test-kitchen 2.9.0 → 2.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58365d9f59d1210a1c8f56f7fe095f285fde61e6251c61b164569b783d75d6f8
-  data.tar.gz: ceef4069cb15be71c35992173d3d347717f8149dc3a7fe2f4863e5a8aaac98c5
+  metadata.gz: 51ed51940914e0c4ffb30d1e11be2e3554289833261e0b418eaa2ebdb674cab9
+  data.tar.gz: c3c9be7593e1c0c333102168228c84e217244c5071da0bfb2ba543edca7581ba
 SHA512:
-  metadata.gz: bf9e9206b2b78a39fa9fdeca2104e3cf17fed69821644f0055e7638e23a15f50dc11c9923718e5cb997d9a2ef416bbe2e48649fc6d6e7c02fd8627fbbe86f6b1
-  data.tar.gz: 86102634d2ad1b336cd5e18fdfe005ea7ef18f77e185351f041567aeb32b224609e457ca6904ea865bb18f278e836fdca4ae9afedff1877dd71564ed17d54d1b
+  metadata.gz: 59633a6df2c274542ee3d4c649c55f8632077a98476ee655a1f59c0b39d42fad9077294b0e615d8e7f697feef4cbb027a9df7be81708832760d45eee72fbf159
+  data.tar.gz: 34164cc7046bb2aa507fa33373c928d94be84284a99ba629562c585614c1818d032a42a1b2b83ab0b95382e984841be63a2dc32a05412dbf8d60a15839325146

data/lib/kitchen/cli.rb

@@ -162,7 +162,7 @@ module Kitchen
       long_desc <<-DESC
         The instance states are in order: destroy, create, converge, setup, verify, destroy.
         Change one or more instances from the current state to the #{action} state. Actions for all
-        intermediate states will be executed. See http://kitchen.ci for further explanation.
+        intermediate states will be executed. See https://kitchen.ci/ for further explanation.
       DESC
       method_option :concurrency,
         aliases: "-c",

data/lib/kitchen/config.rb

@@ -244,16 +244,18 @@ module Kitchen
     # @return [Instance] a new Instance object
     # @api private
     def new_instance(suite, platform, index)
+      sf = new_state_file(suite, platform)
+
       Instance.new(
         driver: new_driver(suite, platform),
-        lifecycle_hooks: new_lifecycle_hooks(suite, platform),
+        lifecycle_hooks: new_lifecycle_hooks(suite, platform, sf),
         logger: new_instance_logger(suite, platform, index),
         suite: suite,
         platform: platform,
         provisioner: new_provisioner(suite, platform),
         transport: new_transport(suite, platform),
         verifier: new_verifier(suite, platform),
-        state_file: new_state_file(suite, platform)
+        state_file: sf
       )
     end
 
@@ -284,11 +286,12 @@ module Kitchen
     #
     # @param suite [Suite,#name] a Suite
     # @param platform [Platform,#name] a Platform
+    # @param state_file [Kitchen::StateFile] a SateFile
     # @return [LifecycleHooks] a new LifecycleHooks object
     # @api private
-    def new_lifecycle_hooks(suite, platform)
+    def new_lifecycle_hooks(suite, platform, state_file)
       lhdata = data.lifecycle_hooks_data_for(suite.name, platform.name)
-      LifecycleHooks.new(lhdata)
+      LifecycleHooks.new(lhdata, state_file)
     end
 
     # Builds a newly configured Provisioner object, for a given Suite and

data/lib/kitchen/lifecycle_hook/base.rb

@@ -0,0 +1,78 @@
+module Kitchen
+  class LifecycleHook
+    class Base
+      # @return [Kitchen::LifecycleHooks]
+      attr_reader :lifecycle_hooks
+
+      # return [String]
+      attr_reader :phase
+
+      # return [Hash]
+      attr_reader :hook
+
+      # @param lifecycle_hooks [Kitchen::LifecycleHooks]
+      # @param phase [String]
+      # @param hook [Hash]
+      def initialize(lifecycle_hooks, phase, hook)
+        @lifecycle_hooks = lifecycle_hooks
+        @phase = phase
+        @hook = hook
+      end
+
+      # return [void]
+      def run
+        raise NotImplementedError
+      end
+
+      # @return [TrueClass, FalseClass]
+      def should_run?
+        if !includes.empty?
+          includes.include?(platform_name)
+        elsif !excludes.empty?
+          !excludes.include?(platform_name)
+        else
+          true
+        end
+      end
+
+      # @return [Logger] the lifecycle hooks's logger
+      #   otherwise
+      # @api private
+      def logger
+        lifecycle_hooks.send(:logger)
+      end
+
+      private
+
+      # @return [Kitchen::Instance]
+      def instance
+        lifecycle_hooks.instance
+      end
+
+      # @return [Hash]
+      def config
+        lifecycle_hooks.send(:config)
+      end
+
+      # @return [Kitchen::StateFile]
+      def state_file
+        lifecycle_hooks.state_file
+      end
+
+      # @return [Array<String>] names of excluded platforms
+      def excludes
+        @excludes ||= hook.fetch(:excludes, [])
+      end
+
+      # @return [Array<String>] names of only included platforms
+      def includes
+        @includes ||= hook.fetch(:includes, [])
+      end
+
+      # @return [String]
+      def platform_name
+        instance.platform.name
+      end
+    end
+  end
+end

data/lib/kitchen/lifecycle_hook/local.rb

@@ -0,0 +1,53 @@
+require_relative "base"
+require_relative "../shell_out"
+require_relative "../logging"
+
+module Kitchen
+  class LifecycleHook
+    class Local < Base
+      include ShellOut
+      include Logging
+
+      # Execute a specific local command hook.
+      #
+      # @return [void]
+      def run
+        state = state_file.read
+        # set up empty user variable
+        user = {}
+        # Set up some environment variables with instance info.
+        environment = {
+          "KITCHEN_INSTANCE_NAME" => instance.name,
+          "KITCHEN_SUITE_NAME" => instance.suite.name,
+          "KITCHEN_PLATFORM_NAME" => instance.platform.name,
+          "KITCHEN_INSTANCE_HOSTNAME" => state[:hostname].to_s,
+        }
+        # If the user specified env vars too, fix them up because symbol keys
+        # make mixlib-shellout sad.
+        hook[:environment]&.each do |k, v|
+          environment[k.to_s] = v.to_s
+        end
+
+        # add user to user hash for later merging
+        user[:user] = hook[:user] if hook[:user]
+
+        # Default the cwd to the kitchen root and resolve a relative input cwd against that.
+        cwd = if hook[:cwd]
+                File.expand_path(hook[:cwd], config[:kitchen_root])
+              else
+                config[:kitchen_root]
+              end
+        # Build the options for mixlib-shellout.
+        opts = {}.merge(user).merge(cwd: cwd, environment: environment)
+        run_command(command, opts)
+      end
+
+      private
+
+      # @return [String]
+      def command
+        hook.fetch(:local)
+      end
+    end
+  end
+end

data/lib/kitchen/lifecycle_hook/remote.rb

@@ -0,0 +1,33 @@
+require_relative "base"
+require_relative "../errors"
+
+module Kitchen
+  class LifecycleHook
+    class Remote < Base
+      # Execute a specific remote command hook.
+      #
+      # @return [void]
+      def run
+        # Check if we're in a state that makes sense to even try.
+        unless instance.last_action
+          if hook[:skippable]
+            # Just not even trying.
+            return
+          else
+            raise UserError, "Cannot use remote lifecycle hooks during phases when the instance is not available"
+          end
+        end
+
+        conn = instance.transport.connection(state_file.read)
+        conn.execute(command)
+      end
+
+      private
+
+      # return [String]
+      def command
+        hook.fetch(:remote)
+      end
+    end
+  end
+end

data/lib/kitchen/lifecycle_hooks.rb

@@ -15,8 +15,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require_relative "configurable"
 require_relative "errors"
-require_relative "shell_out"
+require_relative "lifecycle_hook/local"
+require_relative "lifecycle_hook/remote"
+require_relative "logging"
 
 module Kitchen
   # A helper object used by {Instance} to coordinate lifecycle hook calls from
@@ -27,10 +30,10 @@ module Kitchen
   class LifecycleHooks
     include Configurable
     include Logging
-    include ShellOut
 
-    def initialize(config)
+    def initialize(config, state_file)
       init_config(config)
+      @state_file = state_file
     end
 
     # Run a lifecycle phase with the pre and post hooks.
@@ -40,21 +43,22 @@ module Kitchen
     # @param block [Proc] Block of code implementing the lifecycle phase.
     # @return [void]
     def run_with_hooks(phase, state_file, &block)
-      run(instance, phase, state_file, :pre)
+      run(phase, :pre)
       yield
-      run(instance, phase, state_file, :post)
+      run(phase, :post)
     end
 
+    # @return [Kitchen::StateFile]
+    attr_reader :state_file
+
     private
 
     # Execute a specific lifecycle hook.
     #
-    # @param instance [Instance] The instance object to run against.
     # @param phase [String] Lifecycle phase which is being executed.
-    # @param state_file [StateFile] Instance state file object.
     # @param hook_timing [Symbol] `:pre` or `:post` to indicate which hook to run.
     # @return [void]
-    def run(instance, phase, state_file, hook_timing)
+    def run(phase, hook_timing)
       # Yes this has to be a symbol because of how data munger works.
       hook_key = :"#{hook_timing}_#{phase}"
       # No hooks? We're outta here.
@@ -65,80 +69,24 @@ module Kitchen
         # Coerce the common case of a bare string to be a local command. This
         # is to match the behavior of the old `pre_create_command` semi-hook.
         hook = { local: hook } if hook.is_a?(String)
