vagrant 0.3.4 → 0.4.0

data/lib/vagrant/util.rb

@@ -1,51 +1,7 @@
 module Vagrant
   module Util
     def self.included(base)
-      base.extend Vagrant::Util
-    end
-
-    def wrap_output
-      puts "====================================================================="
-      yield
-      puts "====================================================================="
-    end
-
-    def error_and_exit(key, data = {})
-      abort <<-error
-=====================================================================
-Vagrant experienced an error!
-
-#{Errors.error_string(key, data).chomp}
-=====================================================================
-error
-    end
-
-    def logger
-      Logger.singleton_logger
-    end
-  end
-
-  class Logger < ::Logger
-    @@singleton_logger = nil
-
-    class << self
-      def singleton_logger
-        # TODO: Buffer messages until config is loaded, then output them?
-        if Vagrant.config.loaded?
-          @@singleton_logger ||= Vagrant::Logger.new(Vagrant.config.vagrant.log_output)
-        else
-          Vagrant::Logger.new(nil)
-        end
-      end
-
-      def reset_logger!
-        @@singleton_logger = nil
-      end
-    end
-
-    def format_message(level, time, progname, msg)
-      "[#{level} #{time.strftime('%m-%d-%Y %X')}] Vagrant: #{msg}\n"
+      base.extend(self)
     end
   end
 end
-

data/lib/vagrant/util/error_helper.rb

@@ -0,0 +1,13 @@
+module Vagrant
+  module Util
+    def error_and_exit(key, data = {})
+      abort <<-error
+=====================================================================
+Vagrant experienced an error!
+
+#{Translator.t(key, data).chomp}
+=====================================================================
+error
+    end
+  end
+end

data/lib/vagrant/util/glob_loader.rb

@@ -0,0 +1,22 @@
+module Vagrant
+  # Eases the processes of loading specific files then globbing
+  # the rest from a specified directory.
+  module GlobLoader
+    # Glob requires all ruby files in a directory, optionally loading select
+    # files initially (since others may depend on them).
+    #
+    # @param [String] dir The directory to glob
+    # @param [Array<String>] initial_files Initial files (relative to `dir`)
+    #   to load
+    def self.glob_require(dir, initial_files=[])
+      initial_files.each do |file|
+        require File.expand_path(file, dir)
+      end
+
+      # Glob require the rest
+      Dir[File.join(dir, "**", "*.rb")].each do |f|
+        require File.expand_path(f)
+      end
+    end
+  end
+end

data/lib/vagrant/util/output_helper.rb

@@ -0,0 +1,9 @@
+module Vagrant
+  module Util
+    def wrap_output
+      puts "====================================================================="
+      yield
+      puts "====================================================================="
+    end
+  end
+end

data/lib/vagrant/util/plain_logger.rb

@@ -0,0 +1,12 @@
+module Vagrant
+  module Util
+    # Subclass of the standard library logger which has no format on
+    # its own. The message sent to the logger is outputted as-is.
+    class PlainLogger < ::Logger
+      def format_message(level, time, progname, msg)
+        # We do no formatting, its up to the user
+        "#{msg}\n"
+      end
+    end
+  end
+end

data/lib/vagrant/util/platform.rb

@@ -2,11 +2,16 @@ module Vagrant
   module Util
     # This class just contains some platform checking code.
     class Platform
-      class <<self
+      class << self
         def leopard?
           RUBY_PLATFORM.downcase.include?("darwin9")
         end
+
+        def tar_file_options
+          # create, write only, fail if the file exists, binary if windows
+          File::WRONLY|File::EXCL|File::CREAT|(Mario::Platform.windows? ? File::BINARY : 0)
+        end
       end
     end
   end
-end
+end

data/lib/vagrant/util/template_renderer.rb

@@ -6,7 +6,7 @@ module Vagrant
     # This class is used to render the ERB templates in the
     # `GEM_ROOT/templates` directory.
     class TemplateRenderer < OpenStruct
-      class <<self
+      class << self
         # Render a given template and return the result. This method optionally
         # takes a block which will be passed the renderer prior to rendering, which
         # allows the caller to set any view variables within the renderer itself.
@@ -80,4 +80,4 @@ module Vagrant
       end
     end
   end
-end
+end

data/lib/vagrant/util/translator.rb

