vagrant-shell-commander 0.2.0 → 0.3.0

data/Gemfile.lock

@@ -1,19 +1,19 @@
 GIT
   remote: git://github.com/mitchellh/vagrant.git
-  revision: 4638a7a0dff2a242ae583e045c56f6ce49191a4e
+  revision: 862331fbf02deb7f3c7e00967359e3debd1f9809
   specs:
-    vagrant (1.3.2.dev)
+    vagrant (1.5.0.dev)
       childprocess (~> 0.3.7)
       erubis (~> 2.7.0)
       i18n (~> 0.6.0)
       log4r (~> 1.1.9)
       net-scp (~> 1.1.0)
-      net-ssh (~> 2.6.6)
+      net-ssh (>= 2.6.6, < 2.8.0)
 
 PATH
   remote: .
   specs:
-    vagrant-shell-commander (0.2.0)
+    vagrant-shell-commander (0.3.0)
 
 GEM
   remote: https://rubygems.org/
@@ -24,13 +24,13 @@ GEM
       ffi (~> 1.0, >= 1.0.11)
     diff-lcs (1.2.4)
     erubis (2.7.0)
-    ffi (1.9.0)
-    i18n (0.6.5)
+    ffi (1.9.3)
+    i18n (0.6.9)
     log4r (1.1.10)
     multi_json (1.7.7)
     net-scp (1.1.2)
       net-ssh (>= 2.6.5)
-    net-ssh (2.6.8)
+    net-ssh (2.7.0)
     parallel (0.7.1)
     rake (10.1.0)
     reek (1.3.1)

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Federico Gimenez Nieto
+Copyright (c) 2014 Federico Gimenez Nieto
 
 MIT License
 

data/README.md

@@ -26,7 +26,7 @@ execute:
 
 ## Usage
 
-To execute a command on all the machines:
+The command line utility is very similar to the ```vagrant ssh -c``` builtin command, but with multinode support and additional options. To execute a command on all the machines:
 
     $ vagrant sh -c free
 
@@ -38,6 +38,14 @@ Specify the working directory (remember to quote multiword commands):
 
     $ vagrant sh -c 'ls -al' -d /srv/www
 
+Execute as specific user:
+
+    $ vagrant sh -c 'cap production deploy' -u 'deployer'
+
+Get help:
+
+    $ vagrant sh -h
+
 To execute a command once the machine(s) has booted, add this configuration option to the Vagrantfile:
 
 ```ruby
@@ -49,10 +57,6 @@ Vagrant.configure("2") do |config|
 end
 ```
 
-Get help:
-
-    $ vagrant sh -h
-
 ## Contributing
 
 1. Fork it
@@ -61,3 +65,7 @@ Get help:
 4. Commit your changes (`git commit -am 'Add some feature'`)
 5. Push to the branch (`git push origin my-new-feature`)
 6. Create new Pull Request
+
+
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/fgimenez/vagrant-shell-commander/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
+

data/lib/vagrant-shell-commander/action.rb

@@ -1,26 +1,33 @@
-module VagrantShellCommander
-  # Action for shell command hooking
-  class Action
-    # Constructor
-    #
-    # @param app [Action] Next middleware to call
-    # @param env [Hash] Action environment
-    # @return nil
-    #
-    def initialize(app, env)
-      @app = app
-      @machine = env[:machine]
-    end
+module VagrantPlugins
+  module ShellCommander
+    # Action for shell command hooking
+    class Action
+      include Vagrant::Action::Builtin
 
-    # Call method of this middleware
-    #
-    # @param env [Hash] Action environment
-    # @return nil
-    #
-    def call(env)
-      @app.call(env)
-      @machine.action(:ssh_run, 
-                      ssh_run_command: env[:global_config].sh.after_share_folders)
+      # Constructor
+      #
+      # @param app [Action] Next middleware to call
+      # @param env [Hash] Action environment
+      # @return nil
+      #
+      def initialize(app, env)
+        @app = app
+        @machine = env[:machine]
+      end
+      
+      # Call method of this middleware
+      #
+      # @param env [Hash] Action environment
+      # @return nil
+      #
+      def call(env)
+        @app.call(env)
+        unless env[:global_config].sh.after_share_folders.nil?
+          @machine.action(:ssh_run, 
+                          ssh_run_command: env[:global_config].sh.after_share_folders,
+                          ssh_opts: {extra_args: []})
+        end
+      end
     end
   end
 end

