class Vagrant::Environment

A “Vagrant environment” represents a configuration of how Vagrant should behave: data directories, working directory, UI output, etc. In day-to-day usage, every `vagrant` invocation typically leads to a single Vagrant environment.

Constants

CURRENT_SETUP_VERSION

This is the current version that this version of Vagrant is compatible with in the home directory.

@return [String]

DEFAULT_LOCAL_DATA

Attributes

boxes_path[R]

The directory where boxes are stored.

cwd[R]

The `cwd` that this environment represents

data_dir[R]

The persistent data directory where global data can be stored. It is up to the creator of the data in this directory to properly remove it when it is no longer needed.

@return [Pathname]

default_private_key_path[R]

The path to the default private key

gems_path[R]

The path where the plugins are stored (gems)

home_path[R]

The directory to the “home” folder that Vagrant will use to store global state.

local_data_path[R]

The directory to the directory where local, environment-specific data is stored.

tmp_path[R]

The directory where temporary files for Vagrant go.

ui[R]

The {UI} object to communicate with the outside world.

ui_class[R]

This is the UI class to use when creating new UIs.

vagrantfile_name[R]

The valid name for a Vagrantfile for this environment.

Public Class Methods

new(opts=nil) click to toggle source

Initializes a new environment with the given options. The options is a hash where the main available key is `cwd`, which defines where the environment represents. There are other options available but they shouldn't be used in general. If `cwd` is nil, then it defaults to the `Dir.pwd` (which is the cwd of the executing process).

# File lib/vagrant/environment.rb, line 71
def initialize(opts=nil)
  opts = {
    :cwd              => nil,
    :home_path        => nil,
    :local_data_path  => nil,
    :lock_path        => nil,
    :ui_class         => nil,
    :vagrantfile_name => nil,
  }.merge(opts || {})

  # Set the default working directory to look for the vagrantfile
  opts[:cwd] ||= ENV["VAGRANT_CWD"] if ENV.has_key?("VAGRANT_CWD")
  opts[:cwd] ||= Dir.pwd
  opts[:cwd] = Pathname.new(opts[:cwd])
  if !opts[:cwd].directory?
    raise Errors::EnvironmentNonExistentCWD, cwd: opts[:cwd].to_s
  end

  # Set the default ui class
  opts[:ui_class] ||= UI::Silent

  # Set the Vagrantfile name up. We append "Vagrantfile" and "vagrantfile" so that
  # those continue to work as well, but anything custom will take precedence.
  opts[:vagrantfile_name] ||= ENV["VAGRANT_VAGRANTFILE"] if          ENV.has_key?("VAGRANT_VAGRANTFILE")
  opts[:vagrantfile_name] = [opts[:vagrantfile_name]] if          opts[:vagrantfile_name] && !opts[:vagrantfile_name].is_a?(Array)

  # Set instance variables for all the configuration parameters.
  @cwd              = opts[:cwd]
  @home_path        = opts[:home_path]
  @lock_path        = opts[:lock_path]
  @vagrantfile_name = opts[:vagrantfile_name]
  @ui               = opts[:ui_class].new
  @ui_class         = opts[:ui_class]

  # This is the batch lock, that enforces that only one {BatchAction}
  # runs at a time from {#batch}.
  @batch_lock = Mutex.new

  @lock_acquired = false

  @logger = Log4r::Logger.new("vagrant::environment")
  @logger.info("Environment initialized (#{self})")
  @logger.info("  - cwd: #{cwd}")

  # Setup the home directory
  @home_path  ||= Vagrant.user_data_path
  @home_path  = Util::Platform.fs_real_path(@home_path)
  @boxes_path = @home_path.join("boxes")
  @data_dir   = @home_path.join("data")
  @gems_path  = @home_path.join("gems")
  @tmp_path   = @home_path.join("tmp")

  # Prepare the directories
  setup_home_path

  # Setup the local data directory. If a configuration path is given,
  # then it is expanded relative to the working directory. Otherwise,
  # we use the default which is expanded relative to the root path.
  opts[:local_data_path] ||= ENV["VAGRANT_DOTFILE_PATH"]
  opts[:local_data_path] ||= root_path.join(DEFAULT_LOCAL_DATA) if !root_path.nil?
  if opts[:local_data_path]
    @local_data_path = Pathname.new(File.expand_path(opts[:local_data_path], @cwd))
  end

  setup_local_data_path

  # Setup the default private key
  @default_private_key_path = @home_path.join("insecure_private_key")
  copy_insecure_private_key

  # Call the hooks that does not require configurations to be loaded
  # by using a "clean" action runner
  hook(:environment_plugins_loaded, runner: Action::Runner.new(env: self))

  # Call the environment load hooks
  hook(:environment_load)