@@ -0,0 +1,35 @@
+require 'yaml'
+
+module Vagrant
+  module Util
+    # This class is responsible for reading static messages from the strings.yml file.
+    class Translator
+      @@strings = nil
+
+      class <<self
+        # Resets the internal strings hash to nil, forcing a reload on the next
+        # access of {strings}.
+        def reset!
+          @@strings = nil
+        end
+
+        # Returns the hash of strings from the error YML files. This only loads once,
+        # then returns a cached value until {reset!} is called.
+        #
+        # @return [Hash]
+        def strings
+          @@strings ||= YAML.load_file(File.join(PROJECT_ROOT, "templates", "strings.yml"))
+        end
+
+        # Renders the string with the given key and data parameters and returns
+        # the rendered result.
+        #
+        # @return [String]
+        def t(key, data = {})
+          template = strings[key] || "Unknown strings key: #{key}"
+          TemplateRenderer.render_string(template, data)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant/vm.rb

@@ -2,22 +2,87 @@ module Vagrant
   class VM < Actions::Runner
     include Vagrant::Util
 
-    attr_accessor :env
+    attr_reader :env
+    attr_reader :system
+    attr_reader :name
     attr_accessor :vm
-    attr_accessor :from
 
     class << self
       # Finds a virtual machine by a given UUID and either returns
       # a Vagrant::VM object or returns nil.
-      def find(uuid)
+      def find(uuid, env=nil, vm_name=nil)
         vm = VirtualBox::VM.find(uuid)
-        return nil if vm.nil?
-        new(vm)
+        new(:vm => vm, :env => env, :vm_name => vm_name)
       end
     end
 
-    def initialize(vm=nil)
-      @vm = vm
+    def initialize(opts=nil)
+      defaults = {
+        :vm => nil,
+        :env => nil,
+        :vm_name => nil
+      }
+
+      opts = defaults.merge(opts || {})
+
+      @vm = opts[:vm]
+      @name = opts[:vm_name]
+
+      if !opts[:env].nil?
+        # We have an environment, so we create a new child environment
+        # specifically for this VM. This step will load any custom
+        # config and such.
+        @env = Vagrant::Environment.new({
+          :cwd => opts[:env].cwd,
+          :parent => opts[:env],
+          :vm_name => opts[:vm_name],
+          :vm => self
+        }).load!
+
+        # Load the associated system.
+        load_system!
+      end
+    end
+
+    # Loads the system associated with the VM. The system class is
+    # responsible for OS-specific functionality. More information
+    # can be found by reading the documentation on {Vagrant::Systems::Base}.
+    #
+    # **This method should never be called manually.**
+    def load_system!
+      system = env.config.vm.system
+
+      if system.is_a?(Class)
+        @system = system.new(self)
+        error_and_exit(:system_invalid_class, :system => system.to_s) unless @system.is_a?(Systems::Base)
+      elsif system.is_a?(Symbol)
+        # Hard-coded internal systems
+        mapping = { :linux => Systems::Linux }
+
+        if !mapping.has_key?(system)
+          error_and_exit(:system_unknown_type, :system => system.to_s)
+          return # for tests
+        end
+
+        @system = mapping[system].new(self)
+      else
+        error_and_exit(:system_unspecified)
+      end
+    end
+
+    # Access the {Vagrant::SSH} object associated with this VM.
+    # On the initial call, this will initialize the object. On
+    # subsequent calls it will reuse the existing object.
+    def ssh
+      @ssh ||= SSH.new(env)
+    end
+
+    # Returns a boolean true if the VM has been created, otherwise
+    # returns false.
+    #
+    # @return [Boolean]
+    def created?
+      !vm.nil?
     end
 
     def uuid
@@ -28,18 +93,34 @@ module Vagrant
       @vm = VirtualBox::VM.find(@vm.uuid)
     end
 
-    def package(out_path, include_files=[])
-      add_action(Actions::VM::Export)
-      add_action(Actions::VM::Package, out_path, include_files)
+    def package(options=nil)
+      add_action(Actions::VM::Export, options)
+      add_action(Actions::VM::Package, options)
       execute!
     end
 
+    def up(options=nil)
+      execute!(Actions::VM::Up, options)
+    end
+
     def start
       return if @vm.running?
 
       execute!(Actions::VM::Start)
     end
 
