test-kitchen 2.10.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51ed51940914e0c4ffb30d1e11be2e3554289833261e0b418eaa2ebdb674cab9
-  data.tar.gz: c3c9be7593e1c0c333102168228c84e217244c5071da0bfb2ba543edca7581ba
+  metadata.gz: 7cff7935683511121e07b20e636078776ae80c20fc007b5b08a922ce76e0ce94
+  data.tar.gz: 8207e168e7faf42b8239438753c58f2a9a37fc4f4f2dcd9728948f67b4a5afb9
 SHA512:
-  metadata.gz: 59633a6df2c274542ee3d4c649c55f8632077a98476ee655a1f59c0b39d42fad9077294b0e615d8e7f697feef4cbb027a9df7be81708832760d45eee72fbf159
-  data.tar.gz: 34164cc7046bb2aa507fa33373c928d94be84284a99ba629562c585614c1818d032a42a1b2b83ab0b95382e984841be63a2dc32a05412dbf8d60a15839325146
+  metadata.gz: 46356119baf46a5ec115cc036c81778e8f17ac2dca6a21733d7bb4ef8779d7d23724ef295cd1f0557083abe577578ff28eec2bb5d9a4596359d8c5c34ea0379b
+  data.tar.gz: 7770f0e415279795ecf2106a6005f7b1514bd692be9a5839d24e992ad4e03dcbbe33dd86892904b1dd87a73473a3484d3f44518f7b87211d1c340c3f94abd6a3

data/Gemfile

@@ -1,4 +1,6 @@
 source "https://rubygems.org"
+
+# Specify your gem"s dependencies in test-kitchen.gemspec
 gemspec
 
 group :integration do
@@ -8,20 +10,12 @@ group :integration do
   gem "kitchen-vagrant"
 end
 
-group :changelog do
-  gem "github_changelog_generator", "1.15.2"
-end
-
 group :debug do
-  gem "pry"
+  gem "pry", "~>0.12"
   gem "pry-byebug"
   gem "pry-stack_explorer"
 end
 
 group :chefstyle do
-  gem "chefstyle"
-end
-
-group :docs do
-  gem "yard"
-end
+  gem "chefstyle", "2.0.5"
+end

data/Rakefile

@@ -11,7 +11,7 @@ begin
   require "cucumber"
   require "cucumber/rake/task"
   Cucumber::Rake::Task.new(:features) do |t|
-    t.cucumber_opts = ["features", "-x", "--format progress", "--no-color", "--tags ~@ignore"]
+    t.cucumber_opts = ["features", "-x", "--format progress", "--no-color", "--tags 'not @ignore'"]
   end
 rescue LoadError
   puts "cucumber is not available. (sudo) gem install cucumber to run tests."
@@ -41,30 +41,8 @@ end
 desc "Run all quality tasks"
 task quality: %i{style stats}
 
-begin
-  require "yard" unless defined?(YARD)
-  YARD::Rake::YardocTask.new
-rescue LoadError
-  puts "yard is not available. (sudo) gem install yard to generate yard documentation."
-end
-
 task default: %i{test quality}
 
-begin
-  require "github_changelog_generator/task"
-  require "kitchen/version"
-
-  GitHubChangelogGenerator::RakeTask.new :changelog do |config|
-    config.future_release = "v#{Kitchen::VERSION}"
-    config.enhancement_labels = "enhancement,Enhancement,New Feature,Feature,Improvement".split(",")
-    config.bug_labels = "bug,Bug".split(",")
-    config.exclude_labels = %w{Duplicate Question Discussion No_Changelog}
-  end
-rescue LoadError
-  puts "github_changelog_generator is not available." \
-       " (sudo) gem install github_changelog_generator to generate changelogs"
-end
-
 namespace :docs do
   desc "Deploy docs"
   task :deploy do

data/lib/kitchen/chef_utils_wiring.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+#
+# Copyright:: Copyright (c) Chef Software 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
+#
+#     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.
+#
+
+module Kitchen
+  # Common Dependency Injection wiring for ChefUtils-related modules
+  module ChefUtilsWiring
+    private
+
+    def __config
+      # this would need to be some kind of Chef::Config looking thing, which probably requires
+      # a translation object from t-k config to Chef::Config layout if that ever becomes necessary.
+      # this ISNT the t-k config.
+      {}
+    end
+
+    def __log
+      @logger
+    end
+
+    def __transport_connection
+      # this could be wired up to train at some point, but need to be careful because about local vs. remote
+      # uses of helpers with test-kitchen, right now we're using it for local.
+    end
+  end
+end