end

Public Instance Methods

action_runner() click to toggle source

Action runner for executing actions in the context of this environment.

@return [Action::Runner]

# File lib/vagrant/environment.rb, line 162
def action_runner
  @action_runner ||= Action::Runner.new do
    {
      :action_runner  => action_runner,
      :box_collection => boxes,
      :hook           => method(:hook),
      :host           => host,
      :gems_path      => gems_path,
      :home_path      => home_path,
      :root_path      => root_path,
      :tmp_path       => tmp_path,
      :ui             => @ui
    }
  end
end
active_machines() click to toggle source

Returns a list of machines that this environment is currently managing that physically have been created.

An “active” machine is a machine that Vagrant manages that has been created. The machine itself may be in any state such as running, suspended, etc. but if a machine is “active” then it exists.

Note that the machines in this array may no longer be present in the Vagrantfile of this environment. In this case the machine can be considered an “orphan.” Determining which machines are orphan and which aren't is not currently a supported feature, but will be in a future version.

@return [Array<String, Symbol>]

# File lib/vagrant/environment.rb, line 192
def active_machines
  machine_folder = @local_data_path.join("machines")

  # If the machine folder is not a directory then we just return
  # an empty array since no active machines exist.
  return [] if !machine_folder.directory?

  # Traverse the machines folder accumulate a result
  result = []

  machine_folder.children(true).each do |name_folder|
    # If this isn't a directory then it isn't a machine
    next if !name_folder.directory?

    name = name_folder.basename.to_s.to_sym
    name_folder.children(true).each do |provider_folder|
      # If this isn't a directory then it isn't a provider
      next if !provider_folder.directory?

      # If this machine doesn't have an ID, then ignore
      next if !provider_folder.join("id").file?

      provider = provider_folder.basename.to_s.to_sym
      result << [name, provider]
    end
  end

  # Return the results
  result
end
batch(parallel=true) { |b| ... } click to toggle source

This creates a new batch action, yielding it, and then running it once the block is called.

This handles the case where batch actions are disabled by the VAGRANT_NO_PARALLEL environmental variable.

# File lib/vagrant/environment.rb, line 228
def batch(parallel=true)
  parallel = false if ENV["VAGRANT_NO_PARALLEL"]

  @batch_lock.synchronize do
    BatchAction.new(parallel).tap do |b|
      # Yield it so that the caller can setup actions
      yield b

      # And run it!
      b.run
    end
  end
end
boxes() click to toggle source

Returns the collection of boxes for the environment.

@return [BoxCollection]

# File lib/vagrant/environment.rb, line 264
def boxes
  @_boxes ||= BoxCollection.new(
    boxes_path,
    hook: method(:hook),
    temp_dir_root: tmp_path)
end
cli(*args) click to toggle source

Makes a call to the CLI with the given arguments as if they came from the real command line (sometimes they do!). An example:

env.cli("package", "--vagrantfile", "Vagrantfile")
# File lib/vagrant/environment.rb, line 247
def cli(*args)
  CLI.new(args.flatten, self).execute
end
config_loader() click to toggle source

Returns the {Config::Loader} that can be used to load Vagrantflies given the settings of this environment.

@return [Config::Loader]

