vagrant 1.5.0 → 2.4.4

data/plugins/provisioners/chef/config/base.rb

@@ -0,0 +1,139 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
+require "vagrant/util/presence"
+
+module VagrantPlugins
+  module Chef
+    module Config
+      class Base < Vagrant.plugin("2", :config)
+        include Vagrant::Util::Presence
+
+        # The path to Chef's bin/ directory.
+        # @return [String]
+        attr_accessor :binary_path
+
+        # Arbitrary environment variables to set before running the Chef
+        # provisioner command.
+        # @return [String]
+        attr_accessor :binary_env
+
+        # The name of the Chef project to install. This is "chef" for the Chef
+        # Client or "chefdk" for the Chef Development Kit. Other product names
+        # may be available as well.
+        # @return [String]
+        attr_accessor :product
+
+        # Install Chef on the system if it does not exist. Default is true.
+        # This is a trinary attribute (it can have three values):
+        #
+        # - true (bool) install Chef
+        # - false (bool) do not install Chef
+        # - "force" (string) install Chef, even if it is already installed at
+        #   the proper version
+        #
+        # @return [true, false, String]
+        attr_accessor :install
+
+        # The Chef log level. See the Chef docs for acceptable values.
+        # @return [String, Symbol]
+        attr_accessor :log_level
+
+        # The channel from which to download Chef. Currently known values are
+        # "current" and "stable", but more may be added in the future. The
+        # default is "stable".
+        # @return [String]
+        attr_accessor :channel
+
+        # The version of Chef to install. If Chef is already installed on the
+        # system, the installed version is compared with the requested version.
+        # If they match, no action is taken. If they do not match, version of
+        # the value specified in this attribute will be installed over top of
+        # the existing version (a warning will be displayed).
+        #
+        # You can also specify "latest" (default), which will install the latest
+        # version of Chef on the system. In this case, Chef will use whatever
+        # version is on the system. To force the newest version of Chef to be
+        # installed on every provision, set the {#install} option to "force".
+        #
+        # @return [String]
+        attr_accessor :version
+
+        # Location of Omnibus installation scripts.
+        # This URL specifies the location of install.sh/install.ps1 for
+        # Linux/Unix and Windows respectively.
+        #
+        # It defaults to https://omnitruck.chef.io/. The full URL is then:
+        #  - Linux/Unix: https://omnitruck.chef.io/install.sh
+        #  - Windows: https://omnitruck.chef.io/install.ps1
+        #
+        # If you want to have https://example.com/install.sh as Omnibus script
+        # for your Linux/Unix installations, you should set this option to
+        # https://example.com
+        #
+        # @return [String]
+        attr_accessor :omnibus_url
+
+        # The path where the Chef installer will be downloaded to. Only valid if
+        # install is true or "force". It defaults to nil, which means that the
+        # omnibus installer will choose the destination and you have no control
+        # over it.
+        #
+        # @return [String]
+        attr_accessor :installer_download_path
+
+        def initialize
+          super
+
+          @binary_path = UNSET_VALUE
+          @binary_env  = UNSET_VALUE
+          @product     = UNSET_VALUE
+          @install     = UNSET_VALUE
+          @log_level   = UNSET_VALUE
+          @channel     = UNSET_VALUE
+          @version     = UNSET_VALUE
+          @omnibus_url = UNSET_VALUE
+          @installer_download_path = UNSET_VALUE
+        end
+
+        def finalize!
+          @binary_path = nil       if @binary_path == UNSET_VALUE
+          @binary_env  = nil       if @binary_env == UNSET_VALUE
+          @product     = "chef"    if @product == UNSET_VALUE
+          @install     = true      if @install == UNSET_VALUE
+          @log_level   = :info     if @log_level == UNSET_VALUE
+          @channel     = "stable"  if @channel == UNSET_VALUE
+          @version     = :latest   if @version == UNSET_VALUE
+          @omnibus_url = 'https://omnitruck.chef.io' if @omnibus_url == UNSET_VALUE
+          @installer_download_path = nil  if @installer_download_path == UNSET_VALUE
+
+          # Make sure the install is a symbol if it's not a boolean
+          if @install.respond_to?(:to_sym)
+            @install = @install.to_sym
+          end
+
+          # Make sure the version is a symbol if it's not a boolean
+          if @version.respond_to?(:to_sym)
+            @version = @version.to_sym
+          end
+
+          # Make sure the log level is a symbol
+          @log_level = @log_level.to_sym
+        end
+
+        # Like validate, but returns a list of errors to append.
+        #
+        # @return [Array<String>]
+        def validate_base(machine)
+          errors = _detected_errors
+
+          if !present?(log_level)
+            errors << I18n.t("vagrant.provisioners.chef.log_level_empty")
+          end
+
+          errors
+        end
+      end
+    end
+  end
+end

