test-kitchen 3.5.1 → 3.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43f3ba1a55d6f333784b955cda9e822970cd2226b9312f5dad31eb061e459688
-  data.tar.gz: a4f73825f0766b4fa61e5206eab8fcb48bc77ff5eb4c17173b1c4ebe5a00ff14
+  metadata.gz: 78dcb8180d72d9ce32f3cf860d2dbb90d4c66ba2920cdf03252717bd4674a3f5
+  data.tar.gz: fc68fb60b6fa811425c3079a317946414cfca980198e4e668fbcc0e4c507841a
 SHA512:
-  metadata.gz: c99da65b2481b02024d48852f700ad4b314319b12509b939370308f19866a5ee20145ffc0f1a840becd3eff6ecc28606394f9f3e3817ec88d9c5a2bcb230c0e8
-  data.tar.gz: 8e09b252dc4ada45de3c3cae80c22762ad418db5ed765e0441653c43a6d25f7117d17108ede0ac0cf7eef5996b73289ac8e6e08af25ade71511525236244fc7c
+  metadata.gz: 04e4ddf2b8c612db3a71ef7a7d720c5f586813f8ba3263415d56385f41e90b89663e2c4091fbbd03f60ff4c8922413988df086c71a93fbf7a396f903303b03d9
+  data.tar.gz: 93131c18cdc7889dd9c2e477c598a409ae4d1b47a865fdf4bba6ae54da6b48de59bfc1c7b57015b0dc011a311762e18b13c13955e8e45cc95f852807845d4073

data/Gemfile

@@ -1,15 +1,26 @@
 source "https://rubygems.org"
 
-# Specify your gem"s dependencies in test-kitchen.gemspec
 gemspec
 
+group :test do
+  gem "rake"
+  gem "rb-readline"
+  gem "aruba",     ">= 0.11", "< 3.0"
+  gem "countloc",  "~> 0.4"
+  gem "cucumber",  ">= 9.2", "< 10"
+  gem "fakefs",    "~> 2.0"
+  gem "maruku",    "~> 0.6"
+  gem "minitest",  "~> 5.3", "< 6.0"
+  gem "mocha",     "~> 2.0"
+end
+
 group :integration do
-  gem "berkshelf"
+  gem "chef-cli"
   gem "kitchen-dokken"
   gem "kitchen-inspec"
   gem "kitchen-vagrant"
 end
 
 group :chefstyle do
-  gem "chefstyle", "2.2.2"
-end
+  gem "chefstyle", "2.2.3"
+end

data/lib/kitchen/cli.rb

@@ -44,7 +44,7 @@ module Kitchen
           action: task,
           help: -> { help(task) },
           config: @config,
-          shell: shell,
+          shell:,
         }.merge(additional_options)
 
         str_const = Thor::Util.camel_case(command)

data/lib/kitchen/command/diagnose.rb

@@ -33,7 +33,7 @@ module Kitchen
         loader = record_failure { load_loader }
 
         puts YAML.dump(Kitchen::Diagnostic.new(
-          loader: loader, instances: instances, plugins: plugins?
+          loader:, instances:, plugins: plugins?
         ).read)
       end
 

data/lib/kitchen/config.rb

@@ -216,11 +216,11 @@ module Kitchen
             /^win/i.match?(platform) ? "winrm" : Transport::DEFAULT_PLUGIN
           end,
         },
-        kitchen_root: kitchen_root,
-        test_base_path: test_base_path,
-        log_level: log_level,
-        log_overwrite: log_overwrite,
-        debug: debug,
+        kitchen_root:,
+        test_base_path:,
+        log_level:,
+        log_overwrite:,
+        debug:,
       }
     end
 
@@ -250,8 +250,8 @@ module Kitchen
         driver: new_driver(suite, platform),
         lifecycle_hooks: new_lifecycle_hooks(suite, platform, sf),
         logger: new_instance_logger(suite, platform, index),
-        suite: suite,
-        platform: platform,
+        suite:,
+        platform:,
         provisioner: new_provisioner(suite, platform),
         transport: new_transport(suite, platform),
         verifier: new_verifier(suite, platform),
