vagrant-shell-commander 0.1.4 → 0.2.0

data/.gitignore

@@ -17,4 +17,5 @@ tmp
 .ruby-*
 *~
 .vagrant
-*gem
+*gem
+debug*

data/Gemfile.lock

@@ -1,8 +1,8 @@
 GIT
   remote: git://github.com/mitchellh/vagrant.git
-  revision: e1e57024dc78565b99b8f2ccdd9c388270bf2de0
+  revision: 4638a7a0dff2a242ae583e045c56f6ce49191a4e
   specs:
-    vagrant (1.2.3.dev)
+    vagrant (1.3.2.dev)
       childprocess (~> 0.3.7)
       erubis (~> 2.7.0)
       i18n (~> 0.6.0)
@@ -13,7 +13,7 @@ GIT
 PATH
   remote: .
   specs:
-    vagrant-shell-commander (0.1.4)
+    vagrant-shell-commander (0.2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -25,26 +25,26 @@ GEM
     diff-lcs (1.2.4)
     erubis (2.7.0)
     ffi (1.9.0)
-    i18n (0.6.4)
+    i18n (0.6.5)
     log4r (1.1.10)
     multi_json (1.7.7)
-    net-scp (1.1.1)
+    net-scp (1.1.2)
       net-ssh (>= 2.6.5)
-    net-ssh (2.6.7)
+    net-ssh (2.6.8)
     parallel (0.7.1)
     rake (10.1.0)
     reek (1.3.1)
       ruby2ruby (~> 2.0.2)
       ruby_parser (~> 3.1.1)
       sexp_processor
-    rspec (2.13.0)
-      rspec-core (~> 2.13.0)
-      rspec-expectations (~> 2.13.0)
-      rspec-mocks (~> 2.13.0)
-    rspec-core (2.13.1)
-    rspec-expectations (2.13.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.2)
       diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.13.1)
+    rspec-mocks (2.14.3)
     ruby2ruby (2.0.6)
       ruby_parser (~> 3.1)
       sexp_processor (~> 4.0)

data/README.md

@@ -3,13 +3,26 @@
 
 # Vagrant::Shell::Commander
 
-Vagrant plugin for executing arbitrary shell commands on guest. Executes the given command on all the machines on multinode environments. It also gives the option to specify a working directory.
+Vagrant plugin for running arbitrary shell commands on guest(s). Executes the given command on all the machines of multinode environments, or just in one of them. It also gives the option to specify a working directory and a user by command line.
+
+It allows you to hook into the boot process, specifying a command to be run once the machine has finished the complete boot process. This can be handy for running init scripts which depends on files located in shared folders, for example.
+
 
 ## Installation
 
-As usual with vagrant plugins:
+Given you have Vagrant 1.1+ installed, as usual with vagrant plugins:
 
     $ vagrant plugin install vagrant-shell-commander
+    
+or with the great Bindler, after adding a plugins.json with, at least:
+
+    {
+      "vagrant-shell-commander"
+    }
+
+execute:
+
+    $ vagrant plugin bundle
 
 ## Usage
 
@@ -25,6 +38,17 @@ Specify the working directory (remember to quote multiword commands):
 
     $ vagrant sh -c 'ls -al' -d /srv/www
 
+To execute a command once the machine(s) has booted, add this configuration option to the Vagrantfile:
+
+```ruby
+Vagrant.configure("2") do |config|
+  # other...
+
+  config.sh.after_share_folders = "sudo /etc/init.d/myapp start"
+
+end
+```
+
 Get help:
 
     $ vagrant sh -h

data/Vagrantfile

@@ -1,6 +1,11 @@
 Vagrant.require_plugin "vagrant-shell-commander"
 
-Vagrant::Config.run do |config|
+Vagrant.configure("2") do |config|
   config.vm.box = "canonical-ubuntu-12.04"
   config.vm.box_url = "http://cloud-images.ubuntu.com/vagrant/precise/current/precise-server-cloudimg-amd64-vagrant-disk1.box"
+
+  config.vm.define "node1"
+  config.vm.define "node2"
+
+  config.sh.after_share_folders = "free"
 end

data/lib/vagrant-shell-commander.rb

@@ -1,15 +1,7 @@
 require "vagrant-shell-commander/version"
 require "vagrant-shell-commander/option_manager"
+require "vagrant-shell-commander/plugin"
+require 'vagrant-shell-commander/command'
+require 'vagrant-shell-commander/config'
+require 'vagrant-shell-commander/action'
 
-module VagrantShellCommander
-  # Plugin definition
-  #
-  class Plugin < Vagrant.plugin("2")
-    name 'vagrant shell commander'
-
-    command 'sh' do
-      require_relative 'vagrant-shell-commander/command'
-      Command
-    end
-  end
-end

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

@@ -0,0 +1,26 @@
+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
+
+    # 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)
+    end
+  end
+end

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

@@ -23,8 +23,6 @@ module VagrantShellCommander
 
     private
 
