test-kitchen 2.7.1 → 2.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ae69102eac88b3cbb40ad7e39b02fd2a1519e8f9ed9d114fa1c0d4c0ea7319d
-  data.tar.gz: 48bf850ca5c79fcb0b7af6cc7fce89b05d1c735ad51c80e224285c50581576bd
+  metadata.gz: 36e340a7aefc9e4512f05ded9b43003298a3466de705d7c6c6050dd07f433175
+  data.tar.gz: 310ae63b637cbd62a88cd5beef8effa437f0d1b2dec6bf9098ba3112e621c8ed
 SHA512:
-  metadata.gz: 9164957f96d9e93b04a4a9e32ac475d9b0e239f1e900d02660fa286d4625e312f7d1b47ab5cfa7136b91e514e826f6c915fb9dcc8a56677915714ce9106b6366
-  data.tar.gz: 3a0968bbe24c08505b12c8bfe3900c450c5f00bc35c3821db18b3535a891256ac9093f2f472a02bcbc7179d0b24f0c87f3a8237e185e87d39b0d741c98629738
+  metadata.gz: cc3e9bf0e55d519d757e4339b4e643f038216dedb573225aed9cc1ce2972ad121e7819db643e26e4038ebe5fc05e2bc0a57435588d462bf2d2a4a198cbd0b9b1
+  data.tar.gz: 48c9bc01e69691e4096f5ae219638b0d996f069852c3ac14ec143ce583c3f6f610263000e5b24256b3b969314c9903e95b570372c1d3a8d3298d3ba4c65885bd

data/Gemfile

@@ -1,4 +1,6 @@
 source "https://rubygems.org"
+
+# Specify your gem"s dependencies in test-kitchen.gemspec
 gemspec
 
 group :integration do
@@ -8,10 +10,6 @@ group :integration do
   gem "kitchen-vagrant"
 end
 
-group :changelog do
-  gem "github_changelog_generator", "1.15.2"
-end
-
 group :debug do
   gem "pry"
   gem "pry-byebug"
@@ -19,9 +17,5 @@ group :debug do
 end
 
 group :chefstyle do
-  gem "chefstyle"
-end
-
-group :docs do
-  gem "yard"
-end
+  gem "chefstyle", "1.6.2"
+end

data/Rakefile

@@ -41,30 +41,8 @@ end
 desc "Run all quality tasks"
 task quality: %i{style stats}
 
-begin
-  require "yard" unless defined?(YARD)
-  YARD::Rake::YardocTask.new
-rescue LoadError
-  puts "yard is not available. (sudo) gem install yard to generate yard documentation."
-end
-
 task default: %i{test quality}
 
-begin
-  require "github_changelog_generator/task"
-  require "kitchen/version"
-
-  GitHubChangelogGenerator::RakeTask.new :changelog do |config|
-    config.future_release = "v#{Kitchen::VERSION}"
-    config.enhancement_labels = "enhancement,Enhancement,New Feature,Feature,Improvement".split(",")
-    config.bug_labels = "bug,Bug".split(",")
-    config.exclude_labels = %w{Duplicate Question Discussion No_Changelog}
-  end
-rescue LoadError
-  puts "github_changelog_generator is not available." \
-       " (sudo) gem install github_changelog_generator to generate changelogs"
-end
-
 namespace :docs do
   desc "Deploy docs"
   task :deploy do

data/lib/kitchen.rb

@@ -16,8 +16,6 @@
 # limitations under the License.
 
 require "pathname" unless defined?(Pathname)
-require "thread"
-
 require_relative "kitchen/errors"
 require_relative "kitchen/logger"
 require_relative "kitchen/logging"
@@ -67,7 +65,7 @@ module Kitchen
     #
     # @return [Pathname] root path of gem
     def source_root
-      @source_root ||= Pathname.new(File.expand_path("../../", __FILE__))
+      @source_root ||= Pathname.new(File.expand_path("..", __dir__))
     end
 
     # Returns a default logger which emits on standard output.

data/lib/kitchen/chef_utils_wiring.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+#
+# Copyright:: Copyright (c) Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module Kitchen
+  # Common Dependency Injection wiring for ChefUtils-related modules
+  module ChefUtilsWiring
+    private
+
+    def __config
+      # this would need to be some kind of Chef::Config looking thing, which probably requires
+      # a translation object from t-k config to Chef::Config layout if that ever becomes necessary.
+      # this ISNT the t-k config.
+      {}
+    end
+
+    def __log
+      @logger
+    end
+
+    def __transport_connection
+      # this could be wired up to train at some point, but need to be careful because about local vs. remote
+      # uses of helpers with test-kitchen, right now we're using it for local.
+    end
+  end
+end

