test-kitchen 2.6.0 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbc194fbd762658d4d989813aa6eb5aff36dda3859ee7d65eaf080fe033b1fad
-  data.tar.gz: f4afc61cf21085c167952eadae6867ffc242c616d283dbfdff8c7e87085d5dfb
+  metadata.gz: 58365d9f59d1210a1c8f56f7fe095f285fde61e6251c61b164569b783d75d6f8
+  data.tar.gz: ceef4069cb15be71c35992173d3d347717f8149dc3a7fe2f4863e5a8aaac98c5
 SHA512:
-  metadata.gz: 7278defbe363816e09a07eaa757bc7108d7e87bbbf93dc8f30e1d93d4eda5aebe2b5a826d817a8be20cd123ffaa917f890458568245860d8f0e7ae233428c38b
-  data.tar.gz: 509577b9063d96342cfd1491aeae633930ca88dbf18be3b2bee23145850ee8eba1fd8e8581fd11ce583216797eaf9d9f9dff78e8e38997c2f614ba3159a12e10
+  metadata.gz: bf9e9206b2b78a39fa9fdeca2104e3cf17fed69821644f0055e7638e23a15f50dc11c9923718e5cb997d9a2ef416bbe2e48649fc6d6e7c02fd8627fbbe86f6b1
+  data.tar.gz: 86102634d2ad1b336cd5e18fdfe005ea7ef18f77e185351f041567aeb32b224609e457ca6904ea865bb18f278e836fdca4ae9afedff1877dd71564ed17d54d1b

data/Rakefile

@@ -42,7 +42,7 @@ desc "Run all quality tasks"
 task quality: %i{style stats}
 
 begin
-  require "yard"
+  require "yard" unless defined?(YARD)
   YARD::Rake::YardocTask.new
 rescue LoadError
   puts "yard is not available. (sudo) gem install yard to generate yard documentation."

data/bin/kitchen

@@ -4,7 +4,7 @@
 Signal.trap("INT") { exit 1 }
 
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), %w{.. lib})
-require "rubygems"
+require "rubygems" unless defined?(Gem)
 require "kitchen/cli"
 require "kitchen/errors"
 

data/lib/kitchen.rb

@@ -15,9 +15,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "pathname"
-require "thread"
-
+require "pathname" unless defined?(Pathname)
 require_relative "kitchen/errors"
 require_relative "kitchen/logger"
 require_relative "kitchen/logging"
@@ -67,7 +65,7 @@ module Kitchen
     #
     # @return [Pathname] root path of gem
     def source_root
-      @source_root ||= Pathname.new(File.expand_path("../../", __FILE__))
+      @source_root ||= Pathname.new(File.expand_path("..", __dir__))
     end
 
     # Returns a default logger which emits on standard output.

data/lib/kitchen/cli.rb

@@ -15,7 +15,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "thor"
+# CI tests fail without an explicit unconditional require of Thor
+require "thor" # rubocop:disable Chef/Ruby/UnlessDefinedRequire
 
 require_relative "../kitchen"
 require_relative "generator/init"

data/lib/kitchen/command.rb

@@ -15,8 +15,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "thread"
-
 module Kitchen
   module Command
     # Base class for CLI commands.

data/lib/kitchen/command/action.rb

@@ -17,7 +17,7 @@
 
 require_relative "../command"
 
-require "benchmark"
+require "benchmark" unless defined?(Benchmark)
 
 module Kitchen
   module Command

data/lib/kitchen/command/diagnose.rb

@@ -18,7 +18,7 @@
 require_relative "../command"
 require_relative "../diagnostic"
 
-require "yaml"
+autoload :YAML, "yaml"
 
 module Kitchen
   module Command
@@ -32,9 +32,9 @@ module Kitchen
 
         loader = record_failure { load_loader }
 
-        puts Kitchen::Diagnostic.new(
+        puts YAML.dump(Kitchen::Diagnostic.new(
           loader: loader, instances: instances, plugins: plugins?
-        ).read.to_yaml
+        ).read)
       end
 
       private

data/lib/kitchen/command/list.rb

@@ -16,7 +16,7 @@
 # limitations under the License.
 
 require_relative "../command"
-require "json"
+require "json" unless defined?(JSON)
 
 module Kitchen
   module Command

data/lib/kitchen/command/test.rb

@@ -17,7 +17,7 @@
 
 require_relative "../command"
 
