test-kitchen 2.2.5 → 2.3.0

data/lib/kitchen/driver/ssh_base.rb

@@ -82,7 +82,7 @@ module Kitchen
           conn.execute(env_cmd(provisioner.run_command))
           info("Downloading files from #{instance.to_str}")
           provisioner[:downloads].to_h.each do |remotes, local|
-            debug("Downloading #{Array(remotes).join(', ')} to #{local}")
+            debug("Downloading #{Array(remotes).join(", ")} to #{local}")
             conn.download(remotes, local)
           end
           debug("Download complete")
@@ -136,13 +136,12 @@ module Kitchen
       # Package an instance.
       #
       # (see Base#package)
-      def package(state) # rubocop:disable Lint/UnusedMethodArgument
-      end
+      def package(state); end
 
       # (see Base#login_command)
       def login_command(state)
         instance.transport.connection(backcompat_merged_state(state))
-                .login_command
+          .login_command
       end
 
       # Executes an arbitrary command on an instance over an SSH connection.
@@ -179,8 +178,7 @@ module Kitchen
       #
       # @raise [UserError] if the driver will not be able to perform or if a
       #   documented dependency is missing from the system
-      def verify_dependencies
-      end
+      def verify_dependencies; end
 
       class << self
         # @return [Array<Symbol>] an array of action method names that cannot
@@ -207,7 +205,7 @@ module Kitchen
       # @param methods [Array<Symbol>] one or more actions as symbols
       # @raise [ClientError] if any method is not a valid action method name
       def self.no_parallel_for(*methods)
-        action_methods = [:create, :converge, :setup, :verify, :destroy]
+        action_methods = %i{create converge setup verify destroy}
 
         Array(methods).each do |meth|
           next if action_methods.include?(meth)
@@ -223,8 +221,7 @@ module Kitchen
       # that it can leverage it internally
       #
       # @return path [String] a path of the cache directory
-      def cache_directory
-      end
+      def cache_directory; end
 
       private
 
@@ -265,6 +262,7 @@ module Kitchen
       # rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity, Metrics/AbcSize
       def env_cmd(cmd)
         return if cmd.nil?
+
         env = "env"
         http_proxy = config[:http_proxy] || ENV["http_proxy"] ||
           ENV["HTTP_PROXY"]
@@ -343,7 +341,7 @@ module Kitchen
         pseudo_state.merge!(options)
 
         instance.transport.connection(backcompat_merged_state(pseudo_state))
-                .wait_until_ready
+          .wait_until_ready
       end
 
       # Intercepts any bare #puts calls in subclasses and issues an INFO log

data/lib/kitchen/generator/init.rb

@@ -29,29 +29,29 @@ module Kitchen
       include Thor::Actions
 
       class_option :driver,
-                   type: :array,
-                   aliases: "-D",
-                   default: %w{kitchen-vagrant},
-                   desc: <<-D.gsub(/^\s+/, "").tr("\n", " ")
+        type: :array,
+        aliases: "-D",
+        default: %w{kitchen-vagrant},
+        desc: <<-D.gsub(/^\s+/, "").tr("\n", " ")
           One or more Kitchen Driver gems to be installed or added to a
           Gemfile
-                   D
+        D
 
       class_option :provisioner,
-                   type: :string,
-                   aliases: "-P",
-                   default: "chef_solo",
-                   desc: <<-D.gsub(/^\s+/, "").tr("\n", " ")
+        type: :string,
+        aliases: "-P",
+        default: "chef_solo",
+        desc: <<-D.gsub(/^\s+/, "").tr("\n", " ")
           The default Kitchen Provisioner to use
-                   D
+        D
 
       class_option :create_gemfile,
-                   type: :boolean,
-                   default: false,
-                   desc: <<-D.gsub(/^\s+/, "").tr("\n", " ")
+        type: :boolean,
+        default: false,
+        desc: <<-D.gsub(/^\s+/, "").tr("\n", " ")
           Whether or not to create a Gemfile if one does not exist.
           Default: false
-                   D
+        D
 
       # Invoke the command.
       def init
