vagrant-notify 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c08a1c58a9fcfa0470ad77a737f52f2b60cf7971
-  data.tar.gz: b2a3093c5a9dce8a52c28aa8dc90b2e95ef68f07
+  metadata.gz: ba4fc9493cec21bcfb25014ba736fb42b5fec41f
+  data.tar.gz: a8d46b48d1b215007f65ad3fb5278d4a6810f244
 SHA512:
-  metadata.gz: 479ab1f5e182e41f8e15ed05e3f91ecd66e044276c3eb6b60059f175babf5c42447ed2de497827abd3f482d83db67d543596ce73235adbfaeb1e5efd067c696e
-  data.tar.gz: e91676a8f4795be0f42f442091c7e7fe25902f45448355c33b7b96da0ea798c9a0e696cd66d873d4654cd89a1ad499185b72dec7761921579bbecad68041862f
+  metadata.gz: af4894a0012437cbd6a81c13a3ada7fa8a2e8dbfe270c0f44732c23b15a92248382fa61300c3bee07bf93edcd827b5d24a417d7cfef9f3ddd14eb56b84602dad
+  data.tar.gz: 2f82cfb35c78298f9de96d417d23fad6060a0c292ec5005940e6b5e5c4173a7dc6545f91fc7729d45c672711df5f50057c36aeb067b69ffeb292ed8c320b110c

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+## [0.4.0](https://github.com/fgrehm/vagrant-notify/compare/v0.3.0...master) (Feb 26, 2014)
+
+IMPROVEMENTS
+
+  - Notify provisioning status on Vagrant 1.4+ [[GH-5]]
+  - Make use of `$SSH_CLIENT` when identifying host's IP to connect
+
+BUG FIXES
+
+  - Fix "rm: cannot remove ‘/usr/bin/notify-send’: No such file or directory" [[GH-11]]
+
+## Previous
+
+The changelog began with version 0.4.0 so any changes prior to that
+can be seen by checking the tagged releases and reading git commit
+messages.
+
+
+[GH-5]:https://github.com/fgrehm/vagrant-notify/issues/5
+[GH-11]:https://github.com/fgrehm/vagrant-notify/issues/11

data/Gemfile.lock

@@ -1,25 +1,25 @@
 GIT
   remote: git://github.com/fgrehm/vagrant-lxc.git
-  revision: d2e354839f404ef426bdee38e50c9b3256e1e3c2
+  revision: c19bc91e708f7a69b62e35f465b5246bf5706cc3
   specs:
-    vagrant-lxc (0.4.1.dev)
+    vagrant-lxc (0.7.1.dev)
 
 GIT
   remote: git://github.com/mitchellh/vagrant.git
-  revision: e98e8bf9d768cc9be244fb61883a907253b11f08
+  revision: e3734a7a46c39cd73e79538980dd98aeaeca9656
   specs:
-    vagrant (1.2.7.dev)
+    vagrant (1.4.2.dev)
       childprocess (~> 0.3.7)
       erubis (~> 2.7.0)
       i18n (~> 0.6.0)
       log4r (~> 1.1.9)
       net-scp (~> 1.1.0)
-      net-ssh (~> 2.6.6)
+      net-ssh (>= 2.6.6, < 2.8.0)
 
 PATH
   remote: .
   specs:
-    vagrant-notify (0.3.0)
+    vagrant-notify (0.4.0)
 
 GEM
   remote: https://rubygems.org/
@@ -29,7 +29,7 @@ GEM
     coderay (1.0.9)
     diff-lcs (1.2.4)
     erubis (2.7.0)
-    ffi (1.9.0)
+    ffi (1.9.3)
     formatador (0.2.4)
     guard (1.8.1)
       formatador (>= 0.2.4)
@@ -40,7 +40,7 @@ GEM
     guard-rspec (3.0.2)
       guard (>= 1.8)
       rspec (~> 2.13)
-    i18n (0.6.4)
+    i18n (0.6.9)
     listen (1.2.2)
       rb-fsevent (>= 0.9.3)
       rb-inotify (>= 0.9)
@@ -50,7 +50,7 @@ GEM
     method_source (0.8.2)
     net-scp (1.1.2)
       net-ssh (>= 2.6.5)
-    net-ssh (2.6.8)
+    net-ssh (2.7.0)
     pry (0.9.12.2)
       coderay (~> 1.0.5)
       method_source (~> 0.8)

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Fabio Rehm
+Copyright (c) 2012-2014 Fabio Rehm
 
 MIT License
 