-    
-
     # Executes actions for a given machine
     #
     # @param [Vagrant::Machine] subject vm 
@@ -37,23 +35,24 @@ module VagrantShellCommander
         return
       end
       
-      machine.communicate.
-        execute(add_cwd_to_command(cli_options[:values][:cmd], 
-                                   cli_options[:values][:dir])) do |type, data|
-        env.ui.success("#{machine.name}::")
-        env.ui.info(data)
-      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 change to a working directory to the given command
+    # Adds the options to the given command
     #
     # @param cmd [String] Shell command
     # @param cwd [String] Optional working directory
-    # @return [String] Command with directory change if cwd is present
+    # @param user [String] Optional executing user
+    # @return [String] Command with directory change if cwd is present and optional executing user
     #
-    def add_cwd_to_command(cmd, cwd=nil)
-      return cmd unless cwd
-      "cd #{cwd} && #{cmd}"
+    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

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

@@ -0,0 +1,19 @@
+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
+    end
+  end
+end

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

@@ -18,6 +18,11 @@ module VagrantShellCommander
           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

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

@@ -0,0 +1,21 @@
+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)
+      end
+    end
+  end
+end

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

@@ -1,3 +1,3 @@
 module VagrantShellCommander
-  VERSION = "0.1.4"
+  VERSION = "0.2.0"
 end

data/spec/action_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe VagrantShellCommander::Action do
+  let(:app) {double(call: true)}
+  let(:machine) {double(action: true)}
+  let(:env) {double(:[] => machine)}
+  let(:cmd) {'cmd'}
+  let(:sh) {double(after_share_folders: cmd)}
+  let(:global_config) {double(sh: sh)}
+  let(:action_env) {{global_config: global_config}}
+  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)
+    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)
+      
+      expect(machine).to receive(:action).with(:ssh_run, ssh_run_command: cmd)
+    end
+  end
+end

data/spec/command_spec.rb

@@ -57,17 +57,18 @@ describe VagrantShellCommander::Command do
         end
 
         it 'reports information about state' do
-          ui.should_receive(:warn).with("Machine #{machine_name} is not running.")
+          expect(ui).to receive(:warn).with("Machine #{machine_name} is not running.")
         end
 
         it 'dows not try to execute the command' do
-          machine.should_not_receive(:communicate)
+          expect(machine).not_to receive(:communicate)
         end
       end
 
       context 'running machine' do
         let(:cmd) {'command'}
         let(:dir) {'dir'}
+        let(:user) {'user'}
         let(:communicate) {double(execute: true)}
         
         before(:each) do
@@ -75,35 +76,48 @@ describe VagrantShellCommander::Command do
             and_return(parser: 'parser', values: {cmd: cmd})
 
           machine.stub_chain(:state, :id).and_return(:running)
-          machine.stub(:communicate).and_return(communicate)
+          allow(ui).to receive(:success)
+          allow(machine).to receive(:action)
         end
 
         it 'executes the given command' do
-          communicate.should_receive(:execute).with(cmd)
+          expect(machine).to receive(:action).with(:ssh_run, ssh_run_command: cmd)
         end
 
-        it 'shows the command output along with the machine name' do
-          data = 'data'
-
-          communicate.stub(:execute).and_yield('type', data)
-
-          ui.should_receive(:success).with("#{machine_name}::")
-          ui.should_receive(:info).with(data)
+        it 'shows the machine name' do
+          expect(ui).to receive(:success).with("#{machine_name}::")
         end
 
         it 'executes the command in the given dir' do
           VagrantShellCommander::OptionManager.stub_chain(:new, :execute).
             and_return(parser: 'parser', values: {cmd: cmd, dir: dir})
           
-          communicate.should_receive(:execute).with("cd #{dir} && #{cmd}")
+          expect(machine).to receive(:action).with(:ssh_run, 
+                                                   ssh_run_command: "cd #{dir} && #{cmd}")
+        end
+
+        it 'executes the command for the given user' do
+          VagrantShellCommander::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}\"")
+        end
+
+        it 'executes the command for the given user and the given dir' do
+          VagrantShellCommander::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}\"")
         end
 
         describe 'shows help' do
           let(:parser) {'parser'}
 
           after(:each) do
-            subject.should_not_receive(:with_target_vms)
-            ui.should_receive(:info).with(parser)
+            expect(subject).not_to receive(:with_target_vms)
+            expect(ui).to receive(:info).with(parser)
           end
 
           it 'an empty command' do
@@ -113,7 +127,7 @@ describe VagrantShellCommander::Command do
 
           it 'non present command' do
             VagrantShellCommander::OptionManager.stub_chain(:new, :execute).
-              and_return(parser: parser, values: {dir: dir})
+              and_return(parser: parser, values: {user: user})
           end
         end
       end

