test-kitchen 3.9.1 → 4.1.0

data/lib/kitchen.rb

@@ -16,6 +16,7 @@
 # limitations under the License.
 
 require "pathname" unless defined?(Pathname)
+require "securerandom" unless defined?(SecureRandom)
 require_relative "kitchen/errors"
 require_relative "kitchen/logger"
 require_relative "kitchen/logging"
@@ -31,7 +32,6 @@ require_relative "kitchen/config"
 require_relative "kitchen/data_munger"
 require_relative "kitchen/driver"
 require_relative "kitchen/driver/base"
-require_relative "kitchen/driver/ssh_base"
 require_relative "kitchen/driver/proxy"
 require_relative "kitchen/instance"
 require_relative "kitchen/lifecycle_hooks"
@@ -41,7 +41,6 @@ require_relative "kitchen/loader/yaml"
 require_relative "kitchen/metadata_chopper"
 require_relative "kitchen/platform"
 require_relative "kitchen/state_file"
-require_relative "kitchen/ssh"
 require_relative "kitchen/suite"
 require_relative "kitchen/verifier"
 require_relative "kitchen/verifier/base"
@@ -61,6 +60,9 @@ module Kitchen
     # @return [Mutex] a mutex used for Dir.chdir coordination
     attr_accessor :mutex_chdir
 
+    # @return [String] identifier for the current Kitchen process invocation
+    attr_writer :run_id
+
     # Returns the root path of the Kitchen gem source code.
     #
     # @return [Pathname] root path of gem
@@ -72,7 +74,11 @@ module Kitchen
     #
     # @return [Logger] a logger
     def default_logger
-      Logger.new(stdout: $stdout, level: Util.to_logger_level(env_log))
+      Logger.new(
+        stdout: $stdout,
+        level: Util.to_logger_level(env_log),
+        metadata: { kitchen_run_id: run_id }
+      )
     end
 
     # Returns a default file logger which emits on standard output and to a
@@ -86,15 +92,26 @@ module Kitchen
       log_overwrite = log_overwrite.nil? ? env_log_overwrite : log_overwrite
       log_location = File.expand_path(File.join(DEFAULT_LOG_DIR, "kitchen.log"))
       log_location = log_location.to_s
+      structured_log_location = File.expand_path(File.join(DEFAULT_LOG_DIR, "kitchen.ndjson"))
+      structured_log_location = structured_log_location.to_s
 
       Logger.new(
         stdout: $stdout,
         logdev: log_location,
+        structured_logdev: structured_log_location,
         level: Util.to_logger_level(level),
-        log_overwrite:
+        log_overwrite:,
+        metadata: { kitchen_run_id: run_id }
       )
     end
 
+    # Returns the current Kitchen run identifier.
+    #
+    # @return [String] identifier for the current Kitchen process invocation
+    def run_id
+      @run_id ||= SecureRandom.uuid
+    end
+
     # Returns whether or not standard output is associated with a terminal
     # device (tty).
     #

data/lib/vendor/hash_recursive_merge.rb

@@ -48,8 +48,8 @@ module HashRecursiveMerge
   # When both +hsh+ and +other_hash+ contains an entry with the same key,
   # it merges and returns the values from both arrays.
   #
-  # Compared with Hash#merge, this method provides a different approch
-  # for merging nasted hashes.
+  # Compared with Hash#merge, this method provides a different approach
+  # for merging nested hashes.
   # If the value of a given key is an Hash and both +other_hash+ abd +hsh
   # includes the same key, the value is merged instead replaced with
   # +other_hash+ value.

data/templates/driver/driver.rb.erb

@@ -11,7 +11,7 @@ module Kitchen
     # <%= config[:klass_name] %> driver for Kitchen.
     #
     # @author <%= config[:author] %> <<%= config[:email] %>>
-    class <%= config[:klass_name] %> < Kitchen::Driver::SSHBase
+    class <%= config[:klass_name] %> < Kitchen::Driver::Base
 
       def create(state)
       end

