test-kitchen 1.0.0.alpha.2 → 1.0.0.alpha.3

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## 1.0.0.alpha.3 / 2013-04-05
+
+### Bug fixes
+
+* Fix :require_chef_omnibus driver_config option to eliminate re-installation (@fnichol)
+* Remove implicit Bundler dependency in `kitchen init`. (@fnichol)
+
+### New features
+
+* Add --auto-init flag to `kitchen test` (default: false) (@fnichol)
+
+### Improvements
+
+* Update base box URLs. (@fnichol)
+* Extract .kitchen.yml to an ERB template & update box URLs. (@fnichol)
+* Add more spec coverage. (@fnichol)
+
+
 ## 1.0.0.alpha.2 / 2013-03-28
 
 ### Bug fixes
@@ -49,4 +67,4 @@ The initial release.
 [@ChrisLundquist]: https://github.com/ChrisLundquist
 [@fnichol]: https://github.com/fnichol
 [@mattray]: https://github.com/mattray
-[@reset]: https://github.com/reset
+[@reset]: https://github.com/reset

data/features/kitchen_init_command.feature

@@ -104,7 +104,6 @@ Feature: Add Test Kitchen support to an existing project
     """
     suites:
     - name: default
-      run_list:
-      - recipe[ntp]
+      run_list: ["recipe[ntp]"]
       attributes: {}
     """

data/lib/kitchen/cli.rb

@@ -92,6 +92,8 @@ module Kitchen
       :desc => "Set the log level (debug, info, warn, error, fatal)"
     method_option :destroy, :aliases => "-d", :default => "passing",
       :desc => "Destroy strategy to use after testing (passing, always, never)."
+    method_option :auto_init, :type => :boolean, :default => false,
+      :desc => "Invoke init command if .kitchen.yml is missing"
     def test(*args)
       if ! %w{passing always never}.include?(options[:destroy])
         raise ArgumentError, "Destroy mode must be passing, always, or never."
@@ -100,6 +102,7 @@ module Kitchen
       update_config!
       banner "Starting Kitchen"
       elapsed = Benchmark.measure do
+        ensure_initialized
         destroy_mode = options[:destroy].to_sym
         @task = :test
         results = parse_subcommand(args.first)
@@ -311,6 +314,15 @@ module Kitchen
       exit 1
     end
 
+    def ensure_initialized
+      yaml = ENV['KITCHEN_YAML'] || '.kitchen.yml'
+
+      if options[:auto_init] && ! File.exists?(yaml)
+        banner "Invoking init as '#{yaml}' file is missing"
+        invoke "init"
+      end
+    end
+
     def pry_prompts
       [
         proc { |target_self, nest_level, pry|

data/lib/kitchen/color.rb

@@ -18,7 +18,13 @@
 
 module Kitchen
 
+  # Utility methods to help ouput colorized text in a terminal. The
+  # implementation is a compressed mashup of code from the Thor and Foreman
+  # projects.
+  #
+  # @author Fletcher Nichol <fnichol@nichol.ca>
   module Color
+
     ANSI = {
       :reset => 0, :black => 30, :red => 31, :green => 32, :yellow => 33,
       :blue => 34, :magenta => 35, :cyan => 36, :white => 37,
@@ -32,12 +38,25 @@ module Kitchen
       bright_green bright_magenta bright_red bright_blue
     ).freeze
 
+    # Returns an ansi escaped string representing a color control sequence.
+    #
+    # @param name [Symbol] a valid color representation, taken from
+    #   Kitchen::Color::ANSI
+    # @return [String] an ansi escaped string if the color is valid and an
+    #   empty string otherwise
     def self.escape(name)
       return "" if name.nil?
       return "" unless ansi = ANSI[name]
       "\e[#{ansi}m"
     end
 
+    # Returns a colorized ansi escaped string with the given color.
+    #
+    # @param str [String] a string to colorize
+    # @param name [Symbol] a valid color representation, taken from
+    #   Kitchen::Color::ANSI
+    # @return [String] an ansi escaped string if the color is valid and an
+    #   unescaped string otherwise
     def self.colorize(str, name)
       color = escape(name)
       color.empty? ? str : "#{color}#{str}#{escape(:reset)}"

data/lib/kitchen/driver.rb

@@ -16,6 +16,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'thor/util'
+
 module Kitchen
 
   module Driver
@@ -25,17 +27,18 @@ module Kitchen
     # @param plugin [String] a driver plugin type, which will be constantized
     # @return [Driver::Base] a driver instance
     # @raise [ClientError] if a driver instance could not be created
+    # @raise [UserError] if the driver's dependencies could not be met
     def self.for_plugin(plugin, config)
       first_load = require("kitchen/driver/#{plugin}")
 
-      str_const = Util.to_camel_case(plugin)
+      str_const = Thor::Util.camel_case(plugin)
       klass = self.const_get(str_const)
       object = klass.new(config)
       object.verify_dependencies if first_load
       object
     rescue UserError
       raise
-    rescue LoadError
+    rescue LoadError, NameError
       raise ClientError, "Could not require '#{plugin}' plugin from load path"
     end
   end

data/lib/kitchen/driver/base.rb

@@ -16,6 +16,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'thor/util'
+
 module Kitchen
 
   module Driver
@@ -139,7 +141,7 @@ module Kitchen
       def run_command(cmd, options = {})
         base_options = {
           :use_sudo => config[:use_sudo],
-          :log_subject => Util.to_snake_case(self.class.to_s)
+          :log_subject => Thor::Util.snake_case(self.class.to_s)
         }.merge(options)
         super(cmd, base_options)
       end

data/lib/kitchen/driver/ssh_base.rb

@@ -108,7 +108,7 @@ module Kitchen
         ssh(ssh_args, <<-INSTALL.gsub(/^ {10}/, ''))
           should_update_chef() {
             case "#{flag}" in
-              $(chef-solo --v | awk "{print \$2}")) return 1 ;;
+              true|$(chef-solo -v | cut -d " " -f 2)) return 1 ;;
               latest|*) return 0 ;;
             esac
           }

