test-kitchen 1.0.0.rc.1 → 1.0.0.rc.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 531f23b775d0e1852010f3405773b4a36e938126
-  data.tar.gz: 7d447f5dca58df770141b9184606632bc4ae4a61
+  metadata.gz: 893be3400f70816247b46d2128c8a649b2c95996
+  data.tar.gz: 4888b33cdfe04efa18da5cdc5312d940e63d760f
 SHA512:
-  metadata.gz: 39879c2db849837769c3375cae413a18521fd28978456336703c005c4aef3913dd1e20e83d55485ae9e8e9cd5dd0b7d2f7f1fa3f5d9c5aa51aab5e8995c482fb
-  data.tar.gz: fb4e14f632ae4fecb40cb34c83df2cdad2bcb784bd41168cae3fbe2ffad8e043399444ac721b44c907dafddcd9f55c3ae834f4b9e3d208c1e4c911999f284a36
+  metadata.gz: a8613b788d26d13cd0e5b7f72f29cc286fd2ee74ce1c0f51f42b1bbcde2d376c244cff8cf623cca1ecfc6d4d4101e879ad378543f6e18d19bf01f377f89d811e
+  data.tar.gz: a9a22957290e20d68f309d61dd2fe6fa5292ab41bc8e73ef22fb0c1da593615232d712b4350b516cf61e1eb113807cee606482ed258e7b6426d92cc3ff2ffaba

data/CHANGELOG.md