data/test-kitchen.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency "csv",                "~> 3.3"
   gem.add_dependency "ed25519",            "~> 1.3" # ed25519 ssh key support
   gem.add_dependency "irb",                "~> 1.15"
-  gem.add_dependency "mixlib-install",     "~> 3.6"
+  gem.add_dependency "mixlib-install",     ">= 3.6", "< 5.0" # allow Cinc's mixlib-install 4.x fork
   gem.add_dependency "mixlib-shellout",    ">= 1.2", "< 4.0"
   gem.add_dependency "net-scp",            ">= 1.1", "< 5.0" # pinning until we can confirm 4+ works
   gem.add_dependency "net-ssh",            ">= 2.9", "< 8.0" # pinning until we can confirm 8+ works
@@ -35,10 +35,8 @@ Gem::Specification.new do |gem|
   gem.add_dependency "ostruct",            "~> 0.6"
   gem.add_dependency "syslog",             "~> 0.3"
   gem.add_dependency "thor",               ">= 0.19", "< 2.0"
-  gem.add_dependency "winrm",              "~> 2.0"
-  gem.add_dependency "winrm-elevated",     "~> 1.0"
-  gem.add_dependency "winrm-fs",           "~> 1.1"
-  # 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
+  # Chef Forked versions with additional fixes since no one is maintining them upstream
+  gem.add_dependency "chef-winrm",         ">= 2.5.0", "< 3.0"
+  gem.add_dependency "chef-winrm-elevated", ">= 1.0", "< 2.0"
+  gem.add_dependency "chef-winrm-fs",      ">= 1.0", "< 2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-kitchen
 version: !ruby/object:Gem::Version
-  version: 3.9.1
+  version: 4.1.0
 platform: ruby
 authors:
 - Fletcher Nichol
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-10-17 00:00:00.000000000 Z
+date: 2026-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcrypt_pbkdf
@@ -84,16 +84,22 @@ dependencies:
   name: mixlib-install
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: mixlib-shellout
   requirement: !ruby/object:Gem::Requirement
@@ -223,67 +229,65 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: winrm
+  name: chef-winrm
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.5.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.5.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: winrm-elevated
+  name: chef-winrm-elevated
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: winrm-fs
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: license-acceptance
+  name: chef-winrm-fs
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.11
+        version: '1.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.11
+        version: '1.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.0'
 description: Test Kitchen is an integration tool for developing and testing infrastructure
   code and software on isolated target platforms.
 email:
@@ -311,6 +315,7 @@ files:
 - lib/kitchen/command/exec.rb
 - lib/kitchen/command/list.rb
 - lib/kitchen/command/login.rb
+- lib/kitchen/command/logs.rb
 - lib/kitchen/command/package.rb
 - lib/kitchen/command/sink.rb
 - lib/kitchen/command/test.rb
@@ -323,7 +328,6 @@ files:
 - lib/kitchen/driver/dummy.rb
 - lib/kitchen/driver/exec.rb
 - lib/kitchen/driver/proxy.rb
-- lib/kitchen/driver/ssh_base.rb
 - lib/kitchen/errors.rb
 - lib/kitchen/generator/init.rb
 - lib/kitchen/instance.rb
@@ -343,20 +347,11 @@ files:
 - lib/kitchen/plugin_base.rb
 - lib/kitchen/provisioner.rb
 - lib/kitchen/provisioner/base.rb
-- lib/kitchen/provisioner/chef/berkshelf.rb
-- lib/kitchen/provisioner/chef/common_sandbox.rb
-- lib/kitchen/provisioner/chef/policyfile.rb
-- lib/kitchen/provisioner/chef_apply.rb
-- lib/kitchen/provisioner/chef_base.rb
-- lib/kitchen/provisioner/chef_infra.rb
-- lib/kitchen/provisioner/chef_solo.rb
-- lib/kitchen/provisioner/chef_target.rb
-- lib/kitchen/provisioner/chef_zero.rb
 - lib/kitchen/provisioner/dummy.rb
