vagrant-triggers 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2fc9e72e96c859d7a51666232ac6616d94ab1bad
-  data.tar.gz: 9a6582a7dba4fcf707ea943f33d1c3dd143a3a3f
+  metadata.gz: 143df3dafe6617342eeea922dee510ade4fc69f0
+  data.tar.gz: 92cf760b6937957927f66aa6d29a12b48c128e07
 SHA512:
-  metadata.gz: 4894efdbaa8bfadcafa9b681c5c165bccd9a8c172181874c9b627cbe9c554c8c4f2cd2da3708cb479d5e232fc9c510707a705c417f9b4f27c0f1c0a09cec29f0
-  data.tar.gz: b1420068c5d83aa1b67fe2958d13a20fe4305820194e1c8428744fb5d01f6d342c517fbd45e5a37052cb664015933aba1f77f4015ebf0973e443f7255ffde6d4
+  metadata.gz: e707bffcb9a263a74c760c6d7e4f7b1f3b802562c544ffc01b0dbc0838436ec4c4aeb90d9778a5627d7a088fa0e02bd7f11f5dbe0e3ad38535ae8ed8c223ada1
+  data.tar.gz: 99b49229d13930918cc02cc3060493ecba6930c6ad5a0d33b856836c5700676b9d7cfd80be6fdbd4d4655b78eb89d6937431866557a5e4cf8fa0dbfb4c381f65

data/.travis.yml

@@ -1,6 +1,6 @@
 language: ruby
 rvm:
-  - 2.0.0
+  - 2.2.3
 before_install:
   - gem update --system
   - rvm @global do gem uninstall -ax bundler
@@ -10,10 +10,12 @@ env:
   global:
     - SPEC_OPTS="--tag ~skip_travis"
   matrix:
-    - VAGRANT_VERSION=v1.7.4
+    - VAGRANT_VERSION=v1.8.1
 matrix:
   include:
     - env: VAGRANT_VERSION=master
+      rvm: 2.2.3
+    - env: VAGRANT_VERSION=v1.7.4
       rvm: 2.0.0
     - env: VAGRANT_VERSION=v1.6.5
       rvm: 2.0.0
@@ -27,5 +29,5 @@ matrix:
       rvm: 1.9.3
   allow_failures:
     - env: VAGRANT_VERSION=master
