639 lines
22 KiB
Ruby
639 lines
22 KiB
Ruby
require "pathname"
|
|
require "securerandom"
|
|
require "set"
|
|
|
|
require "vagrant"
|
|
require "vagrant/config/v2/util"
|
|
require "vagrant/util/platform"
|
|
|
|
require File.expand_path("../vm_provisioner", __FILE__)
|
|
require File.expand_path("../vm_subvm", __FILE__)
|
|
|
|
module VagrantPlugins
|
|
module Kernel_V2
|
|
class VMConfig < Vagrant.plugin("2", :config)
|
|
DEFAULT_VM_NAME = :default
|
|
|
|
attr_accessor :base_mac
|
|
attr_accessor :boot_timeout
|
|
attr_accessor :box
|
|
attr_accessor :box_check_update
|
|
attr_accessor :box_url
|
|
attr_accessor :box_version
|
|
attr_accessor :box_download_ca_cert
|
|
attr_accessor :box_download_checksum
|
|
attr_accessor :box_download_checksum_type
|
|
attr_accessor :box_download_client_cert
|
|
attr_accessor :box_download_insecure
|
|
attr_accessor :communicator
|
|
attr_accessor :graceful_halt_timeout
|
|
attr_accessor :guest
|
|
attr_accessor :hostname
|
|
attr_accessor :post_up_message
|
|
attr_accessor :usable_port_range
|
|
attr_reader :provisioners
|
|
|
|
def initialize
|
|
@base_mac = UNSET_VALUE
|
|
@boot_timeout = UNSET_VALUE
|
|
@box = UNSET_VALUE
|
|
@box_check_update = UNSET_VALUE
|
|
@box_download_ca_cert = UNSET_VALUE
|
|
@box_download_checksum = UNSET_VALUE
|
|
@box_download_checksum_type = UNSET_VALUE
|
|
@box_download_client_cert = UNSET_VALUE
|
|
@box_download_insecure = UNSET_VALUE
|
|
@box_url = UNSET_VALUE
|
|
@box_version = UNSET_VALUE
|
|
@communicator = UNSET_VALUE
|
|
@graceful_halt_timeout = UNSET_VALUE
|
|
@guest = UNSET_VALUE
|
|
@hostname = UNSET_VALUE
|
|
@post_up_message = UNSET_VALUE
|
|
@provisioners = []
|
|
@usable_port_range = UNSET_VALUE
|
|
|
|
# Internal state
|
|
@__compiled_provider_configs = {}
|
|
@__defined_vm_keys = []
|
|
@__defined_vms = {}
|
|
@__finalized = false
|
|
@__networks = {}
|
|
@__providers = {}
|
|
@__provider_overrides = {}
|
|
@__synced_folders = {}
|
|
end
|
|
|
|
# This was from V1, but we just kept it here as an alias for hostname
|
|
# because too many people mess this up.
|
|
def host_name=(value)
|
|
@hostname = value
|
|
end
|
|
|
|
# Custom merge method since some keys here are merged differently.
|
|
def merge(other)
|
|
super.tap do |result|
|
|
other_networks = other.instance_variable_get(:@__networks)
|
|
|
|
result.instance_variable_set(:@__networks, @__networks.merge(other_networks))
|
|
|
|
# Merge defined VMs by first merging the defined VM keys,
|
|
# preserving the order in which they were defined.
|
|
other_defined_vm_keys = other.instance_variable_get(:@__defined_vm_keys)
|
|
other_defined_vm_keys -= @__defined_vm_keys
|
|
new_defined_vm_keys = @__defined_vm_keys + other_defined_vm_keys
|
|
|
|
# Merge the actual defined VMs.
|
|
other_defined_vms = other.instance_variable_get(:@__defined_vms)
|
|
new_defined_vms = {}
|
|
|
|
@__defined_vms.each do |key, subvm|
|
|
new_defined_vms[key] = subvm.clone
|
|
end
|
|
|
|
other_defined_vms.each do |key, subvm|
|
|
if !new_defined_vms.has_key?(key)
|
|
new_defined_vms[key] = subvm.clone
|
|
else
|
|
new_defined_vms[key].config_procs.concat(subvm.config_procs)
|
|
new_defined_vms[key].options.merge!(subvm.options)
|
|
end
|
|
end
|
|
|
|
# Merge the providers by prepending any configuration blocks we
|
|
# have for providers onto the new configuration.
|
|
other_providers = other.instance_variable_get(:@__providers)
|
|
new_providers = @__providers.dup
|
|
other_providers.each do |key, blocks|
|
|
new_providers[key] ||= []
|
|
new_providers[key] += blocks
|
|
end
|
|
|
|
# Merge the provider overrides by appending them...
|
|
other_overrides = other.instance_variable_get(:@__provider_overrides)
|
|
new_overrides = @__provider_overrides.dup
|
|
other_overrides.each do |key, blocks|
|
|
new_overrides[key] ||= []
|
|
new_overrides[key] += blocks
|
|
end
|
|
|
|
# Merge provisioners. First we deal with overrides and making
|
|
# sure the ordering is good there. Then we merge them.
|
|
new_provs = []
|
|
other_provs = other.provisioners.dup
|
|
@provisioners.each do |p|
|
|
if p.id
|
|
other_p = other_provs.find { |o| p.id == o.id }
|
|
if other_p
|
|
# There is an override. Take it.
|
|
other_p.config = p.config.merge(other_p.config)
|
|
other_p.run ||= p.run
|
|
next if !other_p.preserve_order
|
|
|
|
# We're preserving order, delete from other
|
|
p = other_p
|
|
other_provs.delete(other_p)
|
|
end
|
|
end
|
|
|
|
# There is an override, merge it into the
|
|
new_provs << p.dup
|
|
end
|
|
other_provs.each do |p|
|
|
new_provs << p.dup
|
|
end
|
|
result.instance_variable_set(:@provisioners, new_provs)
|
|
|
|
# Merge synced folders.
|
|
other_folders = other.instance_variable_get(:@__synced_folders)
|
|
new_folders = {}
|
|
@__synced_folders.each do |key, value|
|
|
new_folders[key] = value.dup
|
|
end
|
|
|
|
other_folders.each do |id, options|
|
|
new_folders[id] ||= {}
|
|
new_folders[id].merge!(options)
|
|
end
|
|
|
|
result.instance_variable_set(:@__defined_vm_keys, new_defined_vm_keys)
|
|
result.instance_variable_set(:@__defined_vms, new_defined_vms)
|
|
result.instance_variable_set(:@__providers, new_providers)
|
|
result.instance_variable_set(:@__provider_overrides, new_overrides)
|
|
result.instance_variable_set(:@__synced_folders, new_folders)
|
|
end
|
|
end
|
|
|
|
# Defines a synced folder pair. This pair of folders will be synced
|
|
# to/from the machine. Note that if the machine you're using doesn't
|
|
# support multi-directional syncing (perhaps an rsync backed synced
|
|
# folder) then the host is always synced to the guest but guest data
|
|
# may not be synced back to the host.
|
|
#
|
|
# @param [String] hostpath Path to the host folder to share. If this
|
|
# is a relative path, it is relative to the location of the
|
|
# Vagrantfile.
|
|
# @param [String] guestpath Path on the guest to mount the shared
|
|
# folder.
|
|
# @param [Hash] options Additional options.
|
|
def synced_folder(hostpath, guestpath, options=nil)
|
|
if Vagrant::Util::Platform.windows?
|
|
# On Windows, Ruby just uses normal '/' for path seps, so
|
|
# just replace normal Windows style seps with Unix ones.
|
|
hostpath = hostpath.to_s.gsub("\\", "/")
|
|
end
|
|
|
|
options ||= {}
|
|
options = options.dup
|
|
options[:guestpath] = guestpath.to_s.gsub(/\/$/, '')
|
|
options[:hostpath] = hostpath
|
|
# Make sure the type is a symbol
|
|
options[:type] = options[:type].to_sym if options[:type]
|
|
|
|
@__synced_folders[options[:guestpath]] = options
|
|
end
|
|
|
|
# Define a way to access the machine via a network. This exposes a
|
|
# high-level abstraction for networking that may not directly map
|
|
# 1-to-1 for every provider. For example, AWS has no equivalent to
|
|
# "port forwarding." But most providers will attempt to implement this
|
|
# in a way that behaves similarly.
|
|
#
|
|
# `type` can be one of:
|
|
#
|
|
# * `:forwarded_port` - A port that is accessible via localhost
|
|
# that forwards into the machine.
|
|
# * `:private_network` - The machine gets an IP that is not directly
|
|
# publicly accessible, but ideally accessible from this machine.
|
|
# * `:public_network` - The machine gets an IP on a shared network.
|
|
#
|
|
# @param [Symbol] type Type of network
|
|
# @param [Hash] options Options for the network.
|
|
def network(type, **options)
|
|
options = options.dup
|
|
options[:protocol] ||= "tcp"
|
|
|
|
if !options[:id]
|
|
default_id = nil
|
|
|
|
if type == :forwarded_port
|
|
# For forwarded ports, set the default ID to the
|
|
# host port so that host ports overwrite each other.
|
|
default_id = "#{options[:protocol]}#{options[:host]}"
|
|
end
|
|
|
|
options[:id] = default_id || SecureRandom.uuid
|
|
end
|
|
|
|
# Scope the ID by type so that different types can share IDs
|
|
id = options[:id]
|
|
id = "#{type}-#{id}"
|
|
|
|
# Merge in the previous settings if we have them.
|
|
if @__networks.has_key?(id)
|
|
options = @__networks[id][1].merge(options)
|
|
end
|
|
|
|
# Merge in the latest settings and set the internal state
|
|
@__networks[id] = [type.to_sym, options]
|
|
end
|
|
|
|
# Configures a provider for this VM.
|
|
#
|
|
# @param [Symbol] name The name of the provider.
|
|
def provider(name, &block)
|
|
name = name.to_sym
|
|
@__providers[name] ||= []
|
|
@__provider_overrides[name] ||= []
|
|
|
|
if block_given?
|
|
@__providers[name] << block if block_given?
|
|
|
|
# If this block takes two arguments, then we curry it and store
|
|
# the configuration override for use later.
|
|
if block.arity == 2
|
|
@__provider_overrides[name] << block.curry[Vagrant::Config::V2::DummyConfig.new]
|
|
end
|
|
end
|
|
end
|
|
|
|
def provision(name, **options, &block)
|
|
id = options.delete(:id).to_s if options.has_key?(:id)
|
|
|
|
prov = nil
|
|
if id
|
|
prov = @provisioners.find { |p| p.id == id }
|
|
end
|
|
|
|
if !prov
|
|
prov = VagrantConfigProvisioner.new(id, name.to_sym)
|
|
@provisioners << prov
|
|
end
|
|
|
|
prov.preserve_order = !!options.delete(:preserve_order) if \
|
|
options.has_key?(:preserve_order)
|
|
prov.run = options.delete(:run) if options.has_key?(:run)
|
|
prov.add_config(options, &block)
|
|
nil
|
|
end
|
|
|
|
def defined_vms
|
|
@__defined_vms
|
|
end
|
|
|
|
# This returns the keys of the sub-vms in the order they were
|
|
# defined.
|
|
def defined_vm_keys
|
|
@__defined_vm_keys
|
|
end
|
|
|
|
def define(name, options=nil, &block)
|
|
name = name.to_sym
|
|
options ||= {}
|
|
options = options.dup
|
|
options[:config_version] ||= "2"
|
|
|
|
# Add the name to the array of VM keys. This array is used to
|
|
# preserve the order in which VMs are defined.
|
|
@__defined_vm_keys << name if !@__defined_vm_keys.include?(name)
|
|
|
|
# Add the SubVM to the hash of defined VMs
|
|
if !@__defined_vms[name]
|
|
@__defined_vms[name] = VagrantConfigSubVM.new
|
|
end
|
|
|
|
@__defined_vms[name].options.merge!(options)
|
|
@__defined_vms[name].config_procs << [options[:config_version], block] if block
|
|
end
|
|
|
|
#-------------------------------------------------------------------
|
|
# Internal methods, don't call these.
|
|
#-------------------------------------------------------------------
|
|
|
|
def finalize!
|
|
# Defaults
|
|
@base_mac = nil if @base_mac == UNSET_VALUE
|
|
@boot_timeout = 300 if @boot_timeout == UNSET_VALUE
|
|
@box = nil if @box == UNSET_VALUE
|
|
@box_check_update = true if @box_check_update == UNSET_VALUE
|
|
@box_download_ca_cert = nil if @box_download_ca_cert == UNSET_VALUE
|
|
@box_download_checksum = nil if @box_download_checksum == UNSET_VALUE
|
|
@box_download_checksum_type = nil if @box_download_checksum_type == UNSET_VALUE
|
|
@box_download_client_cert = nil if @box_download_client_cert == UNSET_VALUE
|
|
@box_download_insecure = false if @box_download_insecure == UNSET_VALUE
|
|
@box_url = nil if @box_url == UNSET_VALUE
|
|
@box_version = nil if @box_version == UNSET_VALUE
|
|
@communicator = nil if @communicator == UNSET_VALUE
|
|
@graceful_halt_timeout = 60 if @graceful_halt_timeout == UNSET_VALUE
|
|
@guest = nil if @guest == UNSET_VALUE
|
|
@hostname = nil if @hostname == UNSET_VALUE
|
|
@hostname = @hostname.to_s if @hostname
|
|
@post_up_message = "" if @post_up_message == UNSET_VALUE
|
|
|
|
if @usable_port_range == UNSET_VALUE
|
|
@usable_port_range = (2200..2250)
|
|
end
|
|
|
|
# Make sure that the download checksum is a string and that
|
|
# the type is a symbol
|
|
@box_download_checksum = "" if !@box_download_checksum
|
|
if @box_download_checksum_type
|
|
@box_download_checksum_type = @box_download_checksum_type.to_sym
|
|
end
|
|
|
|
# Make sure the box URL is an array if it is set
|
|
@box_url = Array(@box_url) if @box_url
|
|
|
|
# Set the communicator properly
|
|
@communicator = @communicator.to_sym if @communicator
|
|
|
|
# Set the guest properly
|
|
@guest = @guest.to_sym if @guest
|
|
|
|
# If we haven't defined a single VM, then we need to define a
|
|
# default VM which just inherits the rest of the configuration.
|
|
define(DEFAULT_VM_NAME) if defined_vm_keys.empty?
|
|
|
|
# Make sure the SSH forwarding is added if it doesn't exist
|
|
if !@__networks["forwarded_port-ssh"]
|
|
network :forwarded_port,
|
|
guest: 22,
|
|
host: 2222,
|
|
host_ip: "127.0.0.1",
|
|
id: "ssh",
|
|
auto_correct: true
|
|
end
|
|
|
|
# Clean up some network configurations
|
|
@__networks.values.each do |type, opts|
|
|
if type == :forwarded_port
|
|
opts[:guest] = opts[:guest].to_i if opts[:guest]
|
|
opts[:host] = opts[:host].to_i if opts[:host]
|
|
end
|
|
end
|
|
|
|
# Compile all the provider configurations
|
|
@__providers.each do |name, blocks|
|
|
# If we don't have any configuration blocks, then ignore it
|
|
next if blocks.empty?
|
|
|
|
# Find the configuration class for this provider
|
|
config_class = Vagrant.plugin("2").manager.provider_configs[name]
|
|
config_class ||= Vagrant::Config::V2::DummyConfig
|
|
|
|
# Load it up
|
|
config = config_class.new
|
|
|
|
begin
|
|
blocks.each do |b|
|
|
new_config = config_class.new
|
|
b.call(new_config, Vagrant::Config::V2::DummyConfig.new)
|
|
config = config.merge(new_config)
|
|
end
|
|
rescue Exception => e
|
|
raise Vagrant::Errors::VagrantfileLoadError,
|
|
path: "<provider config: #{name}>",
|
|
message: e.message
|
|
end
|
|
|
|
config.finalize!
|
|
|
|
# Store it for retrieval later
|
|
@__compiled_provider_configs[name] = config
|
|
end
|
|
|
|
# Finalize all the provisioners
|
|
@provisioners.each do |p|
|
|
p.config.finalize! if !p.invalid?
|
|
p.run = p.run.to_sym if p.run
|
|
end
|
|
|
|
# If we didn't share our current directory, then do it
|
|
# manually.
|
|
if !@__synced_folders["/vagrant"]
|
|
synced_folder(".", "/vagrant")
|
|
end
|
|
|
|
@__synced_folders.each do |id, options|
|
|
if options[:nfs]
|
|
options[:type] = :nfs
|
|
end
|
|
|
|
# Ignore NFS on Windows
|
|
if options[:type] == :nfs && Vagrant::Util::Platform.windows?
|
|
options.delete(:type)
|
|
end
|
|
end
|
|
|
|
# Flag that we finalized
|
|
@__finalized = true
|
|
end
|
|
|
|
# This returns the compiled provider-specific configurationf or the
|
|
# given provider.
|
|
#
|
|
# @param [Symbol] name Name of the provider.
|
|
def get_provider_config(name)
|
|
raise "Must finalize first." if !@__finalized
|
|
|
|
result = @__compiled_provider_configs[name]
|
|
|
|
# If no compiled configuration was found, then we try to just
|
|
# use the default configuration from the plugin.
|
|
if !result
|
|
config_class = Vagrant.plugin("2").manager.provider_configs[name]
|
|
if config_class
|
|
result = config_class.new
|
|
result.finalize!
|
|
end
|
|
end
|
|
|
|
return result
|
|
end
|
|
|
|
# This returns a list of VM configurations that are overrides
|
|
# for this provider.
|
|
#
|
|
# @param [Symbol] name Name of the provider
|
|
# @return [Array<Proc>]
|
|
def get_provider_overrides(name)
|
|
(@__provider_overrides[name] || []).map do |p|
|
|
["2", p]
|
|
end
|
|
end
|
|
|
|
# This returns the list of networks configured.
|
|
def networks
|
|
@__networks.values
|
|
end
|
|
|
|
# This returns the list of synced folders
|
|
def synced_folders
|
|
@__synced_folders
|
|
end
|
|
|
|
def validate(machine)
|
|
errors = _detected_errors
|
|
|
|
if !box && !machine.provider_options[:box_optional]
|
|
errors << I18n.t("vagrant.config.vm.box_missing")
|
|
end
|
|
|
|
errors << I18n.t("vagrant.config.vm.hostname_invalid_characters") if \
|
|
@hostname && @hostname !~ /^[a-z0-9][-.a-z0-9]+$/i
|
|
|
|
if @box_version
|
|
@box_version.split(",").each do |v|
|
|
begin
|
|
Gem::Requirement.new(v.strip)
|
|
rescue Gem::Requirement::BadRequirementError
|
|
errors << I18n.t(
|
|
"vagrant.config.vm.bad_version", version: v)
|
|
end
|
|
end
|
|
end
|
|
|
|
if box_download_ca_cert
|
|
path = Pathname.new(box_download_ca_cert).
|
|
expand_path(machine.env.root_path)
|
|
if !path.file?
|
|
errors << I18n.t(
|
|
"vagrant.config.vm.box_download_ca_cert_not_found",
|
|
path: box_download_ca_cert)
|
|
end
|
|
end
|
|
|
|
if box_download_checksum_type
|
|
if box_download_checksum == ""
|
|
errors << I18n.t("vagrant.config.vm.box_download_checksum_blank")
|
|
end
|
|
else
|
|
if box_download_checksum != ""
|
|
errors << I18n.t("vagrant.config.vm.box_download_checksum_notblank")
|
|
end
|
|
end
|
|
|
|
used_guest_paths = Set.new
|
|
@__synced_folders.each do |id, options|
|
|
# If the shared folder is disabled then don't worry about validating it
|
|
next if options[:disabled]
|
|
|
|
guestpath = Pathname.new(options[:guestpath])
|
|
hostpath = Pathname.new(options[:hostpath]).expand_path(machine.env.root_path)
|
|
|
|
if guestpath.relative? && guestpath.to_s !~ /^\w+:/
|
|
errors << I18n.t("vagrant.config.vm.shared_folder_guestpath_relative",
|
|
:path => options[:guestpath])
|
|
else
|
|
if used_guest_paths.include?(options[:guestpath])
|
|
errors << I18n.t("vagrant.config.vm.shared_folder_guestpath_duplicate",
|
|
:path => options[:guestpath])
|
|
end
|
|
|
|
used_guest_paths.add(options[:guestpath])
|
|
end
|
|
|
|
if !hostpath.directory? && !options[:create]
|
|
errors << I18n.t("vagrant.config.vm.shared_folder_hostpath_missing",
|
|
:path => options[:hostpath])
|
|
end
|
|
|
|
if options[:type] == :nfs
|
|
if options[:owner] || options[:group]
|
|
# Owner/group don't work with NFS
|
|
errors << I18n.t("vagrant.config.vm.shared_folder_nfs_owner_group",
|
|
:path => options[:hostpath])
|
|
end
|
|
end
|
|
|
|
if options[:mount_options] && !options[:mount_options].is_a?(Array)
|
|
errors << I18n.t("vagrant.config.vm.shared_folder_mount_options_array")
|
|
end
|
|
|
|
# One day remove this probably.
|
|
if options[:extra]
|
|
errors << "The 'extra' flag on synced folders is now 'mount_options'"
|
|
end
|
|
end
|
|
|
|
# Validate networks
|
|
has_fp_port_error = false
|
|
fp_used = Set.new
|
|
valid_network_types = [:forwarded_port, :private_network, :public_network]
|
|
|
|
port_range=(1..65535)
|
|
networks.each do |type, options|
|
|
if !valid_network_types.include?(type)
|
|
errors << I18n.t("vagrant.config.vm.network_type_invalid",
|
|
:type => type.to_s)
|
|
end
|
|
|
|
if type == :forwarded_port
|
|
if !has_fp_port_error && (!options[:guest] || !options[:host])
|
|
errors << I18n.t("vagrant.config.vm.network_fp_requires_ports")
|
|
has_fp_port_error = true
|
|
end
|
|
|
|
if options[:host]
|
|
key = "#{options[:protocol]}#{options[:host]}"
|
|
if fp_used.include?(key)
|
|
errors << I18n.t("vagrant.config.vm.network_fp_host_not_unique",
|
|
:host => options[:host].to_s,
|
|
:protocol => options[:protocol].to_s)
|
|
end
|
|
|
|
fp_used.add(key)
|
|
end
|
|
|
|
if !port_range.include?(options[:host]) || !port_range.include?(options[:guest])
|
|
errors << I18n.t("vagrant.config.vm.network_fp_invalid_port")
|
|
end
|
|
end
|
|
|
|
if type == :private_network
|
|
if options[:type] && options[:type].to_sym != :dhcp
|
|
if !options[:ip]
|
|
errors << I18n.t("vagrant.config.vm.network_ip_required")
|
|
end
|
|
end
|
|
|
|
if options[:ip] && options[:ip].end_with?(".1")
|
|
machine.ui.warn(I18n.t(
|
|
"vagrant.config.vm.network_ip_ends_in_one"))
|
|
end
|
|
end
|
|
end
|
|
|
|
# We're done with VM level errors so prepare the section
|
|
errors = { "vm" => errors }
|
|
|
|
# Validate only the _active_ provider
|
|
if machine.provider_config
|
|
provider_errors = machine.provider_config.validate(machine)
|
|
if provider_errors
|
|
errors = Vagrant::Config::V2::Util.merge_errors(errors, provider_errors)
|
|
end
|
|
end
|
|
|
|
# Validate provisioners
|
|
@provisioners.each do |vm_provisioner|
|
|
if vm_provisioner.invalid?
|
|
errors["vm"] << I18n.t("vagrant.config.vm.provisioner_not_found",
|
|
:name => vm_provisioner.name)
|
|
next
|
|
end
|
|
|
|
if vm_provisioner.config
|
|
provisioner_errors = vm_provisioner.config.validate(machine)
|
|
if provisioner_errors
|
|
errors = Vagrant::Config::V2::Util.merge_errors(errors, provisioner_errors)
|
|
end
|
|
end
|
|
end
|
|
|
|
errors
|
|
end
|
|
end
|
|
end
|
|
end
|