test-kitchen 3.2.1 → 3.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d13b33db25f75d1d7f7a89d6da2a7eb2e78da9a8c7416ed6cf7a8d72e2e690a2
-  data.tar.gz: bb0352e0588277a0cff8d03364e09608cbd4f68218824a041d26d2f7c3c74a4b
+  metadata.gz: cbe0ba6a501464b8f253beca9d017b7d09a90fa5f4407e775d5fe31b81f610da
+  data.tar.gz: c7e0c062a903e1be1fd5425f692fecdd28d29841a5bee156b89a0d7149a25b10
 SHA512:
-  metadata.gz: 3d6cd7cdfff82e128a602f8eab578834168051940aadb50fdee9988f45ae9baa1b20053dc8580e69ce70ad160edb4d46e8bdf458cf36245a4dff97d13f128175
-  data.tar.gz: f05de5e3be22a367cdafb162e70651fcf9b9f881d8948654988c93648f650619ef63b2b2cf70d55b0818e94f057695c06465cf59f5a9168aa085ebb4710aa1f3
+  metadata.gz: abb1d27365dcdbfe5eaccffe717d7391f63a8784a75ee79bb44b8a5ba23d72d17bd7bd01a3d375454111ddcd0425874f0fa7b14dcdd2cf461ccdf978426f99c3
+  data.tar.gz: 6bd22f60e9f13a0b74f1c4c4598be74071640f5593f7039f030aa5c95de1a595e5a6401eb092eee2f165715d28202bb0b43324e16b5393a96dc256b993d05109

data/Gemfile

@@ -17,5 +17,5 @@ group :debug do
 end
 
 group :chefstyle do
-  gem "chefstyle", "2.1.0"
+  gem "chefstyle", "2.2.2"
 end

data/lib/kitchen/configurable.rb

@@ -241,7 +241,7 @@ module Kitchen
           #{deprecated_config.keys.join("\n")}
           Run 'kitchen doctor' for details.
         MSG
-        warn(warning)
+        Error.warn_on_stderr(warning)
 
         # Set global var that the deprecation message has been printed
         @@has_been_warned_of_deprecations = true

data/lib/kitchen/driver/ssh_base.rb

@@ -70,7 +70,7 @@ module Kitchen
       def converge(state) # rubocop:disable Metrics/AbcSize
         provisioner = instance.provisioner
         provisioner.create_sandbox
-        sandbox_dirs = Util.list_directory(provisioner.sandbox_path)
+        sandbox_dirs = provisioner.sandbox_dirs
 
         instance.transport.connection(backcompat_merged_state(state)) do |conn|
           conn.execute(env_cmd(provisioner.install_command))

data/lib/kitchen/errors.rb

@@ -94,6 +94,19 @@ module Kitchen
         "".center(22, "-"),
       ]
     end
+
+    # Log a warn message on STDERR device.
+    # This will help to distinguish between the errors and
+    # output when parsing the output from the commands like
+    # kitchen diagnose.
+    #
+    # @params lines [Array<String>] Array of lines that needs to be printed
+    def self.warn_on_stderr(lines)
+      Array(lines).each do |line|
+        line = Color.colorize(line, :blue) if Kitchen.tty?
+        $stderr.puts(line)
+      end
+    end
   end
 
   # Base exception class from which all Kitchen exceptions derive. This class

data/lib/kitchen/provisioner/base.rb

@@ -70,7 +70,6 @@ module Kitchen
       # rubocop:disable Metrics/AbcSize
       def call(state)
         create_sandbox
-        sandbox_dirs = Util.list_directory(sandbox_path)
 
         instance.transport.connection(state) do |conn|
           config[:uploads].to_h.each do |locals, remote|
@@ -182,6 +181,13 @@ module Kitchen
           "trying to access the path."
       end
 