data/lib/kitchen/generator/init.rb

@@ -44,7 +44,9 @@ module Kitchen
         D
 
       def init
-        create_file ".kitchen.yml", default_yaml
+        self.class.source_root(Kitchen.source_root.join("templates", "plugin"))
+
+        create_kitchen_yaml
 
         rakedoc = <<-RAKE.gsub(/^ {10}/, '')
 
@@ -81,7 +83,7 @@ module Kitchen
 
       private
 
-      def default_yaml
+      def create_kitchen_yaml
         cookbook_name = if File.exists?(File.expand_path('metadata.rb'))
           MetadataChopper.extract('metadata.rb').first
         else
@@ -90,34 +92,10 @@ module Kitchen
         run_list = cookbook_name ? "recipe[#{cookbook_name}]" : nil
         driver_plugin = Array(options[:driver]).first || 'dummy'
 
-        { 'driver_plugin' => driver_plugin.sub(/^kitchen-/, ''),
-          'platforms' => platforms_hash,
-          'suites' => [
-            { 'name' => 'default',
-              'run_list' => Array(run_list),
-              'attributes' => Hash.new
-            },
-          ]
-        }.to_yaml
-      end
-
-      def platforms_hash
-        url_base = "https://opscode-vm.s3.amazonaws.com/vagrant/boxes"
-        platforms = [
-          { :n => 'ubuntu', :vers => %w(12.04 10.04), :rl => "recipe[apt]" },
-          { :n => 'centos', :vers => %w(6.3 5.8), :rl => "recipe[yum::epel]" },
-        ]
-        platforms = platforms.map do |p|
-          p[:vers].map do |v|
-            { 'name' => "#{p[:n]}-#{v}",
-              'driver_config' => {
-                'box' => "opscode-#{p[:n]}-#{v}",
-                'box_url' => "#{url_base}/opscode-#{p[:n]}-#{v}.box"
-              },
-              'run_list' => Array(p[:rl])
-            }
-          end
-        end.flatten
+        template("kitchen.yml.erb", ".kitchen.yml", {
+          :driver_plugin => driver_plugin.sub(/^kitchen-/, ''),
+          :run_list => Array(run_list)
+        })
       end
 
       def init_rakefile?
@@ -183,7 +161,7 @@ module Kitchen
       end
 
       def install_gem(driver_gem)
-        Bundler.with_clean_env do
+        unbundlerize do
           run "gem install #{driver_gem}"
         end
       end
@@ -191,6 +169,14 @@ module Kitchen
       def not_in_file?(filename, regexp)
         IO.readlines(filename).grep(regexp).empty?
       end