@@ -80,10 +80,9 @@ module Kitchen
         driver_plugin = Array(options[:driver]).first || "dummy"
 
         template("kitchen.yml.erb", "kitchen.yml",
-                 driver_plugin: driver_plugin.sub(/^kitchen-/, ""),
-                 provisioner: options[:provisioner],
-                 run_list: Array(run_list)
-                )
+          driver_plugin: driver_plugin.sub(/^kitchen-/, ""),
+          provisioner: options[:provisioner],
+          run_list: Array(run_list))
       end
 
       # Creates the `chefignore` file.

data/lib/kitchen/instance.rb

@@ -217,7 +217,7 @@ module Kitchen
              transport.connection(state).login_command
            end
 
-      debug(%{Login command: #{lc.command} #{lc.arguments.join(' ')} } \
+      debug(%{Login command: #{lc.command} #{lc.arguments.join(" ")} } \
         "(Options: #{lc.options})")
       Kernel.exec(*lc.exec_args)
     end
@@ -252,9 +252,9 @@ module Kitchen
     # @return [Hash] a diagnostic hash
     def diagnose
       result = {}
-      [
-        :platform, :state_file, :driver, :provisioner, :transport, :verifier
-      ].each do |sym|
+      %i{
+        platform state_file driver provisioner transport verifier
+      }.each do |sym|
         obj = send(sym)
         result[sym] = obj.respond_to?(:diagnose) ? obj.diagnose : :unknown
       end
@@ -267,7 +267,7 @@ module Kitchen
     # @return [Hash] a diagnostic hash
     def diagnose_plugins
       result = {}
-      [:driver, :provisioner, :verifier, :transport].each do |sym|
+      %i{driver provisioner verifier transport}.each do |sym|
         obj = send(sym)
         result[sym] = if obj.respond_to?(:diagnose_plugin)
                         obj.diagnose_plugin
@@ -313,10 +313,10 @@ module Kitchen
     # @raise [ClientError] if any validations fail
     # @api private
     def validate_options(options)
-      [
-        :suite, :platform, :driver, :provisioner,
-        :transport, :verifier, :state_file
-      ].each do |k|
+      %i{
+        suite platform driver provisioner
+        transport verifier state_file
+      }.each do |k|
         next if options.key?(k)
 
         raise ClientError, "Instance#new requires option :#{k}"
@@ -521,12 +521,12 @@ module Kitchen
       state[:last_error] = e.class.name
       raise(InstanceFailure, failure_message(what) +
         "  Please see .kitchen/logs/#{name}.log for more details",
-            e.backtrace)
+        e.backtrace)
     rescue Exception => e # rubocop:disable Lint/RescueException
       log_failure(what, e)
       state[:last_error] = e.class.name
       raise ActionFailed,
-            "Failed to complete ##{what} action: [#{e.message}]", e.backtrace
+        "Failed to complete ##{what} action: [#{e.message}]", e.backtrace
     ensure
       state_file.write(state)
     end
@@ -681,7 +681,7 @@ module Kitchen
         end
       end
 
-      TRANSITIONS = [:destroy, :create, :converge, :setup, :verify].freeze
+      TRANSITIONS = %i{destroy create converge setup verify}.freeze
 
       # Determines the index of a state in the state lifecycle vector. Woah.
       #

data/lib/kitchen/lifecycle_hooks.rb

@@ -61,6 +61,7 @@ module Kitchen
       # No hooks? We're outta here.
       hook_data = Array(config[hook_key])
       return if hook_data.empty?
+
       hook_data.each do |hook|
         # Coerce the common case of a bare string to be a local command. This
         # is to match the behavior of the old `pre_create_command` semi-hook.

data/lib/kitchen/loader/yaml.rb

@@ -352,7 +352,14 @@ module Kitchen
       def parse_yaml_string(string, file_name)
         return {} if string.nil? || string.empty?
 
-        result = ::YAML.safe_load(string, [Symbol], [], true) || {}
+        result =
+          if Gem::Requirement.new(">= 3.1.0").satisfied_by?(Gem::Version.new(Psych::VERSION))
+            # ruby >= 2.6.0
+            ::YAML.safe_load(string, permitted_classes: [Symbol], permitted_symbols: [], aliases: true) || {}
+          else
+            # ruby < 2.6.0
+            ::YAML.safe_load(string, [Symbol], [], true) || {}
+          end
         unless result.is_a?(Hash)
           raise UserError, "Error parsing #{file_name} as YAML " \
             "(Result of parse was not a Hash, but was a #{result.class}).\n" \

data/lib/kitchen/plugin.rb

@@ -65,13 +65,13 @@ module Kitchen
     #   plugins of the given type
     def self.plugins_available(plugin_type)
       $LOAD_PATH.map { |load_path| Dir[File.expand_path("kitchen/#{plugin_type}/*.rb", load_path)] }
-                .reject { |plugin_paths| plugin_paths.empty? }
-                .flatten
-                .uniq
-                .select { |plugin_path| File.readlines(plugin_path).grep(/^\s*class \w* </).any? }
-                .map { |plugin_path| File.basename(plugin_path).gsub(/\.rb$/, "") }
-                .reject { |plugin_name| plugin_name == "base" }
-                .sort
+        .reject(&:empty?)
+        .flatten
+        .uniq
+        .select { |plugin_path| File.readlines(plugin_path).grep(/^\s*class \w* </).any? }
+        .map { |plugin_path| File.basename(plugin_path).gsub(/\.rb$/, "") }
+        .reject { |plugin_name| plugin_name == "base" }
+        .sort
     end
   end
 end

data/lib/kitchen/provisioner/base.rb

@@ -86,7 +86,7 @@ module Kitchen
           )
           info("Downloading files from #{instance.to_str}")
           config[:downloads].to_h.each do |remotes, local|
-            debug("Downloading #{Array(remotes).join(', ')} to #{local}")
+            debug("Downloading #{Array(remotes).join(", ")} to #{local}")
             conn.download(remotes, local)
           end
           debug("Download complete")
@@ -108,16 +108,14 @@ module Kitchen
       # Certain products that Test Kitchen uses to provision require accepting
       # a license to use. Overwrite this method in the specific provisioner
       # to implement this check.
-      def check_license
-      end
+      def check_license; end
 
       # Generates a command string which will install and configure the
       # provisioner software on an instance. If no work is required, then `nil`
       # will be returned.
       #
       # @return [String] a command string
-      def install_command
-      end
+      def install_command; end
 
       # Generates a command string which will perform any data initialization
       # or configuration required after the provisioner software is installed
@@ -125,8 +123,7 @@ module Kitchen
       # is required, then `nil` will be returned.
       #
       # @return [String] a command string
-      def init_command
-      end
+      def init_command; end
 
       # Generates a command string which will perform any commands or
       # configuration required just before the main provisioner run command but
@@ -134,16 +131,14 @@ module Kitchen
       # required, then `nil` will be returned.
       #
       # @return [String] a command string
-      def prepare_command
-      end
+      def prepare_command; end
 
       # Generates a command string which will invoke the main provisioner
       # command on the prepared instance. If no work is required, then `nil`
       # will be returned.
       #
       # @return [String] a command string
-      def run_command
-      end
+      def run_command; end
 
       # Creates a temporary directory on the local workstation into which
       # provisioner related files and directories can be copied or created. The

data/lib/kitchen/provisioner/chef/berkshelf.rb

@@ -108,7 +108,7 @@ module Kitchen
               " `gem install berkshelf` or add the following to your" \
               " Gemfile if you are using Bundler: `gem 'berkshelf'`.")
             raise UserError,
