test-kitchen 1.18.0 → 1.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 97e193b25afda7ff71ca265f2b333536dbc66d8f
-  data.tar.gz: f2a5f618364bba733e19fcf833e9966bb8a3a7fa
+  metadata.gz: e20828b8c1e7e6d38e56fd780945e80c1e2448c0
+  data.tar.gz: 991344adaf49eb62704258bcf3caa65f0b0b3920
 SHA512:
-  metadata.gz: e961821cc1bd26c47f069ff8aef06e00d989addf6b0a0150851a8c367d198d0ae49a1edf13a7027f8d37f450ccb2a12d425cc834649088e78b6b579fdc8a6a80
-  data.tar.gz: afcd17fd1f4956c925af332072cc449b17201875ffc892454b9f53cc24dd3692fea38e926699f6748bd4cde9658292f3723bb992781b7647002033a5d7f9b795
+  metadata.gz: 82d95c4a38fbb60cfc50e4dd8cf52e4e767a95d33b059aa223f4cc54b5bd089e9b1dd914b1e5342c59a2f5c361b34007911df2877093a11128374e1cc0e5f488
+  data.tar.gz: 44c4ed0d15ec894e1c9ebc2393710e11d6760083cfc3d76a4c29ce5f2dc5180601af4d889cace89fbd69abc8ebd5d92afb0980236a39904f9ee87e4405ce77e8

data/CHANGELOG.md

@@ -1,5 +1,64 @@
 # Change Log
 