data/lib/vagrant-shell-commander/command.rb

@@ -1,58 +1,61 @@
-module VagrantShellCommander
-  # Main plugin command
-  class Command < Vagrant.plugin("2", "command")
-    attr_accessor :env
-
-    # Main entry point of this command
-    #
-    def execute
-      cli_options = OptionManager.new.execute
-      argv = parse_options(cli_options[:parser])
+module VagrantPlugins
+  module ShellCommander
+    # Main plugin command
+    class Command < Vagrant.plugin("2", "command")
+      attr_accessor :env
       
-      return unless argv
-      
-      if [nil, ''].include? cli_options[:values][:cmd]
+      # Main entry point of this command
+      #
+      def execute
+        cli_options = OptionManager.new.execute
+        argv = parse_options(cli_options[:parser])
+        
+        return unless argv
+        
+        if [nil, ''].include? cli_options[:values][:cmd]
         env.ui.info cli_options[:parser]
-      else
-        with_target_vms(argv) do |machine|
-          manage_machine(machine, cli_options) 
+        else
+          with_target_vms(argv) do |machine|
+            manage_machine(machine, cli_options) 
+          end
         end
+        0
       end
-      0
-    end
-
-    private
-
-    # Executes actions for a given machine
-    #
-    # @param [Vagrant::Machine] subject vm 
-    # @param [Hash] Parser (:parser key) and parsed options (:values key)
-    # @return nil
-    #
-    def manage_machine(machine, cli_options)
-      if machine.state.id != :running
-        env.ui.warn("Machine #{machine.name} is not running.")
-        return
+      
+      private
+      
+      # Executes actions for a given machine
+      #
+      # @param [Vagrant::Machine] subject vm 
+      # @param [Hash] Parser (:parser key) and parsed options (:values key)
+      # @return nil
+      #
+      def manage_machine(machine, cli_options)
+        if machine.state.id != :running
+          env.ui.warn("Machine #{machine.name} is not running.")
+          return
+        end
+        
+        env.ui.success("#{machine.name}::")
+        machine.action(:ssh_run, 
+                       ssh_run_command: add_options_to_command(cli_options[:values][:cmd], 
+                                                               cli_options[:values][:dir],
+                                                               cli_options[:values][:user]),
+                      ssh_opts: {extra_args: []})
       end
       
-      env.ui.success("#{machine.name}::")
-      machine.action(:ssh_run, 
-                     ssh_run_command: add_options_to_command(cli_options[:values][:cmd], 
-                                                             cli_options[:values][:dir],
-                                                             cli_options[:values][:user]))
-    end
-
-    # Adds the options to the given command
-    #
-    # @param cmd [String] Shell command
-    # @param cwd [String] Optional working directory
-    # @param user [String] Optional executing user
-    # @return [String] Command with directory change if cwd is present and optional executing user
-    #
-    def add_options_to_command(cmd, cwd=nil, user=nil)
-      cmd = "cd #{cwd} && #{cmd}" if cwd
-      cmd = "sudo su - #{user} -c \"#{cmd}\"" if user
-      cmd
+      # Adds the options to the given command
+      #
+      # @param cmd [String] Shell command
+      # @param cwd [String] Optional working directory
+      # @param user [String] Optional executing user
+      # @return [String] Command with directory change if cwd is present and optional executing user
+      #
+      def add_options_to_command(cmd, cwd=nil, user=nil)
+        cmd = "cd #{cwd} && #{cmd}" if cwd
+        cmd = "sudo su - #{user} -c \"#{cmd}\"" if user
+        cmd
+      end
     end
   end
 end

data/lib/vagrant-shell-commander/config.rb

