test-kitchen 3.9.1 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afc726dab92d4107edf13980480047c6286dbc816001eb61597206806e279644
-  data.tar.gz: 8cb0615335e7b7239e717bc4fac1c60ee0d4da202607be641542633fd0152f6b
+  metadata.gz: 80afb157c2779c990f0194d9711cf3a35d949a1916515fbaf722056306314a6d
+  data.tar.gz: d06ecf45e9c7c2288a772c2202505f2d5cdd722b357fb7fa9cf0433e06eec725
 SHA512:
-  metadata.gz: afc342581e2d0b242bae26f23d5b872610c24cc78c160405ae7b7a56c9c45b595ab4a55ef88c6bb153a302e3a8aaa42cdb0218d2e6c98827ab04b5ecbf7eb47f
-  data.tar.gz: 5ece9c33f5ce95f94ff35f52d3a66b34c67da743f4ea296f89879c35da1c0bd97f503bdb94e3050ac588ade627bc3b65342d9bafa747cacfa0889982989b760e
+  metadata.gz: 323e94d69dfadaa75a6214b504f47c7114227ee5ce98ae5dcdd64f9961945caf8212d9ef015a778ace055b6b63eb6fa5917dc072aa7f977a9da2a734ccfa66cd
+  data.tar.gz: fcf0647d42a9482a9da0656ed68b90b6cc17eb8a14cd999a6316b3be4a2cc02796a3ef4a0ccf7ee8938a0cd92bb8910efb7243342f6677f63b624f8b9756cb64

data/Gemfile

@@ -6,19 +6,20 @@ group :test do
   gem "rake"
   gem "rb-readline"
   gem "aruba",     ">= 0.11", "< 3.0"
-  gem "chef-cli"
   gem "countloc",  "~> 0.4"
   gem "cucumber",  ">= 9.2", "< 11"
   gem "fakefs",    "~> 3.0"
-  gem "kitchen-inspec"
   gem "maruku",    "~> 0.7"
-  gem "minitest",  "~> 5.3", "< 6.0"
-  gem "mocha",     "~> 2.0"
+  gem "minitest",  "~> 6.0", "< 6.1"
+  gem "mocha",     "~> 3.0"
 end
 
 group :integration do
+  gem "chef-cli"
   gem "kitchen-dokken"
   gem "kitchen-vagrant"
+  gem "kitchen-inspec"
+  gem "kitchen-omnibus-chef", ">= 1.0"
 end
 
 group :linting do

data/lib/kitchen/collection.rb

@@ -46,7 +46,7 @@ module Kitchen
     #
     # @return [Array<String>] array of name strings
     def as_names
-      __getobj__.map(&:name)
+      __getobj__.map { |item| item.respond_to?(:name) ? item.name : item.to_s }
     end
   end
 end

data/lib/kitchen/configurable.rb

@@ -180,7 +180,7 @@ module Kitchen
 
     private
 
-    # @return [LzayHash] a configuration hash
+    # @return [LazyHash] a configuration hash
     # @api private
     attr_reader :config
 
@@ -472,7 +472,7 @@ module Kitchen
       # easier to debug and diagnose.
       #
       # Note that the file path expansion is only intended for paths on the
-      # local workstation invking the Test Kitchen code.
+      # local workstation invoking the Test Kitchen code.
       #
       # @example the default usage
       #
@@ -598,8 +598,8 @@ module Kitchen
         end
       end
 
-      # @return [Hash] a hash of attribute keys and valudation callable blocks
-      #   which has been merged with any superclass valudations
+      # @return [Hash] a hash of attribute keys and validation callable blocks
+      #   which has been merged with any superclass validations
       # @api private
       def validations
         @validations ||= {}.merge(super_validations)

data/lib/kitchen/data_munger.rb

@@ -231,7 +231,7 @@ module Kitchen
     # platforms, or the like, just a vanilla hash.
     #
     # @param root [Hash] a hash to use as the root of the conversion
-    # @deprecated The following configuration hashses should no longer be
+    # @deprecated The following configuration hashes should no longer be
     #   created in a Test Kitchen hash: `:busser`. Use a `:verifier` hash
     #   block in their place.
     # @api private
@@ -378,7 +378,7 @@ module Kitchen
     #
     # @param root [Hash] a hash to use as the root of the conversion
     # @deprecated The following configuration hashes should no longer be
-    #   created in a Test Kitche hash: [`:driver_plugin`, `:driver_config`].
+    #   created in a Test Kitchen hash: [`:driver_plugin`, `:driver_config`].
     #   Use a `:driver` hash block in their place.
     # @api private
     def convert_legacy_driver_format_at!(root)
