test-kitchen 1.22.1 → 1.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a25f1efb06c17a12ffbdfdf5047e74b1fb784945e687848b1966da79e571b164
-  data.tar.gz: 58e429e9df4ecd71a335243a0580a0351aacff07d2ee1d1f9a05f0eb82a17554
+  metadata.gz: 885f8d3b08f1f4c860cd55c370cefc6f2b35e87dc2607ce9f6d60c39788bfd86
+  data.tar.gz: 352335dacee5a0ed1dbe5067d658bd2cd85bac1d0ec39c49a1283871c8604953
 SHA512:
-  metadata.gz: 35cf9c12e8bdc1eba84b38b50bcee1332cca0db9e5548bccf07f3bc0185d88afc40d75341baee5a3cba64e888bd011e2479206e9796eb6c4a5bbcf51b4aef66f
-  data.tar.gz: 58f2c081cb0ac675cde486c9455b01e25f7dd98d49122c86039c76bd62ea33603fc203c1d521b3698c684a0b7464c13ca5d70fcfea2bc2f2b78062fa938b4b30
+  metadata.gz: cc58bb9f82520bf0e616620a874d0452ac5ed0889cc7e28f0eb1aacfbb8e609436b65ff6f3f687044c3f896fc4846697cf96c78b8adee54816647c9a2f787373
+  data.tar.gz: '0909b191b4dc6c965ccf6e5afb59b67cff485035b049de9bea218c89f31753312ab970ca68217dc4c7f4eaa6b33ea814f67ce5a9cda3e31a0efa0a66bc2a3dd1'

data/CHANGELOG.md

@@ -1,12 +1,12 @@
 # Change Log
 