+
+      def unbundlerize
+        keys = %w[BUNDLER_EDITOR BUNDLE_BIN_PATH BUNDLE_GEMFILE RUBYOPT]
+
+        keys.each { |key| ENV["__#{key}"] = ENV[key] ; ENV.delete(key) }
+        yield
+        keys.each { |key| ENV[key] = ENV.delete("__#{key}") }
+      end
     end
   end
 end

data/lib/kitchen/generator/new_plugin.rb

@@ -17,6 +17,7 @@
 # limitations under the License.
 
 require 'thor/group'
+require 'thor/util'
 
 module Kitchen
 
@@ -42,8 +43,8 @@ module Kitchen
         @plugin_name = plugin_name
         @gem_name = "kitchen-#{plugin_name}"
         @gemspec = "#{gem_name}.gemspec"
-        @klass_name = Util.to_camel_case(plugin_name)
-        @constant = Util.to_snake_case(plugin_name).upcase
+        @klass_name = ::Thor::Util.camel_case(plugin_name)
+        @constant = ::Thor::Util.snake_case(plugin_name).upcase
         @license = options[:license]
         @author = %x{git config user.name}.chomp
         @email = %x{git config user.email}.chomp

data/lib/kitchen/util.rb

@@ -20,26 +20,30 @@ module Kitchen
 
   # Stateless utility methods used in different contexts. Essentially a mini
   # PassiveSupport library.
+  #
+  # @author Fletcher Nichol <fnichol@nichol.ca>
   module Util
 
-    def self.to_camel_case(str)
-      str.split('_').map { |w| w.capitalize }.join
-    end
-
-    def self.to_snake_case(str)
-      str.split('::').
-        last.
-        gsub(/([A-Z+])([A-Z][a-z])/, '\1_\2').
-        gsub(/([a-z\d])([A-Z])/, '\1_\2').
-        downcase
-    end
-
+    # Returns the standard library Logger level constants for a given symbol
+    # representation.
+    #
+    # @param symbol [Symbol] symbol representation of a logger level (:debug,
+    #   :info, :warn, :error, :fatal)
+    # @return [Integer] Logger::Severity constant value or nil if input is not
+    #   valid
     def self.to_logger_level(symbol)
       return nil unless [:debug, :info, :warn, :error, :fatal].include?(symbol)
 
       Logger.const_get(symbol.to_s.upcase)
     end
 
+    # Returns the symbol represenation of a logging levels for a given
+    # standard library Logger::Severity constant.
+    #
+    # @param const [Integer] Logger::Severity constant value for a logging
+    #   level (Logger::DEBUG, Logger::INFO, Logger::WARN, Logger::ERROR,
+    #   Logger::FATAL)
+    # @return [Symbol] symbol representation of the logging level
     def self.from_logger_level(const)
       case const
       when Logger::DEBUG then :debug
@@ -50,6 +54,13 @@ module Kitchen
       end
     end
 
+    # Returns a new Hash with all key values coerced to symbols. All keys
+    # within a Hash are coerced by calling #to_sym and hashes within arrays
+    # and other hashes are traversed.
+    #
+    # @param obj [Object] the hash to be processed. While intended for
+    #   hashes, this method safely processes arbitrary objects
+    # @return [Object] a converted hash with all keys as symbols
     def self.symbolized_hash(obj)
       if obj.is_a?(Hash)
         obj.inject({}) { |h, (k, v)| h[k.to_sym] = symbolized_hash(v) ; h }
@@ -60,16 +71,27 @@ module Kitchen
       end
     end
 
+    # Returns a new Hash with all key values coerced to strings. All keys
+    # within a Hash are coerced by calling #to_s and hashes with arrays
+    # and other hashes are traversed.
+    #
+    # @param obj [Object] the hash to be processed. While intended for
+    #   hashes, this method safely processes arbitrary objects
+    # @return [Object] a converted hash with all keys as strings
     def self.stringified_hash(obj)
       if obj.is_a?(Hash)
-        obj.inject({}) { |h, (k, v)| h[k.to_s] = symbolized_hash(v) ; h }
+        obj.inject({}) { |h, (k, v)| h[k.to_s] = stringified_hash(v) ; h }
       elsif obj.is_a?(Array)
-        obj.inject([]) { |a, v| a << symbolized_hash(v) ; a }
+        obj.inject([]) { |a, v| a << stringified_hash(v) ; a }
       else
         obj
       end
     end
 