+## [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.17.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))
+- add kitchen-sparkleformation driver to ECOSYSTEM.md [\#1300](https://github.com/test-kitchen/test-kitchen/pull/1300) ([pesimon](https://github.com/pesimon))
+- Add a --debug command line option [\#1296](https://github.com/test-kitchen/test-kitchen/pull/1296) ([coderanger](https://github.com/coderanger))
+- Exec driver [\#1295](https://github.com/test-kitchen/test-kitchen/pull/1295) ([coderanger](https://github.com/coderanger))
+- Misc cleanups [\#1294](https://github.com/test-kitchen/test-kitchen/pull/1294) ([coderanger](https://github.com/coderanger))
+- Upgrades to the shell provisioner [\#1293](https://github.com/test-kitchen/test-kitchen/pull/1293) ([coderanger](https://github.com/coderanger))
+- Remove the `driver create` and `driver discover` commands [\#1290](https://github.com/test-kitchen/test-kitchen/pull/1290) ([coderanger](https://github.com/coderanger))
+- Adds pre_create_command for running arbitrary commands [\#1243](https://github.com/test-kitchen/test-kitchen/pull/1243) ([sean797](https://github.com/sean797))
+- Added better routine to install Busser+Plugins [\#1083](https://github.com/test-kitchen/test-kitchen/pull/1083) ([yeoldegrove](https://github.com/yeoldegrove))
+
 ## [v1.18.0](https://github.com/test-kitchen/test-kitchen/tree/v1.18.0) (2017-09-28)
 [Full Changelog](https://github.com/test-kitchen/test-kitchen/compare/v1.17.0...v1.18.0)
 

data/ECOSYSTEM.md

@@ -40,13 +40,13 @@ The following are community driven plugins.
 
 [kitchen-qemu][qemu] | [kitchen-cfengine][cfengine] | [kitchen-cloudformation][cloudformation] | [kitchen-wpar][wpar] | [kitchen-powervc][powervc] | [kitchen-terraform][terraform]
 ---- | ---- | ---- | ---- | ---- | ----
-[![Status](https://travis-ci.org/esmil/kitchen-qemu.svg?branch=master)](https://travis-ci.org/esmil/kitchen-qemu)| [![Status](https://travis-ci.org/nmische/kitchen-cfengine.svg?branch=master)](https://travis-ci.org/nmische/kitchen-cfengine) | [![Status](https://travis-ci.org/neillturner/kitchen-cloudformation.svg?branch=master)](https://travis-ci.org/neillturner/kitchen-cloudformation) | [![Status](https://travis-ci.org/adejoux/kitchen-wpar.svg?branch=master)](https://travis-ci.org/adejoux/kitchen-wpar) |  [![Status](https://travis-ci.org/chmod666org/kitchen-powervc.svg?branch=master)](https://travis-ci.org/chmod666org/kitchen-powervc) | [![Status](https://travis-ci.org/newcontext-oss/kitchen-terraform.svg?branch=master)](https://travis-ci.org/newcontext-oss/kitchen-terraform)
+[![Status](https://travis-ci.org/esmil/kitchen-qemu.svg?branch=master)](https://travis-ci.org/esmil/kitchen-qemu)| [![Status](https://travis-ci.org/nmische/kitchen-cfengine.svg?branch=master)](https://travis-ci.org/nmische/kitchen-cfengine) | [![Status](https://travis-ci.org/neillturner/kitchen-cloudformation.svg?branch=master)](https://travis-ci.org/neillturner/kitchen-cloudformation)  | [![Status](https://travis-ci.org/adejoux/kitchen-wpar.svg?branch=master)](https://travis-ci.org/adejoux/kitchen-wpar) |  [![Status](https://travis-ci.org/chmod666org/kitchen-powervc.svg?branch=master)](https://travis-ci.org/chmod666org/kitchen-powervc) | [![Status](https://travis-ci.org/newcontext-oss/kitchen-terraform.svg?branch=master)](https://travis-ci.org/newcontext-oss/kitchen-terraform)
 [![Gem Version](https://badge.fury.io/rb/kitchen-qemu.svg)](http://badge.fury.io/rb/kitchen-qemu) | [![Gem Version](https://badge.fury.io/rb/kitchen-cfengine.svg)](http://badge.fury.io/rb/kitchen-cfengine) | [![Gem Version](https://badge.fury.io/rb/kitchen-cloudformation.svg)](http://badge.fury.io/rb/kitchen-cloudformation) | [![Gem Version](https://badge.fury.io/rb/kitchen-wpar.svg)](http://badge.fury.io/rb/kitchen-wpar) | [![Gem Version](https://badge.fury.io/rb/kitchen-powervc.svg)](http://badge.fury.io/rb/kitchen-powervc) | [![Gem Version](https://badge.fury.io/rb/kitchen-terraform.svg)](http://badge.fury.io/rb/kitchen-terraform)
 
-[kitchen-azurerm][azurerm] |
----- |
-[![Status](https://travis-ci.org/pendrica/kitchen-azurerm.svg?branch=master)](https://travis-ci.org/pendrica/kitchen-azurerm) |
-[![Gem Version](https://badge.fury.io/rb/kitchen-azurerm.svg)](http://badge.fury.io/rb/kitchen-azurerm) |
+[kitchen-azurerm][azurerm] | [kitchen-sparkleformation][sparkleformation] 
+---- | ---- 
+[![Status](https://travis-ci.org/pendrica/kitchen-azurerm.svg?branch=master)](https://travis-ci.org/pendrica/kitchen-azurerm) | [![Status](https://travis-ci.org/devkid/kitchen-sparkleformation.svg?branch=master)](https://travis-ci.org/devkid/kitchen-sparkleformation) 
+[![Gem Version](https://badge.fury.io/rb/kitchen-azurerm.svg)](http://badge.fury.io/rb/kitchen-azurerm) |  [![Gem Version](https://badge.fury.io/rb/kitchen-sparkleformation.svg)](http://badge.fury.io/rb/kitchen-sparkleformation) 
 
 
 [chefpartners]: https://github.com/chef-partners/
@@ -82,6 +82,7 @@ The following are community driven plugins.
 [qemu]:  https://github.com/esmil/kitchen-qemu
 [cfengine]: https://github.com/nmische/kitchen-cfengine
 [cloudformation]: https://github.com/neillturner/kitchen-cloudformation
+[sparkleformation]: https://github.com/devkid/kitchen-sparkleformation
 [wpar]:  https://github.com/adejoux/kitchen-wpar
 [powervc]:  https://github.com/chmod666org/kitchen-powervc
 [appbundle-updater]: https://github.com/chef/kitchen-appbundle-updater

data/lib/kitchen/cli.rb

@@ -19,7 +19,6 @@
 require "thor"
 
 require "kitchen"
-require "kitchen/generator/driver_create"
 require "kitchen/generator/init"
 
 module Kitchen
@@ -180,6 +179,13 @@ module Kitchen
           [Future DEPRECATION, use --concurrency]
           Run a #{action} against all matching instances concurrently.
         DESC
+      if action == :converge || action == :verify
+        method_option :debug,
+                      aliases: "-D",
+                      type: :boolean,
+                      default: false,
+                      desc: "Run the #{action} with debugging enabled."
+      end
       test_base_path
       log_options
       define_method(action) do |*args|
@@ -226,6 +232,11 @@ module Kitchen
                   type: :boolean,
                   default: false,
                   desc: "Invoke init command if .kitchen.yml is missing"
+    method_option :debug,
+                  aliases: "-D",
+                  type: :boolean,
+                  default: false,
+                  desc: "Run the converge and verify with debugging enabled."
     test_base_path
     log_options
     def test(*args)
@@ -248,6 +259,16 @@ module Kitchen
       perform("package", "package", args)
     end
 
+    desc "doctor INSTANCE|REGEXP", "Check for common system problems"
+    log_options
+    method_option :all,
+                  aliases: "-a",
+                  desc: "Check all instances"
+    def doctor(*args)
+      update_config!
+      perform("doctor", "doctor", args)
+    end
+
     desc "exec INSTANCE|REGEXP -c REMOTE_COMMAND",
          "Execute command on one or more instance"
     method_option :command,
@@ -285,58 +306,6 @@ module Kitchen
     D
     tasks["init"].options = Kitchen::Generator::Init.class_options
 
-    # Thor class for kitchen driver commands.
-    #
-    # @author Fletcher Nichol <fnichol@nichol.ca>
-    class Driver < Thor
-      include PerformCommand
-
-      register Kitchen::Generator::DriverCreate, "create",
-               "create [NAME]", "Create a new Kitchen Driver gem project"
-      long_desc <<-D, for: "create"
-        Create will generate a project scaffold for a brand new Test Kitchen
-        Driver RubyGem. For example:
-
-        > kitchen driver create foobar
-
-        will create a project scaffold for a RubyGem called `kitchen-foobar'.
-      D
-      tasks["create"].options = Kitchen::Generator::DriverCreate.class_options
-
-      desc "discover", "Discover Test Kitchen drivers published on RubyGems"
-      long_desc <<-D
-        Discover will perform a search aginst the RubyGems service for any
-        published gems of the form: "kitchen-*". Note that it it cannot be
-        guarenteed that every result is a driver, but chances are good most
-        relevant drivers will be returned.
-      D
-      method_option :chef_config_path,
-                    default: nil,
-                    desc: "Path to chef config file containing proxy configuration to use"
-      def discover
-        perform("discover", "driver_discover", args)
-      end
-
-      # @return [String] basename
-      def self.basename
-        super + " driver"
-      end
-    end
-
-    register Kitchen::CLI::Driver, "driver",
-             "driver", "Driver subcommands"
-
-    no_tasks do
-      def invoke_task(command, *args)
-        if command.name == "help" && args.first.first == "driver"
-          Kitchen::CLI::Driver.task_help(shell, args.first.last)
-        else
-          super
-        end
-      end
-      alias_method :invoke_command, :invoke_task
-    end
-
     private
 
     # Ensure the any failing commands exit non-zero.
@@ -369,6 +338,8 @@ module Kitchen
         @config.test_base_path = File.absolute_path(options[:test_base_path])
       end
 
+      @config.debug = options[:debug]
+
       # Now that we have required configs, lets create our file logger
       Kitchen.logger = Kitchen.default_file_logger(
         log_level,

data/lib/kitchen/command/doctor.rb

@@ -0,0 +1,40 @@
+# -*- 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.
+# 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/command"
+
+module Kitchen
+  module Command
+    # Check for common system or configuration problems.
+    #
+    class Doctor < Kitchen::Command::Base
+      # Invoke the command.
+      def call
+        results = parse_subcommand(args.first)
+        if results.empty?
+          error("No instances configured, cannot check configuration. Please check your .kitchen.yml and confirm it has platform and suites sections.")
+          exit(1)
+        end
+        # By default only doctor the first instance to avoid output spam.
+        results = [results.first] unless options[:all]
+        failed = results.any? do |instance|
+          debug "Doctor on #{instance.name}."
+          instance.doctor_action
+        end
+        exit(1) if failed
+      end
+    end
+  end
+end

data/lib/kitchen/config.rb

@@ -78,6 +78,10 @@ module Kitchen
     # @api private
     attr_accessor :colorize
 
+    # @return [Boolean] whether to enable debugging in the provisioner/verifier plugin or not
+    # @api private
+    attr_accessor :debug
+
     # Creates a new configuration, representing a particular testing
     # configuration for a project.
     #
@@ -104,6 +108,7 @@ module Kitchen
       @colorize       = options.fetch(:colorize) { Kitchen.tty? }
       @log_root       = options.fetch(:log_root) { default_log_root }
       @test_base_path = options.fetch(:test_base_path) { default_test_base_path }
+      @debug          = options.fetch(:debug) { false }
     end
 
     # @return [Collection<Instance>] all instances, resulting from all
@@ -214,6 +219,7 @@ module Kitchen
         test_base_path: test_base_path,
         log_level: log_level,
         log_overwrite: log_overwrite,
+        debug: debug,
       }
     end
 

data/lib/kitchen/configurable.rb

@@ -304,7 +304,7 @@ module Kitchen
     # @return [String] wrapped shell code
     # @api private
     def wrap_shell_code(code)
-      return env_wrapped code if powershell_shell?
+      return env_wrapped(code) if powershell_shell?
       Util.wrap_command((env_wrapped code))
     end
 

data/lib/kitchen/data_munger.rb

@@ -80,6 +80,7 @@ module Kitchen
       merged_data_for(:provisioner, suite, platform).tap do |pdata|
         set_kitchen_config_at!(pdata, :kitchen_root)
         set_kitchen_config_at!(pdata, :test_base_path)
+        set_kitchen_config_at!(pdata, :debug)
         combine_arrays!(pdata, :run_list, :platform, :suite)
       end
     end
@@ -118,6 +119,7 @@ module Kitchen
         set_kitchen_config_at!(vdata, :kitchen_root)
         set_kitchen_config_at!(vdata, :test_base_path)
         set_kitchen_config_at!(vdata, :log_level)
+        set_kitchen_config_at!(vdata, :debug)
       end
     end
 

data/lib/kitchen/driver/base.rb

@@ -17,6 +17,7 @@
 # limitations under the License.
 
 require "kitchen/lazy_hash"
+require "kitchen/shell_out"
 
 module Kitchen
   module Driver
@@ -26,6 +27,9 @@ module Kitchen
     class Base
       include Configurable
       include Logging
+      include ShellOut
+
+      default_config :pre_create_command, nil
 
       # Creates a new Driver object using the provided configuration data
       # which will be merged with any default configuration.
@@ -40,6 +44,7 @@ module Kitchen
       # @param state [Hash] mutable instance and driver state
       # @raise [ActionFailed] if the action could not be completed
       def create(state) # rubocop:disable Lint/UnusedMethodArgument
+        pre_create_command
       end
 
       # Destroys an instance.
@@ -56,6 +61,14 @@ module Kitchen
       def package(state) # rubocop:disable Lint/UnusedMethodArgument
       end
 
+      # Check system and configuration for common errors.
+      #
+      # @param state [Hash] mutable instance and driver state
+      # @returns [Boolean] Return true if a problem is found.
+      def doctor(state)
+        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
@@ -81,7 +94,7 @@ module Kitchen
       # @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 = [:create, :setup, :verify, :destroy]
+        action_methods = [:create, :setup, :converge, :verify, :destroy]
 
         Array(methods).each do |meth|
           next if action_methods.include?(meth)
@@ -125,6 +138,18 @@ module Kitchen
 
       private
 
+      # Run command if config[:pre_create_command] is set
+      def pre_create_command
+        if config[:pre_create_command]
+          begin
+            run_command(config[:pre_create_command])
+          rescue ShellCommandFailed => error
+            raise ActionFailed,
+              "pre_create_command '#{config[:pre_create_command]}' failed to execute #{error}"
+          end
+        end
+      end
+
       # Intercepts any bare #puts calls in subclasses and issues an INFO log
       # event instead.
       #

data/lib/kitchen/driver/dummy.rb

@@ -36,6 +36,7 @@ module Kitchen
 
       # (see Base#create)
       def create(state)
+        # Intentionally not calling `super` to avoid pre_create_command.
         state[:my_id] = "#{instance.name}-#{Time.now.to_i}"
         report(:create, state)
       end

data/lib/kitchen/driver/exec.rb

@@ -0,0 +1,71 @@
+# -*- 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.
+# 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/driver/base"
+require "kitchen/shell_out"
+require "kitchen/transport/exec"
+require "kitchen/version"
+
+module Kitchen
+  module Driver
+    # Simple driver that runs commands locally. As with the proxy driver, this
+    # has no isolation in general.
+    class Exec < Kitchen::Driver::Base
+      include ShellOut
+
+      plugin_version Kitchen::VERSION
+
+      default_config :reset_command, nil
+
+      no_parallel_for :create, :converge, :destroy
+
+      # Hack to force using the exec transport when using this driver.
+      # If someone comes up with a use case for using the driver with a different
+      # transport, please let us know.
+      #
+      # @api private
+      def finalize_config!(instance)
+        super.tap do
+          instance.transport = Kitchen::Transport::Exec.new
+        end
+      end
+
+      # (see Base#create)
+      def create(state)
+        super
+        reset_instance(state)
+      end
+
+      # (see Base#destroy)
+      def destroy(state)
+        reset_instance(state)
+      end
+
+      private
+
+      # Resets the non-Kitchen managed instance using by issuing a command
+      # over SSH.
+      #
+      # @param state [Hash] the state hash
+      # @api private
+      def reset_instance(state)
+        if cmd = config[:reset_command]
+          info("Resetting instance state with command: #{cmd}")
+          run_command(cmd)
+        end
+      end
+    end
+  end
+end