module Vagrant::Config

Constants

CONFIGURE_MUTEX

This is a mutex used to guarantee that only one thread can load procs at any given time.

CURRENT_VERSION
VERSIONS

This is the registry which keeps track of what configuration versions are available, mapped by the version string used in ‘Vagrant.configure` calls.

VERSIONS_ORDER

This is the order of versions. This is used by the loader to figure out how to “upgrade” versions up to the desired (current) version. The current version is always considered to be the last version in this list.

Public Class Methods

capture_configures() { || ... } click to toggle source

This is a method which will yield to a block and will capture all “Vagrant.configure“ calls, returning an array of ‘Proc`s.

Wrapping this around anytime you call code which loads configurations will force a mutex so that procs never get mixed up. This keeps the configuration loading part of Vagrant thread-safe.

# File lib/vagrant/config.rb, line 47
def self.capture_configures
  CONFIGURE_MUTEX.synchronize do
    # Reset the last procs so that we start fresh
    @last_procs = []

    # Yield to allow the caller to do whatever loading needed
    yield

    # Return the last procs we've seen while still in the mutex,
    # knowing we're safe.
    return @last_procs
  end
end
run(version="1", &block) click to toggle source

This is the method which is called by all Vagrantfiles to configure Vagrant. This method expects a block which accepts a single argument representing an instance of the {Config::Top} class.

Note that the block is not run immediately. Instead, it’s proc is stored away for execution later.

# File lib/vagrant/config.rb, line 35
def self.run(version="1", &block)
  # Store it for later
  @last_procs ||= []
  @last_procs << [version.to_s, block]
end