test-kitchen 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ca7e5ea2276e74e8d5d6555731377aa0aacce64482f3ff810f18bca54095616
-  data.tar.gz: a726dfed16b6c6177559ed80a6450573fda9b9d3777aa008b3d639a81f152201
+  metadata.gz: c0f0f59e09f9a2d65a94c33e6c0e833b7fc86958d88d42ef71f4934196cd809f
+  data.tar.gz: aa0bcc30665a7628da122d74354f113965dbdc86e0b68faa1b275fd30cdbbeb5
 SHA512:
-  metadata.gz: 69456998d9b85ad5d28f522a98d7668279081c67a5c8dbdf17b299de2a8364d65064a641088d32f0dd820305beb07263ca0f2c66c49f6e433b9b9a3c49fe2b9b
-  data.tar.gz: c24f12f481427bf8a259afaaf09b93efe23c2d27632083fc3b78a25182a35e37f2fcfabf8344a7f0b30745a27b205904e21e247540e486e13f9810b8831db039
+  metadata.gz: 726d1016370af32c8a40f8877a51a9ff5c3bc4e7f57952318bdfdb3cd8356c0fe3b326ea67596299447cdbd9c5cf915f1c3f2ec41ea0b88b4427526ff0c99a32
+  data.tar.gz: 40d835a7607f6de437bbdb8cd03c720891bc6d8e9417c986f2e9ef5abeded7c7c4957ef0fff727d16152d0e4a967cfe76e9507b02bfff9489498d02d31c6447a

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/provisioner/chef_base.rb

@@ -681,25 +681,42 @@ module Kitchen
         chef_cmds(base_cmd).join(separator)
       end
 
-      # Gives an array of command
+      # Gives an array of commands
       # @api private
       def chef_cmds(base_cmd)
-        cmd = prefix_command(wrap_shell_code(
-          [base_cmd, *chef_args(config_filename), last_exit_code].join(" ")
-          .tap { |str| str.insert(0, reload_ps1_path) if windows_os? }
-        ))
-
-        cmds = [cmd].cycle(config[:multiple_converge].to_i).to_a
-
-        if config[:enforce_idempotency]
-          idempotent_cmd = prefix_command(wrap_shell_code(
-            [base_cmd, *chef_args("client_no_updated_resources.rb"), last_exit_code].join(" ")
-            .tap { |str| str.insert(0, reload_ps1_path) if windows_os? }
-          ))
-          cmds[-1] = idempotent_cmd
+        cmds = []
+        num_converges = config[:multiple_converge].to_i
+        idempotency   = config[:enforce_idempotency]
+
+        # Execute Chef Client n-1 times, without exiting
+        (num_converges - 1).times do
+          cmds << wrapped_chef_cmd(base_cmd, config_filename)
         end
+
+        # Append another execution with Windows specific Exit code helper or (for
+        # idempotency check) a specific config file which assures no changed resources.
+        cmds << unless idempotency
+                  wrapped_chef_cmd(base_cmd, config_filename, append: last_exit_code)
+                else
+                  wrapped_chef_cmd(base_cmd, "client_no_updated_resources.rb", append: last_exit_code)
+                end
         cmds
       end
+
+      # Concatenate all arguments and wrap it with shell-specifics
+      # @api private
+      def wrapped_chef_cmd(base_cmd, configfile, append: "")
+        args = []
+
+        args << base_cmd
+        args << chef_args(configfile)
+        args << append
+
+        shell_cmd = args.flatten.join(" ")
+        shell_cmd = shell_cmd.prepend(reload_ps1_path) if windows_os?
+
+        prefix_command(wrap_shell_code(shell_cmd))
+      end
     end
   end
 end

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/winrm.rb

@@ -21,6 +21,7 @@ require "rbconfig" unless defined?(RbConfig)
 require "uri" unless defined?(URI)
 require_relative "../../kitchen"
 require "winrm" unless defined?(WinRM::Connection)
+require "winrm/exceptions" unless defined?(WinRM::WinRMHTTPTransportError)
 
 module Kitchen
   module Transport
@@ -118,6 +119,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"]

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.0".freeze
+  VERSION = "3.3.0".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.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Fletcher Nichol
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-17 00:00:00.000000000 Z
+date: 2022-06-14 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.7
 signing_key:
 specification_version: 4
 summary: Test Kitchen is an integration tool for developing and testing infrastructure