test-kitchen 1.24.0 → 1.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f96d164d3286ff8f8445c248a0457012d3e633fd99cd27844cbd869409b971b
-  data.tar.gz: dea0f61a598f25e833fe700381033a4c1b90c38c46c8177ef3518922c09eb860
+  metadata.gz: a6c10ada5565a14188f81198ab603201f831f7b7237def1517b92695fb851d49
+  data.tar.gz: 232f4a053884a07eef2edff6415cf4582d76e685464943eebfb547494dd887c6
 SHA512:
-  metadata.gz: 26b4c8102ae775129437252c33c387d379e6099e2c7b4147a61e4c729a859fc6ee4816f38e4f157f406080ebe59c00976249df9d55854aed04819feda880a6ac
-  data.tar.gz: 93a9e042dff74b4ef29870bb990edce9556fd559724666164c4aaa891e2b5e4cb4ea07ea0abfa66b6e5ba4fba2c0c7d64dd66e53613569abf9d7dd3ff6d45bcf
+  metadata.gz: 7594aa1002500ab9130b39293fdc795da406202e7438627b2f42fffc29b0d1c17f200ec79fd0c85b69a5a984a4b5062a889c9fdbd1ae685ba435e89e347d80d6
+  data.tar.gz: 4044d16718fa0b27425c4a0a91fc67ff50f0c77c2fab3266d8b88afaadec3259d67dfe51cb0db0f850410922d0901e081d9c9fcdc3ee5ea1094afd5a6d7fccdd

data/lib/kitchen/cli.rb

@@ -171,14 +171,14 @@ module Kitchen
                     desc: <<-DESC.gsub(/^\s+/, "").tr("\n", " ")
           Run a #{action} against all matching instances concurrently. Only N
           instances will run at the same time if a number is given.
-        DESC
+                    DESC
       method_option :parallel,
                     aliases: "-p",
                     type: :boolean,
                     desc: <<-DESC.gsub(/^\s+/, "").tr("\n", " ")
           [Future DEPRECATION, use --concurrency]
           Run a #{action} against all matching instances concurrently.
-        DESC
+                    DESC
       if action == :converge || action == :verify
         method_option :debug,
                       aliases: "-D",
@@ -186,6 +186,11 @@ module Kitchen
                       default: false,
                       desc: "Run the #{action} with debugging enabled."
       end
+      method_option :fail_fast,
+        aliases: "-f",
+        type: :boolean,
+        desc: "Fail immediately when errors occur in concurrency mode"
+
       test_base_path
       log_options
       define_method(action) do |*args|
@@ -216,14 +221,14 @@ module Kitchen
                   desc: <<-DESC.gsub(/^\s+/, "").tr("\n", " ")
         Run a test against all matching instances concurrently. Only N
         instances will run at the same time if a number is given.
-      DESC
+                  DESC
     method_option :parallel,
                   aliases: "-p",
                   type: :boolean,
                   desc: <<-DESC.gsub(/^\s+/, "").tr("\n", " ")
         [Future DEPRECATION, use --concurrency]
         Run a test against all matching instances concurrently.
-      DESC
+                  DESC
     method_option :destroy,
                   aliases: "-d",
                   default: "passing",
@@ -300,7 +305,7 @@ module Kitchen
              "init", "Adds some configuration to your cookbook so Kitchen can rock"
     long_desc <<-D, for: "init"
       Init will add Test Kitchen support to an existing project for
