vagrant-triggers 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 66df1e94338bdbd5b8ea22fa123abc641dbc9e05
-  data.tar.gz: 1310d39fe9e67faaac2a2784b6ed841939a7092e
+  metadata.gz: 92d93f338ac34daa73bb81b1c67e82a098ed6a3b
+  data.tar.gz: 19f64c4f8f7d5379719a126d8e5fdf0fa2db76b3
 SHA512:
-  metadata.gz: 3cd9b20a5e2fdb1f15c702502f008fb89afbb91d3685874c4270bde7000bce13cb44506203085c5e651af3d9900dd655c01743e13bed877c6134b7773c39e7cf
-  data.tar.gz: 600308d8966f0b35fba1c2a17698382ecce0c80054f02103374124144f94345a4e560a301ce47ef97f3bdc85fd90bd99351470dd4c38f7580b3e3fb46b02dab5
+  metadata.gz: 0cb4fa497e40a8697e7f86d7276c63a7e38df7c5c82aaa3c804566fa3bc783138547f8d60640f7cde21b7d051bc1abe891fd0f4cd80f24ced622eb7e19c54bb5
+  data.tar.gz: ad5b94780e81efe97b693e0460ce1163983a95c171d980d2021ffe99c69b92746ee68125e3ab75c2a398a7de0530965c5d30e126f7028c2cdfd88f7d9d30b00d

data/.travis.yml

@@ -1,11 +1,15 @@
 language: ruby
 rvm:
-  - 1.9.3
+  - 2.0.0
 env:
-  - VAGRANT_VERSION=v1.4.3
+  - VAGRANT_VERSION=v1.5.2
 matrix:
   include:
+    - env: VAGRANT_VERSION=master
+    - env: VAGRANT_VERSION=v1.4.3
     - 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

data/CHANGELOG.md

@@ -1,4 +1,22 @@
-## 0.2.2 (unreleased)
+## 0.3.0 (April 4, 2014)
+
+CHANGES:
+
+  - Implement a new DSL for running scripts.
+
+DEPRECATIONS:
+
+  - The ```:info``` and ```:execute``` options has been replaced by the new DSL.
+
+IMPROVEMENTS:
+
+  - Plugin messages are now localized.
+
+BUG FIXES:
+
+  - Avoid loops by adding VAGRANT_NO_TRIGGERS to the subprocess shell.
+
+## 0.2.2 (March 1, 2014)
 
 NEW FEATURES:
 
@@ -6,7 +24,7 @@ NEW FEATURES:
 
 BUG FIXES:
 
