tnargav 1.2.2

data/lib/vagrant/guest.rb

@@ -0,0 +1,163 @@
+require "log4r"
+
+module Vagrant
+  # This class handles guest-OS specific interactions with a machine.
+  # It is primarily responsible for detecting the proper guest OS
+  # implementation and then delegating capabilities.
+  #
+  # Vagrant has many tasks which require specific guest OS knowledge.
+  # These are implemented using a guest/capability system. Various plugins
+  # register as "guests" which determine the underlying OS of the system.
+  # Then, "guest capabilities" register themselves for a specific OS (one
+  # or more), and these capabilities are called.
+  #
+  # Example capabilities might be "mount_virtualbox_shared_folder" or
+  # "configure_networks".
+  #
+  # This system allows for maximum flexibility and pluginability for doing
+  # guest OS specific operations.
+  class Guest
+    attr_reader :chain
+
+    # The name of the guest OS. This is available after {#detect!} is
+    # called.
+    #
+    # @return [Symbol]
+    attr_reader :name
+
+    def initialize(machine, guests, capabilities)
+      @logger       = Log4r::Logger.new("vagrant::guest")
+      @capabilities = capabilities
+      @chain        = []
+      @guests       = guests
+      @machine      = machine
+      @name         = nil
+    end
+
+    # This will detect the proper guest OS for the machine and set up
+    # the class to actually execute capabilities.
+    def detect!
+      @logger.info("Detect guest for machine: #{@machine}")
+
+      # Get the mapping of guests with the most parents. We start searching
+      # with the guests with the most parents first.
+      parent_count = {}
+      @guests.each do |name, parts|
+        parent_count[name] = 0
+
+        parent = parts[1]
+        while parent
+          parent_count[name] += 1
+          parent = @guests[parent]
+          parent = parent[1] if parent
+        end
+      end
+
+      # Now swap around the mapping so that it is a mapping of
+      # count to the actual list of guest names
+      parent_count_to_guests = {}
+      parent_count.each do |name, count|
+        parent_count_to_guests[count] ||= []
+        parent_count_to_guests[count] << name
+      end
+
+      catch(:guest_os) do
+        sorted_counts = parent_count_to_guests.keys.sort.reverse
+        sorted_counts.each do |count|
+          parent_count_to_guests[count].each do |name|
+            @logger.debug("Trying: #{name}")
+            guest_info = @guests[name]
+            guest      = guest_info[0].new
+
+            if guest.detect?(@machine)
+              @logger.info("Detected: #{name}!")
+              @chain << [name, guest]
+              @name = name
+
+              # Build the proper chain of parents if there are any.
+              # This allows us to do "inheritence" of capabilities later
+              if guest_info[1]
+                parent_name = guest_info[1]
+                parent_info = @guests[parent_name]
+                while parent_info
+                  @chain << [parent_name, parent_info[0].new]
+                  parent_name = parent_info[1]
+                  parent_info = @guests[parent_name]
+                end
+              end
+
+              @logger.info("Full guest chain: #{@chain.inspect}")
+
+              # Exit the search
+              throw :guest_os
+            end
+          end
+        end
+      end
+
+      # We shouldn't reach this point. Ideally we would detect
+      # all operating systems.
+      raise Errors::GuestNotDetected if @chain.empty?
+    end
+
+    # Tests whether the guest has the named capability.
+    #
+    # @return [Boolean]
+    def capability?(cap_name)
+      !capability_module(cap_name).nil?
+    end
+
+    # Executes the capability with the given name, optionally passing
+    # more arguments onwards to the capability.
+    def capability(cap_name, *args)
+      @logger.info("Execute capability: #{cap_name} (#{@chain[0][0]})")
+      cap_mod = capability_module(cap_name.to_sym)
+      if !cap_mod
+        raise Errors::GuestCapabilityNotFound,
+          :cap => cap_name.to_s,
+          :guest => @chain[0][0].to_s
+      end
+
+      cap_method = nil
+      begin
+        cap_method = cap_mod.method(cap_name)
+      rescue NameError
+        raise Errors::GuestCapabilityInvalid,
+          :cap => cap_name.to_s,
+          :guest => @chain[0][0].to_s
+      end
+
+      cap_method.call(@machine, *args)
+    end
+
+    # This returns whether the guest is ready to work. If this returns
+    # `false`, then {#detect!} should be called in order to detect the
+    # guest OS.
+    #
+    # @return [Boolean]
+    def ready?
+      !@chain.empty?
+    end
+
+    protected
+
+    # Returns the registered module for a capability with the given name.
+    #
+    # @param [Symbol] cap_name
+    # @return [Module]
+    def capability_module(cap_name)
+      @logger.debug("Searching for cap: #{cap_name}")
+      @chain.each do |guest_name, guest|
+        @logger.debug("Checking in: #{guest_name}")
+        caps = @capabilities[guest_name]
+
+        if caps && caps.has_key?(cap_name)
+          @logger.debug("Found cap: #{cap_name} in #{guest_name}")
+          return caps[cap_name]
+        end
+      end
+
+      nil
+    end
+  end
+end

