vagrant-shell-commander 0.1.0

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.ruby-*
+*~
+.vagrant

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format doc

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3-p286
+install: bundle install
+script: bundle exec rake

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vagrant-shell-commander.gemspec
+gemspec
+
+group :development do
+  gem "vagrant", :git => "git://github.com/mitchellh/vagrant.git"
+end

data/Gemfile.lock

@@ -0,0 +1,72 @@
+GIT
+  remote: git://github.com/mitchellh/vagrant.git
+  revision: e1e57024dc78565b99b8f2ccdd9c388270bf2de0
+  specs:
+    vagrant (1.2.3.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)
+
+PATH
+  remote: .
+  specs:
+    vagrant-shell-commander (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    cane (2.6.0)
+      parallel
+    childprocess (0.3.9)
+      ffi (~> 1.0, >= 1.0.11)
+    diff-lcs (1.2.4)
+    erubis (2.7.0)
+    ffi (1.9.0)
+    i18n (0.6.4)
+    log4r (1.1.10)
+    multi_json (1.7.7)
+    net-scp (1.1.1)
+      net-ssh (>= 2.6.5)
+    net-ssh (2.6.7)
+    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)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    ruby2ruby (2.0.6)
+      ruby_parser (~> 3.1)
+      sexp_processor (~> 4.0)
+    ruby_parser (3.1.3)
+      sexp_processor (~> 4.1)
+    sexp_processor (4.2.1)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    yard (0.8.6.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  cane
+  rake
+  reek
+  rspec
+  simplecov
+  vagrant!
+  vagrant-shell-commander!
+  yard

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Federico Gimenez Nieto
+
+MIT License
+
+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,34 @@
+[![Build Status](https://travis-ci.org/fgimenez/vagrant-shell-commander.png)](https://travis-ci.org/fgimenez/vagrant-shell-commander)
+[![Code Climate](https://codeclimate.com/github/fgimenez/vagrant-shell-commander.png)](https://codeclimate.com/github/fgimenez/vagrant-shell-commander)
+
+# 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.
+
+## Installation
+
+Install it as a vagrant plugin:
+
+    $ vagrant plugin install vagrant-shell-commander
+
+## Usage
+
+To execute a command on all the machines:
+
+    $ vagrant sh --cmd 'free'
+
+Restrict the machine to run:
+
+    $ vagrant sh --cmd 'free' machine1
+
+Add working directory:
+
+    $ vagrant sh --cmd 'ls -al' --cwd '/srv/www'
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+
+Dir.glob('lib/tasks/*.rake').each { |r| import r }
+
+task default: [:reek, :spec, :quality]

data/Vagrantfile

@@ -0,0 +1,6 @@
+Vagrant.require_plugin "vagrant-shell-commander"
+
+Vagrant::Config.run 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"
+end

data/lib/tasks/cane.rake

@@ -0,0 +1,12 @@
+begin
+  require 'cane/rake_task'
+
+  desc "Run cane to check quality metrics"
+  Cane::RakeTask.new(:quality) do |cane|
+    cane.abc_max = 15
+    cane.add_threshold 'coverage/.last_run.json', :>=, 95
+    cane.no_style = true
+  end
+rescue LoadError
+  warn "cane not available, quality task not provided."
+end

data/lib/tasks/reek.rake

@@ -0,0 +1,5 @@
+require 'reek/rake/task'
+
+Reek::Rake::Task.new do |t|
+  t.fail_on_error = false
+end

data/lib/tasks/rspec.rake

@@ -0,0 +1,6 @@
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+  warn "rspec not available, spec task not provided."
+end

data/lib/vagrant-shell-commander.rb

@@ -0,0 +1,15 @@
+require "vagrant-shell-commander/version"
+require "vagrant-shell-commander/option_manager"
+
+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/command.rb

@@ -0,0 +1,53 @@
+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])
+      
+      return unless argv
+      
+      with_target_vms(argv) do |machine|
+        manage_machine(machine, cli_options) 
+      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.info("Machine #{machine.name} is not running.")
+        return
+      end
+      
+      machine.communicate.
+        execute(add_cwd_to_command(cli_options[:values][:cmd], 
+                                   cli_options[:values][:cwd])) do |type, data|
+        env.ui.info("#{machine.name}:: #{data}")
+      end
+    end
+
+    # Adds the change to a working directory 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
+    #
+    def add_cwd_to_command(cmd, cwd=nil)
+      return cmd unless cwd
+      "cd #{cwd} && #{cmd}"
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+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
+    #
+    def execute
+      options = {}
+      block = lambda do |parser|
+        parser.banner = "Usage: vagrant sh --cmd 'COMMAND' --cwd [DIR] [MACHINE]"
+
+        parser.separator ''
+
+        parser.on('--cwd [DIR]', '--change-working-dir [DIR]', 
+                  'Directory to execute the command') do |cwd|
+          options[:cwd] = cwd
+        end
+
+        parser.on("--cmd 'COMMAND'", "--command 'COMMAND'", 
+                  'Command to execute') do |cmd|
+          options[:cmd] = cmd
+        end
+      end
+
+      {parser: OptionParser.new(&block), values: options}
+    end
+  end
+end
+

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

@@ -0,0 +1,3 @@
+module VagrantShellCommander
+  VERSION = "0.1.0"
+end

data/spec/command_spec.rb

@@ -0,0 +1,104 @@
+require 'spec_helper'
+
+describe VagrantShellCommander::Command do
+  let(:subject) {described_class.new('2', 'command')}
+  let(:argv) {double}
+  let(:opts) {{parser: 'parser', values: 'values'}}
+
+  before(:each) do
+    VagrantShellCommander::OptionManager.stub_chain(:new, :execute).
+      and_return(opts)
+
+    subject.stub(:with_target_vms)
+    subject.stub(:parse_options).and_return(argv)
+  end
+
+  describe '#execute' do
+    it 'returns 0 if all went good' do
+      expect(subject.execute).to eql(0)
+    end
+    
+    describe 'options' do
+      after(:each) do
+        subject.execute
+      end
+
+      it 'parses the given options' do
+        subject.should_receive(:parse_options).with(opts[:parser])
+      end
+      
+      it 'returns on option parsing failure' do
+        subject.stub(:parse_options).and_return(false)
+        
+        expect(subject.execute).to eql(nil)
+      end
+      
+    end
+
+    describe 'command execution' do
+      let(:machine) {double}
+      let(:ui) {double(info: true)}
+      let(:env) {double(ui: ui)}
+      let(:machine_name) {'machine_name'}
+
+      before(:each) do
+        subject.stub(:with_target_vms).and_yield(machine)
+        subject.stub(:env).and_return env
+        machine.stub(:name).and_return(machine_name)
+      end
+
+      after(:each) do
+        subject.execute
+      end
+      
+      context 'not running machine' do
+        before(:each) do
+          machine.stub_chain(:state, :id).and_return(:not_running)
+        end
+
+        it 'reports information about state' do
+          ui.should_receive(:info).with("Machine #{machine_name} is not running.")
+        end
+
+        it 'dows not try to execute the command' do
+          machine.should_not_receive(:communicate)
+        end
+      end
+
+      context 'running machine' do
+        let(:cmd) {'command'}
+        let(:communicate) {double(execute: true)}
+        
+        before(:each) do
+          VagrantShellCommander::OptionManager.stub_chain(:new, :execute).
+            and_return(parser: 'parser', values: {cmd: cmd})
+
+          machine.stub_chain(:state, :id).and_return(:running)
+          machine.stub(:communicate).and_return(communicate)
+        end
+
+        it 'executes the given command' do
+          communicate.should_receive(:execute).with(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(:info).with("#{machine_name}:: #{data}")
+        end
+
+        it 'executes the command in the given cwd' do
+          cwd = 'cwd'
+
+          VagrantShellCommander::OptionManager.stub_chain(:new, :execute).
+            and_return(parser: 'parser', values: {cmd: cmd, cwd: cwd})
+          
+          communicate.should_receive(:execute).with("cd #{cwd} && #{cmd}")
+        end
+
+      end
+    end
+  end
+end

data/spec/option_manager_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe VagrantShellCommander::OptionManager do
+  let(:subject) {described_class.new}
+  let(:argv) {double()}
+
+  describe '#execute' do
+    let(:option_parser) {double(:banner= => true, 
+                                separator: true, 
+                                on: true)}
+
+    before(:each) do
+      OptionParser.stub(:new).
+        and_yield(option_parser)
+      
+      subject.stub(:parse_options).and_return(true)
+    end
+    
+    after(:each) do
+
+    end
+      
+    it 'displays a informing banner' do
+      option_parser.should_receive(:banner=)
+
+      subject.execute
+    end
+    
+    it 'has a cwd option' do
+      cwd_value = 'cwd'
+      
+      option_parser.stub(:on).with('--cwd [DIR]', 
+                                   anything, 
+                                   anything).
+        and_yield(cwd_value)
+
+      result = subject.execute
+
+      expect(result[:values][:cwd]).to eql(cwd_value)
+    end
+    
+    it 'has a cmd option' do
+      cmd_value = 'cmd'
+      
+      option_parser.stub(:on).with("--cmd 'COMMAND'", 
+                                   anything, 
+                                   anything).
+        and_yield(cmd_value)
+
+      result = subject.execute
+
+      expect(result[:values][:cmd]).to eql(cmd_value)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require 'simplecov'
+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|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+ 
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/vagrant_shell_commander_spec.rb

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

data/vagrant-shell-commander.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vagrant-shell-commander/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vagrant-shell-commander"
+  spec.version       = VagrantShellCommander::VERSION
+  spec.authors       = ["Federico Gimenez Nieto"]
+  spec.email         = ["federico.gimenez@gmail.com"]
+  spec.description   = %q{This plugin allows you to execute a given shell command on all the machines of your multinode environment. You can aldo specify the working directory to execute the command}
+  spec.summary       = %q{Vagrant plugin for executing arbitrary shell commands on guest(s)}
+  spec.homepage      = "https://github.com/fgimenez/vagrant-shell-commander"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "reek"
+  spec.add_development_dependency "cane"
+  spec.add_development_dependency "yard"
+  spec.add_development_dependency "simplecov"
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-shell-commander
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Federico Gimenez Nieto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: reek
+  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: cane
+  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: yard
+  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: simplecov
+  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: This plugin allows you to execute a given shell command on all the machines
+  of your multinode environment. You can aldo specify the working directory to execute
+  the command
+email:
+- federico.gimenez@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- Vagrantfile
+- lib/tasks/cane.rake
+- lib/tasks/reek.rake
+- lib/tasks/rspec.rake
+- lib/vagrant-shell-commander.rb
+- lib/vagrant-shell-commander/command.rb
+- lib/vagrant-shell-commander/option_manager.rb
+- lib/vagrant-shell-commander/version.rb
+- spec/command_spec.rb
+- spec/option_manager_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:
+- MIT
+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.25
+signing_key: 
+specification_version: 3
+summary: Vagrant plugin for executing arbitrary shell commands on guest(s)
+test_files:
+- spec/command_spec.rb
+- spec/option_manager_spec.rb
+- spec/spec_helper.rb
+- spec/vagrant_shell_commander_spec.rb
+has_rdoc: