vagrant-exec 0.1.0 → 0.2.0

data/README.md

@@ -1,10 +1,8 @@
-vagrant-exec
+vagrant-exec [![Gem Version](https://badge.fury.io/rb/vagrant-exec.png)](http://badge.fury.io/rb/vagrant-exec)
 ===============
 
 Vagrant plugin to execute commands within the context of VM synced directory.
 
-[![Gem Version](https://badge.fury.io/rb/vagrant-exec.png)](http://badge.fury.io/rb/vagrant-exec)
-
 Description
 -----------
 
@@ -37,6 +35,12 @@ Vagrant.configure('2') do |config|
 end
 ```
 
+```shell
+➜ vagrant exec pwd
+# is the same as
+➜ vagrant ssh -c "cd /custom && bundle exec pwd'
+```
+
 You can also enable bundler to prepend each command with `bundle exec` (note, that it won't be done for commands like `bundle install`).
 
 ```ruby
@@ -46,6 +50,32 @@ Vagrant.configure('2') do |config|
 end
 ```
 
+```shell
+➜ vagrant exec pwd
+# is the same as
+➜ vagrant ssh -c "cd /vagrant && bundle exec pwd'
+
+➜ vagrant exec bundle install
+# is the same as
+➜ vagrant ssh -c "cd /vagrant && bundle install'
+```
+
+You can also add environment variables to be exported before.
+
+```ruby
+Vagrant.configure('2') do |config|
+  config.vm.box = 'precise32'
+  config.exec.env['RAILS_ENV'] = 'test'
+  config.exec.env['RAILS_ROOT'] = '/vagrant'
+end
+```
+
+```shell
+➜ vagrant exec pwd
+# is the same as
+➜ vagrant ssh -c "cd /vagrant && export RAILS_ENV=test && export RAILS_ROOT=/vagrant && pwd'
+```
+
 Acceptance tests
 ----------------
 
@@ -56,6 +86,12 @@ Before running features, you'll need to bootstrap box.
 ➜ bundle exec rake features:run
 ```
 
+After you're done, remove Vagrant box.
+
+```shell
+➜ bundle exec rake features:cleanup
+```
+
 Note on Patches/Pull Requests
 -----------------------------
 

data/Rakefile

@@ -3,12 +3,18 @@ require 'cucumber/rake/task'
 Bundler::GemHelper.install_tasks
 
 namespace :features do
+  desc 'Downloads and adds vagrant box for testing.'
   task(:bootstrap) do
-    # download and add box for acceptance tests
-    system("bundle exec vagrant box add precise32 http://files.vagrantup.com/precise32.box")
+    system('bundle exec vagrant box add vagrant_exec http://files.vagrantup.com/precise32.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_exec virtualbox')
+  end
 end

data/features/step_definitions/steps.rb

@@ -3,12 +3,13 @@ Given(/^I have default Vagrantfile$/) do
 Vagrant.require_plugin 'vagrant-exec'
 
 Vagrant.configure('2') do |config|
-  config.vm.box = 'precise32'
+  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
 
@@ -19,6 +20,7 @@ end
   step 'I append to "Vagrantfile" with:', config
 end
 
+
 Given(/^I set vagrant-exec bundler to (.+)$/) do |bundler|
   config = <<-RUBY
 
@@ -28,3 +30,20 @@ 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

@@ -1,4 +1,5 @@
 require 'aruba/cucumber'
+ENV['VAGRANT_LOG'] = 'info'
 
 Before do
   # VM start takes a long time

data/features/vagrant-exec.feature

@@ -6,7 +6,8 @@ Feature: vagrant-exec
   I want to use "vagrant exec" command
   And be able to customize folder
   And prepend commands with "bundle exec"
-  Using Vagrantfile configuraiotn
+  And set exported environmental variables
+  Using Vagrantfile configuration
 
   Background:
     Given I have default Vagrantfile
@@ -15,14 +16,14 @@ Feature: vagrant-exec
     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 "/vagrant"
+    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 "/tmp"
+    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
@@ -41,13 +42,13 @@ Feature: vagrant-exec
     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 "bundle: command not found"
+    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 not contain "bundle 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"
@@ -55,7 +56,36 @@ Feature: vagrant-exec
     Then the exit status should not be 0
     And the output should contain "bundler should be boolean"
 
-  Scenario: can use custom VM
+  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 --machine vm pwd`
-    And the output should contain "machine with the name 'vm' was not found"
+    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-exec/command.rb

@@ -3,32 +3,45 @@ module VagrantPlugins
     class Command < Vagrant.plugin(2, :command)
 
       def execute
-        options = {}
-
-        opts = OptionParser.new do | o |
+        opts = OptionParser.new do |o|
           o.banner = 'Usage: vagrant exec [options] <command>'
           o.separator ''
 
-          o.on('-m', '--machine VM', 'VM name to use.') do | vm |
-            options[:machine] = vm
+          o.on('-h', '--help', 'Print this help') do
+            safe_puts(opts.help)
           end
         end
 
-        # Parse the options
-        argv = parse_options(opts)
-        return unless argv
+        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
 
         # Execute the actual SSH
-        with_target_vms(options[:machine], single_target: true) do | vm |
+        with_target_vms(nil, single_target: true) do |vm|
           vm.config.exec.finalize! # TODO: do we have to call it explicitly?
 
-          plain = argv.join(' ')
-          command =  "cd #{vm.config.exec.folder}; "
+          plain   = "#{cmd} " << cmd_args.join(' ')
+          command = "cd #{vm.config.exec.folder} && "
+
+          env = vm.config.exec.env
+          if env.any?
+            env.each do |key, value|
+              command << "export #{key}=#{value} && "
+            end
+          end
+
           if vm.config.exec.bundler && !(plain =~ /^bundle /)
             command << 'bundle exec '
           end
+
           command << plain
-          @logger.debug("Executing single command on remote machine: #{command}")
+
+          @logger.info("Executing single command on remote machine: #{command}")
           env = vm.action(:ssh_run, ssh_run_command: command)
 
           status = env[:ssh_run_exit_status] || 0

data/lib/vagrant-exec/config.rb

@@ -2,17 +2,19 @@ module VagrantPlugins
   module Exec
     class Config < Vagrant.plugin(2, :config)
 
-      attr_accessor :folder
+      attr_reader :env
       attr_accessor :bundler
+      attr_accessor :folder
 
       def initialize
-        @folder  = UNSET_VALUE
+        @env     = {}
         @bundler = UNSET_VALUE
+        @folder  = UNSET_VALUE
       end
 
       def validate(_)
-        return { 'exec' => ['folder should be a string'] } unless @folder.is_a?(String)
         return { 'exec' => ['bundler should be boolean'] } unless [true, false].include?(@bundler)
+        return { 'exec' => ['folder should be a string'] } unless @folder.is_a?(String)
 
         {}
       end

data/lib/vagrant-exec/version.rb

@@ -1,7 +1,7 @@
 module VagrantPlugins
   module Exec
 
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
 
   end # Exec
 end # VagrantPlugins

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-exec
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-29 00:00:00.000000000 Z
+date: 2013-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aruba
@@ -76,7 +76,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 612892604228850569
+      hash: 1395843341620425617
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -85,7 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 612892604228850569
+      hash: 1395843341620425617
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23