+    # Returns a formatted string representing a duration in seconds.
+    #
+    # @param total [Integer] the total number of seconds
+    # @return [String] a formatted string of the form (XmYY.00s)
     def self.duration(total)
       minutes = (total / 60).to_i
       seconds = (total - (minutes * 60))

data/lib/kitchen/version.rb

@@ -18,5 +18,5 @@
 
 module Kitchen
 
-  VERSION = "1.0.0.alpha.2"
+  VERSION = "1.0.0.alpha.3"
 end

data/spec/kitchen/driver_spec.rb

@@ -0,0 +1,111 @@
+# -*- 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_relative '../spec_helper'
+
+require 'kitchen/errors'
+require 'kitchen/logging'
+require 'kitchen/shell_out'
+require 'kitchen/driver'
+require 'kitchen/driver/base'
+
+module Kitchen
+
+  module Driver
+
+    class Coolbeans < Kitchen::Driver::Base
+    end
+
+    class ItDepends < Kitchen::Driver::Base
+
+      attr_reader :verify_call_count
+
+      def initialize(config = {})
+        @verify_call_count = 0
+        super
+      end
+
+      def verify_dependencies
+        @verify_call_count += 1
+      end
+    end
+
+    class UnstableDepends < Kitchen::Driver::Base
+
+      def verify_dependencies
+        raise UserError, "Oh noes, you don't have software!"
+      end
+    end
+  end
+end
+
+describe Kitchen::Driver do
+
+  describe ".for_plugin" do
+
+    before do
+      Kitchen::Driver.stubs(:require).returns(true)
+    end
+
+    it "returns a driver object of the correct class" do
+      driver = Kitchen::Driver.for_plugin('coolbeans', {})
+
+      driver.must_be_kind_of Kitchen::Driver::Coolbeans
+    end
+
+    it "returns a driver initialized with its config" do
+      driver = Kitchen::Driver.for_plugin('coolbeans', { :jelly => 'beans' })
+
+      driver[:jelly].must_equal 'beans'
+    end
+
+    it "calls #verify_dependencies on the driver object" do
+      driver = Kitchen::Driver.for_plugin('it_depends', {})
+
+      driver.verify_call_count.must_equal 1
+    end
+
+    it "calls #verify_dependencies once per driver require" do
+      Kitchen::Driver.stubs(:require).returns(true, false)
+      driver1 = Kitchen::Driver.for_plugin('it_depends', {})
+      driver1.verify_call_count.must_equal 1
+      driver2 = Kitchen::Driver.for_plugin('it_depends', {})
+
+      driver2.verify_call_count.must_equal 0
+    end
+
+    it "raises ClientError if the driver could not be required" do
+      Kitchen::Driver.stubs(:require).raises(LoadError)
+
+      proc { Kitchen::Driver.for_plugin('coolbeans', {}) }.
+        must_raise Kitchen::ClientError
+    end
+
+    it "raises ClientError if the driver's class constant could not be found" do
+      Kitchen::Driver.stubs(:require).returns(true) # pretend require worked
+
+      proc { Kitchen::Driver.for_plugin('nope', {}) }.
+        must_raise Kitchen::ClientError
+    end
+
+    it "raises UserError if #verify_dependencies fails" do
+      proc { Kitchen::Driver.for_plugin('unstable_depends', {}) }.
+        must_raise Kitchen::UserError
+    end
+  end
+end

data/spec/kitchen/util_spec.rb