-require "benchmark"
+require "benchmark" unless defined?(Benchmark)
 
 module Kitchen
   module Command

data/lib/kitchen/config.rb

@@ -213,7 +213,7 @@ module Kitchen
           provisioner: Provisioner::DEFAULT_PLUGIN,
           verifier: Verifier::DEFAULT_PLUGIN,
           transport: lambda do |_suite, platform|
-            platform =~ /^win/i ? "winrm" : Transport::DEFAULT_PLUGIN
+            /^win/i.match?(platform) ? "winrm" : Transport::DEFAULT_PLUGIN
           end,
         },
         kitchen_root: kitchen_root,

data/lib/kitchen/driver/base.rb

@@ -19,6 +19,7 @@ require_relative "../configurable"
 require_relative "../errors"
 require_relative "../lazy_hash"
 require_relative "../logging"
+require_relative "../plugin_base"
 require_relative "../shell_out"
 
 module Kitchen
@@ -26,7 +27,7 @@ module Kitchen
     # Base class for a driver.
     #
     # @author Fletcher Nichol <fnichol@nichol.ca>
-    class Base
+    class Base < Kitchen::Plugin::Base
       include Configurable
       include Logging
       include ShellOut
@@ -69,43 +70,6 @@ module Kitchen
         false
       end
 
-      class << self
-        # @return [Array<Symbol>] an array of action method names that cannot
-        #   be run concurrently and must be run in serial via a shared mutex
-        attr_reader :serial_actions
-      end
-
-      # Registers certain driver actions that cannot be safely run concurrently
-      # in threads across multiple instances. Typically this might be used
-      # for create or destroy actions that use an underlying resource that
-      # cannot be used at the same time.
-      #
-      # A shared mutex for this driver object will be used to synchronize all
-      # registered methods.
-      #
-      # @example a single action method that cannot be run concurrently
-      #
-      #   no_parallel_for :create
-      #
-      # @example multiple action methods that cannot be run concurrently
-      #
-      #   no_parallel_for :create, :destroy
-      #
-      # @param methods [Array<Symbol>] one or more actions as symbols
-      # @raise [ClientError] if any method is not a valid action method name
-      def self.no_parallel_for(*methods)
-        action_methods = %i{create setup converge verify destroy}
-
-        Array(methods).each do |meth|
-          next if action_methods.include?(meth)
-
-          raise ClientError, "##{meth} is not a valid no_parallel_for method"
-        end
-
-        @serial_actions ||= []
-        @serial_actions += methods
-      end
-
       # Sets the API version for this driver. If the driver does not set this
       # value, then `nil` will be used and reported.
       #

data/lib/kitchen/driver/ssh_base.rb

@@ -18,7 +18,8 @@
 require "thor/util"
 
 require_relative "../lazy_hash"
-require "benchmark"
+require_relative "../plugin_base"
+require "benchmark" unless defined?(Benchmark)
 
 module Kitchen
   module Driver
@@ -42,7 +43,7 @@ module Kitchen
     #   Transport, and Verifier subsystems may not be picked up in these
     #   Drivers. When legacy Driver::SSHBase support is removed, this class
     #   will no longer be available.
-    class SSHBase
+    class SSHBase < Kitchen::Plugin::Base
       include ShellOut
       include Configurable
       include Logging
@@ -179,43 +180,6 @@ module Kitchen
       #   documented dependency is missing from the system
       def verify_dependencies; end
 
-      class << self
-        # @return [Array<Symbol>] an array of action method names that cannot
-        #   be run concurrently and must be run in serial via a shared mutex
-        attr_reader :serial_actions
-      end
-
-      # Registers certain driver actions that cannot be safely run concurrently
-      # in threads across multiple instances. Typically this might be used
-      # for create or destroy actions that use an underlying resource that
-      # cannot be used at the same time.
-      #
-      # A shared mutex for this driver object will be used to synchronize all
-      # registered methods.
-      #
-      # @example a single action method that cannot be run concurrently
-      #
-      #   no_parallel_for :create
-      #
-      # @example multiple action methods that cannot be run concurrently
-      #
-      #   no_parallel_for :create, :destroy
-      #
-      # @param methods [Array<Symbol>] one or more actions as symbols
-      # @raise [ClientError] if any method is not a valid action method name
-      def self.no_parallel_for(*methods)
-        action_methods = %i{create converge setup verify destroy}
-
-        Array(methods).each do |meth|
-          next if action_methods.include?(meth)
-
-          raise ClientError, "##{meth} is not a valid no_parallel_for method"
-        end
-
-        @serial_actions ||= []
-        @serial_actions += methods
-      end
-
       # Cache directory that a driver could implement to inform the provisioner
       # that it can leverage it internally
       #