-      rvm: 2.0.0
+      rvm: 2.2.3
 sudo: false

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 0.5.3 (April 9, 2016)
+
+IMPROVEMENTS:
+
+  - Add ```:good_exit``` option for specifying custom positive exit codes [(#37)](https://github.com/emyl/vagrant-triggers/issues/37)
+
+BUG FIXES:
+
+  - Gracefully catch communication errors [(#55)](https://github.com/emyl/vagrant-triggers/issues/55)
+
 ## 0.5.2 (September 9, 2015)
 
 BUG FIXES:

data/README.md

@@ -2,7 +2,7 @@
 
 [![Build Status](https://travis-ci.org/emyl/vagrant-triggers.png?branch=master)](https://travis-ci.org/emyl/vagrant-triggers)
 
-Allow the definition of arbitrary scripts that will run on the host before and/or after Vagrant commands.
+Allow the definition of arbitrary scripts that will run on the host or guest before and/or after Vagrant commands.
 
 ## Installation
 
@@ -13,9 +13,33 @@ Installation is performed in the prescribed manner for Vagrant plugins:
 
     $ vagrant plugin install vagrant-triggers
 
-## Usage
+## Example Usage
 
-### Basic usage
+```ruby
+Vagrant.configure("2") do |config|
+  # Your existing Vagrant configuration
+  ...
+
+  # run some script before the guest is destroyed
+  config.trigger.before :destroy do
+    info "Dumping the database before destroying the VM..."
+    run_remote  "bash /vagrant/cleanup.sh"
+  end
+
+  # clean up files on the host after the guest is destroyed
+  config.trigger.after :destroy do
+    run "rm -Rf tmp/*"
+  end
+
+  # start apache on the guest after the guest starts
+  config.trigger.after :up do
+    run_remote "service apache2 start"
+  end
+
+end
+```
+
+## Syntax Overview
 
 ```ruby
 Vagrant.configure("2") do |config|
@@ -62,6 +86,7 @@ end
 
 * ```:append_to_path => ["dir", "dir"]```: additional places where looking for scripts. See [this wiki page](https://github.com/emyl/vagrant-triggers/wiki/The-:append_to_path-option) for details.
 * ```:force => true|false```: continue even if one of the scripts fails (exits with non-zero code). Defaults to false.
+* ```:good_exit => [ ... ]```: good command exit codes. Defaults to ```[0]```. **Don't forget to include 0 if you change the default value, unless you really want**.
 * ```:stderr => true|false```: display standard error from scripts. Defaults to true.
 * ```:stdout => true|false```: display standard output from scripts. Defaults to true.
 * ```:vm => ["vm1", /vm[2-3]/]```: fire only for matching virtual machines. Value can be a string, a regexp or an array of strings and/or regexps.
@@ -103,17 +128,7 @@ end
 
 Multiple commands can be blacklisted using an array.
 
-## A simple example
-
-Cleanup some temporary files after machine destroy:
 
-```ruby
-Vagrant.configure("2") do |config|
-  config.trigger.after :destroy do
-    run "rm -Rf tmp/*"
-  end
-end
-```
 
 ## A more detailed example
 

data/lib/vagrant-triggers/action/trigger.rb

@@ -49,15 +49,7 @@ module VagrantPlugins
           end
 
           triggers_to_fire.each do |trigger|
-            if trigger[:proc]
-              begin
-                dsl = DSL.new(@env[:machine], trigger[:options])
-                dsl.instance_eval &trigger[:proc]
-              rescue Errors::NotMatchingMachine
-              end
-            else
-              @logger.debug("Trigger command not found.")
-            end
+            DSL.fire!(trigger, @env[:machine])
           end
         end
 

data/lib/vagrant-triggers/config/provisioner.rb

@@ -7,8 +7,9 @@ module VagrantPlugins
 
         def initialize
           @options = {
-            :stderr => true,
-            :stdout => true
+            :good_exit => [0],
+            :stderr    => true,
+            :stdout    => true
           }
         end
 

data/lib/vagrant-triggers/config/trigger.rb

@@ -6,7 +6,7 @@ module VagrantPlugins
 
         def initialize
           @blacklist = []
-          @options   = { :stdout => true, :stderr => true }
+          @options   = { :good_exit => [0], :stderr => true, :stdout => true }
           @triggers  = []
         end
 

data/lib/vagrant-triggers/dsl.rb

@@ -5,6 +5,14 @@ require "vagrant/util/subprocess"
 module VagrantPlugins
   module Triggers
     class DSL
+      def self.fire!(trigger, machine)
+        begin
+          dsl = new(machine, trigger[:options])
+          dsl.instance_eval &trigger[:proc] if trigger[:proc]
+        rescue Errors::NotMatchingMachine
+        end
+      end
+
       def initialize(machine, options = {})
         if options[:vm]
           match = false
@@ -17,7 +25,7 @@ module VagrantPlugins
         @buffer  = Hash.new("")
         @logger  = Log4r::Logger.new("vagrant::plugins::triggers::dsl")
         @machine = machine
-        @options = options
+        @options = { :good_exit => [0] }.merge(options)
         @ui      = machine.ui
 
         @command_output = lambda do |channel, data, options|
@@ -53,7 +61,7 @@ module VagrantPlugins
         ensure
           ENV.replace(env_backup)
         end
-        process_result(raw_command, result, options)
+        process_result("local", raw_command, result, options)
       end
       alias_method :execute, :run
 
@@ -61,11 +69,16 @@ module VagrantPlugins
         options.merge!(@options) { |key, old, new| old }
         info I18n.t("vagrant_triggers.action.trigger.executing_remote_command", :command => raw_command)
         @buffer.clear
-        exit_code = @machine.communicate.sudo(raw_command, :elevated => true, :good_exit => (0..255).to_a) do |channel, data|
-          @command_output.call(channel, data, options)
+        exit_code = 1
+        begin
+          exit_code = @machine.communicate.sudo(raw_command, :elevated => true, :good_exit => (0..255).to_a) do |channel, data|
+            @command_output.call(channel, data, options)
+          end
+        rescue => e
+          @command_output.call(:stderr, e.message, options)
         end
         info I18n.t("vagrant_triggers.action.trigger.remote_command_finished")
-        process_result(raw_command, Vagrant::Util::Subprocess::Result.new(exit_code, @buffer[:stdout], @buffer[:stderr]), options)
+        process_result("remote", raw_command, Vagrant::Util::Subprocess::Result.new(exit_code, @buffer[:stdout], @buffer[:stderr]), options)
       end
       alias_method :execute_remote, :run_remote
 
@@ -101,9 +114,9 @@ module VagrantPlugins
         ENV["VAGRANT_SKIP_SUBPROCESS_JAILBREAK"] = "1"
       end
 
-      def process_result(command, result, options)
-        if result.exit_code != 0 && !options[:force]
-          raise Errors::CommandFailed, :command => command, :stderr => result.stderr
+      def process_result(context, command, result, options)
+        unless options[:good_exit].include?(result.exit_code) || options[:force]
+          raise Errors::CommandFailed, :context => context, :command => command, :stderr => result.stderr
         end
         result.stdout
       end

data/lib/vagrant-triggers/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module Triggers
-    VERSION = "0.5.2"
+    VERSION = "0.5.3"
   end
 end

data/locales/en.yml

@@ -14,8 +14,8 @@ en:
           Running triggers %{condition} %{action}...
     errors:
       command_failed: |-
-        The command "%{command}" returned a failed exit code. The
-        error output is shown below:
+        The %{context} command "%{command}" returned a failed exit
+        code or an exception. The error output is shown below:
 
         %{stderr}
       command_unavailable: |-

data/spec/vagrant-triggers/action/trigger_spec.rb

@@ -57,7 +57,8 @@ describe VagrantPlugins::Triggers::Action::Trigger do
 
   it "shouldn't execute trigger with no command or block" do
     @triggers[0][:proc] = nil
-    VagrantPlugins::Triggers::DSL.should_not_receive(:new)
+    dsl = double("dsl")
+    dsl.should_not_receive(:instance_eval)
     described_class.new(app, env, condition).call(env)
   end
 

data/spec/vagrant-triggers/config/provisioner_spec.rb

@@ -4,13 +4,17 @@ describe VagrantPlugins::Triggers::Config::Provisioner do
   let(:config)  { described_class.new }
 
   describe "defaults" do
-    it "should default :stdout option to true" do
-      expect(config.options[:stdout]).to be true
+    it "should default :good_exit option to [0]" do
+      expect(config.options[:good_exit]).to eq([0])
     end
 
     it "should default :stderr option to true" do
       expect(config.options[:stderr]).to be true
     end
+
+    it "should default :stdout option to true" do
+      expect(config.options[:stdout]).to be true
+    end
   end
 
   describe "fire" do

data/spec/vagrant-triggers/config/trigger_spec.rb

@@ -12,9 +12,9 @@ describe VagrantPlugins::Triggers::Config::Trigger do
       expect(config.triggers).to eq([])
     end
 
-    it "should default :stdout option to true" do
+    it "should default :good_exit option to [0]" do
       config.before(:up) { run "ls" }
-      expect(config.triggers.first[:options][:stdout]).to eq(true)
+      expect(config.triggers.first[:options][:good_exit]).to eq([0])
     end
 
     it "should default :stderr option to true" do
@@ -22,7 +22,22 @@ describe VagrantPlugins::Triggers::Config::Trigger do
       expect(config.triggers.first[:options][:stderr]).to eq(true)
     end
 
-    it "should override options" do
+    it "should default :stdout option to true" do
+      config.before(:up) { run "ls" }
+      expect(config.triggers.first[:options][:stdout]).to eq(true)
+    end
+
+    it "should override :good_exit option" do
+      config.before(:up, :good_exit => [0, 2]) { run "ls" }
+      expect(config.triggers.first[:options][:good_exit]).to eq([0, 2])
+    end
+
+    it "should override :stderr option" do
+      config.before(:up, :stderr => false) { run "ls" }
+      expect(config.triggers.first[:options][:stderr]).to eq(false)
+    end
+
+    it "should override :stdout option" do
       config.before(:up, :stdout => false) { run "ls" }
       expect(config.triggers.first[:options][:stdout]).to eq(false)
     end

data/spec/vagrant-triggers/dsl_spec.rb

@@ -93,6 +93,12 @@ describe VagrantPlugins::Triggers::DSL do
       expect { dsl.run(@command) }.not_to raise_error()
     end
 
+    it "shouldn't raise an error if executed command exits with non-zero code but the code is included in the :good_exit array" do
+      dsl = described_class.new(machine, :good_exit => [0, 2])
+      result.stub(:exit_code => 2)
+      expect { dsl.run(@command) }.not_to raise_error()
+    end
+
     it "should return standard output" do
       dsl = described_class.new(machine)
       expect(dsl.run(@command)).to eq("Some output")
@@ -228,12 +234,24 @@ describe VagrantPlugins::Triggers::DSL do
       expect { @dsl.run_remote(@command) }.to raise_error(VagrantPlugins::Triggers::Errors::CommandFailed)
     end
 
+    it "should catch communication errors and raise a proper exception" do
+      machine.stub_chain(:communicate, :sudo).and_raise(StandardError)
+      result.stub(:exit_code => 1)
+      expect { @dsl.run_remote(@command) }.to raise_error(VagrantPlugins::Triggers::Errors::CommandFailed)
+    end
+
     it "shouldn't raise an error if executed command exits with non-zero code but :force option was specified" do
       dsl = described_class.new(machine, :force => true)
       result.stub(:exit_code => 1)
       expect { dsl.run_remote(@command) }.not_to raise_error()
     end
 
+    it "shouldn't raise an error if executed command exits with non-zero code but the code is included in the :good_exit array" do
+      dsl = described_class.new(machine, :good_exit => [0, 2])
+      result.stub(:exit_code => 2)
+      expect { dsl.run_remote(@command) }.not_to raise_error()
+    end
+
     it "should return standard output" do
       dsl = described_class.new(machine)
       expect(dsl.run_remote(@command)).to eq("Some output")

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-triggers
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
 platform: ruby
 authors:
 - Emiliano Ticci
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-08 00:00:00.000000000 Z
+date: 2016-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: This plugin allow the definition of arbitrary scripts that will run on
@@ -59,23 +59,25 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
-- lib/vagrant-triggers/action/trigger.rb
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/vagrant-triggers.rb
 - lib/vagrant-triggers/action.rb
+- lib/vagrant-triggers/action/trigger.rb
+- lib/vagrant-triggers/config.rb
 - lib/vagrant-triggers/config/provisioner.rb
 - lib/vagrant-triggers/config/trigger.rb
-- lib/vagrant-triggers/config.rb
 - lib/vagrant-triggers/dsl.rb
 - lib/vagrant-triggers/errors.rb
 - lib/vagrant-triggers/plugin.rb
 - lib/vagrant-triggers/provisioner.rb
 - lib/vagrant-triggers/version.rb
-- lib/vagrant-triggers.rb
-- LICENSE.txt
 - locales/en.yml
-- Rakefile
-- README.md
 - spec/spec_helper.rb
 - spec/vagrant-triggers/action/trigger_spec.rb
 - spec/vagrant-triggers/config/provisioner_spec.rb
@@ -84,8 +86,6 @@ files:
 - spec/vagrant-triggers/provisioner_spec.rb
 - spec/vagrant-triggers/vagrant_spec.rb
 - vagrant-triggers.gemspec
-- .gitignore
-- .travis.yml
 homepage: https://github.com/emyl/vagrant-triggers
 licenses:
 - MIT
@@ -96,17 +96,17 @@ 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.14
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Triggers for Vagrant commands.