vagrant-triggers 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 92d93f338ac34daa73bb81b1c67e82a098ed6a3b
-  data.tar.gz: 19f64c4f8f7d5379719a126d8e5fdf0fa2db76b3
+  metadata.gz: 24bfa273b967f208d110651eda1e6c9dc807ecf0
+  data.tar.gz: 643443292d3045678520d9b864bf00811648e8fc
 SHA512:
-  metadata.gz: 0cb4fa497e40a8697e7f86d7276c63a7e38df7c5c82aaa3c804566fa3bc783138547f8d60640f7cde21b7d051bc1abe891fd0f4cd80f24ced622eb7e19c54bb5
-  data.tar.gz: ad5b94780e81efe97b693e0460ce1163983a95c171d980d2021ffe99c69b92746ee68125e3ab75c2a398a7de0530965c5d30e126f7028c2cdfd88f7d9d30b00d
+  metadata.gz: 26fafa806afa5d6863033843dfe1329297ade73a8df715945ca1e877100925f12db659d63073b0a91bbc11f59b1d0734b1df3874ca4f073fde8a9eee4e45c9cd
+  data.tar.gz: d285bca1d4d3c2cba1dea08748cd7434aa8f3d5e8b3dac8a147269c4308cc57ade7e4458c29433d01fb7cf943c81917cb0ea7cde6d92c03dea95efb720aa4355

data/.travis.yml

@@ -1,15 +1,24 @@
 language: ruby
 rvm:
   - 2.0.0
+before_install:
+  - gem update --system
+  - rvm @global do gem uninstall -ax bundler
+  - gem install bundler -v 1.5.3
 env:
-  - VAGRANT_VERSION=v1.5.2
+  - VAGRANT_VERSION=v1.6.2
 matrix:
   include:
     - env: VAGRANT_VERSION=master
+      rvm: 2.0.0
+    - env: VAGRANT_VERSION=v1.5.4
+      rvm: 2.0.0
     - env: VAGRANT_VERSION=v1.4.3
+      rvm: 2.0.0
     - env: VAGRANT_VERSION=v1.3.5
       rvm: 1.9.3
     - env: VAGRANT_VERSION=v1.2.7
       rvm: 1.9.3
   allow_failures:
     - env: VAGRANT_VERSION=master