data/lib/kitchen/instance.rb

@@ -15,8 +15,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "benchmark"
-require "fileutils"
+require "benchmark" unless defined?(Benchmark)
+require "fileutils" unless defined?(FileUtils)
 
 module Kitchen
   # An instance of a suite running on a platform. A created instance may be a
@@ -28,7 +28,7 @@ module Kitchen
     include Logging
 
     class << self
-      # @return [Hash] a hash of mutxes, arranged by Driver class names
+      # @return [Hash] a hash of mutexes, arranged by Plugin class names
       # @api private
       attr_accessor :mutexes
 
@@ -322,21 +322,29 @@ module Kitchen
       end
     end
 
-    # Perform any final configuration or preparation needed for the driver
-    # object carry out its duties.
+    # If a plugin has declared via .no_parallel_for that it is not
+    # thread-safe for certain actions, create a mutex to track it.
     #
+    # @param plugin_class[Class] Kitchen::Plugin::Base
     # @api private
-    def setup_driver
-      @driver.finalize_config!(self)
-
-      if driver.class.serial_actions
+    def setup_plugin_mutexes(plugin_class)
+      if plugin_class.serial_actions
         Kitchen.mutex.synchronize do
           self.class.mutexes ||= {}
-          self.class.mutexes[driver.class] = Mutex.new
+          self.class.mutexes[plugin_class] = Mutex.new
         end
       end
     end
 
+    # Perform any final configuration or preparation needed for the driver
+    # object carry out its duties.
+    #
+    # @api private
+    def setup_driver
+      @driver.finalize_config!(self)
+      setup_plugin_mutexes(driver.class)
+    end
+
     # Perform any final configuration or preparation needed for the lifecycle hooks
     # object carry out its duties.
     #
@@ -351,6 +359,7 @@ module Kitchen
     # @api private
     def setup_provisioner
       @provisioner.finalize_config!(self)
+      setup_plugin_mutexes(provisioner.class)
     end
 
     # Perform any final configuration or preparation needed for the transport
@@ -359,6 +368,7 @@ module Kitchen
     # @api private
     def setup_transport
       transport.finalize_config!(self)
+      setup_plugin_mutexes(transport.class)
     end
 
     # Perform any final configuration or preparation needed for the verifier
@@ -367,6 +377,7 @@ module Kitchen
     # @api private
     def setup_verifier
       verifier.finalize_config!(self)
+      setup_plugin_mutexes(verifier.class)
     end
 
     # Perform all actions in order from last state to desired state.
@@ -541,10 +552,11 @@ module Kitchen
     # @param block [Proc] a block to be called
     # @api private
     def synchronize_or_call(what, state)
-      if Array(driver.class.serial_actions).include?(what)
-        debug("#{to_str} is synchronizing on #{driver.class}##{what}")
-        self.class.mutexes[driver.class].synchronize do
-          debug("#{to_str} is messaging #{driver.class}##{what}")
+      plugin_class = plugin_class_for_action(what)
+      if Array(plugin_class.serial_actions).include?(what)
+        debug("#{to_str} is synchronizing on #{plugin_class}##{what}")
+        self.class.mutexes[plugin_class].synchronize do
+          debug("#{to_str} is messaging #{plugin_class}##{what}")
           yield(state)
         end
       else
@@ -552,6 +564,21 @@ module Kitchen
       end
     end
 
+    # Maps the given action to the plugin class associated with the action
+    #
+    # @param what[Symbol] action
+    # @return [Class] Kitchen::Plugin::Base
+    # @api private
+    def plugin_class_for_action(what)
+      {
+        create: driver,
+        setup: transport,
+        converge: provisioner,
+        verify: verifier,
+        destroy: driver,
+      }[what].class
+    end
+
     # Writes a high level message for logging and/or output.
     #
     # In this case, all instance banner messages will be written to the common

data/lib/kitchen/loader/yaml.rb

@@ -15,9 +15,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "erb"
+require "erb" unless defined?(Erb)
 require_relative "../../vendor/hash_recursive_merge"