@@ -1,19 +1,21 @@
-module VagrantShellCommander
-  # Configuration options
-  class Config < Vagrant.plugin("2", "config")
-    attr_accessor :after_share_folders
-
-    # Initialize override, setting config options default values
-    # for merging
-    def initialize
-      super
-
-      @after_share_folders = UNSET_VALUE
-    end
-
-    # finalize! override, unseting config options
-    def finalize!
-      @after_share_folders = nil if @after_share_folders == UNSET_VALUE
+module VagrantPlugins
+  module ShellCommander
+    # Configuration options
+    class Config < Vagrant.plugin("2", "config")
+      attr_accessor :after_share_folders
+      
+      # Initialize override, setting config options default values
+      # for merging
+      def initialize
+        super
+        
+        @after_share_folders = UNSET_VALUE
+      end
+      
+      # finalize! override, unseting config options
+      def finalize!
+        @after_share_folders = nil if @after_share_folders == UNSET_VALUE
+      end
     end
   end
 end

data/lib/vagrant-shell-commander/option_manager.rb

@@ -1,36 +1,37 @@
-module VagrantShellCommander
-  # Option parser
-  #
-  class OptionManager
-    # Main parsing method
-    # @return [Hash] The keys are :parser for the object returned by
-    #   OptionParser and :values for the actual option values
+module VagrantPlugins
+  module ShellCommander
+    # Option parser
     #
-    def execute
-      options = {}
-      block = lambda do |parser|
-        parser.banner = "Usage: vagrant sh -c 'COMMAND' -d [DIR] [MACHINE]"
-
-        parser.separator ''
-
-        parser.on('-d [DIR]', '--directory [DIR]', 
-                  'Directory to execute the command') do |dir|
-          options[:dir] = dir
-        end
-
-        parser.on('-u [USER]', '--user [USER]', 
-                  'User to execute the command') do |user|
-          options[:user] = user
+    class OptionManager
+      # Main parsing method
+      # @return [Hash] The keys are :parser for the object returned by
+      #   OptionParser and :values for the actual option values
+      #
+      def execute
+        options = {}
+        block = lambda do |parser|
+          parser.banner = "Usage: vagrant sh -c 'COMMAND' -d [DIR] [MACHINE]"
+          
+          parser.separator ''
+          
+          parser.on('-d [DIR]', '--directory [DIR]', 
+                    'Directory to execute the command') do |dir|
+            options[:dir] = dir
+          end
+          
+          parser.on('-u [USER]', '--user [USER]', 
+                    'User to execute the command') do |user|
+            options[:user] = user
+          end
+          
+          parser.on("-c 'COMMAND'", "--command 'COMMAND'", 
+                    'Command to execute, quotes required for multiword') do |cmd|
+            options[:cmd] = cmd
+          end
         end
 
-        parser.on("-c 'COMMAND'", "--command 'COMMAND'", 
-                  'Command to execute, quotes required for multiword') do |cmd|
-          options[:cmd] = cmd
-        end
+        {parser: OptionParser.new(&block), values: options}
       end
-
-      {parser: OptionParser.new(&block), values: options}
     end
   end
 end
-

data/lib/vagrant-shell-commander/plugin.rb

@@ -1,20 +1,22 @@
-module VagrantShellCommander
-  # Plugin definition
-  #
-  class Plugin < Vagrant.plugin("2")
-    name 'vagrant shell commander'
-
-    command 'sh' do
-      Command
-    end
-
-    config 'sh' do
-      Config
-    end
-
-    %w[up reload].each do |event|
-      action_hook("sh_hook_#{event}".to_sym, "machine_action_#{event}".to_sym) do |hook|
-        hook.append(VagrantShellCommander::Action)
+module VagrantPlugins
+  module ShellCommander
+    # Plugin definition
+    #
+    class Plugin < Vagrant.plugin("2")
+      name 'vagrant shell commander'
+      
+      command 'sh' do
+        Command
+      end
+      
+      config 'sh' do
+        Config
+      end
+      
+      %w[up reload].each do |event|
+        action_hook("sh_hook_#{event}".to_sym, "machine_action_#{event}".to_sym) do |hook|
+          hook.append(Action)
+        end
       end
     end
   end

data/lib/vagrant-shell-commander/version.rb

@@ -1,3 +1,5 @@
-module VagrantShellCommander
-  VERSION = "0.2.0"
+module VagrantPlugins
+  module ShellCommander
+    VERSION = "0.3.0"
+  end
 end

data/spec/action_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe VagrantShellCommander::Action do
+describe VagrantPlugins::ShellCommander::Action do
   let(:app) {double(call: true)}
   let(:machine) {double(action: true)}
   let(:env) {double(:[] => machine)}