data/lib/kitchen/cli.rb

@@ -285,7 +285,7 @@ module Kitchen
       perform("exec", "exec", args)
     end
 
-    desc "version", "Print Kitchen's version information"
+    desc "version", "Print Test Kitchen's version information"
     def version
       puts "Test Kitchen version #{Kitchen::VERSION}"
     end
@@ -296,7 +296,7 @@ module Kitchen
       perform("sink", "sink")
     end
 
-    desc "console", "Kitchen Console!"
+    desc "console", "Test Kitchen Console!"
     def console
       perform("console", "console")
     end

data/lib/kitchen/command/console.rb

@@ -43,7 +43,7 @@ module Kitchen
       def prompt(char)
         proc do |target_self, nest_level, pry|
           [
-            "[#{pry.input_array.size}] ",
+            "[#{pry.input_ring.size}] ",
             "kc(#{Pry.view_clip(target_self.class)})",
             "#{":#{nest_level}" unless nest_level == 0}#{char} ",
           ].join

data/lib/kitchen/configurable.rb

@@ -149,7 +149,7 @@ module Kitchen
     # @return [String] joined path for instance's os_type
     def remote_path_join(*parts)
       path = File.join(*parts)
-      windows_os? ? path.tr("/", '\\') : path.tr('\\', "/")
+      windows_os? ? path.tr("/", "\\") : path.tr("\\", "/")
     end
 
     # @return [TrueClass,FalseClass] true if `:os_type` is `"unix"` (or

data/lib/kitchen/data_munger.rb

@@ -720,12 +720,14 @@ module Kitchen
         move_data_to!(:provisioner, suite, :attributes)
         move_data_to!(:provisioner, suite, :run_list)
         move_data_to!(:provisioner, suite, :named_run_list)
+        move_data_to!(:provisioner, suite, :policy_group)
       end
 
       data.fetch(:platforms, []).each do |platform|
         move_data_to!(:provisioner, platform, :attributes)
         move_data_to!(:provisioner, platform, :run_list)
         move_data_to!(:provisioner, platform, :named_run_list)
+        move_data_to!(:provisioner, platform, :policy_group)
       end
     end
 

data/lib/kitchen/lifecycle_hook/remote.rb

@@ -18,8 +18,14 @@ module Kitchen
           end
         end
 
-        conn = instance.transport.connection(state_file.read)
-        conn.execute(command)
+        begin
+          conn = instance.transport.connection(state_file.read)
+          conn.execute(command)
+        rescue Kitchen::Transport::SshFailed => e
+          return if hook[:skippable] && e.message.match(/^SSH exited \(\d{1,3}\) for command: \[.+\]$/)
+
+          raise
+        end
       end
 
       private

data/lib/kitchen/logger.rb

@@ -293,11 +293,11 @@ module Kitchen
       logger = StdoutLogger.new(stdout)
       if colorize
         logger.formatter = proc do |_severity, _datetime, _progname, msg|
-          Color.colorize(msg.to_s, color).concat("\n")
+          Color.colorize(msg.dup.to_s, color).concat("\n")
         end
       else
         logger.formatter = proc do |_severity, _datetime, _progname, msg|
-          msg.concat("\n")
+          msg.dup.concat("\n")
         end
       end
       logger

data/lib/kitchen/provisioner.rb

@@ -2,6 +2,7 @@
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #
 # Copyright (C) 2013, Fletcher Nichol
+# Copyright (C) Chef Software Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -25,7 +26,7 @@ module Kitchen
   # @author Fletcher Nichol <fnichol@nichol.ca>
   module Provisioner
     # Default provisioner to use
-    DEFAULT_PLUGIN = "chef_solo".freeze
+    DEFAULT_PLUGIN = "chef_infra".freeze
 
     # Returns an instance of a provisioner given a plugin type string.
     #
@@ -34,6 +35,7 @@ module Kitchen
     # @return [Provisioner::Base] a provisioner instance
     # @raise [ClientError] if a provisioner instance could not be created
     def self.for_plugin(plugin, config)