-require "yaml"
+require "yaml" unless defined?(YAML)
 
 module Kitchen
   module Loader

data/lib/kitchen/logger.rb

@@ -15,7 +15,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "fileutils"
+require "fileutils" unless defined?(FileUtils)
 require "logger"
 
 module Kitchen

data/lib/kitchen/plugin_base.rb

@@ -0,0 +1,60 @@
+#
+# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
+#
+# Copyright (C) 2014, 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.
+
+module Kitchen
+  module Plugin
+    class Base
+      class << self
+        # @return [Array<Symbol>] an array of action method names that cannot
+        #   be run concurrently and must be run in serial via a shared mutex
+        attr_reader :serial_actions
+      end
+
+      # Registers certain driver actions that cannot be safely run concurrently
+      # in threads across multiple instances. Typically this might be used
+      # for create or destroy actions that use an underlying resource that
+      # cannot be used at the same time.
+      #
+      # A shared mutex for this driver object will be used to synchronize all
+      # registered methods.
+      #
+      # @example a single action method that cannot be run concurrently
+      #
+      #   no_parallel_for :create
+      #
+      # @example multiple action methods that cannot be run concurrently
+      #
+      #   no_parallel_for :create, :destroy
+      #
+      # @param methods [Array<Symbol>] one or more actions as symbols
+      # @raise [ClientError] if any method is not a valid action method name
+      def self.no_parallel_for(*methods)
+        action_methods = %i{create setup converge verify destroy}
+
+        Array(methods).each do |meth|
+          next if action_methods.include?(meth)
+
+          raise ClientError, "##{meth} is not a valid no_parallel_for method"
+        end
+
+        @serial_actions ||= []
+        @serial_actions += methods
+      end
+
+    end
+  end
+end

data/lib/kitchen/provisioner/base.rb

@@ -18,13 +18,14 @@
 require_relative "../configurable"
 require_relative "../errors"
 require_relative "../logging"
+require_relative "../plugin_base"
 
 module Kitchen
   module Provisioner
     # Base class for a provisioner.
     #
     # @author Fletcher Nichol <fnichol@nichol.ca>
-    class Base
+    class Base < Kitchen::Plugin::Base
       include Configurable
       include Logging
 

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

@@ -15,7 +15,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "json"
+require "json" unless defined?(JSON)
 
 module Kitchen
   module Provisioner

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

@@ -15,8 +15,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "shellwords"
-require "rbconfig"
+require "shellwords" unless defined?(Shellwords)
+require "rbconfig" unless defined?(RbConfig)
 
 require_relative "../../errors"
 require_relative "../../logging"
@@ -110,13 +110,13 @@ module Kitchen
         # @return [String]
         # @api private
         def escape_path(path)
-          if RbConfig::CONFIG["host_os"] =~ /mswin|mingw/
+          if /mswin|mingw/.match?(RbConfig::CONFIG["host_os"])
             # I know what you're thinking: "just use Shellwords.escape". That
             # method produces incorrect results on Windows with certain input
             # which would be a metacharacter in Sh but is not for one or more of
             # Windows command line parsing libraries. This covers the 99% case of
             # spaces in the path without breaking other stuff.