data/plugins/provisioners/chef/config/base_runner.rb

@@ -0,0 +1,131 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
+require "vagrant/util/counter"
+
+require_relative "base"
+
+module VagrantPlugins
+  module Chef
+    module Config
+      # This is the config base for Chef provisioners that need a full Chef
+      # Runner object, like chef-solo or chef-client. For provisioners like
+      # chef-apply, these options are not valid
+      class BaseRunner < Base
+        attr_accessor :arguments
+        attr_accessor :attempts
+        attr_accessor :custom_config_path
+        attr_accessor :encrypted_data_bag_secret_key_path
+        attr_accessor :environment
+        attr_accessor :formatter
+        attr_accessor :http_proxy
+        attr_accessor :http_proxy_user
+        attr_accessor :http_proxy_pass
+        attr_accessor :https_proxy
+        attr_accessor :https_proxy_user
+        attr_accessor :https_proxy_pass
+        attr_accessor :json
+        attr_accessor :no_proxy
+        attr_accessor :node_name
+        attr_accessor :provisioning_path
+        attr_accessor :run_list
+        attr_accessor :file_cache_path
+        attr_accessor :file_backup_path
+        attr_accessor :verbose_logging
+        attr_accessor :enable_reporting
+
+        def initialize
+          super
+
+          @arguments          = UNSET_VALUE
+          @attempts           = UNSET_VALUE
+          @custom_config_path = UNSET_VALUE
+
+          # /etc/chef/client.rb config options
+          @encrypted_data_bag_secret_key_path = UNSET_VALUE
+          @environment        = UNSET_VALUE
+          @formatter          = UNSET_VALUE
+          @http_proxy         = UNSET_VALUE
+          @http_proxy_user    = UNSET_VALUE
+          @http_proxy_pass    = UNSET_VALUE
+          @https_proxy        = UNSET_VALUE
+          @https_proxy_user   = UNSET_VALUE
+          @https_proxy_pass   = UNSET_VALUE
+          @no_proxy           = UNSET_VALUE
+          @node_name          = UNSET_VALUE
+          @provisioning_path  = UNSET_VALUE
+          @file_cache_path    = UNSET_VALUE
+          @file_backup_path   = UNSET_VALUE
+          @verbose_logging    = UNSET_VALUE
+          @enable_reporting   = UNSET_VALUE
+
+          # Runner options
+          @json     = {}
+          @run_list = []
+        end
+
+        def finalize!
+          super
+
+          @arguments          = nil if @arguments == UNSET_VALUE
+          @attempts           = 1   if @attempts == UNSET_VALUE
+          @custom_config_path = nil if @custom_config_path == UNSET_VALUE
+          @environment        = nil if @environment == UNSET_VALUE
+          @formatter          = nil if @formatter == UNSET_VALUE
+          @http_proxy         = nil if @http_proxy == UNSET_VALUE
+          @http_proxy_user    = nil if @http_proxy_user == UNSET_VALUE
+          @http_proxy_pass    = nil if @http_proxy_pass == UNSET_VALUE
+          @https_proxy        = nil if @https_proxy == UNSET_VALUE
+          @https_proxy_user   = nil if @https_proxy_user == UNSET_VALUE
+          @https_proxy_pass   = nil if @https_proxy_pass == UNSET_VALUE
+          @no_proxy           = nil if @no_proxy == UNSET_VALUE
+          @node_name          = nil if @node_name == UNSET_VALUE
+          @provisioning_path  = nil if @provisioning_path == UNSET_VALUE
+          @file_backup_path   = nil if @file_backup_path == UNSET_VALUE
+          @file_cache_path    = nil if @file_cache_path == UNSET_VALUE
+          @verbose_logging    = false if @verbose_logging == UNSET_VALUE
+          @enable_reporting   = true  if @enable_reporting == UNSET_VALUE
+
+          if @encrypted_data_bag_secret_key_path == UNSET_VALUE
+            @encrypted_data_bag_secret_key_path = nil
+          end
+        end
+
+        def merge(other)
+          super.tap do |result|
+            result.instance_variable_set(:@json, @json.merge(other.json))
+            result.instance_variable_set(:@run_list, (@run_list + other.run_list))
+          end
+        end
+
+        # Just like the normal configuration "validate" method except that
+        # it returns an array of errors that should be merged into some
+        # other error accumulator.
+        def validate_base(machine)
+          errors = super
+
+          if @custom_config_path
+            expanded = File.expand_path(@custom_config_path, machine.env.root_path)
+            if !File.file?(expanded)
+              errors << I18n.t("vagrant.config.chef.custom_config_path_missing")
+            end
+          end
+
+          errors
+        end
+
+        # Adds a recipe to the run list
+        def add_recipe(name)
+          name = "recipe[#{name}]" unless name =~ /^recipe\[(.+?)\]$/
+            run_list << name
+        end
+
+        # Adds a role to the run list
+        def add_role(name)
+          name = "role[#{name}]" unless name =~ /^role\[(.+?)\]$/
+            run_list << name
+        end
+      end
+    end
+  end
+end