@@ -275,7 +275,7 @@ module Kitchen
         color: Color::COLORS[index % Color::COLORS.size].to_sym,
         logdev: log_location,
         level: Util.to_logger_level(log_level),
-        log_overwrite: log_overwrite,
+        log_overwrite:,
         progname: name,
         colorize: @colorize
       )

data/lib/kitchen/driver/ssh_base.rb

@@ -299,7 +299,7 @@ module Kitchen
       # @param options [Hash] configuration hash (default: `{}`)
       # @api private
       def wait_for_sshd(hostname, username = nil, options = {})
-        pseudo_state = { hostname: hostname }
+        pseudo_state = { hostname: }
         pseudo_state[:username] = username if username
         pseudo_state.merge!(options)
 

data/lib/kitchen/lifecycle_hook/local.rb

@@ -38,7 +38,7 @@ module Kitchen
                 config[:kitchen_root]
               end
         # Build the options for mixlib-shellout.
-        opts = {}.merge(user).merge(cwd: cwd, environment: environment)
+        opts = {}.merge(user).merge(cwd:, environment:)
         run_command(command, opts)
       end
 

data/lib/kitchen/platform.rb

@@ -58,7 +58,7 @@ module Kitchen
     #
     # @return [Hash] a diagnostic hash
     def diagnose
-      { os_type: os_type, shell_type: shell_type }
+      { os_type:, shell_type: }
     end
   end
 end

data/lib/kitchen/platform_filter.rb

@@ -26,7 +26,7 @@ module Kitchen
   # @author Baptiste Courtois <b.courtois@criteo.com>
   class PlatformFilter
     # Pattern used to determine whether a filter should be handled as a Regexp
-    REGEXP_LIKE_PATTERN = %r{^/(?<pattern>.*)/(?<options>[ix]*)$}.freeze
+    REGEXP_LIKE_PATTERN = %r{^/(?<pattern>.*)/(?<options>[ix]*)$}
 
     # Converts platform filters into an array of PlatformFilter handling both strings and Regexp.
     # A string "looks-like" a regexp if it starts by / and end by / + Regexp options i or x

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

@@ -287,9 +287,9 @@ module Kitchen
         def update_dna_for_policyfile
           policy = Chef::Policyfile.new(
             policyfile, sandbox_path,
-            logger: logger,
+            logger:,
             always_update: config[:always_update_cookbooks],
-            policy_group: policy_group,
+            policy_group:,
             license: config[:chef_license]
           )
           Kitchen.mutex.synchronize do
@@ -297,7 +297,7 @@ module Kitchen
           end
           policy_name = JSON.parse(IO.read(policy.lockfile))["name"]
           policy_group = config[:policy_group] || "local"
-          config[:attributes].merge(policy_name: policy_name, policy_group: policy_group)
+          config[:attributes].merge(policy_name:, policy_group:)
         end
 
         # Performs a Policyfile cookbook resolution inside a common mutex.
@@ -307,7 +307,7 @@ module Kitchen
           Kitchen.mutex.synchronize do
             Chef::Policyfile.new(
               policyfile, sandbox_path,
-              logger: logger,
+              logger:,
               always_update: config[:always_update_cookbooks],
               policy_group: config[:policy_group],
               license: config[:chef_license]
@@ -321,7 +321,7 @@ module Kitchen
         def resolve_with_berkshelf
           Kitchen.mutex.synchronize do
             Chef::Berkshelf.new(berksfile, tmpbooks_dir,
-              logger: logger,
+              logger:,
               always_update: config[:always_update_cookbooks]).resolve
           end
         end

data/lib/kitchen/provisioner/chef_base.rb

@@ -244,6 +244,7 @@ module Kitchen
       end
 
       def doctor(state)
+        deprecated_config = instance.driver.instance_variable_get(:@deprecated_config)
         deprecated_config.each do |attr, msg|
           info("**** #{attr} deprecated\n#{msg}")
         end
@@ -347,7 +348,7 @@ module Kitchen
           omnibus_url: config[:chef_omnibus_url],
           project: project.nil? ? nil : project[1],
           install_flags: config[:chef_omnibus_install_options],
-          sudo_command: sudo_command,
+          sudo_command:,
         }.tap do |opts|
           opts[:root] = config[:chef_omnibus_root] if config.key? :chef_omnibus_root
           %i{install_msi_url http_proxy https_proxy}.each do |key|