-            if path =~ /[ \t\n\v"]/
+            if /[ \t\n\v"]/.match?(path)
               "\"#{path.gsub(/[ \t\n\v\"\\]/) { |m| '\\' + m[0] }}\""
             else
               path
@@ -136,7 +136,7 @@ module Kitchen
           # @api private
           def detect_chef_command!(logger)
             unless ENV["PATH"].split(File::PATH_SEPARATOR).any? do |path|
-              if RbConfig::CONFIG["host_os"] =~ /mswin|mingw/
+              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))
@@ -146,7 +146,7 @@ module Kitchen
               end
             end
               logger.fatal("The `chef` executable cannot be found in your " \
-                          "PATH. Ensure you have installed ChefDK or Chef Workstation " \
+                          "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,

data/lib/kitchen/provisioner/chef_base.rb

@@ -15,18 +15,18 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "fileutils"
-require "pathname"
-require "json"
-require "cgi"
+require "fileutils" unless defined?(FileUtils)
+require "pathname" unless defined?(Pathname)
+require "json" unless defined?(JSON)
+require "cgi" unless defined?(CGI)
 
 require_relative "chef/policyfile"
 require_relative "chef/berkshelf"
 require_relative "chef/common_sandbox"
 require_relative "../util"
-require "mixlib/install"
-require "mixlib/install/script_generator"
-require "license_acceptance/acceptor"
+module LicenseAcceptance
+  autoload :Acceptor, "license_acceptance/acceptor"
+end
 
 begin
   require "chef-config/config"
@@ -156,7 +156,7 @@ module Kitchen
               product_name: <chef or chef-workstation>
               install_strategy: skip
           MSG
-        when provisioner[:require_chef_omnibus].to_s.match(/\d/)
+        when provisioner[:require_chef_omnibus].to_s.match?(/\d/)
           Util.outdent!(<<-MSG)
             The 'require_chef_omnibus' attribute with version values will change
             to use the new 'product_version' attribute.
@@ -503,6 +503,7 @@ module Kitchen
       # @return [String] contents of product based install script
       # @api private
       def script_for_product
+        require "mixlib/install"
         installer = Mixlib::Install.new({
           product_name: config[:product_name],
           product_version: config[:product_version],
@@ -576,6 +577,7 @@ module Kitchen
       # @return [String] contents of version based install script
       # @api private
       def script_for_omnibus_version
+        require "mixlib/install/script_generator"
         installer = Mixlib::Install::ScriptGenerator.new(
           config[:require_chef_omnibus], powershell_shell?, install_options
         )

data/lib/kitchen/provisioner/chef_solo.rb

@@ -27,6 +27,10 @@ module Kitchen
 
       plugin_version Kitchen::VERSION
 
+      # ChefSolo is dependent on Berkshelf, which is not thread-safe.
+      # See discussion on https://github.com/test-kitchen/test-kitchen/issues/1307
+      no_parallel_for :converge
+
       default_config :solo_rb, {}
 
       default_config :chef_solo_path do |provisioner|

data/lib/kitchen/provisioner/shell.rb

@@ -15,7 +15,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "shellwords"
+require "shellwords" unless defined?(Shellwords)
 
 require_relative "base"
 require_relative "../version"

data/lib/kitchen/shell_out.rb

@@ -15,7 +15,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "mixlib/shellout"
+require "mixlib/shellout" unless defined?(Mixlib::ShellOut)
 
 module Kitchen
   # Mixin that wraps a command shell out invocation, providing a #run_command

data/lib/kitchen/ssh.rb

@@ -16,9 +16,10 @@
 # limitations under the License.
 
 require "logger"
-require "net/ssh"
-require "net/scp"
-require "socket"
+module Net
+  autoload :SSH, "net/ssh"
+end
+require "socket" unless defined?(Socket)
 
 require_relative "errors"
 require_relative "login_command"
@@ -90,6 +91,7 @@ module Kitchen
     #   `Net::SCP.upload`
     # @see http://net-ssh.github.io/net-scp/classes/Net/SCP.html#method-i-upload
     def upload!(local, remote, options = {}, &progress)
+      require "net/scp" unless defined?(Net::SCP)
       if progress.nil?
         progress = lambda do |_ch, name, sent, total|
           logger.debug("Uploaded #{name} (#{total} bytes)") if sent == total
@@ -100,6 +102,7 @@ module Kitchen
     end
 
     def upload(local, remote, options = {}, &progress)
+      require "net/scp" unless defined?(Net::SCP)
       if progress.nil?
         progress = lambda do |_ch, name, sent, total|
           if sent == total

data/lib/kitchen/state_file.rb

@@ -15,7 +15,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "yaml"
+autoload :YAML, "yaml"
 
 module Kitchen
   # Exception class for any exceptions raised when reading and parsing a state

data/lib/kitchen/thor_tasks.rb

@@ -15,7 +15,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "thor"
+require "thor" unless defined?(Thor)
 
 require_relative "../kitchen"
 

data/lib/kitchen/transport/base.rb

@@ -21,6 +21,7 @@ require_relative "../errors"
 require_relative "../lazy_hash"
 require_relative "../logging"
 require_relative "../login_command"
+require_relative "../plugin_base"
 
 module Kitchen
   module Transport
@@ -40,7 +41,7 @@ module Kitchen
     #
     # @author Salim Afiune <salim@afiunemaya.com.mx>
     # @author Fletcher Nichol <fnichol@nichol.ca>
-    class Base
+    class Base < Kitchen::Plugin::Base
       include Configurable
       include Logging
 

data/lib/kitchen/transport/exec.rb

@@ -11,7 +11,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "fileutils"
+require "fileutils" unless defined?(FileUtils)
 
 require_relative "../shell_out"
 require_relative "base"
@@ -28,7 +28,7 @@ module Kitchen
       plugin_version Kitchen::VERSION
 
       def connection(state, &block)
-        options = config.to_hash.merge(state)
+        options = connection_options(config.to_hash.merge(state))
         Kitchen::Transport::Exec::Connection.new(options, &block)
       end
 
@@ -40,19 +40,105 @@ module Kitchen
         def execute(command)
           return if command.nil?
 
-          run_command(command)
+          if host_os_windows?
+            run_command(run_from_file_command(command))
+            close
+          else
+            run_command(command)
+          end
+        end
+
+        def close
+          if host_os_windows?
+            FileUtils.remove(exec_script_file)
+          end
         end
 
         # "Upload" the files by copying them locally.
         #
         # @see Base#upload
         def upload(locals, remote)
-          FileUtils.mkdir_p(remote)
+          # evaluate $env:temp on Windows
+          real_remote = remote.to_s == "\$env:TEMP\\kitchen" ? kitchen_temp : remote
+          FileUtils.mkdir_p(real_remote)
           Array(locals).each do |local|
-            FileUtils.cp_r(local, remote)
+            FileUtils.cp_r(local, real_remote)
+          end
+        end
+
+        # (see Base#init_options)
+        def init_options(options)
+          super
+          @instance_name = @options.delete(:instance_name)
+          @kitchen_root = @options.delete(:kitchen_root)
+        end
+
+        private
+
+        # @return [String] display name for the associated instance
+        # @api private
+        attr_reader :instance_name
+
+        # @return [String] local path to the root of the project
+        # @api private
+        attr_reader :kitchen_root
+
+        # Takes a long command and saves it to a file and uploads it to
+        # the test instance. Windows has cli character limits.
+        #
+        # @param command [String] a long command to be saved and uploaded
+        # @return [String] a command that executes the uploaded script
+        # @api private
+        def run_from_file_command(command)
+          if logger.debug?
+            debug("Creating exec script for #{instance_name} (#{exec_script_file})")
+            debug("Executing #{exec_script_file}")
+          end
+          File.open(exec_script_file, "wb") { |file| file.write(command) }
+          %{powershell -file "#{exec_script_file}"}
+        end
+
+        # @return [String] evaluated $env:temp variable
+        # @api private
+        def kitchen_temp
+          "#{ENV["temp"]}/kitchen"
+        end
+
+        # @return [String] name of script using instance name
+        # @api private
+        def exec_script_name
+          "#{instance_name}-exec-script.ps1"
+        end
+
+        # @return [String] file path for exec script to be run
+        # @api private
+        def exec_script_file
+          File.join(kitchen_root, ".kitchen", exec_script_name)
+        end
+
+        def host_os_windows?
+          case RbConfig::CONFIG["host_os"]
+          when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
+            true
+          else
+            false
           end
         end
+      end
+
+      private
 
+      # Builds the hash of options needed by the Connection object on construction.
+      #
+      # @param data [Hash] merged configuration and mutable state data
+      # @return [Hash] hash of connection options
+      # @api private
+      def connection_options(data)
+        opts = {
+          instance_name: instance.name,
+          kitchen_root: Dir.pwd,
+        }
+        opts
       end
     end
   end

data/lib/kitchen/transport/ssh.rb

@@ -17,13 +17,13 @@
 
 require_relative "../../kitchen"
 
-require "fileutils"
-require "net/ssh"
+require "fileutils" unless defined?(FileUtils)
+require "net/ssh" unless defined?(Net::SSH)
 require "net/ssh/gateway"
 require "net/ssh/proxy/http"
 require "net/scp"
-require "timeout"
-require "benchmark"
+require "timeout" unless defined?(Timeout)
+require "benchmark" unless defined?(Benchmark)
 
 module Kitchen
   module Transport

data/lib/kitchen/transport/winrm.rb

@@ -17,10 +17,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "rbconfig"
-require "uri"
+require "rbconfig" unless defined?(RbConfig)
+require "uri" unless defined?(URI)
 require_relative "../../kitchen"
-require "winrm"
+require "winrm" unless defined?(WinRM::Connection)
 
 module Kitchen
   module Transport
@@ -308,16 +308,20 @@ module Kitchen
 
         # Builds a `LoginCommand` for use by Linux-based platforms.
         #
-        # TODO: determine whether or not `desktop` exists
-        #
         # @return [LoginCommand] a login command
         # @api private
         def login_command_for_linux
-          args  = %W{-u #{options[:user]}}
-          args += %W{-p #{options[:password]}} if options.key?(:password)
-          args += %W{#{URI.parse(options[:endpoint]).host}:#{rdp_port}}
+          xfreerdp = Util.command_exists? "xfreerdp"
+          unless xfreerdp
+            raise WinrmFailed, "xfreerdp binary not found. Please install freerdp2-x11 on Debian-based systems or freerdp on Redhat-based systems."
+          end
+
+          args  = %W{/u:#{options[:user]}}
+          args += %W{/p:#{options[:password]}} if options.key?(:password)
+          args += %W{/v:#{URI.parse(options[:endpoint]).host}:#{rdp_port}}
+          args += %W{/cert-tofu} # always accept certificate
 
-          LoginCommand.new("rdesktop", args)
+          LoginCommand.new(xfreerdp, args)
         end
 
         # Builds a `LoginCommand` for use by Mac-based platforms.

data/lib/kitchen/util.rb

@@ -110,7 +110,7 @@ module Kitchen
     def self.wrap_command(cmd)
       cmd = "false" if cmd.nil?
       cmd = "true" if cmd.to_s.empty?
-      cmd = cmd.sub(/\n\Z/, "") if cmd =~ /\n\Z/
+      cmd = cmd.sub(/\n\Z/, "") if /\n\Z/.match?(cmd)
 
       "sh -c '\n#{cmd}\n'"
     end
@@ -215,5 +215,15 @@ module Kitchen
     def self.snake_case(a_string)
       Thor::Util.snake_case(a_string)
     end
+
+    # Check if a cmd exists on the PATH
+    def self.command_exists?(cmd)
+      paths = ENV["PATH"].split(File::PATH_SEPARATOR) + [ "/bin", "/usr/bin", "/sbin", "/usr/sbin" ]
+      paths.each do |path|
+        filename = File.join(path, cmd)
+        return filename if File.executable?(filename)
+      end
+      false
+    end
   end
 end

data/lib/kitchen/verifier/base.rb

@@ -18,13 +18,14 @@
 require_relative "../errors"
 require_relative "../configurable"
 require_relative "../logging"
+require_relative "../plugin_base"
 
 module Kitchen
   module Verifier
     # Base class for a verifier.
     #
     # @author Fletcher Nichol <fnichol@nichol.ca>
-    class Base
+    class Base < Kitchen::Plugin::Base
       include Configurable
       include Logging
 

data/lib/kitchen/verifier/busser.rb

@@ -15,8 +15,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "base64"
-require "digest"
+require "base64" unless defined?(Base64)
+require "digest" unless defined?(Digest)
 
 require_relative "base"
 
@@ -168,7 +168,7 @@ module Kitchen
       # @api private
       def gem_install_args
         gem, version = config[:version].split("@")
-        if gem =~ /^\d+\.\d+\.\d+/
+        if /^\d+\.\d+\.\d+/.match?(gem)
           version = gem
           gem = "busser"
         end

data/lib/kitchen/verifier/shell.rb

@@ -23,7 +23,7 @@ module Kitchen
     #
     # @author SAWANOBORI Yukihiko (<sawanoboriyu@higanworks.com>)
     class Shell < Kitchen::Verifier::Base
-      require "mixlib/shellout"
+      require "mixlib/shellout" unless defined?(Mixlib::ShellOut)
 
       kitchen_verifier_api_version 1
 

data/lib/kitchen/version.rb

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

data/test-kitchen.gemspec

@@ -1,4 +1,4 @@
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "kitchen/version"
 require "English"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-kitchen
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.9.0
 platform: ruby
 authors:
 - Fletcher Nichol
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-13 00:00:00.000000000 Z
+date: 2020-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mixlib-shellout
@@ -423,6 +423,7 @@ files:
 - lib/kitchen/metadata_chopper.rb
 - lib/kitchen/platform.rb
 - lib/kitchen/plugin.rb
+- lib/kitchen/plugin_base.rb
 - lib/kitchen/provisioner.rb
 - lib/kitchen/provisioner/base.rb
 - lib/kitchen/provisioner/chef/berkshelf.rb
@@ -499,7 +500,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Test Kitchen is an integration tool for developing and testing infrastructure