vagrant-triggers 0.2.1 → 0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 66df1e94338bdbd5b8ea22fa123abc641dbc9e05
+  data.tar.gz: 1310d39fe9e67faaac2a2784b6ed841939a7092e
+SHA512:
+  metadata.gz: 3cd9b20a5e2fdb1f15c702502f008fb89afbb91d3685874c4270bde7000bce13cb44506203085c5e651af3d9900dd655c01743e13bed877c6134b7773c39e7cf
+  data.tar.gz: 600308d8966f0b35fba1c2a17698382ecce0c80054f02103374124144f94345a4e560a301ce47ef97f3bdc85fd90bd99351470dd4c38f7580b3e3fb46b02dab5

data/.gitignore

@@ -4,6 +4,8 @@
 pkg/*
 Gemfile.lock
 
+coverage
+
 .rspec
 
 .vagrant

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 1.9.3
+env:
+  - VAGRANT_VERSION=v1.4.3
+matrix:
+  include:
+    - env: VAGRANT_VERSION=v1.3.5
+      rvm: 1.9.3
+    - env: VAGRANT_VERSION=v1.2.7
+      rvm: 1.9.3

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 0.2.2 (unreleased)
+
+NEW FEATURES:
+
+  - Add ```:info``` as an alternative to ```:execute```.
+
+BUG FIXES:
+
+  - Remove Vagrant specific environment variables when executing commands [(#5)](https://github.com/emyl/vagrant-triggers/issues/2)
+
 ## 0.2.1 (November 19, 2013)
 
 BUG FIXES:

data/Gemfile

@@ -3,5 +3,9 @@ source 'https://rubygems.org'
 gemspec
 
 group :development do
-  gem "vagrant", :git => "git://github.com/mitchellh/vagrant.git"
+  gem "vagrant", :github => "mitchellh/vagrant", :ref => ENV.fetch("VAGRANT_VERSION", "v1.4.3")
+end
+
+group :test do
+  gem "simplecov", :require => false
 end

data/README.md

@@ -1,13 +1,15 @@
 # vagrant-triggers
 
+[![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.
 
 ## Installation
 
-Ensure you have downloaded and installed Vagrant from the
+Ensure you have downloaded and installed Vagrant 1.2+ from the
 [Vagrant downloads page](http://downloads.vagrantup.com/).
 
-Installation is performed in the prescribed manner for Vagrant 1.1+ plugins.
+Installation is performed in the prescribed manner for Vagrant plugins:
 
     $ vagrant plugin install vagrant-triggers
 
@@ -30,6 +32,8 @@ The first argument is the command in which the trigger will be tied. It could be
 ### 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)
 * ```:stdout => true```: display script output
@@ -53,7 +57,7 @@ Vagrant.configure("2") do |config|
   }.each do |command, trigger|
     config.trigger.before command, :execute => "vboxmanage #{trigger}", :stdout => true
   end
-  
+
 end
 ```
 

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

@@ -15,30 +15,36 @@ module VagrantPlugins
 
         def call(env)
           fire_triggers
-          
+
           # Carry on
           @app.call(env)
         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"]}")
+        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
-            @logger.debug("Command not found in the path.")
-            @logger.debug("Current PATH: #{ENV["PATH"]}")
-            new_path = Array(@options[:append_to_path]).join(File::PATH_SEPARATOR)
-            @logger.debug("Temporary replacing the system PATH with #{new_path}.")
-            unless new_path.empty?
-              new_env = env_backup.dup
-              new_env.delete("PATH")
-              new_env["PATH"] = new_path
-              ENV.replace(new_env)
-              @options[:append_to_path] = nil
-              retry
-            end
             raise Errors::CommandUnavailable, :command => command[0]
           ensure
             ENV.replace(env_backup)
@@ -65,6 +71,8 @@ module VagrantPlugins
               @options = trigger[:options]
               if @options[:execute]
                 execute(@options[:execute])
+              elsif @options[:info]
+                @env[:ui].info @options[:info]
               else
                 @logger.debug("Trigger command not found.")
               end
@@ -74,4 +82,4 @@ module VagrantPlugins
       end
     end
   end
-end
+end

data/lib/vagrant-triggers/plugin.rb

@@ -1,12 +1,6 @@
-begin
-  require "vagrant"
-rescue LoadError
-  raise "The Vagrant Triggers plugin must be run within Vagrant."
-end
-
 # This is a sanity check to make sure no one is attempting to install
 # this into an early Vagrant version.
-if Vagrant::VERSION < "1.1.0"
+if Vagrant::VERSION < "1.2.0"
   raise "The Vagrant Triggers plugin is only compatible with Vagrant 1.1+"
 end
 
@@ -28,7 +22,7 @@ module VagrantPlugins
           hook.append(Action.action_trigger(:after))
         end
       end
-      
+
       config(:trigger) do
         require_relative "config"
         Config
@@ -42,4 +36,4 @@ module VagrantPlugins
       end
     end
   end
-end
+end

data/lib/vagrant-triggers/version.rb

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

data/spec/spec_helper.rb

@@ -1 +1,5 @@
-require_relative "../lib/vagrant-triggers"
+require "simplecov"
+SimpleCov.start
+
+require "vagrant"
+require_relative "../lib/vagrant-triggers"

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

@@ -1,6 +1,5 @@
+require "fileutils"
 require "spec_helper"
-require "vagrant/util/platform"
-require "vagrant/util/subprocess"
 
 describe VagrantPlugins::Triggers::Action::Trigger do
   let(:app)            { lambda { |env| } }
@@ -80,6 +79,13 @@ describe VagrantPlugins::Triggers::Action::Trigger do
       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")
+      described_class.new(app, env, condition).call(env)
+    end
   end
 
   context "with a command not in the PATH" do
@@ -115,4 +121,62 @@ describe VagrantPlugins::Triggers::Action::Trigger do
       expect { described_class.new(app, env, condition).call(env) }.not_to raise_error()
     end
   end
-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
+
+      after do
+        FileUtils.rm_rf("#{ENV["EMBEDDED_DIR"]}/bin")
+      end
+    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 "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 "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
+
+    after do
+      ENV["EMBEDDED_DIR"] = nil
+      ENV["GEM_HOME"]     = nil
+      ENV["GEM_PATH"]     = nil
+      ENV["GEMRC"]        = nil
+      ENV["PATH"]         = @original_path
+    end
+  end
+end

data/spec/vagrant-triggers/config_spec.rb

@@ -14,6 +14,18 @@ describe VagrantPlugins::Triggers::Config do
     its("triggers") { should eq [] }
   end
 
+  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" } })
+    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" } })
+    end
+  end
+
   describe "accept multiple entries" do
     it "should record multiple entries" do
       config.before :up, :exec => "echo ls"
@@ -38,4 +50,4 @@ describe VagrantPlugins::Triggers::Config do
       expect(config.validate(machine)["triggers"]).to have(1).item
     end
   end
-end
+end

data/spec/vagrant-triggers/vagrant_spec.rb

@@ -0,0 +1,6 @@
+describe "Vagrant" do
+  it "can run vagrant with the plugin loaded" do
+    env = Vagrant::Environment.new
+    expect(env.cli("-h")).to eq(0)
+  end
+end

data/vagrant-triggers.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.email         = "emiticci@gmail.com"
   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."
-  
+
   # 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
   # this gemspec is, and parsing out the ignored files from the gitignore.
@@ -17,6 +17,7 @@ Gem::Specification.new do |spec|
   root_path      = File.dirname(__FILE__)
   all_files      = Dir.chdir(root_path) { Dir.glob("**/{*,.*}") }
   all_files.reject! { |file| [".", ".."].include?(File.basename(file)) }
+  all_files.reject! { |file| file.start_with?("coverage/") }
   gitignore_path = File.join(root_path, ".gitignore")
   gitignore      = File.readlines(gitignore_path)
   gitignore.map!    { |line| line.chomp.strip }

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-triggers
 version: !ruby/object:Gem::Version
-  version: 0.2.1
-  prerelease: 
+  version: 0.2.2
 platform: ruby
 authors:
 - Emiliano Ticci
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-19 00:00:00.000000000 Z
+date: 2014-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,33 +27,29 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: This plugin allow the definition of arbitrary scripts that will run on
@@ -82,39 +75,35 @@ files:
 - spec/spec_helper.rb
 - spec/vagrant-triggers/action/trigger_spec.rb
 - spec/vagrant-triggers/config_spec.rb
+- spec/vagrant-triggers/vagrant_spec.rb
 - vagrant-triggers.gemspec
 - .gitignore
+- .travis.yml
 homepage: 
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2957871706623383121
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2957871706623383121
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.14
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Triggers for Vagrant commands.
 test_files:
 - spec/spec_helper.rb
 - spec/vagrant-triggers/action/trigger_spec.rb
 - spec/vagrant-triggers/config_spec.rb
+- spec/vagrant-triggers/vagrant_spec.rb