-## [v1.22.1](https://github.com/test-kitchen/test-kitchen/tree/v1.22.1) (2018-08-03)
-[Full Changelog](https://github.com/test-kitchen/test-kitchen/compare/v1.22.0...v1.22.1)
+## [v1.23.0](https://github.com/test-kitchen/test-kitchen/tree/v1.23.0) (2018-07-30)
+[Full Changelog](https://github.com/test-kitchen/test-kitchen/compare/v1.22.0...v1.23.0)
 
 **Merged pull requests:**
 
-- \[SHACK-295\] ChefDK 2.x uses an old version of net-ssh [\#1439](https://github.com/test-kitchen/test-kitchen/pull/1439) ([tyler-ball](https://github.com/tyler-ball))
-
+- Lifecycle hooks [\#1428](https://github.com/test-kitchen/test-kitchen/pull/1428) ([coderanger](https://github.com/coderanger))
+- Minor technical cleanup and unify behavior for files and directories. [\#1401](https://github.com/test-kitchen/test-kitchen/pull/1401) ([coderanger](https://github.com/coderanger))
 
 ## [v1.22.0](https://github.com/test-kitchen/test-kitchen/tree/v1.22.0) (2018-06-28)
 [Full Changelog](https://github.com/test-kitchen/test-kitchen/compare/v1.21.2...v1.22.0)
@@ -21,23 +21,14 @@
 - Removing thor upper bound in step with berks [\#1410](https://github.com/test-kitchen/test-kitchen/pull/1410) ([cheeseplus](https://github.com/cheeseplus)
 )
 
-
 ## [v1.21.1](https://github.com/test-kitchen/test-kitchen/tree/v1.21.1) (2018-04-18)
 [Full Changelog](https://github.com/test-kitchen/test-kitchen/compare/v1.21.0...v1.21.1)
 
-
 - Revert: honor root\_path for location of chef installer script [\#1369]
 
 ## [v1.21.0](https://github.com/test-kitchen/test-kitchen/tree/v1.21.0) (2018-04-16)
 [Full Changelog](https://github.com/test-kitchen/test-kitchen/compare/v1.20.0...v1.21.0)
 
-**Release Notes:**
-
-### Configuration UX improvements
-
-Having the kitchen configuration file be hidden has always been a bit odd and so we're moving to using `kitchen.yml` over `.kitchen.yml`.
-This also applies to `kitchen.local.yml` and we've made the change backwards compatible so you're not forced to move over right away. Additionally, we've added support for the environment variables `KITCHEN_YML` and KITCHEN_LOCAL_YML` again preserving compatibility if you're using the `*_YAML` forms.
-
 **Merged pull requests:**
 
 - Support `\*\_YML` for env vars too, for better UX [\#1398](https://github.com/test-kitchen/test-kitchen/pull/1398) ([coderanger](https://github.com/coderanger))
@@ -57,58 +48,6 @@ This also applies to `kitchen.local.yml` and we've made the change backwards com
 ## [v1.20.0](https://github.com/test-kitchen/test-kitchen/tree/v1.20.0) (2018-01-19)
 [Full Changelog](https://github.com/test-kitchen/test-kitchen/compare/v1.19.2...v1.20.0)
 
-**Release Notes:**
-
-#### Multiple paths for data_bags
-
-Allows a user to use data_bags from an array of directories
-
-```
-data_bags_path:
-  - 'data_bags'
-  - 'test/integrations/data_bags'
-  ```
-
-#### Deprecation Warnings for Configuration Keys
-
-```
-$ kitchen list default-centos-7
-$$$$$$ Deprecated configuration detected:
-require_chef_omnibus
-Run 'kitchen doctor' for details.
-```
-
-```
-$ kitchen doctor
-$$$$$$ Deprecated configuration detected:
-require_chef_omnibus
-Run 'kitchen doctor' for details.
-
------> The doctor is in
-       **** require_chef_omnibus deprecated
-The 'require_chef_omnibus' attribute with version values will change
-to use the new 'product_version' attribute.
-
-Note: 'product_name' must be set in order to use 'product_version'
-until 'product_name' replaces 'require_chef_omnibus' as the default.
-
-# New Usage #
-provisioner:
-  product_name: <chef or chefdk>
-  product_version: 12.0.3
-```
-
-#### SSH via an HTTP Proxy
-
-This allows configuring the SSH transport to utilize an HTTP Proxy. The following configuration keys have been added to `transport`:
-
-```
-ssh_http_proxy_user
-ssh_http_proxy_password
-ssh_http_proxy_port
-ssh_http_proxy
-```
-
 **Merged pull requests:**
 
 - Support multiple paths for data bags [\#1313](https://github.com/test-kitchen/test-kitchen/pull/1313) ([thomasdziedzic](https://github.com/thomasdziedzic))
@@ -141,50 +80,6 @@ Removed an extraneous bash shebang that caused the script generated to install c
 ## [v1.19.0](https://github.com/test-kitchen/test-kitchen/tree/v1.19.0) (2017-11-1)
 [Full Changelog](https://github.com/test-kitchen/test-kitchen/compare/v1.18.0...v1.19.0)
 
-**Release Notes:**
-
-#### Driver Commands Removed
-
-The `kitchen driver` family of commands have been removed. It was not recommended
-to use them and it was judged to be more harm than good to leave them in. If you
-regularly create new drivers and relied on the skeleton generator, check out
-other code skeleton projects like [`chef generate`](https://blog.chef.io/2014/12/09/guest-post-creating-your-own-chef-cookbook-generator/),
-and [Cookiecutter](https://github.com/audreyr/cookiecutter).
-
-#### `kitchen converge -D`
-
-When you want to get debug logging for your provisioner or verifier, you can now
-use the new `-D` (or `--debug`) command line option for `kitchen converge`,
-`kitchen verify`, and `kitchen test`. Support has been added to the Chef provisioners,
-avoiding the need to use the `log_level: debug` configuration option every time.
-
-#### `exec` Driver
-
-A new driver named `exec` is included with Test Kitchen which runs all the
-provisioning and verification commands locally, rather than on a VM. This can
-be used for testing on systems where you've already created the VM yourself and
-installed Test Kitchen on it. Note that this is related but different from the
-included `proxy` driver, which also connects to an existing server, but over
-SSH/WinRM rather than running commands locally.
-
-#### `shell` Provisioner `command`
-
-Previously the included `shell` provisioner allowed running a user-specified bootstrap
-script. This has been extended to allow specifying a `command` option with a
-string to run, rather than managing a script file.
-
-#### Faster Busser
-
-The `busser` verifier has been improved to be faster on the second (or beyond)
-verification, or in other cases where the required gems are already present.
-
-#### `kitchen doctor`
-
-A `kitchen doctor` command has been added, modeled on Homebrew's `brew doctor`.
-This currently doesn't do much, but if you are a Kitchen plugin author, consider
-adding more detailed debugging checks and troubleshooting help to your plugin
-via this system.
-
 **Merged pull requests**
 
 - Basic framework for kitchen doctor [\#1301](https://github.com/test-kitchen/test-kitchen/pull/1301) ([coderanger](https://github.com/coderanger))
@@ -224,7 +119,6 @@ via this system.
 - New install\_strategy option used in conjunction with product\_name [\#1262](https://github.com/test-kitchen/test-kitchen/pull/1262) ([wrightp](https://github.com/wrightp))
 - Allow command line arguments config in shell provisioner [\#943](https://github.com/test-kitchen/test-kitchen/pull/943) ([mmckinst](https://github.com/mmckinst))
 
-
 ## [v1.17.0](https://github.com/test-kitchen/test-kitchen/tree/v1.17.0) (2017-08-11)
 [Full Changelog](https://github.com/test-kitchen/test-kitchen/compare/v1.16.0...v1.17.0)
 

data/RELEASE_NOTES.md

@@ -0,0 +1,167 @@
+# Test Kitchen 1.23.0 Release Notes
+
+## Life Cycle Hooks
+
+The life cycle hooks system allows running commands before or after any phase
+of Test Kitchen (`create`, `converge`, `verify`, or `destroy`). Commands can be
+run either locally on your workstation (the default) or remotely on the test instance.
+
+These hooks are configured under a new `lifecycle:` section in `kitchen.yml`:
+
+```yaml
+lifecycle:
+  pre_create: echo before
+  post_create:
+  - echo after
+  - local: echo also after
+  - remote: echo after but in the instance
+```
+
+You can also configure hooks on a single platform or suite:
+
+```yaml
+platforms:
+- name: ubuntu-18.04
+  lifecycle:
+    pre_converge:
+    - remote: apt update
+
+suites:
+- name: default
+  lifecycle:
+    post_verify:
+    - my_coverage_formatter
+```
+
+Local commands automatically get some environment variables with information
+about which instance the hook is evaluating against:
+
+* `KITCHEN_INSTANCE_NAME` - The full name of the instance
+* `KITCHEN_SUITE_NAME` - The name of the suite of the instance
+* `KITCHEN_PLATFORM_NAME` - The name of the platform of the instance
+* `KITCHEN_INSTANCE_HOSTNAME` - The hostname of the instance as reported by the driver plugin
+
+You can also pass additional configuration for local commands:
+
+```yaml
+lifecycle:
+  pre_converge:
+  - local: ./setup.sh
+    environment:
+      API_KEY: asdf1234
+    timeout: 60
+```
+
+Remote commands are normally not allowed during `pre_create` or `post_destroy`
+hooks as there is generally no instance running at that point, but with `pre_destroy`
+hooks you may want to use the `skippable` flag so as to not fail during `kitchen test`:
+
+```yaml
+lifecycle:
+  pre_destroy:
+  - remote: myapp --unregister-license
+    skippable: true
+```
+
+# Test Kitchen 1.21.0 Release Notes
+
+## Configuration UX improvements
+
+Having the kitchen configuration file be hidden has always been a bit odd and so we're moving to using `kitchen.yml` over `.kitchen.yml`.
+This also applies to `kitchen.local.yml` and we've made the change backwards compatible so you're not forced to move over right away. Additionally, we've added support for the environment variables `KITCHEN_YML` and KITCHEN_LOCAL_YML` again preserving compatibility if you're using the `*_YAML` forms.
+
+# Test Kitchen 1.20.0 Release Notes
+
+## Multiple paths for data_bags
+
+Allows a user to use data_bags from an array of directories
+
+```
+data_bags_path: 
+  - 'data_bags'
+  - 'test/integrations/data_bags'
+  ```
+
+## Deprecation Warnings for Configuration Keys
+
+```
+$ kitchen list default-centos-7
+$$$$$$ Deprecated configuration detected:
+require_chef_omnibus
+Run 'kitchen doctor' for details.
+```
+
+```
+$ kitchen doctor
+$$$$$$ Deprecated configuration detected:
+require_chef_omnibus
+Run 'kitchen doctor' for details.
+
+-----> The doctor is in
+       **** require_chef_omnibus deprecated
+The 'require_chef_omnibus' attribute with version values will change
+to use the new 'product_version' attribute.
+
+Note: 'product_name' must be set in order to use 'product_version'
+until 'product_name' replaces 'require_chef_omnibus' as the default.
+
+# New Usage #
+provisioner:
+  product_name: <chef or chefdk>
+  product_version: 12.0.3
+```
+
+## SSH via an HTTP Proxy
+
+This allows configuring the SSH transport to utilize an HTTP Proxy. The following configuration keys have been added to `transport`:
+
+```
+ssh_http_proxy_user
+ssh_http_proxy_password
+ssh_http_proxy_port
+ssh_http_proxy
+```
+
+# Test Kitchen 1.20.0 Release Notes
+
+## Driver Commands Removed
+
+The `kitchen driver` family of commands have been removed. It was not recommended
+to use them and it was judged to be more harm than good to leave them in. If you
+regularly create new drivers and relied on the skeleton generator, check out
+other code skeleton projects like [`chef generate`](https://blog.chef.io/2014/12/09/guest-post-creating-your-own-chef-cookbook-generator/),
+and [Cookiecutter](https://github.com/audreyr/cookiecutter).
+
+## `kitchen converge -D`
+
+When you want to get debug logging for your provisioner or verifier, you can now
+use the new `-D` (or `--debug`) command line option for `kitchen converge`,
+`kitchen verify`, and `kitchen test`. Support has been added to the Chef provisioners,
+avoiding the need to use the `log_level: debug` configuration option every time.
+
+## `exec` Driver
+
+A new driver named `exec` is included with Test Kitchen which runs all the
+provisioning and verification commands locally, rather than on a VM. This can
+be used for testing on systems where you've already created the VM yourself and
+installed Test Kitchen on it. Note that this is related but different from the
+included `proxy` driver, which also connects to an existing server, but over
+SSH/WinRM rather than running commands locally.
+
+## `shell` Provisioner `command`
+
+Previously the included `shell` provisioner allowed running a user-specified bootstrap
+script. This has been extended to allow specifying a `command` option with a
+string to run, rather than managing a script file.
+
+## Faster Busser
+
+The `busser` verifier has been improved to be faster on the second (or beyond)
+verification, or in other cases where the required gems are already present.
+
+## `kitchen doctor`
+
+A `kitchen doctor` command has been added, modeled on Homebrew's `brew doctor`.
+This currently doesn't do much, but if you are a Kitchen plugin author, consider
+adding more detailed debugging checks and troubleshooting help to your plugin
+via this system.

data/lib/kitchen.rb

@@ -37,6 +37,7 @@ require "kitchen/driver/base"
 require "kitchen/driver/ssh_base"
 require "kitchen/driver/proxy"
 require "kitchen/instance"
+require "kitchen/lifecycle_hooks"
 require "kitchen/transport"
 require "kitchen/transport/base"
 require "kitchen/loader/yaml"

data/lib/kitchen/config.rb

@@ -245,6 +245,7 @@ module Kitchen
     def new_instance(suite, platform, index)
       Instance.new(
         driver: new_driver(suite, platform),
+        lifecycle_hooks: new_lifecycle_hooks(suite, platform),
         logger: new_instance_logger(suite, platform, index),
         suite: suite,
         platform: platform,
@@ -277,6 +278,18 @@ module Kitchen
       )
     end
 
+    # Builds a newly configured LifecycleHooks object, for a given a Suite and
+    # Platform.
+    #
+    # @param suite [Suite,#name] a Suite
+    # @param platform [Platform,#name] a Platform
+    # @return [LifecycleHooks] a new LifecycleHooks object
+    # @api private
+    def new_lifecycle_hooks(suite, platform)
+      lhdata = data.lifecycle_hooks_data_for(suite.name, platform.name)
+      LifecycleHooks.new(lhdata)
+    end
+
     # Builds a newly configured Provisioner object, for a given Suite and
     # Platform.
     #

data/lib/kitchen/data_munger.rb

@@ -45,6 +45,7 @@ module Kitchen
       convert_legacy_busser_format!
       convert_legacy_driver_http_proxy_format!
       move_chef_data_to_provisioner!
+      convert_legacy_pre_create_command!
     end
 
     # Generate a new Hash of configuration data that can be used to construct
@@ -62,6 +63,25 @@ module Kitchen
       end
     end
 
+    # Generate a new Hash of configuration data that can be used to construct
+    # a new LifecycleHooks object.
+    #
+    # @param suite [String] a suite name
+    # @param platform [String] a platform name
+    # @return [Hash] a new configuration Hash that can be used to construct a
+    #   new LifecycleHooks
+    def lifecycle_hooks_data_for(suite, platform)
+      merged_data_for(:lifecycle, suite, platform).tap do |lhdata|
+        lhdata.each_key do |k|
+          combine_arrays!(lhdata, k, :common, :platform, :suite)
+        end
+        set_kitchen_config_at!(lhdata, :kitchen_root)
+        set_kitchen_config_at!(lhdata, :test_base_path)
+        set_kitchen_config_at!(lhdata, :log_level)
+        set_kitchen_config_at!(lhdata, :debug)
+      end
+    end
+
     # Returns an Array of platform Hashes.
     #
     # @return [Array<Hash>] an Array of Hashes
@@ -591,6 +611,27 @@ module Kitchen
       end
     end
 
+    def convert_legacy_pre_create_command!
+      convert_legacy_pre_create_command_at!(data)
+      data.fetch(:platforms, []).each do |platform|
+        convert_legacy_pre_create_command_at!(platform)
+      end
+      data.fetch(:suites, []).each do |suite|
+        convert_legacy_pre_create_command_at!(suite)
+      end
+    end
+
+    def convert_legacy_pre_create_command_at!(root)
+      ddata = root[:driver] || {}
+      if ddata.is_a?(Hash) && ddata.include?(:pre_create_command)
+        root[:lifecycle] ||= {}
+        root[:lifecycle][:pre_create] ||= []
+        root[:lifecycle][:pre_create] = Array(root[:lifecycle][:pre_create])
+        root[:lifecycle][:pre_create] << { local: ddata[:pre_create_command] }
+        ddata.delete(:pre_create_command)
+      end
+    end
+
     # Performs a prioritized recursive merge of several source Hashes and
     # returns a new merged Hash. For these data sub-hash structures, there are
     # 4 sources for configuration data:
@@ -758,6 +799,12 @@ module Kitchen
       cdata = data.fetch(key, {})
       cdata = cdata.nil? ? {} : cdata.dup
       cdata = { default_key => cdata } if cdata.is_a?(String)
+      case key
+      when :lifecycle
+        cdata.each_key do |k|
+          namespace_array!(cdata, k, :common)
+        end
+      end
       cdata
     end
 
@@ -856,7 +903,14 @@ module Kitchen
       pdata = platform_data_for(platform).fetch(key, {})
       pdata = pdata.nil? ? {} : pdata.dup
       pdata = { default_key => pdata } if pdata.is_a?(String)
-      namespace_array!(pdata, :run_list, :platform)
+      case key
+      when :provisioner
+        namespace_array!(pdata, :run_list, :platform)
+      when :lifecycle
+        pdata.each_key do |k|
+          namespace_array!(pdata, k, :platform)
+        end
+      end
       pdata
     end
 
@@ -911,7 +965,14 @@ module Kitchen
       sdata = suite_data_for(suite).fetch(key, {})
       sdata = sdata.nil? ? {} : sdata.dup
       sdata = { default_key => sdata } if sdata.is_a?(String)
-      namespace_array!(sdata, :run_list, :suite)
+      case key
+      when :provisioner
+        namespace_array!(sdata, :run_list, :suite)
+      when :lifecycle
+        sdata.each_key do |k|
+          namespace_array!(sdata, k, :suite)
+        end
+      end
       sdata
     end
 

data/lib/kitchen/generator/init.rb

@@ -18,7 +18,6 @@
 
 require "rubygems/gem_runner"
 require "thor/group"
-require "kitchen"
 
 module Kitchen
   module Generator

data/lib/kitchen/instance.rb

@@ -56,6 +56,9 @@ module Kitchen
     #   lifecycle actions
     attr_accessor :driver
 
+    # @return [LifecycleHooks] lifecycle hooks manager object
+    attr_accessor :lifecycle_hooks
+
     # @return [Provisioner::Base] provisioner object which will the setup
     #   and invocation instructions for configuration management and other
     #   automation tools
@@ -90,20 +93,22 @@ module Kitchen
     def initialize(options = {})
       validate_options(options)
 
-      @suite        = options.fetch(:suite)
-      @platform     = options.fetch(:platform)
-      @name         = self.class.name_for(@suite, @platform)
-      @driver       = options.fetch(:driver)
-      @provisioner  = options.fetch(:provisioner)
-      @transport    = options.fetch(:transport)
-      @verifier     = options.fetch(:verifier)
-      @logger       = options.fetch(:logger) { Kitchen.logger }
-      @state_file   = options.fetch(:state_file)
+      @suite           = options.fetch(:suite)
+      @platform        = options.fetch(:platform)
+      @name            = self.class.name_for(@suite, @platform)
+      @driver          = options.fetch(:driver)
+      @lifecycle_hooks = options.fetch(:lifecycle_hooks)
+      @provisioner     = options.fetch(:provisioner)
+      @transport       = options.fetch(:transport)
+      @verifier        = options.fetch(:verifier)
+      @logger          = options.fetch(:logger) { Kitchen.logger }
+      @state_file      = options.fetch(:state_file)
 
       setup_driver
       setup_provisioner
       setup_transport
       setup_verifier
+      setup_lifecycle_hooks
     end
 
     # Returns a displayable representation of the instance.
@@ -333,6 +338,14 @@ module Kitchen
       end
     end
 
+    # Perform any final configuration or preparation needed for the lifecycle hooks
+    # object carry out its duties.
+    #
+    # @api private
+    def setup_lifecycle_hooks
+      lifecycle_hooks.finalize_config!(self)
+    end
+
     # Perform any final configuration or preparation needed for the provisioner
     # object carry out its duties.
     #
@@ -365,7 +378,9 @@ module Kitchen
     def transition_to(desired)
       result = nil
       FSM.actions(last_action, desired).each do |transition|
-        result = send("#{transition}_action")
+        @lifecycle_hooks.run_with_hooks(transition, state_file) do
+          result = send("#{transition}_action")
+        end
       end
       result
     end

data/lib/kitchen/lifecycle_hooks.rb

@@ -0,0 +1,135 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Noah Kantrowitz <noah@coderanger.net>
+#
+# Copyright (C) 2018, Noah Kantrowitz
+#
+# 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.
+
+require "kitchen/errors"
+require "kitchen/shell_out"
+
+module Kitchen
+  # A helper object used by {Instance} to coordinate lifecycle hook calls from
+  # the `lifecycle:` configuration section.
+  #
+  # @api internal
+  # @since 1.22
+  class LifecycleHooks
+    include Configurable
+    include Logging
+    include ShellOut
+
+    def initialize(config)
+      init_config(config)
+    end
+
+    # Run a lifecycle phase with the pre and post hooks.
+    #
+    # @param phase [String] Lifecycle phase which is being executed.
+    # @param state_file [StateFile] Instance state file object.
+    # @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)
+      yield
+      run(instance, phase, state_file, :post)
+    end
+
+    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)
+      # Yes this has to be a symbol because of how data munger works.
+      hook_key = :"#{hook_timing}_#{phase}"
+      # No hooks? We're outta here.
+      hook_data = Array(config[hook_key])
+      return if hook_data.empty?
+      hook_data.each do |hook|
+        # 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
+      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.delete(:local)
+      state = state_file.read
+      # 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
+      # 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(hook).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.delete(:remote)
+      conn = instance.transport.connection(state_file.read)
+      conn.execute(cmd)
+    end
+  end
+end

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

@@ -234,14 +234,10 @@ module Kitchen
           case opts[:type]
           when :directory
             FileUtils.mkdir_p(dest)
-            if src.kind_of?(Array)
-              src.each { |x| FileUtils.cp_r(Util.list_directory(x), dest) }
-            else
-              FileUtils.cp_r(Util.list_directory(src), dest)
-            end
+            Array(src).each { |dir| FileUtils.cp_r(Util.list_directory(dir), dest) }
           when :file
             FileUtils.mkdir_p(File.dirname(dest))
-            FileUtils.cp_r(src, dest)
+            Array(src).each { |file| FileUtils.cp_r(file, dest) }
           end
         end
 

data/lib/kitchen/transport/ssh.rb

@@ -517,17 +517,13 @@ module Kitchen
       # net-ssh to ~> 4.2, this will prevent InSpec from being used in
       # Chef v12 because of it pinning to a v3 of net-ssh.
       #
-      def self.verify_host_key_option
+      def verify_host_key_option
         current_net_ssh = Net::SSH::Version::CURRENT
         new_option_version = Net::SSH::Version[4, 2, 0]
 
         current_net_ssh >= new_option_version ? :verify_host_key : :paranoid
       end
 
-      def verify_host_key_option
-        self.class.verify_host_key_option
-      end
-
       # Creates a new SSH Connection instance and save it for potential future
       # reuse.
       #

data/lib/kitchen/version.rb

@@ -17,5 +17,5 @@
 # limitations under the License.
 
 module Kitchen
-  VERSION = "1.22.1".freeze
+  VERSION = "1.23.0".freeze
 end

data/spec/kitchen/config_spec.rb

@@ -295,6 +295,7 @@ describe Kitchen::Config do
     let(:munger) do
       stub(
         driver_data_for: { "junk" => true },
+        lifecycle_hooks_data_for: { "junk" => true },
         provisioner_data_for: { "junk" => true },
         transport_data_for: { "junk" => true },
         verifier_data_for: { "junk" => true }
@@ -309,6 +310,7 @@ describe Kitchen::Config do
       Kitchen::Verifier.stubs(:for_plugin).returns("verifier")
       Kitchen::Logger.stubs(:new).returns("logger")
       Kitchen::StateFile.stubs(:new).returns("state_file")
+      Kitchen::LifecycleHooks.stubs(:new).returns("lifecycle_hooks")
 
       Kitchen::DataMunger.stubs(:new).returns(munger)
       config.stubs(:platforms).returns(platforms)
@@ -384,6 +386,7 @@ describe Kitchen::Config do
         driver: "driver",
         logger: "logger",
         suite: suites.first,
+        lifecycle_hooks: "lifecycle_hooks",
         platform: platforms.first,
         provisioner: "provisioner",
         transport: "transport",

data/spec/kitchen/data_munger_spec.rb

@@ -2689,5 +2689,112 @@ module Kitchen # rubocop:disable Metrics/ModuleLength
         end
       end
     end
+
+    describe "lifecycle_hooks stuff" do
+      it "handles a single global hook" do
+        DataMunger.new(
+          {
+            lifecycle: {
+              pre_create: "echo foo"
+            },
+            platforms: [{ name: "plat" }],
+            suites: [{ name: "sweet" }],
+          },
+          {}
+        ).lifecycle_hooks_data_for("sweet", "plat").must_equal(
+          pre_create: ["echo foo"]
+        )
+      end
+
+      it "handles multiple global hooks" do
+        DataMunger.new(
+          {
+            lifecycle: {
+              pre_create: "echo foo",
+              post_converge: ["echo bar", { local: "echo baz" }],
+              pre_verify: [{ remote: "echo other" }],
+            },
+            platforms: [{ name: "plat" }],
+            suites: [{ name: "sweet" }],
+          },
+          {}
+        ).lifecycle_hooks_data_for("sweet", "plat").must_equal(
+          pre_create: ["echo foo"],
+          post_converge: ["echo bar", { local: "echo baz" }],
+          pre_verify: [{ remote: "echo other" }]
+        )
+      end
+
+      it "handles hooks in platforms and suites" do
+        DataMunger.new(
+          {
+            lifecycle: {
+              pre_create: "echo foo",
+              post_create: "echo post"
+            },
+            platforms: [{
+              name: "plat",
+              lifecycle: {
+                pre_create: "echo bar"
+              }
+            }],
+            suites: [{
+              name: "sweet",
+              lifecycle: {
+                pre_create: "echo baz"
+              }
+            }],
+          },
+          {}
+        ).lifecycle_hooks_data_for("sweet", "plat").must_equal(
+          pre_create: ["echo foo", "echo bar", "echo baz"],
+          post_create: ["echo post"]
+        )
+      end
+
+      it "munges a global legacy pre_create_command" do
+        DataMunger.new(
+          {
+            driver: {
+              pre_create_command: "echo bar"
+            },
+            lifecycle: {
+              pre_create: "echo foo"
+            },
+            platforms: [{ name: "plat" }],
+            suites: [{ name: "sweet" }],
+          },
+          {}
+        ).lifecycle_hooks_data_for("sweet", "plat").must_equal(
+          pre_create: ["echo foo", { local: "echo bar" }]
+        )
+      end
+
+      it "munges a platform/suite legacy pre_create_commands" do
+        DataMunger.new(
+          {
+            lifecycle: {
+              pre_create: "echo foo"
+            },
+            platforms: [{
+              name: "plat",
+              driver: {
+                pre_create_command: "echo bar"
+              }
+            }],
+            suites: [{
+              name: "sweet",
+              driver: {
+                pre_create_command: "echo baz"
+              }
+            }],
+          },
+          {}
+        ).lifecycle_hooks_data_for("sweet", "plat").must_equal(
+          pre_create: ["echo foo", { local: "echo bar" }, { local: "echo baz" }]
+        )
+      end
+
+    end
   end
 end

data/spec/kitchen/instance_spec.rb

@@ -95,17 +95,18 @@ class LegacyDriver < Kitchen::Driver::SSHBase
 end
 
 describe Kitchen::Instance do
-  let(:driver)      { Kitchen::Driver::Dummy.new({}) }
-  let(:logger_io)   { StringIO.new }
-  let(:logger)      { Kitchen::Logger.new(logdev: logger_io) }
-  let(:instance)    { Kitchen::Instance.new(opts) }
-  let(:provisioner) { Kitchen::Provisioner::Dummy.new({}) }
-  let(:state_file)  { DummyStateFile.new }
-  let(:transport)   { Kitchen::Transport::Dummy.new({}) }
-  let(:verifier)    { Kitchen::Verifier::Dummy.new({}) }
+  let(:driver)          { Kitchen::Driver::Dummy.new({}) }
+  let(:logger_io)       { StringIO.new }
+  let(:logger)          { Kitchen::Logger.new(logdev: logger_io) }
+  let(:instance)        { Kitchen::Instance.new(opts) }
+  let(:lifecycle_hooks) { Kitchen::LifecycleHooks.new({}) }
+  let(:provisioner)     { Kitchen::Provisioner::Dummy.new({}) }
+  let(:state_file)      { DummyStateFile.new }
+  let(:transport)       { Kitchen::Transport::Dummy.new({}) }
+  let(:verifier)        { Kitchen::Verifier::Dummy.new({}) }
 
   let(:opts) do
-    { suite: suite, platform: platform, driver: driver,
+    { suite: suite, platform: platform, driver: driver, lifecycle_hooks: lifecycle_hooks,
       provisioner: provisioner, verifier: verifier,
       logger: logger, state_file: state_file, transport: transport }
   end
@@ -477,6 +478,13 @@ describe Kitchen::Instance do
           logger_io.string
                    .must_match regex_for("Finished creating #{instance.to_str}")
         end
+
+        it "calls lifecycle hooks" do
+          lifecycle_hooks.expects(:run).with(instance, :create, state_file, :pre)
+          lifecycle_hooks.expects(:run).with(instance, :create, state_file, :post)
+
+          instance.create
+        end
       end
 
       describe "with last_action of create" do
@@ -525,6 +533,15 @@ describe Kitchen::Instance do
           logger_io.string
                    .must_match regex_for("Finished converging #{instance.to_str}")
         end
+
+        it "calls lifecycle hooks" do
+          lifecycle_hooks.expects(:run).with(instance, :create, state_file, :pre)
+          lifecycle_hooks.expects(:run).with(instance, :create, state_file, :post)
+          lifecycle_hooks.expects(:run).with(instance, :converge, state_file, :pre)
+          lifecycle_hooks.expects(:run).with(instance, :converge, state_file, :post)
+
+          instance.converge
+        end
       end
 
       describe "with last action of create" do
@@ -542,6 +559,13 @@ describe Kitchen::Instance do
 
           state_file.read[:last_action].must_equal "converge"
         end
+
+        it "calls lifecycle hooks" do
+          lifecycle_hooks.expects(:run).with(instance, :converge, state_file, :pre)
+          lifecycle_hooks.expects(:run).with(instance, :converge, state_file, :post)
+
+          instance.converge
+        end
       end
 
       describe "with last action of converge" do

data/spec/kitchen/lifecycle_hooks_spec.rb

@@ -0,0 +1,171 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Noah Kantrowitz <noah@coderanger.net>
+#
+# Copyright (C) 2018, Noah Kantrowitz
+#
+# 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.
+
+require_relative "../spec_helper"
+
+require "kitchen/errors"
+require "kitchen/lifecycle_hooks"
+
+describe Kitchen::LifecycleHooks do
+  let(:suite) { mock("suite").tap { |i| i.stubs(name: "default") } }
+  let(:platform) { mock("platform").tap { |i| i.stubs(name: "toaster-1.0") } }
+  let(:state_file) { mock("state_file").tap { |s| s.stubs(read: { hostname: "localhost" }) } }
+  let(:connection) { mock("connection") }
+  let(:transport) { mock("transport").tap { |t| t.stubs(:connection).with({ hostname: "localhost" }).returns(connection) } }
+  let(:last_action) { :create }
+  let(:instance) { mock("instance").tap { |i| i.stubs(name: "default-toaster-10", transport: transport, last_action: last_action, suite: suite, platform: platform) } }
+  let(:config) { { kitchen_root: "/kitchen" } }
+  let(:lifecycle_hooks) { Kitchen::LifecycleHooks.new(config).tap { |lh| lh.finalize_config!(instance) } }
+
+  def run_lifecycle_hooks
+    lifecycle_hooks.run_with_hooks(:create, state_file) {}
+  end
+
+  # Pull this out because it's used in a bunch of tests.
+  STANDARD_LOCAL_OPTIONS = {
+    cwd: "/kitchen",
+    environment: {
+      "KITCHEN_INSTANCE_NAME" => "default-toaster-10",
+      "KITCHEN_SUITE_NAME" => "default",
+      "KITCHEN_PLATFORM_NAME" => "toaster-1.0",
+      "KITCHEN_INSTANCE_HOSTNAME" => "localhost",
+    }
+  }
+
+  it "runs a single local command" do
+    config.update(post_create: ["echo foo"])
+    lifecycle_hooks.expects(:run_command).with("echo foo", STANDARD_LOCAL_OPTIONS)
+    run_lifecycle_hooks
+  end
+
+  it "runs multiple local commands" do
+    config.update(post_create: ["echo foo", { local: "echo bar" }])
+    lifecycle_hooks.expects(:run_command).with("echo foo", STANDARD_LOCAL_OPTIONS)
+    lifecycle_hooks.expects(:run_command).with("echo bar", STANDARD_LOCAL_OPTIONS)
+    run_lifecycle_hooks
+  end
+
+  it "runs multiple local hooks" do
+    config.update(pre_create: ["echo foo"], post_create: ["echo bar"])
+    lifecycle_hooks.expects(:run_command).with("echo foo", STANDARD_LOCAL_OPTIONS)
+    lifecycle_hooks.expects(:run_command).with("echo bar", STANDARD_LOCAL_OPTIONS)
+    run_lifecycle_hooks
+  end
+
+  it "runs a local command with a user option" do
+    config.update(post_create: [{ local: "echo foo", user: "bar" }])
+    lifecycle_hooks.expects(:run_command).with("echo foo", {
+      cwd: "/kitchen",
+      user: "bar",
+      environment: {
+        "KITCHEN_INSTANCE_NAME" => "default-toaster-10",
+        "KITCHEN_SUITE_NAME" => "default",
+        "KITCHEN_PLATFORM_NAME" => "toaster-1.0",
+        "KITCHEN_INSTANCE_HOSTNAME" => "localhost",
+      }
+    })
+    run_lifecycle_hooks
+  end
+
+  it "runs a local command with environment options" do
+    config.update(post_create: [{ local: "echo foo", environment: { FOO: "one", BAR: "two" } }])
+    lifecycle_hooks.expects(:run_command).with("echo foo", {
+      cwd: "/kitchen",
+      environment: {
+        "FOO" => "one",
+        "BAR" => "two",
+        "KITCHEN_INSTANCE_NAME" => "default-toaster-10",
+        "KITCHEN_SUITE_NAME" => "default",
+        "KITCHEN_PLATFORM_NAME" => "toaster-1.0",
+        "KITCHEN_INSTANCE_HOSTNAME" => "localhost",
+      }
+    })
+    run_lifecycle_hooks
+  end
+
+  it "runs a local command with a relative cwd option" do
+    config.update(post_create: [{ local: "echo foo", cwd: "test" }])
+    lifecycle_hooks.expects(:run_command).with("echo foo", {
+      cwd: os_safe_root_path("/kitchen/test"),
+      environment: {
+        "KITCHEN_INSTANCE_NAME" => "default-toaster-10",
+        "KITCHEN_SUITE_NAME" => "default",
+        "KITCHEN_PLATFORM_NAME" => "toaster-1.0",
+        "KITCHEN_INSTANCE_HOSTNAME" => "localhost",
+      }
+    })
+    run_lifecycle_hooks
+  end
+
+  it "runs a local command with an absolute cwd option" do
+    config.update(post_create: [{ local: "echo foo", cwd: "/test" }])
+    lifecycle_hooks.expects(:run_command).with("echo foo", {
+      cwd: os_safe_root_path("/test"),
+      environment: {
+        "KITCHEN_INSTANCE_NAME" => "default-toaster-10",
+        "KITCHEN_SUITE_NAME" => "default",
+        "KITCHEN_PLATFORM_NAME" => "toaster-1.0",
+        "KITCHEN_INSTANCE_HOSTNAME" => "localhost",
+      }
+    })
+    run_lifecycle_hooks
+  end
+
+  it "runs a single remote command" do
+    config.update(post_create: [{ remote: "echo foo" }])
+    lifecycle_hooks.expects(:run_command).never
+    connection.expects(:execute).with("echo foo")
+    run_lifecycle_hooks
+  end
+
+  it "rejects unknown hook targets" do
+    config.update(post_create: [{ banana: "echo foo" }])
+    lifecycle_hooks.expects(:run_command).never
+    proc { run_lifecycle_hooks }.must_raise Kitchen::UserError
+  end
+
+  it "runs mixed local and remote commands" do
+    config.update(post_create: ["echo foo", { local: "echo bar" }, { remote: "echo baz" }])
+    lifecycle_hooks.expects(:run_command).with("echo foo", STANDARD_LOCAL_OPTIONS)
+    lifecycle_hooks.expects(:run_command).with("echo bar", STANDARD_LOCAL_OPTIONS)
+    connection.expects(:execute).with("echo baz")
+    run_lifecycle_hooks
+  end
+
+  describe "with no last_action" do
+    let(:last_action) { nil }
+
+    it "runs local commands" do
+      config.update(post_create: [{ local: "echo foo" }])
+      lifecycle_hooks.expects(:run_command).with("echo foo", STANDARD_LOCAL_OPTIONS)
+      run_lifecycle_hooks
+    end
+
+    it "fails on remote commands" do
+      config.update(post_create: [{ remote: "echo foo" }])
+      lifecycle_hooks.expects(:run_command).never
+      proc { run_lifecycle_hooks }.must_raise Kitchen::UserError
+    end
+
+    it "ignores skippable remote commands" do
+      config.update(post_create: [{ remote: "echo foo", skippable: true }])
+      lifecycle_hooks.expects(:run_command).never
+      run_lifecycle_hooks
+    end
+  end
+end

data/spec/kitchen/transport/ssh_spec.rb

@@ -188,9 +188,8 @@ describe Kitchen::Transport::Ssh do
       end
 
       it "sets the :verify_host_key flag to false" do
-        verify_host_key_option = Kitchen::Transport::Ssh.verify_host_key_option
         klass.expects(:new).with do |hash|
-          hash[verify_host_key_option] == false
+          hash[:verify_host_key] == false
         end
 
         make_connection

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-kitchen
 version: !ruby/object:Gem::Version
-  version: 1.22.1
+  version: 1.23.0
 platform: ruby
 authors:
 - Fletcher Nichol
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-03 00:00:00.000000000 Z
+date: 2018-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mixlib-shellout
@@ -336,6 +336,7 @@ files:
 - LICENSE
 - MAINTAINERS.md
 - README.md
+- RELEASE_NOTES.md
 - Rakefile
 - appveyor.yml
 - bin/kitchen
@@ -384,6 +385,7 @@ files:
 - lib/kitchen/generator/init.rb
 - lib/kitchen/instance.rb
 - lib/kitchen/lazy_hash.rb
+- lib/kitchen/lifecycle_hooks.rb
 - lib/kitchen/loader/yaml.rb
 - lib/kitchen/logger.rb
 - lib/kitchen/logging.rb
@@ -439,6 +441,7 @@ files:
 - spec/kitchen/errors_spec.rb
 - spec/kitchen/instance_spec.rb
 - spec/kitchen/lazy_hash_spec.rb
+- spec/kitchen/lifecycle_hooks_spec.rb
 - spec/kitchen/loader/yaml_spec.rb
 - spec/kitchen/logger_spec.rb
 - spec/kitchen/logging_spec.rb
@@ -525,7 +528,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Test Kitchen is an integration tool for developing and testing infrastructure
@@ -563,6 +566,7 @@ test_files:
 - spec/kitchen/errors_spec.rb
 - spec/kitchen/instance_spec.rb
 - spec/kitchen/lazy_hash_spec.rb
+- spec/kitchen/lifecycle_hooks_spec.rb
 - spec/kitchen/loader/yaml_spec.rb
 - spec/kitchen/logger_spec.rb
 - spec/kitchen/logging_spec.rb