# File lib/vagrant/environment.rb, line 275
def config_loader
  return @config_loader if @config_loader

  home_vagrantfile = nil
  root_vagrantfile = nil
  home_vagrantfile = find_vagrantfile(home_path) if home_path
  if root_path
    root_vagrantfile = find_vagrantfile(root_path, @vagrantfile_name)
  end

  @config_loader = Config::Loader.new(
    Config::VERSIONS, Config::VERSIONS_ORDER)
  @config_loader.set(:home, home_vagrantfile) if home_vagrantfile
  @config_loader.set(:root, root_vagrantfile) if root_vagrantfile
  @config_loader
end
default_provider() click to toggle source

This returns the provider name for the default provider for this environment. The provider returned is currently hardcoded to “virtualbox” but one day should be a detected valid, best-case provider for this environment.

@return [Symbol] Name of the default provider.

# File lib/vagrant/environment.rb, line 257
def default_provider
  (ENV['VAGRANT_DEFAULT_PROVIDER'] || :virtualbox).to_sym
end
detect?(env) click to toggle source
# File lib/vagrant/environment.rb, line 331
def detect?(env); true; end
hook(name, opts=nil) click to toggle source

This defines a hook point where plugin action hooks that are registered against the given name will be run in the context of this environment.

@param [Symbol] name Name of the hook. @param [Action::Runner] #action_runner A custom action runner for running hooks.

# File lib/vagrant/environment.rb, line 297
def hook(name, opts=nil)
  @logger.info("Running hook: #{name}")
  opts ||= {}
  opts[:callable] ||= Action::Builder.new
  opts[:runner] ||= action_runner
  opts[:action_name] = name
  opts[:env] = self
  opts.delete(:runner).run(opts.delete(:callable), opts)
end
host() click to toggle source

Returns the host object associated with this environment.

@return [Class]

# File lib/vagrant/environment.rb, line 310
def host
  return @host if defined?(@host)

  # Determine the host class to use. ":detect" is an old Vagrant config
  # that shouldn't be valid anymore, but we respect it here by assuming
  # its old behavior. No need to deprecate this because I thin it is
  # fairly harmless.
  host_klass = vagrantfile.config.vagrant.host
  host_klass = nil if host_klass == :detect

  begin
    @host = Host.new(
      host_klass,
      Vagrant.plugin("2").manager.hosts,
      Vagrant.plugin("2").manager.host_capabilities,
      self)
  rescue Errors::CapabilityHostNotDetected
    # If the auto-detect failed, then we create a brand new host
    # with no capabilities and use that. This should almost never happen
    # since Vagrant works on most host OS's now, so this is a "slow path"
    klass = Class.new(Vagrant.plugin("2", :host)) do
      def detect?(env); true; end
    end

    hosts     = { generic: [klass, nil] }
    host_caps = {}

    @host = Host.new(:generic, hosts, host_caps, self)
  rescue Errors::CapabilityHostExplicitNotDetected => e
    raise Errors::HostExplicitNotDetected, e.extra_data
  end
end
inspect() click to toggle source

Return a human-friendly string for pretty printed or inspected instances.

@return [String]

# File lib/vagrant/environment.rb, line 155
def inspect
  "#<#{self.class}: #{@cwd}>"
end
lock() { || ... } click to toggle source

This locks Vagrant for the duration of the block passed to this method. During this time, any other environment which attempts to lock which points to the same lock file will fail.

# File lib/vagrant/environment.rb, line 352
def lock
  # If we don't have a block, then locking is useless, so ignore it
  return if !block_given?

  # This allows multiple locks in the same process to be nested
  return yield if @lock_acquired

  File.open(lock_path, "w+") do |f|
    # The file locking fails only if it returns "false." If it
    # succeeds it returns a 0, so we must explicitly check for
    # the proper error case.
    raise Errors::EnvironmentLockedError if f.flock(File::LOCK_EX | File::LOCK_NB) === false

    begin
      # Mark that we have a lock
      @lock_acquired = true

      yield
    ensure
      # We need to make sure that no matter what this is always
      # reset to false so we don't think we have a lock when we
      # actually don't.
      @lock_acquired = false
    end
  end
