nixme-vagrant 0.7.2

data/lib/vagrant/errors.rb

@@ -0,0 +1,332 @@
+# This file contains all of the internal errors in Vagrant's core
+# commands, actions, etc.
+
+module Vagrant
+  # This module contains all of the internal errors in Vagrant's core.
+  # These errors are _expected_ errors and as such don't typically represent
+  # bugs in Vagrant itself. These are meant as a way to detect errors and
+  # display them in a user-friendly way.
+  #
+  # # Defining a new Error
+  #
+  # To define a new error, inherit from {VagrantError}, which lets Vagrant
+  # know that this is an expected error, and also gives you some helpers for
+  # providing exit codes and error messages. An example is shown below, then
+  # it is explained:
+  #
+  #     class MyError < Vagrant::Errors::VagrantError
+  #       error_key "my_error"
+  #     end
+  #
+  # This creates an error with an I18n error key of "my_error." {VagrantError}
+  # uses I18n to look up error messages, in the "vagrant.errors" namespace. So
+  # in the above, the error message would be the translation of "vagrant.errors.my_error"
+  #
+  # If you don't want to use I18n, you can override the {#initialize} method and
+  # set your own error message.
+  #
+  # # Raising an Error
+  #
+  # To raise an error, it is nothing special, just raise it like any normal
+  # exception:
+  #
+  #     raise MyError.new
+  #
+  # Eventually this exception will bubble out to the `vagrant` binary which
+  # will show a nice error message. And if it is raised in the middle of a
+  # middleware sequence, then {Action::Warden} will catch it and begin the
+  # recovery process prior to exiting.
+  module Errors
+    # Main superclass of any errors in Vagrant. This provides some
+    # convenience methods for setting the status code and error key.
+    # The status code is used by the `vagrant` executable as the
+    # error code, and the error key is used as a default message from
+    # I18n.
+    class VagrantError < StandardError
+      @@used_codes = []
+
+      def self.status_code(code = nil)
+        if code
+          raise "Status code already in use: #{code}"  if @@used_codes.include?(code)
+          @@used_codes << code
+        end
+
+        define_method(:status_code) { code }
+      end
+
+      def self.error_key(key=nil, namespace=nil)
+        define_method(:error_key) { key }
+        error_namespace(namespace) if namespace
+      end
+
+      def self.error_namespace(namespace)
+        define_method(:error_namespace) { namespace }
+      end
+
+      def initialize(message=nil, *args)
+        message = { :_key => message } if message && !message.is_a?(Hash)
+        message = { :_key => error_key, :_namespace => error_namespace }.merge(message || {})
+        message = translate_error(message)
+
+        super
+      end
+
+      # The default error namespace which is used for the error key.
+      # This can be overridden here or by calling the "error_namespace"
+      # class method.
+      def error_namespace; "vagrant.errors"; end
+
+      # The key for the error message. This should be set using the
+      # {error_key} method but can be overridden here if needed.
+      def error_key; nil; end
+
+      protected
+
+      def translate_error(opts)
+        return nil if !opts[:_key]
+        I18n.t("#{opts[:_namespace]}.#{opts[:_key]}", opts)
+      end
+    end
+
+    class BaseVMNotFound < VagrantError
+      status_code(18)
+      error_key(:base_vm_not_found)
+    end
+
+    class BoxAlreadyExists < VagrantError
+      status_code(14)
+      error_key(:already_exists, "vagrant.actions.box.unpackage")
+    end
+
+    class BoxDownloadUnknownType < VagrantError
+      status_code(13)
+      error_key(:unknown_type, "vagrant.actions.box.download")
+    end
+
+    class BoxNotFound < VagrantError
+      status_code(2)
+      error_key(:box_not_found)
+    end
+
+    class BoxNotSpecified < VagrantError
+      status_code(22)
+      error_key(:not_specified, "vagrant.actions.vm.check_box")
+    end
+
+    class BoxSpecifiedDoesntExist < VagrantError
+      status_code(23)
+      error_key(:does_not_exist, "vagrant.actions.vm.check_box")
+    end
+
+    class BoxVerificationFailed < VagrantError
+      status_code(15)
+      error_key(:failed, "vagrant.actions.box.verify")
+    end
+
+    class CLIMissingEnvironment < VagrantError
+      status_code(1)
+      error_key(:cli_missing_env)
+    end
+
+    class ConfigValidationFailed < VagrantError
+      status_code(42)
+      error_key(:config_validation)
+    end
+
+    class DotfileIsDirectory < VagrantError
+      status_code(46)
+      error_key(:dotfile_is_directory)
+    end
+
+    class DownloaderFileDoesntExist < VagrantError
+      status_code(37)
+      error_key(:file_missing, "vagrant.downloaders.file")
+    end
+
+    class DownloaderHTTPSocketError < VagrantError
+      status_code(38)
+      error_key(:socket_error, "vagrant.downloaders.http")
+    end
+
+    class ForwardPortAutolistEmpty < VagrantError
+      status_code(27)
+      error_key(:auto_empty, "vagrant.actions.vm.forward_ports")
+    end
+
+    class ForwardPortBelowThreshold < VagrantError
+      status_code(25)
+      error_key(:below_threshold_error, "vagrant.actions.vm.forward_ports")
+    end
+
+    class ForwardPortCollision < VagrantError
+      status_code(26)
+      error_key(:collision_error, "vagrant.actions.vm.forward_ports")
+    end
+
+    class MultiVMEnvironmentRequired < VagrantError
+      status_code(5)
+      error_key(:multi_vm_required)
+    end
+
+    class MultiVMTargetRequired < VagrantError
+      status_code(7)
+      error_key(:multi_vm_target_required)
+    end
+
+    class NetworkCollision < VagrantError
+      status_code(29)
+      error_key(:collides, "vagrant.actions.vm.network")
+    end
+
+    class NetworkNotFound < VagrantError
+      status_code(30)
+      error_key(:not_found, "vagrant.actions.vm.network")
+    end
+
+    # Note: This is a temporary error for Windows users while host-only
+    # networking doesn't quite work.
+    class NetworkNotImplemented < VagrantError
+      status_code(49)
+      error_key(:windows_not_implemented, "vagrant.actions.vm.network")
+    end
+
+    class NFSHostRequired < VagrantError
+      status_code(31)
+      error_key(:host_required, "vagrant.actions.vm.nfs")
+    end
+
+    class NFSNotSupported < VagrantError
+      status_code(32)
+      error_key(:not_supported, "vagrant.actions.vm.nfs")
+    end
+
+    class NFSNoHostNetwork < VagrantError
+      status_code(33)
+      error_key(:no_host_network, "vagrant.actions.vm.nfs")
+    end
+
+    class NoEnvironmentError < VagrantError
+      status_code(3)
+      error_key(:no_env)
+    end
+
+    class PackageIncludeMissing < VagrantError
+      status_code(20)
+      error_key(:include_file_missing, "vagrant.actions.general.package")
+    end
+
+    class PackageOutputExists < VagrantError
+      status_code(16)
+      error_key(:output_exists, "vagrant.actions.general.package")
+    end
+
+    class PackageRequiresDirectory < VagrantError
+      status_code(19)
+      error_key(:requires_directory, "vagrant.actions.general.package")
+    end
+
+    class PersistDotfileExists < VagrantError
+      status_code(34)
+      error_key(:dotfile_error, "vagrant.actions.vm.persist")
+    end
+
+    class SSHAuthenticationFailed < VagrantError
+      status_code(11)
+      error_key(:ssh_authentication_failed)
+    end
+
+    class SSHConnectionRefused < VagrantError
+      status_code(43)
+      error_key(:ssh_connection_refused)
+    end
+
+    class SSHKeyBadPermissions < VagrantError
+      status_code(12)
+      error_key(:ssh_key_bad_permissions)
+    end
+
+    class SSHPortNotDetected < VagrantError
+      status_code(50)
+      error_key(:ssh_port_not_detected)
+    end
+
+    class SSHUnavailable < VagrantError
+      status_code(45)
+      error_key(:ssh_unavailable)
+    end
+
+    class SSHUnavailableWindows < VagrantError
+      status_code(10)
+      error_key(:ssh_unavailable_windows)
+    end
+
+    class VagrantInterrupt < VagrantError
+      status_code(40)
+      error_key(:interrupted)
+    end
+
+    class VagrantfileSyntaxError < VagrantError
+      status_code(41)
+      error_key(:vagrantfile_syntax_error)
+    end
+
+    class VirtualBoxInvalidVersion < VagrantError
+      status_code(17)
+      error_key(:virtualbox_invalid_version)
+    end
+
+    class VirtualBoxNotDetected < VagrantError
+      status_code(8)
+      error_key(:virtualbox_not_detected)
+    end
+
+    # Note that this is a subclass of VirtualBoxNotDetected, so developers
+    # who script Vagrant or use it as a library in any way can rescue from
+    # "VirtualBoxNotDetected" and catch both errors, which represent the
+    # same thing. This subclass simply has a specialized error message.
+    class VirtualBoxNotDetected_Win64 < VirtualBoxNotDetected
+      status_code(48)
+      error_key(:virtualbox_not_detected_win64)
+    end
+
+    class VMBaseMacNotSpecified < VagrantError
+      status_code(47)
+      error_key(:no_base_mac, "vagrant.actions.vm.match_mac")
+    end
+
+    class VMFailedToBoot < VagrantError
+      status_code(21)
+      error_key(:failed_to_boot, "vagrant.actions.vm.boot")
+    end
+
+    class VMImportFailure < VagrantError
+      status_code(28)
+      error_key(:failure, "vagrant.actions.vm.import")
+    end
+
+    class VMNotCreatedError < VagrantError
+      status_code(6)
+      error_key(:vm_creation_required)
+    end
+
+    class VMNotFoundError < VagrantError
+      status_code(4)
+      error_key(:vm_not_found)
+    end
+
+    class VMNotRunningError < VagrantError
+      status_code(44)
+      error_key(:vm_not_running)
+    end
+
+    class VMPowerOffToPackage < VagrantError
+      status_code(24)
+      error_key(:power_off, "vagrant.actions.vm.export")
+    end
+
+    class VMSystemError < VagrantError
+      status_code(39)
+      error_namespace("vagrant.errors.system")
+    end
+  end
+end