data/lib/kitchen/cli.rb

@@ -16,7 +16,7 @@
 # limitations under the License.
 
 # CI tests fail without an explicit unconditional require of Thor
-require "thor" # rubocop:disable ChefRuby/UnlessDefinedRequire
+require "thor" # rubocop:disable Chef/Ruby/UnlessDefinedRequire
 
 require_relative "../kitchen"
 require_relative "generator/init"
@@ -162,7 +162,7 @@ module Kitchen
       long_desc <<-DESC
         The instance states are in order: destroy, create, converge, setup, verify, destroy.
         Change one or more instances from the current state to the #{action} state. Actions for all
-        intermediate states will be executed. See http://kitchen.ci for further explanation.
+        intermediate states will be executed. See https://kitchen.ci/ for further explanation.
       DESC
       method_option :concurrency,
         aliases: "-c",

data/lib/kitchen/command.rb

@@ -15,8 +15,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "thread"
-
 module Kitchen
   module Command
     # Base class for CLI commands.

data/lib/kitchen/command/diagnose.rb

@@ -18,7 +18,7 @@
 require_relative "../command"
 require_relative "../diagnostic"
 
-require "yaml" unless defined?(YAML)
+autoload :YAML, "yaml"
 
 module Kitchen
   module Command
@@ -32,9 +32,9 @@ module Kitchen
 
         loader = record_failure { load_loader }
 
-        puts Kitchen::Diagnostic.new(
+        puts YAML.dump(Kitchen::Diagnostic.new(
           loader: loader, instances: instances, plugins: plugins?
-        ).read.to_yaml
+        ).read)
       end
 
       private

data/lib/kitchen/config.rb

@@ -213,7 +213,7 @@ module Kitchen
           provisioner: Provisioner::DEFAULT_PLUGIN,
           verifier: Verifier::DEFAULT_PLUGIN,
           transport: lambda do |_suite, platform|
-            platform =~ /^win/i ? "winrm" : Transport::DEFAULT_PLUGIN
+            /^win/i.match?(platform) ? "winrm" : Transport::DEFAULT_PLUGIN
           end,
         },
         kitchen_root: kitchen_root,
@@ -244,16 +244,18 @@ module Kitchen
     # @return [Instance] a new Instance object
     # @api private
     def new_instance(suite, platform, index)
+      sf = new_state_file(suite, platform)
+
       Instance.new(
         driver: new_driver(suite, platform),
-        lifecycle_hooks: new_lifecycle_hooks(suite, platform),
+        lifecycle_hooks: new_lifecycle_hooks(suite, platform, sf),
         logger: new_instance_logger(suite, platform, index),
         suite: suite,
         platform: platform,
         provisioner: new_provisioner(suite, platform),
         transport: new_transport(suite, platform),
         verifier: new_verifier(suite, platform),
-        state_file: new_state_file(suite, platform)
+        state_file: sf
       )
     end
 
@@ -284,11 +286,12 @@ module Kitchen
     #
     # @param suite [Suite,#name] a Suite
     # @param platform [Platform,#name] a Platform
+    # @param state_file [Kitchen::StateFile] a SateFile
     # @return [LifecycleHooks] a new LifecycleHooks object
     # @api private
-    def new_lifecycle_hooks(suite, platform)
+    def new_lifecycle_hooks(suite, platform, state_file)
       lhdata = data.lifecycle_hooks_data_for(suite.name, platform.name)
-      LifecycleHooks.new(lhdata)
+      LifecycleHooks.new(lhdata, state_file)
     end
 
     # Builds a newly configured Provisioner object, for a given Suite and

data/lib/kitchen/lifecycle_hook/base.rb