+      # Returns the list of items in the sandbox directory
+      #
+      # @return [String] path of items in the sandbox directory
+      def sandbox_dirs
+        Util.list_directory(sandbox_path)
+      end
+
       # Deletes the sandbox path. Without calling this method, the sandbox path
       # will persist after the process terminates. In other words, cleanup is
       # explicit. This method is safe to call multiple times.

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

@@ -289,7 +289,8 @@ module Kitchen
             policyfile, sandbox_path,
             logger: logger,
             always_update: config[:always_update_cookbooks],
-            policy_group: policy_group
+            policy_group: policy_group,
+            license: config[:chef_license]
           )
           Kitchen.mutex.synchronize do
             policy.compile
@@ -308,7 +309,8 @@ module Kitchen
               policyfile, sandbox_path,
               logger: logger,
               always_update: config[:always_update_cookbooks],
-              policy_group: config[:policy_group]
+              policy_group: config[:policy_group],
+              license: config[:chef_license]
             ).resolve
           end
         end

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

@@ -41,12 +41,13 @@ module Kitchen
         #   cookbooks
         # @param logger [Kitchen::Logger] a logger to use for output, defaults
         #   to `Kitchen.logger`
-        def initialize(policyfile, path, logger: Kitchen.logger, always_update: false, policy_group: nil)
+        def initialize(policyfile, path, license: nil, logger: Kitchen.logger, always_update: false, policy_group: nil)
           @policyfile    = policyfile
           @path          = path
           @logger        = logger
           @always_update = always_update
           @policy_group  = policy_group
+          @license       = license
         end
 
         # Loads the library code required to use the resolver.
@@ -62,10 +63,10 @@ module Kitchen
         def resolve
           if policy_group
             info("Exporting cookbook dependencies from Policyfile #{path} with policy_group #{policy_group} using `#{cli_path} export`...")
-            run_command("#{cli_path} export #{escape_path(policyfile)} #{escape_path(path)} --policy_group #{policy_group} --force")
+            run_command("#{cli_path} export #{escape_path(policyfile)} #{escape_path(path)} --policy_group #{policy_group} --force --chef-license #{license}")
           else
             info("Exporting cookbook dependencies from Policyfile #{path} using `#{cli_path} export`...")
-            run_command("#{cli_path} export #{escape_path(policyfile)} #{escape_path(path)} --force")
+            run_command("#{cli_path} export #{escape_path(policyfile)} #{escape_path(path)} --force --chef-license #{license}")
           end
         end
 
@@ -77,11 +78,11 @@ module Kitchen
           else
             info("Policy lock file doesn't exist, running `#{cli_path} install` for Policyfile #{policyfile}...")
           end
-          run_command("#{cli_path} install #{escape_path(policyfile)}")
+          run_command("#{cli_path} install #{escape_path(policyfile)} --chef-license #{license}")
 
           if always_update
             info("Updating policy lock using `#{cli_path} update`")
-            run_command("#{cli_path} update #{escape_path(policyfile)}")
+            run_command("#{cli_path} update #{escape_path(policyfile)} --chef-license #{license}")
           end
         end
 
@@ -114,6 +115,10 @@ module Kitchen
         # @api private
         attr_reader :policy_group
 
+        # @return [String] name of the chef_license
+        # @api private
+        attr_reader :license
+
         # Escape spaces in a path in way that works with both Sh (Unix) and
         # Windows.
         #
@@ -152,7 +157,7 @@ module Kitchen
         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 " \
+                        "from https://www.chef.io/downloads/ 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

data/lib/kitchen/ssh.rb

@@ -23,6 +23,7 @@ require "socket" unless defined?(Socket)
 
 require_relative "errors"
 require_relative "login_command"
+require_relative "util"
 
 module Kitchen
   # Wrapped exception for any internally raised SSH-related errors.
@@ -75,7 +76,9 @@ module Kitchen
     # @param cmd [String] command string to execute
     # @raise [SSHFailed] if the command does not exit with a 0 code
     def exec(cmd)