@@ -482,10 +483,10 @@ module Kitchen
         super
         if File.exist?(policyfile)
           debug("Policyfile found at #{policyfile}, using Policyfile to resolve cookbook dependencies")
-          Chef::Policyfile.load!(logger: logger)
+          Chef::Policyfile.load!(logger:)
         elsif File.exist?(berksfile)
           debug("Berksfile found at #{berksfile}, using Berkshelf to resolve cookbook dependencies")
-          Chef::Berkshelf.load!(logger: logger)
+          Chef::Berkshelf.load!(logger:)
         end
       end
 

data/lib/kitchen/provisioner/chef_target.rb

@@ -0,0 +1,130 @@
+#
+# Author:: Thomas Heinen (<thomas.heinen@gmail.com>)
+#
+# Copyright (C) 2023, Thomas Heinen
+#
+# 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_relative "chef_infra"
+
+module Kitchen
+  module Provisioner
+    # Chef Target provisioner.
+    #
+    # @author Thomas Heinen <thomas.heinen@gmail.com>
+    class ChefTarget < ChefInfra
+      MIN_VERSION_REQUIRED = "19.0.0".freeze
+      class ChefVersionTooLow < UserError; end
+      class ChefClientNotFound < UserError; end
+      class RequireTrainTransport < UserError; end
+
+      default_config :install_strategy, "none"
+      default_config :sudo, true
+
+      def install_command; ""; end
+      def init_command; ""; end
+      def prepare_command; ""; end
+
+      def chef_args(client_rb_filename)
+        # Dummy execution to initialize and test remote connection
+        connection = instance.remote_exec("echo Connection established")
+
+        check_transport(connection)
+        check_local_chef_client
+
+        instance_name = instance.name
+        credentials_file = File.join(kitchen_basepath, ".kitchen", instance_name + ".ini")
+        File.write(credentials_file, connection.credentials_file)
+
+        super.concat([
+          "--target #{instance_name}",
+          "--credentials #{credentials_file}",
+        ])
+      end
+
+      def check_transport(connection)
+        debug("Checking for active transport")
+
+        unless connection.respond_to? "train_uri"
+          error("Chef Target Mode provisioner requires a Train-based transport like kitchen-transport-train")
+          raise RequireTrainTransport.new("No Train transport")
+        end
+
+        debug("Kitchen transport responds to train_uri function call, as required")
+      end
+
+      def check_local_chef_client
+        debug("Checking for chef-client version")
+
+        begin
+          client_version = `chef-client -v`.chop.split(":")[-1]
+        rescue Errno::ENOENT => e
+          error("Error determining Chef Infra version: #{e.exception.message}")
+          raise ChefClientNotFound.new("Need chef-client installed locally")
+        end
+
+        minimum_version = Gem::Version.new(MIN_VERSION_REQUIRED)
+        installed_version = Gem::Version.new(client_version)
+
+        if installed_version < minimum_version
+          error("Found Chef Infra version #{installed_version}, but require #{minimum_version} for Target Mode")
+          raise ChefVersionTooLow.new("Need version #{MIN_VERSION_REQUIRED} or higher")
+        end
+
+        debug("Chef Infra found and version constraints match")
+      end
+
+      def kitchen_basepath
+        instance.driver.config[:kitchen_root]
+      end
+
+      def create_sandbox
+        super
+
+        # Change config.rb to point to the local sandbox path, not to /tmp/kitchen
+        config[:root_path] = sandbox_path
+        prepare_config_rb
+      end
+
+      def call(state)
+        remote_connection = instance.transport.connection(state)
+
+        config[:uploads].to_h.each do |locals, remote|
+          debug("Uploading #{Array(locals).join(", ")} to #{remote}")
+          remote_connection.upload(locals.to_s, remote)
+        end
+
+        # no installation
+        create_sandbox
+        # no prepare command
+
+        # Stream output to logger
+        require "open3"
+        Open3.popen2e(run_command) do |_stdin, output, _thread|
+          output.each { |line| logger << line }
+        end
+
+        info("Downloading files from #{instance.to_str}")
+        config[:downloads].to_h.each do |remotes, local|
+          debug("Downloading #{Array(remotes).join(", ")} to #{local}")
+          remote_connection.download(remotes, local)
+        end
+        debug("Download complete")
+      rescue Kitchen::Transport::TransportFailed => ex
+        raise ActionFailed, ex.message
+      ensure
+        cleanup_sandbox
+      end
+    end
+  end
+end