@@ -0,0 +1,78 @@
+module Kitchen
+  class LifecycleHook
+    class Base
+      # @return [Kitchen::LifecycleHooks]
+      attr_reader :lifecycle_hooks
+
+      # return [String]
+      attr_reader :phase
+
+      # return [Hash]
+      attr_reader :hook
+
+      # @param lifecycle_hooks [Kitchen::LifecycleHooks]
+      # @param phase [String]
+      # @param hook [Hash]
+      def initialize(lifecycle_hooks, phase, hook)
+        @lifecycle_hooks = lifecycle_hooks
+        @phase = phase
+        @hook = hook
+      end
+
+      # return [void]
+      def run
+        raise NotImplementedError
+      end
+
+      # @return [TrueClass, FalseClass]
+      def should_run?
+        if !includes.empty?
+          includes.include?(platform_name)
+        elsif !excludes.empty?
+          !excludes.include?(platform_name)
+        else
+          true
+        end
+      end
+
+      # @return [Logger] the lifecycle hooks's logger
+      #   otherwise
+      # @api private
+      def logger
+        lifecycle_hooks.send(:logger)
+      end
+
+      private
+
+      # @return [Kitchen::Instance]
+      def instance
+        lifecycle_hooks.instance
+      end
+
+      # @return [Hash]
+      def config
+        lifecycle_hooks.send(:config)
+      end
+
+      # @return [Kitchen::StateFile]
+      def state_file
+        lifecycle_hooks.state_file
+      end
+
+      # @return [Array<String>] names of excluded platforms
+      def excludes
+        @excludes ||= hook.fetch(:excludes, [])
+      end
+
+      # @return [Array<String>] names of only included platforms
+      def includes
+        @includes ||= hook.fetch(:includes, [])
+      end
+
+      # @return [String]
+      def platform_name
+        instance.platform.name
+      end
+    end
+  end
+end

data/lib/kitchen/lifecycle_hook/local.rb

@@ -0,0 +1,53 @@
+require_relative "base"
+require_relative "../shell_out"
+require_relative "../logging"
+
+module Kitchen
+  class LifecycleHook
+    class Local < Base
+      include ShellOut
+      include Logging
+
+      # Execute a specific local command hook.
+      #
+      # @return [void]
+      def run
+        state = state_file.read
+        # set up empty user variable
+        user = {}
+        # Set up some environment variables with instance info.
+        environment = {
+          "KITCHEN_INSTANCE_NAME" => instance.name,
+          "KITCHEN_SUITE_NAME" => instance.suite.name,
+          "KITCHEN_PLATFORM_NAME" => instance.platform.name,
+          "KITCHEN_INSTANCE_HOSTNAME" => state[:hostname].to_s,
+        }
+        # If the user specified env vars too, fix them up because symbol keys
+        # make mixlib-shellout sad.
+        hook[:environment]&.each do |k, v|
+          environment[k.to_s] = v.to_s
+        end
+
+        # add user to user hash for later merging
+        user[:user] = hook[:user] if hook[:user]
+
+        # Default the cwd to the kitchen root and resolve a relative input cwd against that.
+        cwd = if hook[:cwd]
+                File.expand_path(hook[:cwd], config[:kitchen_root])
+              else
+                config[:kitchen_root]
+              end
+        # Build the options for mixlib-shellout.
+        opts = {}.merge(user).merge(cwd: cwd, environment: environment)
+        run_command(command, opts)
+      end
+
+      private
+
+      # @return [String]
+      def command
+        hook.fetch(:local)
+      end
+    end
+  end
+end

data/lib/kitchen/lifecycle_hook/remote.rb

@@ -0,0 +1,33 @@
+require_relative "base"
+require_relative "../errors"
+
+module Kitchen
+  class LifecycleHook
+    class Remote < Base
+      # Execute a specific remote command hook.
+      #
+      # @return [void]
+      def run
+        # Check if we're in a state that makes sense to even try.
+        unless instance.last_action
+          if hook[:skippable]
+            # Just not even trying.
+            return
+          else
+            raise UserError, "Cannot use remote lifecycle hooks during phases when the instance is not available"
+          end
+        end
+
+        conn = instance.transport.connection(state_file.read)
+        conn.execute(command)
+      end
+
+      private
+
+      # return [String]
+      def command
+        hook.fetch(:remote)
+      end
+    end
+  end
+end

data/lib/kitchen/lifecycle_hooks.rb

@@ -15,8 +15,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require_relative "configurable"
 require_relative "errors"
-require_relative "shell_out"
+require_relative "lifecycle_hook/local"
+require_relative "lifecycle_hook/remote"
+require_relative "logging"
 
 module Kitchen
   # A helper object used by {Instance} to coordinate lifecycle hook calls from
@@ -27,10 +30,10 @@ module Kitchen
   class LifecycleHooks
     include Configurable
     include Logging
-    include ShellOut
 
-    def initialize(config)
+    def initialize(config, state_file)
       init_config(config)
+      @state_file = state_file
     end
 
     # Run a lifecycle phase with the pre and post hooks.
@@ -40,21 +43,22 @@ module Kitchen
     # @param block [Proc] Block of code implementing the lifecycle phase.
     # @return [void]
     def run_with_hooks(phase, state_file, &block)