-      logger.debug("[SSH] #{self} (#{cmd})")
+      string_to_mask = "[SSH] #{self} (#{cmd})"
+      masked_string = Util.mask_values(string_to_mask, %w{password ssh_http_proxy_password})
+      logger.debug(masked_string)
       exit_code = exec_with_exit(cmd)
 
       if exit_code != 0
@@ -137,7 +140,9 @@ module Kitchen
     def shutdown
       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.shutdown!
     ensure
       @session = nil
@@ -212,7 +217,9 @@ module Kitchen
       retries = options[:ssh_retries] || 3
 
       begin
-        logger.debug("[SSH] opening connection to #{self}")
+        string_to_mask = "[SSH] opening connection to #{self}"
+        masked_string = Util.mask_values(string_to_mask, %w{password ssh_http_proxy_password})
+        logger.debug(masked_string)
         Net::SSH.start(hostname, username, options)
       rescue *rescue_exceptions => e
         retries -= 1

data/lib/kitchen/transport/base.rb

@@ -128,8 +128,8 @@ module Kitchen
             tries += 1
             debug("Attempting to execute command - try #{tries} of #{max_retries}.")
             execute(command)
-          rescue Kitchen::Transport::TransportFailed => e
-            if retry?(tries, max_retries, retryable_exit_codes, e.exit_code)
+          rescue Exception => e
+            if retry?(tries, max_retries, retryable_exit_codes, e)
               close
               sleep wait_time
               retry
@@ -139,10 +139,14 @@ module Kitchen
           end
         end
 
-        def retry?(current_try, max_retries, retryable_exit_codes, exit_code)
-          current_try <= max_retries &&
-            !retryable_exit_codes.nil? &&
-            retryable_exit_codes.flatten.include?(exit_code)
+        def retry?(current_try, max_retries, retryable_exit_codes, exception)
+          if exception.is_a?(Kitchen::Transport::TransportFailed)
+            return current_try <= max_retries &&
+                !retryable_exit_codes.nil? &&
+                retryable_exit_codes.flatten.include?(exception.exit_code)
+          end
+
+          false
         end
 
         # Builds a LoginCommand which can be used to open an interactive

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
@@ -352,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
@@ -541,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)
@@ -555,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"]
@@ -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)
@@ -174,6 +173,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.2.1".freeze
+  VERSION = "3.3.1".freeze
 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

@@ -42,9 +42,9 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "bundler"
   gem.add_development_dependency "rake"
 
-  gem.add_development_dependency "aruba",     "~> 0.11", "< 1.0"
+  gem.add_development_dependency "aruba",     ">= 0.11", "< 3.0"
   gem.add_development_dependency "fakefs",    "~> 1.0"
-  gem.add_development_dependency "minitest",  "~> 5.3", "< 5.15"
+  gem.add_development_dependency "minitest",  "~> 5.3", "< 5.16"
   gem.add_development_dependency "mocha",     "~> 1.1"
   gem.add_development_dependency "cucumber",  ">= 2.1", "< 8.0"
   gem.add_development_dependency "countloc",  "~> 0.4"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-kitchen
 version: !ruby/object:Gem::Version
-  version: 3.2.1
+  version: 3.3.1
 platform: ruby
 authors:
 - Fletcher Nichol
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-29 00:00:00.000000000 Z
+date: 2022-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mixlib-shellout
@@ -274,22 +274,22 @@ dependencies:
   name: aruba
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.11'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        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: '1.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: fakefs
   requirement: !ruby/object:Gem::Requirement
@@ -313,7 +313,7 @@ dependencies:
         version: '5.3'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.15'
+        version: '5.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -323,7 +323,7 @@ dependencies:
         version: '5.3'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.15'
+        version: '5.16'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -520,7 +520,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.11
 signing_key:
 specification_version: 4
 summary: Test Kitchen is an integration tool for developing and testing infrastructure