end
lock_path() click to toggle source

This returns the path which Vagrant uses to determine the location of the file lock. This is specific to each operating system.

# File lib/vagrant/environment.rb, line 345
def lock_path
  @lock_path || tmp_path.join("vagrant.lock")
end
machine(name, provider, refresh=false) click to toggle source

This returns a machine with the proper provider for this environment. The machine named by `name` must be in this environment.

@param [Symbol] name Name of the machine (as configured in the

Vagrantfile).

@param [Symbol] provider The provider that this machine should be

backed by.

@param [Boolean] refresh If true, then if there is a cached version

it is reloaded.

@return [Machine]

# File lib/vagrant/environment.rb, line 389
def machine(name, provider, refresh=false)
  @logger.info("Getting machine: #{name} (#{provider})")

  # Compose the cache key of the name and provider, and return from
  # the cache if we have that.
  cache_key = [name, provider]
  @machines ||= {}
  if refresh
    @logger.info("Refreshing machine (busting cache): #{name} (#{provider})")
    @machines.delete(cache_key)
  end

  if @machines.has_key?(cache_key)
    @logger.info("Returning cached machine: #{name} (#{provider})")
    return @machines[cache_key]
  end

  @logger.info("Uncached load of machine.")

  # Determine the machine data directory and pass it to the machine.
  # XXX: Permissions error here.
  machine_data_path = @local_data_path.join(
    "machines/#{name}/#{provider}")
  FileUtils.mkdir_p(machine_data_path)

  # Create the machine and cache it for future calls. This will also
  # return the machine from this method.
  @machines[cache_key] = vagrantfile.machine(
    name, provider, boxes, machine_data_path, self)
end
machine_names() click to toggle source