-                  "Could not load or activate Berkshelf (#{e.message})"
+              "Could not load or activate Berkshelf (#{e.message})"
           end
         end
       end

data/lib/kitchen/provisioner/chef/common_sandbox.rb

@@ -81,7 +81,7 @@ module Kitchen
         # @api private
         def all_files_in_cookbooks
           Util.list_directory(tmpbooks_dir, include_dot: true, recurse: true)
-             .select { |fn| File.file?(fn) }
+            .select { |fn| File.file?(fn) }
         end
 
         # @return [String] an absolute path to a Policyfile, relative to the
@@ -89,14 +89,15 @@ module Kitchen
         # @api private
         def policyfile
           basename = config[:policyfile_path] || config[:policyfile] || "Policyfile.rb"
-          File.join(config[:kitchen_root], basename)
+          File.expand_path(basename, config[:kitchen_root])
         end
 
         # @return [String] an absolute path to a Berksfile, relative to the
         #   kitchen root
         # @api private
         def berksfile
-          File.join(config[:kitchen_root], "Berksfile")
+          basename = config[:berksfile_path] || "Berksfile"
+          File.expand_path(basename, config[:kitchen_root])
         end
 
         # @return [String] an absolute path to a cookbooks/ directory, relative
@@ -140,8 +141,8 @@ module Kitchen
           debug("Using metadata.rb from #{metadata_rb}")
 
           cb_name = MetadataChopper.extract(metadata_rb).first || raise(UserError,
-                                                                        "The metadata.rb does not define the 'name' key." \
-                                                                          " Please add: `name '<cookbook_name>'` to metadata.rb and retry")
+            "The metadata.rb does not define the 'name' key." \
+              " Please add: `name '<cookbook_name>'` to metadata.rb and retry")
 
           cb_path = File.join(tmpbooks_dir, cb_name)
 
