test-kitchen 3.1.0 → 3.6.0

data/lib/kitchen/transport/ssh.rb

@@ -16,6 +16,7 @@
 # limitations under the License.
 
 require_relative "../../kitchen"
+require_relative "../util"
 
 require "fileutils" unless defined?(FileUtils)
 require "net/ssh" unless defined?(Net::SSH)
@@ -102,7 +103,9 @@ module Kitchen
       # (see Base#cleanup!)
       def cleanup!
         if @connection
-          logger.debug("[SSH] shutting previous connection #{@connection}")
+          string_to_mask = "[SSH] shutting previous connection #{@connection}"
+          masked_string = Util.mask_values(string_to_mask, %w{password ssh_http_proxy_password})
+          logger.debug(masked_string)
           @connection.close
           @connection = @connection_options = nil
         end
@@ -125,7 +128,9 @@ module Kitchen
         def close
           return if @session.nil?
 
-          logger.debug("[SSH] closing connection to #{self}")
+          string_to_mask = "[SSH] closing connection to #{self}"
+          masked_string = Util.mask_values(string_to_mask, %w{password ssh_http_proxy_password})
+          logger.debug(masked_string)
           session.close
         ensure
           @session = nil
@@ -135,7 +140,9 @@ module Kitchen
         def execute(command)
           return if command.nil?
 
-          logger.debug("[SSH] #{self} (#{command})")
+          string_to_mask = "[SSH] #{self} (#{command})"
+          masked_string = Util.mask_values(string_to_mask, %w{password ssh_http_proxy_password})
+          logger.debug(masked_string)
           exit_code = execute_with_exit_code(command)
 
           if exit_code != 0
@@ -176,9 +183,11 @@ module Kitchen
             Array(locals).map do |local|
               opts = File.directory?(local) ? { recursive: true } : {}
 
-              waits.push session.scp.upload(local, remote, opts) do |_ch, name, sent, total|
-                logger.debug("Async Uploaded #{name} (#{total} bytes)") if sent == total
-              end
+              waits.push(
+                session.scp.upload(local, remote, opts) do |_ch, name, sent, total|
+                  logger.debug("Async Uploaded #{name} (#{total} bytes)") if sent == total
+                end
+              )
               waits.shift.wait while waits.length >= max_ssh_sessions
             end
             waits.each(&:wait)
@@ -216,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"
           )
@@ -350,7 +359,9 @@ module Kitchen
         def retry_connection(opts)
           log_msg = "[SSH] opening connection to #{self}"
           log_msg += " via #{ssh_gateway_username}@#{ssh_gateway}:#{ssh_gateway_port}" if ssh_gateway
-          logger.debug(log_msg)
+          masked_string = Util.mask_values(log_msg, %w{password ssh_http_proxy_password})
+
+          logger.debug(masked_string)
           yield
         rescue *RESCUE_EXCEPTIONS_ON_ESTABLISH => e
           if (opts[:retries] -= 1) > 0
@@ -457,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],
@@ -539,7 +550,7 @@ module Kitchen
       # Creates a new SSH Connection instance and save it for potential future
       # reuse.
       #
-      # @param options [Hash] conneciton options
+      # @param options [Hash] connection options
       # @return [Ssh::Connection] an SSH Connection instance
       # @api private
       def create_new_connection(options, &block)
@@ -553,7 +564,9 @@ module Kitchen
       # @return [Ssh::Connection] an SSH Connection instance
       # @api private
       def reuse_connection
-        logger.debug("[SSH] reusing existing connection #{@connection}")
+        string_to_mask = "[SSH] reusing existing connection #{@connection}"
+        masked_string = Util.mask_values(string_to_mask, %w{password ssh_http_proxy_password})
+        logger.debug(masked_string)
         yield @connection if block_given?
         @connection
       end

data/lib/kitchen/transport/winrm.rb

@@ -20,7 +20,9 @@
 require "rbconfig" unless defined?(RbConfig)
 require "uri" unless defined?(URI)
 require_relative "../../kitchen"