+      plugin, config[:name] = "chef_infra", "chef_infra" if plugin == "chef_zero"
       Kitchen::Plugin.load(self, plugin, config)
     end
   end

data/lib/kitchen/provisioner/base.rb

@@ -74,7 +74,7 @@ module Kitchen
 
         instance.transport.connection(state) do |conn|
           config[:uploads].to_h.each do |locals, remote|
-            debug("Uploading #{Array(locals).join(', ')} to #{remote}")
+            debug("Uploading #{Array(locals).join(", ")} to #{remote}")
             conn.upload(locals.to_s, remote)
           end
           conn.execute(install_command)
@@ -177,11 +177,9 @@ module Kitchen
       # @raise [ClientError] if the sandbox directory has no yet been created
       #   by calling `#create_sandbox`
       def sandbox_path
-        @sandbox_path ||= begin
-          raise ClientError, "Sandbox directory has not yet " \
+        @sandbox_path ||= raise ClientError, "Sandbox directory has not yet " \
           "been created. Please run #{self.class}#create_sandox before " \
           "trying to access the path."
-        end
       end
 
       # Deletes the sandbox path. Without calling this method, the sandbox path

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

@@ -73,6 +73,10 @@ module Kitchen
         # @api private
         attr_reader :sandbox_path
 
+        # @return [String] name of the policy_group, nil results in "local"
+        # @api private
+        attr_reader :policy_group
+
         # Generates a list of all files in the cookbooks directory in the
         # sandbox path.
         #
@@ -281,19 +285,17 @@ module Kitchen
         end
 
         def update_dna_for_policyfile
-          if !config[:run_list].nil? && !config[:run_list].empty?
-            warn("You must set your run_list in your Policyfile instead of "\
-                 "kitchen config. The run_list in your config will be ignored.")
-            warn("Ignored run_list: #{config[:run_list].inspect}")
-          end
-          policy = Chef::Policyfile.new(policyfile, sandbox_path,
+          policy = Chef::Policyfile.new(
+            policyfile, sandbox_path,
             logger: logger,
-            always_update: config[:always_update_cookbooks])
+            always_update: config[:always_update_cookbooks],
+            policy_group: policy_group
+          )
           Kitchen.mutex.synchronize do
             policy.compile
           end
           policy_name = JSON.parse(IO.read(policy.lockfile))["name"]
-          policy_group = "local"
+          policy_group = config[:policy_group] || "local"
           config[:attributes].merge(policy_name: policy_name, policy_group: policy_group)
         end
 
@@ -302,9 +304,12 @@ module Kitchen
         # @api private
         def resolve_with_policyfile
           Kitchen.mutex.synchronize do
-            Chef::Policyfile.new(policyfile, sandbox_path,
+            Chef::Policyfile.new(
+              policyfile, sandbox_path,
               logger: logger,
-              always_update: config[:always_update_cookbooks]).resolve
+              always_update: config[:always_update_cookbooks],
+              policy_group: config[:policy_group]
+            ).resolve
           end
         end
 

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

@@ -21,6 +21,7 @@ require "rbconfig" unless defined?(RbConfig)
 require_relative "../../errors"
 require_relative "../../logging"
 require_relative "../../shell_out"
+require_relative "../../which"
 
 module Kitchen
   module Provisioner
@@ -31,6 +32,7 @@ module Kitchen
       class Policyfile
         include Logging
         include ShellOut
+        include Which
 
         # Creates a new cookbook resolver.
         #
@@ -39,11 +41,12 @@ 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)
-          @policyfile = policyfile
-          @path       = path
-          @logger     = logger
+        def initialize(policyfile, path, logger: Kitchen.logger, always_update: false, policy_group: nil)
+          @policyfile    = policyfile
+          @path          = path
+          @logger        = logger
           @always_update = always_update
+          @policy_group  = policy_group
         end
 
         # Loads the library code required to use the resolver.
@@ -51,30 +54,34 @@ module Kitchen
         # @param logger [Kitchen::Logger] a logger to use for output, defaults
         #   to `Kitchen.logger`
         def self.load!(logger: Kitchen.logger)