data/plugins/provisioners/chef/config/chef_apply.rb

@@ -0,0 +1,53 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
+require "vagrant/util/presence"
+
+require_relative "base"
+
+module VagrantPlugins
+  module Chef
+    module Config
+      class ChefApply < Base
+        include Vagrant::Util::Presence
+
+        # The raw recipe text (as a string) to execute via chef-apply.
+        # @return [String]
+        attr_accessor :recipe
+
+        # The path (on the guest) where the uploaded apply recipe should be
+        # written (/tmp/vagrant-chef-apply-#.rb).
+        # @return [String]
+        attr_accessor :upload_path
+
+        def initialize
+          super
+
+          @recipe      = UNSET_VALUE
+          @upload_path = UNSET_VALUE
+        end
+
+        def finalize!
+          super
+
+          @recipe = nil if @recipe == UNSET_VALUE
+          @upload_path = "/tmp/vagrant-chef-apply" if @upload_path == UNSET_VALUE
+        end
+
+        def validate(machine)
+          errors = validate_base(machine)
+
+          if !present?(recipe)
+            errors << I18n.t("vagrant.provisioners.chef.recipe_empty")
+          end
+
+          if !present?(upload_path)
+            errors << I18n.t("vagrant.provisioners.chef.upload_path_empty")
+          end
+
+          { "chef apply provisioner" => errors }
+        end
+      end
+    end
+  end
+end

data/plugins/provisioners/chef/config/chef_client.rb

@@ -0,0 +1,77 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
+require "vagrant/util/presence"
+require "vagrant/util/which"
+
+require_relative "base_runner"
+
+module VagrantPlugins
+  module Chef
+    module Config
+      class ChefClient < BaseRunner
+        include Vagrant::Util::Presence
+
+        # The URL endpoint to the Chef Server.
+        # @return [String]
+        attr_accessor :chef_server_url
+
+        # The path on disk to the Chef client key,
+        # @return [String]
+        attr_accessor :client_key_path
+
+        # Delete the client key when the VM is destroyed. Default is false.
+        # @return [true, false]
+        attr_accessor :delete_client
+
+        # Delete the node when the VM is destroyed. Default is false.
+        # @return [true, false]
+        attr_accessor :delete_node
+
+        # The path to the validation key on disk.
+        # @return [String]
+        attr_accessor :validation_key_path
+
+        # The name of the validation client.
+        # @return [String]
+        attr_accessor :validation_client_name
+
+        def initialize
+          super
+
+          @chef_server_url        = UNSET_VALUE
+          @client_key_path        = UNSET_VALUE
+          @delete_client          = UNSET_VALUE
+          @delete_node            = UNSET_VALUE
+          @validation_key_path    = UNSET_VALUE
+          @validation_client_name = UNSET_VALUE
+        end
+
+        def finalize!
+          super
+
+          @chef_server_url        = nil if @chef_server_url == UNSET_VALUE
+          @client_key_path        = nil if @client_key_path == UNSET_VALUE
+          @delete_client          = false if @delete_client == UNSET_VALUE
+          @delete_node            = false if @delete_node == UNSET_VALUE
+          @validation_client_name = "chef-validator" if @validation_client_name == UNSET_VALUE
+          @validation_key_path    = nil if @validation_key_path == UNSET_VALUE
+        end
+
+        def validate(machine)
+          errors = validate_base(machine)
+
+          if !present?(chef_server_url)
+            errors << I18n.t("vagrant.config.chef.server_url_empty")
+          end
+
+          if !present?(validation_key_path)
+            errors << I18n.t("vagrant.config.chef.validation_key_path")
+          end
+
+          { "chef client provisioner" => errors }
+        end
+      end
+    end
+  end
+end