data/lib/vagrant/hosts.rb

@@ -0,0 +1,7 @@
+module Vagrant
+  module Hosts
+    autoload :Base,  'vagrant/hosts/base'
+    autoload :BSD,   'vagrant/hosts/bsd'
+    autoload :Linux, 'vagrant/hosts/linux'
+  end
+end

data/lib/vagrant/hosts/base.rb

@@ -0,0 +1,77 @@
+module Vagrant
+  module Hosts
+    # Base class representing a host machine. These classes
+    # define methods which may have host-specific (Mac OS X, Windows,
+    # Linux, etc) behavior. The class is automatically determined by
+    # default but may be explicitly set via `config.vagrant.host`.
+    class Base
+      # The {Environment} which this host belongs to.
+      attr_reader :env
+
+      class << self
+        # Loads the proper host for the given value. If the value is nil
+        # or is the symbol `:detect`, then the host class will be detected
+        # using the `RUBY_PLATFORM` constant.
+        #
+        # @param [Environment] env
+        # @param [String] klass
+        # @return [Base]
+        def load(env, klass)
+          klass = detect if klass.nil? || klass == :detect
+          return nil if !klass
+          return klass.new(env)
+        end
+
+        # Detects the proper host class for current platform and returns
+        # the class.
+        #
+        # @return [Class]
+        def detect
+          # More coming soon
+          classes = {
+            :darwin => BSD,
+            :bsd => BSD,
+            :linux => Linux
+          }
+
+          classes.each do |type, klass|
+            return klass if Util::Platform.send("#{type}?")
+          end
+
+          nil
+        rescue Exception
+          nil
+        end
+      end
+
+      # Initialzes a new host. This method shouldn't be called directly,
+      # typically, since it will be called by {Environment#load!}.
+      #
+      # @param [Environment] env
+      def initialize(env)
+        @env = env
+      end
+
+      # Returns true of false denoting whether or not this host supports
+      # NFS shared folder setup. This method ideally should verify that
+      # NFS is installed.
+      #
+      # @return [Boolean]
+      def nfs?
+        false
+      end
+
+      # Exports the given hash of folders via NFS. This method will raise
+      # an {Vagrant::Action::ActionException} if anything goes wrong.
+      #
+      # @param [String] ip IP of the guest machine.
+      # @param [Hash] folders Shared folders to sync.
+      def nfs_export(ip, folders)
+      end
+
+      # Cleans up the exports for the current VM.
+      def nfs_cleanup
+      end
+    end
+  end
+end