-      convergence integration testing. A default .kitchen.yml file (which is
+      convergence integration testing. A default kitchen.yml file (which is
       intended to be customized) is created in the project's root directory
       and one or more gems will be added to the project's Gemfile.
     D

data/lib/kitchen/command.rb

@@ -111,10 +111,10 @@ module Kitchen
         result = begin
           @config.instances.get(regexp) ||
             @config.instances.get_all(/#{regexp}/)
-        rescue RegexpError => e
-          die "Invalid Ruby regular expression, " \
-            "you may need to single quote the argument. " \
-            "Please try again or consult http://rubular.com/ (#{e.message})"
+                 rescue RegexpError => e
+                   die "Invalid Ruby regular expression, " \
+                     "you may need to single quote the argument. " \
+                     "Please try again or consult http://rubular.com/ (#{e.message})"
         end
         result = Array(result)
 
@@ -170,6 +170,7 @@ module Kitchen
             end
           end
         end
+        Thread.abort_on_exception = true if options[:fail_fast]
         threads.map(&:join)
         report_errors
       end

data/lib/kitchen/generator/init.rb

@@ -35,7 +35,7 @@ module Kitchen
                    desc: <<-D.gsub(/^\s+/, "").tr("\n", " ")
           One or more Kitchen Driver gems to be installed or added to a
           Gemfile
-        D
+                   D
 
       class_option :provisioner,
                    type: :string,
@@ -43,7 +43,7 @@ module Kitchen
                    default: "chef_solo",
                    desc: <<-D.gsub(/^\s+/, "").tr("\n", " ")
           The default Kitchen Provisioner to use
-        D
+                   D
 
       class_option :create_gemfile,
                    type: :boolean,
@@ -51,7 +51,7 @@ module Kitchen
                    desc: <<-D.gsub(/^\s+/, "").tr("\n", " ")
           Whether or not to create a Gemfile if one does not exist.
           Default: false
-        D
+                   D
 
       # Invoke the command.
       def init

data/lib/kitchen/instance.rb

@@ -405,6 +405,7 @@ module Kitchen
         if legacy_ssh_base_driver?
           legacy_ssh_base_converge(state)
         else
+          provisioner.check_license
           provisioner.call(state)
         end
       end

data/lib/kitchen/loader/yaml.rb

@@ -196,6 +196,10 @@ module Kitchen
           raise UserError, "Both #{kitchen_yml} and #{dot_kitchen_yml} found. Please use the un-dotted variant: #{kitchen_yml}."
         end
 
+        if !File.exist?(kitchen_yml) && !File.exist?(dot_kitchen_yml)
+          return kitchen_yml
+        end
+
         File.exist?(kitchen_yml) ? kitchen_yml : dot_kitchen_yml
       end
 
@@ -221,11 +225,12 @@ module Kitchen
 
         undot_config = default_local_config.sub(/^\./, "")
         dot_config = ".#{undot_config}"
+
         if File.exist?(File.join(config_dir, undot_config)) && File.exist?(File.join(config_dir, dot_config))
           raise UserError, "Both #{undot_config} and #{dot_config} found in #{config_dir}. Please use #{default_local_config} which matches your #{config_file}."
         end
 
-        File.join(config_dir, default_local_config)
+        File.exist?(File.join(config_dir, dot_config)) ? File.join(config_dir, dot_config) : File.join(config_dir, undot_config)
       end
 
       # Determines the default absolute path to the Kitchen global YAML file,
@@ -251,8 +256,8 @@ module Kitchen
 
         hash = begin
           send(component)
-        rescue => e
-          failure_hash(e, file)
+               rescue => e
+                 failure_hash(e, file)
         end
 
         { filename: file, raw_data: hash }
@@ -347,7 +352,14 @@ module Kitchen
       def parse_yaml_string(string, file_name)
         return {} if string.nil? || string.empty?
 
-        result = ::YAML.safe_load(string, [Symbol], [], true) || {}
+        result =
+          if Gem::Requirement.new(">= 3.1.0").satisfied_by?(Gem::Version.new(Psych::VERSION))
+            # ruby >= 2.6.0
+            ::YAML.safe_load(string, permitted_classes: [Symbol], permitted_symbols: [], aliases: true) || {}
+          else
+            # ruby < 2.6.0
+            ::YAML.safe_load(string, [Symbol], [], true) || {}
+          end
         unless result.is_a?(Hash)
           raise UserError, "Error parsing #{file_name} as YAML " \
             "(Result of parse was not a Hash, but was a #{result.class}).\n" \

data/lib/kitchen/provisioner/base.rb

@@ -105,6 +105,12 @@ module Kitchen
         false
       end
 
+      # Certain products that Test Kitchen uses to provision require accepting
+      # a license to use. Overwrite this method in the specific provisioner
+      # to implement this check.
+      def check_license
+      end
+
       # Generates a command string which will install and configure the
       # provisioner software on an instance. If no work is required, then `nil`
       # will be returned.

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

@@ -89,14 +89,15 @@ module Kitchen
         # @api private
         def policyfile
           basename = config[:policyfile_path] || config[:policyfile] || "Policyfile.rb"
-          File.join(config[:kitchen_root], basename)
+          File.expand_path(basename, config[:kitchen_root])
         end
 
         # @return [String] an absolute path to a Berksfile, relative to the
         #   kitchen root
         # @api private
         def berksfile
-          File.join(config[:kitchen_root], "Berksfile")
+          basename = config[:berksfile_path] || "Berksfile"
+          File.expand_path(basename, config[:kitchen_root])
         end
 
         # @return [String] an absolute path to a Cheffile, relative to the
@@ -179,8 +180,8 @@ module Kitchen
         #
         # @api private
         def make_fake_cookbook
-          info("Berksfile, Cheffile, cookbooks/, or metadata.rb not found " \
-            "so Chef will run with effectively no cookbooks. Is this intended?")
+          info("Policyfile, Berksfile, Cheffile, cookbooks/, or metadata.rb not found " \
+            "so Chef Infra Client will run, but do nothing. Is this intended?")
           name = File.basename(config[:kitchen_root])
           fake_cb = File.join(tmpbooks_dir, name)
           FileUtils.mkdir_p(fake_cb)
@@ -292,7 +293,7 @@ module Kitchen
 
         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 "\
+            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

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

@@ -87,7 +87,7 @@ module Kitchen
 
         private
 
-        # @return [String] path to a Berksfile
+        # @return [String] path to a Policyfile
         # @api private
         attr_reader :policyfile
 
@@ -139,8 +139,8 @@ module Kitchen
               File.exist?(File.join(p, "chef"))
             end
               logger.fatal("The `chef` executable cannot be found in your " \
-                          "PATH. Ensure you have installed ChefDK from " \
-                          "https://downloads.chef.io and that your PATH " \
+                          "PATH. Ensure you have installed ChefDK or Chef Workstation " \
+                          "from https://downloads.chef.io and that your PATH " \
                           "setting includes the path to the `chef` comand.")
               raise UserError,
                     "Could not find the chef executable in your PATH."

data/lib/kitchen/provisioner/chef_apply.rb

@@ -107,6 +107,7 @@ module Kitchen
             "--no-color",
           ]
           args << "--logfile #{config[:log_file]}" if config[:log_file]
+          args << "--chef-license #{config[:chef_license]}" if config[:chef_license]
 
           lines << wrap_shell_code(
             [cmd, *args].join(" ")

data/lib/kitchen/provisioner/chef_base.rb

@@ -28,6 +28,7 @@ require "kitchen/provisioner/chef/librarian"
 require "kitchen/util"
 require "mixlib/install"
 require "mixlib/install/script_generator"
+require "license_acceptance/acceptor"
 
 begin
   require "chef-config/config"
@@ -45,6 +46,7 @@ module Kitchen
       default_config :require_chef_omnibus, true
       default_config :chef_omnibus_url, "https://omnitruck.chef.io/install.sh"
       default_config :chef_omnibus_install_options, nil
+      default_config :chef_license, nil
       default_config :run_list, []
       default_config :attributes, {}
       default_config :config_path, nil
@@ -58,6 +60,9 @@ module Kitchen
       # Will try to autodetect by searching for `Policyfile.rb` if not set.
       # If set, will error if the file doesn't exist.
       default_config :policyfile_path, nil
+      # Will try to autodetect by searching for `Berksfile` if not set.
+      # If set, will error if the file doesn't exist.
+      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
@@ -244,6 +249,43 @@ module Kitchen
         end
       end
 
+      # gives us the product version from either require_chef_omnibus or product_version
+      # If the non-default (true) value of require_chef_omnibus is present use that
+      # otherwise use config[:product_version] which defaults to :latest and is the actual
+      # default for chef provisioners
+      #
+      # @return [String,Symbol,NilClass] version or nil if not applicable
+      def product_version
+        case config[:require_chef_omnibus]
+        when FalseClass
+          nil
+        when TrueClass
+          config[:product_version]
+        else
+          config[:require_chef_omnibus]
+        end
+      end
+
+      # (see Base#check_license)
+      def check_license
+        name = config[:product_name] || "chef"
+        version = product_version
+        debug("Checking if we need to prompt for license acceptance on product: #{name} version: #{version}.")
+
+        acceptor = LicenseAcceptance::Acceptor.new(logger: Kitchen.logger, provided: config[:chef_license])
+        if acceptor.license_required?(name, version)
+          debug("License acceptance required for #{name} version: #{version}. Prompting")
+          license_id = acceptor.id_from_mixlib(name)
+          begin
+            acceptor.check_and_persist(license_id, version.to_s)
+          rescue LicenseAcceptance::LicenseNotAcceptedError => e
+            error("Cannot converge without accepting the #{e.product.pretty_name} License. Set it in your kitchen.yml or using the CHEF_LICENSE environment variable")
+            raise
+          end
+          config[:chef_license] ||= acceptor.acceptance_value
+        end
+      end
+
       # (see Base#create_sandbox)
       def create_sandbox
         super
@@ -316,14 +358,15 @@ module Kitchen
       # @api private
       def policyfile
         policyfile_basename = config[:policyfile_path] || config[:policyfile] || "Policyfile.rb"
-        File.join(config[:kitchen_root], policyfile_basename)
+        File.expand_path(policyfile_basename, config[:kitchen_root])
       end
 
       # @return [String] an absolute path to a Berksfile, relative to the
       #   kitchen root
       # @api private
       def berksfile
-        File.join(config[:kitchen_root], "Berksfile")
+        berksfile_basename = config[:berksfile_path] || config[:berksfile] || "Berksfile"
+        File.expand_path(berksfile_basename, config[:kitchen_root])
       end
 
       # @return [String] an absolute path to a Cheffile, relative to the
@@ -341,7 +384,7 @@ module Kitchen
       def default_config_rb # rubocop:disable Metrics/MethodLength
         root = config[:root_path].gsub("$env:TEMP", "\#{ENV['TEMP']\}")
 
-        {
+        config_rb = {
           node_name: instance.name,
           checksum_path: remote_path_join(root, "checksums"),
           file_cache_path: remote_path_join(root, "cache"),
@@ -364,6 +407,8 @@ module Kitchen
           ),
           treat_deprecation_warnings_as_errors: config[:deprecations_as_errors],
         }
+        config_rb[:chef_license] = config[:chef_license] unless config[:chef_license].nil?
+        config_rb
       end
 
       # Generates a rendered client.rb/solo.rb/knife.rb formatted file as a
@@ -427,10 +472,10 @@ module Kitchen
       def load_needed_dependencies!
         super
         if File.exist?(policyfile)
-          debug("Policyfile found at #{policyfile}, using Policyfile to resolve dependencies")
+          debug("Policyfile found at #{policyfile}, using Policyfile to resolve cookbook dependencies")
           Chef::Policyfile.load!(logger: logger)
         elsif File.exist?(berksfile)
-          debug("Berksfile found at #{berksfile}, loading Berkshelf")
+          debug("Berksfile found at #{berksfile}, using Berkshelf to resolve cookbook dependencies")
           Chef::Berkshelf.load!(logger: logger)
         elsif File.exist?(cheffile)
           debug("Cheffile found at #{cheffile}, loading Librarian-Chef")
@@ -537,13 +582,18 @@ module Kitchen
         if (config[:policyfile_path] || config[:policyfile]) && !File.exist?(policyfile)
           raise UserError, "policyfile_path set in config "\
             "(#{config[:policyfile_path]} could not be found. " \
-            "Expected to find it at full path #{policyfile} " \
+            "Expected to find it at full path #{policyfile}."
+        end
+        if config[:berksfile_path] && !File.exist?(berksfile)
+          raise UserError, "berksfile_path set in config "\
+            "(#{config[:berksfile_path]} could not be found. " \
+            "Expected to find it at full path #{berksfile}."
         end
         if File.exist?(policyfile) && !supports_policyfile?
           raise UserError, "policyfile detected, but provisioner " \
-            "#{self.class.name} doesn't support policyfiles. " \
+            "#{self.class.name} doesn't support Policyfiles. " \
             "Either use a different provisioner, or delete/rename " \
-            "#{policyfile}"
+            "#{policyfile}."
         end
       end
 

data/lib/kitchen/provisioner/chef_solo.rb

@@ -88,7 +88,6 @@ module Kitchen
         args << "--logfile #{config[:log_file]}" if config[:log_file]
         args << "--profile-ruby" if config[:profile_ruby]
         args << "--legacy-mode" if config[:legacy_mode]
-
         args
       end
     end

data/lib/kitchen/provisioner/shell.rb

@@ -69,7 +69,7 @@ module Kitchen
             if (-Not (Test-Path "#{root}")) {
               New-Item "#{root}" -ItemType directory | Out-Null
             }
-          POWERSHELL
+                 POWERSHELL
                else
                  "#{sudo('rm')} -rf #{data} ; mkdir -p #{root}"
                end

data/lib/kitchen/transport/ssh.rb

@@ -232,7 +232,7 @@ module Kitchen
           Errno::EACCES, Errno::EALREADY, Errno::EADDRINUSE, Errno::ECONNREFUSED, Errno::ETIMEDOUT,
           Errno::ECONNRESET, Errno::ENETUNREACH, Errno::EHOSTUNREACH, Errno::EPIPE,
           Net::SSH::Disconnect, Net::SSH::AuthenticationFailed, Net::SSH::ConnectionTimeout,
-          Timeout::Error
+          Net::SSH::Proxy::ConnectError, Timeout::Error
         ].freeze
 
         # @return [Integer] cap on number of parallel ssh sessions we can use

data/lib/kitchen/verifier/busser.rb

@@ -182,7 +182,7 @@ module Kitchen
         # to be under /tmp/verifier
         args = gem
         args += " --version #{version}" if version
-        args += " --no-rdoc --no-ri --no-format-executable -n #{gem_bin}"
+        args += " --no-document --no-format-executable -n #{gem_bin}"
         args += " --no-user-install"
         args
       end

data/lib/kitchen/version.rb

@@ -17,5 +17,5 @@
 # limitations under the License.
 
 module Kitchen
-  VERSION = "1.24.0".freeze
+  VERSION = "1.25.0".freeze
 end

data/templates/driver/gemspec.erb

@@ -18,9 +18,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'test-kitchen', '~> 1.0.0.alpha.3'
+  spec.add_dependency 'test-kitchen', '~> 1.0.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
 
   spec.add_development_dependency 'cane'

data/templates/driver/travis.yml.erb

@@ -1,9 +1,9 @@
 language: ruby
 
 rvm:
-- 2.0.0
-- 1.9.3
-- 1.9.2
+- 2.4
+- 2.5
+- 2.6
 - ruby-head
 
 matrix:

data/templates/init/kitchen.yml.erb

@@ -6,7 +6,7 @@ provisioner:
   name: <%= config[:provisioner] %>
 
 platforms:
-  - name: ubuntu-16.04
+  - name: ubuntu-18.04
   - name: centos-7
 
 suites:

data/test-kitchen.gemspec

@@ -24,17 +24,20 @@ Gem::Specification.new do |gem|
   gem.required_ruby_version = ">= 2.3"
 
   gem.add_dependency "mixlib-shellout", ">= 1.2", "< 3.0"
-  gem.add_dependency "net-scp",         "~> 1.1"
+  gem.add_dependency "net-scp", ">= 1.1", "< 3.0" # pinning until we can confirm 3+ works
   gem.add_dependency "net-ssh", ">= 2.9", "< 5.0"
-  gem.add_dependency "net-ssh-gateway", "~> 1.2"
+  gem.add_dependency "net-ssh-gateway", ">= 1.2", "< 3.0" # pinning until we can confirm 3+ works
   gem.add_dependency "thor",            "~> 0.19"
   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_development_dependency "rb-readline"
+  # 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", ">= 1.0.11"
 
+  gem.add_development_dependency "rb-readline"
   gem.add_development_dependency "bundler"
   gem.add_development_dependency "rake"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-kitchen
 version: !ruby/object:Gem::Version
-  version: 1.24.0
+  version: 1.25.0
 platform: ruby
 authors:
 - Fletcher Nichol
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-26 00:00:00.000000000 Z
+date: 2019-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mixlib-shellout
@@ -34,16 +34,22 @@ dependencies:
   name: net-scp
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: net-ssh
   requirement: !ruby/object:Gem::Requirement
@@ -68,16 +74,22 @@ dependencies:
   name: net-ssh-gateway
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -148,6 +160,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: license-acceptance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.11
 - !ruby/object:Gem::Dependency
   name: rb-readline
   requirement: !ruby/object:Gem::Requirement
@@ -425,8 +457,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Test Kitchen is an integration tool for developing and testing infrastructure