@@ -0,0 +1,103 @@
+# -*- 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_relative '../spec_helper'
+
+require 'logger'
+
+require 'kitchen/util'
+
+describe Kitchen::Util do
+
+  describe '.to_logger_level' do
+
+    it "returns nil for invalid symbols" do
+      Kitchen::Util.to_logger_level(:nope).must_be_nil
+    end
+
+    %w{debug info warn error fatal}.each do |level|
+      it "returns Logger::#{level.upcase} for :#{level} input" do
+        Kitchen::Util.to_logger_level(level.to_sym).
+          must_equal Logger.const_get(level.upcase)
+      end
+    end
+  end
+
+  describe ".from_logger_level" do
+
+    it "returns :fatal for invalid symbols" do
+      Kitchen::Util.from_logger_level("nope").must_equal :fatal
+    end
+
+    %w{debug info warn error fatal}.each do |level|
+      it "returns :#{level} for Logger::#{level.upcase} input" do
+        Kitchen::Util.from_logger_level(Logger.const_get(level.upcase)).
+          must_equal(level.to_sym)
+      end
+    end
+  end
+
+  describe ".symbolized_hash" do
+
+    it "returns itself if not a hash" do
+      obj = Object.new
+      Kitchen::Util.symbolized_hash(obj).must_equal obj
+    end
+
+    it "preserves a symbolized hash" do
+      hash = { :one => [{ :two => "three" }] }
+      Kitchen::Util.symbolized_hash(hash).must_equal hash
+    end
+
+    it "converts string keys into symbols" do
+      Kitchen::Util.
+        symbolized_hash({ "one" => [{ "two" => :three, :four => "five" }] }).
+        must_equal({ :one => [{ :two => :three, :four => "five" }] })
+    end
+  end
+
+  describe ".stringified_hash" do
+
+    it "returns itself if not a hash" do
+      obj = Object.new
+      Kitchen::Util.stringified_hash(obj).must_equal obj
+    end
+
+    it "preserves a stringified hash" do
+      hash = { "one" => [{ "two" => "three" }] }
+      Kitchen::Util.stringified_hash(hash).must_equal hash
+    end
+
+    it "converts symbol keys into strings" do
+      Kitchen::Util.
+        stringified_hash({ :one => [{ :two => :three, "four" => "five" }] }).
+        must_equal({ "one" => [{ "two" => :three, "four" => "five" }] })
+    end
+  end
+
+  describe ".duration" do
+
+    it "formats seconds to 2 digits" do
+      Kitchen::Util.duration(60).must_equal "(1m0.00s)"
+    end
+
+    it "formats large values into minutes and seconds" do
+      Kitchen::Util.duration(48033).must_equal "(800m33.00s)"
+    end
+  end
+end

data/templates/plugin/kitchen.yml.erb

@@ -0,0 +1,26 @@
+---
+driver_plugin: <%= config[:driver_plugin] %>
+
+platforms:
+- name: ubuntu-12.04
+  driver_config:
+    box: canonical-ubuntu-12.04
+    box_url: http://cloud-images.ubuntu.com/vagrant/precise/current/precise-server-cloudimg-amd64-vagrant-disk1.box
+    require_chef_omnibus: true
+- name: ubuntu-10.04
+  driver_config:
+    box: opscode-ubuntu-10.04
+    box_url: http://opscode-vm.s3.amazonaws.com/vagrant/opscode_ubuntu-10.04_chef-11.2.0.box
+- name: centos-6.3
+  driver_config:
+    box: opscode-centos-6.3
+    box_url: http://opscode-vm.s3.amazonaws.com/vagrant/opscode_centos-6.3_chef-11.2.0.box
+- name: centos-5.8
+  driver_config:
+    box: opscode-centos-5.8
+    box_url: http://opscode-vm.s3.amazonaws.com/vagrant/opscode_centos-5.8_chef-11.2.0.box
+
+suites:
+- name: default
+  run_list: <%= config[:run_list].inspect %>
+  attributes: {}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: test-kitchen
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha.2
+  version: 1.0.0.alpha.3
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-29 00:00:00.000000000 Z
+date: 2013-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: celluloid
@@ -372,13 +372,16 @@ files:
 - spec/kitchen/color_spec.rb
 - spec/kitchen/config_spec.rb
 - spec/kitchen/driver/dummy_spec.rb
+- spec/kitchen/driver_spec.rb
 - spec/kitchen/instance_spec.rb
 - spec/kitchen/loader/yaml_spec.rb
 - spec/kitchen/platform_spec.rb
 - spec/kitchen/state_file_spec.rb
 - spec/kitchen/suite_spec.rb
+- spec/kitchen/util_spec.rb
 - spec/spec_helper.rb
 - templates/plugin/driver.rb.erb
+- templates/plugin/kitchen.yml.erb
 - templates/plugin/license_apachev2.erb
 - templates/plugin/license_gplv2.erb
 - templates/plugin/license_gplv3.erb
@@ -421,10 +424,12 @@ test_files:
 - spec/kitchen/color_spec.rb
 - spec/kitchen/config_spec.rb
 - spec/kitchen/driver/dummy_spec.rb
+- spec/kitchen/driver_spec.rb
 - spec/kitchen/instance_spec.rb
 - spec/kitchen/loader/yaml_spec.rb
 - spec/kitchen/platform_spec.rb
 - spec/kitchen/state_file_spec.rb
 - spec/kitchen/suite_spec.rb
+- spec/kitchen/util_spec.rb
 - spec/spec_helper.rb
 has_rdoc: