vagrant-notify 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1074a71950090d90ae0b29f1a84c15ceb70ba2e
-  data.tar.gz: 9da0d636fd6ebe6f8023ed14d2338574a90c5868
+  metadata.gz: 0d66b2dcc7b07f99723c453e8a8708720d3e3139
+  data.tar.gz: d58378442c0b7f1a2850589d146cd620133aa1c4
 SHA512:
-  metadata.gz: 4aa952173645b5a6e165b180fbd4111c8e06dac056673813d3a658b09a4c19fb284e675233a414d605a92fe63b32aae2d7daec2c57e2ab5596e86b7ee8643723
-  data.tar.gz: 7858e8b543ff5236af42f2c32c894bf3980814979fb94d5eb8c6d41329e9fe4410809a19961173fb5f6f37167a66f546bd8f82aea33af5b967ef56372d2d390c
+  metadata.gz: 90758ab9aec949ec3ccbe9b14a188da3b1f9555576e59ce7acc4730143578b8024cfca89ad9feb7d80a438b280b63de45b25e8b891c501af2477d6d72f1a69cf
+  data.tar.gz: 6659609a5349738fd444e5f4fa4c0a65370f8b39bd786527c8f1aa9d4511551b58cf203716614df7c6a2ba0671a559624e01e2043057c5e2f1db8313864b374b

data/Gemfile.lock

@@ -14,7 +14,7 @@ GIT
 PATH
   remote: .
   specs:
-    vagrant-notify (0.2.0)
+    vagrant-notify (0.2.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -27,8 +27,12 @@ command.
 If by any chance your IP changes, you can run `vagrant provision` in order to
 update the guest script with the new IP.
 
-As of now, the plugin is not supported on multi vm environments, it used to be
-for the Vagrant < 1.1 version and I'm planning to fix that as soon as I have a chance.
+## 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
 
 
 ## Contributing

data/lib/vagrant-notify/plugin.rb

@@ -4,13 +4,14 @@ module Vagrant
       name 'vagrant notify'
       description 'Forwards notify-send from guest to host machine'
 
+      # TODO: This should be generic, we don't want to hard code every single
+      #       possible provider action class that Vagrant might have
       action_hook 'start-server-after-boot' do |hook|
         require_relative './action'
-        # TODO: This should be generic
         hook.after VagrantPlugins::ProviderVirtualBox::Action::Boot, Vagrant::Notify::Action.action_start_server
 
         if defined?(Vagrant::LXC)
-          # TODO: Require just the boot file once its "require dependencies" are sorted out
+          # TODO: Require just the boot action file once its "require dependencies" are sorted out
           require 'vagrant-lxc/action'
           hook.after Vagrant::LXC::Action::Boot, Vagrant::Notify::Action.action_start_server
         end
@@ -20,10 +21,23 @@ module Vagrant
         hook.after Vagrant::Action::Builtin::Provision, Vagrant::Notify::Action.action_start_server
       end
 
-      action_hook 'stop-server-after-halting' do |hook|
+      action_hook 'stop-server-after-halting', :machine_action_halt do |hook|
         require_relative './action'
         hook.after 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|
+        require_relative './action'
+        hook.before VagrantPlugins::ProviderVirtualBox::Action::Destroy, Vagrant::Notify::Action.action_stop_server
+
+        if defined?(Vagrant::LXC)
+          # TODO: Require just the destroy action file once its "require dependencies" are sorted out
+          require 'vagrant-lxc/action'
+          hook.before Vagrant::LXC::Action::Destroy, Vagrant::Notify::Action.action_stop_server
+        end
+      end
     end
   end
 end

data/lib/vagrant-notify/server.rb

@@ -68,12 +68,9 @@ module Vagrant
       end
 
       def communicator
-        @communicator ||=
-          begin
-            env     = Vagrant::Environment.new
-            machine = env.machine(@machine_name, @provider)
-            machine.communicate
-          end
+        env     = Vagrant::Environment.new
+        machine = env.machine(@machine_name, @provider)
+        machine.communicate
       end
     end
   end

data/lib/vagrant-notify/version.rb

@@ -1,5 +1,5 @@
 module Vagrant
   module Notify
-    VERSION = "0.2.0"
+    VERSION = "0.2.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-notify
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Fabio Rehm
@@ -27,13 +27,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- burn/middleware/install_command.rb
-- burn/middleware/start_server.rb
-- burn/middleware/stop_server.rb
-- burn/old_stack.rb
-- burn/spec/middleware/install_command_spec.rb
-- burn/spec/middleware/start_server_spec.rb
-- burn/spec/middleware/stop_server_spec.rb
 - files/notify-send.erb
 - lib/vagrant-notify.rb
 - lib/vagrant-notify/action.rb

data/burn/middleware/install_command.rb

@@ -1,45 +0,0 @@
-module Vagrant
-  module Notify
-    module Middleware
-      class InstallCommand
-        def initialize(app, env)
-          @app = app
-          @command_template_file = Vagrant::Notify.files_path + '/notify-send.erb'
-        end
-
-        def call(env)
-          env[:ui].info('Compiling and installing notify-send script on guest machine')
-          path = compile_command(env)
-          install_command_on_guest(env, path)
-          @app.call(env)
-        end
-
-        def host_ip(env)
-          ip = nil
-          env[:vm].channel.execute('echo -n $SSH_CLIENT | cut -d" " -f1') do |buffer, data|
-            ip = data.chomp if buffer == :stdout
-          end
-          ip
-        end
-
-        private
-
-        def compile_command(env)
-          uuid       = env[:vm].uuid.to_s
-          local_data = env[:vm].env.local_data
-          host_port  = local_data['vagrant-notify'][uuid]['port']
-          template_binding = OpenStruct.new(:host_ip => host_ip(env), :host_port => host_port)
-          command = ERB.new(File.read(@command_template_file)).result(template_binding.instance_eval { binding })
-          File.open(env[:vm].env.tmp_path + 'vagrant-notify-send', 'w') { |f| f.write(command) }
-        end
-
-        def install_command_on_guest(env, command_path)
-          # DISCUSS: Should we back up the original command if present?
-          source = env[:vm].env.tmp_path + 'vagrant-notify-send'
-          env[:vm].channel.upload(source.to_s, '/tmp/notify-send')
-          env[:vm].channel.sudo('mv /tmp/notify-send /usr/bin/notify-send && chmod +x /usr/bin/notify-send')
-        end
-      end
-    end
-  end
-end

data/burn/middleware/start_server.rb

@@ -1,78 +0,0 @@
-module Vagrant
-  module Notify
-    module Middleware
-      class StartServer
-        def initialize(app, env)
-          @app = app
-        end
-
-        def call(env)
-          @env = env
-          if pid = server_is_running?
-            env[:ui].info "Notification server is already running (#{pid})"
-          else
-            port, pid = run_server
-            env[:ui].info "Notification server is listening on #{port} (#{pid})"
-          end
-
-          @app.call(env)
-        end
-
-        private
-
-        def run_server
-          port = next_available_port
-          uuid = @env[:vm].uuid.to_s
-          pid  = Server.run(@env, port)
-
-          local_data = @env[:vm].env.local_data
-          config = local_data['vagrant-notify'] ||= Vagrant::Util::HashWithIndifferentAccess.new
-          config.merge!(uuid => {'pid' => pid, 'port' => port })
-          local_data.commit
-
-          [port, pid]
-        end
-
-        def next_available_port
-          range = @env[:vm].config.vm.auto_port_range.to_a
-          range -= @env[:vm].config.vm.forwarded_ports.collect { |opts| opts[:hostport].to_i }
-          range -= used_ports
-
-          if range.empty?
-            raise 'Unable to find a port to bind the notification server to'
-          end
-
-          # 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/1-0-stable/lib/vagrant/action/vm/check_port_collisions.rb#L51
-          port = range.pop
-        end
-
-        def used_ports
-          local_data = @env[:vm].env.local_data
-          local_data['vagrant-notify'] ||= Vagrant::Util::HashWithIndifferentAccess.new
-          local_data['vagrant-notify'].values.map do |settings|
-            settings['port'].to_i if settings['port']
-          end.compact
-        end
-
-        # REFACTOR: This is duplicated on Middleware::StopServer
-        def server_is_running?
-          uuid = @env[:vm].uuid.to_s
-          begin
-            pid = @env[:vm].env.local_data.
-              fetch('vagrant-notify', {}).
-              fetch(uuid, {}).
-              fetch('pid', nil)
-            return false unless pid
-
-            Process.getpgid(pid)
-            pid
-          rescue Errno::ESRCH
-            false
-          end
-        end
-      end
-    end
-  end
-end

data/burn/middleware/stop_server.rb

@@ -1,54 +0,0 @@
-module Vagrant
-  module Notify
-    module Middleware
-      class StopServer
-        def initialize(app, env)
-          @app = app
-        end
-
-        def call(env)
-          # TODO: Need to handle multi VMs setup
-
-          if pid = server_is_running?(env)
-            env[:ui].info('Stopping notification server...')
-            stop_server(pid)
-            cleanup_local_data(env)
-          end
-
-          @app.call(env)
-        end
-
-        private
-
-        def stop_server(pid)
-          Process.kill('KILL', pid.to_i) rescue nil
-        end
-
-        def cleanup_local_data(env)
-          uuid = env[:vm].uuid.to_s
-          local_data = env[:vm].env.local_data
-          local_data['vagrant-notify'] ||= Vagrant::Util::HashWithIndifferentAccess.new
-          local_data['vagrant-notify'].delete(uuid)
-          local_data.commit
-        end
-
-        # REFACTOR: This is duplicated on Middleware::StartServer
-        def server_is_running?(env)
-          uuid = env[:vm].uuid.to_s
-          begin
-            pid = env[:vm].env.local_data.
-              fetch('vagrant-notify', {}).
-              fetch(uuid, {}).
-              fetch('pid', nil)
-            return false unless pid
-
-            Process.getpgid(pid.to_i)
-            pid
-          rescue Errno::ESRCH
-            false
-          end
-        end
-      end
-    end
-  end
-end

data/burn/old_stack.rb

@@ -1,11 +0,0 @@
-Vagrant.actions[:start].tap do |start|
-  start.insert_after Vagrant::Action::VM::Boot,                Vagrant::Notify::Middleware::StartServer
-  start.insert_after Vagrant::Notify::Middleware::StartServer, Vagrant::Notify::Middleware::InstallCommand
-end
-Vagrant.actions[:resume].tap do |start|
-  start.use Vagrant::Notify::Middleware::StartServer
-  start.use Vagrant::Notify::Middleware::InstallCommand
-end
-Vagrant.actions[:halt].use      Vagrant::Notify::Middleware::StopServer
-Vagrant.actions[:suspend].use   Vagrant::Notify::Middleware::StopServer
-Vagrant.actions[:provision].use Vagrant::Notify::Middleware::InstallCommand

data/burn/spec/middleware/install_command_spec.rb

@@ -1,68 +0,0 @@
-describe Vagrant::Notify::Middleware::InstallCommand do
-  let(:start_stack)           { Vagrant.actions[:start].send(:stack) }
-  let(:provision_stack)       { Vagrant.actions[:provision].send(:stack) }
-  let(:resume_stack)          { Vagrant.actions[:resume].send(:stack) }
-  let(:host_ip)               { 'host-ip' }
-  let(:host_port)             { 789 }
-  let(:template)              { ERB.new('<%= host_ip %> <%= host_port %>') }
-  let(:compiled_command_path) { @env[:vm].env.tmp_path + 'vagrant-notify-send' }
-  let(:target_tmp_path)       { '/tmp/notify-send' }
-  let(:target_path)           { '/usr/bin/notify-send' }
-  let(:channel)               { mock(:channel, :sudo => true, :upload => true, :execute => true) }
-  let(:get_ip_command)        { 'echo -n $SSH_CLIENT | cut -d" " -f1' }
-  let(:uuid)                  { @env[:vm].uuid.to_s }
-  let(:local_data)            { Hash.new }
-
-  subject { described_class.new(@app, @env) }
-
-  before do
-    @app, @env = action_env(vagrant_env.vms.values.first.env)
-    @env[:vm].stub(:channel => channel)
-    @env[:vm].env.stub(:local_data => local_data)
-    local_data['vagrant-notify'] = { uuid => {'port' => host_port } }
-    ERB.stub(:new => template)
-  end
-
-  it 'gets called after boot middleware when starting machine' do
-    boot_index       = start_stack.index([Vagrant::Action::VM::Boot, [], nil])
-    middleware_index = start_stack.index([described_class, [], nil])
-
-    boot_index.should < middleware_index
-  end
-
-  it 'gets called when resuming machine' do
-    resume_stack.should include([described_class, [], nil])
-  end
-
-  it 'gets called when provisioning machine' do
-    provision_stack.should include([described_class, [], nil])
-  end
-
-  it "is able to identify host's ip" do
-    channel.should_receive(:execute).with(get_ip_command).and_yield(:stdout, host_ip + "\n")
-    subject.host_ip(@env).should == host_ip
-  end
-
-  it 'compiles command script passing host ip and server port' do
-    subject.stub(:host_ip => host_ip)
-    subject.call(@env)
-    File.read(compiled_command_path).should == "#{host_ip} #{host_port}"
-  end
-
-  it 'uploads compiled command script over to guest machine' do
-    channel.should_receive(:upload).with(compiled_command_path.to_s, target_tmp_path)
-    subject.stub(:host_ip => host_ip)
-    subject.call(@env)
-  end
-
-  it 'installs command for all users' do
-    channel.should_receive(:sudo).with("mv #{target_tmp_path} #{target_path} && chmod +x #{target_path}")
-    subject.stub(:host_ip => host_ip)
-    subject.call(@env)
-  end
-
-  it 'notifies user about script installation' do
-    @env[:ui].should_receive(:info).with('Compiling and installing notify-send script on guest machine')
-    subject.call(@env)
-  end
-end

data/burn/spec/middleware/start_server_spec.rb

@@ -1,85 +0,0 @@
-describe Vagrant::Notify::Middleware::StartServer do
-  let(:start_stack)    { Vagrant.actions[:start].send(:stack) }
-  let(:resume_stack)   { Vagrant.actions[:resume].send(:stack) }
-  let(:server_pid)     { 1234 }
-  let(:available_port) { 8080 }
-  let(:uuid)           { @env[:vm].uuid.to_s }
-  let(:local_data)     { Hash.new }
-
-  subject { described_class.new(@app, @env) }
-
-  before do
-    @app, @env = action_env(vagrant_env.vms.values.first.env)
-    @env[:vm].env.stub(:local_data => local_data)
-    local_data.stub(:commit)
-    Vagrant::Notify::Server.stub(:run => server_pid)
-  end
-
-  it 'gets called when starting machine' do
-    start_stack.should include([described_class, [], nil])
-  end
-
-  it 'gets called when resuming machine' do
-    resume_stack.should include([described_class, [], nil])
-  end
-
-  context 'server is down' do
-    before do
-      Process.stub(:getpgid).and_raise(Errno::ESRCH)
-      subject.stub(:next_available_port => available_port)
-    end
-
-    it 'fires up notification server when called' do
-      Vagrant::Notify::Server.should_receive(:run).with(@env, available_port)
-      subject.call(@env)
-    end
-
-    it 'notifies user about server start' do
-      @env[:ui].should_receive(:info).with("Notification server is listening on #{available_port} (#{server_pid})")
-      subject.call(@env)
-    end
-
-    it "persists server PID on local data" do
-      local_data.should_receive(:commit)
-      subject.call(@env)
-      local_data['vagrant-notify'][uuid]['pid'].should == server_pid
-    end
-
-    it "persists server port on local data" do
-      local_data.should_receive(:commit)
-      subject.call(@env)
-      local_data['vagrant-notify'][uuid]['port'].should == available_port
-    end
-
-    context "and a PID is present on Vagrant's local data" do
-      let(:new_pid) { server_pid + 1 }
-
-      before do
-        Vagrant::Notify::Server.stub(:run => new_pid)
-        local_data['vagrant-notify'] = { uuid => { 'pid' => server_pid } }
-      end
-
-      it 'updates server PID' do
-        subject.call(@env)
-        local_data['vagrant-notify'][uuid]['pid'].should == new_pid
-      end
-    end
-  end
-
-  context 'server is up' do
-    before do
-      Process.stub(:getpgid => true)
-      local_data['vagrant-notify'] = { uuid => { 'pid' => server_pid } }
-    end
-
-    it 'does not start a new server instance' do
-      Vagrant::Notify::Server.should_not_receive(:run)
-      subject.call(@env)
-    end
-
-    it 'notifies user that server is already running' do
-      @env[:ui].should_receive(:info).with("Notification server is already running (#{server_pid})")
-      subject.call(@env)
-    end
-  end
-end

data/burn/spec/middleware/stop_server_spec.rb

@@ -1,55 +0,0 @@
-describe Vagrant::Notify::Middleware::StopServer do
-  let(:halt_stack)    { Vagrant.actions[:halt].send(:stack) }
-  let(:suspend_stack) { Vagrant.actions[:halt].send(:stack) }
-  let(:server_pid)    { '1234' }
-  let(:uuid)          { @env[:vm].uuid.to_s }
-  let(:local_data)    { { 'vagrant-notify' => { uuid => { 'pid' => server_pid } } } }
-
-  subject { described_class.new(@app, @env) }
-
-  before do
-    @app, @env = action_env(vagrant_env.vms.values.first.env)
-    @env[:vm].env.stub(:local_data => local_data)
-    local_data.stub(:commit)
-  end
-
-  it 'gets called when halting machine' do
-    halt_stack.should include([described_class, [], nil])
-  end
-
-  it 'gets called when suspending machine' do
-    suspend_stack.should include([described_class, [], nil])
-  end
-
-  context 'server is down' do
-    before { Process.stub(:getpgid).and_raise(Errno::ESRCH) }
-
-    it 'does not notify user about server stop' do
-      @env[:ui].should_not_receive(:info)
-      subject.call(@env)
-    end
-  end
-
-  context 'server is up' do
-    before do
-      Process.stub(:getpgid => true)
-      local_data['vagrant-notify'] = { uuid => { 'pid' => server_pid } }
-    end
-
-    it 'notifies user that server is stopping' do
-      @env[:ui].should_receive(:info).with('Stopping notification server...')
-      subject.call(@env)
-    end
-
-    it 'kills notification server' do
-      Process.should_receive(:kill).with('KILL', server_pid.to_i)
-      subject.call(@env)
-    end
-
-    it "removes server PID on local data" do
-      local_data.should_receive(:commit)
-      subject.call(@env)
-      local_data['vagrant-notify']['pid'].should be_nil
-    end
-  end
-end