+- lib/kitchen/provisioner/external.rb
 - lib/kitchen/provisioner/shell.rb
 - lib/kitchen/rake_tasks.rb
 - lib/kitchen/shell_out.rb
-- lib/kitchen/ssh.rb
 - lib/kitchen/state_file.rb
 - lib/kitchen/suite.rb
 - lib/kitchen/thor_tasks.rb

data/lib/kitchen/driver/ssh_base.rb

@@ -1,346 +0,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
-#
-#    https://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 "thor/util"
-
-require_relative "../lazy_hash"
-require_relative "../plugin_base"
-require "benchmark" unless defined?(Benchmark)
-
-module Kitchen
-  module Driver
-    # Legacy base class for a driver that uses SSH to communication with an
-    # instance. This class has been updated to use the Instance's Transport to
-    # issue commands and transfer files and no longer uses the `Kitchen:SSH`
-    # class directly.
-    #
-    # **NOTE:** Authors of new Drivers are encouraged to inherit from
-    # `Kitchen::Driver::Base` instead and existing Driver authors are
-    # encouraged to update their Driver class to inherit from
-    # `Kitchen::Driver::SSHBase`.
-    #
-    # A subclass must implement the following methods:
-    # * #create(state)
-    # * #destroy(state)
-    #
-    # @author Fletcher Nichol <fnichol@nichol.ca>
-    # @deprecated While all possible effort has been made to preserve the
-    #   original behavior of this class, future improvements to the Driver,
-    #   Transport, and Verifier subsystems may not be picked up in these
-    #   Drivers. When legacy Driver::SSHBase support is removed, this class
-    #   will no longer be available.
-    class SSHBase < Kitchen::Plugin::Base
-      include ShellOut
-      include Configurable
-      include Logging
-
-      default_config :sudo, true
-      default_config :port, 22
-      # needs to be one less than the configured sshd_config MaxSessions
-      default_config :max_ssh_sessions, 9
-
-      # Creates a new Driver object using the provided configuration data
-      # which will be merged with any default configuration.
-      #
-      # @param config [Hash] provided driver configuration
-      def initialize(config = {})
-        init_config(config)
-      end
-
-      # (see Base#create)
-      def create(state) # rubocop:disable Lint/UnusedMethodArgument
-        raise ClientError, "#{self.class}#create must be implemented"
-      end
-
-      # (see Base#converge)
-      def converge(state) # rubocop:disable Metrics/AbcSize
-        provisioner = instance.provisioner
-        provisioner.create_sandbox
-        sandbox_dirs = provisioner.sandbox_dirs
-
-        instance.transport.connection(backcompat_merged_state(state)) do |conn|
-          conn.execute(env_cmd(provisioner.install_command))
-          conn.execute(env_cmd(provisioner.init_command))
-          info("Transferring files to #{instance.to_str}")
-          conn.upload(sandbox_dirs, provisioner[:root_path])
-          debug("Transfer complete")
-          conn.execute(env_cmd(provisioner.prepare_command))
-          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}")
-            conn.download(remotes, local)
-          end
-          debug("Download complete")
-        end
-      rescue Kitchen::Transport::TransportFailed => ex
-        raise ActionFailed, ex.message
-      ensure
-        instance.provisioner.cleanup_sandbox
-      end
-
-      # (see Base#setup)
-      def setup(state)
-        verifier = instance.verifier
-
-        instance.transport.connection(backcompat_merged_state(state)) do |conn|
-          conn.execute(env_cmd(verifier.install_command))
-        end
-      rescue Kitchen::Transport::TransportFailed => ex
-        raise ActionFailed, ex.message
-      end
-
-      # (see Base#verify)
-      def verify(state) # rubocop:disable Metrics/AbcSize
-        verifier = instance.verifier
-        verifier.create_sandbox
-        sandbox_dirs = Util.list_directory(verifier.sandbox_path)
-
-        instance.transport.connection(backcompat_merged_state(state)) do |conn|
-          conn.execute(env_cmd(verifier.init_command))
-          info("Transferring files to #{instance.to_str}")
-          conn.upload(sandbox_dirs, verifier[:root_path])
-          debug("Transfer complete")
-          conn.execute(env_cmd(verifier.prepare_command))
-          conn.execute(env_cmd(verifier.run_command))
-        end
-      rescue Kitchen::Transport::TransportFailed => ex
-        raise ActionFailed, ex.message
-      ensure
-        instance.verifier.cleanup_sandbox
-      end
-
-      # (see Base#destroy)
-      def destroy(state) # rubocop:disable Lint/UnusedMethodArgument
-        raise ClientError, "#{self.class}#destroy must be implemented"
-      end
-
-      def legacy_state(state)
-        backcompat_merged_state(state)
-      end
-
-      # Package an instance.
-      #
-      # (see Base#package)
-      def package(state); end
-
-      # (see Base#login_command)
-      def login_command(state)
-        instance.transport.connection(backcompat_merged_state(state))
-          .login_command
-      end
-
-      # Executes an arbitrary command on an instance over an SSH connection.
-      #
-      # @param state [Hash] mutable instance and driver state
-      # @param command [String] the command to be executed
-      # @raise [ActionFailed] if the command could not be successfully completed
-      def remote_command(state, command)
-        instance.transport.connection(backcompat_merged_state(state)) do |conn|
-          conn.execute(env_cmd(command))
-        end
-      end
-
-      # **(Deprecated)** Executes a remote command over SSH.
-      #
-      # @param ssh_args [Array] ssh arguments
-      # @param command [String] remote command to invoke
-      # @deprecated This method should no longer be called directly and exists
-      #   to support very old drivers. This will be removed in the future.
-      def ssh(ssh_args, command)
-        pseudo_state = { hostname: ssh_args[0], username: ssh_args[1] }
-        pseudo_state.merge!(ssh_args[2])
-        connection_state = backcompat_merged_state(pseudo_state)
-
-        instance.transport.connection(connection_state) do |conn|
-          conn.execute(env_cmd(command))
-        end
-      end
-
-      # Performs whatever tests that may be required to ensure that this driver
-      # will be able to function in the current environment. This may involve
-      # checking for the presence of certain directories, software installed,
-      # etc.
-      #
-      # @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
-
-      # Cache directory that a driver could implement to inform the provisioner
-      # that it can leverage it internally
-      #
-      # @return path [String] a path of the cache directory
-      def cache_directory; end
-
-      private
-
-      def backcompat_merged_state(state)
-        driver_ssh_keys = %w{
-          forward_agent hostname password port ssh_key username
-        }.map(&:to_sym)
-        config.select { |key, _| driver_ssh_keys.include?(key) }.rmerge(state)
-      end
-
-      # Builds arguments for constructing a `Kitchen::SSH` instance.
-      #
-      # @param state [Hash] state hash
-      # @return [Array] SSH constructor arguments
-      # @api private
-      def build_ssh_args(state)
-        combined = config.to_hash.merge(state)
-
-        opts = {}
-        opts[:user_known_hosts_file] = "/dev/null"
-        opts[:verify_host_key] = false
-        opts[:keys_only] = true if combined[:ssh_key]
-        opts[:password] = combined[:password] if combined[:password]
-        opts[:forward_agent] = combined[:forward_agent] if combined.key? :forward_agent
-        opts[:port] = combined[:port] if combined[:port]
-        opts[:keys] = Array(combined[:ssh_key]) if combined[:ssh_key]
-        opts[:logger] = logger
-
-        [combined[:hostname], combined[:username], opts]
-      end
-
-      # Adds http, https and ftp proxy environment variables to a command, if
-      # set in configuration data or on local workstation.
-      #
-      # @param cmd [String] command string
-      # @return [String] command string
-      # @api private
-      # 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"]
-        https_proxy = config[:https_proxy] || ENV["https_proxy"] ||
-          ENV["HTTPS_PROXY"]
-        ftp_proxy = config[:ftp_proxy] || ENV["ftp_proxy"] ||
-          ENV["FTP_PROXY"]
-        no_proxy = if (!config[:http_proxy] && http_proxy) ||
-            (!config[:https_proxy] && https_proxy) ||
-            (!config[:ftp_proxy] && ftp_proxy)
-                     ENV["no_proxy"] || ENV["NO_PROXY"]
-                   end
-        env << " http_proxy=#{http_proxy}"   if http_proxy
-        env << " https_proxy=#{https_proxy}" if https_proxy
-        env << " ftp_proxy=#{ftp_proxy}"     if ftp_proxy
-        env << " no_proxy=#{no_proxy}"       if no_proxy
-
-        env == "env" ? cmd : "#{env} #{cmd}"
-      end
-
-      # Executes a remote command over SSH.
-      #
-      # @param command [String] remove command to run
-      # @param connection [Kitchen::SSH] an SSH connection
-      # @raise [ActionFailed] if an exception occurs
-      # @api private
-      def run_remote(command, connection)
-        return if command.nil?
-
-        connection.exec(env_cmd(command))
-      rescue SSHFailed, Net::SSH::Exception => ex
-        raise ActionFailed, ex.message
-      end
-
-      # Transfers one or more local paths over SSH.
-      #
-      # @param locals [Array<String>] array of local paths
-      # @param remote [String] remote destination path
-      # @param connection [Kitchen::SSH] an SSH connection
-      # @raise [ActionFailed] if an exception occurs
-      # @api private
-      def transfer_path(locals, remote, connection)
-        return if locals.nil? || Array(locals).empty?
-
-        info("Transferring files to #{instance.to_str}")
-        debug("TIMING: scp asynch upload (Kitchen::Driver::SSHBase)")
-        elapsed = Benchmark.measure do
-          transfer_path_async(locals, remote, connection)
-        end
-        delta = Util.duration(elapsed.real)
-        debug("TIMING: scp async upload (Kitchen::Driver::SSHBase) took #{delta}")
-        debug("Transfer complete")
-      rescue SSHFailed, Net::SSH::Exception => ex
-        raise ActionFailed, ex.message
-      end
-
-      def transfer_path_async(locals, remote, connection)
-        waits = []
-        locals.map do |local|
-          waits.push connection.upload_path(local, remote)
-          waits.shift.wait while waits.length >= config[:max_ssh_sessions]
-        end
-        waits.each(&:wait)
-      end
-
-      # Blocks until a TCP socket is available where a remote SSH server
-      # should be listening.
-      #
-      # @param hostname [String] remote SSH server host
-      # @param username [String] SSH username (default: `nil`)
-      # @param options [Hash] configuration hash (default: `{}`)
-      # @api private
-      def wait_for_sshd(hostname, username = nil, options = {})
-        pseudo_state = { hostname: }
-        pseudo_state[:username] = username if username
-        pseudo_state.merge!(options)
-
-        instance.transport.connection(**backcompat_merged_state(pseudo_state))
-          .wait_until_ready
-      end
-
-      # Intercepts any bare #puts calls in subclasses and issues an INFO log
-      # event instead.
-      #
-      # @param msg [String] message string
-      def puts(msg)
-        info(msg)
-      end
-
-      # Intercepts any bare #print calls in subclasses and issues an INFO log
-      # event instead.
-      #
-      # @param msg [String] message string
-      def print(msg)
-        info(msg)
-      end
-
-      # Delegates to Kitchen::ShellOut.run_command, overriding some default
-      # options:
-      #
-      # * `:use_sudo` defaults to the value of `config[:use_sudo]` in the
-      #   Driver object
-      # * `:log_subject` defaults to a String representation of the Driver's
-      #   class name
-      #
-      # @see ShellOut#run_command
-      def run_command(cmd, options = {})
-        base_options = {
-          use_sudo: config[:use_sudo],
-          log_subject: Thor::Util.snake_case(self.class.to_s),
-        }.merge(options)
-        super(cmd, base_options)
-      end
-
-      # Returns the Busser object associated with the driver.
-      #
-      # @return [Busser] a busser
-      def busser
-        instance.verifier
-      end
-    end
-  end
-end