@@ -11,18 +11,30 @@ describe VagrantShellCommander::Action do
   let(:subject) {described_class.new(app, env)}
 
   describe "#call" do
-    after(:each) do
-      subject.call(action_env)
-    end
-
     it "should call the next middleware" do
       expect(app).to receive(:call).with(action_env)
+
+      subject.call(action_env)
     end
 
-    it "should call SSHRun action of the current machine with the after_boot option as command" do
-      allow(env).to receive(:[]).with(:machine).and_return(machine)
+    describe "SSHRun call" do
+      it "should call SSHRun action of the current machine with the after_boot option as command" do
+        allow(env).to receive(:[]).with(:machine).and_return(machine)
+        
+        expect(machine).to receive(:action).with(:ssh_run, ssh_run_command: cmd, ssh_opts: {:extra_args=>[]})
+
+        subject.call(action_env)
+      end
       
-      expect(machine).to receive(:action).with(:ssh_run, ssh_run_command: cmd)
+      it "should not call SSHRun action if after_boot option is nil" do
+        sh = double(after_share_folders: nil)
+        global_config = double(sh: sh)
+        action_env = {global_config: global_config}
+        
+        expect(machine).not_to receive(:action)
+
+        subject.call(action_env)
+      end
     end
   end
 end

data/spec/command_spec.rb

@@ -1,12 +1,12 @@
 require 'spec_helper'
 
-describe VagrantShellCommander::Command do
+describe VagrantPlugins::ShellCommander::Command do
   let(:subject) {described_class.new('2', 'command')}
   let(:argv) {double}
   let(:opts) {{parser: 'parser', values: {cmd: 'cmd'}}}
 
   before(:each) do
-    VagrantShellCommander::OptionManager.stub_chain(:new, :execute).
+    VagrantPlugins::ShellCommander::OptionManager.stub_chain(:new, :execute).
       and_return(opts)
 
     subject.stub(:with_target_vms)
@@ -72,7 +72,7 @@ describe VagrantShellCommander::Command do
         let(:communicate) {double(execute: true)}
         
         before(:each) do
-          VagrantShellCommander::OptionManager.stub_chain(:new, :execute).
+          VagrantPlugins::ShellCommander::OptionManager.stub_chain(:new, :execute).
             and_return(parser: 'parser', values: {cmd: cmd})
 
           machine.stub_chain(:state, :id).and_return(:running)
@@ -81,7 +81,7 @@ describe VagrantShellCommander::Command do
         end
 
         it 'executes the given command' do
-          expect(machine).to receive(:action).with(:ssh_run, ssh_run_command: cmd)
+          expect(machine).to receive(:action).with(:ssh_run, ssh_run_command: cmd, ssh_opts: {:extra_args=>[]})
         end
 
         it 'shows the machine name' do
@@ -89,27 +89,30 @@ describe VagrantShellCommander::Command do
         end
 
         it 'executes the command in the given dir' do
-          VagrantShellCommander::OptionManager.stub_chain(:new, :execute).
+          VagrantPlugins::ShellCommander::OptionManager.stub_chain(:new, :execute).
             and_return(parser: 'parser', values: {cmd: cmd, dir: dir})
           
           expect(machine).to receive(:action).with(:ssh_run, 
-                                                   ssh_run_command: "cd #{dir} && #{cmd}")
+                                                   ssh_run_command: "cd #{dir} && #{cmd}",
+                                                   ssh_opts: {:extra_args=>[]})
         end
 
         it 'executes the command for the given user' do
-          VagrantShellCommander::OptionManager.stub_chain(:new, :execute).
+          VagrantPlugins::ShellCommander::OptionManager.stub_chain(:new, :execute).
             and_return(parser: 'parser', values: {cmd: cmd, user: user})
           
           expect(machine).to receive(:action).with(:ssh_run,
-                                                   ssh_run_command: "sudo su - #{user} -c \"#{cmd}\"")
+                                                   ssh_run_command: "sudo su - #{user} -c \"#{cmd}\"",
+                                                   ssh_opts: {:extra_args=>[]})
         end
 
         it 'executes the command for the given user and the given dir' do