@@ -396,9 +396,7 @@ module Kitchen
     end
 
     # Copies `:http_proxy` and `:https_proxy` values in a driver hash into the
-    # provisioner and verifier hashes. For backwards compatibility with legacy
-    # Drivers (those inheriting directly from `SSHBase`), the original
-    # values are maintained in the driver hash.
+    # provisioner and verifier hashes.
     #
     # This method converts the following:
     #
@@ -589,9 +587,9 @@ module Kitchen
     end
 
     # Destructively moves a `:require_chef_omnibus` key/value pair from a
-    # `:driver` hash block to a `:provisioner` hash block in the first leve
+    # `:driver` hash block to a `:provisioner` hash block in the first level
     # depth of a hash. This method has no knowledge of suites, platforms, or
-    # the like, just a vanilla haash.
+    # the like, just a vanilla hash.
     #
     # @param root [Hash] a hash to use as the root of the conversion
     # @deprecated The `:require_chef_omnibus` key/value pair should no longer
@@ -753,9 +751,9 @@ module Kitchen
     # takes an array value and transforms it into a hash with a bucket name
     # containing the original Array. This way semantic Hash merging will do
     # its thing and another process can collapse the hash into a flat array
-    # afterwards, given a strategy (like use the array segmenet from one
+    # afterwards, given a strategy (like use the array segment from one
     # bucket first, then another one second). To anyone who made it this far,
-    # Fletcher appologizes.
+    # Fletcher apologizes.
     #
     # @param root [Hash] a hash to use as the root of the conversion
     # @param key [Symbol] a key in the root hash that, if exists, has its

data/lib/kitchen/driver/proxy.rb

@@ -11,7 +11,7 @@
 # limitations under the License.
 #
 
-require_relative "ssh_base"
+require_relative "base"
 require_relative "../version"
 
 module Kitchen
@@ -23,7 +23,7 @@ module Kitchen
     # the driver was created.
     #
     # @author Seth Chisamore <schisamo@opscode.com>
-    class Proxy < Kitchen::Driver::SSHBase
+    class Proxy < Kitchen::Driver::Base
       plugin_version Kitchen::VERSION
 
       required_config :host
@@ -33,8 +33,11 @@ module Kitchen
 
       # (see Base#create)
       def create(state)
-        # TODO: Once this isn't using SSHBase, it should call `super` to support pre_create_command.
+        super
         state[:hostname] = config[:host]
+        state[:port] = config[:port] if config[:port]
+        state[:username] = config[:username] if config[:username]
+        state[:password] = config[:password] if config[:password]
         reset_instance(state)
       end
 
@@ -48,15 +51,17 @@ module Kitchen
 
       private
 
-      # Resets the non-Kitchen managed instance using by issuing a command
-      # over SSH.
+      # Resets the non-Kitchen managed instance by issuing a command
+      # over the transport.
       #
       # @param state [Hash] the state hash
       # @api private
       def reset_instance(state)
         if (cmd = config[:reset_command])
           info("Resetting instance state with command: #{cmd}")
-          ssh(build_ssh_args(state), cmd)
+          instance.transport.connection(state) do |conn|
+            conn.execute(cmd)
+          end
         end
       end
     end

data/lib/kitchen/generator/init.rb

@@ -39,7 +39,7 @@ module Kitchen
       class_option :provisioner,
         type: :string,
         aliases: "-P",
-        default: "chef_infra",
+        default: "shell",
         desc: <<-D.gsub(/^\s+/, "").tr("\n", " ")
           The default Kitchen Provisioner to use
         D

data/lib/kitchen/instance.rb

@@ -210,11 +210,7 @@ module Kitchen
         raise UserError, "Instance #{to_str} has not yet been created"
       end
 