-          detect_chef_command!(logger)
+          # intentionally left blank
         end
 
         # Performs the cookbook resolution and vendors the resulting cookbooks
         # in the desired path.
         def resolve
-          info("Exporting cookbook dependencies from Policyfile #{path}...")
-          run_command("chef export #{escape_path(policyfile)} #{escape_path(path)} --force")
+          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")
+          else
+            info("Exporting cookbook dependencies from Policyfile #{path} using `#{cli_path} export`...")
+            run_command("#{cli_path} export #{escape_path(policyfile)} #{escape_path(path)} --force")
+          end
         end
 
         # Runs `chef install` to determine the correct cookbook set and
         # generate the policyfile lock.
         def compile
           if File.exist?(lockfile)
-            info("Installing cookbooks for Policyfile #{policyfile} using `chef install`")
+            info("Installing cookbooks for Policyfile #{policyfile} using `#{cli_path} install`")
           else
-            info("Policy lock file doesn't exist, running `chef install` for "\
-                 "Policyfile #{policyfile}...")
+            info("Policy lock file doesn't exist, running `#{cli_path} install` for Policyfile #{policyfile}...")
           end
-          run_command("chef install #{escape_path(policyfile)}")
+          run_command("#{cli_path} install #{escape_path(policyfile)}")
 
           if always_update
-            info("Updating policy lock using `chef update`")
-            run_command("chef update #{escape_path(policyfile)}")
+            info("Updating policy lock using `#{cli_path} update`")
+            run_command("#{cli_path} update #{escape_path(policyfile)}")
           end
         end
 
@@ -103,6 +110,10 @@ module Kitchen
         # @api private
         attr_reader :always_update
 
+        # @return [String] name of the policy_group, nil results in "local"
+        # @api private
+        attr_reader :policy_group
+
         # Escape spaces in a path in way that works with both Sh (Unix) and
         # Windows.
         #