-        if hook.include?(:local)
-          # Local command execution on the workstation.
-          run_local_hook(instance, state_file, hook)
-        elsif hook.include?(:remote)
-          # Remote command execution on the test instance.
-          run_remote_hook(instance, state_file, hook)
-        else
-          raise UserError, "Unknown lifecycle hook target #{hook.inspect}"
-        end
+        hook = generate_hook(phase, hook)
+        hook.run if hook.should_run?
       end
     end
 
-    # Execute a specific local command hook.
-    #
-    # @param instance [Instance] The instance object to run against.
-    # @param state_file [StateFile] Instance state file object.
-    # @param hook [Hash] Hook configration to use.
-    # @return [void]
-    def run_local_hook(instance, state_file, hook)
-      cmd = hook.fetch(:local)
-      state = state_file.read
-      # set up empty user variable
-      user = {}
-      # Set up some environment variables with instance info.
-      environment = {
-        "KITCHEN_INSTANCE_NAME" => instance.name,
-        "KITCHEN_SUITE_NAME" => instance.suite.name,
-        "KITCHEN_PLATFORM_NAME" => instance.platform.name,
-        "KITCHEN_INSTANCE_HOSTNAME" => state[:hostname].to_s,
-      }
-      # If the user specified env vars too, fix them up because symbol keys
-      # make mixlib-shellout sad.
-      if hook[:environment]
-        hook[:environment].each do |k, v|
-          environment[k.to_s] = v.to_s
-        end
-      end
-
-      # add user to user hash for later merging
-      if hook[:user]
-        user[:user] = hook[:user]
+    # @param phase [String]
+    # @param hook [Hash]
+    # @return [Kitchen::LifecycleHook::Local, Kitchen::LifecycleHook::Remote]
+    def generate_hook(phase, hook)
+      if hook.include?(:local)
+        # Local command execution on the workstation.
+        Kitchen::LifecycleHook::Local.new(self, phase, hook)
+      elsif hook.include?(:remote)
+        # Remote command execution on the test instance.
+        Kitchen::LifecycleHook::Remote.new(self, phase, hook)
+      else
+        raise UserError, "Unknown lifecycle hook target #{hook.inspect}"
       end
-
-      # Default the cwd to the kitchen root and resolve a relative input cwd against that.
-      cwd = if hook[:cwd]
-              File.expand_path(hook[:cwd], config[:kitchen_root])
-            else
-              config[:kitchen_root]
-            end
-      # Build the options for mixlib-shellout.
-      opts = {}.merge(user).merge(cwd: cwd, environment: environment)
-      run_command(cmd, opts)
-    end
-
-    # Execute a specific remote command hook.
-    #
-    # @param instance [Instance] The instance object to run against.
-    # @param state_file [StateFile] Instance state file object.
-    # @param hook [Hash] Hook configration to use.
-    # @return [void]
-    def run_remote_hook(instance, state_file, hook)
-      # Check if we're in a state that makes sense to even try.
-      unless instance.last_action
-        if hook[:skippable]
-          # Just not even trying.
-          return
-        else
-          raise UserError, "Cannot use remote lifecycle hooks during phases when the instance is not available"
-        end
-      end
-
-      cmd = hook.fetch(:remote)
-      conn = instance.transport.connection(state_file.read)
-      conn.execute(cmd)
     end
   end
 end

data/lib/kitchen/loader/yaml.rb

@@ -17,6 +17,7 @@
 
 require "erb" unless defined?(Erb)
 require_relative "../../vendor/hash_recursive_merge"
+require "psych" unless defined?(Psych)
 require "yaml" unless defined?(YAML)
 
 module Kitchen

data/lib/kitchen/provisioner/base.rb

@@ -51,6 +51,7 @@ module Kitchen
 
       default_config :command_prefix, nil
 
+      default_config :uploads, {}
       default_config :downloads, {}
 
       expand_path_for :test_base_path
@@ -72,6 +73,10 @@ module Kitchen
         sandbox_dirs = Util.list_directory(sandbox_path)
 
         instance.transport.connection(state) do |conn|
+          config[:uploads].to_h.each do |locals, remote|
+            debug("Uploading #{Array(locals).join(', ')} to #{remote}")
+            conn.upload(locals.to_s, remote)
+          end
           conn.execute(install_command)
           conn.execute(init_command)
           info("Transferring files to #{instance.to_str}")

data/lib/kitchen/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-kitchen
 version: !ruby/object:Gem::Version
-  version: 2.9.0
+  version: 2.10.0
 platform: ruby
 authors:
 - Fletcher Nichol
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-23 00:00:00.000000000 Z
+date: 2021-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mixlib-shellout
@@ -415,6 +415,9 @@ files:
 - lib/kitchen/generator/init.rb
 - lib/kitchen/instance.rb
 - lib/kitchen/lazy_hash.rb
+- lib/kitchen/lifecycle_hook/base.rb
+- lib/kitchen/lifecycle_hook/local.rb
+- lib/kitchen/lifecycle_hook/remote.rb
 - lib/kitchen/lifecycle_hooks.rb
 - lib/kitchen/loader/yaml.rb
 - lib/kitchen/logger.rb