@@ -19,4 +19,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,31 +1,65 @@
-# Vagrant::Notify
+# vagrant-notify
 
 [![Build Status](https://travis-ci.org/fgrehm/vagrant-notify.png)](https://travis-ci.org/fgrehm/vagrant-notify)
-[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/fgrehm/vagrant-notify)
+[![Gem Version](https://badge.fury.io/rb/vagrant-notify.png)](http://badge.fury.io/rb/vagrant-notify)
+[![Gittip](http://img.shields.io/gittip/fgrehm.svg)](https://www.gittip.com/fgrehm/)
+
+A Vagrant plugin that forwards `notify-send` from guest to host machine and
+notifies provisioning status. [See it in action](#demo)
 
-A Vagrant plugin that forwards `notify-send` from guest to host machine, tested
-using Ubuntu as guest and host machine.
 
 ## Installation
 
-Make sure you have Vagrant >= 1.1 around and run:
+Make sure you have Vagrant 1.4+ around and run:
 
 ```terminal
 $ vagrant plugin install vagrant-notify
 ```
 
 
-
 ## Usage
 
+### `notify-send` from guest VMs
+
 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
-update the guest script with the new IP.
+### Provisioning notification
+
+Apart from redirecting `notify-send` from the guest VM to the host, whenever
+a Vagrant provisioner completes running you'll also receive a notification
+like:
+
+![provisioning](http://i.imgur.com/DgKjDgr.png)
+
+![provisioned](http://i.imgur.com/UGhOAzV.png)
+
+
+### Linux
+
+Since Linux distributions have `notify-send` pre-installed, everything should work out of the box.
+
+### OS X
+
+You will need to create a `notify-send` script, available on `$PATH`. The script can forward the message to either
+[Growl](http://growl.info/) with [GrowlNotify](http://growl.info/downloads) (version 1.2.2 is free but unreliable)
+or to the [Notification Center](http://support.apple.com/kb/HT5362) available on OS X 10.8+
+using f.ex. [terminal-notifier](https://github.com/alloy/terminal-notifier).
+
+A (too) primitive script integrating with Growl:
+
+```bash
+#!/bin/bash
+growlnotify -t "Vagrant VM" -m "$*"
+```
+
+## Demo
+
+![Demo](http://i.imgur.com/tzOLvGY.gif)
+
 
 ## Known issues
 

data/development/Vagrantfile

@@ -5,8 +5,8 @@ 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.box = "raring64"
+  config.vm.synced_folder "../", "/vagrant", id: 'vagrant-root'
 
   config.vm.define :vm1
   config.vm.define :vm2

data/files/notify-send.erb

@@ -40,6 +40,7 @@ unless ARGV.empty?
   cmd << ARGV.map{|a| "'#{a}'"}.join(' ')
 end
 
-TCPSocket.open "<%= host_ip %>", <%= host_port %> do |s|
+client_ip = ENV['SSH_CLIENT'].split(' ')[0]
+TCPSocket.open ENV['SSH_CLIENT'], <%= host_port %> do |s|
   s.send cmd, 0
 end

data/lib/vagrant-notify/action.rb

@@ -1,26 +1,15 @@
 require_relative 'action/check_provider'
 require_relative 'action/install_command'
+require_relative 'action/notify_provisioning_status'
 require_relative 'action/prepare_data'
 require_relative 'action/server_is_running'
+require_relative 'action/set_shared_folder'
 require_relative 'action/start_server'
 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, :shared_folder => '/tmp/vagrant-notify')
+          template_binding = OpenStruct.new(: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 })
 
@@ -30,29 +30,6 @@ module Vagrant
           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
-
-        ##
-        # Returns the local IP address of the host running the vagrant VMs.
-        #
-        # Thanks to:
-        #   https://github.com/fnichol/vagrant-butter/blob/master/lib/vagrant/butter/helpers.rb
-        #   https://github.com/jedi4ever/veewee/blob/c75a5b175c5b8ac7e5aa3341e93493923d0c7af0/lib/veewee/session.rb#L622
-        #
-        # @return [String] the local IP address
-        def local_ip
-          @local_ip ||= begin
-            # turn off reverse DNS resolution temporarily
-            orig, Socket.do_not_reverse_lookup =
-              Socket.do_not_reverse_lookup, true
-
-            UDPSocket.open do |s|
-              s.connect '64.233.187.99', 1
-              s.addr.last
-            end
-          ensure
-            Socket.do_not_reverse_lookup = orig
-          end
-        end
       end
     end
   end

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

@@ -0,0 +1,17 @@
+module Vagrant
+  module Notify
+    module Action
+      class NotifyProvisioningStatus
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          system("notify-send '[#{env[:machine].name}] Provisioning with \"#{env[:provisioner_name]}\"...'")
+          @app.call(env)
+          system("notify-send '[#{env[:machine].name}] Finished provisioning with \"#{env[:provisioner_name]}\"'")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+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
+    end
+  end
+end

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

@@ -7,8 +7,10 @@ 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')
+          if env[:machine].state.id == :running
+            env[:machine].communicate.sudo('rm /usr/bin/notify-send; exit 0')
+            env[:machine].communicate.sudo('mv /usr/bin/{notify-send.bkp,notify-send}; exit 0')
+          end
 
           @app.call env
 

data/lib/vagrant-notify/plugin.rb

@@ -4,19 +4,26 @@ module Vagrant
       name 'vagrant notify'
       description 'Forwards notify-send from guest to host machine'
 
+      action_hook 'notify-provisioning-status', :provisioner_run do |hook|
+        require_relative './action'
+        hook.before :run_provisioner, Vagrant::Notify::Action::NotifyProvisioningStatus
+      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 'start-server-after-boot' do |hook|
+      start_server_hook = lambda do |hook|
         require_relative './action'
         hook.after VagrantPlugins::ProviderVirtualBox::Action::Boot, Vagrant::Notify::Action.action_start_server
 
         if defined?(Vagrant::LXC)
-          # 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
       end
 
+      action_hook 'start-server-after-boot-on-machine-up',     :machine_action_up, &start_server_hook
+      action_hook 'start-server-after-boot-on-machine-reload', :machine_action_reload, &start_server_hook
+
       share_folder_hook = lambda do |hook|
         require_relative './action'
         hook.after Vagrant::Action::Builtin::Provision, Vagrant::Notify::Action::SetSharedFolder
@@ -24,7 +31,7 @@ module Vagrant
       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-halt' do |hook|
+      action_hook 'stop-server-after-halt', :machine_action_halt do |hook|
         require_relative './action'
         hook.before Vagrant::Action::Builtin::GracefulHalt, Vagrant::Notify::Action.action_stop_server
       end
@@ -36,7 +43,6 @@ module Vagrant
         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

data/lib/vagrant-notify/version.rb

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

data/spec/action/install_command_spec.rb

@@ -14,20 +14,19 @@ describe Vagrant::Notify::Action::InstallCommand do
   let(:tmp_cmd_path)     { tmp_path.join('vagrant-notify-send') }
   let(:guest_tmp_path)   { '/tmp/notify-send' }
   let(:guest_path)       { '/usr/bin/notify-send' }
-  let(:stubbed_template) { ERB.new('<%= host_ip %> <%= host_port %>') }
+  let(:stubbed_template) { ERB.new('<%= host_port %>') }
 
   subject { described_class.new(app, env) }
 
   before do
     ERB.stub(:new => stubbed_template)
-    subject.stub(local_ip: host_ip)
     subject.call(env)
   end
 
   after { FileUtils.rm_rf tmp_path.to_s }
 
-  it 'compiles command script passing host ip and server port' do
-    tmp_cmd_path.read.should == "#{host_ip} #{host_port}"
+  it 'compiles command script passing server port' do
+    tmp_cmd_path.read.should == "#{host_port}"
   end
 
   it 'uploads compiled command script over to guest machine' do

data/spec/action/stop_server_spec.rb

@@ -5,7 +5,7 @@ require 'vagrant-notify/action/stop_server'
 describe Vagrant::Notify::Action::StopServer do
   let(:app)          { lambda { |env| } }
   let(:communicator) { mock(sudo: true) }
-  let(:machine)      { mock(communicate: communicator) }
+  let(:machine)      { mock(communicate: communicator, state: stub(id: :running)) }
   let(:env)          { {notify_data: {pid: pid, port: 1234}, machine: machine} }
   let(:pid)          { '42' }
   let(:port)         { described_class::PORT }

data/vagrant-notify.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |gem|
   gem.version       = Vagrant::Notify::VERSION
   gem.authors       = ["Fabio Rehm"]
   gem.email         = ["fgrehm@gmail.com"]
-  gem.description   = 'A Vagrant plugin that redirects system notifications from guest to host machine.'
+  gem.description   = 'A Vagrant plugin that forwards `notify-send` from guest to host machine and notifies provisioning status'
   gem.summary       = gem.description
   gem.homepage      = "https://github.com/fgrehm/vagrant-notify"
 

metadata

@@ -1,26 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-notify
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Fabio Rehm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-29 00:00:00.000000000 Z
+date: 2014-02-27 00:00:00.000000000 Z
 dependencies: []
-description: A Vagrant plugin that redirects system notifications from guest to host
-  machine.
+description: A Vagrant plugin that forwards `notify-send` from guest to host machine
+  and notifies provisioning status
 email:
 - fgrehm@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - Guardfile
@@ -33,8 +34,10 @@ files:
 - lib/vagrant-notify/action.rb
 - lib/vagrant-notify/action/check_provider.rb
 - lib/vagrant-notify/action/install_command.rb
+- lib/vagrant-notify/action/notify_provisioning_status.rb
 - lib/vagrant-notify/action/prepare_data.rb
 - lib/vagrant-notify/action/server_is_running.rb
+- lib/vagrant-notify/action/set_shared_folder.rb
 - lib/vagrant-notify/action/start_server.rb
 - lib/vagrant-notify/action/stop_server.rb
 - lib/vagrant-notify/data.rb
@@ -59,20 +62,21 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: A Vagrant plugin that redirects system notifications from guest to host machine.
+summary: A Vagrant plugin that forwards `notify-send` from guest to host machine and
+  notifies provisioning status
 test_files:
 - spec/action/install_command_spec.rb
 - spec/action/prepare_data_spec.rb