vagrant-exec 0.1.0

data/Gemfile

@@ -0,0 +1,10 @@
+source 'http://rubygems.org'
+
+gemspec
+
+group :development do
+  # We depend on Vagrant for development, but we don't add it as a
+  # gem dependency because we expect to be installed within the
+  # Vagrant environment itself using `vagrant plugin`.
+  gem 'vagrant', git: 'git://github.com/mitchellh/vagrant.git'
+end

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2013-2013 Alex Rodionov
+
+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,71 @@
+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
+-----------
+
+You will probably use the plugin if you don't want to SSH into the box to execute commands simply because your machine environment is already configured (e.g. I use ZSH and TextMate bundles to run specs/features).
+
+Example
+-------
+
+```shell
+➜ vagrant exec pwd
+/vagrant
+```
+
+Installation
+-------
+
+```shell
+➜ vagrant plugin install vagrant-exec
+```
+
+Configuration
+-------------
+
+The root directory can be configured using Vagrantfile.
+
+```ruby
+Vagrant.configure('2') do |config|
+  config.vm.box = 'precise32'
+  config.exec.folder = '/custom'
+end
+```
+
+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
+Vagrant.configure('2') do |config|
+  config.vm.box = 'precise32'
+  config.exec.bundler = true
+end
+```
+
+Acceptance tests
+----------------
+
+Before running features, you'll need to bootstrap box.
+
+```shell
+➜ bundle exec rake features:bootstrap
+➜ bundle exec rake features:run
+```
+
+Note on Patches/Pull Requests
+-----------------------------
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+Copyright
+---------
+
+Copyright (c) 2013-2013 Alex Rodionov. See LICENSE.md for details.

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler'
+require 'cucumber/rake/task'
+Bundler::GemHelper.install_tasks
+
+namespace :features do
+  task(:bootstrap) do
+    # download and add box for acceptance tests
+    system("bundle exec vagrant box add precise32 http://files.vagrantup.com/precise32.box")
+  end
+
+  Cucumber::Rake::Task.new(:run) do |t|
+    t.cucumber_opts = %w(--format pretty)
+  end
+end

data/features/step_definitions/steps.rb

@@ -0,0 +1,30 @@
+Given(/^I have default Vagrantfile$/) do
+  vagrantfile = <<-RUBY
+Vagrant.require_plugin 'vagrant-exec'
+
+Vagrant.configure('2') do |config|
+  config.vm.box = 'precise32'
+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

data/features/support/env.rb

@@ -0,0 +1,11 @@
+require 'aruba/cucumber'
+
+Before do
+  # VM start takes a long time
+  @aruba_timeout_seconds = 60
+end
+
+After do
+  # halt VM
+  system "cd tmp/aruba; bundle exec vagrant halt &> /dev/null"
+end

data/features/vagrant-exec.feature

@@ -0,0 +1,61 @@
+@no-clobber
+Feature: vagrant-exec
+  In order to execute commands in Vagrant box
+  Within context of root synced folder
+  As a developer using vagrant-exec plugin
+  I want to use "vagrant exec" command
+  And be able to customize folder
+  And prepend commands with "bundle exec"
+  Using Vagrantfile configuraiotn
+
+  Background:
+    Given I have default Vagrantfile
+
+  Scenario: uses /vagrant as default folder
+    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"
+
+  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"
+
+  Scenario: raises error if folder is improperly set
+    Given I set vagrant-exec folder to true
+    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"
+
+  Scenario: does not use bundler by default
+    Given I run `bundle exec vagrant up`
+    When I run `bundle exec vagrant exec pwd`
+    Then the output should not contain "bundle exec"
+
+  # we don't have bundler in box
+  Scenario: can use bundler
+    Given I set vagrant-exec bundler to true
+    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"
+
+  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"
+
+  Scenario: raises error if bundler is improperly set
+    Given I set vagrant-exec bundler to "true"
+    When I run `bundle exec vagrant up`
+    Then the exit status should not be 0
+    And the output should contain "bundler should be boolean"
+
+  Scenario: can use custom VM
+    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"

data/lib/vagrant-exec/command.rb

@@ -0,0 +1,41 @@
+module VagrantPlugins
+  module Exec
+    class Command < Vagrant.plugin(2, :command)
+
+      def execute
+        options = {}
+
+        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
+          end
+        end
+
+        # Parse the options
+        argv = parse_options(opts)
+        return unless argv
+
+        # Execute the actual SSH
+        with_target_vms(options[:machine], 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}; "
+          if vm.config.exec.bundler && !(plain =~ /^bundle /)
+            command << 'bundle exec '
+          end
+          command << plain
+          @logger.debug("Executing single command on remote machine: #{command}")
+          env = vm.action(:ssh_run, ssh_run_command: command)
+
+          status = env[:ssh_run_exit_status] || 0
+          return status
+        end
+      end
+
+    end # Command
+  end # Exec
+end # VagrantPlugins

data/lib/vagrant-exec/config.rb

@@ -0,0 +1,27 @@
+module VagrantPlugins
+  module Exec
+    class Config < Vagrant.plugin(2, :config)
+
+      attr_accessor :folder
+      attr_accessor :bundler
+
+      def initialize
+        @folder  = UNSET_VALUE
+        @bundler = 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)
+
+        {}
+      end
+
+      def finalize!
+        @folder  = '/vagrant' if @folder  == UNSET_VALUE
+        @bundler = false      if @bundler == UNSET_VALUE
+      end
+
+    end # Config
+  end # Exec
+end # VagrantPlugins

data/lib/vagrant-exec/plugin.rb

@@ -0,0 +1,20 @@
+module VagrantPlugins
+  module Exec
+    class Plugin < Vagrant.plugin(2)
+
+      name 'Vagrant Exec'
+      description 'Plugin allows to execute commands within the context of synced folder.'
+
+      config :exec do
+        require_relative 'config'
+        Config
+      end
+
+      command :exec do
+        require_relative 'command'
+        Command
+      end
+
+    end # Plugin
+  end # Exec
+end # VagrantPlugins

data/lib/vagrant-exec/version.rb

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

data/lib/vagrant-exec.rb

@@ -0,0 +1,4 @@
+require 'vagrant'
+
+require 'vagrant-exec/plugin'
+require 'vagrant-exec/version'

data/vagrant-exec.gemspec

@@ -0,0 +1,21 @@
+$:.push File.expand_path("../lib", __FILE__)
+require 'vagrant-exec/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'vagrant-exec'
+  s.version     = VagrantPlugins::Exec::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.author      = 'Alex Rodionov'
+  s.email       = 'p0deje@gmail.com'
+  s.homepage    = 'http://github.com/p0deje/vagrant-exec'
+  s.summary     = 'Execute commands in Vagrant synced folder'
+  s.description = 'Vagrant plugin to execute commands within the context of VM synced folder'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = %w(lib)
+
+  s.add_development_dependency 'aruba'
+  s.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-exec
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Alex Rodionov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aruba
+  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: 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'
+description: Vagrant plugin to execute commands within the context of VM synced folder
+email: p0deje@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- features/step_definitions/steps.rb
+- features/support/env.rb
+- features/vagrant-exec.feature
+- lib/vagrant-exec.rb
+- lib/vagrant-exec/command.rb
+- lib/vagrant-exec/config.rb
+- lib/vagrant-exec/plugin.rb
+- lib/vagrant-exec/version.rb
+- vagrant-exec.gemspec
+homepage: http://github.com/p0deje/vagrant-exec
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 612892604228850569
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 612892604228850569
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Execute commands in Vagrant synced folder
+test_files:
+- features/step_definitions/steps.rb
+- features/support/env.rb
+- features/vagrant-exec.feature