+    def halt(options=nil)
+      execute!(Actions::VM::Halt, options)
+    end
+
+    def reload
+      execute!(Actions::VM::Reload)
+    end
+
+    def provision
+      execute!(Actions::VM::Provision)
+    end
+
     def destroy
       execute!(Actions::VM::Down)
     end

data/templates/crontab_entry.erb

@@ -0,0 +1 @@
+* * * * * <%= scriptname %> '<%= syncopts %>' '<%= guestpath %>' '<%= syncpath %>' '-prefer <%= guestpath %>'

data/templates/network_entry.erb

@@ -0,0 +1,8 @@
+#VAGRANT-BEGIN
+# The contents below are automatically generated by Vagrant.
+# Please do not modify any of these contents.
+auto eth<%= net_options[:adapter] %>
+iface eth<%= net_options[:adapter] %> inet static
+      address <%= net_options[:ip] %>
+      netmask <%= net_options[:netmask] %>
+#VAGRANT-END

data/templates/ssh_config.erb

@@ -4,4 +4,5 @@ Host <%= host_key %>
   Port <%= ssh_port %>
   UserKnownHostsFile /dev/null
   StrictHostKeyChecking no
+  PasswordAuthentication no
   IdentityFile <%= private_key_path %>

data/templates/{errors.yml → strings.yml}

@@ -3,6 +3,46 @@
 # In short, |  means keep new lines, trim whitespace left and right
 # The |- does the above, but trims the new line at the end of all text
 
+#---------------------------------------------------------------------
+# CATEGORY: Status Messages
+#---------------------------------------------------------------------
+:status_listing: |-
+  This environment represents multiple VMs. The VMs will be listed
+  below with a short status. For more detailed information about a
+  VM, run `vagrant status NAME`.
+:status_no_environment: |-
+  No vagrant environment detected. Run `vagrant init` to setup a Vagrantfile
+  in the current directory to get started with Vagrant.
+:status_not_created: |-
+  The environment has not yet been created. Run `vagrant up` to create the
+  environment.
+:status_created: |-
+  The environment has been created. The status of the current environment's
+  virtual machine is: "<%= vm_state %>"
+
+  <%= additional_message %>
+:status_created_running: |-
+  To stop this VM, you can run `vagrant halt` to shut it down forcefully,
+  or you can run `vagrant suspend` to simply suspend the virtual machine.
+  In either case, to restart it again, simply run a `vagrant up`.
+:status_created_saved: |-
+  To resume this VM, simply run `vagrant up`.
+:status_created_powered_off: |-
+  To restart this VM, simply run `vagrant up`.
+:status_global: |-
+  Below is a list of virtual machines which are currently created and were
+  created by a Vagrant environment. The path listed was the "last known path"
+  of the environment (it may have moved).
+
+  <%= entries.join("\n\n") %>
+:status_global_entry: |-
+  Name:       <%= vm.vm.name %>
+  Path:       <%= data["path"] %>
+  Created at: <%= Time.at(data["created_at"]) %>
+
+#---------------------------------------------------------------------
+# CATEGORY: Error Messages
+#---------------------------------------------------------------------
 :box_already_exists: |-
   This box appears to already exist! Please call `vagrant box remove <%= box_name %>`
   and then try to add it again.
@@ -38,6 +78,11 @@
   The validation key set for `config.chef.validation_key_path` does not exist! This
   file needs to exist so it can be uploaded to the virtual machine. It is
   currently set to "<%= Vagrant.config.chef.validation_key_path %>"
+:chef_not_detected: |-
+  The `<%= binary %>` binary appears to not be in the PATH of the guest. This
+  could be because the PATH is not properly setup or perhaps chef is not
+  installed on this guest. Chef provisioning can not continue without
+  chef properly installed.
 :command_box_invalid: |-
   Please specify a valid action to take on the boxes, either
   `add` or `remove`. Examples:
@@ -45,9 +90,6 @@
   vagrant box add name uri
   vagrant box remove name
   vagrant box list
-:command_deprecation_down: |-
-  `vagrant down` is now `vagrant destroy`. Please use that command instead. This
-  warning will be removed in future versions.
 :dotfile_error: |-
   The dotfile which Vagrant uses to store the UUID of the project's
   virtual machine already exists and is not a file! The dotfile is