-      run(instance, phase, state_file, :pre)
+      run(phase, :pre)
       yield
-      run(instance, phase, state_file, :post)
+      run(phase, :post)
     end
 
+    # @return [Kitchen::StateFile]
+    attr_reader :state_file
+
     private
 
     # Execute a specific lifecycle hook.
     #
-    # @param instance [Instance] The instance object to run against.
     # @param phase [String] Lifecycle phase which is being executed.
-    # @param state_file [StateFile] Instance state file object.
     # @param hook_timing [Symbol] `:pre` or `:post` to indicate which hook to run.
     # @return [void]
-    def run(instance, phase, state_file, hook_timing)
+    def run(phase, hook_timing)
       # Yes this has to be a symbol because of how data munger works.
       hook_key = :"#{hook_timing}_#{phase}"
       # No hooks? We're outta here.
@@ -65,80 +69,24 @@ module Kitchen
         # 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.
         hook = { local: hook } if hook.is_a?(String)
-        if hook.include?(:local)
-          # Local command execution on the workstation.
-          run_local_hook(instance, state_file, hook)
-        elsif hook.include?(:remote)
-          # Remote command execution on the test instance.
-          run_remote_hook(instance, state_file, hook)
-        else
-          raise UserError, "Unknown lifecycle hook target #{hook.inspect}"
-        end
+        hook = generate_hook(phase, hook)
+        hook.run if hook.should_run?
       end
     end
 
-    # Execute a specific local command hook.
-    #
-    # @param instance [Instance] The instance object to run against.
-    # @param state_file [StateFile] Instance state file object.
-    # @param hook [Hash] Hook configration to use.
-    # @return [void]
-    def run_local_hook(instance, state_file, hook)
-      cmd = hook.fetch(:local)
-      state = state_file.read
-      # set up empty user variable
-      user = {}
-      # Set up some environment variables with instance info.
-      environment = {
-        "KITCHEN_INSTANCE_NAME" => instance.name,
-        "KITCHEN_SUITE_NAME" => instance.suite.name,
-        "KITCHEN_PLATFORM_NAME" => instance.platform.name,
-        "KITCHEN_INSTANCE_HOSTNAME" => state[:hostname].to_s,
-      }
-      # If the user specified env vars too, fix them up because symbol keys
-      # make mixlib-shellout sad.
-      if hook[:environment]
-        hook[:environment].each do |k, v|
-          environment[k.to_s] = v.to_s
-        end
-      end
-
-      # add user to user hash for later merging
-      if hook[:user]
-        user[:user] = hook[:user]
+    # @param phase [String]
+    # @param hook [Hash]
+    # @return [Kitchen::LifecycleHook::Local, Kitchen::LifecycleHook::Remote]
+    def generate_hook(phase, hook)
+      if hook.include?(:local)
+        # Local command execution on the workstation.
+        Kitchen::LifecycleHook::Local.new(self, phase, hook)
+      elsif hook.include?(:remote)
+        # Remote command execution on the test instance.
+        Kitchen::LifecycleHook::Remote.new(self, phase, hook)
+      else
+        raise UserError, "Unknown lifecycle hook target #{hook.inspect}"
       end
-
-      # Default the cwd to the kitchen root and resolve a relative input cwd against that.
-      cwd = if hook[:cwd]
-              File.expand_path(hook[:cwd], config[:kitchen_root])
-            else
-              config[:kitchen_root]
-            end
-      # Build the options for mixlib-shellout.
-      opts = {}.merge(user).merge(cwd: cwd, environment: environment)
-      run_command(cmd, opts)
-    end
-
-    # Execute a specific remote command hook.
-    #
-    # @param instance [Instance] The instance object to run against.
-    # @param state_file [StateFile] Instance state file object.
-    # @param hook [Hash] Hook configration to use.
-    # @return [void]
-    def run_remote_hook(instance, state_file, hook)
-      # Check if we're in a state that makes sense to even try.
-      unless instance.last_action
-        if hook[:skippable]
-          # Just not even trying.
-          return
-        else
-          raise UserError, "Cannot use remote lifecycle hooks during phases when the instance is not available"
-        end
-      end
-
-      cmd = hook.fetch(:remote)
-      conn = instance.transport.connection(state_file.read)
-      conn.execute(cmd)
     end
   end
 end

data/lib/kitchen/loader/yaml.rb

@@ -17,6 +17,7 @@
 
 require "erb" unless defined?(Erb)
 require_relative "../../vendor/hash_recursive_merge"
