test-kitchen 2.10.0 → 2.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51ed51940914e0c4ffb30d1e11be2e3554289833261e0b418eaa2ebdb674cab9
-  data.tar.gz: c3c9be7593e1c0c333102168228c84e217244c5071da0bfb2ba543edca7581ba
+  metadata.gz: 36e340a7aefc9e4512f05ded9b43003298a3466de705d7c6c6050dd07f433175
+  data.tar.gz: 310ae63b637cbd62a88cd5beef8effa437f0d1b2dec6bf9098ba3112e621c8ed
 SHA512:
-  metadata.gz: 59633a6df2c274542ee3d4c649c55f8632077a98476ee655a1f59c0b39d42fad9077294b0e615d8e7f697feef4cbb027a9df7be81708832760d45eee72fbf159
-  data.tar.gz: 34164cc7046bb2aa507fa33373c928d94be84284a99ba629562c585614c1818d032a42a1b2b83ab0b95382e984841be63a2dc32a05412dbf8d60a15839325146
+  metadata.gz: cc3e9bf0e55d519d757e4339b4e643f038216dedb573225aed9cc1ce2972ad121e7819db643e26e4038ebe5fc05e2bc0a57435588d462bf2d2a4a198cbd0b9b1
+  data.tar.gz: 48c9bc01e69691e4096f5ae219638b0d996f069852c3ac14ec143ce583c3f6f610263000e5b24256b3b969314c9903e95b570372c1d3a8d3298d3ba4c65885bd

data/Gemfile

@@ -1,4 +1,6 @@
 source "https://rubygems.org"
+
+# Specify your gem"s dependencies in test-kitchen.gemspec
 gemspec
 
 group :integration do
@@ -8,10 +10,6 @@ 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-byebug"
@@ -19,9 +17,5 @@ group :debug do
 end
 
 group :chefstyle do
-  gem "chefstyle"
-end
-
-group :docs do
-  gem "yard"
-end
+  gem "chefstyle", "1.6.2"
+end

data/Rakefile

@@ -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/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)

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.
         #
@@ -40,9 +42,9 @@ module Kitchen
         # @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
+          @policyfile    = policyfile
+          @path          = path
+          @logger        = logger
           @always_update = always_update
         end
 
@@ -51,30 +53,29 @@ 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")
+          info("Exporting cookbook dependencies from Policyfile #{path} using `#{cli_path} export`...")
+          run_command("#{cli_path} export #{escape_path(policyfile)} #{escape_path(path)} --force")
         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
 
@@ -126,33 +127,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/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/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 = "2.11.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?(Ohai::Mixin::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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-kitchen
 version: !ruby/object:Gem::Version
-  version: 2.10.0
+  version: 2.11.0
 platform: ruby
 authors:
 - Fletcher Nichol
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-17 00:00:00.000000000 Z
+date: 2021-03-01 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
@@ -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
@@ -457,6 +472,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,7 +512,7 @@ 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:
   - - ">="