vagrant-triggers 0.1.0

data/.gitignore

@@ -0,0 +1,11 @@
+.DS_Store
+
+.bundle
+pkg/*
+Gemfile.lock
+
+.rspec
+
+.vagrant
+.vagrant.d/*
+Vagrantfile

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem "vagrant", :git => "git://github.com/mitchellh/vagrant.git"
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Emiliano Ticci
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+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.

data/README.md

@@ -0,0 +1,65 @@
+# 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
+[Vagrant downloads page](http://downloads.vagrantup.com/).
+
+Installation is performed in the prescribed manner for Vagrant 1.1+ plugins.
+
+    $ vagrant plugin install vagrant-triggers
+
+## Usage
+
+### Basic usage
+
+The following ```Vagrantfile``` configuration options are added:
+
+```
+config.trigger.before :command, :execute => "script"
+```
+
+```
+config.trigger.after :command, :execute => "script"
+```
+
+### Options
+
+* ```:execute => "script"```: the script to execute
+* ```:force => true```: continue even if the script fails (exits with non-zero code)
+* ```:stdout => true```: display script output
+
+## 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:
+
+```ruby
+
+Vagrant.configure("2") do |config|
+
+  {
+    :halt => "controlvm 22aed8b3-d246-40d5-8ad4-176c17552c43 acpipowerbutton",
+    :resume => "startvm 22aed8b3-d246-40d5-8ad4-176c17552c43 --type headless",
+    :suspend => "controlvm 22aed8b3-d246-40d5-8ad4-176c17552c43 savestate",
+    :up => "startvm 22aed8b3-d246-40d5-8ad4-176c17552c43 --type headless"
+  }.each do |command, trigger|
+    config.trigger.before command, :execute => "vboxmanage #{trigger}", :stdout => true
+  end
+  
+end
+```
+
+## Contributing
+
+To contribute, clone the repository, and use [Bundler](http://bundler.io/)
+to install dependencies:
+
+    $ bundle
+
+To run the plugin's tests:
+
+    $ bundle exec rake
+
+You can now fork this repository, make your changes and send a pull request.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => "spec"

data/lib/vagrant-triggers.rb

@@ -0,0 +1,18 @@
+require "pathname"
+require "vagrant-triggers/plugin"
+
+module VagrantPlugins
+  module Triggers
+    lib_path = Pathname.new(File.expand_path("../vagrant-triggers", __FILE__))
+    autoload :Action,   lib_path.join("action")
+    autoload :Config,   lib_path.join("config")
+    autoload :Errors,   lib_path.join("errors")
+    
+    # This returns the path to the source of this plugin.
+    #
+    # @return [Pathname]
+    def self.source_root
+      @source_root ||= Pathname.new(File.expand_path("../../", __FILE__))
+    end
+  end
+end

data/lib/vagrant-triggers/action.rb

@@ -0,0 +1,15 @@
+module VagrantPlugins
+  module Triggers
+    module Action
+      def self.action_trigger(condition)
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use Trigger, condition
+        end
+      end
+
+      # Autoload farm
+      action_root = Pathname.new(File.expand_path("../action", __FILE__))
+      autoload :Trigger, action_root.join("trigger")
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+require "log4r"
+require "shellwords"
+require "vagrant/util/subprocess"
+
+module VagrantPlugins
+  module Triggers
+    module Action
+      class Trigger
+        def initialize(app, env, condition)
+          @app       = app
+          @condition = condition
+          @env       = env
+          @logger    = Log4r::Logger.new("vagrant::plugins::triggers::trigger")
+        end
+
+        def call(env)
+          fire_triggers
+          
+          # Carry on
+          @app.call(env)
+        end
+
+        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]
+          # 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?
+            @env[:ui].info "Running triggers #{@condition} action..."
+            triggers_to_fire.each do |trigger|
+              options = trigger[:options]
+              if options[:execute]
+                raw_command = options[:execute]
+                @env[:ui].info 'Executing command "' + raw_command + '"...'
+                command     = Shellwords.shellsplit(raw_command)
+                result      = Vagrant::Util::Subprocess.execute(command[0], *command[1..-1])
+                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
+              else
+                @logger.debug("Trigger command not found.")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-triggers/config.rb

@@ -0,0 +1,29 @@
+module VagrantPlugins
+  module Triggers
+    class Config < Vagrant.plugin("2", :config)
+      attr_reader :triggers
+      
+      def initialize
+        @triggers = []
+      end
+
+      def after(action, options = {})
+        @triggers << { :action => action, :condition => :after, :options => options }
+      end
+
+      def before(action, options = {})
+        @triggers << { :action => action, :condition => :before, :options => options }
+      end      
+
+      def validate(machine)
+        errors = []
+
+        if @__invalid_methods && !@__invalid_methods.empty?
+          errors << I18n.t("vagrant.config.common.bad_field", :fields => @__invalid_methods.to_a.sort.join(", "))
+        end
+
+        { "triggers" => errors }
+      end
+    end
+  end
+end

data/lib/vagrant-triggers/errors.rb

@@ -0,0 +1,13 @@
+module VagrantPlugins
+  module Triggers
+    module Errors
+      class VagrantTriggerError < Vagrant::Errors::VagrantError
+        error_namespace("vagrant_triggers.errors")
+      end
+
+      class CommandFailed < VagrantTriggerError
+        error_key(:command_failed)
+      end
+    end
+  end
+end

data/lib/vagrant-triggers/plugin.rb

@@ -0,0 +1,43 @@
+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"
+  raise "The Vagrant Triggers plugin is only compatible with Vagrant 1.1+"
+end
+
+module VagrantPlugins
+  module Triggers
+    class Plugin < Vagrant.plugin("2")
+      name "Triggers"
+      description <<-DESC
+      This plugin allow the definition of arbitrary scripts that
+      will run on the host before and/or after Vagrant commands.
+      DESC
+
+      action_hook(:init_i18n, :environment_load) { init_i18n }
+
+      action_hook(:trigger, Plugin::ALL_ACTIONS) do |hook|
+        require_relative "action"
+        hook.prepend(Action.action_trigger(:before))
+        hook.append(Action.action_trigger(:after))
+      end
+      
+      config(:trigger) do
+        require_relative "config"
+        Config
+      end
+
+      # This initializes the I18n load path so that the plugin specific
+      # transations work.
+      def self.init_i18n
+        I18n.load_path << File.expand_path("locales/en.yml", Triggers.source_root)
+        I18n.reload!
+      end
+    end
+  end
+end

data/lib/vagrant-triggers/version.rb

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module Triggers
+    VERSION = "0.1.0"
+  end
+end

data/locales/en.yml

@@ -0,0 +1,8 @@
+en:
+  vagrant_triggers:
+    errors:
+      command_failed: |-
+        The command "%{command}" returned a failed exit code. The
+        error output is shown below:
+
+        %{stderr}

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require_relative "../lib/vagrant-triggers"

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

@@ -0,0 +1,78 @@
+require "spec_helper"
+require "vagrant/util/subprocess"
+
+describe VagrantPlugins::Triggers::Action::Trigger do
+  let(:app)            { lambda { |env| } }
+  let(:env)            { { :action_name => action_name, :machine => machine, :machine_action => machine_action, :ui => ui } }
+  let(:condition)      { double("condition") }
+  let(:action_name)    { double("action_name") }
+  let(:machine)        { double("machine") }
+  let(:machine_action) { double("machine_action") }
+
+  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" } } ]
+    machine.stub_chain(:config, :trigger, :triggers).and_return(@triggers)
+    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) }.to_not raise_error()
+  end
+end

data/spec/vagrant-triggers/config_spec.rb

@@ -0,0 +1,36 @@
+require "spec_helper"
+
+describe VagrantPlugins::Triggers::Config do
+  let(:config)  { described_class.new }
+  let(:machine) { double("machine") }
+
+  describe "defaults" do
+    subject do
+      config.tap do |o|
+        o.finalize!
+      end
+    end
+
+    its("triggers") { should eq [] }
+  end
+
+  describe "accept multiple entries" do
+    it "should record multiple entries" do
+      config.before :up, :exec => "echo ls"
+      config.after :up, :exec => "echo ls"
+      expect(config.triggers).to have(2).items
+    end
+  end
+
+  describe "validation" do
+    it "should validate" do
+      config.finalize!
+      expect(config.validate(machine)["triggers"]).to have(:no).items
+    end
+
+    it "shouldn't accept invalid methods" do
+      config.foo "bar"
+      expect(config.validate(machine)["triggers"]).to have(1).item
+    end
+  end
+end

data/vagrant-triggers.gemspec

@@ -0,0 +1,51 @@
+$:.unshift File.expand_path("../lib", __FILE__)
+require "vagrant-triggers/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "vagrant-triggers"
+  spec.version       = VagrantPlugins::Triggers::VERSION
+  spec.authors       = "Emiliano Ticci"
+  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.
+  # Note that the entire gitignore(5) syntax is not supported, specifically
+  # the "!" syntax, but it should mostly work correctly.
+  root_path      = File.dirname(__FILE__)
+  all_files      = Dir.chdir(root_path) { Dir.glob("**/{*,.*}") }
+  all_files.reject! { |file| [".", ".."].include?(File.basename(file)) }
+  gitignore_path = File.join(root_path, ".gitignore")
+  gitignore      = File.readlines(gitignore_path)
+  gitignore.map!    { |line| line.chomp.strip }
+  gitignore.reject! { |line| line.empty? || line =~ /^(#|!)/ }
+
+  unignored_files = all_files.reject do |file|
+    # Ignore any directories, the gemspec only cares about files
+    next true if File.directory?(file)
+
+    # Ignore any paths that match anything in the gitignore. We do
+    # two tests here:
+    #
+    #   - First, test to see if the entire path matches the gitignore.
+    #   - Second, match if the basename does, this makes it so that things
+    #     like '.DS_Store' will match sub-directories too (same behavior
+    #     as git).
+    #
+    gitignore.any? do |ignore|
+      File.fnmatch(ignore, file, File::FNM_PATHNAME) ||
+        File.fnmatch(ignore, File.basename(file), File::FNM_PATHNAME)
+    end
+  end
+
+  spec.files        = unignored_files
+  spec.executables  = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files   = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_path = "lib"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-triggers
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Emiliano Ticci
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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
+  the host before and/or after Vagrant commands.
+email: emiticci@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- lib/vagrant-triggers/action/trigger.rb
+- lib/vagrant-triggers/action.rb
+- lib/vagrant-triggers/config.rb
+- lib/vagrant-triggers/errors.rb
+- lib/vagrant-triggers/plugin.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_spec.rb
+- vagrant-triggers.gemspec
+- .gitignore
+homepage: 
+licenses: []
+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: -3600971872626738108
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3600971872626738108
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Triggers for Vagrant commands.
+test_files:
+- spec/spec_helper.rb
+- spec/vagrant-triggers/action/trigger_spec.rb
+- spec/vagrant-triggers/config_spec.rb