vagrant-rake 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in vagrant-rake.gemspec
+gem "vagrant-rake", :path => "."
+
+gem "vagrant", :git => "git://github.com/mitchellh/vagrant.git"
+
+group :test do
+  gem "protest", "~> 0.4.0"
+  gem "mocha", "~> 0.9.8"
+end

data/Gemfile.lock

@@ -0,0 +1,52 @@
+GIT
+  remote: git://github.com/mitchellh/vagrant.git
+  revision: daa6caffe98d6285a0dad0467f002dd57e822985
+  specs:
+    vagrant (0.6.0.dev)
+      archive-tar-minitar (= 0.5.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4.1)
+      json (~> 1.4.6)
+      mario (~> 0.0.6)
+      net-scp (~> 1.0.3)
+      net-ssh (~> 2.0.23)
+      thor (~> 0.14.1)
+      virtualbox (~> 0.7.3)
+
+PATH
+  remote: .
+  specs:
+    vagrant-rake (0.1.0)
+      vagrant (~> 0.6.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    archive-tar-minitar (0.5.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    ffi (0.6.3)
+      rake (>= 0.8.7)
+    i18n (0.4.1)
+    json (1.4.6)
+    mario (0.0.6)
+    mocha (0.9.8)
+      rake
+    net-scp (1.0.4)
+      net-ssh (>= 1.99.1)
+    net-ssh (2.0.23)
+    protest (0.4.1)
+    rake (0.8.7)
+    thor (0.14.2)
+    virtualbox (0.7.5)
+      ffi (>= 0.6.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mocha (~> 0.9.8)
+  protest (~> 0.4.0)
+  vagrant!
+  vagrant-rake!

data/README.md

@@ -0,0 +1,49 @@
+# vagrant-rake
+
+`vagrant-rake` is a plugin for [Vagrant](http://vagrantup.com) which allows
+a developer to execute rake tasks on the host using the `vagrant rake` command
+and have them be invoked on the guest. This alleviates the need to SSH into
+the VM to simply run a rake task.
+
+This gem is also a good example of how to create a proper Vagrant plugin.
+
+**NOTE:** This plugin requires Vagrant 0.6 or later.
+
+## Installing / Getting Started
+
+To use this plugin, first install Vagrant 0.6 or later. Next, install this gem:
+
+    gem install vagrant-rake
+
+The `vagrant rake` command should now be available. To use it, simply
+pass use it as if you were running rake locally. The various ways to
+call the command is shown below:
+
+    vagrant rake db:migrate
+    vagrant rake build
+    vagrant rake test --cwd /some/other/directory
+
+The plugin will auotomatically run your rake task on the VM, forwarding
+the output to you on the host.
+
+You can also specify the default working directory for executed
+rake tasks in your Vagrantfile:
+
+    Vagrant::Config.run do |config|
+      config.rake.directory = "/my/custom/directory"
+    end
+
+## Working with the Plugin Source
+
+If you'd like to work with the plugin source (for learning purposes or
+to make a contribution), then clone out this repository, then run the
+test suite to verify everything is working:
+
+    git clone git://github.com/mitchellh/vagrant-rake.git
+    cd vagrant-rake
+
+Then bundle the environment to get the required gems, and run rake to
+verify that the test suite passes:
+
+    bundle install
+    rake

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'bundler'
+require 'bundler/setup'
+Bundler::GemHelper.install_tasks
+
+task :default => :test
+
+desc "Run the test suite."
+task :test do
+  $:.unshift File.expand_path("../test", __FILE__)
+
+  Dir["test/**/*_test.rb"].each do |f|
+    load f
+  end
+end

data/lib/vagrant-rake.rb

@@ -0,0 +1,16 @@
+require 'vagrant'
+require 'vagrant-rake/config'
+require 'vagrant-rake/command'
+require 'vagrant-rake/middleware'
+
+# Create a new middleware stack "rake" which is executed for
+# rake commands. See the VagrantRake::Middleware docs for more
+# information.
+rake = Vagrant::Action::Builder.new do
+  use VagrantRake::Middleware
+end
+
+Vagrant::Action.register(:rake, rake)
+
+# Add our custom translations to the load path
+I18n.load_path << File.expand_path("../../locales/en.yml", __FILE__)

data/lib/vagrant-rake/command.rb

@@ -0,0 +1,23 @@
+module VagrantRake
+  class Command < Vagrant::Command::Base
+    register "rake", "Run a rake task inside the VM environment"
+    argument :rake_command, :type => :array, :required => false, :desc => "The command to run on the VM via Rake"
+    class_option :cwd, :type => :string, :default => nil
+
+    # Executes the given rake command on the VMs that are represented
+    # by this environment.
+    def execute
+      command = (rake_command || []).join(" ")
+      target_vms.each { |vm| execute_on_vm(vm, command) }
+    end
+
+    protected
+
+    # Executes a command on a specific VM.
+    def execute_on_vm(vm, command)
+      vm.env.actions.run(:rake,
+                         "rake.command" => command,
+                         "rake.cwd" => options[:cwd])
+    end
+  end
+end

data/lib/vagrant-rake/config.rb

@@ -0,0 +1,12 @@
+module VagrantRake
+  # A configuration class to configure defaults which are used for
+  # the `vagrant-rake` plugin.
+  class Config < Vagrant::Config::Base
+    configures :rake
+    attr_accessor :directory
+
+    def validate(errors)
+      errors.add(I18n.t("vagrant.plugins.rake.config_directory")) if directory && !directory.is_a?(String)
+    end
+  end
+end

data/lib/vagrant-rake/middleware.rb

@@ -0,0 +1,40 @@
+module VagrantRake
+  # A Vagrant middleware which executes a rake task on a given
+  # VM. This task will run "rake" on the VM that this action sequence
+  # was run on. If an env variable "rake.command" is populated, then
+  # this command will be executed by rake.
+  class Middleware
+    def initialize(app, env)
+      @app = app
+      @env = env
+    end
+
+    def call(env)
+      if env["vm"].created? && env["vm"].vm.running?
+        command = "rake #{env["rake.command"]}".strip
+
+        env["vm"].ssh.execute do |ssh|
+          env.ui.info I18n.t("vagrant.plugins.rake.executing", :command => command)
+
+          ssh.exec!("cd #{working_directory}; #{command}") do |channel, type, data|
+            # Print the data directly to STDOUT, not doing any newlines
+            # or any extra formatting of our own
+            $stdout.print(data) if type != :exit_status
+          end
+
+          # Puts out an ending newline just to make sure we end on a new
+          # line.
+          $stdout.puts
+        end
+      end
+
+      @app.call(env)
+    end
+
+    protected
+
+    def working_directory
+      @env["rake.cwd"] || @env["config"].rake.directory || @env["config"].vm.shared_folders["v-root"][:guestpath]
+    end
+  end
+end

data/lib/vagrant-rake/version.rb

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

data/lib/vagrant_init.rb

@@ -0,0 +1,4 @@
+# This file is automatically loaded by Vagrant to load any
+# plugins. This file kicks off this plugin.
+
+require 'vagrant-rake'

data/locales/en.yml

@@ -0,0 +1,6 @@
+en:
+  vagrant:
+    plugins:
+      rake:
+        executing: "Executing: %{command}"
+        config_directory: "Directory must be a string."

data/test/test_helper.rb

@@ -0,0 +1,35 @@
+require "test/unit/assertions"
+require "protest"
+require "mocha"
+require "vagrant-rake"
+
+class Protest::TestCase
+  include Test::Unit::Assertions
+  include Mocha::API
+  include Vagrant::TestHelpers
+
+  # Get Mocha integrated properly into the tests
+  alias :original_run :run
+  def run(report)
+    original_run(report)
+    mocha_verify
+  ensure
+    mocha_teardown
+  end
+
+  # Helper to silence streams, courtesy of Ruby Facets library.
+  def silence_stream(*streams) #:yeild:
+    on_hold = streams.collect{ |stream| stream.dup }
+    streams.each do |stream|
+      stream.reopen(RUBY_PLATFORM =~ /mswin/ ? 'NUL:' : '/dev/null')
+      stream.sync = true
+    end
+    yield
+  ensure
+    streams.each_with_index do |stream, i|
+      stream.reopen(on_hold[i])
+    end
+  end
+end
+
+Protest.report_with(:documentation)

data/test/vagrant-rake/command_test.rb

@@ -0,0 +1,51 @@
+require "test_helper"
+
+Protest.describe("`vagrant rake` command") do
+  setup do
+    clean_paths
+
+    @klass = VagrantRake::Command
+    @env = vagrant_env
+    @vm = @env.vms.values.first
+  end
+
+  should "execute the command on every VM" do
+    @vm.env.actions.expects(:run).with() do |action, options|
+      assert_equal :rake, action
+      assert_equal "db:migrate", options["rake.command"]
+      true
+    end
+
+    @env.cli("rake", "db:migrate")
+  end
+
+  should "execute fine with no command given" do
+    @vm.env.actions.expects(:run).with() do |action, options|
+      assert_equal :rake, action
+      assert_equal "", options["rake.command"]
+      true
+    end
+
+    @env.cli("rake")
+  end
+
+  should "execute within the nil cwd by default" do
+    @vm.env.actions.expects(:run).with() do |action, options|
+      assert_equal :rake, action
+      assert_equal nil, options["rake.cwd"]
+      true
+    end
+
+    @env.cli("rake")
+  end
+
+  should "execute within the given cwd" do
+    @vm.env.actions.expects(:run).with() do |action, options|
+      assert_equal :rake, action
+      assert_equal "/foo/bar", options["rake.cwd"]
+      true
+    end
+
+    @env.cli("rake", "--cwd", "/foo/bar")
+  end
+end

data/test/vagrant-rake/config_test.rb

@@ -0,0 +1,21 @@
+require "test_helper"
+
+Protest.describe("Configuration class") do
+  setup do
+    @klass = VagrantRake::Config
+    @instance = @klass.new
+    @errors = Vagrant::Config::ErrorRecorder.new
+  end
+
+  should "be valid by default" do
+    @instance.validate(@errors)
+    assert @errors.errors.empty?
+  end
+
+  should "be invalid if directory is not a string" do
+    @instance.directory = 24
+    @instance.validate(@errors)
+
+    assert !@errors.errors.empty?
+  end
+end

data/test/vagrant-rake/middleware_test.rb

@@ -0,0 +1,71 @@
+require "test_helper"
+
+Protest.describe("rake middleware") do
+  setup do
+    @klass = VagrantRake::Middleware
+    @app, @env = action_env(vagrant_env.vms.values.first.env)
+
+    @instance = @klass.new(@app, @env)
+
+    @env["vm"].stubs(:created?).returns(true)
+    @env["vm"].vm.stubs(:running?).returns(true)
+  end
+
+  should "do nothing if the VM is not created" do
+    @env["vm"].stubs(:created?).returns(false)
+    @env["vm"].expects(:ssh).never
+    @instance.call(@env)
+  end
+
+  should "do nothing if the VM is not running" do
+    @env["vm"].vm.stubs(:running?).returns(false)
+    @env["vm"].expects(:ssh).never
+    @instance.call(@env)
+  end
+
+  should "run rake via SSH on the VM" do
+    ssh = mock("ssh")
+    @env["vm"].ssh.expects(:execute).yields(ssh)
+
+    ssh.expects(:exec!).with("cd /vagrant; rake")
+
+    silence_stream($stdout) { @instance.call(@env) }
+  end
+
+  should "run the specified rake command via SSH on the VM" do
+    ssh = mock("ssh")
+    @env["vm"].ssh.expects(:execute).yields(ssh)
+
+    ssh.expects(:exec!).with("cd /vagrant; rake db:migrate")
+
+    @env["rake.command"] = "db:migrate"
+    silence_stream($stdout) { @instance.call(@env) }
+  end
+
+  context "cwd" do
+    setup do
+      @ssh = mock("ssh")
+      @env["vm"].ssh.expects(:execute).yields(@ssh)
+      @env["rake.cwd"] = nil
+    end
+
+    should "run the rake command in the specified cwd" do
+      @ssh.expects(:exec!).with("cd /foo/bar; rake")
+
+      @env["rake.cwd"] = "/foo/bar"
+      silence_stream($stdout) { @instance.call(@env) }
+    end
+
+    should "run the rake command with the configured directory if middleware variable is not set" do
+      @env.env.config.rake.directory = "/configured"
+
+      @ssh.expects(:exec!).with("cd /configured; rake")
+      silence_stream($stdout) { @instance.call(@env) }
+    end
+
+    should "run the rake command with the root shared directory if nothing configured" do
+      @ssh.expects(:exec!).with("cd /vagrant; rake")
+      silence_stream($stdout) { @instance.call(@env) }
+    end
+  end
+end

data/vagrant-rake.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/vagrant-rake/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "vagrant-rake"
+  s.version     = VagrantRake::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Mitchell Hashimoto"]
+  s.email       = ["mitchell.hashimoto@gmail.com"]
+  s.homepage    = "http://rubygems.org/gems/vagrant-rake"
+  s.summary     = "A Vagrant plugin to execute `rake` commands from the host in the VM"
+  s.description = "A Vagrant plugin to execute `rake` commands from the host in the VM"
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "vagrant-rake"
+
+  s.add_dependency "vagrant", "~> 0.6.0"
+  s.add_development_dependency "protest", "~> 0.4.0"
+  s.add_development_dependency "mocha", "~> 0.9.8"
+  s.add_development_dependency "bundler", ">= 1.0.0"
+
+  s.files        = `git ls-files`.split("\n")
+  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path = 'lib'
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification 
+name: vagrant-rake
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Mitchell Hashimoto
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-27 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: vagrant
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: protest
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 4
+        - 0
+        version: 0.4.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        - 8
+        version: 0.9.8
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+description: A Vagrant plugin to execute `rake` commands from the host in the VM
+email: 
+- mitchell.hashimoto@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/vagrant-rake.rb
+- lib/vagrant-rake/command.rb
+- lib/vagrant-rake/config.rb
+- lib/vagrant-rake/middleware.rb
+- lib/vagrant-rake/version.rb
+- lib/vagrant_init.rb
+- locales/en.yml
+- test/test_helper.rb
+- test/vagrant-rake/command_test.rb
+- test/vagrant-rake/config_test.rb
+- test/vagrant-rake/middleware_test.rb
+- vagrant-rake.gemspec
+has_rdoc: true
+homepage: http://rubygems.org/gems/vagrant-rake
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -913781413029022123
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: vagrant-rake
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A Vagrant plugin to execute `rake` commands from the host in the VM
+test_files: []
+