vagrant-exec 0.2.1 → 0.3.0

data/README.md

@@ -11,7 +11,7 @@ You will probably use the plugin if you don't want to SSH into the box to execut
 Example
 -------
 
-```shell
+```bash
 ➜ vagrant exec pwd
 /vagrant
 ```
@@ -19,49 +19,67 @@ Example
 Installation
 ------------
 
-```shell
+```bash
 ➜ vagrant plugin install vagrant-exec
 ```
 
 Configuration
 -------------
 
-### Custom folder
+### Custom root
 
 The root directory can be configured using Vagrantfile.
 
 ```ruby
 Vagrant.configure('2') do |config|
   config.vm.box = 'precise32'
-  config.exec.folder = '/custom'
+  config.exec.root = '/custom'
 end
 ```
 
-```shell
+```bash
 ➜ vagrant exec pwd
 # is the same as
 ➜ vagrant ssh -c "cd /custom && bundle exec pwd"
 ```
 
-### Bundler
+### Prepend with
 
-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`).
+You can tell `vagrant-exec` to prepend all the commands with custom string.
 
 ```ruby
 Vagrant.configure('2') do |config|
   config.vm.box = 'precise32'
-  config.exec.bundler = true
+  config.exec.prepend_with 'bundle exec'
 end
 ```
 
-```shell
+```bash
 ➜ vagrant exec pwd
 # is the same as
 ➜ vagrant ssh -c "cd /vagrant && bundle exec pwd"
+```
+
+You can also limit prepend to specific commands and combine them.
+
+```ruby
+Vagrant.configure('2') do |config|
+  config.vm.box = 'precise32'
+  config.exec.prepend_with 'bundle exec', :only => %w(rails rspec cucumber)
+  config.exec.prepend_with 'rvmsudo', :only => %w(gem)
+end
+```
+
+```bash
+➜ vagrant exec rails c
+# is the same as
+➜ vagrant ssh -c "cd /vagrant && bundle exec rails c"
+```
 
-➜ vagrant exec bundle install
+```bash
+➜ vagrant exec gem install bundler
 # is the same as
-➜ vagrant ssh -c "cd /vagrant && bundle install"
+➜ vagrant ssh -c "cd /vagrant && rvmsudo gem install bundler"
 ```
 
 ### Environment variables
@@ -76,7 +94,7 @@ Vagrant.configure('2') do |config|
 end
 ```
 
-```shell
+```bash
 ➜ vagrant exec pwd
 # is the same as
 ➜ vagrant ssh -c "cd /vagrant && export RAILS_ENV=test && export RAILS_ROOT=/vagrant && pwd"
@@ -87,22 +105,27 @@ Acceptance tests
 
 Before running features, you'll need to bootstrap box.
 
-```shell
+```bash
 ➜ bundle exec rake features:bootstrap
 ```
 
 To run features, execute the following rake task.
 
-```shell
+```bash
 ➜ bundle exec rake features:run
 ```
 
 After you're done, remove Vagrant box.
 
