test-kitchen 3.7.2 → 3.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d5084681fcdd3347fff64203a6a4a01e005297e2da8da4a19268e862c015f78
-  data.tar.gz: a97d9c95641aef0c507f775dbf8164e73acc712bd5efed94324209c8b7a5d725
+  metadata.gz: 20202cfa53b2c7701a9cf67fa0d48b8d6975b5adbe0c0a6fdac04ccd6fae227a
+  data.tar.gz: 78af76288e703870f132824cd0037cb0e35b5128349e73296d648b75c270fbbe
 SHA512:
-  metadata.gz: a1c90dbec6701faa9b16472fea3b46bff2e5743fb08db95d44a305dcfa7bdcea5c92961a5c82d9758e199f128dfbf746474414db8ec1cc910b99e6471b9e5ec0
-  data.tar.gz: 698c4e4f6a617799ac5930da2ab8e4e934a5cbc523cb7515bc241117e3544166acf81a8fcc8b716c58fa0319b41b78e51a1dbc2846faaa442435d0937764521e
+  metadata.gz: 4935e08c83c27064098f9903cc76728b74c5cbb7cd15c3378ab5809c5fbb52b9890b13b4109cac44287307a78537aeeb80ed60cc31439f51f90ccbbe583a5645
+  data.tar.gz: 5cf63e66b71ef201bae5157f9cf3dcb94682aa7f78611e2669e24466ddb96b101b3818ec1fab4d96283acb483eaaf2e2d3383854140b34f5a3c741ae412dc83d

data/Gemfile

@@ -7,7 +7,7 @@ group :test do
   gem "rb-readline"
   gem "aruba",     ">= 0.11", "< 3.0"
   gem "countloc",  "~> 0.4"
-  gem "cucumber",  ">= 9.2", "< 10"
+  gem "cucumber",  ">= 9.2", "< 11"
   gem "fakefs",    "~> 3.0"
   gem "maruku",    "~> 0.6"
   gem "minitest",  "~> 5.3", "< 6.0"

data/lib/kitchen/config.rb

@@ -98,7 +98,7 @@ module Kitchen
     #   directory containing test suites and other testing-related files and
     #   directories (default: `"#{kitchen_root}/test/integration"`)
     # @option options [Symbol] :log_level the log level verbosity that the
-    #   loggers will use when outputing information (default: `:info`)
+    #   loggers will use when outputting information (default: `:info`)
     def initialize(options = {})
       @loader         = options.fetch(:loader) { Kitchen::Loader::YAML.new }
       @kitchen_root   = options.fetch(:kitchen_root) { Dir.pwd }

data/lib/kitchen/configurable.rb

@@ -485,7 +485,7 @@ module Kitchen
       #   end
       #
       # @param attr [String] configuration attribute name
-      # @param value [Object, nil] whether or not to exand the file path
+      # @param value [Object, nil] whether or not to expand the file path
       # @yieldparam object [Object] a reference to the instantiated object
       # @yieldreturn [Object, nil] dynamically compute whether or not to
       #   perform the file expansion

data/lib/kitchen/driver/base.rb

@@ -1,8 +1,3 @@
-#
-# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
-#
-# Copyright (C) 2012, Fletcher Nichol
-#
 # 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
@@ -25,8 +20,6 @@ require_relative "../shell_out"
 module Kitchen
   module Driver
     # Base class for a driver.
-    #
-    # @author Fletcher Nichol <fnichol@nichol.ca>
     class Base < Kitchen::Plugin::Base
       include Configurable
       include Logging

data/lib/kitchen/driver/dummy.rb

@@ -1,8 +1,3 @@
-#
-# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
-#
-# Copyright (C) 2012, 2013, 2014 Fletcher Nichol
-#
 # 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

data/lib/kitchen/driver/exec.rb

@@ -1,4 +1,3 @@
-#
 # 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

data/lib/kitchen/driver/proxy.rb

@@ -1,9 +1,3 @@
-#
-# Author:: Seth Chisamore <schisamo@opscode.com>
-#
-# Copyright:: Copyright (c) 2013 Opscode, 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

data/lib/kitchen/driver/ssh_base.rb

@@ -1,8 +1,3 @@
-#
-# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
-#
-# Copyright (C) 2012, Fletcher Nichol
-#
 # 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

data/lib/kitchen/provisioner/base.rb

@@ -70,20 +70,39 @@ module Kitchen
       # rubocop:disable Metrics/AbcSize
       def call(state)
         create_sandbox
+        prepare_install_script
 
         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)
+
+          # Run the init command to create the kitchen tmp directory
+          conn.execute(encode_for_powershell(init_command))
+
+          # Upload the install script instead of directly executing the command
+          if install_command
+            script_filename = windows_os? ? "install_script.ps1" : "install_script"
+            remote_script_path = remote_path_join(resolve_remote_path(config[:root_path]), script_filename)
+            if install_script_path
+              debug("Uploading install script to #{remote_script_path}")
+              conn.upload(install_script_path, remote_script_path)
+              # Make script executable on remote host
+              conn.execute(make_executable_command(remote_script_path))
+              # Execute the uploaded script
+              conn.execute(run_script_command(remote_script_path))
+            end
+          end
+
+          # The install script will remove the kitchen tmp directory, hence creating it again.
           conn.execute(init_command)
           info("Transferring files to #{instance.to_str}")