data/lib/vagrant/hosts.rb

@@ -0,0 +1,28 @@
+require 'log4r'
+
+module Vagrant
+  module Hosts
+    # This method detects the correct host based on the `match?` methods
+    # implemented in the registered hosts.
+    #
+    # @param [Hash] registry Hash mapping key to host class
+    def self.detect(registry)
+      logger = Log4r::Logger.new("vagrant::hosts")
+
+      # Sort the hosts by their precedence
+      host_klasses = registry.values.sort_by { |a| a.precedence }.reverse
+      logger.debug("Host path search classes: #{host_klasses.inspect}")
+
+      # Test for matches and return the host class that matches
+      host_klasses.each do |klass|
+        if klass.match?
+          logger.info("Host class: #{klass}")
+          return klass
+        end
+      end
+
+      # No matches found...
+      return nil
+    end
+  end
+end

data/lib/vagrant/machine.rb

@@ -0,0 +1,325 @@
+require "log4r"
+
+module Vagrant
+  # This represents a machine that Vagrant manages. This provides a singular
+  # API for querying the state and making state changes to the machine, which
+  # is backed by any sort of provider (VirtualBox, VMWare, etc.).
+  class Machine
+    # The box that is backing this machine.
+    #
+    # @return [Box]
+    attr_reader :box
+
+    # Configuration for the machine.
+    #
+    # @return [Object]
+    attr_reader :config
+
+    # Directory where machine-specific data can be stored.
+    #
+    # @return [Pathname]
+    attr_reader :data_dir
+
+    # The environment that this machine is a part of.
+    #
+    # @return [Environment]
+    attr_reader :env
+
+    # ID of the machine. This ID comes from the provider and is not
+    # guaranteed to be of any particular format except that it is
+    # a string.
+    #
+    # @return [String]
+    attr_reader :id
+
+    # Name of the machine. This is assigned by the Vagrantfile.
+    #
+    # @return [String]
+    attr_reader :name
+
+    # The provider backing this machine.
+    #
+    # @return [Object]
+    attr_reader :provider
+
+    # The provider-specific configuration for this machine.
+    #
+    # @return [Object]
+    attr_reader :provider_config
+
+    # The name of the provider.
+    #
+    # @return [Symbol]
+    attr_reader :provider_name
+
+    # The options given to the provider when registering the plugin.
+    #
+    # @return [Hash]
+    attr_reader :provider_options
+
+    # The UI for outputting in the scope of this machine.
+    #
+    # @return [UI]
+    attr_reader :ui
+
+    # Initialize a new machine.
+    #
+    # @param [String] name Name of the virtual machine.
+    # @param [Class] provider The provider backing this machine. This is
+    #   currently expected to be a V1 `provider` plugin.
+    # @param [Object] provider_config The provider-specific configuration for
+    #   this machine.
+    # @param [Hash] provider_options The provider-specific options from the
+    #   plugin definition.
+    # @param [Object] config The configuration for this machine.
+    # @param [Pathname] data_dir The directory where machine-specific data
+    #   can be stored. This directory is ensured to exist.
+    # @param [Box] box The box that is backing this virtual machine.
+    # @param [Environment] env The environment that this machine is a
+    #   part of.
+    def initialize(name, provider_name, provider_cls, provider_config, provider_options, config, data_dir, box, env, base=false)
+      @logger = Log4r::Logger.new("vagrant::machine")
+      @logger.info("Initializing machine: #{name}")
+      @logger.info("  - Provider: #{provider_cls}")
+      @logger.info("  - Box: #{box}")
+      @logger.info("  - Data dir: #{data_dir}")
+
+      @box             = box
+      @config          = config
+      @data_dir        = data_dir
+      @env             = env
+      @guest           = Guest.new(
+        self,
+        Vagrant.plugin("2").manager.guests,
+        Vagrant.plugin("2").manager.guest_capabilities)
+      @name            = name
+      @provider_config = provider_config
+      @provider_name   = provider_name
+      @provider_options = provider_options
+      @ui              = @env.ui.scope(@name)
+
+      # Read the ID, which is usually in local storage
+      @id = nil
+
+      # XXX: This is temporary. This will be removed very soon.
+      if base
+        @id = name
+      else
+        # Read the id file from the data directory if it exists as the
+        # ID for the pre-existing physical representation of this machine.
+        id_file = @data_dir.join("id")
+        @id = id_file.read if id_file.file?
+      end
+
+      # Initializes the provider last so that it has access to all the
+      # state we setup on this machine.
+      @provider = provider_cls.new(self)
+    end
+
+    # This calls an action on the provider. The provider may or may not
+    # actually implement the action.
+    #
+    # @param [Symbol] name Name of the action to run.
+    # @param [Hash] extra_env This data will be passed into the action runner
+    #   as extra data set on the environment hash for the middleware
+    #   runner.
+    def action(name, extra_env=nil)
+      @logger.info("Calling action: #{name} on provider #{@provider}")
+
+      # Get the callable from the provider.
+      callable = @provider.action(name)
+
+      # If this action doesn't exist on the provider, then an exception
+      # must be raised.
+      if callable.nil?
+        raise Errors::UnimplementedProviderAction,
+          :action => name,
+          :provider => @provider.to_s
+      end
+
+      # Run the action with the action runner on the environment
+      env = {
+        :action_name    => "machine_action_#{name}".to_sym,
+        :machine        => self,
+        :machine_action => name,
+        :ui             => @ui
+      }.merge(extra_env || {})
+      @env.action_runner.run(callable, env)
+    end
+
+    # Returns a communication object for executing commands on the remote
+    # machine. Note that the _exact_ semantics of this are up to the
+    # communication provider itself. Despite this, the semantics are expected
+    # to be consistent across operating systems. For example, all linux-based
+    # systems should have similar communication (usually a shell). All
+    # Windows systems should have similar communication as well. Therefore,
+    # prior to communicating with the machine, users of this method are
+    # expected to check the guest OS to determine their behavior.
+    #
+    # This method will _always_ return some valid communication object.
+    # The `ready?` API can be used on the object to check if communication
+    # is actually ready.
+    #
+    # @return [Object]
+    def communicate
+      if !@communicator
+        # For now, we always return SSH. In the future, we'll abstract
+        # this and allow plugins to define new methods of communication.
+        klass = Vagrant.plugin("2").manager.communicators[:ssh]
+        @communicator = klass.new(self)
+      end
+
+      @communicator
+    end
+
+    # Returns a guest implementation for this machine. The guest implementation
+    # knows how to do guest-OS specific tasks, such as configuring networks,
+    # mounting folders, etc.
+    #
+    # @return [Guest]
+    def guest
+      raise Errors::MachineGuestNotReady if !communicate.ready?
+      @guest.detect! if !@guest.ready?
+      @guest
+    end
+
+    # This sets the unique ID associated with this machine. This will
+    # persist this ID so that in the future Vagrant will be able to find
+    # this machine again. The unique ID must be absolutely unique to the
+    # virtual machine, and can be used by providers for finding the
+    # actual machine associated with this instance.
+    #
+    # **WARNING:** Only providers should ever use this method.
+    #
+    # @param [String] value The ID.
+    def id=(value)
+      # The file that will store the id if we have one. This allows the
+      # ID to persist across Vagrant runs.
+      id_file = @data_dir.join("id")
+
+      if value
+        # Write the "id" file with the id given.
+        id_file.open("w+") do |f|
+          f.write(value)
+        end
+      else
+        # Delete the file, since the machine is now destroyed
+        id_file.delete if id_file.file?
+      end
+
+      # Store the ID locally
+      @id = value
+
+      # Notify the provider that the ID changed in case it needs to do
+      # any accounting from it.
+      @provider.machine_id_changed
+    end
+
+    # This returns a clean inspect value so that printing the value via
+    # a pretty print (`p`) results in a readable value.
+    #
+    # @return [String]
+    def inspect
+      "#<#{self.class}: #{@name} (#{@provider.class})>"
+    end
+
+    # This returns the SSH info for accessing this machine. This SSH info
+    # is queried from the underlying provider. This method returns `nil` if
+    # the machine is not ready for SSH communication.
+    #
+    # The structure of the resulting hash is guaranteed to contain the
+    # following structure, although it may return other keys as well
+    # not documented here:
+    #
+    #     {
+    #       :host => "1.2.3.4",
+    #       :port => "22",
+    #       :username => "mitchellh",
+    #       :private_key_path => "/path/to/my/key"
+    #     }
+    #
+    # Note that Vagrant makes no guarantee that this info works or is
+    # correct. This is simply the data that the provider gives us or that
+    # is configured via a Vagrantfile. It is still possible after this
+    # point when attempting to connect via SSH to get authentication
+    # errors.
+    #
+    # @return [Hash] SSH information.
+    def ssh_info
+      # First, ask the provider for their information. If the provider
+      # returns nil, then the machine is simply not ready for SSH, and
+      # we return nil as well.
+      info = @provider.ssh_info
+      return nil if info.nil?
+
+      # Delete out the nil entries.
+      info.dup.each do |key, value|
+        info.delete(key) if value.nil?
+      end
+
+      # We set the defaults
+      info[:host] ||= @config.ssh.default.host
+      info[:port] ||= @config.ssh.default.port
+      info[:private_key_path] ||= @config.ssh.default.private_key_path
+      info[:username] ||= @config.ssh.default.username
+
+      # We set overrides if they are set. These take precedence over
+      # provider-returned data.
+      info[:host] = @config.ssh.host if @config.ssh.host
+      info[:port] = @config.ssh.port if @config.ssh.port
+      info[:username] = @config.ssh.username if @config.ssh.username
+
+      # We also set some fields that are purely controlled by Varant
+      info[:forward_agent] = @config.ssh.forward_agent
+      info[:forward_x11]   = @config.ssh.forward_x11
+
+      # Set the private key path. If a specific private key is given in
+      # the Vagrantfile we set that. Otherwise, we use the default (insecure)
+      # private key, but only if the provider didn't give us one.
+      if !info[:private_key_path]
+        if @config.ssh.private_key_path
+          info[:private_key_path] = @config.ssh.private_key_path
+        else
+          info[:private_key_path] = @env.default_private_key_path
+        end
+      end
+
+      # Expand the private key path relative to the root path
+      info[:private_key_path] = File.expand_path(info[:private_key_path], @env.root_path)
+
+      # Return the final compiled SSH info data
+      info
+    end
+
+    # Returns the state of this machine. The state is queried from the
+    # backing provider, so it can be any arbitrary symbol.
+    #
+    # @return [Symbol]
+    def state
+      result = @provider.state
+      raise Errors::MachineStateInvalid if !result.is_a?(MachineState)
+      result
+    end
+
+    protected
+
+    # Given a guest name (such as `:windows`), this will load the associated
+    # guest implementation and return an instance.
+    #
+    # @param [Symbol] guest The name of the guest implementation.
+    # @return [Object]
+    def load_guest(guest)
+      @logger.info("Loading guest: #{guest}")
+
+      klass = Vagrant.plugin("2").manager.guests[guest]
+
+      if klass.nil?
+        raise Errors::VMGuestError,
+          :_key  => :unknown_type,
+          :guest => guest.to_s
+      end
+
+      return klass.new(self)
+    end
+  end
+end

