test-kitchen 1.0.0.alpha.7 → 1.0.0.beta.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ea78b6f7069f03c81704ff35144fb2946803dea9
+  data.tar.gz: c22d68cbe08ce48169505a07f085da04da60abcf
+SHA512:
+  metadata.gz: 2811c0a0243a3a73570634dac3e2180bf6f53fb561413fb6c180e7c43d5cca7a06aa91624a822121c42a30d45c3e4e758d5d86c501cb5a597cb188e1ace52e20
+  data.tar.gz: fd8dea90199f09311862f7f63c89e8cfa620d18fc622016b9d28f632e42ebd31615fc08fad96e4ed773b9895ab440d389479aa03636d89807de864d05a7d8ae4

data/.travis.yml

@@ -18,3 +18,6 @@ matrix:
   allow_failures:
     - rvm: ruby-head
     - rvm: jruby-19mode
+  exclude:
+    - rvm: 2.0.0
+      env: RUBYGEMS_VERSION=1.8.25

data/CHANGELOG.md

@@ -1,3 +1,39 @@
+## 1.0.0.beta.1 / 2013-07-23
+
+### New features
+
+* Pull request [#128][]: [Breaking] Introduce Provisioners to support chef-client (chef-zero), puppet-apply, and puppet-agent. ([@fnichol][])
+* Pull request [#128][]: Add `chef_zero` provisioner type as an alternative to the iplicit default `chef_solo` provisioner. ([@fnichol][])
+* Pull request [#171][]: Support computed default values for Driver authors (see pull request for light documentation). ([@fnichol][])
+* Pull request [#161][], issue [#129][]: Allow custom paths for roles, data\_bags, and nodes by setting `roles_path`, `data_bags_path`, and `nodes_path`. ([@gondoi][])
+* Pull request [#134][]: Add cross suite helpers. ([@rteabeault][])
+
+### Bug fixes
+
+* Pull request [#122][]: Adding missing sudo calls to busser. ([@adamhjk][])
+* Pull request [#154][], issue [#163][]: Set a more sane default PATH for installing Chef. ([@jtimberman][])
+* Issue [#153][]: Assign Celluloid.logger to Kitchen.logger which won't open a file. ([@fnichol][])
+* Pull request [#155][], issue [#154][]: Setting :on_black when your default terminal text color is black results in unreadable (black on black) text. Or: The NSA censors your VM names when using a terminal with a light background. ([@mconigliaro][])
+* Pull request [#140][]: Make `kitchen init` generator safe to run when given an explicit `:destination_root`. ([@reset][])
+* Pull request [#170][]: Add asterisk to wait_for_sshd argument. ([@saketoba][])
+* Pull request [#136][]: Fixes bundler ref for 1.0. ([@patcon][])
+* Pull request [#142][], issue [#137][]: Require a safe\_yaml release with correct permissions. ([@josephholsten][])
+
+### Improvements
+
+* Pull request [#128][]: Add Driver and Provisioner columns to `kitchen list` output. ([@fnichol][])
+* Pull request [#124][], issue [#132][]: Aggressively filter "non-cookbook" files before uploading to instances. ([@fnichol][])
+* Pull request [#128][]: Suite run_list is no longer required. ([@fnichol][])
+* Pull request [#123][]: Swap cookbook resolution strategy from shell outs to using Ruby APIs. ([@fnichol][])
+* Pull request [#128][]: SSH and SCP commands share a single connection when transfering Chef artifacts to an instance (via the new `Kitchen::SSH` class). ([@fnichol][])
+* Pull request [#128][]: Add more helpful output logging (info and debug) when creating and uploading the sandbox directory of Chef artifacts. ([@fnichol][])
+* Issue [#97][]: Remove red as a candidate instance color. ([@fnichol][])
+* Fix ANSI color codes for bright colors. ([@fnichol][])
+* Pull request [#172][]: [Breaking] Update signature of Driver.required_config block. ([@fnichol][])
+* Pull request [#152][], issue [#151][]: Update the bucket name for Opscode's Bento Boxes. ([@jtimberman][])
+* Pull request [#131][]: Use ssh_args for test_ssh. ([@jonsmorrow][])
+
+
 ## 1.0.0.alpha.7 / 2013-05-23
 
 ### New features
@@ -14,7 +50,7 @@
 * Pull request [#116][]: Require the 'name' attribute is present in `metadata.rb`. ([@sethvargo][])
 * Pull request [#113][]: Handle case where YAML parses as nil. ([@smith][])
 * Pass original exception's backtrace to InstanceFailure and ActionFailed. ([@fnichol][])
-* Fix bug where action failures are swallowed with a nil inside an ensure. ([@fnichol][])
+* Pull request [#112][]: Fix bug where action failures are swallowed with a nil inside an ensure. ([@manul][])
 
 ### Improvements
 
@@ -139,6 +175,7 @@ The initial release.
 [#84]: https://github.com/opscode/test-kitchen/issues/84
 [#90]: https://github.com/opscode/test-kitchen/issues/90
 [#92]: https://github.com/opscode/test-kitchen/issues/92
+[#97]: https://github.com/opscode/test-kitchen/issues/97
 [#98]: https://github.com/opscode/test-kitchen/issues/98
 [#99]: https://github.com/opscode/test-kitchen/issues/99
 [#102]: https://github.com/opscode/test-kitchen/issues/102
@@ -146,22 +183,53 @@ The initial release.
 [#105]: https://github.com/opscode/test-kitchen/issues/105
 [#108]: https://github.com/opscode/test-kitchen/issues/108
 [#111]: https://github.com/opscode/test-kitchen/issues/111
+[#112]: https://github.com/opscode/test-kitchen/issues/112
 [#113]: https://github.com/opscode/test-kitchen/issues/113
 [#114]: https://github.com/opscode/test-kitchen/issues/114
 [#116]: https://github.com/opscode/test-kitchen/issues/116
 [#119]: https://github.com/opscode/test-kitchen/issues/119
 [#120]: https://github.com/opscode/test-kitchen/issues/120
+[#122]: https://github.com/opscode/test-kitchen/issues/122
+[#123]: https://github.com/opscode/test-kitchen/issues/123
+[#124]: https://github.com/opscode/test-kitchen/issues/124
+[#128]: https://github.com/opscode/test-kitchen/issues/128
+[#129]: https://github.com/opscode/test-kitchen/issues/129
+[#131]: https://github.com/opscode/test-kitchen/issues/131
+[#132]: https://github.com/opscode/test-kitchen/issues/132
+[#134]: https://github.com/opscode/test-kitchen/issues/134
+[#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
+[#142]: https://github.com/opscode/test-kitchen/issues/142
+[#151]: https://github.com/opscode/test-kitchen/issues/151
+[#152]: https://github.com/opscode/test-kitchen/issues/152
+[#153]: https://github.com/opscode/test-kitchen/issues/153
+[#154]: https://github.com/opscode/test-kitchen/issues/154
+[#155]: https://github.com/opscode/test-kitchen/issues/155
+[#161]: https://github.com/opscode/test-kitchen/issues/161
+[#163]: https://github.com/opscode/test-kitchen/issues/163
+[#170]: https://github.com/opscode/test-kitchen/issues/170
+[#171]: https://github.com/opscode/test-kitchen/issues/171
+[#172]: https://github.com/opscode/test-kitchen/issues/172
 [@ChrisLundquist]: https://github.com/ChrisLundquist
 [@adamhjk]: https://github.com/adamhjk
 [@arunthampi]: https://github.com/arunthampi
 [@bryanwb]: https://github.com/bryanwb
 [@calavera]: https://github.com/calavera
 [@fnichol]: https://github.com/fnichol
+[@gondoi]: https://github.com/gondoi
 [@grahamc]: https://github.com/grahamc
+[@jonsmorrow]: https://github.com/jonsmorrow
+[@josephholsten]: https://github.com/josephholsten
 [@jtimberman]: https://github.com/jtimberman
+[@manul]: https://github.com/manul
 [@mattray]: https://github.com/mattray
+[@mconigliaro]: https://github.com/mconigliaro
+[@patcon]: https://github.com/patcon
 [@reset]: https://github.com/reset
+[@rteabeault]: https://github.com/rteabeault
+[@saketoba]: https://github.com/saketoba
 [@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/README.md

@@ -1,6 +1,6 @@
 # Test Kitchen
 
-[![Build Status](https://secure.travis-ci.org/opscode/test-kitchen.png?branch=1.0)](https://travis-ci.org/opscode/test-kitchen)
+[![Build Status](https://secure.travis-ci.org/opscode/test-kitchen.png?branch=master)](https://travis-ci.org/opscode/test-kitchen)
 [![Code Climate](https://codeclimate.com/github/opscode/test-kitchen.png)](https://codeclimate.com/github/opscode/test-kitchen)
 
 A convergence integration test harness for configuration management systems.
@@ -15,7 +15,7 @@ In your `Gemfile`, add `test-kitchen` as a
 dependency:
 
 ```ruby
-gem 'test-kitchen', git: 'git://github.com/opscode/test-kitchen.git', branch: '1.0'
+gem 'test-kitchen', '~> 1.0.0.alpha'
 ```
 
 and run the `bundle` command to install:

data/Rakefile

@@ -16,7 +16,13 @@ end
 desc "Run all test suites"
 task :test => [:unit, :features]
 
-task :default => [:test]
+desc "Display LOC stats"
+task :stats do
+  puts "\n## Production Code Stats"
+  sh "countloc -r lib/kitchen lib/kitchen.rb"
+  puts "\n## Test Code Stats"
+  sh "countloc -r spec features"
+end
 
 unless RUBY_ENGINE == 'jruby'
   require 'cane/rake_task'
@@ -29,6 +35,7 @@ unless RUBY_ENGINE == 'jruby'
       Kitchen::ThorTasks#define
       Kitchen::CLI#pry_prompts
       Kitchen::Instance#synchronize_or_call
+      Kitchen::Driver::SSHBase#converge
     )
     cane.style_exclude = %w(
       lib/vendor/hash_recursive_merge.rb
@@ -58,15 +65,11 @@ unless RUBY_ENGINE == 'jruby'
     end
   end
 
-  Rake::Task[:default].enhance [:cane, :tailor]
-end
-
-desc "Display LOC stats"
-task :stats do
-  puts "\n## Production Code Stats"
-  sh "countloc -r lib/kitchen lib/kitchen.rb"
-  puts "\n## Test Code Stats"
-  sh "countloc -r spec features"
+  desc "Run all quality tasks"
+  task :quality => [:cane, :tailor, :stats]
+else
+  desc "Run all quality tasks"
+  task :quality => [:stats]
 end
 
-Rake::Task[:default].enhance [:stats]
+task :default => [:test, :quality]

data/lib/kitchen.rb

@@ -26,8 +26,9 @@ require 'kitchen/logging'
 require 'kitchen/shell_out'
 require 'kitchen/util'
 
+require 'kitchen/provisioner'
+require 'kitchen/provisioner/base'
 require 'kitchen/busser'
-require 'kitchen/chef_data_uploader'
 require 'kitchen/color'
 require 'kitchen/collection'
 require 'kitchen/config'
@@ -41,9 +42,13 @@ require 'kitchen/manager'
 require 'kitchen/metadata_chopper'
 require 'kitchen/platform'
 require 'kitchen/state_file'
+require 'kitchen/ssh'
 require 'kitchen/suite'
 require 'kitchen/version'
 
+# Test Kitchen base module.
+#
+# @author Fletcher Nichol <fnichol@nichol.ca>
 module Kitchen
 
   class << self
@@ -91,7 +96,7 @@ end
 
 # Initialize the base logger and use that for Celluloid's logger
 Kitchen.logger = Kitchen.default_logger
-Celluloid.logger = Kitchen.celluloid_file_logger
+Celluloid.logger = Kitchen.logger
 
 # Setup a collection of instance crash exceptions for error reporting
 Kitchen.crashes = []

data/lib/kitchen/busser.rb

@@ -80,7 +80,8 @@ module Kitchen
         <<-INSTALL_CMD.gsub(/^ {10}/, '')
           bash -c '
           #{sudo}#{busser_bin} suite cleanup
-          #{local_suite_files.map { |f| stream_file(f, remote_file(f)) }.join}'
+          #{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
       end
     end
@@ -103,7 +104,14 @@ module Kitchen
     DEFAULT_TEST_ROOT = File.join(Dir.pwd, "test/integration").freeze
 
     def validate_options(suite_name)
-      raise ClientError, "Busser#new requires a suite_name" if suite_name.nil?
+      if suite_name.nil?
+        raise ClientError, "Busser#new requires a suite_name"
+      end
+
+      if suite_name == 'helper'
+        raise UserError,
+          "Suite name invalid: 'helper' is a reserved directory name."
+      end
     end
 
     def plugins
@@ -118,9 +126,13 @@ module Kitchen
       end
     end
 
-    def remote_file(file)
-      local_prefix = File.join(test_root, @suite_name)
-      "$(#{busser_bin} suite path)/".concat(file.sub(%r{^#{local_prefix}/}, ''))
+    def helper_files
+      Dir.glob(File.join(test_root, "helpers", "*/**/*"))
+    end
+
+    def remote_file(file, dir)
+      local_prefix = File.join(test_root, dir)
+      "$(#{sudo}#{busser_bin} suite path)/".concat(file.sub(%r{^#{local_prefix}/}, ''))
     end
 
     def stream_file(local_path, remote_path)
@@ -128,7 +140,7 @@ module Kitchen
       md5 = Digest::MD5.hexdigest(local_file)
       perms = sprintf("%o", File.stat(local_path).mode)[2, 4]
       stream_cmd = [
-        busser_bin,
+        "#{sudo}#{busser_bin}",
         "deserialize",
         "--destination=#{remote_path}",
         "--md5sum=#{md5}",
@@ -137,7 +149,7 @@ module Kitchen
 
       <<-STREAMFILE.gsub(/^ {8}/, '')
         echo "Uploading #{remote_path} (mode=#{perms})"
-        cat <<"__EOFSTREAM__" | #{sudo}#{stream_cmd}
+        #{sudo}cat <<"__EOFSTREAM__" | #{sudo}#{stream_cmd}
         #{Base64.encode64(local_file)}
         __EOFSTREAM__
       STREAMFILE

data/lib/kitchen/cli.rb

@@ -40,6 +40,7 @@ module Kitchen
       super
       $stdout.sync = true
       Kitchen.logger = Kitchen.default_file_logger
+      Celluloid.logger = Kitchen.celluloid_file_logger
       @config = Kitchen::Config.new(
         :loader     => Kitchen::Loader::YAML.new(ENV['KITCHEN_YAML']),
         :log_level  => ENV['KITCHEN_LOG'] && ENV['KITCHEN_LOG'].downcase.to_sym,
@@ -55,11 +56,7 @@ module Kitchen
       if options[:bare]
         say Array(result).map { |i| i.name }.join("\n")
       else
-        table = [
-          [set_color("Instance", :green), set_color("Last Action", :green)]
-        ]
-        table += Array(result).map { |i| display_instance(i) }
-        print_table(table)
+        list_table(result)
       end
     end
 
@@ -318,8 +315,30 @@ module Kitchen
       end
     end
 
+    def list_table(result)
+      table = [
+        [set_color("Instance", :green), set_color("Driver", :green),
+          set_color("Provisioner", :green), set_color("Last Action", :green)]
+      ]
+      table += Array(result).map { |i| display_instance(i) }
+      print_table(table)
+    end
+
     def display_instance(instance)
-      action = case instance.last_action
+      [
+        color_pad(instance.name),
+        color_pad(instance.driver.name),
+        color_pad(format_provisioner(instance.driver[:provisioner])),
+        format_last_action(instance.last_action)
+      ]
+    end
+
+    def color_pad(string)
+      string + set_color("", :white)
+    end
+
+    def format_last_action(last_action)
+      case last_action
       when 'create' then set_color("Created", :cyan)
       when 'converge' then set_color("Converged", :magenta)
       when 'setup' then set_color("Set Up", :blue)
@@ -327,7 +346,10 @@ module Kitchen
       when nil then set_color("<Not Created>", :red)
       else set_color("<Unknown>", :white)
       end
-      [set_color(instance.name, :on_black), action]
+    end
+
+    def format_provisioner(name)
+      name.split('_').map { |word| word.capitalize }.join(' ')
     end
 
     def update_config!

data/lib/kitchen/color.rb

@@ -28,14 +28,14 @@ module Kitchen
     ANSI = {
       :reset => 0, :black => 30, :red => 31, :green => 32, :yellow => 33,
       :blue => 34, :magenta => 35, :cyan => 36, :white => 37,
-      :bright_black => 30, :bright_red => 31, :bright_green => 32,
-      :bright_yellow => 33, :bright_blue => 34, :bright_magenta => 35,
-      :bright_cyan => 36, :bright_white => 37
+      :bright_black => 90, :bright_red => 91, :bright_green => 92,
+      :bright_yellow => 93, :bright_blue => 94, :bright_magenta => 95,
+      :bright_cyan => 96, :bright_white => 97
     }.freeze
 
     COLORS = %w(
-      cyan yellow green magenta red blue bright_cyan bright_yellow
-      bright_green bright_magenta bright_red bright_blue
+      cyan yellow green magenta blue bright_cyan bright_yellow
+      bright_green bright_magenta bright_blue
     ).freeze
 
     # Returns an ansi escaped string representing a color control sequence.

data/lib/kitchen/config.rb

@@ -37,6 +37,9 @@ module Kitchen
     # Default driver plugin to use
     DEFAULT_DRIVER_PLUGIN = "dummy".freeze
 
+    # Default provisioner to use
+    DEFAULT_PROVISIONER = "chef_solo".freeze
+
     # Default base path which may contain `data_bags/` directories
     DEFAULT_TEST_BASE_PATH = File.join(Dir.pwd, 'test/integration').freeze
 
@@ -94,8 +97,9 @@ module Kitchen
 
     def new_suite(hash)
       path_hash = {
-        :data_bags_path => calculate_path("data_bags", hash[:name]),
-        :roles_path     => calculate_path("roles", hash[:name]),
+        :data_bags_path => calculate_path("data_bags", hash[:name], hash[:data_bags_path]),
+        :roles_path     => calculate_path("roles", hash[:name], hash[:roles_path]),
+        :nodes_path     => calculate_path("nodes", hash[:name], hash[:nodes_path]),
       }
 
       Suite.new(hash.rmerge(path_hash))
@@ -108,6 +112,7 @@ module Kitchen
     def new_driver(hash)
       hash[:driver_config] ||= Hash.new
       hash[:driver_config][:kitchen_root] = kitchen_root
+      hash[:driver_config][:provisioner] = hash[:provisioner]
 
       Driver.for_plugin(hash[:driver_plugin], hash[:driver_config])
     end
@@ -126,13 +131,38 @@ module Kitchen
     def new_instance(suite, platform, index)
       platform_hash = platform_driver_hash(platform.name)
       driver = new_driver(merge_driver_hash(platform_hash))
+      provisioner = driver[:provisioner]
 
-      Instance.new(
-        :suite    => suite,
-        :platform => platform,
+      instance = Instance.new(
+        :suite    => extend_suite(suite, provisioner),
+        :platform => extend_platform(platform, provisioner),
         :driver   => driver,
         :logger   => new_instance_logger(index)
       )
+      extend_instance(instance, provisioner)
+    end
+
+    def extend_suite(suite, provisioner)
+      case provisioner.to_s.downcase
+      when /^chef_/ then suite.dup.extend(Suite::Cheflike)
+      when /^puppet_/ then suite.dup.extend(Suite::Puppetlike)
+      else suite.dup
+      end
+    end
+
+    def extend_platform(platform, provisioner)
+      case provisioner.to_s.downcase
+      when /^chef_/ then platform.dup.extend(Platform::Cheflike)
+      else platform.dup
+      end
+    end
+
+    def extend_instance(instance, provisioner)
+      case provisioner.to_s.downcase
+      when /^chef_/ then instance.extend(Instance::Cheflike)
+      when /^puppet_/ then instance.extend(Instance::Puppetlike)
+      else instance
+      end
     end
 
     def actor_registry(instance)
@@ -171,7 +201,9 @@ module Kitchen
     def platform_driver_hash(platform_name)
       h = data[:platforms].find { |p| p[:name] == platform_name } || Hash.new
 
-      h.select { |key, value| [:driver_plugin, :driver_config].include?(key) }
+      h.select do |key, value|
+        [:driver_plugin, :driver_config, :provisioner].include?(key)
+      end
     end
 
     def new_instance_logger(index)
@@ -194,12 +226,15 @@ module Kitchen
       default_driver_hash.rmerge(common_driver_hash.rmerge(driver_hash))
     end
 
-    def calculate_path(path, suite_name)
+    def calculate_path(path, suite_name, local_path)
+      custom_path     = File.join(kitchen_root, local_path) if local_path
       suite_path      = File.join(test_base_path, suite_name, path)
       common_path     = File.join(test_base_path, path)
       top_level_path  = File.join(Dir.pwd, path)
 
-      if File.directory?(suite_path)
+      if custom_path and File.directory?(custom_path)
+        custom_path
+      elsif File.directory?(suite_path)
         suite_path
       elsif File.directory?(common_path)
         common_path
@@ -211,12 +246,16 @@ module Kitchen
     end
 
     def default_driver_hash
-      { :driver_plugin => DEFAULT_DRIVER_PLUGIN, :driver_config => {} }
+      {
+        :driver_plugin  => DEFAULT_DRIVER_PLUGIN,
+        :driver_config  => {},
+        :provisioner    => DEFAULT_PROVISIONER
+      }
     end
 
     def common_driver_hash
       data.select do |key, value|
-        [:driver_plugin, :driver_config].include?(key)
+        [:driver_plugin, :driver_config, :provisioner].include?(key)
       end
     end
   end