data/plugins/provisioners/chef/config/chef_solo.rb

@@ -0,0 +1,141 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
+require "vagrant/util/presence"
+
+require_relative "base_runner"
+
+module VagrantPlugins
+  module Chef
+    module Config
+      class ChefSolo < BaseRunner
+        include Vagrant::Util::Presence
+
+        # The path on disk where Chef cookbooks are stored.
+        # Default is "cookbooks".
+        # @return [String]
+        attr_accessor :cookbooks_path
+
+        # The path where data bags are stored on disk.
+        # @return [String]
+        attr_accessor :data_bags_path
+
+        # The path where environments are stored on disk.
+        # @return [String]
+        attr_accessor :environments_path
+
+        # The path where nodes are stored on disk.
+        # @return [String]
+        attr_accessor :nodes_path
+
+        # A URL download a remote recipe from. Note: you should use chef-apply
+        # instead.
+        #
+        # @deprecated
+        #
+        # @return [String]
+        attr_accessor :recipe_url
+
+        # Enable chef-solo legacy mode rather than local mode.
+        # @return [true, false]
+        attr_accessor :legacy_mode
+
+        # The path where roles are stored on disk.
+        # @return [String]
+        attr_accessor :roles_path
+
+        # The type of synced folders to use.
+        # @return [String]
+        attr_accessor :synced_folder_type
+
+        def initialize
+          super
+
+          @cookbooks_path      = UNSET_VALUE
+          @data_bags_path      = UNSET_VALUE
+          @environments_path   = UNSET_VALUE
+          @nodes_path          = UNSET_VALUE
+          @recipe_url          = UNSET_VALUE
+          @legacy_mode         = UNSET_VALUE
+          @roles_path          = UNSET_VALUE
+          @synced_folder_type  = UNSET_VALUE
+        end
+
+        #------------------------------------------------------------
+        # Internal methods
+        #------------------------------------------------------------
+
+        def finalize!
+          super
+
+          @recipe_url = nil if @recipe_url == UNSET_VALUE
+          @synced_folder_type = nil if @synced_folder_type == UNSET_VALUE
+          @legacy_mode = false if @legacy_mode == UNSET_VALUE
+
+          if @cookbooks_path == UNSET_VALUE
+            @cookbooks_path = []
+            @cookbooks_path << [:host, "cookbooks"] if !@recipe_url
+            @cookbooks_path << [:vm, "cookbooks"]
+          end
+
+          @data_bags_path    = [] if @data_bags_path == UNSET_VALUE
+          @nodes_path        = [] if @nodes_path == UNSET_VALUE
+          @roles_path        = [] if @roles_path == UNSET_VALUE
+          @environments_path = [] if @environments_path == UNSET_VALUE
+          @environments_path = [@environments_path].flatten
+
+          # Make sure the path is an array.
+          @cookbooks_path    = prepare_folders_config(@cookbooks_path)
+          @data_bags_path    = prepare_folders_config(@data_bags_path)
+          @nodes_path        = prepare_folders_config(@nodes_path)
+          @roles_path        = prepare_folders_config(@roles_path)
+          @environments_path = prepare_folders_config(@environments_path)
+        end
+
+        def validate(machine)
+          errors = validate_base(machine)
+
+          if !present?(Array(cookbooks_path))
+            errors << I18n.t("vagrant.config.chef.cookbooks_path_empty")
+          end
+
+          if environment && !present?(environments_path)
+            errors << I18n.t("vagrant.config.chef.environment_path_required")
+          end
+
+          environments_path.each do |type, raw_path|
+            next if type != :host
+
+            path = Pathname.new(raw_path).expand_path(machine.env.root_path)
+            if !path.directory?
+              errors << I18n.t("vagrant.config.chef.environment_path_missing",
+                path: raw_path.to_s
+              )
+            end
+          end
+
+          { "chef solo provisioner" => errors }
+        end
+
+        protected
+
+        # This takes any of the configurations that take a path or
+        # array of paths and turns it into the proper format.
+        #
+        # @return [Array]
+        def prepare_folders_config(config)
+          # Make sure the path is an array
+          config = [config] if !config.is_a?(Array) || config.first.is_a?(Symbol)
+
+          return [] if config.flatten.compact.empty?
+
+          # Make sure all the paths are in the proper format
+          config.map do |path|
+            path = [:host, path] if !path.is_a?(Array)
+            path
+          end
+        end
+      end
+    end
+  end
+end