@@ -1,50 +1,74 @@
+## 1.0.0.rc.2 / 2013-11-30
+
+### Changes
+
+* Generate a more explict form for driver & provisioner in `kitchen init`. ([@fnichol][])
+* Set `Busser[:sudo]` to `false` by default. ([@fnichol][])
+
+### Bug fixes
+
+* Properly handle `encrypted_data_bag_secret_key_path` under a suite. ([@fnichol][])
+* Pull request [#265][]: Busser Fixes for Greybeard UNIX. ([@schisamo][])
+* Pull request [#265][]: Busser config key name is `sudo` not `use_sudo`. ([@schisamo][])
+
+### New features
+
+* Add diagnostic facility to Test Kitchen, usable with `kitchen diagnose`. ([@fnichol][])
+
+### Improvements
+
+* Pull request [#266][]: Generate more a helpful error when supplying an invalid Regexp with CLI. ([@fnichol][])
+* Improve logging of file transfers to instances in converge action. ([@fnichol][])
+* Add feature test coverage for `kitchen list` subcommand. ([@fnichol][])
+
+
 ## 1.0.0.rc.1 / 2013-11-28
 
 ### Changes
 
-* Busser now installs into /tmp/busser by default on instances. (@fnichol)
-* Test Kitchen now works out of /tmp/kitchen for all providers by default. (@fnichol)
-* Remove Chef Omnibus `GEM_PATH` inclusion in Busser `GEM_PATH`. This fully isolates Busser and its runner plugins to a `GEM_HOME` and `GEM_PATH` in `<busser_root_path>/gems`. (@fnichol)
-* Add --provisioner to `kitchen init` to override default, chef\_solo. (@fnichol)
+* Busser now installs into /tmp/busser by default on instances. ([@fnichol][])
+* Test Kitchen now works out of /tmp/kitchen for all providers by default. ([@fnichol][])
+* Remove Chef Omnibus `GEM_PATH` inclusion in Busser `GEM_PATH`. This fully isolates Busser and its runner plugins to a `GEM_HOME` and `GEM_PATH` in `<busser_root_path>/gems`. ([@fnichol][])
+* Add --provisioner to `kitchen init` to override default, chef\_solo. ([@fnichol][])
 
 ### Bug fixes
 
-* Issue #240, issue #242, pull request #258: Fix Busser and Chef Zero sandboxing so that each tool is completely isolated from the Omnibus packages gems and each other. (@fnichol, @schisamo)
+* Issue [#240][], issue [#242][], pull request [#258][]: Fix Busser and Chef Zero sandboxing so that each tool is completely isolated from the Omnibus packages gems and each other. ([@fnichol][], [@schisamo][])
 
 ### New features
 
 * Beef up Provisioners so that they resemble Drivers with user, default, inherited, and computed configuration..
-* Use `chef-client -z` (local mode) with ChefZero Provisioner for Chef versions >= 11.8.0. Support older versions of Chef with a best-effort fallback shim to use chef-zero. (@fnichol)
-* `kitchen list --debug` mode greatly improved showing rendered configuration for each Instance's Driver, Provisioner, and Busser configuration. (@fnichol)
-* Pull request #249: Add a data\_path which will be sync'd to the instance in the same manner as roles and data bags. (@oferrigni)
-* Test Kitchen no longer requires a cookbook to run; kitchen init anywhere! (@fnichol)
-* All settings in solo.rb (for ChefSolo) and client.rb (for ChefZero) can be modified or added with a `solo_rb:` or `client_rb:` block inside a `provisioner:` block. (@fnichol)
-* Add :ruby_bindr in a busser config block to set Busser's alternative remote path to Ruby. (@fnichol)
-* Busser install root can be configured and is relocatable, defaults to /tmp/busser. (@fnichol)
-* Test Kitchen root can be configured and is relocatable, defaults to /tmp/kitchen. (@fnichol)
-* Support installing a specific version of Busser. (@fnichol)
+* Use `chef-client -z` (local mode) with ChefZero Provisioner for Chef versions >= 11.8.0. Support older versions of Chef with a best-effort fallback shim to use chef-zero. ([@fnichol][])
+* `kitchen list --debug` mode greatly improved showing rendered configuration for each Instance's Driver, Provisioner, and Busser configuration. ([@fnichol][])
+* Pull request [#249][]: Add a data\_path which will be sync'd to the instance in the same manner as roles and data bags. ([@oferrigni][])
+* Test Kitchen no longer requires a cookbook to run; kitchen init anywhere! ([@fnichol][])
+* All settings in solo.rb (for ChefSolo) and client.rb (for ChefZero) can be modified or added with a `solo_rb:` or `client_rb:` block inside a `provisioner:` block. ([@fnichol][])
+* Add :ruby_bindr in a busser config block to set Busser's alternative remote path to Ruby. ([@fnichol][])
+* Busser install root can be configured and is relocatable, defaults to /tmp/busser. ([@fnichol][])
+* Test Kitchen root can be configured and is relocatable, defaults to /tmp/kitchen. ([@fnichol][])
+* Support installing a specific version of Busser. ([@fnichol][])
 
 ### Improvements
 
-* Greatly simplify default .kitchen.yml. (@fnichol, @sethvargo)
-* Massive internal refactoring data manipulation logic. Data code now lives in Kitchen::DataMunger and was properly TDD'ed from the ground up with a full test suite. (@fnichol)
-* `require_chef_ommnibus` will default to `true` for all Chef provisioners and so can be omitted from .kitchen.yml files in most cases. (@fnichol)
-* Pull request #262: Use a configurable glob pattern to select Chef cookbook files. (@fnichol)
-* Pull request #141: Do not create a gitignore if there is no git repo. (@sethvargo)
-* Improve `kitchen init` smarts for detecting gems already in Gemfile. (@fnichol)
-* Expand all Chef-related local paths in Provisioner::ChefBase. (@fnichol)
-* Issue #227: Handle absolute paths. (@sethvargo)
-* Cope with nil values for run\_list and attributes entries in .kitchen.yml. (@fnichol)
-* Allow for nil values for `provisioner:`, `driver:`, & `busser:`. (@fnichol)
-* Pull request #253: Fix TravisCI badges. (@arangamani)
-* Pull request #254: Update references to test-kitchen org. (@josephholsten)
-* Pull request #256: Changed 'passed' to 'passing' in the Destroy options documentation. (@scarolan)
-* Pull request #259: Fix inconsistent date in CHANGELOG. (@ryansouza)
-* Extract Berkshelf & Librarian-Chef resolver code to classes. (@fnichol)
-* Full spec coverage for Suite. (@fnichol)
-* Full spec coverage for Platform. (@fnichol)
-* Full spec coverage for Instance. (@fnichol)
-* Full spec coverage for Kitchen::Provisioner.for\_plugin (@fnichol)
+* Greatly simplify default .kitchen.yml. ([@fnichol][], [@sethvargo][])
+* Massive internal refactoring data manipulation logic. Data code now lives in Kitchen::DataMunger and was properly TDD'ed from the ground up with a full test suite. ([@fnichol][])
+* `require_chef_ommnibus` will default to `true` for all Chef provisioners and so can be omitted from .kitchen.yml files in most cases. ([@fnichol][])
+* Pull request [#262][]: Use a configurable glob pattern to select Chef cookbook files. ([@fnichol][])
+* Pull request [#141][]: Do not create a gitignore if there is no git repo. ([@sethvargo][])
+* Improve `kitchen init` smarts for detecting gems already in Gemfile. ([@fnichol][])
+* Expand all Chef-related local paths in Provisioner::ChefBase. ([@fnichol][])
+* Issue [#227][]: Handle absolute paths. ([@sethvargo][])
+* Cope with nil values for run\_list and attributes entries in .kitchen.yml. ([@fnichol][])
+* Allow for nil values for `provisioner:`, `driver:`, & `busser:`. ([@fnichol][])
+* Pull request [#253][]: Fix TravisCI badges. ([@arangamani][])
+* Pull request [#254][]: Update references to test-kitchen org. ([@josephholsten][])
+* Pull request [#256][]: Changed 'passed' to 'passing' in the Destroy options documentation. ([@scarolan][])
+* Pull request [#259][]: Fix inconsistent date in CHANGELOG. ([@ryansouza][])
+* Extract Berkshelf & Librarian-Chef resolver code to classes. ([@fnichol][])
+* Full spec coverage for Suite. ([@fnichol][])
+* Full spec coverage for Platform. ([@fnichol][])
+* Full spec coverage for Instance. ([@fnichol][])
+* Full spec coverage for Kitchen::Provisioner.for\_plugin ([@fnichol][])
 
 
 ## 1.0.0.beta.4 / 2013-11-01
@@ -302,6 +326,7 @@ The initial release.
 [#136]: https://github.com/opscode/test-kitchen/issues/136
 [#137]: https://github.com/opscode/test-kitchen/issues/137
 [#140]: https://github.com/opscode/test-kitchen/issues/140
+[#141]: https://github.com/opscode/test-kitchen/issues/141
 [#142]: https://github.com/opscode/test-kitchen/issues/142
 [#147]: https://github.com/opscode/test-kitchen/issues/147
 [#151]: https://github.com/opscode/test-kitchen/issues/151
@@ -325,8 +350,20 @@ The initial release.
 [#217]: https://github.com/opscode/test-kitchen/issues/217
 [#218]: https://github.com/opscode/test-kitchen/issues/218
 [#222]: https://github.com/opscode/test-kitchen/issues/222
+[#227]: https://github.com/opscode/test-kitchen/issues/227
 [#231]: https://github.com/opscode/test-kitchen/issues/231
 [#235]: https://github.com/opscode/test-kitchen/issues/235
+[#240]: https://github.com/opscode/test-kitchen/issues/240
+[#242]: https://github.com/opscode/test-kitchen/issues/242
+[#249]: https://github.com/opscode/test-kitchen/issues/249
+[#253]: https://github.com/opscode/test-kitchen/issues/253
+[#254]: https://github.com/opscode/test-kitchen/issues/254
+[#256]: https://github.com/opscode/test-kitchen/issues/256
+[#258]: https://github.com/opscode/test-kitchen/issues/258
+[#259]: https://github.com/opscode/test-kitchen/issues/259
+[#262]: https://github.com/opscode/test-kitchen/issues/262
+[#265]: https://github.com/opscode/test-kitchen/issues/265
+[#266]: https://github.com/opscode/test-kitchen/issues/266
 [@ChrisLundquist]: https://github.com/ChrisLundquist
 [@adamhjk]: https://github.com/adamhjk
 [@arangamani]: https://github.com/arangamani
@@ -349,15 +386,17 @@ The initial release.
 [@manul]: https://github.com/manul
 [@mattray]: https://github.com/mattray
 [@mconigliaro]: https://github.com/mconigliaro
+[@oferrigni]: https://github.com/oferrigni
 [@patcon]: https://github.com/patcon
 [@portertech]: https://github.com/portertech
 [@reset]: https://github.com/reset
 [@rteabeault]: https://github.com/rteabeault
 [@ryansouza]: https://github.com/ryansouza
 [@saketoba]: https://github.com/saketoba
+[@scarolan]: https://github.com/scarolan
 [@schisamo]: https://github.com/schisamo
 [@scotthain]: https://github.com/scotthain
 [@sethvargo]: https://github.com/sethvargo
 [@smith]: https://github.com/smith
 [@stevendanna]: https://github.com/stevendanna
-[@thommay]: https://github.com/thommay
+[@thommay]: https://github.com/thommay

data/features/kitchen_init_command.feature

@@ -21,7 +21,11 @@ Feature: Add Test Kitchen support to an existing project
     And a directory named "test/integration/default" should exist
     And the file ".gitignore" should contain ".kitchen/"
     And the file ".gitignore" should contain ".kitchen.local.yml"
-    And the file ".kitchen.yml" should contain "driver: vagrant"
+    And the file ".kitchen.yml" should contain:
+    """
+    driver:
+      name: vagrant
+    """
     And a file named "Gemfile" should not exist
     And a file named "Rakefile" should not exist
     And a file named "Thorfile" should not exist
@@ -104,24 +108,40 @@ Feature: Add Test Kitchen support to an existing project
     first driver given
     Given an empty file named "Gemfile"
     When I successfully run `kitchen init --driver=kitchen-bluebox kitchen-wakka`
-    Then the file ".kitchen.yml" should contain "driver: bluebox"
+    Then the file ".kitchen.yml" should contain:
+    """
+    driver:
+      name: bluebox
+    """
 
   Scenario: Running init with no drivers sets the plugin_driver to the
     dummy driver
     Given an empty file named "Gemfile"
     When I successfully run `kitchen init --no-driver`
-    Then the file ".kitchen.yml" should contain "driver: dummy"
+    Then the file ".kitchen.yml" should contain:
+    """
+    driver:
+      name: dummy
+    """
 
   Scenario: Running init without a provisioner sets the default provisioner
     to chef_solo in .kitchen.yml
     Given an empty file named "Gemfile"
     When I successfully run `kitchen init --no-driver`
-    Then the file ".kitchen.yml" should contain "provisioner: chef_solo"
+    Then the file ".kitchen.yml" should contain:
+    """
+    provisioner:
+      name: chef_solo
+    """
 
   Scenario: Running init with a provisioner sets the provisioner in .kitchen.yml
     Given an empty file named "Gemfile"
     When I successfully run `kitchen init --no-driver --provisioner=chef_zero`
-    Then the file ".kitchen.yml" should contain "provisioner: chef_zero"
+    Then the file ".kitchen.yml" should contain:
+    """
+    provisioner:
+      name: chef_zero
+    """
 
   Scenario: Running with a Rakefile file appends Kitchen tasks
     Given an empty file named "Gemfile"
@@ -172,8 +192,11 @@ Feature: Add Test Kitchen support to an existing project
     Then the file ".kitchen.yml" should contain exactly:
     """
     ---
-    driver: vagrant
-    provisioner: chef_solo
+    driver:
+      name: vagrant
+
+    provisioner:
+      name: chef_solo
 
     platforms:
       - name: ubuntu-12.04

data/features/kitchen_list_command.feature

@@ -0,0 +1,62 @@
+Feature: Listing Test Kitchen instances
+  In order to understand how the .kitchen.yml is consumed
+  As a user of Test Kitchen
+  I want to run a command to see the state of my instances
+
+  Background:
+    Given a file named ".kitchen.yml" with:
+    """
+    ---
+    driver: dummy
+    provisioner: chef_solo
+
+    platforms:
+      - name: ubuntu-13.04
+      - name: centos-6.4
+
+    suites:
+      - name: foobar
+    """
+
+  Scenario: Listing instances
+    When I run `kitchen list`
+    Then the exit status should be 0
+    And the output should contain "foobar-ubuntu-1304"
+    And the output should contain "foobar-centos-64"
+
+  Scenario: Listing instances with the --bare option
+    When I run `kitchen list --bare`
+    Then the exit status should be 0
+    And the output should contain exactly:
+    """
+    foobar-ubuntu-1304
+    foobar-centos-64
+
+    """
+
+  Scenario: Listing instances with a simple regular expression glob
+    When I successfully run `kitchen list ubun --bare`
+    Then the output should contain exactly:
+    """
+    foobar-ubuntu-1304
+
+    """
+
+  Scenario: Listing instances with a Ruby regular expression glob, requiring
+    signle quoting on the command line
+    When I successfully run `kitchen list '^foo.*\-(10|13)04$' --bare`
+    Then the output should contain exactly:
+    """
+    foobar-ubuntu-1304
+
+    """
+
+  Scenario: Listing instances with a regular expression yielding no results
+    When I run `kitchen list freebsd --bare`
+    Then the exit status should not be 0
+    And the output should contain "No instances for regex `freebsd', try running `kitchen list'"
+
+  Scenario: Listing instances with a bad regular expression
+    When I run `kitchen list *centos* --bare`
+    Then the exit status should not be 0
+    And the output should contain "Invalid Ruby regular expression"

data/lib/kitchen.rb

@@ -32,6 +32,7 @@ require 'kitchen/color'
 require 'kitchen/collection'
 require 'kitchen/config'
 require 'kitchen/data_munger'
+require 'kitchen/diagnostic'
 require 'kitchen/driver'
 require 'kitchen/driver/base'
 require 'kitchen/driver/proxy'

data/lib/kitchen/busser.rb

@@ -37,35 +37,36 @@ module Kitchen
     # @option opts [String] :instance_ruby_bindir path to the directory
     #   containing the Ruby binary on the remote instance
     # @option opts [TrueClass, FalseClass] :sudo whether or not to invoke
-    #   sudo before commands requiring root access (default: `true`)
+    #   sudo before commands requiring root access (default: `false`)
     def initialize(suite_name, opts = {})
       validate_options(suite_name)
 
       kitchen_root = opts.fetch(:kitchen_root) { Dir.pwd }
       test_base_path = opts.fetch(:test_base_path, Kitchen::DEFAULT_TEST_DIR)
 
-      @test_base_path = File.expand_path(test_base_path, kitchen_root)
-      @suite_name = suite_name
-      @use_sudo = opts.fetch(:sudo, true)
-      @ruby_bindir = opts.fetch(:instance_ruby_bindir, DEFAULT_RUBY_BINDIR)
-      @root_path = opts.fetch(:root_path, DEFAULT_ROOT_PATH)
-      @version_string = opts.fetch(:version, "busser")
-      @busser_bin = File.join(@root_path, "bin/busser")
+      @config = Hash.new
+      @config[:kitchen_root] = kitchen_root
+      @config[:test_base_path] = File.expand_path(test_base_path, kitchen_root)
+      @config[:suite_name] = suite_name
+      @config[:sudo] = opts.fetch(:sudo, false)
+      @config[:ruby_bindir] = opts.fetch(:ruby_bindir, DEFAULT_RUBY_BINDIR)
+      @config[:root_path] = opts.fetch(:root_path, DEFAULT_ROOT_PATH)
+      @config[:version] = opts.fetch(:version, "busser")
+      @config[:busser_bin] = opts.fetch(:busser_bin, File.join(@config[:root_path], "bin/busser"))
     end
 
     # Returns the name of this busser, suitable for display in a CLI.
     #
     # @return [String] name of this busser
     def name
-      suite_name
+      config[:suite_name]
     end
 
     # Returns an array of configuration keys.
     #
     # @return [Array] array of configuration keys
     def config_keys
-      [:test_base_path, :ruby_bindir, :root_path, :version_string,
-        :busser_bin, :use_sudo, :suite_name]
+      config.keys
     end
 
     # Provides hash-like access to configuration keys.
@@ -73,7 +74,16 @@ module Kitchen
     # @param attr [Object] configuration key
     # @return [Object] value at configuration key
     def [](attr)
-      config_keys.include?(attr) ? self.send(attr) : nil
+      config[attr]
+    end
+
+    # Returns a Hash of configuration and other useful diagnostic information.
+    #
+    # @return [Hash] a diagnostic hash
+    def diagnose
+      result = Hash.new
+      config_keys.sort.each { |k| result[k] = config[k] }
+      result
     end
 
     # Returns a command string which installs Busser, and installs all
@@ -88,17 +98,17 @@ module Kitchen
       @setup_cmd ||= if local_suite_files.empty?
         nil
       else
+        setup_cmd  = []
+        setup_cmd << busser_setup_env
+        setup_cmd << "if ! #{sudo}#{config[:ruby_bindir]}/gem list busser -i >/dev/null"
+        setup_cmd << "then #{sudo}#{config[:ruby_bindir]}/gem install #{gem_install_args}"
+        setup_cmd << "fi"
+        setup_cmd << "gem_bindir=`#{config[:ruby_bindir]}/ruby -rrubygems -e \"puts Gem.bindir\"`"
+        setup_cmd << "#{sudo}${gem_bindir}/busser setup"
+        setup_cmd << "#{sudo}#{config[:busser_bin]} plugin install #{plugins.join(' ')}"
+
         # use Bourne (/bin/sh) as Bash does not exist on all Unix flavors
-        <<-INSTALL_CMD.gsub(/^ {10}/, '')
-          sh -c '
-          #{busser_setup_env}
-          if ! #{sudo}#{ruby_bindir}/gem list busser -i >/dev/null; then
-            #{sudo}#{ruby_bindir}/gem install #{gem_install_args}
-          fi
-          gem_bindir=`#{ruby_bindir}/ruby -rrubygems -e "puts Gem.bindir"`
-          #{sudo}${gem_bindir}/busser setup
-          #{sudo}#{busser_bin} plugin install #{plugins.join(' ')}'
-        INSTALL_CMD
+        "sh -c '#{setup_cmd.join('; ')}'"
       end
     end
 
@@ -114,13 +124,14 @@ module Kitchen
       @sync_cmd ||= if local_suite_files.empty?
         nil
       else
+        sync_cmd  = []
+        sync_cmd << busser_setup_env
+        sync_cmd << "#{sudo}#{config[:busser_bin]} suite cleanup"
+        sync_cmd << "#{local_suite_files.map { |f| stream_file(f, remote_file(f, config[:suite_name])) }.join}"
+        sync_cmd << "#{helper_files.map { |f| stream_file(f, remote_file(f, "helpers")) }.join}"
+
         # use Bourne (/bin/sh) as Bash does not exist on all Unix flavors
-        <<-INSTALL_CMD.gsub(/^ {10}/, '')
-          sh -c '
-          #{sudo}#{busser_bin} suite cleanup
-          #{local_suite_files.map { |f| stream_file(f, remote_file(f, suite_name)) }.join}
-          #{helper_files.map { |f| stream_file(f, remote_file(f, "helpers")) }.join}'
-        INSTALL_CMD
+        "sh -c '#{sync_cmd.join('; ')}'"
       end
     end
 
@@ -132,7 +143,16 @@ module Kitchen
     # @return [String] a command string to run the test suites, or nil if no
     #   work needs to be performed
     def run_cmd
-      @run_cmd ||= local_suite_files.empty? ? nil : "#{sudo}#{busser_bin} test"
+      @run_cmd ||= if local_suite_files.empty?
+        nil
+      else
+        run_cmd  = []
+        run_cmd << busser_setup_env
+        run_cmd << "#{sudo}#{config[:busser_bin]} test"
+
+        # use Bourne (/bin/sh) as Bash does not exist on all Unix flavors
+        "sh -c '#{run_cmd.join('; ')}'"
+      end
     end
 
     private
@@ -140,13 +160,7 @@ module Kitchen
     DEFAULT_RUBY_BINDIR = "/opt/chef/embedded/bin".freeze
     DEFAULT_ROOT_PATH = "/tmp/busser".freeze
 
-    attr_reader :test_base_path
-    attr_reader :ruby_bindir
-    attr_reader :root_path
-    attr_reader :version_string
-    attr_reader :busser_bin
-    attr_reader :use_sudo
-    attr_reader :suite_name
+    attr_reader :config
 
     def validate_options(suite_name)
       if suite_name.nil?
@@ -160,24 +174,26 @@ module Kitchen
     end
 
     def plugins
-      Dir.glob(File.join(test_base_path, suite_name, "*")).reject { |d|
+      glob = File.join(config[:test_base_path], config[:suite_name], "*")
+      Dir.glob(glob).reject { |d|
         ! File.directory?(d) || non_suite_dirs.include?(File.basename(d))
       }.map { |d| "busser-#{File.basename(d)}" }.sort.uniq
     end
 
     def local_suite_files
-      Dir.glob(File.join(test_base_path, suite_name, "*/**/*")).reject do |f|
+      glob = File.join(config[:test_base_path], config[:suite_name], "*/**/*")
+      Dir.glob(glob).reject do |f|
         f[/(data|data_bags|environments|nodes|roles)/] || File.directory?(f)
       end
     end
 
     def helper_files
-      Dir.glob(File.join(test_base_path, "helpers", "*/**/*"))
+      Dir.glob(File.join(config[:test_base_path], "helpers", "*/**/*"))
     end
 
     def remote_file(file, dir)
-      local_prefix = File.join(test_base_path, dir)
-      "$(#{sudo}#{busser_bin} suite path)/".concat(file.sub(%r{^#{local_prefix}/}, ''))
+      local_prefix = File.join(config[:test_base_path], dir)
+      "$(#{sudo}#{config[:busser_bin]} suite path)/".concat(file.sub(%r{^#{local_prefix}/}, ''))
     end
 
     def stream_file(local_path, remote_path)
@@ -185,27 +201,21 @@ module Kitchen
       md5 = Digest::MD5.hexdigest(local_file)
       perms = sprintf("%o", File.stat(local_path).mode)[2, 4]
       stream_cmd = [
-        "#{sudo}#{busser_bin}",
+        "#{sudo}#{config[:busser_bin]}",
         "deserialize",
         "--destination=#{remote_path}",
         "--md5sum=#{md5}",
         "--perms=#{perms}"
       ].join(" ")
 
-      <<-STREAMFILE.gsub(/^ {8}/, '')
-        echo "Uploading #{remote_path} (mode=#{perms})"
-        #{sudo}cat <<"__EOFSTREAM__" | #{sudo}#{stream_cmd}
-        #{Base64.encode64(local_file)}
-        __EOFSTREAM__
-      STREAMFILE
+      stream_file_cmd  = []
+      stream_file_cmd << %{echo "Uploading #{remote_path} (mode=#{perms})"}
+      stream_file_cmd << %{echo "#{Base64.encode64(local_file).gsub("\n", '')}" | #{sudo}#{stream_cmd}}
+      stream_file_cmd.join('; ')
     end
 
     def sudo
-      use_sudo ? "sudo -E " : ""
-    end
-
-    def busser_gem
-      "busser"
+      config[:sudo] ? "sudo -E " : ""
     end
 
     def non_suite_dirs
@@ -214,16 +224,16 @@ module Kitchen
 
     def busser_setup_env
       [
-        %{BUSSER_ROOT="#{root_path}"},
-        %{GEM_HOME="#{root_path}/gems"},
-        %{GEM_PATH="#{root_path}/gems"},
-        %{GEM_CACHE="#{root_path}/gems/cache"},
-        %{; export BUSSER_ROOT GEM_HOME GEM_PATH GEM_CACHE;}
+        %{BUSSER_ROOT="#{config[:root_path]}"},
+        %{GEM_HOME="#{config[:root_path]}/gems"},
+        %{GEM_PATH="#{config[:root_path]}/gems"},
+        %{GEM_CACHE="#{config[:root_path]}/gems/cache"},
+        %{; export BUSSER_ROOT GEM_HOME GEM_PATH GEM_CACHE}
       ].join(" ")
     end
 
     def gem_install_args
-      gem, version = version_string.split("@")
+      gem, version = config[:version].split("@")
       gem, version = "busser", gem if gem =~ /^\d+\.\d+\.\d+/
 
       args = gem

data/lib/kitchen/cli.rb

@@ -41,8 +41,9 @@ module Kitchen
       super
       $stdout.sync = true
       Kitchen.logger = Kitchen.default_file_logger
+      @loader = Kitchen::Loader::YAML.new(ENV['KITCHEN_YAML'])
       @config = Kitchen::Config.new(
-        :loader     => Kitchen::Loader::YAML.new(ENV['KITCHEN_YAML']),
+        :loader     => @loader,
         :log_level  => ENV.fetch('KITCHEN_LOG', "info").downcase.to_sym
       )
     end
@@ -51,14 +52,15 @@ module Kitchen
     method_option :bare, :aliases => "-b", :type => :boolean,
       :desc => "List the name of each instance only, one per line"
     method_option :debug, :aliases => "-d", :type => :boolean,
-      :desc => "Show computed driver configuration for each instance"
+      :desc => "[Deprecated] Please use `kitchen diagnose'"
     method_option :log_level, :aliases => "-l",
       :desc => "Set the log level (debug, info, warn, error, fatal)"
     def list(*args)
       update_config!
       result = parse_subcommand(args.first)
       if options[:debug]
-        Array(result).each { |i| debug_instance(i) }
+        die task, "The --debug flag on the list subcommand is deprecated, " +
+          "please use `kitchen diagnose'."
       elsif options[:bare]
         say Array(result).map { |i| i.name }.join("\n")
       else
@@ -66,6 +68,34 @@ module Kitchen
       end
     end
 
+    desc "diganose [(all|<REGEX>)]", "Show computed diagnostic configuration"
+    method_option :log_level, :aliases => "-l",
+      :desc => "Set the log level (debug, info, warn, error, fatal)"
+    method_option :loader, :type => :boolean,
+      :desc => "Include data loader diagnostics"
+    method_option :instances, :type => :boolean, :default => true,
+      :desc => "Include instances diagnostics"
+    method_option :all, :type => :boolean,
+      :desc => "Include all diagnostics"
+    def diagnose(*args)
+      update_config!
+
+      loader = if options[:all] || options[:loader]
+        @loader
+      else
+        nil
+      end
+      instances = if options[:all] || options[:instances]
+        parse_subcommand(args.first)
+      else
+        []
+      end
+
+      require 'yaml'
+      Kitchen::Diagnostic.new(:loader => loader, :instances => instances).
+        read.to_yaml.each_line { |line| say(line) }
+    end
+
     [:create, :converge, :setup, :verify, :destroy].each do |action|
       desc(
         "#{action} [(all|<REGEX>)] [opts]",
@@ -308,7 +338,13 @@ module Kitchen
     end
 
     def get_filtered_instances(regexp)
-      result = @config.instances.get_all(/#{regexp}/)
+      result = begin
+        @config.instances.get_all(/#{regexp}/)
+      rescue RegexpError => e
+        die task, "Invalid Ruby regular expression, " +
+          "you may need to single quote the argument. " +
+          "Please try again or consult http://rubular.com/ (#{e.message})"
+      end
 
       if result.empty?
         die task, "No instances for regex `#{regexp}', try running `kitchen list'"
@@ -335,24 +371,6 @@ module Kitchen
       ]
     end
 
-    def debug_instance(instance)
-      say "--------"
-      say "Instance: #{instance.name}"
-      say "Driver (#{instance.driver.name}):"
-      instance.driver.config_keys.sort.each do |key|
-        say "    #{key}: #{instance.driver[key].inspect}"
-      end
-      say "Provisioner (#{instance.provisioner.name}):"
-      instance.provisioner.config_keys.sort.each do |key|
-        say "    #{key}: #{instance.provisioner[key].inspect}"
-      end
-      say "Busser (#{instance.busser.name}):"
-      instance.busser.config_keys.sort.each do |key|
-        say "    #{key}: #{instance.busser[key].inspect}"
-      end
-      say ""
-    end
-
     def color_pad(string)
       string + set_color("", :white)
     end

data/lib/kitchen/data_munger.rb

@@ -85,8 +85,9 @@ module Kitchen
 
     def convert_legacy_chef_paths_format!
       data.fetch(:suites, []).each do |suite|
-        %w{data data_bags environments nodes roles}.each do |key|
-          move_chef_data_to_provisioner_at!(suite, "#{key}_path".to_sym)
+        %w{data data_bags encrypted_data_bag_secret_key
+          environments nodes roles}.each do |key|
+            move_chef_data_to_provisioner_at!(suite, "#{key}_path".to_sym)
         end
       end
     end

data/lib/kitchen/diagnostic.rb

@@ -0,0 +1,61 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
+#
+# Copyright (C) 2013, Fletcher Nichol
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'kitchen/util'
+
+module Kitchen
+
+  # Combines and compiles diagnostic information about a Test Kitchen
+  # configuration suitable for support and troubleshooting.
+  #
+  # @author Fletcher Nichol <fnichol@nichol.ca>
+  class Diagnostic
+
+    def initialize(options = {})
+      @loader = options.fetch(:loader, nil)
+      @instances = options.fetch(:instances, [])
+      @result = Hash.new
+    end
+
+    def read
+      prepare_common
+      prepare_loader
+      prepare_instances
+
+      Util.stringified_hash(result)
+    end
+
+    private
+
+    attr_reader :result, :loader, :instances
+
+    def prepare_common
+      result[:timestamp] = Time.now.gmtime
+      result[:kitchen_version] = Kitchen::VERSION
+    end
+
+    def prepare_loader
+      result[:loader] = loader.diagnose if loader
+    end
+
+    def prepare_instances
+      result[:instances] = Hash.new
+      Array(instances).each { |i| result[:instances][i.name] = i.diagnose }
+    end
+  end
+end

data/lib/kitchen/driver/base.rb

@@ -122,6 +122,15 @@ module Kitchen
       #   documented dependency is missing from the system
       def verify_dependencies ; end
 
+      # Returns a Hash of configuration and other useful diagnostic information.
+      #
+      # @return [Hash] a diagnostic hash
+      def diagnose
+        result = Hash.new
+        config_keys.sort.each { |k| result[k] = config[k] }
+        result
+      end
+
       protected
 
       attr_reader :config

data/lib/kitchen/driver/ssh_base.rb

@@ -113,7 +113,9 @@ module Kitchen
       def transfer_path(locals, remote, connection)
         return if locals.nil? || Array(locals).empty?
 
+        info("Transfering files to #{instance.to_str}")
         locals.each { |local| connection.upload_path!(local, remote) }
+        debug("Transfer complete")
       rescue SSHFailed, Net::SSH::Exception => ex
         raise ActionFailed, ex.message
       end

data/lib/kitchen/instance.rb

@@ -193,6 +193,18 @@ module Kitchen
       Kernel.exec(command, *args, options)
     end
 
+    # Returns a Hash of configuration and other useful diagnostic information.
+    #
+    # @return [Hash] a diagnostic hash
+    def diagnose
+      result = Hash.new
+      [:state_file, :driver, :provisioner, :busser].each do |sym|
+        obj = send(sym)
+        result[sym] = obj.respond_to?(:diagnose) ? obj.diagnose : :unknown
+      end
+      result
+    end
+
     def last_action
       state_file.read[:last_action]
     end

data/lib/kitchen/loader/yaml.rb

@@ -62,6 +62,28 @@ module Kitchen
         Util.symbolized_hash(combined_hash)
       end
 
+      # Returns a Hash of configuration and other useful diagnostic information.
+      #
+      # @return [Hash] a diagnostic hash
+      def diagnose
+        result = Hash.new
+        result[:proces_erb] = @process_erb
+        result[:process_local] = @process_local
+        result[:process_global] = @process_global
+        if File.exists?(global_config_file)
+          result[:global_config] =
+            { :filename => global_config_file, :raw_data => global_yaml }
+        end
+        result[:project_config] =
+          { :filename => config_file, :raw_data => yaml }
+        if File.exists?(local_config_file)
+          result[:local_config] =
+            { :filename => local_config_file, :raw_data => local_yaml }
+        end
+        result[:combined_config] = { :raw_data => combined_hash }
+        result
+      end
+
       protected
 
       def default_config_file

data/lib/kitchen/provisioner/base.rb

@@ -72,6 +72,15 @@ module Kitchen
 
       def cleanup_sandbox ; end
 
+      # Returns a Hash of configuration and other useful diagnostic information.
+      #
+      # @return [Hash] a diagnostic hash
+      def diagnose
+        result = Hash.new
+        config_keys.sort.each { |k| result[k] = config[k] }
+        result
+      end
+
       protected
 
       attr_reader :config

data/lib/kitchen/provisioner/chef_base.rb

@@ -62,7 +62,7 @@ module Kitchen
       end
 
       default_config :encrypted_data_bag_secret_key_path do |provisioner|
-        provisioner.calculate_path("encrypted_data_bag_secret", :file)
+        provisioner.calculate_path("encrypted_data_bag_secret_key", :file)
       end
 
       def instance=(instance)
@@ -131,7 +131,8 @@ module Kitchen
       attr_reader :tmpdir
 
       def expand_paths!
-        paths = %w{test_base data data_bags environments nodes roles}
+        paths = %w{test_base data data_bags encrypted_data_bag_secret_key
+          environments nodes roles}
         paths.map{ |p| "#{p}_path".to_sym }.each do |key|
           unless config[key].nil?
             config[key] = File.expand_path(config[key], config[:kitchen_root])
@@ -170,6 +171,7 @@ module Kitchen
       def create_chef_sandbox
         @tmpdir = Dir.mktmpdir("#{instance.name}-sandbox-")
         File.chmod(0755, @tmpdir)
+        info("Preparing files for transfer")
         debug("Creating local sandbox in #{tmpdir}")
 
         yield if block_given?
@@ -278,7 +280,7 @@ module Kitchen
       end
 
       def filter_only_cookbook_files
-        info("Removing non-cookbook files in sandbox")
+        info("Removing non-cookbook files before transfer")
         FileUtils.rm(all_files_in_cookbooks - only_cookbook_files)
       end
 

data/lib/kitchen/state_file.rb

@@ -67,6 +67,16 @@ module Kitchen
       FileUtils.rm_f(file_name) if File.exists?(file_name)
     end
 
+    # Returns a Hash of configuration and other useful diagnostic information.
+    #
+    # @return [Hash] a diagnostic hash
+    def diagnose
+      raw = read
+      result = Hash.new
+      raw.keys.sort.each { |k| result[k] = raw[k] }
+      result
+    end
+
     private
 
     attr_reader :file_name

data/lib/kitchen/version.rb

@@ -18,5 +18,5 @@
 
 module Kitchen
 
-  VERSION = "1.0.0.rc.1"
+  VERSION = "1.0.0.rc.2"
 end

data/spec/kitchen/data_munger_spec.rb

@@ -1260,7 +1260,7 @@ module Kitchen
     describe "legacy chef paths from suite" do
 
       LEGACY_CHEF_PATHS = [:data_path, :data_bags_path, :environments_path,
-        :nodes_path, :roles_path]
+        :nodes_path, :roles_path, :encrypted_data_bag_secret_key_path]
 
       LEGACY_CHEF_PATHS.each do |key|
 

data/templates/init/kitchen.yml.erb

@@ -1,6 +1,9 @@
 ---
-driver: <%= config[:driver_plugin] %>
-provisioner: <%= config[:provisioner] %>
+driver:
+  name: <%= config[:driver_plugin] %>
+
+provisioner:
+  name: <%= config[:provisioner] %>
 
 platforms:
   - name: ubuntu-12.04

data/test-kitchen.gemspec

@@ -9,9 +9,9 @@ Gem::Specification.new do |gem|
   gem.license       = 'Apache 2.0'
   gem.authors       = ['Fletcher Nichol']
   gem.email         = ['fnichol@nichol.ca']
-  gem.description   = %q{A Chef convergence integration test harness}
+  gem.description   = %q{A convergence integration test harness for configuration management systems.}
   gem.summary       = gem.description
-  gem.homepage      = 'https://github.com/opscode/test-kitchen'
+  gem.homepage      = 'https://github.com/test-kitchen/test-kitchen'
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = %w(kitchen)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-kitchen
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc.1
+  version: 1.0.0.rc.2
 platform: ruby
 authors:
 - Fletcher Nichol
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-28 00:00:00.000000000 Z
+date: 2013-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mixlib-shellout
@@ -248,7 +248,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.8'
-description: A Chef convergence integration test harness
+description: A convergence integration test harness for configuration management systems.
 email:
 - fnichol@nichol.ca
 executables:
@@ -270,6 +270,7 @@ files:
 - features/kitchen_driver_create_command.feature
 - features/kitchen_driver_discover_command.feature
 - features/kitchen_init_command.feature
+- features/kitchen_list_command.feature
 - features/sink_command.feature
 - features/step_definitions/gem_steps.rb
 - features/step_definitions/git_steps.rb
@@ -281,6 +282,7 @@ files:
 - lib/kitchen/color.rb
 - lib/kitchen/config.rb
 - lib/kitchen/data_munger.rb
+- lib/kitchen/diagnostic.rb
 - lib/kitchen/driver.rb
 - lib/kitchen/driver/base.rb
 - lib/kitchen/driver/dummy.rb
@@ -349,7 +351,7 @@ files:
 - templates/driver/version.rb.erb
 - templates/init/kitchen.yml.erb
 - test-kitchen.gemspec
-homepage: https://github.com/opscode/test-kitchen
+homepage: https://github.com/test-kitchen/test-kitchen
 licenses:
 - Apache 2.0
 metadata: {}
@@ -372,12 +374,13 @@ rubyforge_project:
 rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
-summary: A Chef convergence integration test harness
+summary: A convergence integration test harness for configuration management systems.
 test_files:
 - features/kitchen_command.feature
 - features/kitchen_driver_create_command.feature
 - features/kitchen_driver_discover_command.feature
 - features/kitchen_init_command.feature
+- features/kitchen_list_command.feature
 - features/sink_command.feature
 - features/step_definitions/gem_steps.rb
 - features/step_definitions/git_steps.rb