-      lc = if legacy_ssh_base_driver?
-             legacy_ssh_base_login(state)
-           else
-             transport.connection(state).login_command
-           end
+      lc = transport.connection(state).login_command
 
       debug(%{Login command: #{lc.command} #{lc.arguments.join(" ")} } \
         "(Options: #{lc.options})")
@@ -412,13 +408,8 @@ module Kitchen
     def converge_action
       banner "Converging #{to_str}..."
       elapsed = action(:converge) do |state|
-        if legacy_ssh_base_driver?
-          provisioner.check_license
-          legacy_ssh_base_converge(state)
-        else
-          provisioner.check_license
-          provisioner.call(state)
-        end
+        provisioner.check_license
+        provisioner.call(state)
       end
       info("Finished converging #{to_str} #{Util.duration(elapsed.real)}.")
       self
@@ -432,26 +423,11 @@ module Kitchen
     def setup_action
       banner "Setting up #{to_str}..."
       elapsed = action(:setup) do |state|
-        legacy_ssh_base_setup(state) if legacy_ssh_base_driver?
       end
       info("Finished setting up #{to_str} #{Util.duration(elapsed.real)}.")
       self
     end
 
-    # returns true, if the verifier is busser
-    def verifier_busser?(verifier)
-      !defined?(Kitchen::Verifier::Busser).nil? && verifier.is_a?(Kitchen::Verifier::Busser)
-    end
-
-    # returns true, if the verifier is dummy
-    def verifier_dummy?(verifier)
-      !defined?(Kitchen::Verifier::Dummy).nil? && verifier.is_a?(Kitchen::Verifier::Dummy)
-    end
-
-    def use_legacy_ssh_verifier?(verifier)
-      verifier_busser?(verifier) || verifier_dummy?(verifier)
-    end
-
     # Perform the verify action.
     #
     # @see Driver::Base#verify
@@ -460,15 +436,7 @@ module Kitchen
     def verify_action
       banner "Verifying #{to_str}..."
       elapsed = action(:verify) do |state|
-        # use special handling for legacy driver
-        if legacy_ssh_base_driver? && use_legacy_ssh_verifier?(verifier)
-          legacy_ssh_base_verify(state)
-        elsif legacy_ssh_base_driver?
-          # read ssh options from legacy driver
-          verifier.call(driver.legacy_state(state))
-        else
-          verifier.call(state)
-        end
+        verifier.call(state)
       end
       info("Finished verifying #{to_str} #{Util.duration(elapsed.real)}.")
       self
@@ -488,7 +456,7 @@ module Kitchen
     # @param verb [Symbol] the action to be performed
     # @param output_verb [String] a verb representing the action, suitable for
     #   use in output logging
-    # @yield perform optional work just after action has complted
+    # @yield perform optional work just after action has completed
     # @return [self] this instance, used to chain actions
     # @api private
     def perform_action(verb, output_verb)
@@ -617,71 +585,6 @@ module Kitchen
       "#{what.capitalize} failed on instance #{to_str}."
     end
 
-    # Invokes `Driver#converge` on a legacy Driver, which inherits from
-    # `Kitchen::Driver::SSHBase`.
-    #
-    # @param state [Hash] mutable instance state
-    # @deprecated When legacy Driver::SSHBase support is removed, the
-    #   `#converge` method will no longer be called on the Driver.
-    # @api private
-    def legacy_ssh_base_converge(state)
-      warn("Running legacy converge for '#{driver.name}' Driver")
-      # TODO: Document upgrade path and provide link
-      # warn("Driver authors: please read http://example.com for more details.")
-      driver.converge(state)
-    end
-
-    # @return [TrueClass,FalseClass] whether or not the Driver inherits from
-    #   `Kitchen::Driver::SSHBase`
-    # @deprecated When legacy Driver::SSHBase support is removed, the
-    #   `#converge` method will no longer be called on the Driver.
-    # @api private
-    def legacy_ssh_base_driver?
-      driver.class < Kitchen::Driver::SSHBase
-    end
-
-    # Invokes `Driver#login_command` on a legacy Driver, which inherits from
-    # `Kitchen::Driver::SSHBase`.
-    #
-    # @param state [Hash] mutable instance state
-    # @deprecated When legacy Driver::SSHBase support is removed, the
-    #   `#login_command` method will no longer be called on the Driver.
-    # @api private
-    def legacy_ssh_base_login(state)
-      warn("Running legacy login for '#{driver.name}' Driver")
-      # TODO: Document upgrade path and provide link
-      # warn("Driver authors: please read http://example.com for more details.")
-      driver.login_command(state)
-    end
-
-    # Invokes `Driver#setup` on a legacy Driver, which inherits from
-    # `Kitchen::Driver::SSHBase`.
-    #
-    # @param state [Hash] mutable instance state
-    # @deprecated When legacy Driver::SSHBase support is removed, the
-    #   `#setup` method will no longer be called on the Driver.
-    # @api private
-    def legacy_ssh_base_setup(state)
-      warn("Running legacy setup for '#{driver.name}' Driver")
-      # TODO: Document upgrade path and provide link
-      # warn("Driver authors: please read http://example.com for more details.")
-      driver.setup(state)
-    end
-
-    # Invokes `Driver#verify` on a legacy Driver, which inherits from
-    # `Kitchen::Driver::SSHBase`.
-    #
-    # @param state [Hash] mutable instance state
-    # @deprecated When legacy Driver::SSHBase support is removed, the
-    #   `#verify` method will no longer be called on the Driver.
-    # @api private
-    def legacy_ssh_base_verify(state)
-      warn("Running legacy verify for '#{driver.name}' Driver")
-      # TODO: Document upgrade path and provide link
-      # warn("Driver authors: please read http://example.com for more details.")
-      driver.verify(state)
-    end
-
     # The simplest finite state machine pseudo-implementation needed to manage
     # an Instance.
     #
@@ -689,7 +592,7 @@ module Kitchen
     # @author Fletcher Nichol <fnichol@nichol.ca>
     class FSM
       # Returns an Array of all transitions to bring an Instance from its last
-      # reported transistioned state into the desired transitioned state.
+      # reported transitioned state into the desired transitioned state.
       #
       # @param last [String,Symbol,nil] the last known transitioned state of
       #   the Instance, defaulting to `nil` (for unknown or no history)

data/lib/kitchen/lazy_hash.rb

@@ -18,7 +18,7 @@
 require "delegate"
 
 module Kitchen
-  # A modifed Hash object that may contain callables as a value which must be
+  # A modified Hash object that may contain callables as a value which must be
   # executed in the context of another object. This allows for delayed
   # evaluation of a hash value while still looking and largely feeling like a
   # normal Ruby Hash.

data/lib/kitchen/logger.rb

@@ -285,7 +285,7 @@ module Kitchen
     # Construct a new standard out logger.
     #
     # @param stdout [IO] the IO object that represents stdout (or similar)
-    # @param color [Symbol] color to use when outputing messages
+    # @param color [Symbol] color to use when outputting messages
     # @param colorize [Boolean] whether to enable color
     # @return [StdoutLogger] a new logger
     # @api private

data/lib/kitchen/metadata_chopper.rb

@@ -33,7 +33,7 @@ module Kitchen
       [mc[:name], mc[:version]]
     end
 
-    # Creates a new instances and loads in the contents of the metdata.rb
+    # Creates a new instances and loads in the contents of the metadata.rb
     # file. If you value your life, you may want to avoid reading the
     # implementation.
     #

data/lib/kitchen/provisioner/base.rb

@@ -247,24 +247,6 @@ module Kitchen
 
       private
 
-      # Builds a complete command given a variables String preamble and a file
-      # containing shell code.
-      #
-      # @param vars [String] shell variables, as a String
-      # @param file [String] file basename (without extension) containing
-      #   shell code
-      # @return [String] command
-      # @api private
-      def shell_code_from_file(vars, file)
-        src_file = File.join(
-          File.dirname(__FILE__),
-          %w{.. .. .. support},
-          file + (powershell_shell? ? ".ps1" : ".sh")
-        )
-
-        wrap_shell_code([vars, "", File.read(src_file)].join("\n"))
-      end
-
       # Conditionally prefixes a command with a sudo command.
       #
       # @param command [String] command to be prefixed

data/lib/kitchen/provisioner.rb

@@ -26,7 +26,7 @@ module Kitchen
   # @author Fletcher Nichol <fnichol@nichol.ca>
   module Provisioner
     # Default provisioner to use
-    DEFAULT_PLUGIN = "chef_infra".freeze
+    DEFAULT_PLUGIN = "shell".freeze
 
     # Returns an instance of a provisioner given a plugin type string.
     #
@@ -35,7 +35,6 @@ 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/transport/winrm.rb

@@ -21,8 +21,8 @@ require "rbconfig" unless defined?(RbConfig)
 require "uri" unless defined?(URI)
 require_relative "../../kitchen"
 require_relative "../util"
-require "winrm" unless defined?(WinRM::Connection)
-require "winrm/exceptions" unless defined?(WinRM::WinRMHTTPTransportError)
+require "chef-winrm" unless defined?(WinRM::Connection)
+require "chef-winrm/exceptions" unless defined?(WinRM::WinRMHTTPTransportError)
 
 module Kitchen
   module Transport
@@ -420,9 +420,9 @@ module Kitchen
 
       private
 
-      WINRM_SPEC_VERSION = ["~> 2.0"].freeze
-      WINRM_FS_SPEC_VERSION = ["~> 1.0"].freeze
-      WINRM_ELEVATED_SPEC_VERSION = ["~> 1.0"].freeze
+      CHEF_WINRM_SPEC_VERSION = ["~> 2.0"].freeze
+      CHEF_WINRM_FS_SPEC_VERSION = ["~> 1.0"].freeze
+      CHEF_WINRM_ELEVATED_SPEC_VERSION = ["~> 1.0"].freeze
 
       # Builds the hash of options needed by the Connection object on
       # construction.
@@ -515,9 +515,9 @@ module Kitchen
       # (see Base#load_needed_dependencies!)
       def load_needed_dependencies!
         super
-        load_with_rescue!("winrm", WINRM_SPEC_VERSION.dup)
-        load_with_rescue!("winrm-fs", WINRM_FS_SPEC_VERSION.dup)
-        load_with_rescue!("winrm-elevated", WINRM_ELEVATED_SPEC_VERSION.dup) if config[:elevated]
+        load_with_rescue!("chef-winrm", CHEF_WINRM_SPEC_VERSION.dup)
+        load_with_rescue!("chef-winrm-fs", CHEF_WINRM_FS_SPEC_VERSION.dup)
+        load_with_rescue!("chef-winrm-elevated", CHEF_WINRM_ELEVATED_SPEC_VERSION.dup) if config[:elevated]
       end
 
       def load_with_rescue!(gem_name, spec_version)

data/lib/kitchen/util.rb

@@ -128,7 +128,7 @@ module Kitchen
       "sh -c '\n#{cmd}\n'"
     end
 
-    # Modifes the given string to strip leading whitespace on each line, the
+    # Modifies the given string to strip leading whitespace on each line, the
     # amount which is calculated by using the first line of text.
     #
     # @example

data/lib/kitchen/version.rb

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

data/lib/kitchen.rb

@@ -31,7 +31,6 @@ require_relative "kitchen/config"
 require_relative "kitchen/data_munger"
 require_relative "kitchen/driver"
 require_relative "kitchen/driver/base"
-require_relative "kitchen/driver/ssh_base"
 require_relative "kitchen/driver/proxy"
 require_relative "kitchen/instance"
 require_relative "kitchen/lifecycle_hooks"
@@ -41,7 +40,6 @@ require_relative "kitchen/loader/yaml"
 require_relative "kitchen/metadata_chopper"
 require_relative "kitchen/platform"
 require_relative "kitchen/state_file"
-require_relative "kitchen/ssh"
 require_relative "kitchen/suite"
 require_relative "kitchen/verifier"
 require_relative "kitchen/verifier/base"

data/lib/vendor/hash_recursive_merge.rb

@@ -48,8 +48,8 @@ module HashRecursiveMerge
   # When both +hsh+ and +other_hash+ contains an entry with the same key,
   # it merges and returns the values from both arrays.
   #
-  # Compared with Hash#merge, this method provides a different approch
-  # for merging nasted hashes.
+  # Compared with Hash#merge, this method provides a different approach
+  # for merging nested hashes.
   # If the value of a given key is an Hash and both +other_hash+ abd +hsh
   # includes the same key, the value is merged instead replaced with
   # +other_hash+ value.

data/templates/driver/driver.rb.erb

@@ -11,7 +11,7 @@ module Kitchen
     # <%= config[:klass_name] %> driver for Kitchen.
     #
     # @author <%= config[:author] %> <<%= config[:email] %>>
-    class <%= config[:klass_name] %> < Kitchen::Driver::SSHBase
+    class <%= config[:klass_name] %> < Kitchen::Driver::Base
 
       def create(state)
       end

data/test-kitchen.gemspec

@@ -35,10 +35,8 @@ Gem::Specification.new do |gem|
   gem.add_dependency "ostruct",            "~> 0.6"
   gem.add_dependency "syslog",             "~> 0.3"
   gem.add_dependency "thor",               ">= 0.19", "< 2.0"
-  gem.add_dependency "winrm",              "~> 2.0"
-  gem.add_dependency "winrm-elevated",     "~> 1.0"
-  gem.add_dependency "winrm-fs",           "~> 1.1"
-  # 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
+  # Chef Forked versions with additional fixes since no one is maintining them upstream
+  gem.add_dependency "chef-winrm",         ">= 2.5.0", "< 3.0"
+  gem.add_dependency "chef-winrm-elevated", ">= 1.0", "< 2.0"
+  gem.add_dependency "chef-winrm-fs",      ">= 1.0", "< 2.0"
 end