+      rvm: 2.0.0

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## 0.4.0 (May 20, 2014)
+
+NEW FEATURES:
+
+  - New trigger type: ```instead_of```.
+  - Add ```:vm``` option for choosing the target vm(s) in case of multi-machine Vagrantfile.
+
+IMPROVEMENTS:
+
+  - DSL: add ```run_remote``` as alias to ```run("vagrant ssh -c ...")```.
+  - DSL: the ```error``` statement now stops the action and makes Vagrant fail with an error.
+  - Ensure the ```run``` statement always returns the command output.
+
+BUG FIXES:
+
+  - Use additive merge logic [(#12)](https://github.com/emyl/vagrant-triggers/issues/12)
+  - Remove bundler settings from RUBYOPT [(reopened #5)](https://github.com/emyl/vagrant-triggers/issues/5)
+
 ## 0.3.0 (April 4, 2014)
 
 CHANGES:

data/README.md

@@ -31,9 +31,16 @@ Vagrant.configure("2") do |config|
     run "script"
     ...
   end
+
+  config.trigger.instead_of :command, :option => "value" do
+    run "script"
+    ...
+  end
 end
 ```
 
+The ```instead_of``` trigger could also be aliased as ```reject```.
+
 The first argument is the command in which the trigger will be tied. It could be an array (e.g. ```[:up, :resume]```) in case of multiple commands.
 
 ### Options
@@ -41,10 +48,11 @@ The first argument is the command in which the trigger will be tied. It could be
 * ```: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```: continue even one of the scripts fails (exits with non-zero code)
 * ```:stdout => true```: display script output
+* ```: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.
 
 ### Trigger block DSL
 
-The given block will be evaluated by an instance of the [VagrantPlugins::Triggers::DSL](https://github.com/emyl/vagrant-triggers/blob/master/lib/vagrant-triggers/dsl.rb) class. This class defines a very simple DSL for running scripts on the host machine. Basically only one method (`run`) is directly defined, all the other calls will be forwarded to Vagrant's [ui](https://github.com/mitchellh/vagrant/blob/master/lib/vagrant/ui.rb) instance. This allows the definition of custom messages along with scripts.
+The given block will be evaluated by an instance of the [VagrantPlugins::Triggers::DSL](https://github.com/emyl/vagrant-triggers/blob/master/lib/vagrant-triggers/dsl.rb) class. This class defines a very simple DSL for running scripts on the host machine. Only a few methods are directly defined, all the other calls will be forwarded to Vagrant's [ui](https://github.com/mitchellh/vagrant/blob/master/lib/vagrant/ui.rb) instance. This allows the definition of custom messages along with scripts.
 
 For additional details you can take a look to the [VagrantPlugins::Triggers::DSL](https://github.com/emyl/vagrant-triggers/blob/master/lib/vagrant-triggers/dsl.rb) definition.
 

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

@@ -8,50 +8,67 @@ module VagrantPlugins
           @app       = app
           @condition = condition
           @env       = env
+          @exit      = false
           @logger    = Log4r::Logger.new("vagrant::plugins::triggers::trigger")
         end
 
         def call(env)
           fire_triggers
 
-          # Carry on
-          @app.call(env)
+          @app.call(env) unless @exit
         end
 
         private
 
         def fire_triggers
           # Triggers don't fire on environment load and unload.
-          return if [:environment_load, :environment_unload].include?(@env[:action_name])
-          current_action   = @env[:machine_action]
+          return if [:environment_load, :environment_plugins_loaded, :environment_unload].include?(@env[:action_name])
+
           # Also don't fire if machine action is not defined.
-          return unless current_action
-          @logger.debug("Looking for triggers #{@condition} action #{current_action}.")
-          triggers_to_fire = @env[:machine].config.trigger.triggers.find_all { |t| t[:action] == current_action && t[:condition] == @condition }
-          unless triggers_to_fire.empty?
-            # Emit a warning message if the old syntax is found
-            if @env[:machine].config.trigger.deprecation_warning
-              @env[:ui].warn I18n.t("vagrant_triggers.action.trigger.deprecated_syntax")
-            end
-            @env[:ui].info I18n.t("vagrant_triggers.action.trigger.running_triggers", :condition => @condition)
-            triggers_to_fire.each do |trigger|
-              # Ugly block, will change in v0.4
-              @options = trigger[:options]
-              case
-              when trigger[:proc]
-                dsl = DSL.new(@env[:ui], @options)
-                dsl.instance_eval &trigger[:proc]
-              when @options[:execute]
-                dsl = DSL.new(@env[:ui], @options)
-                dsl.execute @options[:execute]
-              when @options[:info]
-                dsl = DSL.new(@env[:ui], @options)
-                dsl.info @options[:info]
-              else
-                @logger.debug("Trigger command not found.")
+          return unless @env[:machine_action]
+
+          @logger.debug("Looking for triggers with:")
+          trigger_env.each { |k, v| @logger.debug("-- #{k}: #{v}")}
+
+          # Loop through all defined triggers checking for matches.
+          triggers_to_fire = [].tap do |triggers|
+            @env[:machine].config.trigger.triggers.each do |trigger|
+              next if trigger[:action]    != trigger_env[:action]
+              next if trigger[:condition] != trigger_env[:condition]
+
+              if trigger[:options][:vm]
+                match = false
+                Array(trigger[:options][:vm]).each do |pattern|
+                  match = true if trigger_env[:vm].match(pattern)
+                end
+                next unless match
               end
+
+              triggers << trigger
             end
           end
+
+          unless triggers_to_fire.empty?
+            @env[:ui].info I18n.t("vagrant_triggers.action.trigger.running_triggers", trigger_env).gsub('_', ' ')
+            @exit = true if trigger_env[:condition] == :instead_of
+          end
+
+          triggers_to_fire.each do |trigger|
+            if trigger[:proc]
+              dsl = DSL.new(@env[:ui], @env[:machine], trigger[:options])
+              dsl.instance_eval &trigger[:proc]
+            else
+              @logger.debug("Trigger command not found.")
+            end
+          end
+        end
+
+        def trigger_env
+          {
+            :action    => @env[:machine_action],
+            :condition => @condition,
+            :vm        => @env[:machine].name
+          }
         end
       end
     end

data/lib/vagrant-triggers/config.rb

@@ -1,12 +1,10 @@
 module VagrantPlugins
   module Triggers
     class Config < Vagrant.plugin("2", :config)
-      attr_reader :deprecation_warning
       attr_reader :triggers
 
       def initialize
-        @deprecation_warning = false
-        @triggers            = []
+        @triggers = []
       end
 
       def after(actions, options = {}, &block)
@@ -17,6 +15,17 @@ module VagrantPlugins
         add_trigger(actions, :before, options, block)
       end
 
+      def instead_of(actions, options = {}, &block)
+        add_trigger(actions, :instead_of, options, block)
+      end
+      alias_method :reject, :instead_of
+
+      def merge(other)
+        super.tap do |result|
+          result.instance_variable_set(:@triggers, @triggers + other.triggers)
+        end
+      end
+
       def validate(machine)
         errors = []
 
@@ -32,7 +41,6 @@ module VagrantPlugins
       def add_trigger(actions, condition, options, proc)
         Array(actions).each do |action|
           @triggers << { :action => action, :condition => condition, :options => options, :proc => proc }
-          @deprecation_warning = true if options[:execute] || options[:info]
         end
       end
     end

data/lib/vagrant-triggers/dsl.rb

@@ -5,14 +5,19 @@ require "vagrant/util/subprocess"
 module VagrantPlugins
   module Triggers
     class DSL
-      def initialize(ui, options = {})
+      def initialize(ui, machine, options = {})
         @logger  = Log4r::Logger.new("vagrant::plugins::triggers::dsl")
+        @machine = machine
         @options = options
         @ui      = ui
       end
 
+      def error(message, *opts)
+        raise Errors::DSLError, @ui.error(message, *opts)
+      end
+
       def run(raw_command, options = {})
-        @ui.info I18n.t("vagrant_triggers.action.trigger.executing_command", :command => raw_command)
+        info I18n.t("vagrant_triggers.action.trigger.executing_command", :command => raw_command)
         command     = Shellwords.shellsplit(raw_command)
         env_backup  = ENV.to_hash
         begin
@@ -27,11 +32,17 @@ module VagrantPlugins
           raise Errors::CommandFailed, :command => raw_command, :stderr => result.stderr
         end
         if @options[:stdout]
-          @ui.info I18n.t("vagrant_triggers.action.trigger.command_output", :output => result.stdout)
+          info I18n.t("vagrant_triggers.action.trigger.command_output", :output => result.stdout)
         end
+        result.stdout
       end
       alias_method :execute, :run
 
+      def run_remote(raw_command, options = {})
+        run("vagrant ssh -c '#{raw_command}' #{@machine.name}", options)
+      end
+      alias_method :execute_remote, :run_remote
+
       def method_missing(method, *args, &block)
         # If the @ui object responds to the given method, call it
         if @ui.respond_to?(method)
@@ -55,7 +66,11 @@ module VagrantPlugins
         new_path  = ENV["VAGRANT_INSTALLER_ENV"] ? ENV["PATH"].gsub(/#{ENV["VAGRANT_INSTALLER_EMBEDDED_DIR"]}.*?#{File::PATH_SEPARATOR}/, "") : ENV["PATH"]
         new_path += Array(@options[:append_to_path]).map { |dir| "#{File::PATH_SEPARATOR}#{dir}" }.join
         ENV["PATH"] = new_path
-        @logger.debug("PATH modifed: #{ENV["PATH"]}")
+        @logger.debug("PATH modified: #{ENV["PATH"]}")
+
+        # Remove bundler settings from RUBYOPT
+        ENV["RUBYOPT"] = (ENV["RUBYOPT"] || "").gsub(/-rbundler\/setup\s*/, "")
+        @logger.debug("RUBYOPT modified: #{ENV["RUBYOPT"]}")
 
         # Add the VAGRANT_NO_TRIGGERS variable to avoid loops
         ENV["VAGRANT_NO_TRIGGERS"] = "1"

data/lib/vagrant-triggers/errors.rb

@@ -12,6 +12,10 @@ module VagrantPlugins
       class CommandUnavailable < VagrantTriggerError
         error_key(:command_unavailable)
       end
+
+      class DSLError < VagrantTriggerError
+        error_key(:dsl_error)
+      end
     end
   end
-end
+end

data/lib/vagrant-triggers/plugin.rb

@@ -4,6 +4,15 @@ if Vagrant::VERSION < "1.2.0"
   raise "The Vagrant Triggers plugin is only compatible with Vagrant 1.2+"
 end
 
+if ["1.6.0", "1.6.1"].include?(Vagrant::VERSION)
+  warn <<-WARNING.gsub /^\s{2}/, ""
+  The Vagrant version you're using contains a bug that prevents some
+  triggers to work as expected. Update to version 1.6.2+ if you
+  want to avoid issues.
+
+  WARNING
+end
+
 module VagrantPlugins
   module Triggers
     class Plugin < Vagrant.plugin("2")
@@ -19,6 +28,7 @@ module VagrantPlugins
         require_relative "action"
         unless ENV["VAGRANT_NO_TRIGGERS"]
           hook.prepend(Action.action_trigger(:before))
+          hook.prepend(Action.action_trigger(:instead_of))
           hook.append(Action.action_trigger(:after))
         end
       end

data/lib/vagrant-triggers/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module Triggers
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

data/locales/en.yml

@@ -7,20 +7,10 @@ en:
           ---------------
           %{output}
           ---------------
-        deprecated_syntax: |-
-          --------------------
-          DEPRECATION WARNING:
-          --------------------
-          The `:execute` and `:info` trigger options are deprecated
-          and will be removed in vagrant-triggers 0.4. Please upgrade
-          your Vagrantfile according to the new trigger DSL.
-
-          More information on the project home page:
-          https://github.com/emyl/vagrant-triggers
         executing_command: |-
           Executing command "%{command}"...
         running_triggers: |-
-          Running triggers %{condition} action...
+          Running triggers %{condition} %{action}...
     errors:
       command_failed: |-
         The command "%{command}" returned a failed exit code. The
@@ -31,3 +21,5 @@ en:
         The executable "%{command}" Vagrant is trying to trigger
         was not found. If you know it is not in the PATH, please
         specify its absolute path using the :append_to_path option.
+      dsl_error: |-
+        Trigger failed with an error.

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

@@ -14,7 +14,7 @@ describe VagrantPlugins::Triggers::Action::Trigger do
   before do
     trigger_block = Proc.new { nil }
     @triggers     = [ { :action => machine_action, :condition => condition, :options => { }, :proc => trigger_block } ]
-    machine.stub_chain(:config, :trigger, :deprecation_warning)
+    machine.stub(:name)
     machine.stub_chain(:config, :trigger, :triggers).and_return(@triggers)
   end
 
@@ -35,7 +35,7 @@ describe VagrantPlugins::Triggers::Action::Trigger do
 
   it "should fire trigger when all conditions are satisfied" do
     dsl = double("dsl")
-    VagrantPlugins::Triggers::DSL.stub(:new).with(ui, @triggers.first[:options]).and_return(dsl)
+    VagrantPlugins::Triggers::DSL.stub(:new).with(ui, machine, @triggers.first[:options]).and_return(dsl)
     dsl.should_receive(:instance_eval).and_yield
     described_class.new(app, env, condition).call(env)
   end
@@ -64,9 +64,51 @@ describe VagrantPlugins::Triggers::Action::Trigger do
     described_class.new(app, env, condition).call(env)
   end
 
-  it "should emit a warning message if the deprecation warning flag is set" do
-    machine.stub_chain(:config, :trigger, :deprecation_warning).and_return(true)
-    ui.should_receive(:warn).with(/DEPRECATION WARNING/)
-    described_class.new(app, env, condition).call(env)
+  it "shouldn't carry on in the middleware chain on instead_of condition" do
+    @triggers[0][:condition] = :instead_of
+    app.should_not_receive(:call).with(env)
+    described_class.new(app, env, :instead_of).call(env)
+  end
+
+  context ":vm option" do
+    before do
+      machine.stub(:name).and_return("vm1")
+    end
+
+    it "should fire trigger when :vm option match" do
+      @triggers[0][:options][:vm] = "vm1"
+      VagrantPlugins::Triggers::DSL.should_receive(:new)
+      described_class.new(app, env, condition).call(env)
+    end
+
+    it "shouldn't fire trigger when :vm option doesn't match" do
+      @triggers[0][:options][:vm] = "vm2"
+      VagrantPlugins::Triggers::DSL.should_not_receive(:new)
+      described_class.new(app, env, condition).call(env)
+    end
+
+    it "should fire trigger when :vm option is an array and one of the elements match" do
+      @triggers[0][:options][:vm] = ["vm1", "vm2"]
+      VagrantPlugins::Triggers::DSL.should_receive(:new)
+      described_class.new(app, env, condition).call(env)
+    end
+
+    it "shouldn't fire trigger when :vm option is an array and no element match" do
+      @triggers[0][:options][:vm] = ["vm2", "vm3"]
+      VagrantPlugins::Triggers::DSL.should_not_receive(:new)
+      described_class.new(app, env, condition).call(env)
+    end
+
+    it "should fire trigger when :vm option is a regex and the pattern match" do
+      @triggers[0][:options][:vm] = /^vm/
+      VagrantPlugins::Triggers::DSL.should_receive(:new)
+      described_class.new(app, env, condition).call(env)
+    end
+
+    it "shouldn't fire trigger when :vm option is a regex and the pattern doesn't match" do
+      @triggers[0][:options][:vm] = /staging/
+      VagrantPlugins::Triggers::DSL.should_not_receive(:new)
+      described_class.new(app, env, condition).call(env)
+    end
   end
 end

data/spec/vagrant-triggers/config_spec.rb

@@ -20,16 +20,14 @@ describe VagrantPlugins::Triggers::Config do
       expect(config.triggers).to have(1).item
     end
 
-    it "should add after triggers" do
-      config.after(:up) { run "ls" }
+    it "should add instead_of triggers" do
+      config.instead_of(:up) { run "ls" }
       expect(config.triggers).to have(1).item
     end
 
-    [:execute, :info].each do |option|
-      it "should set the deprecation warning flag if the old #{option.to_s} option is passed" do
-        config.before(:up, option => true)
-        expect(config.deprecation_warning).to be_true
-      end
+    it "should add after triggers" do
+      config.after(:up) { run "ls" }
+      expect(config.triggers).to have(1).item
     end
   end
 

data/spec/vagrant-triggers/dsl_spec.rb

@@ -5,12 +5,22 @@ describe VagrantPlugins::Triggers::DSL do
   let(:result) { double("result", :exit_code => 0, :stderr => stderr) }
   let(:stderr) { double("stderr") }
 
-  let(:ui)     { double("ui", :info => info) }
-  let(:info)   { double("info") }
+  let(:machine) { double("machine") }
+  let(:ui)      { double("ui", :info => info) }
+  let(:info)    { double("info") }
 
   before do
     @command = "foo"
-    @dsl     = described_class.new(ui, {})
+    @dsl     = described_class.new(ui, machine, {})
+
+    result.stub(:stdout => "Some output")
+  end
+
+  context "error" do
+    it "should raise a DSL error on UI error" do
+      ui.should_receive(:error).with("Error message")
+      expect { @dsl.error("Error message") }.to raise_error(VagrantPlugins::Triggers::Errors::DSLError)
+    end
   end
 
   context "method missing" do
@@ -31,14 +41,13 @@ describe VagrantPlugins::Triggers::DSL do
     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(ui, :force => true)
+      dsl = described_class.new(ui, machine, :force => true)
       result.stub(:exit_code => 1)
       expect { dsl.run(@command) }.not_to raise_error()
     end
 
     it "should display output if :stdout option was specified" do
-      dsl = described_class.new(ui, :stdout => true)
-      result.stub(:stdout => "Some output")
+      dsl = described_class.new(ui, machine, :stdout => true)
       ui.should_receive(:info).with(/Some output/)
       dsl.run(@command)
     end
@@ -74,14 +83,14 @@ describe VagrantPlugins::Triggers::DSL do
     end
 
     it "should honor the :append_to_path option and restore original path after execution" do
-      dsl = described_class.new(ui, :append_to_path => @tmp_dir)
+      dsl = described_class.new(ui, machine, :append_to_path => @tmp_dir)
       original_path = ENV["PATH"]
       dsl.run(@command)
       expect(ENV["PATH"]).to eq(original_path)
     end
 
     it "should accept an array for the :append_to_path option" do
-      dsl = described_class.new(ui, :append_to_path => [@tmp_dir, @tmp_dir])
+      dsl = described_class.new(ui, machine, :append_to_path => [@tmp_dir, @tmp_dir])
       expect { dsl.run(@command) }.not_to raise_error()
     end
   end
@@ -95,6 +104,7 @@ describe VagrantPlugins::Triggers::DSL do
       ENV["GEM_PATH"]                       = ENV["GEM_HOME"]
       ENV["GEMRC"]                          = "#{ENV["VAGRANT_INSTALLER_EMBEDDED_DIR"]}/etc/gemrc"
       ENV["PATH"]                           = "#{ENV["VAGRANT_INSTALLER_EMBEDDED_DIR"]}/bin:#{ENV["PATH"]}"
+      ENV["RUBYOPT"]                        = "-rbundler/setup"
     end
 
     context "with a command which is present into the Vagrant embedded dir" do
@@ -122,12 +132,29 @@ describe VagrantPlugins::Triggers::DSL do
       end
     end
 
+    it "should remove bundler settings from RUBYOPT" do
+      Vagrant::Util::Subprocess.should_receive(:execute) do |command|
+        expect(ENV["RUBYOPT"]).to eq("")
+        result
+      end
+      @dsl.run(@command)
+    end
+
     after do
       ENV["EMBEDDED_DIR"] = nil
       ENV["GEM_HOME"]     = nil
       ENV["GEM_PATH"]     = nil
       ENV["GEMRC"]        = nil
       ENV["PATH"]         = @original_path
+      ENV["RUBYOPT"]      = nil
+    end
+  end
+
+  context "run_remote" do
+    it "should generate a 'vagrant ssh -c' command" do
+      machine.stub(:name => "vm1")
+      @dsl.should_receive(:run).with("vagrant ssh -c '#{@command}' vm1", {})
+      @dsl.run_remote(@command, {})
     end
   end
 end

data/vagrant-triggers.gemspec

@@ -6,8 +6,10 @@ Gem::Specification.new do |spec|
   spec.version       = VagrantPlugins::Triggers::VERSION
   spec.authors       = "Emiliano Ticci"
   spec.email         = "emiticci@gmail.com"
+  spec.homepage      = "https://github.com/emyl/vagrant-triggers"
   spec.summary       = "Triggers for Vagrant commands."
   spec.description   = "This plugin allow the definition of arbitrary scripts that will run on the host before and/or after Vagrant commands."
+  spec.license       = "MIT"
 
   # The following block of code determines the files that should be included
   # in the gem. It does this by reading all the files in the directory where

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-triggers
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Emiliano Ticci
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-04 00:00:00.000000000 Z
+date: 2014-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -81,8 +81,9 @@ files:
 - vagrant-triggers.gemspec
 - .gitignore
 - .travis.yml
-homepage: 
-licenses: []
+homepage: https://github.com/emyl/vagrant-triggers
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []