vagrant-notify 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b92afa6ddcd75d898cddd0a6aa0d782b0402092
-  data.tar.gz: 9bfa48cd8650a092d9daa36f3e8ddce83bcb32aa
+  metadata.gz: c08a1c58a9fcfa0470ad77a737f52f2b60cf7971
+  data.tar.gz: b2a3093c5a9dce8a52c28aa8dc90b2e95ef68f07
 SHA512:
-  metadata.gz: baddaf5a7b7d1978c9ab1db6dfc61ba0b429231926d07135ea67d1b4434ae47be30cb3e7355ec5afa219adc9ab4b94b9a9e84e4080a4f2912ee7d22d017041df
-  data.tar.gz: df8160d0754c78384a47c4623e14bdb9b5a7f39cf9a87dd82382b4b039a5ff167b3c94830697d872a07db470a6d861e21859ebf80f43097cf48624aef00f2754
+  metadata.gz: 479ab1f5e182e41f8e15ed05e3f91ecd66e044276c3eb6b60059f175babf5c42447ed2de497827abd3f482d83db67d543596ce73235adbfaeb1e5efd067c696e
+  data.tar.gz: e91676a8f4795be0f42f442091c7e7fe25902f45448355c33b7b96da0ea798c9a0e696cd66d873d4654cd89a1ad499185b72dec7761921579bbecad68041862f

data/.gitignore

@@ -15,4 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-/.vagrant
+/development/.vagrant

data/Gemfile

@@ -10,11 +10,9 @@ group :development do
 end
 
 group :development, :test do
-  # We depend on Vagrant for development, but we don't add it as a
-  # gem dependency because we expect to be installed within the
-  # Vagrant environment itself using `vagrant plugin`.
-  gem 'vagrant', github: 'mitchellh/vagrant'
+  gem 'vagrant',     github: 'mitchellh/vagrant'
+  gem 'vagrant-lxc', github: 'fgrehm/vagrant-lxc'
   gem 'rake'
-  gem 'rspec'
+  gem 'rspec',       '~> 2.13.0'
   gem 'rspec-spies'
 end

data/README.md

@@ -18,10 +18,10 @@ $ vagrant plugin install vagrant-notify
 
 ## Usage
 
-After installing the gem, whenever you run `vagrant up`, a Ruby
-[TCPServer](http://www.ruby-doc.org/stdlib-1.9.3/libdoc/socket/rdoc/TCPServer.html)
-will fire up on `8081` port and a [script](https://github.com/fgrehm/vagrant-notify/blob/master/files/notify-send.erb)
-will be installed on the guest machine to replace the original `notify-send`
+Whenever you run `vagrant up`, a Ruby [TCPServer](http://www.ruby-doc.org/stdlib-1.9.3/libdoc/socket/rdoc/TCPServer.html)
+will fire up on a port within the [usable port range](https://github.com/mitchellh/vagrant/blob/master/config/default.rb#L14)
+and a [script](https://github.com/fgrehm/vagrant-notify/blob/master/files/notify-send.erb)
+will be copied over to the guest machine to replace the original `notify-send`
 command.
 
 If by any chance your IP changes, you can run `vagrant provision` in order to
@@ -29,10 +29,7 @@ update the guest script with the new IP.
 
 ## Known issues
 
-* Does not work properly on multi vm environments, it used to work on a Vagrant
-  < 1.1 version and I'm planning to fix that as soon as I have a chance.
-
-* vagrant's `suspend` does not stop the notification server
+* `vagrant suspend` does not stop the notification server
 
 
 ## Contributing

data/development/Vagrantfile

@@ -0,0 +1,13 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+Vagrant.require_plugin 'vagrant-notify'
+Vagrant.require_plugin 'vagrant-lxc'
+
+Vagrant.configure("2") do |config|
+  config.vm.box = "base"
+  config.vm.box = "quantal64"
+
+  config.vm.define :vm1
+  config.vm.define :vm2
+end

data/files/notify-send.erb

@@ -8,6 +8,7 @@
 require 'rubygems'
 require 'socket'
 require 'optparse'
+require 'fileutils'
 
 options = {}
 OptionParser.new do |opts|
@@ -23,6 +24,12 @@ OptionParser.new do |opts|
 
 end.parse!
 
+if options[:i]
+  new_filename = options[:i].gsub('/', '-')
+  FileUtils.cp options[:i], "<%= shared_folder %>/#{new_filename}"
+  options[:i]  = new_filename
+end
+
 cmd = options.map do |key, value|
   "-#{key} '#{value}'"
 end.join(' ')

data/lib/vagrant-notify/action.rb

@@ -8,6 +8,19 @@ require_relative 'action/stop_server'
 module Vagrant
   module Notify
     module Action
+      class SetSharedFolder
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          host_dir = Pathname("/tmp/vagrant-notify/#{env[:machine].id}")
+          FileUtils.mkdir_p host_dir.to_s unless host_dir.exist?
+          env[:machine].config.vm.synced_folder host_dir, "/tmp/vagrant-notify", id: "vagrant-notify"
+          @app.call(env)
+        end
+      end
+
       class << self
         Call = Vagrant::Action::Builtin::Call
 

data/lib/vagrant-notify/action/install_command.rb

@@ -17,7 +17,7 @@ module Vagrant
 
         def compile_command(env)
           host_port        = env[:notify_data][:port]
-          template_binding = OpenStruct.new(:host_ip => local_ip, :host_port => host_port)
+          template_binding = OpenStruct.new(:host_ip => local_ip, :host_port => host_port, :shared_folder => '/tmp/vagrant-notify')
           command_template = ERB.new(Vagrant::Notify.files_path.join('notify-send.erb').read)
           command          = command_template.result(template_binding.instance_eval { binding })
 
@@ -27,6 +27,7 @@ module Vagrant
         def install_command_on_guest(env, command_path)
           source = env[:tmp_path].join 'vagrant-notify-send'
           env[:machine].communicate.upload(source.to_s, '/tmp/notify-send')
+          env[:machine].communicate.sudo('mv /usr/bin/{notify-send,notify-send.bkp}; exit 0')
           env[:machine].communicate.sudo('mv /tmp/notify-send /usr/bin/notify-send && chmod +x /usr/bin/notify-send')
         end
 

data/lib/vagrant-notify/action/start_server.rb

@@ -1,23 +1,61 @@
+require "vagrant/util/is_port_open"
+
 require_relative '../server'
 
 module Vagrant
   module Notify
     module Action
       class StartServer
-        # TODO: This should come from vm configuration or be automatically
-        #       assigned
-        PORT = '9999'
+        include Util::IsPortOpen
 
         def initialize(app, env)
           @app = app
         end
 
         def call(env)
-          env[:notify_data][:pid]  = Server.run(env, PORT)
-          env[:notify_data][:port] = PORT
+          @env = env
+
+          port = next_available_port
+          env[:notify_data][:pid]  = Server.run(env, port)
+          env[:notify_data][:port] = port
 
           @app.call env
         end
+
+        def next_available_port
+          # Determine a list of usable ports for us to use
+          usable_ports = Set.new(@env[:machine].config.vm.usable_port_range)
+
+          # Pass one, remove all defined host ports from usable ports
+          with_forwarded_ports do |options|
+            usable_ports.delete(options[:host])
+          end
+
+          # Pass two, remove ports used by other processes
+          with_forwarded_ports do |options|
+            host_port = options[:host]
+            usable_ports.delete(options[:host]) if is_port_open?("127.0.0.1", host_port)
+          end
+
+          # If we have no usable ports then we can't use the plugin
+          raise 'No usable ports available!' if usable_ports.empty?
+
+          # Set the port up to be the last one since vagrant's port collision handler
+          # will use the first as in:
+          #   https://github.com/mitchellh/vagrant/blob/master/lib/vagrant/action/builtin/handle_forwarded_port_collisions.rb#L84
+          usable_ports.to_a.sort.reverse.find do |port|
+            return port unless is_port_open?("127.0.0.1", port)
+          end
+        end
+
+        def with_forwarded_ports
+          @env[:machine].config.vm.networks.each do |type, options|
+            # Ignore anything but forwarded ports
+            next if type != :forwarded_port
+
+            yield options
+          end
+        end
       end
     end
   end

data/lib/vagrant-notify/action/stop_server.rb

@@ -7,6 +7,9 @@ module Vagrant
         end
 
         def call(env)
+          env[:machine].communicate.sudo('rm /usr/bin/notify-send')
+          env[:machine].communicate.sudo('mv /usr/bin/{notify-send.bkp,notify-send}; exit 0')
+
           @app.call env
 
           pid = env[:notify_data][:pid]

data/lib/vagrant-notify/plugin.rb

@@ -17,18 +17,21 @@ module Vagrant
         end
       end
 
-      action_hook 'install-command-after-provisioning', :machine_action_provision do |hook|
-        hook.after Vagrant::Action::Builtin::Provision, Vagrant::Notify::Action.action_start_server
+      share_folder_hook = lambda do |hook|
+        require_relative './action'
+        hook.after Vagrant::Action::Builtin::Provision, Vagrant::Notify::Action::SetSharedFolder
       end
+      action_hook 'set-shared-folder-and-start-notify-server-on-machine-up',     :machine_action_up, &share_folder_hook
+      action_hook 'set-shared-folder-and-start-notify-server-on-machine-reload', :machine_action_reload, &share_folder_hook
 
-      action_hook 'stop-server-after-halting', :machine_action_halt do |hook|
+      action_hook 'stop-server-after-halt' do |hook|
         require_relative './action'
         hook.before Vagrant::Action::Builtin::GracefulHalt, Vagrant::Notify::Action.action_stop_server
       end
 
       # TODO: This should be generic, we don't want to hard code every single
       #       possible provider action class that Vagrant might have
-      action_hook 'stop-server-before-destruction', :machine_action_destroy do |hook|
+      action_hook 'stop-server-before-destroy', :machine_action_destroy do |hook|
         require_relative './action'
         hook.before VagrantPlugins::ProviderVirtualBox::Action::Destroy, Vagrant::Notify::Action.action_stop_server
 

data/lib/vagrant-notify/server.rb

@@ -30,18 +30,22 @@ module Vagrant
         if http_request?(args)
           client.puts HTTP_RESPONSE
         else
-          download_icon!(args)
+          fix_icon_path!(args)
           system("notify-send #{args}")
         end
         client.close
       rescue => ex
-        File.open("/tmp/vagrant-notify-error-#{@id}.log", 'a+') do |log|
-          log.puts "#{ex.message}"
-        end
+        log ex.message
       end
 
       private
 
+      def log(message)
+        File.open("/tmp/vagrant-notify-error-#{@id}.log", 'a+') do |log|
+          log.puts "#{message}"
+        end
+      end
+
       def read_args(client)
         ''.tap do |args|
           while tmp = client.gets and tmp !~ /^\s*$/
@@ -54,24 +58,13 @@ module Vagrant
         args =~ /^GET/
       end
 
-      def download_icon!(args)
+      def fix_icon_path!(args)
         return unless args =~ /-i '([^']+)'/
         icon = $1
         # TODO: Handle system icons
-        host_file = "/tmp/vagrant-notify-#{@id}-#{icon.gsub('/', '-')}"
-        download(icon, host_file) unless File.exists?(host_file)
+        host_file = "/tmp/vagrant-notify/#{@id}/#{icon.gsub('/', '-')}"
         args.gsub!(icon, host_file)
       end
-
-      def download(icon, host_file)
-        communicator.download(icon, host_file)
-      end
-
-      def communicator
-        env     = Vagrant::Environment.new
-        machine = env.machine(@machine_name, @provider)
-        machine.communicate
-      end
     end
   end
 end

data/lib/vagrant-notify/version.rb

@@ -1,5 +1,5 @@
 module Vagrant
   module Notify
-    VERSION = "0.2.2"
+    VERSION = "0.3.0"
   end
 end

data/spec/action/install_command_spec.rb

@@ -34,6 +34,10 @@ describe Vagrant::Notify::Action::InstallCommand do
     communicator.should have_received(:upload).with(tmp_cmd_path.to_s, guest_tmp_path)
   end
 
+  it 'creates a backup for the available command' do
+    communicator.should have_received(:sudo).with("mv /usr/bin/{notify-send,notify-send.bkp}; exit 0")
+  end
+
   it 'installs command for all users' do
     communicator.should have_received(:sudo).with("mv #{guest_tmp_path} #{guest_path} && chmod +x #{guest_path}")
   end

data/spec/action/start_server_spec.rb

@@ -6,12 +6,13 @@ describe Vagrant::Notify::Action::StartServer do
   let(:app)  { lambda { |env| } }
   let(:env)  { {notify_data: {}} }
   let(:pid)  { '42' }
-  let(:port) { described_class::PORT }
+  let(:port) { '1234' }
 
   subject { described_class.new(app, env) }
 
   before do
     Vagrant::Notify::Server.stub(:run => pid)
+    subject.stub(next_available_port: port)
     subject.call(env)
   end
 
@@ -26,4 +27,6 @@ describe Vagrant::Notify::Action::StartServer do
   it 'persists used port' do
     env[:notify_data][:port].should == port
   end
+
+  pending 'identifies the next available port'
 end

data/spec/action/stop_server_spec.rb

@@ -3,10 +3,12 @@ require 'spec_helper'
 require 'vagrant-notify/action/stop_server'
 
 describe Vagrant::Notify::Action::StopServer do
-  let(:app)  { lambda { |env| } }
-  let(:env)  { {notify_data: {pid: pid, port: 1234}} }
-  let(:pid)  { '42' }
-  let(:port) { described_class::PORT }
+  let(:app)          { lambda { |env| } }
+  let(:communicator) { mock(sudo: true) }
+  let(:machine)      { mock(communicate: communicator) }
+  let(:env)          { {notify_data: {pid: pid, port: 1234}, machine: machine} }
+  let(:pid)          { '42' }
+  let(:port)         { described_class::PORT }
 
   subject { described_class.new(app, env) }
 

data/spec/server_spec.rb

@@ -7,7 +7,7 @@ describe Vagrant::Notify::Server do
 
   subject { described_class.new(machine_id) }
 
-  before { subject.stub(:system => true, :download => true) }
+  before { subject.stub(:system => true) }
 
   it 'runs notify-send with received data from client' do
     subject.should_receive(:system).with("notify-send #{arguments}")
@@ -22,27 +22,10 @@ describe Vagrant::Notify::Server do
   context 'notification with an icon' do
     let(:arguments) { "-i 'foo/bar.jpg'" }
 
-    context 'icon hasnt been downloaded before' do
-      before { subject.receive_data(client) }
-
-      it 'downloads icon file to host machine' do
-        subject.should have_received(:download)
-      end
-
-      it 'rewrites icon path before sending the notification' do
-        subject.should have_received(:system).with("notify-send -i '/tmp/vagrant-notify-#{machine_id}-foo-bar.jpg'")
-      end
-    end
-
-    context 'icon file cache is present' do
-      before do
-        File.stub(:exists? => true)
-        subject.receive_data(client)
-      end
+    before { subject.receive_data(client) }
 
-      it 'does not download icon if was already downloaded' do
-        subject.should_not have_received(:download)
-      end
+    it 'rewrites icon path before sending the notification' do
+      subject.should have_received(:system).with("notify-send -i '/tmp/vagrant-notify/#{machine_id}/foo-bar.jpg'")
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-notify
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Fabio Rehm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-21 00:00:00.000000000 Z
+date: 2013-07-29 00:00:00.000000000 Z
 dependencies: []
 description: A Vagrant plugin that redirects system notifications from guest to host
   machine.
@@ -27,6 +27,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- development/Vagrantfile
 - files/notify-send.erb
 - lib/vagrant-notify.rb
 - lib/vagrant-notify/action.rb