data/lib/kitchen/transport/ssh.rb

@@ -225,7 +225,7 @@ module Kitchen
           delay = 3
           session(
             retries: max_wait_until_ready / delay,
-            delay: delay,
+            delay:,
             message: "Waiting for SSH service on #{hostname}:#{port}, " \
               "retrying in #{delay} seconds"
           )
@@ -468,7 +468,7 @@ module Kitchen
       # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
       def connection_options(data)
         opts = {
-          logger: logger,
+          logger:,
           user_known_hosts_file: "/dev/null",
           hostname: data[:hostname],
           port: data[:port],

data/lib/kitchen/transport/winrm.rb

@@ -444,8 +444,8 @@ module Kitchen
         opts = {
           instance_name: instance.name,
           kitchen_root: data[:kitchen_root],
-          logger: logger,
-          endpoint: endpoint,
+          logger:,
+          endpoint:,
           user: data[:username],
           password: data[:password],
           rdp_port: data[:rdp_port],
@@ -457,7 +457,7 @@ module Kitchen
           transport: data[:winrm_transport],
           elevated: data[:elevated],
           elevated_username: data[:elevated_username] || data[:username],
-          elevated_password: elevated_password,
+          elevated_password:,
         }
         opts.merge!(additional_transport_args(data, opts[:transport]))
         if opts[:transport].to_sym == :ssl && opts.key?(:client_cert) && opts.key?(:client_key)

data/lib/kitchen/version.rb

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

data/lib/kitchen.rb

@@ -91,7 +91,7 @@ module Kitchen
         stdout: $stdout,
         logdev: log_location,
         level: Util.to_logger_level(level),
-        log_overwrite: log_overwrite
+        log_overwrite:
       )
     end
 

data/test-kitchen.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |gem|
   gem.executables   = %w{kitchen}
   gem.require_paths = ["lib"]
 
-  gem.required_ruby_version = ">= 2.7"
+  gem.required_ruby_version = ">= 3.1"
 
   gem.add_dependency "bcrypt_pbkdf",       "~> 1.0" # ed25519 ssh key support
   gem.add_dependency "chef-utils",         ">= 16.4.35"
@@ -37,15 +37,4 @@ Gem::Specification.new do |gem|
   # 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
-
-  gem.add_development_dependency "rake"
-  gem.add_development_dependency "rb-readline"
-
-  gem.add_development_dependency "aruba",     ">= 0.11", "< 3.0"
-  gem.add_development_dependency "countloc",  "~> 0.4"
-  gem.add_development_dependency "cucumber",  ">= 2.1", "< 8.0"
-  gem.add_development_dependency "fakefs",    "~> 2.0"
-  gem.add_development_dependency "maruku",    "~> 0.6"
-  gem.add_development_dependency "minitest",  "~> 5.3", "< 5.16"
-  gem.add_development_dependency "mocha",     "~> 2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-kitchen
 version: !ruby/object:Gem::Version
-  version: 3.5.1
+  version: 3.7.0
 platform: ruby
 authors:
 - Fletcher Nichol
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-15 00:00:00.000000000 Z
+date: 2024-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcrypt_pbkdf
@@ -228,150 +228,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rb-readline
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: aruba
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.11'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.11'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: countloc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-- !ruby/object:Gem::Dependency
-  name: cucumber
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '8.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '8.0'
-- !ruby/object:Gem::Dependency
-  name: fakefs
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: maruku
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.3'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.3'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.16'
-- !ruby/object:Gem::Dependency
-  name: mocha
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
 description: Test Kitchen is an integration tool for developing and testing infrastructure
   code and software on isolated target platforms.
 email:
@@ -438,6 +294,7 @@ files:
 - 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/shell.rb
@@ -500,7 +357,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="