test-kitchen 2.6.0 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbc194fbd762658d4d989813aa6eb5aff36dda3859ee7d65eaf080fe033b1fad
-  data.tar.gz: f4afc61cf21085c167952eadae6867ffc242c616d283dbfdff8c7e87085d5dfb
+  metadata.gz: f6ccfe0fbf72b2850671e2e1782c9b8477dd2134a3582d8087dd61c77a7414c7
+  data.tar.gz: 74b6c95a6bc563f846ae54f6c1f62661b4cb1128aa278535e8234e95c2be3ce1
 SHA512:
-  metadata.gz: 7278defbe363816e09a07eaa757bc7108d7e87bbbf93dc8f30e1d93d4eda5aebe2b5a826d817a8be20cd123ffaa917f890458568245860d8f0e7ae233428c38b
-  data.tar.gz: 509577b9063d96342cfd1491aeae633930ca88dbf18be3b2bee23145850ee8eba1fd8e8581fd11ce583216797eaf9d9f9dff78e8e38997c2f614ba3159a12e10
+  metadata.gz: 7a01947ea6e91991646128a65733f0b9b9a7c1d50cb76cb2b373288dbc2b2b3e631d3a217cbbbcec09b21331ef21545dfb89af3ec595ea69ca3b82e367febccc
+  data.tar.gz: 2735785eb1b12548353a38da11ff74484daa403fd4672d196d30915807f937b7dab0760cccf502d32ceb4620cabf5274f7f12a07efe85d179c0a3ce8d1e165f6

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,7 +15,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "pathname"
+require "pathname" unless defined?(Pathname)
 require "thread"
 
 require_relative "kitchen/errors"

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 ChefRuby/UnlessDefinedRequire
 
 require_relative "../kitchen"
 require_relative "generator/init"

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"
+require "yaml" unless defined?(YAML)
 
 module Kitchen
   module Command

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/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"

data/lib/kitchen/provisioner/chef_base.rb

@@ -15,10 +15,10 @@
 # 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"

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,9 @@
 # limitations under the License.
 
 require "logger"
-require "net/ssh"
+require "net/ssh" unless defined?(Net::SSH)
 require "net/scp"
-require "socket"
+require "socket" unless defined?(Socket)
 
 require_relative "errors"
 require_relative "login_command"

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"
+require "yaml" unless defined?(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"

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

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"
 

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.7.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-kitchen
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.7.0
 platform: ruby
 authors:
 - Fletcher Nichol
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-13 00:00:00.000000000 Z
+date: 2020-09-09 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