+require "psych" unless defined?(Psych)
 require "yaml" unless defined?(YAML)
 
 module Kitchen

data/lib/kitchen/provisioner/base.rb

@@ -51,6 +51,7 @@ module Kitchen
 
       default_config :command_prefix, nil
 
+      default_config :uploads, {}
       default_config :downloads, {}
 
       expand_path_for :test_base_path
@@ -72,6 +73,10 @@ module Kitchen
         sandbox_dirs = Util.list_directory(sandbox_path)
 
         instance.transport.connection(state) do |conn|
+          config[:uploads].to_h.each do |locals, remote|
+            debug("Uploading #{Array(locals).join(", ")} to #{remote}")
+            conn.upload(locals.to_s, remote)
+          end
           conn.execute(install_command)
           conn.execute(init_command)
           info("Transferring files to #{instance.to_str}")

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

@@ -21,6 +21,7 @@ require "rbconfig" unless defined?(RbConfig)
 require_relative "../../errors"
 require_relative "../../logging"
 require_relative "../../shell_out"
+require_relative "../../which"
 
 module Kitchen
   module Provisioner
@@ -31,6 +32,7 @@ module Kitchen
       class Policyfile
         include Logging
         include ShellOut
+        include Which
 
         # Creates a new cookbook resolver.
         #
@@ -40,9 +42,9 @@ module Kitchen
         # @param logger [Kitchen::Logger] a logger to use for output, defaults
         #   to `Kitchen.logger`
         def initialize(policyfile, path, logger: Kitchen.logger, always_update: false)
-          @policyfile = policyfile
-          @path       = path
-          @logger     = logger
+          @policyfile    = policyfile
+          @path          = path
+          @logger        = logger
           @always_update = always_update
         end
 
@@ -51,30 +53,29 @@ module Kitchen
         # @param logger [Kitchen::Logger] a logger to use for output, defaults
         #   to `Kitchen.logger`
         def self.load!(logger: Kitchen.logger)
-          detect_chef_command!(logger)
+          # intentionally left blank
         end
 
         # Performs the cookbook resolution and vendors the resulting cookbooks
         # in the desired path.
         def resolve
-          info("Exporting cookbook dependencies from Policyfile #{path}...")
-          run_command("chef export #{escape_path(policyfile)} #{escape_path(path)} --force")
+          info("Exporting cookbook dependencies from Policyfile #{path} using `#{cli_path} export`...")
+          run_command("#{cli_path} export #{escape_path(policyfile)} #{escape_path(path)} --force")
         end
 
         # Runs `chef install` to determine the correct cookbook set and
         # generate the policyfile lock.
         def compile
           if File.exist?(lockfile)
-            info("Installing cookbooks for Policyfile #{policyfile} using `chef install`")
+            info("Installing cookbooks for Policyfile #{policyfile} using `#{cli_path} install`")
           else
-            info("Policy lock file doesn't exist, running `chef install` for "\
-                 "Policyfile #{policyfile}...")
+            info("Policy lock file doesn't exist, running `#{cli_path} install` for Policyfile #{policyfile}...")
           end
-          run_command("chef install #{escape_path(policyfile)}")
+          run_command("#{cli_path} install #{escape_path(policyfile)}")
 
           if always_update
-            info("Updating policy lock using `chef update`")
-            run_command("chef update #{escape_path(policyfile)}")
+            info("Updating policy lock using `#{cli_path} update`")
+            run_command("#{cli_path} update #{escape_path(policyfile)}")
           end
         end
 
@@ -110,13 +111,13 @@ module Kitchen
         # @return [String]
         # @api private
         def escape_path(path)
-          if RbConfig::CONFIG["host_os"] =~ /mswin|mingw/
+          if /mswin|mingw/.match?(RbConfig::CONFIG["host_os"])
             # I know what you're thinking: "just use Shellwords.escape". That
             # method produces incorrect results on Windows with certain input
             # which would be a metacharacter in Sh but is not for one or more of
             # Windows command line parsing libraries. This covers the 99% case of
             # spaces in the path without breaking other stuff.
