vagrant-recipe 0.1.0

data/Gemfile

@@ -0,0 +1,10 @@
+source 'http://rubygems.org'
+
+gemspec
+
+group :development do
+  # We depend on Vagrant for development, but we don't add it as a
+  # gem dependency because we expect to be installed within the
+  # Vagrant environment itself using `vagrant plugin`.
+  gem 'vagrant', git: 'git://github.com/mitchellh/vagrant.git'
+end

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2013-2013 Raul Simiciuc
+
+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,87 @@
+vagrant-recipe [![Gem Version](https://badge.fury.io/rb/vagrant-exec.png)](http://badge.fury.io/rb/vagrant-exec)
+===============
+
+Vagrant plugin to execute chef recipes.
+
+Description
+-----------
+
+Use this plugin to run your recipes at any time.
+
+Example
+-------
+
+```shell
+➜ vagrant run-recipe SystemSetup::default
+```
+
+Installation
+------------
+
+```shell
+➜ vagrant plugin install vagrant-recipe
+```
+
+Configuration
+-------------
+
+### Chef exec file and chef json config file
+
+The root directory can be configured using Vagrantfile.
+
+```ruby
+Vagrant.configure('2') do |config|
+  config.vm.box = 'precise32'
+  # set this value if your solo exec file is different from /tmp/vagrant-chef-1/solo.rb
+  config.recipe.chef = '/tmp/vagrant-chef-1/solo.rb'
+  
+  # set this value if your json confi file is different from /tmp/vagrant-chef-1/dna.json
+  config.recipe.json = '/tmp/vagrant-chef-1/dna.json'
+end
+```
+
+```shell
+➜ vagrant run-recipe SystemSetup
+# is the same as
+➜ vagrant ssh -c "sudo chef-solo -c /tmp/vagrant-chef-1/solo.rb -j /tmp/vagrant-chef-1/dna.json --override-runlist \"recipe[SystemSetup::default]\""
+```
+
+### Bundler
+
+You can enable bundler to prepend each command with `bundle exec`. Note that it won't be done for commands starting with `bundle` (e.g. `bundle install`).
+
+```ruby
+Vagrant.configure('2') do |config|
+  config.vm.box = 'precise32'
+  config.recipe.bundler = true
+end
+```
+
+```shell
+➜ vagrant recipe SystemSetup
+# is the same as
+➜ vagrant ssh -c "cd /vagrant && bundle exec sudo chef-solo -c /tmp/vagrant-chef-1/solo.rb -j /tmp/vagrant-chef-1/dna.json --override-runlist \"recipe[SystemSetup::default]\""
+```
+
+### Environment variables
+
+You can add environment variables to be exported before.
+
+```ruby
+Vagrant.configure('2') do |config|
+  config.vm.box = 'precise32'
+  config.recipe.env['RAILS_ENV'] = 'test'
+  config.recipe.env['RAILS_ROOT'] = '/vagrant'
+end
+```
+
+```shell
+➜ vagrant exec SystemSetup
+# is the same as
+➜ vagrant ssh -c "export RAILS_ENV=test && export RAILS_ROOT=/vagrant && sudo chef-solo -c /tmp/vagrant-chef-1/solo.rb -j /tmp/vagrant-chef-1/dna.json --override-runlist \"recipe[SystemSetup::default]\""
+```
+
+Copyright
+---------
+
+Copyright (c) 2013-2013 Raul Simiciuc. See LICENSE.md for details.

data/Rakefile

@@ -0,0 +1,20 @@
+require 'bundler'
+require 'cucumber/rake/task'
+Bundler::GemHelper.install_tasks
+
+namespace :features do
+  desc 'Downloads and adds vagrant box for testing.'
+  task(:bootstrap) do
+    system('bundle exec vagrant box add vagrant_recipe http://cloud-images.ubuntu.com/vagrant/precise/current/precise-server-cloudimg-amd64-vagrant-disk1.box')
+  end
+
+  Cucumber::Rake::Task.new(:run) do |t|
+    t.cucumber_opts = %w(--format pretty)
+  end
+
+  desc 'Removes testing vagrant box .'
+  task(:cleanup) do
+    system('bundle exec vagrant destroy -f')
+    system('bundle exec vagrant box remove vagrant_recipe virtualbox')
+  end
+end

data/features/step_definitions/steps.rb

@@ -0,0 +1,49 @@
+Given(/^I have default Vagrantfile$/) do
+  vagrantfile = <<-RUBY
+Vagrant.require_plugin 'vagrant-exec'
+
+Vagrant.configure('2') do |config|
+  config.vm.box = 'vagrant_exec'
+end
+  RUBY
+  step 'a file named "Vagrantfile" with:', vagrantfile
+end
+
+
+Given(/^I set vagrant-exec folder to (.+)$/) do |folder|
+  config = <<-RUBY
+
+Vagrant.configure('2') do |config|
+  config.exec.folder = #{folder}
+end
+  RUBY
+  step 'I append to "Vagrantfile" with:', config
+end
+
+
+Given(/^I set vagrant-exec bundler to (.+)$/) do |bundler|
+  config = <<-RUBY
+
+Vagrant.configure('2') do |config|
+  config.exec.bundler = #{bundler}
+end
+  RUBY
+  step 'I append to "Vagrantfile" with:', config
+end
+
+
+Given(/^I set vagrant-exec env with the following values:$/) do |table|
+  data = table.hashes
+  config = data.map do |hash|
+    key, value = "#{hash['key']}", "#{hash['value']}"
+    %(config.exec.env['#{key}'] = '#{value}')
+  end
+
+  config = <<-RUBY
+
+Vagrant.configure('2') do |config|
+  #{config.join("\n\s\s")}
+end
+  RUBY
+  step 'I append to "Vagrantfile" with:', config
+end

data/features/support/env.rb

@@ -0,0 +1,12 @@
+require 'aruba/cucumber'
+ENV['VAGRANT_LOG'] = 'info'
+
+Before do
+  # VM start takes a long time
+  @aruba_timeout_seconds = 60
+end
+
+After do
+  # halt VM
+  system "cd tmp/aruba; bundle exec vagrant halt &> /dev/null"
+end

data/features/vagrant-recipe.feature

@@ -0,0 +1,91 @@
+@no-clobber
+Feature: vagrant-exec
+  In order to execute commands in Vagrant box
+  Within context of root synced folder
+  As a developer using vagrant-exec plugin
+  I want to use "vagrant exec" command
+  And be able to customize folder
+  And prepend commands with "bundle exec"
+  And set exported environmental variables
+  Using Vagrantfile configuration
+
+  Background:
+    Given I have default Vagrantfile
+
+  Scenario: uses /vagrant as default folder
+    Given I run `bundle exec vagrant up`
+    When I run `bundle exec vagrant exec pwd`
+    Then the exit status should be 0
+    And the output should contain "Executing single command on remote machine: cd /vagrant && pwd"
+
+  Scenario: can use custom folder
+    Given I set vagrant-exec folder to "/tmp"
+    And I run `bundle exec vagrant up`
+    When I run `bundle exec vagrant exec pwd`
+    Then the exit status should be 0
+    And the output should contain "Executing single command on remote machine: cd /tmp && pwd"
+
+  Scenario: raises error if folder is improperly set
+    Given I set vagrant-exec folder to true
+    And I run `bundle exec vagrant up`
+    Then the exit status should not be 0
+    And the output should contain "folder should be a string"
+
+  Scenario: does not use bundler by default
+    Given I run `bundle exec vagrant up`
+    When I run `bundle exec vagrant exec pwd`
+    Then the output should not contain "bundle exec"
+
+  # we don't have bundler in box
+  Scenario: can use bundler
+    Given I set vagrant-exec bundler to true
+    And I run `bundle exec vagrant up`
+    When I run `bundle exec vagrant exec pwd`
+    Then the exit status should not be 0
+    And the output should contain "Executing single command on remote machine: cd /vagrant && bundle exec pwd"
+
+  Scenario: does not use bundler for bundle commands
+    Given I set vagrant-exec bundler to true
+    And I run `bundle exec vagrant up`
+    When I run `bundle exec vagrant exec bundle install`
+    Then the output should contain "Executing single command on remote machine: cd /vagrant && bundle install"
+
+  Scenario: raises error if bundler is improperly set
+    Given I set vagrant-exec bundler to "true"
+    When I run `bundle exec vagrant up`
+    Then the exit status should not be 0
+    And the output should contain "bundler should be boolean"
+
+  Scenario: can export environment variables
+    Given I set vagrant-exec env with the following values:
+      | key   | value |
+      | TEST1 | true  |
+      | TEST2 | false |
+    And I run `bundle exec vagrant up`
+    When I run `bundle exec vagrant exec pwd`
+    Then the exit status should be 0
+    And the output should contain "Executing single command on remote machine: cd /vagrant && export TEST1=true && export TEST2=false && pwd"
+
+  Scenario Outline: shows help correctly
+    Given I run `bundle exec vagrant up`
+    When I run `bundle exec vagrant exec <args>`
+    Then the output should contain "Usage: vagrant exec [options] <command>"
+    Examples:
+      | args          |
+      |               |
+      | -h            |
+      | --help        |
+      | -h pwd        |
+      | --help pwd -h |
+
+  Scenario Outline: passes command arguments correctly
+    Given I run `bundle exec vagrant up`
+    When I run `bundle exec vagrant exec <cmd>`
+    Then the output should contain "Executing single command on remote machine: cd /vagrant && <cmd>"
+    Examples:
+      | cmd                 |
+      | cwd .               |
+      | cwd ~               |
+      | cwd -h              |
+      | cwd --blah          |
+      | cwd -h blah -v blah |

data/lib/vagrant-recipe/command.rb

@@ -0,0 +1,72 @@
+module VagrantPlugins
+  module Recipe
+    class Command < Vagrant.plugin(2, :command)
+
+      def execute
+        cmd, cmd_args = parse_args
+        cmd && cmd_args or return nil
+
+        # Execute the actual SSH
+        with_target_vms(nil, single_target: true) do |vm|
+          vm.config.recipe.finalize! # TODO: do we have to call it explicitly?
+
+          plain   = "sudo chef-solo -c #{vm.config.recipe.chef} -j #{vm.config.recipe.json} --override-runlist \"recipe[#{cmd}]\""
+          command = ""
+
+          command << add_env(vm.config.exec.env)
+          command << add_bundler(vm.config.exec.bundler, plain)
+          command << plain
+
+          @logger.info("Executing recipe on remote machine: #{command}")
+          env = vm.action(:ssh_run, ssh_run_command: command)
+
+          status = env[:ssh_run_exit_status] || 0
+          return status
+        end
+      end
+
+      private
+
+      def parse_args
+        opts = OptionParser.new do |o|
+          o.banner = 'Usage: vagrant run-recipe <recipe-name>'
+          o.separator ''
+
+          o.on('-h', '--help', 'Print this help') do
+            safe_puts(opts.help)
+          end
+        end
+
+        argv = split_main_and_subcommand(@argv.dup)
+        exec_args, cmd, cmd_args = argv[0], argv[1], argv[2]
+
+        # show help
+        if !cmd || exec_args.any? { |a| a == '-h' || a == '--help' }
+          safe_puts(opts.help)
+          return nil
+        end
+
+        return cmd, cmd_args
+      end
+
+      def add_env(env)
+        ''.tap do |command|
+          if env.any?
+            env.each do |key, value|
+              command << "export #{key}=#{value} && "
+            end
+          end
+        end
+      end
+
+      def add_bundler(bundler, plain_command)
+        ''.tap do |command|
+          if bundler && plain_command !~ /^bundle /
+            command << 'bundle exec '
+          end
+        end
+      end
+
+    end # Command
+  end # Recipe
+end # VagrantPlugins

data/lib/vagrant-recipe/config.rb

@@ -0,0 +1,33 @@
+module VagrantPlugins
+  module Recipe
+    class Config < Vagrant.plugin(2, :config)
+
+      attr_reader :env
+      attr_accessor :bundler
+      attr_accessor :chef
+      attr_accessor :json
+
+      def initialize
+        @env     = {}
+        @bundler = UNSET_VALUE
+        @chef  = UNSET_VALUE
+        @json = UNSET_VALUE
+      end
+
+      def validate(_)
+        return { 'exec' => ['bundler should be boolean'] } unless [true, false].include?(@bundler)
+        return { 'exec' => ['chef should be a string'] } unless @chef.is_a?(String)
+        return { 'exec' => ['json should be a string'] } unless @json.is_a?(String)
+
+        {}
+      end
+
+      def finalize!
+        @chef  = '/tmp/vagrant-chef-1/solo.rb' if @chef  == UNSET_VALUE
+        @json  = '/tmp/vagrant-chef-1/dna.json' if @json  == UNSET_VALUE
+        @bundler = false      if @bundler == UNSET_VALUE
+      end
+
+    end # Config
+  end # Recipe
+end # VagrantPlugins

data/lib/vagrant-recipe/plugin.rb

@@ -0,0 +1,20 @@
+module VagrantPlugins
+  module Recipe
+    class Plugin < Vagrant.plugin(2)
+
+      name 'Vagrant Recipe'
+      description 'Plugin allows to execute a chef recipe.'
+
+      config :run-recipe do
+        require_relative 'config'
+        Config
+      end
+
+      command :run-recipe do
+        require_relative 'command'
+        Command
+      end
+
+    end # Plugin
+  end # Recipe
+end # VagrantPlugins

data/lib/vagrant-recipe/version.rb

@@ -0,0 +1,7 @@
+module VagrantPlugins
+  module Recipe
+
+    VERSION = '0.1.0'
+
+  end # Recipe
+end # VagrantPlugins

data/lib/vagrant-recipe.rb

@@ -0,0 +1,4 @@
+require 'vagrant'
+
+require 'vagrant-recipe/plugin'
+require 'vagrant-recipe/version'

data/vagrant-recipe.gemspec

@@ -0,0 +1,21 @@
+$:.push File.expand_path("../lib", __FILE__)
+require 'vagrant-recipe/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'vagrant-recipe'
+  s.version     = VagrantPlugins::Recipe::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.author      = 'Raul Simiciuc'
+  s.email       = 'byraul@gmail.com'
+  s.homepage    = 'http://github.com/rsimiciuc/vagrant-recipe'
+  s.summary     = 'Execute chef recipes'
+  s.description = 'Vagrant plugin to execute chef recipes'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = %w(lib)
+
+  s.add_development_dependency 'aruba'
+  s.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-recipe
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Raul Simiciuc
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aruba
+  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: 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'
+description: Vagrant plugin to execute chef recipes
+email: byraul@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- features/step_definitions/steps.rb
+- features/support/env.rb
+- features/vagrant-recipe.feature
+- lib/vagrant-recipe.rb
+- lib/vagrant-recipe/command.rb
+- lib/vagrant-recipe/config.rb
+- lib/vagrant-recipe/plugin.rb
+- lib/vagrant-recipe/version.rb
+- vagrant-recipe.gemspec
+homepage: http://github.com/rsimiciuc/vagrant-recipe
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Execute chef recipes
+test_files: []