+require_relative "../util"
 require "winrm" unless defined?(WinRM::Connection)
+require "winrm/exceptions" unless defined?(WinRM::WinRMHTTPTransportError)
 
 module Kitchen
   module Transport
@@ -103,7 +105,9 @@ module Kitchen
         def execute(command)
           return if command.nil?
 
-          logger.debug("[WinRM] #{self} (#{command})")
+          string_to_mask = "[WinRM] #{self} (#{command})"
+          masked_string = Util.mask_values(string_to_mask, %w{password ssh_http_proxy_password})
+          logger.debug(masked_string)
 
           exit_code, stderr = execute_with_exit_code(command)
 
@@ -118,6 +122,22 @@ module Kitchen
           end
         end
 
+        def retry?(current_try, max_retries, retryable_exit_codes, exception)
+          # Avoid duplicating Kitchen::Transport::Base#retry?
+          result = super
+          return result if result == true
+
+          case exception
+          when WinRM::WinRMHTTPTransportError
+            return current_try <= max_retries &&
+                [400, 500].include?(exception.status_code)
+          when WinRM::WinRMWSManFault
+            return current_try <= max_retries
+          end
+
+          false
+        end
+
         # (see Base::Connection#login_command)
         def login_command
           case RbConfig::CONFIG["host_os"]
@@ -238,10 +258,10 @@ module Kitchen
           end
         end
 
-        # Execute a Powershell script over WinRM and return the command's
+        # Execute a PowerShell script over WinRM and return the command's
         # exit code and standard error.
         #
-        # @param command [String] Powershell script to execute
+        # @param command [String] PowerShell script to execute
         # @return [[Integer,String]] an array containing the exit code of the
         #   script and the standard error stream
         # @api private
@@ -424,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],
@@ -437,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)
@@ -477,12 +497,14 @@ module Kitchen
       # Creates a new WinRM Connection instance and save it for potential
       # future reuse.
       #
-      # @param options [Hash] conneciton options
+      # @param options [Hash] connection options
       # @return [Ssh::Connection] a WinRM Connection instance
       # @api private
       def create_new_connection(options, &block)
         if @connection
-          logger.debug("[WinRM] shutting previous connection #{@connection}")
+          string_to_mask = "[WinRM] shutting previous connection #{@connection}"
+          masked_string = Util.mask_values(string_to_mask, %w{password ssh_http_proxy_password})
+          logger.debug(masked_string)
           @connection.close
         end
 
@@ -542,7 +564,9 @@ module Kitchen
       # @return [Winrm::Connection] a WinRM Connection instance
       # @api private
       def reuse_connection
-        logger.debug("[WinRM] reusing existing connection #{@connection}")
+        string_to_mask = "[WinRM] reusing existing connection #{@connection}"
+        masked_string = Util.mask_values(string_to_mask, %w{password ssh_http_proxy_password})
+        logger.debug(masked_string)
         yield @connection if block_given?
         @connection
       end

data/lib/kitchen/util.rb

@@ -88,6 +88,19 @@ module Kitchen
       end
     end
 