This returns a list of the configured machines for this environment. Each of the names returned by this method is valid to be used with the {#machine} method.

@return [Array<Symbol>] Configured machine names.

# File lib/vagrant/environment.rb, line 425
def machine_names
  vagrantfile.machine_names
end
primary_machine_name() click to toggle source

This returns the name of the machine that is the “primary.” In the case of a single-machine environment, this is just the single machine name. In the case of a multi-machine environment, then this can potentially be nil if no primary machine is specified.

@return [Symbol]

# File lib/vagrant/environment.rb, line 435
def primary_machine_name
  vagrantfile.primary_machine_name
end
root_path() click to toggle source

The root path is the path where the top-most (loaded last) Vagrantfile resides. It can be considered the project root for this environment.

@return [String]

# File lib/vagrant/environment.rb, line 444
def root_path
  return @root_path if defined?(@root_path)

  root_finder = lambda do |path|
    # Note: To remain compatible with Ruby 1.8, we have to use
    # a `find` here instead of an `each`.
    vf = find_vagrantfile(path, @vagrantfile_name)
    return path if vf
    return nil if path.root? || !File.exist?(path)
    root_finder.call(path.parent)
  end

  @root_path = root_finder.call(cwd)
end
setup_home_path() click to toggle source

This sets the `@home_path` variable properly.

@return [Pathname]

# File lib/vagrant/environment.rb, line 496
def setup_home_path
  @logger.info("Home path: #{@home_path}")

  # Setup the list of child directories that need to be created if they
  # don't already exist.
  dirs    = [@home_path]
  subdirs = ["boxes", "data", "gems", "rgloader", "tmp"]
  dirs    += subdirs.collect { |subdir| @home_path.join(subdir) }

  # Go through each required directory, creating it if it doesn't exist
  dirs.each do |dir|
    next if File.directory?(dir)

    begin
      @logger.info("Creating: #{dir}")
      FileUtils.mkdir_p(dir)
    rescue Errno::EACCES
      raise Errors::HomeDirectoryNotAccessible, :home_path => @home_path.to_s
    end
  end

  # Attempt to write into the home directory to verify we can
  begin
    # Append a random suffix to avoid race conditions if Vagrant
    # is running in parallel with other Vagrant processes.
    suffix = (0...32).map { (65 + rand(26)).chr }.join
    path   = @home_path.join("perm_test_#{suffix}")
    path.open("w") do |f|
      f.write("hello")
    end
    path.unlink
  rescue Errno::EACCES
    raise Errors::HomeDirectoryNotAccessible, home_path: @home_path.to_s
  end

  # Create the version file that we use to track the structure of
  # the home directory. If we have an old version, we need to explicitly
  # upgrade it. Otherwise, we just mark that its the current version.
  version_file = @home_path.join("setup_version")
  if version_file.file?
    version = version_file.read.chomp
    if version > CURRENT_SETUP_VERSION
      raise Errors::HomeDirectoryLaterVersion
    end

    case version
    when CURRENT_SETUP_VERSION
      # We're already good, at the latest version.
    when "1.1"
      # We need to update our directory structure
      upgrade_home_path_v1_1

      # Delete the version file so we put our latest version in
      version_file.delete
    else
      raise Errors::HomeDirectoryUnknownVersion,
        path: @home_path.to_s,
        version: version
    end
  end

  if !version_file.file?
    @logger.debug(
      "Creating home directory version file: #{CURRENT_SETUP_VERSION}")
    version_file.open("w") do |f|
      f.write(CURRENT_SETUP_VERSION)
    end
  end

  # Create the rgloader/loader file so we can use encoded files.
  loader_file = @home_path.join("rgloader", "loader.rb")
  if !loader_file.file?
    source_loader = Vagrant.source_root.join("templates/rgloader.rb")
    FileUtils.cp(source_loader.to_s, loader_file.to_s)
  end
end
setup_local_data_path() click to toggle source

This creates the local data directory and show an error if it couldn't properly be created.

# File lib/vagrant/environment.rb, line 575
def setup_local_data_path
  if @local_data_path.nil?
    @logger.warn("No local data path is set. Local data cannot be stored.")
    return
  end

  @logger.info("Local data path: #{@local_data_path}")

  # If the local data path is a file, then we are probably seeing an
  # old (V1) "dotfile." In this case, we upgrade it. The upgrade process
  # will remove the old data file if it is successful.
  if @local_data_path.file?
    upgrade_v1_dotfile(@local_data_path)
  end

  begin
    @logger.debug("Creating: #{@local_data_path}")
    FileUtils.mkdir_p(@local_data_path)
  rescue Errno::EACCES
    raise Errors::LocalDataDirectoryNotAccessible,
      :local_data_path => @local_data_path.to_s
  end
end
unload() click to toggle source

Unload the environment, running completion hooks. The environment should not be used after this (but CAN be, technically). It is recommended to always immediately set the variable to `nil` after running this so you can't accidentally run any more methods. Example:

env.unload
env = nil
# File lib/vagrant/environment.rb, line 467
def unload
  hook(:environment_unload)
end
vagrantfile() click to toggle source

Represents the default Vagrantfile, or the Vagrantfile that is in the working directory or a parent of the working directory of this environment.

The existence of this function is primarily a convenience. There is nothing stopping you from instantiating your own {Vagrantfile} and loading machines in any way you see fit. Typical behavior of Vagrant, however, loads this Vagrantfile.

This Vagrantfile is comprised of two major sources: the Vagrantfile in the user's home directory as well as the “root” Vagrantfile or the Vagrantfile in the working directory (or parent).

@return [Vagrantfile]

# File lib/vagrant/environment.rb, line 485
def vagrantfile
  @vagrantfile ||= Vagrantfile.new(config_loader, [:home, :root])
end

Protected Instance Methods

copy_insecure_private_key() click to toggle source

This method copies the private key into the home directory if it doesn't already exist.

This must be done because `ssh` requires that the key is chmod 0600, but if Vagrant is installed as a separate user, then the effective uid won't be able to read the key. So the key is copied to the home directory and chmod 0600.

# File lib/vagrant/environment.rb, line 608
def copy_insecure_private_key
  if !@default_private_key_path.exist?
    @logger.info("Copying private key to home directory")

    source      = File.expand_path("keys/vagrant", Vagrant.source_root)
    destination = @default_private_key_path

    begin
      FileUtils.cp(source, destination)
    rescue Errno::EACCES
      raise Errors::CopyPrivateKeyFailed,
        :source => source,
        :destination => destination
    end
  end

  if !Util::Platform.windows?
    # On Windows, permissions don't matter as much, so don't worry
    # about doing chmod.
    if Util::FileMode.from_octal(@default_private_key_path.stat.mode) != "600"
      @logger.info("Changing permissions on private key to 0600")
      @default_private_key_path.chmod(0600)
    end
  end
end
find_vagrantfile(search_path, filenames=nil) click to toggle source

Finds the Vagrantfile in the given directory.

@param [Pathname] path Path to search in. @return [Pathname]

# File lib/vagrant/environment.rb, line 638
def find_vagrantfile(search_path, filenames=nil)
  filenames ||= ["Vagrantfile", "vagrantfile"]
  filenames.each do |vagrantfile|
    current_path = search_path.join(vagrantfile)
    return current_path if current_path.file?
  end

  nil
end
upgrade_home_path_v1_1() click to toggle source

This upgrades a home directory that was in the v1.1 format to the v1.5 format. It will raise exceptions if anything fails.

# File lib/vagrant/environment.rb, line 650
def upgrade_home_path_v1_1
  @ui.ask(I18n.t("vagrant.upgrading_home_path_v1_5"))
  collection = BoxCollection.new(
    @home_path.join("boxes"), temp_dir_root: tmp_path)
  collection.upgrade_v1_1_v1_5
end
upgrade_v1_dotfile(path) click to toggle source

This upgrades a Vagrant 1.0.x “dotfile” to the new V2 format.

This is a destructive process. Once the upgrade is complete, the old dotfile is removed, and the environment becomes incompatible for Vagrant 1.0 environments.

@param [Pathname] path The path to the dotfile

# File lib/vagrant/environment.rb, line 664
def upgrade_v1_dotfile(path)
  @logger.info("Upgrading V1 dotfile to V2 directory structure...")

  # First, verify the file isn't empty. If it is an empty file, we
  # just delete it and go on with life.
  contents = path.read.strip
  if contents.strip == ""
    @logger.info("V1 dotfile was empty. Removing and moving on.")
    path.delete
    return
  end

  # Otherwise, verify there is valid JSON in here since a Vagrant
  # environment would always ensure valid JSON. This is a sanity check
  # to make sure we don't nuke a dotfile that is not ours...
  @logger.debug("Attempting to parse JSON of V1 file")
  json_data = nil
  begin
    json_data = JSON.parse(contents)
    @logger.debug("JSON parsed successfully. Things are okay.")
  rescue JSON::ParserError
    # The file could've been tampered with since Vagrant 1.0.x is
    # supposed to ensure that the contents are valid JSON. Show an error.
    raise Errors::DotfileUpgradeJSONError,
      :state_file => path.to_s
  end

  # Alright, let's upgrade this guy to the new structure. Start by
  # backing up the old dotfile.
  backup_file = path.dirname.join(".vagrant.v1.#{Time.now.to_i}")
  @logger.info("Renaming old dotfile to: #{backup_file}")
  path.rename(backup_file)

  # Now, we create the actual local data directory. This should succeed
  # this time since we renamed the old conflicting V1.
  setup_local_data_path

  if json_data["active"]
    @logger.debug("Upgrading to V2 style for each active VM")
    json_data["active"].each do |name, id|
      @logger.info("Upgrading dotfile: #{name} (#{id})")

      # Create the machine configuration directory
      directory = @local_data_path.join("machines/#{name}/virtualbox")
      FileUtils.mkdir_p(directory)

      # Write the ID file
      directory.join("id").open("w+") do |f|
        f.write(id)
      end
    end
  end

  # Upgrade complete! Let the user know
  @ui.info(I18n.t("vagrant.general.upgraded_v1_dotfile",
                  :backup_path => backup_file.to_s))
end