vagrant 0.5.4 → 0.6.0

data/.gitignore

@@ -1,3 +1,4 @@
+.DS_Store
 pkg/*
 Vagrantfile
 .vagrant

data/.yardopts

@@ -0,0 +1 @@
+-m markdown

data/CHANGELOG.md

@@ -1,3 +1,59 @@
+## 0.6.0 (unreleased)
+
+  - VM name now defaults to the name of the containing folder, plus a timestamp.
+    This should make it easier to identify VMs in the VirtualBox GUI.
+  - Exposed Vagrant test helpers in `Vagrant::TestHelpers` for plugins to easily
+    test themselves against Vagrant environments.
+  - **Plugins** have landed. Plugins are simply gems which have a `vagrant_init.rb`
+    file somewhere in their load path. Please read the documentation on
+    vagrantup.com before attempting to create a plugin (which is very easy)
+    for more information on how it all works and also some guidelines.
+  - `vagrant package` now takes a `--vagrantfile` option to specify a
+    Vagrantfile to package. The `--include` approach for including a Vagrantfile
+    no longer works (previously built boxes will continue to work).
+  - `vagrant package` has new logic with regards to the `--include` option
+    depending on if the file path is relative or absolute (they can be
+    intermixed):
+      * _Relative_ paths are copied directly into the box, preserving
+        their path. So `--include lib/foo` would be in the box as "lib/foo"
+      * _Absolute_ paths are simply copied files into the root of the
+        box. So `--include /lib/foo` would be in the box as "foo"
+  - "vagrant_main" is no longer the default run list. Instead, chef
+    run list starts empty. It is up to you to specify all recipes in
+    the Vagrantfile now.
+  - Fixed various issues with certain action middleware not working if
+    the VM was not created.
+  - SSH connection is retried 5 times if there is a connection refused.
+    Related to GH-140.
+  - If `http_proxy` environmental variable is set, it will be used as the proxy
+    box adding via http.
+  - Remove `config.ssh.password`. It hasn't been used for a few versions
+    now and was only kept around to avoid exceptions in Vagrantfiles.
+  - Configuration is now validated so improper input can be found in
+    Vagrantfiles.
+  - Fixed issue with not detecting Vagrantfile at root directory ("/").
+  - Vagrant now gives a nice error message if there is a syntax error
+    in any Vagrantfile. [GH-154]
+  - The format of the ".vagrant" file which stores persisted VMs has
+    changed. This is **backwards incompatible**. Will provide an upgrade
+    utility prior to 0.6 launch.
+  - Every [expected] Vagrant error now exits with a clean error message
+    and a unique exit status, and raises a unique exception (if you're
+    scripting Vagrant).
+  - Added I18n gem dependency for pulling strings into clean YML files.
+    Vagrant is now localizable as a side effect! Translations welcome.
+  - Fixed issue with "Waiting for cleanup" message appearing twice in
+    some cases. [GH-145]
+  - Converted CLI to use Thor. As a tradeoff, there are some backwards
+    incompatibilities:
+      * `vagrant package` - The `--include` flag now separates filenames
+        by spaces, instead of by commas. e.g. `vagrant package --include x y z`
+      * `vagrant ssh` - If you specify a command to execute using the `--execute`
+        flag, you may now only specify one command (before you were able to
+        specify an arbitrary amount). e.g. `vagrant ssh -e "echo hello"`
+      * `vagrant ssh-config` has become `vagrant ssh_config` due to a limitation
+        in Thor.
+
 ## 0.5.4 (September 7, 2010)
 
   - Fix issue with the "exec failed" by running on Tiger as well.

data/Gemfile

@@ -2,7 +2,8 @@ source "http://rubygems.org"
 
 gem "vagrant", :path => '.'
 
-# Use the version of virtualbox off of github
+# Use the following gems straight from git, since Vagrant dev
+# typically coincides with it
 gem "virtualbox", :git => "git://github.com/mitchellh/virtualbox.git"
 
 # Gems required for testing only. To install run
@@ -11,6 +12,16 @@ group :test do
   gem "rake"
   gem "contest", ">= 0.1.2"
   gem "mocha"
-  gem "yard"
-  gem "ruby-debug", ">= 0.10.3" if RUBY_VERSION < '1.9'
+
+  # For documentation
+  gem "yard", "~> 0.6.1"
+  gem "bluecloth"
+
+  platforms :mri_18 do
+    gem "ruby-debug"
+  end
+
+  platforms :mri_19 do
+    gem "ruby-debug19"
+  end
 end

data/Gemfile.lock

@@ -1,20 +1,22 @@
 GIT
   remote: git://github.com/mitchellh/virtualbox.git
-  revision: 69db76b
+  revision: 041996145591d20acf3e04fef3d4709f826d878a
   specs:
-    virtualbox (0.7.5)
-      ffi (>= 0.6.3)
+    virtualbox (0.7.6.dev)
+      ffi (~> 0.6.3)
 
 PATH
   remote: .
   specs:
-    vagrant (0.5.4)
+    vagrant (0.6.0)
       archive-tar-minitar (= 0.5.2)
-      erubis (>= 2.6.6)
-      json (>= 1.4.3)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4.1)
+      json (~> 1.4.6)
       mario (~> 0.0.6)
-      net-scp (>= 1.0.2)
-      net-ssh (>= 2.0.19)
+      net-scp (~> 1.0.3)
+      net-ssh (~> 2.0.23)
+      thor (~> 0.14.2)
       virtualbox (~> 0.7.3)
 
 GEM
@@ -22,28 +24,53 @@ GEM
   specs:
     abstract (1.0.0)
     archive-tar-minitar (0.5.2)
+    bluecloth (2.0.9)
+    columnize (0.3.1)
     contest (0.1.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)
+    linecache (0.43)
+    linecache19 (0.5.11)
+      ruby_core_source (>= 0.1.4)
     mario (0.0.6)
     mocha (0.9.8)
       rake
-    net-scp (1.0.3)
+    net-scp (1.0.4)
       net-ssh (>= 1.99.1)
     net-ssh (2.0.23)
     rake (0.8.7)
-    yard (0.5.8)
+    ruby-debug (0.10.3)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.3.0)
+    ruby-debug-base (0.10.3)
+      linecache (>= 0.3)
+    ruby-debug-base19 (0.11.24)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.4)
+      archive-tar-minitar (>= 0.5.2)
+    thor (0.14.2)
+    yard (0.6.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  bluecloth
   contest (>= 0.1.2)
   mocha
   rake
+  ruby-debug
+  ruby-debug19
   vagrant!
   virtualbox!
-  yard
+  yard (~> 0.6.1)

data/README.md

@@ -3,7 +3,7 @@
 * Website: [http://vagrantup.com](http://vagrantup.com)
 * Source: [http://github.com/mitchellh/vagrant](http://github.com/mitchellh/vagrant)
 * IRC: `#vagrant` on Freenode
-* Mailng list: [Google Groups](http://groups.google.com/group/vagrant-up)
+* Mailing list: [Google Groups](http://groups.google.com/group/vagrant-up)
 
 Vagrant is a tool for building and distributing virtualized development environments.
 

data/bin/vagrant

@@ -1,7 +1,22 @@
 #!/usr/bin/env ruby
-# Get library
-libdir = File.join(File.dirname(__FILE__), '..', 'lib')
-require File.expand_path('vagrant', libdir)
+require 'vagrant'
+require 'vagrant/cli'
 
-# Call the command
-Vagrant::Command.execute(*ARGV)
+env = Vagrant::Environment.new
+
+begin
+  # Set the UI early in case any errors are raised, and load
+  # the config immediately, so we gather any new commands from
+  # plugins
+  env.ui = Vagrant::UI::Shell.new(env, Thor::Base.shell.new)
+  env.load!
+
+  # Kick start the CLI
+  Vagrant::CLI.start(ARGV, :env => env)
+rescue Vagrant::Errors::VagrantError => e
+  opts = { :prefix => false }
+  env.ui.error e.message, opts if e.message
+  env.ui.error e.backtrace.join("\n"), opts if ENV["VAGRANT_DEBUG"]
+  exit e.status_code if e.respond_to?(:status_code)
+  exit 999 # An error occurred with no status code defined
+end

data/config/default.rb

@@ -1,6 +1,5 @@
 Vagrant::Config.run do |config|
   # default config goes here
-  config.vagrant.log_output = STDOUT
   config.vagrant.dotfile_name = ".vagrant"
   config.vagrant.home = "~/.vagrant"
   config.vagrant.host = :detect
@@ -11,7 +10,7 @@ Vagrant::Config.run do |config|
   config.ssh.forwarded_port_key = "ssh"
   config.ssh.max_tries = 10
   config.ssh.timeout = 30
-  config.ssh.private_key_path = File.join(PROJECT_ROOT, 'keys', 'vagrant')
+  config.ssh.private_key_path = File.expand_path("keys/vagrant", Vagrant.source_root)
   config.ssh.forward_agent = false
 
   config.vm.auto_port_range = (2200..2250)
@@ -26,16 +25,15 @@ Vagrant::Config.run do |config|
   config.vm.boot_mode = "vrdp"
   config.vm.system = :linux
 
+  config.vm.customize do |vm|
+    # Make VM name the name of the containing folder by default
+    vm.name = File.basename(File.expand_path("../", Vagrant.source_root)) + "_#{Time.now.to_i}"
+  end
+
   # Share the root folder. This can then be overridden by
   # other Vagrantfiles, if they wish.
   config.vm.share_folder("v-root", "/vagrant", ".")
 
-  config.unison.folder_suffix = ".sync"
-  config.unison.script = "/tmp/vagrant-unison"
-  config.unison.options = "-terse -owner -group -batch"
-  config.unison.crontab_entry_file = "/tmp/vagrant-unison-crontab"
-  config.unison.log_file = "/tmp/v-unison-log-%s"
-
   config.nfs.map_uid = :auto
   config.nfs.map_gid = :auto
 

data/lib/vagrant.rb

@@ -1,19 +1,46 @@
-libdir = File.join(File.dirname(__FILE__), "vagrant")
-PROJECT_ROOT = File.join(libdir, '..', "..") unless defined?(PROJECT_ROOT)
+require 'pathname'
+require 'json'
+require 'i18n'
+require 'virtualbox'
 
-# First, load the various libs which Vagrant requires
-%w{tempfile json pathname logger virtualbox net/ssh archive/tar/minitar
-  net/scp fileutils mario}.each do |lib|
-  require lib
+module Vagrant
+  # TODO: Move more classes over to the autoload model. We'll
+  # start small, but slowly move everything over.
+
+  autoload :Box,           'vagrant/box'
+  autoload :BoxCollection, 'vagrant/box_collection'
+  autoload :CLI,           'vagrant/cli'
+  autoload :Config,        'vagrant/config'
+  autoload :DataStore,     'vagrant/data_store'
+  autoload :Errors,        'vagrant/errors'
+  autoload :Plugin,        'vagrant/plugin'
+  autoload :TestHelpers,   'vagrant/test_helpers'
+  autoload :Util,          'vagrant/util'
+
+  module Command
+    autoload :Base,      'vagrant/command/base'
+    autoload :GroupBase, 'vagrant/command/group_base'
+    autoload :Helpers,   'vagrant/command/helpers'
+    autoload :NamedBase, 'vagrant/command/named_base'
+  end
+
+  # The source root is the path to the root directory of
+  # the Vagrant gem.
+  def self.source_root
+    @source_root ||= Pathname.new(File.expand_path('../../', __FILE__))
+  end
 end
 
-# Then load the glob loader, which will handle loading everything else
-require File.expand_path("util/glob_loader", libdir)
+# Default I18n to load the en locale
+I18n.load_path << File.expand_path("templates/locales/en.yml", Vagrant.source_root)
 
-# Load them up
-Vagrant::GlobLoader.glob_require(libdir, %w{util util/stacked_proc_runner
-  downloaders/base config provisioners/base provisioners/chef systems/base
-  commands/base commands/box action/exception_catcher hosts/base})
+# Load them up. One day we'll convert this to autoloads. Today
+# is not that day. Low hanging fruit for anyone wishing to do it.
+libdir = File.expand_path("lib/vagrant", Vagrant.source_root)
+Vagrant::Util::GlobLoader.glob_require(libdir, %w{
+  downloaders/base provisioners/base provisioners/chef systems/base
+  hosts/base})
 
-# Initialize the built-in actions
+# Initialize the built-in actions and load the plugins.
 Vagrant::Action.builtin!
+Vagrant::Plugin.load!

data/lib/vagrant/action.rb

@@ -1,12 +1,56 @@
 module Vagrant
   # Manages action running and registration. Every Vagrant environment
   # has an instance of {Action} to allow for running in the context of
-  # the environment.
+  # the environment, which is accessible at {Environment#actions}. Actions
+  # are the foundation of most functionality in Vagrant, and are implemented
+  # architecturally as "middleware."
+  #
+  # # Registering an Action
+  #
+  # The main benefits of registering an action is the ability to retrieve and
+  # modify that registered action, as well as easily run the action. An example
+  # of registering an action is shown below, with a simple middleware which just
+  # outputs to `STDOUT`:
+  #
+  #     class StdoutMiddleware
+  #       def initialize(app, env)
+  #         @app = app
+  #       end
+  #
+  #       def call(env)
+  #         puts "HI!"
+  #         @app.call(env)
+  #       end
+  #     end
+  #
+  #     Vagrant::Action.register(:stdout, StdoutMiddleware)
+  #
+  # Then to run a registered action, assuming `env` is a loaded {Environment}:
+  #
+  #     env.actions.run(:stdout)
+  #
+  # Or to retrieve the action class for any reason:
+  #
+  #     Vagrant::Action[:stdout]
+  #
+  # # Running an Action
+  #
+  # There are various built-in registered actions such as `start`, `stop`, `up`,
+  # etc. Actions are built to be run in the context of an environment, so use
+  # {Environment#actions} to run all actions. Then simply call {#run}:
+  #
+  #     env.actions.run(:name)
+  #
+  # Where `:name` is the name of the registered action.
+  #
   class Action
     include Util
+    @@reported_interrupt = false
 
     class << self
       # Returns the list of registered actions.
+      #
+      # @return [Array]
       def actions
         @actions ||= {}
       end
@@ -17,12 +61,14 @@ module Vagrant
       #
       # @param [Symbol] key
       def register(key, callable)
-        actions[key] = callable
+        actions[key.to_sym] = callable
       end
 
       # Retrieves a registered action by key.
+      #
+      # @param [Symbol] key
       def [](key)
-        actions[key]
+        actions[key.to_sym]
       end
     end
 
@@ -41,11 +87,13 @@ module Vagrant
     # If a symbol is given as the `callable` parameter, then it is looked
     # up in the registered actions list which are registered with {register}.
     #
+    # Any options given are injected into the environment hash.
+    #
     # @param [Object] callable An object which responds to `call`.
     def run(callable, options=nil)
       callable = Builder.new.use(callable) if callable.kind_of?(Class)
       callable = self.class.actions[callable] if callable.kind_of?(Symbol)
-      raise Exceptions::UncallableAction.new(callable) if !callable
+      raise ArgumentError.new("Argument to run must be a callable object or registered action.") if !callable
 
       action_environment = Action::Environment.new(env)
       action_environment.merge!(options || {})
@@ -55,24 +103,16 @@ module Vagrant
       # chain has been run.
       int_callback = lambda do
         if action_environment.interrupted?
-          env.logger.info "Exiting immediately!"
+          env.ui.error I18n.t("vagrant.actions.runner.exit_immediately")
           abort
         end
 
-        env.logger.info "Waiting for cleanup before exiting..."
-        action_environment.error!(:interrupt)
+        env.ui.warn I18n.t("vagrant.actions.runner.waiting_cleanup") if !@@reported_interrupt
+        action_environment.interrupt!
+        @@reported_interrupt = true
       end
 
       Busy.busy(int_callback) { callable.call(action_environment) }
-      exit if action_environment.interrupted?
-
-      if action_environment.error?
-        # Erroneous environment resulted. Properly display error
-        # message.
-        key, options = action_environment.error
-        error_and_exit(key, options)
-        return false
-      end
     end
   end
 end

data/lib/vagrant/action/box/destroy.rb

@@ -1,3 +1,5 @@
+require 'fileutils'
+
 module Vagrant
   class Action
     module Box
@@ -8,7 +10,7 @@ module Vagrant
         end
 
         def call(env)
-          env.logger.info "Deleting box directory..."
+          env.ui.info I18n.t("vagrant.actions.box.destroy.destroying", :name => env["box"].name)
           FileUtils.rm_rf(env["box"].directory)
 
           @app.call(env)