@@ -287,8 +288,8 @@ module Kitchen
             warn("Ignored run_list: #{config[:run_list].inspect}")
           end
           policy = Chef::Policyfile.new(policyfile, sandbox_path,
-                                        logger: logger,
-                                        always_update: config[:always_update_cookbooks])
+            logger: logger,
+            always_update: config[:always_update_cookbooks])
           Kitchen.mutex.synchronize do
             policy.compile
           end
@@ -303,8 +304,8 @@ module Kitchen
         def resolve_with_policyfile
           Kitchen.mutex.synchronize do
             Chef::Policyfile.new(policyfile, sandbox_path,
-                                 logger: logger,
-                                 always_update: config[:always_update_cookbooks]).resolve
+              logger: logger,
+              always_update: config[:always_update_cookbooks]).resolve
           end
         end
 
@@ -314,8 +315,8 @@ module Kitchen
         def resolve_with_berkshelf
           Kitchen.mutex.synchronize do
             Chef::Berkshelf.new(berksfile, tmpbooks_dir,
-                                logger: logger,
-                                always_update: config[:always_update_cookbooks]).resolve
+              logger: logger,
+              always_update: config[:always_update_cookbooks]).resolve
           end
         end
 

data/lib/kitchen/provisioner/chef/policyfile.rb

@@ -143,7 +143,7 @@ module Kitchen
                           "from https://downloads.chef.io and that your PATH " \
                           "setting includes the path to the `chef` comand.")
               raise UserError,
-                    "Could not find the chef executable in your PATH."
+                "Could not find the chef executable in your PATH."
             end
           end
         end

data/lib/kitchen/provisioner/chef_apply.rb

@@ -100,7 +100,7 @@ module Kitchen
         lines = []
         config[:run_list].map do |recipe|
           cmd = sudo(config[:chef_apply_path]).dup
-                                              .tap { |str| str.insert(0, "& ") if powershell_shell? }
+            .tap { |str| str.insert(0, "& ") if powershell_shell? }
           args = [
             "apply/#{recipe}.rb",
             "--log_level #{level}",

data/lib/kitchen/provisioner/chef_base.rb

@@ -59,6 +59,9 @@ module Kitchen
       # Will try to autodetect by searching for `Policyfile.rb` if not set.
       # If set, will error if the file doesn't exist.
       default_config :policyfile_path, nil
+      # Will try to autodetect by searching for `Berksfile` if not set.
+      # If set, will error if the file doesn't exist.
+      default_config :berksfile_path, nil
       # If set to true (which is the default from `chef generate`), try to update
       # backend cookbook downloader on every kitchen run.
       default_config :always_update_cookbooks, false
@@ -262,9 +265,24 @@ module Kitchen
         end
       end
 
+      # If the user has policyfiles we shell out to the `chef` executable, so need to ensure they have
+      # accepted the Chef Workstation license. Otherwise they just need the Chef Infra license.
+      #
+      # @return [String] license id to prompt for acceptance
+      def license_acceptance_id
+        case
+          when File.exist?(policyfile)
+            "chef-workstation"
+          when config[:product_name]
+            config[:product_name]
+          else
+            "chef"
+        end
+      end
+
       # (see Base#check_license)
       def check_license
-        name = config[:product_name] || "chef"
+        name = license_acceptance_id
         version = product_version
         debug("Checking if we need to prompt for license acceptance on product: #{name} version: #{version}.")
 
@@ -309,6 +327,7 @@ module Kitchen
       def install_command
         return unless config[:require_chef_omnibus] || config[:product_name]
         return if config[:product_name] && config[:install_strategy] == "skip"
+
         prefix_command(sudo(install_script_contents))
       end
 
@@ -330,7 +349,7 @@ module Kitchen
           sudo_command: sudo_command,
         }.tap do |opts|
           opts[:root] = config[:chef_omnibus_root] if config.key? :chef_omnibus_root