data/plugins/provisioners/chef/config/chef_zero.rb

@@ -0,0 +1,133 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
+require "vagrant/util/presence"
+
+require_relative "chef_solo"
+
+module VagrantPlugins
+  module Chef
+    module Config
+      class ChefZero < BaseRunner
+        include Vagrant::Util::Presence
+
+        # The path on disk where Chef cookbooks are stored.
+        # Default is "cookbooks".
+        # @return [String]
+        attr_accessor :cookbooks_path
+
+        # The path where data bags are stored on disk.
+        # @return [String]
+        attr_accessor :data_bags_path
+
+        # The path where environments are stored on disk.
+        # @return [String]
+        attr_accessor :environments_path
+
+        # The path where nodes are stored on disk.
+        # @return [String]
+        attr_accessor :nodes_path
+
+        # The path where roles are stored on disk.
+        # @return [String]
+        attr_accessor :roles_path
+
+        # The type of synced folders to use.
+        # @return [String]
+        attr_accessor :synced_folder_type
+
+        def initialize
+          super
+
+          @cookbooks_path      = UNSET_VALUE
+          @data_bags_path      = UNSET_VALUE
+          @environments_path   = UNSET_VALUE
+          @nodes_path          = UNSET_VALUE
+          @roles_path          = UNSET_VALUE
+          @synced_folder_type  = UNSET_VALUE
+        end
+
+        def finalize!
+          super
+
+          @synced_folder_type = nil if @synced_folder_type == UNSET_VALUE
+
+          if @cookbooks_path == UNSET_VALUE
+            @cookbooks_path = []
+            @cookbooks_path << [:host, "cookbooks"] if !@recipe_url
+            @cookbooks_path << [:vm, "cookbooks"]
+          end
+
+          @data_bags_path    = [] if @data_bags_path == UNSET_VALUE
+          @nodes_path        = [] if @nodes_path == UNSET_VALUE
+          @roles_path        = [] if @roles_path == UNSET_VALUE
+          @environments_path = [] if @environments_path == UNSET_VALUE
+          @environments_path = [@environments_path].flatten
+
+          # Make sure the path is an array.
+          @cookbooks_path    = prepare_folders_config(@cookbooks_path)
+          @data_bags_path    = prepare_folders_config(@data_bags_path)
+          @nodes_path        = prepare_folders_config(@nodes_path)
+          @roles_path        = prepare_folders_config(@roles_path)
+          @environments_path = prepare_folders_config(@environments_path)
+
+        end
+
+        def validate(machine)
+          errors = validate_base(machine)
+
+          if !present?(Array(cookbooks_path))
+            errors << I18n.t("vagrant.config.chef.cookbooks_path_empty")
+          end
+
+          if !present?(Array(nodes_path))
+            errors << I18n.t("vagrant.config.chef.nodes_path_empty")
+          else
+            missing_paths = Array.new
+            nodes_path.each { |dir| missing_paths << dir[1] if !File.exist? dir[1] }
+            # If it exists at least one path on disk it's ok for Chef provisioning
+            if missing_paths.size == nodes_path.size
+              errors << I18n.t("vagrant.config.chef.nodes_path_missing", path: missing_paths.to_s)
+            end
+          end
+
+          if environment && environments_path.empty?
+            errors << I18n.t("vagrant.config.chef.environment_path_required")
+          end
+
+          environments_path.each do |type, raw_path|
+            next if type != :host
+
+            path = Pathname.new(raw_path).expand_path(machine.env.root_path)
+            if !path.directory?
+              errors << I18n.t("vagrant.config.chef.environment_path_missing",
+                path: raw_path.to_s
+              )
+            end
+          end
+
+          { "chef zero provisioner" => errors }
+        end
+
+        protected
+
+        # This takes any of the configurations that take a path or
+        # array of paths and turns it into the proper format.
+        #
+        # @return [Array]
+        def prepare_folders_config(config)
+          # Make sure the path is an array
+          config = [config] if !config.is_a?(Array) || config.first.is_a?(Symbol)
+
+          return [] if config.flatten.compact.empty?
+
+          # Make sure all the paths are in the proper format
+          config.map do |path|
+            path = [:host, File.expand_path(path)] if !path.is_a?(Array)
+            path
+          end
+        end
+      end
+    end
+  end
+end