@@ -117,7 +128,7 @@ module Kitchen
             # Windows command line parsing libraries. This covers the 99% case of
             # spaces in the path without breaking other stuff.
             if /[ \t\n\v"]/.match?(path)
-              "\"#{path.gsub(/[ \t\n\v\"\\]/) { |m| '\\' + m[0] }}\""
+              "\"#{path.gsub(/[ \t\n\v\"\\]/) { |m| "\\" + m[0] }}\""
             else
               path
             end
@@ -126,33 +137,24 @@ module Kitchen
           end
         end
 
-        class << self
-          private
-
-          # Ensure the `chef` command is in the path.
-          #
-          # @param logger [Kitchen::Logger] the logger to use
-          # @raise [UserError] if the `chef` command is not in the PATH
-          # @api private
-          def detect_chef_command!(logger)
-            unless ENV["PATH"].split(File::PATH_SEPARATOR).any? do |path|
-              if /mswin|mingw/.match?(RbConfig::CONFIG["host_os"])
-                # Windows could have different extentions: BAT, EXE or NONE
-                %w{chef chef.exe chef.bat}.each do |bin|
-                  File.exist?(File.join(path, bin))
-                end
-              else
-                File.exist?(File.join(path, "chef"))
-              end
-            end
-              logger.fatal("The `chef` executable cannot be found in your " \
-                          "PATH. Ensure you have installed Chef Workstation " \
-                          "from https://downloads.chef.io and that your PATH " \
-                          "setting includes the path to the `chef` command.")
-              raise UserError,
-                "Could not find the chef executable in your PATH."
-            end
-          end
+        # Find the `chef` or `chef-cli` commands in the path or raise `chef` is present in
+        # ChefDK / Workstation releases, but is no longer shipped in any gems now that we
+        # use a Go based wrapper for the `chef` command in Workstation. The Ruby CLI has been
+        # renamed `chef-cli` under the hood and is shipped in the `chef-cli` gem.
+        #
+        # @api private
+        # @returns [String]
+        def cli_path
+          @cli_path ||= which("chef-cli") || which("chef") || no_cli_found_error
+        end
+
+        # @api private
+        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 " \
+                        "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
 
       end

data/lib/kitchen/provisioner/chef_base.rb

@@ -46,6 +46,7 @@ module Kitchen
       default_config :chef_omnibus_install_options, nil
       default_config :chef_license, nil
       default_config :run_list, []
+      default_config :policy_group, nil
       default_config :attributes, {}
       default_config :config_path, nil
       default_config :log_file, nil
@@ -63,7 +64,7 @@ module Kitchen
       default_config :berksfile_path, nil
       # If set to true (which is the default from `chef generate`), try to update
       # backend cookbook downloader on every kitchen run.
-      default_config :always_update_cookbooks, false
+      default_config :always_update_cookbooks, true
       default_config :cookbook_files_glob, %w(
         README.* VERSION metadata.{json,rb} attributes.rb recipe.rb
         attributes/**/* definitions/**/* files/**/* libraries/**/*
@@ -441,7 +442,7 @@ module Kitchen
         if obj.is_a?(String) && obj =~ /^:/
           obj
         elsif obj.is_a?(String)
-          %{"#{obj.gsub(/\\/, '\\\\\\\\')}"}
+          %{"#{obj.gsub(/\\/, "\\\\\\\\")}"}
         elsif obj.is_a?(Array)
           %{[#{obj.map { |i| format_value(i) }.join(", ")}]}
         else

data/lib/kitchen/provisioner/chef_infra.rb

@@ -0,0 +1,167 @@
+#
+# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
+#
+# Copyright (C) 2013, 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
+#
+#    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_base"
+
+module Kitchen
+  module Provisioner
+    # Chef Zero provisioner.
+    #
+    # @author Fletcher Nichol <fnichol@nichol.ca>
+    class ChefInfra < ChefBase
+      kitchen_provisioner_api_version 2
+
+      plugin_version Kitchen::VERSION
+
+      default_config :client_rb, {}
+      default_config :named_run_list, {}
+      default_config :json_attributes, true
+      default_config :chef_zero_host, nil
+      default_config :chef_zero_port, 8889
+
+      default_config :chef_client_path do |provisioner|
+        provisioner
+          .remote_path_join(%W{#{provisioner[:chef_omnibus_root]} bin chef-client})
+          .tap { |path| path.concat(".bat") if provisioner.windows_os? }
+      end
+
+      default_config :ruby_bindir do |provisioner|
+        provisioner
+          .remote_path_join(%W{#{provisioner[:chef_omnibus_root]} embedded bin})
+      end
+
+      # (see Base#create_sandbox)
+      def create_sandbox
+        super
+        prepare_validation_pem
+        prepare_config_rb
+      end
+
+      def run_command
+        cmd = "#{sudo(config[:chef_client_path])} --local-mode".tap { |str| str.insert(0, "& ") if powershell_shell? }
+
+        chef_cmd(cmd)
+      end
+
+      private
+
+      # Adds optional flags to a chef-client command, depending on
+      # configuration data. Note that this method mutates the incoming Array.
+      #
+      # @param args [Array<String>] array of flags
+      # @api private
+      # rubocop:disable Metrics/CyclomaticComplexity
+      def add_optional_chef_client_args!(args)
+        if config[:json_attributes]
+          json = remote_path_join(config[:root_path], "dna.json")
+          args << "--json-attributes #{json}"
+        end
+
+        args << "--logfile #{config[:log_file]}" if config[:log_file]
+
+        # these flags are chef-client local mode only and will not work
+        # on older versions of chef-client
+        if config[:chef_zero_host]
+          args << "--chef-zero-host #{config[:chef_zero_host]}"
+        end
+
+        if config[:chef_zero_port]
+          args << "--chef-zero-port #{config[:chef_zero_port]}"
+        end
+
+        args << "--profile-ruby" if config[:profile_ruby]
+
+        if config[:slow_resource_report]
+          if config[:slow_resource_report].is_a?(Integer)
+            args << "--slow-report #{config[:slow_resource_report]}"
+          else
+            args << "--slow-report"
+          end
+        end
+      end
+      # rubocop:enable Metrics/CyclomaticComplexity
+
+      # Returns an Array of command line arguments for the chef client.
+      #
+      # @return [Array<String>] an array of command line arguments
+      # @api private
+      def chef_args(client_rb_filename)
+        level = config[:log_level]
+        args = [
+            "--config #{remote_path_join(config[:root_path], client_rb_filename)}",
+            "--log_level #{level}",
+            "--force-formatter",
+            "--no-color",
+        ]
+        add_optional_chef_client_args!(args)
+
+        args
+      end
+
+      # Generates a string of shell environment variables needed for the
+      # chef-client-zero.rb shim script to properly function.
+      #
+      # @return [String] a shell script string
+      # @api private
+      def chef_client_zero_env
+        root = config[:root_path]
+        gem_home = gem_path = remote_path_join(root, "chef-client-zero-gems")
+        gem_cache = remote_path_join(gem_home, "cache")
+
+        [
+            shell_env_var("CHEF_REPO_PATH", root),
+            shell_env_var("GEM_HOME", gem_home),
+            shell_env_var("GEM_PATH", gem_path),
+            shell_env_var("GEM_CACHE", gem_cache),
+        ].join("\n").concat("\n")
+      end
+
+      # Writes a fake (but valid) validation.pem into the sandbox directory.
+      #
+      # @api private
+      def prepare_validation_pem
+        info("Preparing validation.pem")
+        debug("Using a dummy validation.pem")
+
+        source = File.join(File.dirname(__FILE__),
+                           %w{.. .. .. support dummy-validation.pem})
+        FileUtils.cp(source, File.join(sandbox_path, "validation.pem"))
+      end
+
+      # Returns the command that will run a backwards compatible shim script
+      # that approximates local mode in a modern chef-client run.
+      #
+      # @return [String] the command string
+      # @api private
+      def shim_command
+        ruby = remote_path_join(config[:ruby_bindir], "ruby")
+          .tap { |path| path.concat(".exe") if windows_os? }
+        shim = remote_path_join(config[:root_path], "chef-client-zero.rb")
+
+        "#{chef_client_zero_env}\n#{sudo(ruby)} #{shim}"
+      end
+
+      # This provisioner supports policyfiles, so override the default (which
+      # is false)
+      # @return [true] always returns true
+      # @api private
+      def supports_policyfile?
+        true
+      end
+    end
+  end
+end

data/lib/kitchen/provisioner/chef_zero.rb

@@ -1,156 +1,12 @@
-#
-# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
-#
-# Copyright (C) 2013, 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
-#
-#    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_base"
+# Deprecated AS PER THE PR - https://github.com/test-kitchen/test-kitchen/pull/1730
+require_relative "chef_infra"
 
 module Kitchen
   module Provisioner
     # Chef Zero provisioner.
     #
     # @author Fletcher Nichol <fnichol@nichol.ca>
-    class ChefZero < ChefBase
-      kitchen_provisioner_api_version 2
-
-      plugin_version Kitchen::VERSION
-
-      default_config :client_rb, {}
-      default_config :named_run_list, {}
-      default_config :json_attributes, true
-      default_config :chef_zero_host, nil
-      default_config :chef_zero_port, 8889
-
-      default_config :chef_client_path do |provisioner|
-        provisioner
-          .remote_path_join(%W{#{provisioner[:chef_omnibus_root]} bin chef-client})
-          .tap { |path| path.concat(".bat") if provisioner.windows_os? }
-      end
-
-      default_config :ruby_bindir do |provisioner|
-        provisioner
-          .remote_path_join(%W{#{provisioner[:chef_omnibus_root]} embedded bin})
-      end
-
-      # (see Base#create_sandbox)
-      def create_sandbox
-        super
-        prepare_validation_pem
-        prepare_config_rb
-      end
-
-      def run_command
-        cmd = "#{sudo(config[:chef_client_path])} --local-mode".tap { |str| str.insert(0, "& ") if powershell_shell? }
-
-        chef_cmd(cmd)
-      end
-
-      private
-
-      # Adds optional flags to a chef-client command, depending on
-      # configuration data. Note that this method mutates the incoming Array.
-      #
-      # @param args [Array<String>] array of flags
-      # @api private
-      # rubocop:disable Metrics/CyclomaticComplexity
-      def add_optional_chef_client_args!(args)
-        if config[:json_attributes]
-          json = remote_path_join(config[:root_path], "dna.json")
-          args << "--json-attributes #{json}"
-        end
-        args << "--logfile #{config[:log_file]}" if config[:log_file]
-
-        # these flags are chef-client local mode only and will not work
-        # on older versions of chef-client
-        if config[:chef_zero_host]
-          args << "--chef-zero-host #{config[:chef_zero_host]}"
-        end
-        if config[:chef_zero_port]
-          args << "--chef-zero-port #{config[:chef_zero_port]}"
-        end
-        args << "--profile-ruby" if config[:profile_ruby]
-      end
-      # rubocop:enable Metrics/CyclomaticComplexity
-
-      # Returns an Array of command line arguments for the chef client.
-      #
-      # @return [Array<String>] an array of command line arguments
-      # @api private
-      def chef_args(client_rb_filename)
-        level = config[:log_level]
-        args = [
-          "--config #{remote_path_join(config[:root_path], client_rb_filename)}",
-          "--log_level #{level}",
-          "--force-formatter",
-          "--no-color",
-        ]
-        add_optional_chef_client_args!(args)
-
-        args
-      end
-
-      # Generates a string of shell environment variables needed for the
-      # chef-client-zero.rb shim script to properly function.
-      #
-      # @return [String] a shell script string
-      # @api private
-      def chef_client_zero_env
-        root = config[:root_path]
-        gem_home = gem_path = remote_path_join(root, "chef-client-zero-gems")
-        gem_cache = remote_path_join(gem_home, "cache")
-
-        [
-          shell_env_var("CHEF_REPO_PATH", root),
-          shell_env_var("GEM_HOME", gem_home),
-          shell_env_var("GEM_PATH", gem_path),
-          shell_env_var("GEM_CACHE", gem_cache),
-        ].join("\n").concat("\n")
-      end
-
-      # Writes a fake (but valid) validation.pem into the sandbox directory.
-      #
-      # @api private
-      def prepare_validation_pem
-        info("Preparing validation.pem")
-        debug("Using a dummy validation.pem")
-
-        source = File.join(File.dirname(__FILE__),
-          %w{.. .. .. support dummy-validation.pem})
-        FileUtils.cp(source, File.join(sandbox_path, "validation.pem"))
-      end
-
-      # Returns the command that will run a backwards compatible shim script
-      # that approximates local mode in a modern chef-client run.
-      #
-      # @return [String] the command string
-      # @api private
-      def shim_command
-        ruby = remote_path_join(config[:ruby_bindir], "ruby")
-          .tap { |path| path.concat(".exe") if windows_os? }
-        shim = remote_path_join(config[:root_path], "chef-client-zero.rb")
-
-        "#{chef_client_zero_env}\n#{sudo(ruby)} #{shim}"
-      end
-
-      # This provisioner supports policyfiles, so override the default (which
-      # is false)
-      # @return [true] always returns true
-      # @api private
-      def supports_policyfile?
-        true
-      end
+    class ChefZero < ChefInfra
     end
   end
 end

data/lib/kitchen/transport/ssh.rb

@@ -195,18 +195,16 @@ module Kitchen
           FileUtils.mkdir_p(File.dirname(local))
 
           Array(remotes).each do |file|
+            logger.debug("Attempting to download '#{file}' as file")
+            session.scp.download!(file, local)
+          rescue Net::SCP::Error
             begin
-              logger.debug("Attempting to download '#{file}' as file")
-              session.scp.download!(file, local)
+              logger.debug("Attempting to download '#{file}' as directory")
+              session.scp.download!(file, local, recursive: true)
             rescue Net::SCP::Error
-              begin
-                logger.debug("Attempting to download '#{file}' as directory")
-                session.scp.download!(file, local, recursive: true)
-              rescue Net::SCP::Error
-                logger.warn(
-                  "SCP download failed for file or directory '#{file}', perhaps it does not exist?"
-                )
-              end
+              logger.warn(
+                "SCP download failed for file or directory '#{file}', perhaps it does not exist?"
+              )
             end
           end
         rescue Net::SSH::Exception => ex

data/lib/kitchen/transport/winrm.rb

@@ -365,11 +365,9 @@ module Kitchen
         # @return [Winrm::Shells::Elevated] the elevated shell
         # @api private
         def elevated_session(retry_options = {})
-          @elevated_session ||= begin
-            connection(retry_options).shell(:elevated).tap do |shell|
-              shell.username = options[:elevated_username]
-              shell.password = options[:elevated_password]
-            end
+          @elevated_session ||= connection(retry_options).shell(:elevated).tap do |shell|
+            shell.username = options[:elevated_username]
+            shell.password = options[:elevated_password]
           end
         end
 

data/lib/kitchen/verifier/base.rb

@@ -169,11 +169,9 @@ module Kitchen
       # @raise [ClientError] if the sandbox directory has no yet been created
       #   by calling `#create_sandbox`
       def sandbox_path
-        @sandbox_path ||= begin
-           raise ClientError, "Sandbox directory has not yet " \
+        @sandbox_path ||= raise ClientError, "Sandbox directory has not yet " \
            "been created. Please run #{self.class}#create_sandox before " \
            "trying to access the path."
-         end
       end
 
       # Sets the API version for this verifier. If the verifier does not set

data/lib/kitchen/verifier/shell.rb

@@ -88,6 +88,7 @@ module Kitchen
         env_state[:environment]["KITCHEN_INSTANCE"] = instance.name
         env_state[:environment]["KITCHEN_PLATFORM"] = instance.platform.name
         env_state[:environment]["KITCHEN_SUITE"] = instance.suite.name
+        env_state[:environment]["KITCHEN_USERNAME"] = instance.transport[:username] if instance.respond_to?(:transport)
         state.each_pair do |key, value|
           env_state[:environment]["KITCHEN_" + key.to_s.upcase] = value.to_s
         end

data/lib/kitchen/version.rb

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

data/lib/kitchen/which.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+#
+# Copyright:: Copyright (c) Chef Software 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
+#
+#     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 "chef-utils/dsl/which" unless defined?(ChefUtils::DSL::Which)
+require_relative "chef_utils_wiring" unless defined?(Kitchen::ChefUtilsWiring)
+
+module Kitchen
+  module Which
+    include ChefUtils::DSL::Which
+    include ChefUtilsWiring
+  end
+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.4"
+  gem.required_ruby_version = ">= 2.5"
 
   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
@@ -33,6 +33,7 @@ Gem::Specification.new do |gem|
   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
@@ -43,7 +44,7 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency "aruba",     "~> 0.11", "< 1.0"
   gem.add_development_dependency "fakefs",    "~> 1.0"
-  gem.add_development_dependency "minitest",  "~> 5.3", "< 5.12"
+  gem.add_development_dependency "minitest",  "~> 5.3", "< 5.15"
   gem.add_development_dependency "mocha",     "~> 1.1"
   gem.add_development_dependency "cucumber",  ">= 2.1", "< 4.0" # we just need to validate 4.0 when it comes out
   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: 2.10.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Fletcher Nichol
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-17 00:00:00.000000000 Z
+date: 2021-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mixlib-shellout
@@ -194,6 +194,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: chef-utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 16.4.35
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 16.4.35
 - !ruby/object:Gem::Dependency
   name: license-acceptance
   requirement: !ruby/object:Gem::Requirement
@@ -299,7 +313,7 @@ dependencies:
         version: '5.3'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.12'
+        version: '5.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -309,7 +323,7 @@ dependencies:
         version: '5.3'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.12'
+        version: '5.15'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -387,6 +401,7 @@ files:
 - bin/kitchen
 - lib/kitchen.rb
 - lib/kitchen/base64_stream.rb
+- lib/kitchen/chef_utils_wiring.rb
 - lib/kitchen/cli.rb
 - lib/kitchen/collection.rb
 - lib/kitchen/color.rb
@@ -434,6 +449,7 @@ files:
 - lib/kitchen/provisioner/chef/policyfile.rb
 - lib/kitchen/provisioner/chef_apply.rb
 - lib/kitchen/provisioner/chef_base.rb
+- lib/kitchen/provisioner/chef_infra.rb
 - lib/kitchen/provisioner/chef_solo.rb
 - lib/kitchen/provisioner/chef_zero.rb
 - lib/kitchen/provisioner/dummy.rb
@@ -457,6 +473,7 @@ files:
 - lib/kitchen/verifier/dummy.rb
 - lib/kitchen/verifier/shell.rb
 - lib/kitchen/version.rb
+- lib/kitchen/which.rb
 - lib/vendor/hash_recursive_merge.rb
 - support/busser_install_command.ps1
 - support/busser_install_command.sh
@@ -496,14 +513,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: Test Kitchen is an integration tool for developing and testing infrastructure