-```shell
+```bash
 ➜ bundle exec rake features:cleanup
 ```
 
+Known issues
+-----------------------------
+
+`vagrant-exec` cannot properly handle `-v` in command args (it's caught somewhere before plugin), so executing `vagrant exec ruby -v` will return Vagrant version rather than Ruby. As a workaround, wrap it in quotes: `vagrant exec "ruby -v"`.
+
 Note on Patches/Pull Requests
 -----------------------------
 

data/features/step_definitions/steps.rb

@@ -1,49 +1,8 @@
-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
+Then(/^SHH subprocess should execute command "(.+)"$/) do |command|
+  ssh  = %w(vagrant@127.0.0.1 -p 2200 -o Compression=yes)
+  ssh += %w(-o DSAAuthentication=yes -o LogLevel=FATAL)
+  ssh += %w(-o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null)
+  ssh += %W(-o IdentitiesOnly=yes -i #{Dir.home}/.vagrant.d/insecure_private_key)
+  ssh += ['-q', '-t', "bash -l -c '#{command.delete('"')} --'"]
+  assert_partial_output("Executing SSH in subprocess: #{ssh}", all_output)
 end

data/features/support/env.rb

@@ -8,5 +8,5 @@ end
 
 After do
   # halt VM
-  system "cd tmp/aruba; bundle exec vagrant halt &> /dev/null"
+  system 'cd tmp/aruba; bundle exec vagrant halt &> /dev/null'
 end

data/features/vagrant-exec.feature

@@ -10,82 +10,165 @@ Feature: vagrant-exec
   Using Vagrantfile configuration
 
   Background:
-    Given I have default Vagrantfile
+    Given I write to "Vagrantfile" with:
+      """
+      Vagrant.require_plugin 'vagrant-exec'
 
-  Scenario: uses /vagrant as default folder
+      Vagrant.configure('2') do |config|
+        config.vm.box = 'vagrant_exec'
+      end
+      """
+
+  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 SHH subprocess should execute command "cd /vagrant && <cmd>"
+    Examples:
+      | cmd                   |
+      | cwd .                 |
+      | cwd ~                 |
+      | cwd -h                |
+      | cwd --blah            |
+      | "cwd -h blah -v blah" |
+
+  Scenario: uses /vagrant as default root
     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: source ~/.profile && cd /vagrant && pwd"
+    And SHH subprocess should execute command "cd /vagrant && pwd"
+
+  Scenario: can use custom root
+    Given I overwrite "Vagrantfile" with:
+      """
+      Vagrant.require_plugin 'vagrant-exec'
 
-  Scenario: can use custom folder
-    Given I set vagrant-exec folder to "/tmp"
+      Vagrant.configure('2') do |config|
+        config.vm.box = 'vagrant_exec'
+        config.exec.root = '/tmp'
+      end
+      """
     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: source ~/.profile && cd /tmp && pwd"
+    And SHH subprocess should execute command "cd /tmp && pwd"
+
+  Scenario: raises error if root is improperly set
+    Given I overwrite "Vagrantfile" with:
+      """
+      Vagrant.require_plugin 'vagrant-exec'
 
-  Scenario: raises error if folder is improperly set
-    Given I set vagrant-exec folder to true
+      Vagrant.configure('2') do |config|
+        config.vm.box = 'vagrant_exec'
+        config.exec.root = true
+      end
+      """
     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"
+    And the output should contain "root should be a string"
 
-  Scenario: does not use bundler by default
-    Given I run `bundle exec vagrant up`
+  Scenario: can prepend all commands
+    Given I overwrite "Vagrantfile" with:
+      """
+      Vagrant.require_plugin 'vagrant-exec'
+
+      Vagrant.configure('2') do |config|
+        config.vm.box = 'vagrant_exec'
+        config.exec.prepend_with 'echo vagrant-exec &&'
+      end
+      """
+    And I run `bundle exec vagrant up`
     When I run `bundle exec vagrant exec pwd`
-    Then the output should not contain "bundle exec"
+    Then the exit status should be 0
+    And SHH subprocess should execute command "cd /vagrant && echo vagrant-exec && pwd"
+
+  Scenario: can prepend only specific commands
+    Given I overwrite "Vagrantfile" with:
+      """
+      Vagrant.require_plugin 'vagrant-exec'
 
-  # we don't have bundler in box
-  Scenario: can use bundler
-    Given I set vagrant-exec bundler to true
+      Vagrant.configure('2') do |config|
+        config.vm.box = 'vagrant_exec'
+        config.exec.prepend_with 'echo vagrant-exec &&', :only => %w(pwd echo)
+      end
+      """
     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: source ~/.profile && cd /vagrant && bundle exec pwd"
+    Then SHH subprocess should execute command "cd /vagrant && echo vagrant-exec && pwd"
+    When I run `bundle exec vagrant exec echo 1`
+    Then SHH subprocess should execute command "cd /vagrant && echo vagrant-exec && echo 1"
+    When I run `bundle exec vagrant exec env`
+    Then SHH subprocess should execute command "cd /vagrant && env"
 
-  Scenario: does not use bundler for bundle commands
-    Given I set vagrant-exec bundler to true
+  Scenario: can use prepend multiple times
+    Given I overwrite "Vagrantfile" with:
+      """
+      Vagrant.require_plugin 'vagrant-exec'
+
+      Vagrant.configure('2') do |config|
+        config.vm.box = 'vagrant_exec'
+        config.exec.prepend_with 'echo vagrant-exec1 &&', :only => %w(pwd)
+        config.exec.prepend_with 'echo vagrant-exec2 &&', :only => %w(echo)
+      end
+      """
     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: source ~/.profile && cd /vagrant && bundle install"
+    When I run `bundle exec vagrant exec pwd`
+    Then SHH subprocess should execute command "cd /vagrant && echo vagrant-exec1 && pwd"
+    When I run `bundle exec vagrant exec echo 1`
+    Then SHH subprocess should execute command "cd /vagrant && echo vagrant-exec2 && echo 1"
 
-  Scenario: raises error if bundler is improperly set
-    Given I set vagrant-exec bundler to "true"
-    When I run `bundle exec vagrant up`
+  Scenario: raises error if prepend command is improperly set
+    Given I overwrite "Vagrantfile" with:
+      """
+      Vagrant.require_plugin 'vagrant-exec'
+
+      Vagrant.configure('2') do |config|
+        config.vm.box = 'vagrant_exec'
+        config.exec.prepend_with :test
+      end
+      """
+    Given I set vagrant-exec prepend with :test for all commands
+    And I run `bundle exec vagrant up`
     Then the exit status should not be 0
-    And the output should contain "bundler should be boolean"
+    And the output should contain "prepend_with command should be a string"
+
+  Scenario: raises error if prepend only is improperly set
+    Given I overwrite "Vagrantfile" with:
+      """
+      Vagrant.require_plugin 'vagrant-exec'
+
+      Vagrant.configure('2') do |config|
+        config.vm.box = 'vagrant_exec'
+        config.exec.prepend_with 'echo vagrant-exec1 &&', :only => 'test'
+      end
+      """
+    And I run `bundle exec vagrant up`
+    Then the exit status should not be 0
+    And the output should contain "prepend_with :only should be an array"
 
   Scenario: can export environment variables
-    Given I set vagrant-exec env with the following values:
-      | key   | value |
-      | TEST1 | true  |
-      | TEST2 | false |
+    Given I overwrite "Vagrantfile" with:
+      """
+      Vagrant.require_plugin 'vagrant-exec'
+
+      Vagrant.configure('2') do |config|
+        config.vm.box = 'vagrant_exec'
+        config.exec.env['TEST1'] = true
+        config.exec.env['TEST2'] = false
+      end
+      """
     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: source ~/.profile && 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: source ~/.profile && cd /vagrant && <cmd>"
-    Examples:
-      | cmd                 |
-      | cwd .               |
-      | cwd ~               |
-      | cwd -h              |
-      | cwd --blah          |
-      | cwd -h blah -v blah |
+    And SHH subprocess should execute command "cd /vagrant && export TEST1=true && export TEST2=false && pwd"

data/lib/vagrant-exec/command.rb

@@ -2,6 +2,10 @@ module VagrantPlugins
   module Exec
     class Command < Vagrant.plugin(2, :command)
 
+      def self.synopsis
+        'proxies command to VM synced folder root'
+      end
+
       def execute
         cmd, cmd_args = parse_args
         cmd && cmd_args or return nil
@@ -12,14 +16,14 @@ module VagrantPlugins
 
           plain = "#{cmd} " << cmd_args.join(' ')
 
-          command = "source ~/.profile && "
-          command << "cd #{vm.config.exec.folder} && "
+          command  = "cd #{vm.config.exec.root} && "
           command << add_env(vm.config.exec.env)
-          command << add_bundler(vm.config.exec.bundler, plain)
+          command << prepend_command(vm.config.exec.prepends, plain)
           command << plain
 
           @logger.info("Executing single command on remote machine: #{command}")
-          env = vm.action(:ssh_run, ssh_run_command: command)
+          ssh_opts = { extra_args: ['-q'] } # make it quiet
+          env = vm.action(:ssh_run, ssh_run_command: command, ssh_opts: ssh_opts)
 
           status = env[:ssh_run_exit_status] || 0
           return status
@@ -51,20 +55,22 @@ module VagrantPlugins
       end
 
       def add_env(env)
-        ''.tap do |command|
-          if env.any?
-            env.each do |key, value|
-              command << "export #{key}=#{value} && "
-            end
-          end
+        ''.tap do |cmd|
+          env.each do |key, value|
+            cmd << "export #{key}=#{value} && "
+          end if env.any?
         end
       end
 
-      def add_bundler(bundler, plain_command)
-        ''.tap do |command|
-          if bundler && plain_command !~ /^bundle /
-            command << 'bundle exec '
-          end
+      def prepend_command(prepends, command)
+        bin = command.split(' ').first
+        ''.tap do |cmd|
+          prepends.each do |prep|
+            if !prep[:only] || prep[:only].include?(bin)
+              prep = prep[:command].strip # remove trailing space
+              cmd << "#{prep} "
+            end
+          end if prepends.any?
         end
       end
 

data/lib/vagrant-exec/config.rb

@@ -3,25 +3,40 @@ module VagrantPlugins
     class Config < Vagrant.plugin(2, :config)
 
       attr_reader :env
-      attr_accessor :bundler
-      attr_accessor :folder
+      attr_accessor :root
 
       def initialize
-        @env     = {}
-        @bundler = UNSET_VALUE
-        @folder  = UNSET_VALUE
+        @env          = {}
+        @prepend_with = UNSET_VALUE
+        @root         = UNSET_VALUE
+      end
+
+      def prepend_with(command, opts = {})
+        @prepend_with = [] if @prepend_with == UNSET_VALUE
+        @prepend_with << { :command => command }.merge(opts)
+      end
+
+      def prepends
+        @prepend_with
       end
 
       def validate(_)
-        return { 'exec' => ['bundler should be boolean'] } unless [true, false].include?(@bundler)
-        return { 'exec' => ['folder should be a string'] } unless @folder.is_a?(String)
+        return { 'exec' => ['root should be a string'] } unless @root.is_a?(String)
+        if @prepend_with.any?
+          if !@prepend_with.all? { |p| p[:command].is_a?(String) }
+            return { 'exec' => ['prepend_with command should be a string'] }
+          end
+          if !@prepend_with.all? { |p| !p[:only] || p[:only].is_a?(Array) }
+            return { 'exec' => ['prepend_with :only should be an array'] }
+          end
+        end
 
         {}
       end
 
       def finalize!
-        @folder  = '/vagrant' if @folder  == UNSET_VALUE
-        @bundler = false      if @bundler == UNSET_VALUE
+        @root = '/vagrant' if @root == UNSET_VALUE
+        @prepend_with = [] if @prepend_with == UNSET_VALUE
       end
 
     end # Config

data/lib/vagrant-exec/version.rb

@@ -1,7 +1,7 @@
 module VagrantPlugins
   module Exec
 
-    VERSION = '0.2.1'
+    VERSION = '0.3.0'
 
   end # Exec
 end # VagrantPlugins

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-exec
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-10 00:00:00.000000000 Z
+date: 2013-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aruba
@@ -77,7 +77,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 657150828523853671
+      hash: -1851522929754547545
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -86,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 657150828523853671
+      hash: -1851522929754547545
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23