data/lib/vagrant/machine_state.rb

@@ -0,0 +1,45 @@
+module Vagrant
+  # This represents the state of a given machine. This is a very basic
+  # class that simply stores a short and long description of the state
+  # of a machine.
+  #
+  # The state also stores a state "id" which ca be used as a unique
+  # identifier for a state. This should be a symbol. This allows internal
+  # code to compare state such as ":not_created" instead of using
+  # string comparison.
+  #
+  # The short description should be a single word description of the
+  # state of the machine such as "running" or "not created".
+  #
+  # The long description can span multiple lines describing what the
+  # state actually means.
+  class MachineState
+    # Unique ID for this state.
+    #
+    # @return [Symbol]
+    attr_reader :id
+
+    # Short description for this state.
+    #
+    # @return [String]
+    attr_reader :short_description
+
+    # Long description for this state.
+    #
+    # @return [String]
+    attr_reader :long_description
+
+    # Creates a new instance to represent the state of a machine.
+    #
+    # @param [Symbol] id Unique identifier for this state.
+    # @param [String] short Short (preferably one-word) description of
+    #   the state.
+    # @param [String] long Long description (can span multiple lines)
+    #   of the state.
+    def initialize(id, short, long)
+      @id                = id
+      @short_description = short
+      @long_description  = long
+    end
+  end
+end