-  - Remove Vagrant specific environment variables when executing commands [(#5)](https://github.com/emyl/vagrant-triggers/issues/2)
+  - Remove Vagrant specific environment variables when executing commands [(#5)](https://github.com/emyl/vagrant-triggers/issues/5)
 
 ## 0.2.1 (November 19, 2013)
 

data/Gemfile

@@ -2,8 +2,13 @@ source 'https://rubygems.org'
 
 gemspec
 
+# Warning: Hack below.
+#
+# Add the current project gem to the "plugins" group
+dependencies.find { |dep| dep.name == "vagrant-triggers" }.instance_variable_set(:@groups, [:default, :plugins])
+
 group :development do
-  gem "vagrant", :github => "mitchellh/vagrant", :ref => ENV.fetch("VAGRANT_VERSION", "v1.4.3")
+  gem "vagrant", :github => "mitchellh/vagrant", :ref => ENV.fetch("VAGRANT_VERSION", "master")
 end
 
 group :test do

data/README.md

@@ -17,32 +17,42 @@ Installation is performed in the prescribed manner for Vagrant plugins:
 
 ### Basic usage
 
-The following ```Vagrantfile``` configuration options are added:
+```ruby
+Vagrant.configure("2") do |config|
+  # Your existing Vagrant configuration
+  ...
 
-```
-trigger.before :command, { :option => "value", ... }
-```
+  config.trigger.before :command, :option => "value" do
+    run "script"
+    ...
+  end
 
-```
-trigger.after :command, { :option => "value", ... }
+  config.trigger.after :command, :option => "value" do
+    run "script"
+    ...
+  end
+end
 ```
 
 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
 
-* ```:execute => "script"```: the script to execute
-* ```:info => "string"```: an informational message to be displayed, instead of executing a command. This is only displayed if :execute is not set.
-
-* ```:append_to_path => ["dir", "dir"]```: additional places where looking for the script. See [this wiki page](https://github.com/emyl/vagrant-triggers/wiki/The-:append_to_path-option) for details.
-* ```:force => true```: continue even if the script fails (exits with non-zero code)
+* ```: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
 
+### 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.
+
+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.
+
 ### Skipping execution
 
 Triggers won't run if ```VAGRANT_NO_TRIGGERS``` environment variable is set.
 
-## Example
+## A more detailed example
 
 In the following example a VirtualBox VM (not managed by Vagrant) will be tied to the machine defined in ```Vagrantfile```, to make so that it follows its lifecycle:
 
@@ -55,12 +65,17 @@ Vagrant.configure("2") do |config|
     :suspend       => "controlvm 22aed8b3-d246-40d5-8ad4-176c17552c43 savestate",
     :halt          => "controlvm 22aed8b3-d246-40d5-8ad4-176c17552c43 acpipowerbutton",
   }.each do |command, trigger|
-    config.trigger.before command, :execute => "vboxmanage #{trigger}", :stdout => true
+    config.trigger.before command, :stdout => true do
+      info "Executing #{command} action on the VirtualBox tied VM..."
+      run  "vboxmanage #{trigger}"
+    end
   end
 
 end
 ```
 
+For additional examples, see the [trigger recipes](https://github.com/emyl/vagrant-triggers/wiki/Trigger-recipes) wiki page.
+
 ## Contributing
 
 To contribute, clone the repository, and use [Bundler](http://bundler.io/)
@@ -76,4 +91,3 @@ You can now fork this repository, make your changes and send a pull request.
 
 
 [![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/emyl/vagrant-triggers/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
-

data/lib/vagrant-triggers.rb

@@ -5,9 +5,10 @@ module VagrantPlugins
   module Triggers
     lib_path = Pathname.new(File.expand_path("../vagrant-triggers", __FILE__))
     autoload :Action,   lib_path.join("action")
+    autoload :DSL,      lib_path.join("dsl")
     autoload :Config,   lib_path.join("config")
     autoload :Errors,   lib_path.join("errors")
-    
+
     # This returns the path to the source of this plugin.
     #
     # @return [Pathname]

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

@@ -1,6 +1,4 @@
 require "log4r"
-require "shellwords"
-require "vagrant/util/subprocess"
 
 module VagrantPlugins
   module Triggers
@@ -22,41 +20,6 @@ module VagrantPlugins
 
         private
 
-        def build_environment
-          @logger.debug("Original environment: #{ENV.inspect}")
-
-          # Remove GEM_ environment variables
-          ["GEM_HOME", "GEM_PATH", "GEMRC"].each { |gem_var| ENV.delete(gem_var) }
-
-          # Create the new PATH removing Vagrant bin directory
-          # and appending directories specified through the
-          # :append_to_path option
-          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"]}")
-        end
-
-        def execute(raw_command)
-          @env[:ui].info 'Executing command "' + raw_command + '"...'
-          command     = Shellwords.shellsplit(raw_command)
-          env_backup  = ENV.to_hash
-          begin
-            build_environment
-            result = Vagrant::Util::Subprocess.execute(command[0], *command[1..-1])
-          rescue Vagrant::Errors::CommandUnavailable, Vagrant::Errors::CommandUnavailableWindows
-            raise Errors::CommandUnavailable, :command => command[0]
-          ensure
-            ENV.replace(env_backup)
-          end
-          if result.exit_code != 0 && !@options[:force]
-            raise Errors::CommandFailed, :command => raw_command, :stderr => result.stderr
-          end
-          if @options[:stdout]
-            @env[:ui].info "Command output:\n\n#{result.stdout}\n"
-          end
-        end
-
         def fire_triggers
           # Triggers don't fire on environment load and unload.
           return if [:environment_load, :environment_unload].include?(@env[:action_name])
@@ -66,13 +29,24 @@ module VagrantPlugins
           @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?
-            @env[:ui].info "Running triggers #{@condition} action..."
+            # 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]
-              if @options[:execute]
-                execute(@options[:execute])
-              elsif @options[:info]
-                @env[:ui].info @options[:info]
+              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.")
               end

data/lib/vagrant-triggers/config.rb

@@ -1,19 +1,21 @@
 module VagrantPlugins
   module Triggers
     class Config < Vagrant.plugin("2", :config)
+      attr_reader :deprecation_warning
       attr_reader :triggers
-      
+
       def initialize
-        @triggers = []
+        @deprecation_warning = false
+        @triggers            = []
       end
 
-      def after(actions, options = {})
-        add_trigger(actions, :after, options)
+      def after(actions, options = {}, &block)
+        add_trigger(actions, :after, options, block)
       end
 
-      def before(actions, options = {})
-        add_trigger(actions, :before, options)
-      end      
+      def before(actions, options = {}, &block)
+        add_trigger(actions, :before, options, block)
+      end
 
       def validate(machine)
         errors = []
@@ -27,9 +29,10 @@ module VagrantPlugins
 
       private
 
-      def add_trigger(actions, condition, options)
+      def add_trigger(actions, condition, options, proc)
         Array(actions).each do |action|
-          @triggers << { :action => action, :condition => condition, :options => options }
+          @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

@@ -0,0 +1,65 @@
+require "log4r"
+require "shellwords"
+require "vagrant/util/subprocess"
+
+module VagrantPlugins
+  module Triggers
+    class DSL
+      def initialize(ui, options = {})
+        @logger  = Log4r::Logger.new("vagrant::plugins::triggers::dsl")
+        @options = options
+        @ui      = ui
+      end
+
+      def run(raw_command, options = {})
+        @ui.info I18n.t("vagrant_triggers.action.trigger.executing_command", :command => raw_command)
+        command     = Shellwords.shellsplit(raw_command)
+        env_backup  = ENV.to_hash
+        begin
+          build_environment
+          result = Vagrant::Util::Subprocess.execute(command[0], *command[1..-1])
+        rescue Vagrant::Errors::CommandUnavailable, Vagrant::Errors::CommandUnavailableWindows
+          raise Errors::CommandUnavailable, :command => command[0]
+        ensure
+          ENV.replace(env_backup)
+        end
+        if result.exit_code != 0 && !@options[:force]
+          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)
+        end
+      end
+      alias_method :execute, :run
+
+      def method_missing(method, *args, &block)
+        # If the @ui object responds to the given method, call it
+        if @ui.respond_to?(method)
+          @ui.send(method, *args, *block)
+        else
+          super(method, *args, &block)
+        end
+      end
+
+      private
+
+      def build_environment
+        @logger.debug("Original environment: #{ENV.inspect}")
+
+        # Remove GEM_ environment variables
+        ["GEM_HOME", "GEM_PATH", "GEMRC"].each { |gem_var| ENV.delete(gem_var) }
+
+        # Create the new PATH removing Vagrant bin directory
+        # and appending directories specified through the
+        # :append_to_path option
+        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"]}")
+
+        # Add the VAGRANT_NO_TRIGGERS variable to avoid loops
+        ENV["VAGRANT_NO_TRIGGERS"] = "1"
+      end
+    end
+  end
+end

data/lib/vagrant-triggers/plugin.rb

@@ -1,7 +1,7 @@
 # This is a sanity check to make sure no one is attempting to install
 # this into an early Vagrant version.
 if Vagrant::VERSION < "1.2.0"
-  raise "The Vagrant Triggers plugin is only compatible with Vagrant 1.1+"
+  raise "The Vagrant Triggers plugin is only compatible with Vagrant 1.2+"
 end
 
 module VagrantPlugins

data/lib/vagrant-triggers/version.rb

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

data/locales/en.yml

@@ -1,5 +1,26 @@
 en:
   vagrant_triggers:
+    action:
+      trigger:
+        command_output: |-
+          Command output:
+          ---------------
+          %{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...
     errors:
       command_failed: |-
         The command "%{command}" returned a failed exit code. The

data/spec/spec_helper.rb

@@ -3,3 +3,5 @@ SimpleCov.start
 
 require "vagrant"
 require_relative "../lib/vagrant-triggers"
+
+VagrantPlugins::Triggers::Plugin.init_i18n

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

@@ -1,4 +1,3 @@
-require "fileutils"
 require "spec_helper"
 
 describe VagrantPlugins::Triggers::Action::Trigger do
@@ -12,171 +11,62 @@ describe VagrantPlugins::Triggers::Action::Trigger do
   let(:ui)             { double("ui", :info => info) }
   let(:info)           { double("info") }
 
-  let(:result)         { double("result", :exit_code => 0, :stderr => stderr) }
-  let(:stderr)         { double("stderr") }
-
   before do
-    @triggers = [ { :action => machine_action, :condition => condition, :options => { :execute => "foo" } } ]
+    trigger_block = Proc.new { nil }
+    @triggers     = [ { :action => machine_action, :condition => condition, :options => { }, :proc => trigger_block } ]
+    machine.stub_chain(:config, :trigger, :deprecation_warning)
     machine.stub_chain(:config, :trigger, :triggers).and_return(@triggers)
   end
 
-  context "with a regular command" do
-    before do
-      Vagrant::Util::Subprocess.stub(:execute => result)
-    end
-
-    it "should skip :environment_load and :environment_unload actions" do
-      [:environment_load, :environment_unload].each do |action|
-        env.stub(:[]).with(:action_name).and_return(action)
-        env.should_not_receive(:[]).with(:machine_action)
-        described_class.new(app, env, condition).call(env)
-      end
-    end
-
-    it "shouldn't fire if machine action is not defined" do
-      env.stub(:[]).with(:action_name)
-      env.stub(:[]).with(:machine_action).and_return(nil)
-      env.should_not_receive(:[]).with(:machine)
-      described_class.new(app, env, condition).call(env)
-    end
-
-    it "should fire trigger when all conditions are satisfied" do
-      Vagrant::Util::Subprocess.should_receive(:execute).with("foo")
-      described_class.new(app, env, condition).call(env)
-    end
-
-    it "should fire all defined triggers" do
-      @triggers << { :action => machine_action, :condition => condition, :options => { :execute => "bar" } }
-      Vagrant::Util::Subprocess.should_receive(:execute).twice
-      described_class.new(app, env, condition).call(env)
-    end
-
-    it "shouldn't execute trigger with no command" do
-      @triggers[0][:options] = {}
-      Vagrant::Util::Subprocess.should_not_receive(:execute)
-      described_class.new(app, env, condition).call(env)
-    end
-
-    it "shouldn't fire trigger when condition doesn't match" do
-      @triggers[0][:condition] = "blah"
-      Vagrant::Util::Subprocess.should_not_receive(:execute)
-      described_class.new(app, env, condition).call(env)
-    end
-
-    it "shouldn't fire trigger when action doesn't match" do
-      @triggers[0][:action] = "blah"
-      Vagrant::Util::Subprocess.should_not_receive(:execute)
-      described_class.new(app, env, condition).call(env)
-    end
-
-    it "should raise an error if executed command exits with non-zero code" do
-      result.stub(:exit_code => 1)
-      expect { described_class.new(app, env, condition).call(env) }.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
-      @triggers[0][:options][:force] = true
-      result.stub(:exit_code => 1)
-      expect { described_class.new(app, env, condition).call(env) }.not_to raise_error()
-    end
-
-    it "should display output if :stdout option was specified" do
-      @triggers[0][:options][:stdout] = true
-      result.stub(:stdout => "Some output")
-      ui.should_receive(:info).with("Command output:\n\nSome output\n")
+  it "should skip :environment_load and :environment_unload actions" do
+    [:environment_load, :environment_unload].each do |action|
+      env.stub(:[]).with(:action_name).and_return(action)
+      VagrantPlugins::Triggers::DSL.should_not_receive(:new)
       described_class.new(app, env, condition).call(env)
     end
   end
 
-  context "with a command not in the PATH" do
-    before do
-      @tmp_dir = Vagrant::Util::Platform.windows? ? ENV["USERPROFILE"] : ENV["HOME"]
-      File.open("#{@tmp_dir}/foo", "w+", 0700) { |file| }
-      File.stub(:executable? => false)
-      File.stub(:executable?).with("#{@tmp_dir}/foo").and_return(true)
-    end
-
-    after do
-      File.delete("#{@tmp_dir}/foo")
-    end
-
-    it "should raise a CommandUnavailable error by default" do
-      expect { described_class.new(app, env, condition).call(env) }.to raise_error(VagrantPlugins::Triggers::Errors::CommandUnavailable)
-    end
-
-    it "should raise a CommandUnavailable error on Windows" do
-      Vagrant::Util::Platform.stub(:windows? => true)
-      expect { described_class.new(app, env, condition).call(env) }.to raise_error(VagrantPlugins::Triggers::Errors::CommandUnavailable)
-    end
-
-    it "should honor the :append_to_path option and restore original path after execution" do
-      @triggers[0][:options][:append_to_path] = @tmp_dir
-      original_path = ENV["PATH"]
-      described_class.new(app, env, condition).call(env)
-      expect(ENV["PATH"]).to eq(original_path)
-    end
-
-    it "should accept an array for the :append_to_path option" do
-      @triggers[0][:options][:append_to_path] = [@tmp_dir, @tmp_dir]
-      expect { described_class.new(app, env, condition).call(env) }.not_to raise_error()
-    end
+  it "shouldn't fire if machine action is not defined" do
+    env.stub(:[]).with(:action_name)
+    env.stub(:[]).with(:machine_action).and_return(nil)
+    VagrantPlugins::Triggers::DSL.should_not_receive(:new)
+    described_class.new(app, env, condition).call(env)
   end
 
-  context "within the Vagrant environment" do
-    before do
-      @original_path      = ENV["PATH"]
-      ENV["EMBEDDED_DIR"] = Vagrant::Util::Platform.windows? ? ENV["USERPROFILE"] : ENV["HOME"]
-      ENV["GEM_HOME"]     = "#{ENV["EMBEDDED_DIR"]}/gems"
-      ENV["GEM_PATH"]     = ENV["GEM_HOME"]
-      ENV["GEMRC"]        = "#{ENV["EMBEDDED_DIR"]}/etc/gemrc"
-      ENV["PATH"]         = "#{ENV["EMBEDDED_DIR"]}/bin:#{ENV["PATH"]}"
-    end
-
-    context "with a command which is present into the Vagrant embedded dir" do
-      before do
-        Dir.mkdir("#{ENV["EMBEDDED_DIR"]}/bin")
-        File.open("#{ENV["EMBEDDED_DIR"]}/bin/foo", "w+", 0700) { |file| }
-      end
-
-      it "should raise a CommandUnavailable error" do
-        expect { described_class.new(app, env, condition).call(env) }.to raise_error(VagrantPlugins::Triggers::Errors::CommandUnavailable)
-      end
+  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)
+    dsl.should_receive(:instance_eval).and_yield
+    described_class.new(app, env, condition).call(env)
+  end
 
-      after do
-        FileUtils.rm_rf("#{ENV["EMBEDDED_DIR"]}/bin")
-      end
-    end
+  it "should fire all defined triggers" do
+    @triggers << @triggers.first
+    VagrantPlugins::Triggers::DSL.should_receive(:new).twice
+    described_class.new(app, env, condition).call(env)
+  end
 
-    it "should not pass GEM_HOME to the executed command" do
-      Vagrant::Util::Subprocess.should_receive(:execute) do |command|
-        expect(ENV).not_to have_key("GEM_HOME")
-        result
-      end
-      described_class.new(app, env, condition).call(env)
-    end
+  it "shouldn't execute trigger with no command or block" do
+    @triggers[0][:proc] = nil
+    VagrantPlugins::Triggers::DSL.should_not_receive(:new)
+    described_class.new(app, env, condition).call(env)
+  end
 
-    it "should not pass GEM_PATH to the executed command" do
-      Vagrant::Util::Subprocess.should_receive(:execute) do |command|
-        expect(ENV).not_to have_key("GEM_PATH")
-        result
-      end
-      described_class.new(app, env, condition).call(env)
-    end
+  it "shouldn't fire trigger when condition doesn't match" do
+    @triggers[0][:condition] = "blah"
+    VagrantPlugins::Triggers::DSL.should_not_receive(:new)
+    described_class.new(app, env, condition).call(env)
+  end
 
-    it "should not pass GEMRC to the executed command" do
-      Vagrant::Util::Subprocess.should_receive(:execute) do |command|
-        expect(ENV).not_to have_key("GEMRC")
-        result
-      end
-      described_class.new(app, env, condition).call(env)
-    end
+  it "shouldn't fire trigger when action doesn't match" do
+    @triggers[0][:action] = "blah"
+    VagrantPlugins::Triggers::DSL.should_not_receive(:new)
+    described_class.new(app, env, condition).call(env)
+  end
 
-    after do
-      ENV["EMBEDDED_DIR"] = nil
-      ENV["GEM_HOME"]     = nil
-      ENV["GEM_PATH"]     = nil
-      ENV["GEMRC"]        = nil
-      ENV["PATH"]         = @original_path
-    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)
   end
 end

data/spec/vagrant-triggers/config_spec.rb

@@ -16,25 +16,32 @@ describe VagrantPlugins::Triggers::Config do
 
   describe "add triggers" do
     it "should add before triggers" do
-      config.before :up, :exec => "echo ls"
-      expect(config.triggers.first).to eq({ :action => :up, :condition => :before, :options => { :exec => "echo ls" } })
+      config.before(:up) { run "ls" }
+      expect(config.triggers).to have(1).item
     end
 
     it "should add after triggers" do
-      config.after :up, :exec => "echo ls"
-      expect(config.triggers.first).to eq({ :action => :up, :condition => :after, :options => { :exec => "echo ls" } })
+      config.after(: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
     end
   end
 
   describe "accept multiple entries" do
     it "should record multiple entries" do
-      config.before :up, :exec => "echo ls"
-      config.after :up, :exec => "echo ls"
+      config.before(:up) { run "ls" }
+      config.after(:up) { run "ls" }
       expect(config.triggers).to have(2).items
     end
 
     it "should record multiple entries if the action is an array" do
-      config.before [:up, :halt], :exec => "echo ls"
+      config.before([:up, :halt]) { run "ls" }
       expect(config.triggers).to have(2).items
     end
   end

data/spec/vagrant-triggers/dsl_spec.rb

@@ -0,0 +1,133 @@
+require "fileutils"
+require "spec_helper"
+
+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") }
+
+  before do
+    @command = "foo"
+    @dsl     = described_class.new(ui, {})
+  end
+
+  context "method missing" do
+    it "acts as proxy if the ui object respond to the called method" do
+      ui.stub(:foo).and_return("bar")
+      expect(@dsl.foo).to eq("bar")
+    end
+  end
+
+  context "run a regular command" do
+    before do
+      Vagrant::Util::Subprocess.stub(:execute => result)
+    end
+
+    it "should raise an error if executed command exits with non-zero code" do
+      result.stub(:exit_code => 1)
+      expect { @dsl.run(@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(ui, :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")
+      ui.should_receive(:info).with(/Some output/)
+      dsl.run(@command)
+    end
+
+    it "should pass VAGRANT_NO_TRIGGERS environment variable to the command" do
+      Vagrant::Util::Subprocess.should_receive(:execute) do |command|
+        expect(ENV).to have_key("VAGRANT_NO_TRIGGERS")
+        result
+      end
+      @dsl.run(@command)
+    end
+  end
+
+  context "run a command not in the PATH" do
+    before do
+      @tmp_dir = Vagrant::Util::Platform.windows? ? ENV["USERPROFILE"] : ENV["HOME"]
+      File.open("#{@tmp_dir}/#{@command}", "w+", 0700) { |file| }
+      File.stub(:executable? => false)
+      File.stub(:executable?).with("#{@tmp_dir}/#{@command}").and_return(true)
+    end
+
+    after do
+      File.delete("#{@tmp_dir}/#{@command}")
+    end
+
+    it "should raise a CommandUnavailable error by default" do
+      expect { @dsl.run(@command) }.to raise_error(VagrantPlugins::Triggers::Errors::CommandUnavailable)
+    end
+
+    it "should raise a CommandUnavailable error on Windows" do
+      Vagrant::Util::Platform.stub(:windows? => true)
+      expect { @dsl.run(@command) }.to raise_error(VagrantPlugins::Triggers::Errors::CommandUnavailable)
+    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)
+      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])
+      expect { dsl.run(@command) }.not_to raise_error()
+    end
+  end
+
+  context "run a command simulating the Vagrant environment" do
+    before do
+      @original_path                        = ENV["PATH"]
+      ENV["VAGRANT_INSTALLER_ENV"]          = "1"
+      ENV["VAGRANT_INSTALLER_EMBEDDED_DIR"] = Vagrant::Util::Platform.windows? ? ENV["USERPROFILE"] : ENV["HOME"]
+      ENV["GEM_HOME"]                       = "#{ENV["VAGRANT_INSTALLER_EMBEDDED_DIR"]}/gems"
+      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"]}"
+    end
+
+    context "with a command which is present into the Vagrant embedded dir" do
+      before do
+        Dir.mkdir("#{ENV["VAGRANT_INSTALLER_EMBEDDED_DIR"]}/bin")
+        File.open("#{ENV["VAGRANT_INSTALLER_EMBEDDED_DIR"]}/bin/#{@command}", "w+", 0700) { |file| }
+      end
+
+      it "should raise a CommandUnavailable error" do
+        expect { @dsl.run(@command) }.to raise_error(VagrantPlugins::Triggers::Errors::CommandUnavailable)
+      end
+
+      after do
+        FileUtils.rm_rf("#{ENV["VAGRANT_INSTALLER_EMBEDDED_DIR"]}/bin")
+      end
+    end
+
+    ["GEM_HOME", "GEM_PATH", "GEMRC"].each do |env_var|
+      it "should not pass #{env_var} to the executed command" do
+        Vagrant::Util::Subprocess.should_receive(:execute) do |command|
+          expect(ENV).not_to have_key(env_var)
+          result
+        end
+        @dsl.run(@command)
+      end
+    end
+
+    after do
+      ENV["EMBEDDED_DIR"] = nil
+      ENV["GEM_HOME"]     = nil
+      ENV["GEM_PATH"]     = nil
+      ENV["GEMRC"]        = nil
+      ENV["PATH"]         = @original_path
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-triggers
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Emiliano Ticci
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-01 00:00:00.000000000 Z
+date: 2014-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -64,6 +64,7 @@ files:
 - lib/vagrant-triggers/action/trigger.rb
 - lib/vagrant-triggers/action.rb
 - lib/vagrant-triggers/config.rb
+- lib/vagrant-triggers/dsl.rb
 - lib/vagrant-triggers/errors.rb
 - lib/vagrant-triggers/plugin.rb
 - lib/vagrant-triggers/version.rb
@@ -75,6 +76,7 @@ files:
 - spec/spec_helper.rb
 - spec/vagrant-triggers/action/trigger_spec.rb
 - spec/vagrant-triggers/config_spec.rb
+- spec/vagrant-triggers/dsl_spec.rb
 - spec/vagrant-triggers/vagrant_spec.rb
 - vagrant-triggers.gemspec
 - .gitignore
@@ -106,4 +108,5 @@ test_files:
 - spec/spec_helper.rb
 - spec/vagrant-triggers/action/trigger_spec.rb
 - spec/vagrant-triggers/config_spec.rb
+- spec/vagrant-triggers/dsl_spec.rb
 - spec/vagrant-triggers/vagrant_spec.rb