@@ -69,8 +111,18 @@
   already be created, but unfortunately this vagrant still appears to
   have no box! You can setup the environment by setting up your
   <%= Vagrant::Environment::ROOTFILE_NAME %> and running `vagrant up`
+:network_not_found: |-
+  The specified host network could not be found: <%= name %>.
+  If the name specification is removed, Vagrant will create a new
+  host only network for you. Alternatively, please create the
+  specified network manually.
 :package_include_file_doesnt_exist: |-
   File specified to include: '<%= filename %>' does not exist!
+:package_multivm: |-
+  Because this Vagrant environment represents multiple VMs, a
+  specific VM must be specified. This can be done by calling
+  `vagrant package NAME` where NAME is a valid VM represented by
+  your Vagrantfile.
 :package_requires_export: |-
   Package must be used in conjunction with export.
 :provisioner_invalid_class: |-
@@ -92,6 +144,11 @@
   permissions on the following file to 0600 and then try running this command again:
 
   <%= key_path %>
+:ssh_bad_exit_status: |-
+  The following SSH command responded with a non-zero exit status.
+  Vagrant assumes that this means the command failed!
+
+  <%= command %>
 :ssh_unavailable_windows: |-
   `vagrant ssh` isn't available on the Windows platform. The
   vagrant.ppk file is available at
@@ -106,7 +163,37 @@
   For a more detailed guide please consult:
 
      http://vagrantup.com/docs/getting-started/windows.html
+:ssh_multivm: |-
+  Because this Vagrant environment represents multiple VMs, a
+  specific VM must be specified. This can be done by calling
+  `vagrant ssh NAME` where NAME is a valid VM represented by
+  your Vagrantfile.
+
+  Alternatively, if you mark one of your VMs as 'primary,'
+  then Vagrant will default to that VM. This can be done by
+  specifying `:primary => true` when defining the VM. Example:
 
+  config.vm.define(:foo, :primary => true) do |config|
+    ...
+  end
+:ssh_config_multivm: |-
+  Because this Vagrant environment represents multiple VMs, a
+  specific VM must be specified. This can be done by calling
+  `vagrant ssh-config NAME` where NAME is a valid VM represented by
+  your Vagrantfile.
+:system_invalid_class: |-
+  The specified system does not inherit from `Vagrant::Systems::Base`. The
+  specified system class must inherit from this class.
+
+  The specified system class was: <%= system %>
+:system_unknown_type: |-
+  The specified system type is unknown: <%= system %>. Please change this
+  to a proper value.
+:system_unspecified: |-
+  A VM system type must be specified! This is done via the `config.vm.system`
+  configuration value. Please read the documentation online for more information.
+:unknown_vm: |-
+  The specified VM could not be found: <%= vm %>
 :virtualbox_import_failure: |-
   The VM import failed! Try running `VBoxManage import` on the box file
   manually for more verbose error output.
@@ -133,6 +220,13 @@
   The vagrant virtual environment you are trying to suspend must be running to be suspended.
 :vm_not_suspended: |-
   The vagrant virtual environment you are trying to resume is not in a suspended state.
+:vm_port_auto_empty: |-
+  Vagrant found a port collision for the specified port and virtual machine.
+  While this port was marked to be auto-corrected, the ports in the
+  auto-correction range are all also used.
+
+  VM: <%= vm_name %>
+  Forwarded port: <%= name %> (<%= options[:guestport] %> => <%= options[:hostport] %>)
 :vm_port_collision: |-
   Vagrant cannot forward the specified ports on this VM, since they
   would collide with another VirtualBox virtual machine's forwarded
@@ -163,3 +257,17 @@
 
   If the box was built for 0.2.x and contains a custom public key, perhaps
   the path to the private key is incorrect. Check your `config.ssh.private_key_path`.
+
+#---------------------------------------------------------------------
+# CATEGORY: Error Messages for Linux System
+#---------------------------------------------------------------------
+:network_not_debian: |-
+  Host only networking is only supported for Debian/Ubuntu by the built-in
+  "Linux" system. If you're using some other distro and want to implement
+  host only networking, please subclass the `Vagrant::Systems::Linux` class
+  and implement the `prepare_host_only_network` and `enable_host_only_network`
+  methods.
+
+  Otherwise, please report your distro and how to modify network interfaces
+  to the Vagrant mailing list or IRC and we'll probably be glad to add it
+  to the internal systems.