-          conn.upload(sandbox_dirs, config[:root_path])
+          conn.upload(sandbox_dirs, resolve_remote_path(config[:root_path]))
           debug("Transfer complete")
           conn.execute(prepare_command)
           conn.execute_with_retry(
-            run_command,
+            encode_for_powershell(run_command),
             config[:retry_on_exit_code],
             config[:max_retries],
             config[:wait_for_retry]
@@ -195,6 +214,7 @@ module Kitchen
         return if sandbox_path.nil?
 
         debug("Cleaning up local sandbox in #{sandbox_path}")
+        @install_script_path = nil
         FileUtils.rmtree(sandbox_path)
       end
 
@@ -270,6 +290,103 @@ module Kitchen
       def prefix_command(script)
         config[:command_prefix] ? "#{config[:command_prefix]} #{script}" : script
       end
+
+      def encode_for_powershell(script)
+        return script unless windows_os?
+        return script if script.nil? || script.empty?
+
+        utf16le = script.encode(Encoding::UTF_16LE)
+        encoded = [utf16le].pack("m0")
+
+        "powershell -NoProfile -NonInteractive -NoLogo -ExecutionPolicy Bypass -EncodedCommand #{encoded}"
+      end
+
+      # Writes the install command to a file that will be uploaded to the instance
+      # and executed.
+      #
+      # @api private
+      def prepare_install_script
+        command = install_command
+        return if command.nil? || command.empty?
+
+        info("Preparing install script")
+        script_filename = windows_os? ? "install_script.ps1" : "install_script"
+        @install_script_path = File.join(sandbox_path, script_filename)
+
+        debug("Creating install script at #{@install_script_path}")
+        File.open(@install_script_path, "wb") do |file|
+          unless windows_os?
+            file.write("#!/bin/sh\n")
+          end
+          file.write(command)
+        end
+
+        # Make script executable locally
+        FileUtils.chmod(0755, @install_script_path) unless windows_os?
+      end
+
+      def install_script_path
+        @install_script_path
+      end
+
+      # Returns a command to make a script executable on the remote host.
+      #
+      # @param script_path [String] path to the script on the remote host
+      # @return [String] command to make the script executable
+      # @api private
+      def make_executable_command(script_path)
+        debug "echo Making script executable"
+        return if windows_os?
+
+        prefix_command(wrap_shell_code(sudo("chmod +x #{script_path}")))
+      end
+
+      # Returns a command to execute a script on the remote host.
+      #
+      # @param script_path [String] path to the script on the remote host
+      # @return [String] command to execute the script
+      # @api private
+      def run_script_command(script_path)
+        if windows_os?
+          # Use parameters to suppress PowerShell formatting and control characters
+          # that can interfere with console output over SSH
+          "powershell -NoProfile -NonInteractive -NoLogo -ExecutionPolicy Bypass -File #{script_path}"
+        else
+          prefix_command(wrap_shell_code(sudo(script_path)))
+        end
+      end
+
+      # Resolves PowerShell environment variables in remote paths to actual paths
+      # for use with net/scp and other transport operations that can't handle
+      # PowerShell variables like $env:TEMP.
+      #
+      # @param path [String] the remote path that may contain PowerShell env vars
+      # @return [String] the resolved path
+      # @api private
+      def resolve_remote_path(path)
+        return path unless windows_os?
+
+        # For Windows, resolve common PowerShell environment variables
+        resolved_path = path.dup
+
+        # Replace $env:TEMP with the actual Windows temp directory based on the transport username
+        if resolved_path.include?("$env:TEMP")
+          # Try to get username from transport configuration
+          # For Windows systems, fallback to "Administrator" if not found
+          username = begin
+            instance.transport[:username]
+                     rescue
+                       nil
+          end
+          username ||= "Administrator"
+
+          temp_path = "C:/Users/#{username}/AppData/Local/Temp"
+          resolved_path = resolved_path.gsub("$env:TEMP", temp_path)
+        end
+
+        # Convert backslashes to forward slashes for cross-platform compatibility
+        resolved_path.tr("\\", "/")
+      end
     end
   end
 end

data/lib/kitchen/provisioner/shell.rb

@@ -115,7 +115,7 @@ module Kitchen
           end
         end
 
-        code = powershell_shell? ? %{& #{script}} : sudo(script)
+        code = powershell_shell? ? %{& "#{script}"} : sudo(script)
 
         prefix_command(wrap_shell_code(code))
       end

data/lib/kitchen/shell_out.rb

@@ -23,7 +23,7 @@ module Kitchen
   #
   # @author Fletcher Nichol <fnichol@nichol.ca>
   module ShellOut
-    # Wrapped exception for any interally raised shell out commands.
+    # Wrapped exception for any internally raised shell out commands.
     class ShellCommandFailed < TransientFailure; end
 
     # Executes a command in a subshell on the local running system.

data/lib/kitchen/transport/ssh.rb

@@ -364,7 +364,9 @@ module Kitchen
           logger.debug(masked_string)
           yield
         rescue *RESCUE_EXCEPTIONS_ON_ESTABLISH => e
-          if (opts[:retries] -= 1) > 0
+          retries_left = opts[:retries] - 1
+          if retries_left > 0
+            opts[:retries] = retries_left
             message = if opts[:message]
                         logger.debug("[SSH] connection failed (#{e.inspect})")
                         opts[:message]

data/lib/kitchen/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-kitchen
 version: !ruby/object:Gem::Version
-  version: 3.7.2
+  version: 3.8.1
 platform: ruby
 authors:
 - Fletcher Nichol
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-07-03 00:00:00.000000000 Z
+date: 2025-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcrypt_pbkdf