test-kitchen 2.5.1 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 020036a12997a93cdf945e3ffa7fc856aded24a2dfa635a590f2251c7867388a
-  data.tar.gz: 2899df7333b621b760638e69067e20f130b521720b90394459fd1c02fc4a0105
+  metadata.gz: f6ccfe0fbf72b2850671e2e1782c9b8477dd2134a3582d8087dd61c77a7414c7
+  data.tar.gz: 74b6c95a6bc563f846ae54f6c1f62661b4cb1128aa278535e8234e95c2be3ce1
 SHA512:
-  metadata.gz: 4c5ff7ea0ac8fa94b46b793701c7423cf116a6ae3a650543a36a736f299792e5ddd0c79bb4fcb4e56f7766265eb7beebedb5975912ae7c87c32e1db3abebf58a
-  data.tar.gz: 9e31f598e94d854e263efe69be8ea98386c05ba1c98e5b9055a4330cf70423b629686d8bca89b929c3b82263466f81d4bf1b5117c17ecc1cdeeb88dc11361c25
+  metadata.gz: 7a01947ea6e91991646128a65733f0b9b9a7c1d50cb76cb2b373288dbc2b2b3e631d3a217cbbbcec09b21331ef21545dfb89af3ec595ea69ca3b82e367febccc
+  data.tar.gz: 2735785eb1b12548353a38da11ff74484daa403fd4672d196d30915807f937b7dab0760cccf502d32ceb4620cabf5274f7f12a07efe85d179c0a3ce8d1e165f6

data/Gemfile

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 source "https://rubygems.org"
 gemspec
 
@@ -26,13 +25,3 @@ end
 group :docs do
   gem "yard"
 end
-
-instance_eval(ENV["GEMFILE_MOD"]) if ENV["GEMFILE_MOD"]
-
-# To avoid bringing in development or test dependencies that are not
-# absolutely needed, if you want to load tools not present in the gemspec
-# or this Gemfile, add those additional dependencies into a Gemfile.local
-# file which is ignored by this repository.
-# rubocop:disable Security/Eval
-eval(IO.read(__FILE__ + ".local"), binding) if File.exist?(__FILE__ + ".local")
-# rubocop:enable Security/Eval

data/Rakefile

@@ -1,5 +1,3 @@
-# -*- encoding: utf-8 -*-
-
 require "bundler/gem_tasks"
 
 require "rake/testtask"
@@ -44,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

@@ -1,12 +1,10 @@
 #!/usr/bin/env ruby
-# -*- encoding: utf-8 -*-
-
 # Trap interrupts to quit cleanly. See
 # https://twitter.com/mitchellh/status/283014103189053442
 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

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #
@@ -16,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/base64_stream.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #

data/lib/kitchen/cli.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #
@@ -16,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/collection.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #

data/lib/kitchen/color.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #

data/lib/kitchen/command.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #

data/lib/kitchen/command/action.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #
@@ -18,7 +17,7 @@
 
 require_relative "../command"
 
-require "benchmark"
+require "benchmark" unless defined?(Benchmark)
 
 module Kitchen
   module Command

data/lib/kitchen/command/console.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #

data/lib/kitchen/command/diagnose.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #
@@ -19,7 +18,7 @@
 require_relative "../command"
 require_relative "../diagnostic"
 
-require "yaml"
+require "yaml" unless defined?(YAML)
 
 module Kitchen
   module Command

data/lib/kitchen/command/doctor.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/kitchen/command/exec.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: SAWANOBORI Yukihiko (<sawanoboriyu@higanworks.com>)
 #

data/lib/kitchen/command/list.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #
@@ -17,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/login.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #

data/lib/kitchen/command/package.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/kitchen/command/sink.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #

data/lib/kitchen/command/test.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #
@@ -18,7 +17,7 @@
 
 require_relative "../command"
 
-require "benchmark"
+require "benchmark" unless defined?(Benchmark)
 
 module Kitchen
   module Command

data/lib/kitchen/config.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #

data/lib/kitchen/configurable.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #

data/lib/kitchen/data_munger.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #

data/lib/kitchen/diagnostic.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #

data/lib/kitchen/driver.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #

data/lib/kitchen/driver/base.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #
@@ -20,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
@@ -27,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
@@ -70,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/dummy.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #

data/lib/kitchen/driver/exec.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/kitchen/driver/proxy.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Seth Chisamore <schisamo@opscode.com>
 #

data/lib/kitchen/driver/ssh_base.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #
@@ -19,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
@@ -43,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
@@ -180,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/errors.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #

data/lib/kitchen/generator/init.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #

data/lib/kitchen/instance.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #
@@ -16,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
@@ -29,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
 
@@ -323,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.
     #
@@ -352,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
@@ -360,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
@@ -368,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.
@@ -542,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
@@ -553,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