-          [:install_msi_url, :http_proxy, :https_proxy].each do |key|
+          %i{install_msi_url http_proxy https_proxy}.each do |key|
             opts[key] = config[key] if config.key? key
           end
         end
@@ -354,14 +373,15 @@ module Kitchen
       # @api private
       def policyfile
         policyfile_basename = config[:policyfile_path] || config[:policyfile] || "Policyfile.rb"
-        File.join(config[:kitchen_root], policyfile_basename)
+        File.expand_path(policyfile_basename, config[:kitchen_root])
       end
 
       # @return [String] an absolute path to a Berksfile, relative to the
       #   kitchen root
       # @api private
       def berksfile
-        File.join(config[:kitchen_root], "Berksfile")
+        berksfile_basename = config[:berksfile_path] || config[:berksfile] || "Berksfile"
+        File.expand_path(berksfile_basename, config[:kitchen_root])
       end
 
       # Generates a Hash with default values for a solo.rb or client.rb Chef
@@ -423,7 +443,7 @@ module Kitchen
         elsif obj.is_a?(String)
           %{"#{obj.gsub(/\\/, '\\\\\\\\')}"}
         elsif obj.is_a?(Array)
-          %{[#{obj.map { |i| format_value(i) }.join(', ')}]}
+          %{[#{obj.map { |i| format_value(i) }.join(", ")}]}
         else
           obj.inspect
         end
@@ -449,7 +469,7 @@ module Kitchen
       # @api private
       def init_command_vars_for_powershell(dirs)
         [
-          %{$dirs = @(#{dirs.map { |d| %{"#{d}"} }.join(', ')})},
+          %{$dirs = @(#{dirs.map { |d| %{"#{d}"} }.join(", ")})},
           shell_var("root_path", config[:root_path]),
         ].join("\n")
       end
@@ -492,7 +512,7 @@ module Kitchen
           },
         }.tap do |opts|
           opts[:shell_type] = :ps1 if powershell_shell?
-          [:platform, :platform_version, :architecture].each do |key|
+          %i{platform platform_version architecture}.each do |key|
             opts[key] = config[key] if config[key]
           end
 
@@ -507,12 +527,12 @@ module Kitchen
           end
 
           proxies = {}.tap do |prox|
-            [:http_proxy, :https_proxy, :ftp_proxy, :no_proxy].each do |key|
+            %i{http_proxy https_proxy ftp_proxy no_proxy}.each do |key|
               prox[key] = config[key] if config[key]
             end
 
             # install.ps1 only supports http_proxy
-            prox.delete_if { |p| [:https_proxy, :ftp_proxy, :no_proxy].include?(p) } if powershell_shell?
+            prox.delete_if { |p| %i{https_proxy ftp_proxy no_proxy}.include?(p) } if powershell_shell?
           end
 
           opts[:install_command_options].merge!(proxies)
@@ -546,7 +566,8 @@ module Kitchen
       # @api private
       def script_for_omnibus_version
         installer = Mixlib::Install::ScriptGenerator.new(
-          config[:require_chef_omnibus], powershell_shell?, install_options)
+          config[:require_chef_omnibus], powershell_shell?, install_options
+        )
         config[:chef_omnibus_root] = installer.root
         installer.install_command
       end
@@ -567,13 +588,18 @@ module Kitchen
         if (config[:policyfile_path] || config[:policyfile]) && !File.exist?(policyfile)
           raise UserError, "policyfile_path set in config "\
             "(#{config[:policyfile_path]} could not be found. " \
-            "Expected to find it at full path #{policyfile} " \
+            "Expected to find it at full path #{policyfile}."
+        end
+        if config[:berksfile_path] && !File.exist?(berksfile)
+          raise UserError, "berksfile_path set in config "\
+            "(#{config[:berksfile_path]} could not be found. " \
+            "Expected to find it at full path #{berksfile}."
         end
         if File.exist?(policyfile) && !supports_policyfile?
           raise UserError, "policyfile detected, but provisioner " \
             "#{self.class.name} doesn't support Policyfiles. " \
             "Either use a different provisioner, or delete/rename " \
-            "#{policyfile}"
+            "#{policyfile}."
         end
       end