-            if path =~ /[ \t\n\v"]/
+            if /[ \t\n\v"]/.match?(path)
               "\"#{path.gsub(/[ \t\n\v\"\\]/) { |m| '\\' + m[0] }}\""
             else
               path
@@ -126,33 +127,24 @@ module Kitchen
           end
         end
 
-        class << self
-          private
-
-          # Ensure the `chef` command is in the path.
-          #
-          # @param logger [Kitchen::Logger] the logger to use
-          # @raise [UserError] if the `chef` command is not in the PATH
-          # @api private
-          def detect_chef_command!(logger)
-            unless ENV["PATH"].split(File::PATH_SEPARATOR).any? do |path|
-              if RbConfig::CONFIG["host_os"] =~ /mswin|mingw/
-                # Windows could have different extentions: BAT, EXE or NONE
-                %w{chef chef.exe chef.bat}.each do |bin|
-                  File.exist?(File.join(path, bin))
-                end
-              else
-                File.exist?(File.join(path, "chef"))
-              end
-            end
-              logger.fatal("The `chef` executable cannot be found in your " \
-                          "PATH. Ensure you have installed ChefDK or Chef Workstation " \
-                          "from https://downloads.chef.io and that your PATH " \
-                          "setting includes the path to the `chef` command.")
-              raise UserError,
-                "Could not find the chef executable in your PATH."
-            end
-          end
+        # Find the `chef` or `chef-cli` commands in the path or raise `chef` is present in
+        # ChefDK / Workstation releases, but is no longer shipped in any gems now that we
+        # use a Go based wrapper for the `chef` command in Workstation. The Ruby CLI has been
+        # renamed `chef-cli` under the hood and is shipped in the `chef-cli` gem.
+        #
+        # @api private
+        # @returns [String]
+        def cli_path
+          @cli_path ||= which("chef-cli") || which("chef") || no_cli_found_error
+        end
+
+        # @api private
+        def no_cli_found_error
+          @logger.fatal("The `chef` or `chef-cli` executables cannot be found in your " \
+                        "PATH. Ensure you have installed Chef Workstation " \
+                        "from https://downloads.chef.io and that your PATH " \
+                        "setting includes the path to the `chef` or `chef-cli` commands.")
+          raise UserError, "Could not find the chef or chef-cli executables in your PATH."
         end
 
       end

data/lib/kitchen/provisioner/chef_base.rb

@@ -156,7 +156,7 @@ module Kitchen
               product_name: <chef or chef-workstation>
               install_strategy: skip
           MSG
-        when provisioner[:require_chef_omnibus].to_s.match(/\d/)
+        when provisioner[:require_chef_omnibus].to_s.match?(/\d/)
           Util.outdent!(<<-MSG)
             The 'require_chef_omnibus' attribute with version values will change
             to use the new 'product_version' attribute.

data/lib/kitchen/transport/exec.rb

@@ -28,7 +28,7 @@ module Kitchen
       plugin_version Kitchen::VERSION
 
       def connection(state, &block)
-        options = config.to_hash.merge(state)
+        options = connection_options(config.to_hash.merge(state))
         Kitchen::Transport::Exec::Connection.new(options, &block)
       end
 
@@ -40,19 +40,105 @@ module Kitchen
         def execute(command)
           return if command.nil?
 
-          run_command(command)
+          if host_os_windows?
+            run_command(run_from_file_command(command))
+            close
+          else
+            run_command(command)
+          end
+        end
+
+        def close
+          if host_os_windows?
+            FileUtils.remove(exec_script_file)
+          end
         end
 
         # "Upload" the files by copying them locally.
         #
         # @see Base#upload
         def upload(locals, remote)
-          FileUtils.mkdir_p(remote)
+          # evaluate $env:temp on Windows
+          real_remote = remote.to_s == "\$env:TEMP\\kitchen" ? kitchen_temp : remote
+          FileUtils.mkdir_p(real_remote)
           Array(locals).each do |local|
-            FileUtils.cp_r(local, remote)
+            FileUtils.cp_r(local, real_remote)
+          end
+        end
+
+        # (see Base#init_options)
+        def init_options(options)
+          super
+          @instance_name = @options.delete(:instance_name)
+          @kitchen_root = @options.delete(:kitchen_root)
+        end
+
+        private
+
+        # @return [String] display name for the associated instance
+        # @api private
+        attr_reader :instance_name
+
+        # @return [String] local path to the root of the project
+        # @api private
+        attr_reader :kitchen_root
+
+        # Takes a long command and saves it to a file and uploads it to
+        # the test instance. Windows has cli character limits.
+        #
+        # @param command [String] a long command to be saved and uploaded
+        # @return [String] a command that executes the uploaded script
+        # @api private
+        def run_from_file_command(command)
+          if logger.debug?
+            debug("Creating exec script for #{instance_name} (#{exec_script_file})")
+            debug("Executing #{exec_script_file}")
+          end
+          File.open(exec_script_file, "wb") { |file| file.write(command) }
+          %{powershell -file "#{exec_script_file}"}
+        end
+
+        # @return [String] evaluated $env:temp variable
+        # @api private
+        def kitchen_temp
+          "#{ENV["temp"]}/kitchen"
+        end
+
+        # @return [String] name of script using instance name
+        # @api private
+        def exec_script_name
+          "#{instance_name}-exec-script.ps1"
+        end
+
+        # @return [String] file path for exec script to be run
+        # @api private
+        def exec_script_file
+          File.join(kitchen_root, ".kitchen", exec_script_name)
+        end
+
+        def host_os_windows?
+          case RbConfig::CONFIG["host_os"]
+          when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
+            true
+          else
+            false
           end
         end
+      end
+
+      private
 
+      # Builds the hash of options needed by the Connection object on construction.
+      #
+      # @param data [Hash] merged configuration and mutable state data
+      # @return [Hash] hash of connection options
+      # @api private
+      def connection_options(data)
+        opts = {
+          instance_name: instance.name,
+          kitchen_root: Dir.pwd,
+        }
+        opts
       end
     end
   end

data/lib/kitchen/transport/ssh.rb

@@ -195,18 +195,16 @@ module Kitchen
           FileUtils.mkdir_p(File.dirname(local))
 
           Array(remotes).each do |file|
+            logger.debug("Attempting to download '#{file}' as file")
+            session.scp.download!(file, local)
+          rescue Net::SCP::Error
             begin
-              logger.debug("Attempting to download '#{file}' as file")
-              session.scp.download!(file, local)
+              logger.debug("Attempting to download '#{file}' as directory")
+              session.scp.download!(file, local, recursive: true)
             rescue Net::SCP::Error
-              begin
-                logger.debug("Attempting to download '#{file}' as directory")
-                session.scp.download!(file, local, recursive: true)
-              rescue Net::SCP::Error
-                logger.warn(
-                  "SCP download failed for file or directory '#{file}', perhaps it does not exist?"
-                )
-              end
+              logger.warn(
+                "SCP download failed for file or directory '#{file}', perhaps it does not exist?"
+              )
             end
           end
         rescue Net::SSH::Exception => ex

data/lib/kitchen/transport/winrm.rb

@@ -308,16 +308,20 @@ module Kitchen
 
         # Builds a `LoginCommand` for use by Linux-based platforms.
         #
-        # TODO: determine whether or not `desktop` exists
-        #
         # @return [LoginCommand] a login command
         # @api private
         def login_command_for_linux
-          args  = %W{-u #{options[:user]}}
-          args += %W{-p #{options[:password]}} if options.key?(:password)
-          args += %W{#{URI.parse(options[:endpoint]).host}:#{rdp_port}}
+          xfreerdp = Util.command_exists? "xfreerdp"
+          unless xfreerdp
+            raise WinrmFailed, "xfreerdp binary not found. Please install freerdp2-x11 on Debian-based systems or freerdp on Redhat-based systems."
+          end
+
+          args  = %W{/u:#{options[:user]}}
+          args += %W{/p:#{options[:password]}} if options.key?(:password)
+          args += %W{/v:#{URI.parse(options[:endpoint]).host}:#{rdp_port}}
+          args += %W{/cert-tofu} # always accept certificate
 
-          LoginCommand.new("rdesktop", args)
+          LoginCommand.new(xfreerdp, args)
         end
 
         # Builds a `LoginCommand` for use by Mac-based platforms.

data/lib/kitchen/util.rb

@@ -110,7 +110,7 @@ module Kitchen
     def self.wrap_command(cmd)
       cmd = "false" if cmd.nil?
       cmd = "true" if cmd.to_s.empty?
-      cmd = cmd.sub(/\n\Z/, "") if cmd =~ /\n\Z/
+      cmd = cmd.sub(/\n\Z/, "") if /\n\Z/.match?(cmd)
 
       "sh -c '\n#{cmd}\n'"
     end
@@ -215,5 +215,15 @@ module Kitchen
     def self.snake_case(a_string)
       Thor::Util.snake_case(a_string)
     end
+
+    # Check if a cmd exists on the PATH
+    def self.command_exists?(cmd)
+      paths = ENV["PATH"].split(File::PATH_SEPARATOR) + [ "/bin", "/usr/bin", "/sbin", "/usr/sbin" ]
+      paths.each do |path|
+        filename = File.join(path, cmd)
+        return filename if File.executable?(filename)
+      end
+      false
+    end
   end
 end

data/lib/kitchen/verifier/busser.rb

@@ -168,7 +168,7 @@ module Kitchen
       # @api private
       def gem_install_args
         gem, version = config[:version].split("@")
-        if gem =~ /^\d+\.\d+\.\d+/
+        if /^\d+\.\d+\.\d+/.match?(gem)
           version = gem
           gem = "busser"
         end

data/lib/kitchen/verifier/shell.rb

@@ -88,6 +88,7 @@ module Kitchen
         env_state[:environment]["KITCHEN_INSTANCE"] = instance.name
         env_state[:environment]["KITCHEN_PLATFORM"] = instance.platform.name
         env_state[:environment]["KITCHEN_SUITE"] = instance.suite.name
+        env_state[:environment]["KITCHEN_USERNAME"] = instance.transport[:username] if instance.respond_to?(:transport)
         state.each_pair do |key, value|
           env_state[:environment]["KITCHEN_" + key.to_s.upcase] = value.to_s
         end

data/lib/kitchen/version.rb

@@ -16,5 +16,5 @@
 # limitations under the License.
 
 module Kitchen
-  VERSION = "2.7.1".freeze
+  VERSION = "2.11.0".freeze
 end

data/lib/kitchen/which.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+#
+# Copyright:: Copyright (c) Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require "chef-utils/dsl/which" unless defined?(ChefUtils::DSL::Which)
+require_relative "chef_utils_wiring" unless defined?(Ohai::Mixin::ChefUtilsWiring)
+
+module Kitchen
+  module Which
+    include ChefUtils::DSL::Which
+    include ChefUtilsWiring
+  end
+end

data/test-kitchen.gemspec

@@ -1,4 +1,4 @@
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "kitchen/version"
 require "English"
@@ -20,7 +20,7 @@ Gem::Specification.new do |gem|
   gem.executables   = %w{kitchen}
   gem.require_paths = ["lib"]
 
-  gem.required_ruby_version = ">= 2.4"
+  gem.required_ruby_version = ">= 2.5"
 
   gem.add_dependency "mixlib-shellout",    ">= 1.2", "< 4.0"
   gem.add_dependency "net-scp",            ">= 1.1", "< 4.0" # pinning until we can confirm 4+ works
@@ -33,6 +33,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency "winrm",              "~> 2.0"
   gem.add_dependency "winrm-elevated",     "~> 1.0"
   gem.add_dependency "winrm-fs",           "~> 1.1"
+  gem.add_dependency "chef-utils",         ">= 16.4.35"
   # Required to run the Chef provisioner local license check for remote systems
   # TK is not under Chef EULA
   gem.add_dependency "license-acceptance", ">= 1.0.11", "< 3.0" # pinning until we can confirm 3+ works

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-kitchen
 version: !ruby/object:Gem::Version
-  version: 2.7.1
+  version: 2.11.0
 platform: ruby
 authors:
 - Fletcher Nichol
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-15 00:00:00.000000000 Z
+date: 2021-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mixlib-shellout
@@ -194,6 +194,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: chef-utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 16.4.35
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 16.4.35
 - !ruby/object:Gem::Dependency
   name: license-acceptance
   requirement: !ruby/object:Gem::Requirement
@@ -387,6 +401,7 @@ files:
 - bin/kitchen
 - lib/kitchen.rb
 - lib/kitchen/base64_stream.rb
+- lib/kitchen/chef_utils_wiring.rb
 - lib/kitchen/cli.rb
 - lib/kitchen/collection.rb
 - lib/kitchen/color.rb
@@ -415,6 +430,9 @@ files:
 - lib/kitchen/generator/init.rb
 - lib/kitchen/instance.rb
 - lib/kitchen/lazy_hash.rb
+- lib/kitchen/lifecycle_hook/base.rb
+- lib/kitchen/lifecycle_hook/local.rb
+- lib/kitchen/lifecycle_hook/remote.rb
 - lib/kitchen/lifecycle_hooks.rb
 - lib/kitchen/loader/yaml.rb
 - lib/kitchen/logger.rb
@@ -454,6 +472,7 @@ files:
 - lib/kitchen/verifier/dummy.rb
 - lib/kitchen/verifier/shell.rb
 - lib/kitchen/version.rb
+- lib/kitchen/which.rb
 - lib/vendor/hash_recursive_merge.rb
 - support/busser_install_command.ps1
 - support/busser_install_command.sh
@@ -493,14 +512,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Test Kitchen is an integration tool for developing and testing infrastructure