data/lib/vagrant/hosts/bsd.rb

@@ -0,0 +1,52 @@
+module Vagrant
+  module Hosts
+    # Represents a BSD host, such as FreeBSD and Darwin (Mac OS X).
+    class BSD < Base
+      include Util
+      include Util::Retryable
+
+      def nfs?
+        retryable(:tries => 10, :on => TypeError) do
+          system("which nfsd > /dev/null 2>&1")
+        end
+      end
+
+      def nfs_export(ip, folders)
+        output = TemplateRenderer.render('nfs/exports',
+                                         :uuid => env.vm.uuid,
+                                         :ip => ip,
+                                         :folders => folders)
+
+        # The sleep ensures that the output is truly flushed before any `sudo`
+        # commands are issued.
+        env.ui.info I18n.t("vagrant.hosts.bsd.nfs_export.prepare")
+        sleep 0.5
+
+        output.split("\n").each do |line|
+          # This should only ask for administrative permission once, even
+          # though its executed in multiple subshells.
+          line = line.gsub('"', '\"')
+          system(%Q[sudo su root -c "echo '#{line}' >> /etc/exports"])
+        end
+
+        # We run restart here instead of "update" just in case nfsd
+        # is not starting
+        system("sudo nfsd restart")
+      end
+
+      def nfs_cleanup
+        return if !File.exist?("/etc/exports")
+
+        retryable(:tries => 10, :on => TypeError) do
+          system("cat /etc/exports | grep 'VAGRANT-BEGIN: #{env.vm.uuid}' > /dev/null 2>&1")
+
+          if $?.to_i == 0
+            # Use sed to just strip out the block of code which was inserted
+            # by Vagrant
+            system("sudo sed -e '/^# VAGRANT-BEGIN: #{env.vm.uuid}/,/^# VAGRANT-END: #{env.vm.uuid}/ d' -ibak /etc/exports")
+          end
+        end
+      end
+    end
+  end
+end