-          VagrantShellCommander::OptionManager.stub_chain(:new, :execute).
+          VagrantPlugins::ShellCommander::OptionManager.stub_chain(:new, :execute).
             and_return(parser: 'parser', values: {cmd: cmd, user: user, dir: dir})
           
           expect(machine).to receive(:action).with(:ssh_run, 
-                                                   ssh_run_command: "sudo su - #{user} -c \"cd #{dir} && #{cmd}\"")
+                                                   ssh_run_command: "sudo su - #{user} -c \"cd #{dir} && #{cmd}\"",
+                                                   ssh_opts: {:extra_args=>[]})
         end
 
         describe 'shows help' do
@@ -121,12 +124,12 @@ describe VagrantShellCommander::Command do
           end
 
           it 'an empty command' do
-            VagrantShellCommander::OptionManager.stub_chain(:new, :execute).
+            VagrantPlugins::ShellCommander::OptionManager.stub_chain(:new, :execute).
               and_return(parser: parser, values: {cmd: '', dir: dir})
           end
 
           it 'non present command' do
-            VagrantShellCommander::OptionManager.stub_chain(:new, :execute).
+            VagrantPlugins::ShellCommander::OptionManager.stub_chain(:new, :execute).
               and_return(parser: parser, values: {user: user})
           end
         end

data/spec/config_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe VagrantShellCommander::Config do
+describe VagrantPlugins::ShellCommander::Config do
 
   let(:subject) {described_class.new}
 

data/spec/option_manager_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe VagrantShellCommander::OptionManager do
+describe VagrantPlugins::ShellCommander::OptionManager do
   let(:subject) {described_class.new}
   let(:argv) {double()}
 

data/spec/plugin_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe VagrantShellCommander::Plugin do
+describe VagrantPlugins::ShellCommander::Plugin do
   it 'should have a name' do
     expect(described_class.name).not_to be_nil
   end
@@ -8,12 +8,12 @@ describe VagrantShellCommander::Plugin do
   it "should define a command of type Command" do
     default_command = described_class.command.
       to_hash[:"sh"]
-    expect(default_command).to be(VagrantShellCommander::Command)
+    expect(default_command).to be(VagrantPlugins::ShellCommander::Command)
   end
 
   it "should define a config of type Config" do
     default_config = described_class.components.configs[:top].to_hash[:"sh"]
-    expect(default_config).to be(VagrantShellCommander::Config)
+    expect(default_config).to be(VagrantPlugins::ShellCommander::Config)
   end
 
   context 'action hooks' do
@@ -22,14 +22,14 @@ describe VagrantShellCommander::Plugin do
     it "should define an action hook for machine_action_up" do
       hook_proc = described_class.components.action_hooks[:machine_action_up][0]
       hook = double
-      expect(hook).to receive(:append).with(VagrantShellCommander::Action)
+      expect(hook).to receive(:append).with(VagrantPlugins::ShellCommander::Action)
       hook_proc.call(hook)
     end
 
     it "should define an action hook for machine_action_reload" do
       hook_proc = described_class.components.action_hooks[:machine_action_reload][0]
       hook = double
-      expect(hook).to receive(:append).with(VagrantShellCommander::Action)
+      expect(hook).to receive(:append).with(VagrantPlugins::ShellCommander::Action)
       hook_proc.call(hook)
     end
 

data/spec/spec_helper.rb

@@ -3,13 +3,6 @@ SimpleCov.start
 
 require 'vagrant'
 
-# This file was generated by the `rspec --init` command. Conventionally, all
-# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
-# Require this file using `require "spec_helper"` to ensure that it is only
-# loaded once.
-#
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
-
 Dir['lib/**/*.rb'].each {|f| require File.expand_path(f)}
 
 RSpec.configure do |config|

data/vagrant-shell-commander.gemspec

@@ -5,7 +5,7 @@ require 'vagrant-shell-commander/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "vagrant-shell-commander"
-  spec.version       = VagrantShellCommander::VERSION
+  spec.version       = VagrantPlugins::ShellCommander::VERSION
   spec.authors       = ["Federico Gimenez Nieto"]
   spec.email         = ["federico.gimenez@gmail.com"]
   spec.description   = %q{Vagrant plugin for executing shell commands on guests machines and hooking them in the boot process}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-shell-commander
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-16 00:00:00.000000000 Z
+date: 2014-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -170,15 +170,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -2972945200673106497
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -2972945200673106497
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Some variations to shell command execution on guest(s)