data/spec/config_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe VagrantShellCommander::Config do
+
+  let(:subject) {described_class.new}
+
+  describe 'config properies' do
+    it 'should have a after_share_folders attr_accessor' do
+      expect(subject).to respond_to(:after_share_folders)
+      expect(subject).to respond_to(:after_share_folders=)
+    end
+  end
+
+  describe "#initialize" do
+    it 'should initialize after_share_folders' do
+      expect(subject.after_share_folders).to be_equal(Vagrant::Plugin::V2::Config::UNSET_VALUE)
+    end
+  end
+
+  describe "#finalize!" do
+    it 'should deinitialize after_share_folders if it has been set' do
+      config = described_class.new
+      config.finalize!
+      expect(config.after_share_folders).to be_nil
+    end
+
+    it 'should not deinitialize after_share_folders if it has not been set' do
+      config = described_class.new
+      config.after_share_folders = 'value'
+      config.finalize!
+      expect(config.after_share_folders).to eq('value')
+    end
+
+  end
+end

data/spec/option_manager_spec.rb

@@ -51,5 +51,19 @@ describe VagrantShellCommander::OptionManager do
 
       expect(result[:values][:cmd]).to eql(cmd_value)
     end
+
+    it 'has a user option' do
+      user_value = 'user'
+      
+      option_parser.stub(:on).with('-u [USER]', 
+                                   anything, 
+                                   anything).
+        and_yield(user_value)
+
+      result = subject.execute
+
+      expect(result[:values][:user]).to eql(user_value)
+    end
+
   end
 end

data/spec/plugin_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe VagrantShellCommander::Plugin do
+  it 'should have a name' do
+    expect(described_class.name).not_to be_nil
+  end
+
+  it "should define a command of type Command" do
+    default_command = described_class.command.
+      to_hash[:"sh"]
+    expect(default_command).to be(VagrantShellCommander::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)
+  end
+
+  context 'action hooks' do
+    let(:hook) {double(append: true, prepend: true)}
+
+    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)
+      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)
+      hook_proc.call(hook)
+    end
+
+  end
+
+end

data/vagrant-shell-commander.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = VagrantShellCommander::VERSION
   spec.authors       = ["Federico Gimenez Nieto"]
   spec.email         = ["federico.gimenez@gmail.com"]
-  spec.description   = %q{This Vagrant plugin allows you to execute a given shell command on all the machines of your multinode environment. You can also specify the working directory to execute the command}
-  spec.summary       = %q{Vagrant plugin for executing arbitrary shell commands on guest(s)}
+  spec.description   = %q{Vagrant plugin for executing shell commands on guests machines and hooking them in the boot process}
+  spec.summary       = %q{Some variations to shell command execution on guest(s)}
   spec.homepage      = "https://github.com/fgimenez/vagrant-shell-commander"
   spec.license       = "MIT"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-shell-commander
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-27 00:00:00.000000000 Z
+date: 2013-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -123,9 +123,8 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: This Vagrant plugin allows you to execute a given shell command on all
-  the machines of your multinode environment. You can also specify the working directory
-  to execute the command
+description: Vagrant plugin for executing shell commands on guests machines and hooking
+  them in the boot process
 email:
 - federico.gimenez@gmail.com
 executables: []
@@ -145,13 +144,18 @@ files:
 - lib/tasks/reek.rake
 - lib/tasks/rspec.rake
 - lib/vagrant-shell-commander.rb
+- lib/vagrant-shell-commander/action.rb
 - lib/vagrant-shell-commander/command.rb
+- lib/vagrant-shell-commander/config.rb
 - lib/vagrant-shell-commander/option_manager.rb
+- lib/vagrant-shell-commander/plugin.rb
 - lib/vagrant-shell-commander/version.rb
+- spec/action_spec.rb
 - spec/command_spec.rb
+- spec/config_spec.rb
 - spec/option_manager_spec.rb
+- spec/plugin_spec.rb
 - spec/spec_helper.rb
-- spec/vagrant_shell_commander_spec.rb
 - vagrant-shell-commander.gemspec
 homepage: https://github.com/fgimenez/vagrant-shell-commander
 licenses:
@@ -177,10 +181,12 @@ rubyforge_project:
 rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
-summary: Vagrant plugin for executing arbitrary shell commands on guest(s)
+summary: Some variations to shell command execution on guest(s)
 test_files:
+- spec/action_spec.rb
 - spec/command_spec.rb
+- spec/config_spec.rb
 - spec/option_manager_spec.rb
+- spec/plugin_spec.rb
 - spec/spec_helper.rb
-- spec/vagrant_shell_commander_spec.rb
 has_rdoc: 

data/spec/vagrant_shell_commander_spec.rb

@@ -1,13 +0,0 @@
-require 'spec_helper'
-
-describe VagrantShellCommander::Plugin do
-  it 'should have a name' do
-    expect(described_class.name).not_to be_nil
-  end
-
-  it "should define a command of type Command" do
-    default_command = described_class.command.
-      to_hash[:"sh"]
-    expect(default_command).to be(VagrantShellCommander::Command)
-  end
-end