+    # Returns a string with masked values for specified parameters.
+    #
+    # @param string_to_mask [String] the object whose string representation is parsed
+    # @param [Array] the list of keys whose values should be masked
+    # @return [String] the string representation of passed object with masked values
+    def self.mask_values(string_to_mask, keys)
+      masked_string = string_to_mask
+      keys.each do |key|
+        masked_string.gsub!(/:#{key}=>"([^"]*)"/, %{:#{key}=>"******"})
+      end
+      masked_string
+    end
+
     # Returns a formatted string representing a duration in seconds.
     #
     # @param total [Integer] the total number of seconds

data/lib/kitchen/verifier/base.rb

@@ -65,7 +65,6 @@ module Kitchen
       # @raise [ActionFailed] if the action could not be completed
       def call(state)
         create_sandbox
-        sandbox_dirs = Util.list_directory(sandbox_path)
 
         instance.transport.connection(state) do |conn|
           conn.execute(install_command)
@@ -74,14 +73,17 @@ module Kitchen
           conn.upload(sandbox_dirs, config[:root_path])
           debug("Transfer complete")
           conn.execute(prepare_command)
-          conn.execute(run_command)
 
-          info("Downloading files from #{instance.to_str}")
-          config[:downloads].to_h.each do |remotes, local|
-            debug("Downloading #{Array(remotes).join(", ")} to #{local}")
-            conn.download(remotes, local)
+          begin
+            conn.execute(run_command)
+          ensure
+            info("Downloading files from #{instance.to_str}")
+            config[:downloads].to_h.each do |remotes, local|
+              debug("Downloading #{Array(remotes).join(", ")} to #{local}")
+              conn.download(remotes, local)
+            end
+            debug("Download complete")
           end
-          debug("Download complete")
         end
       rescue Kitchen::Transport::TransportFailed => ex
         raise ActionFailed, ex.message
@@ -174,6 +176,13 @@ module Kitchen
            "trying to access the path."
       end
 
+      # Returns the list of items in the sandbox directory
+      #
+      # @return [String] the absolute path of sandbox directory files
+      def sandbox_dirs
+        Util.list_directory(sandbox_path)
+      end
+
       # Sets the API version for this verifier. If the verifier does not set
       # this value, then `nil` will be used and reported.
       #

data/lib/kitchen/version.rb

@@ -16,5 +16,5 @@
 # limitations under the License.
 
 module Kitchen
-  VERSION = "3.1.0".freeze
+  VERSION = "3.6.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/templates/driver/README.md.erb

@@ -58,7 +58,7 @@ Created and maintained by [<%= config[:author] %>][author] (<<%= config[:email]
 
 [author]:           https://github.com/enter-github-user
 [issues]:           https://github.com/enter-github-user/<%= config[:gem_name] %>/issues
-[license]:          https://github.com/enter-github-user/<%= config[:gem_name] %>/blob/master/LICENSE
+[license]:          https://github.com/enter-github-user/<%= config[:gem_name] %>/blob/main/LICENSE
 [repo]:             https://github.com/enter-github-user/<%= config[:gem_name] %>
-[driver_usage]:     http://docs.kitchen-ci.org/drivers/usage
+[driver_usage]:     https://kitchen.ci/docs/drivers/
 [chef_omnibus_dl]:  http://www.chef.io/chef/install/

data/test-kitchen.gemspec

@@ -20,33 +20,21 @@ Gem::Specification.new do |gem|
   gem.executables   = %w{kitchen}
   gem.require_paths = ["lib"]
 
-  gem.required_ruby_version = ">= 2.6"
+  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"
+  gem.add_dependency "ed25519",            "~> 1.2" # ed25519 ssh key support
+  gem.add_dependency "mixlib-install",     "~> 3.6"
   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
-  gem.add_dependency "net-ssh",            ">= 2.9", "< 7.0" # pinning until we can confirm 7+ works
+  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
   gem.add_dependency "net-ssh-gateway",    ">= 1.2", "< 3.0" # pinning until we can confirm 3+ works
-  gem.add_dependency "ed25519",            "~> 1.2" # ed25519 ssh key support
-  gem.add_dependency "bcrypt_pbkdf",       "~> 1.0" # ed25519 ssh key support
   gem.add_dependency "thor",               ">= 0.19", "< 2.0"
-  gem.add_dependency "mixlib-install",     "~> 3.6"
   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
-
-  gem.add_development_dependency "rb-readline"
-  gem.add_development_dependency "bundler"
-  gem.add_development_dependency "rake"
-
-  gem.add_development_dependency "aruba",     "~> 0.11", "< 1.0"
-  gem.add_development_dependency "fakefs",    "~> 1.0"
-  gem.add_development_dependency "minitest",  "~> 5.3", "< 5.15"
-  gem.add_development_dependency "mocha",     "~> 1.1"
-  gem.add_development_dependency "cucumber",  ">= 2.1", "< 8.0"
-  gem.add_development_dependency "countloc",  "~> 0.4"
-  gem.add_development_dependency "maruku",    "~> 0.6"
 end