test-kitchen 0.7.0 → 1.0.0.alpha.0

data/lib/kitchen/suite.rb

@@ -0,0 +1,76 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
+#
+# Copyright (C) 2012, 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.
+
+module Kitchen
+
+  # A Chef run_list and attribute hash that will be used in a convergence
+  # integration.
+  #
+  # @author Fletcher Nichol <fnichol@nichol.ca>
+  class Suite
+
+    # @return [String] logical name of this suite
+    attr_reader :name
+
+    # @return [Array] Array of Chef run_list items
+    attr_reader :run_list
+
+    # @return [Hash] Hash of Chef node attributes
+    attr_reader :attributes
+
+    # @return [Array] Array of names of excluded platforms
+    attr_reader :excludes
+
+    # @return [String] local path to the suite's data bags, or nil if one does
+    #   not exist
+    attr_reader :data_bags_path
+
+    # @return [String] local path to the suite's roles, or nil if one does
+    #   not exist
+    attr_reader :roles_path
+
+    # Constructs a new suite.
+    #
+    # @param [Hash] options configuration for a new suite
+    # @option options [String] :name logical name of this suit (**Required**)
+    # @option options [String] :run_list Array of Chef run_list items
+    #   (**Required**)
+    # @option options [Hash] :attributes Hash of Chef node attributes
+    # @option options [String] :excludes Array of names of excluded platforms
+    # @option options [String] :data_bags_path path to data bags
+    # @option options [String] :roles_path path to roles
+    def initialize(options = {})
+      validate_options(options)
+
+      @name = options[:name]
+      @run_list = options[:run_list]
+      @attributes = options[:attributes] || Hash.new
+      @excludes = options[:excludes]     || Array.new
+      @data_bags_path = options[:data_bags_path]
+      @roles_path = options[:roles_path]
+    end
+
+    private
+
+    def validate_options(opts)
+      [:name, :run_list].each do |k|
+        raise ClientError, "Suite#new requires option :#{k}" if opts[k].nil?
+      end
+    end
+  end
+end

data/lib/kitchen/thor_tasks.rb

@@ -0,0 +1,62 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
+#
+# Copyright (C) 2012, 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 'thor'
+
+require 'kitchen'
+
+module Kitchen
+
+  # Kitchen Thor task generator.
+  #
+  # @author Fletcher Nichol <fnichol@nichol.ca>
+  class ThorTasks < Thor
+
+    namespace :kitchen
+
+    # Creates Kitchen Thor tasks and allows the callee to configure it.
+    #
+    # @yield [self] gives itself to the block
+    def initialize(*args)
+      super
+      @config = Kitchen::Config.new
+      @config.supervised = false
+      Kitchen.logger = Kitchen.default_file_logger
+      yield self if block_given?
+      define
+    end
+
+    private
+
+    attr_reader :config
+
+    def define
+      config.instances.each do |instance|
+        self.class.desc instance.name, "Run #{instance.name} test instance"
+        self.class.send(:define_method, instance.name.gsub(/-/, '_')) do
+          instance.test(:always)
+        end
+      end
+
+      self.class.desc "all", "Run all test instances"
+      self.class.send(:define_method, :all) do
+        config.instances.each { |i| invoke i.name.gsub(/-/, '_') }
+      end
+    end
+  end
+end

data/lib/kitchen/util.rb

@@ -0,0 +1,79 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
+#
+# Copyright (C) 2012, 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.
+
+module Kitchen
+
+  # Stateless utility methods used in different contexts. Essentially a mini
+  # PassiveSupport library.
+  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
+
+    def self.to_logger_level(symbol)
+      return nil unless [:debug, :info, :warn, :error, :fatal].include?(symbol)
+
+      Logger.const_get(symbol.to_s.upcase)
+    end
+
+    def self.from_logger_level(const)
+      case const
+      when Logger::DEBUG then :debug
+      when Logger::INFO then :info
+      when Logger::WARN then :warn
+      when Logger::ERROR then :error
+      else :fatal
+      end
+    end
+
+    def self.symbolized_hash(obj)
+      if obj.is_a?(Hash)
+        obj.inject({}) { |h, (k, v)| h[k.to_sym] = symbolized_hash(v) ; h }
+      elsif obj.is_a?(Array)
+        obj.inject([]) { |a, v| a << symbolized_hash(v) ; a }
+      else
+        obj
+      end
+    end
+
+    def self.stringified_hash(obj)
+      if obj.is_a?(Hash)
+        obj.inject({}) { |h, (k, v)| h[k.to_s] = symbolized_hash(v) ; h }
+      elsif obj.is_a?(Array)
+        obj.inject([]) { |a, v| a << symbolized_hash(v) ; a }
+      else
+        obj
+      end
+    end
+
+    def self.duration(total)
+      minutes = (total / 60).to_i
+      seconds = (total - (minutes * 60))
+      "(%dm%.2fs)" % [minutes, seconds]
+    end
+  end
+end

data/{cookbooks/test-kitchen/recipes/erlang.rb → lib/kitchen/version.rb}

@@ -1,19 +1,22 @@
+# -*- encoding: utf-8 -*-
 #
-# Author:: Seth Chisamore (<schisamo@opscode.com>)
-# Copyright:: Copyright (c) 2012 Opscode, Inc.
-# License:: Apache License, Version 2.0
+# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
+#
+# Copyright (C) 2012, 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
+#    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.
-#
 
-# TODO - write this!
+module Kitchen
+
+  VERSION = "1.0.0.alpha.0"
+end

data/lib/kitchen.rb

@@ -0,0 +1,98 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
+#
+# Copyright (C) 2012, 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 'celluloid'
+require 'pathname'
+require 'thread'
+
+require 'kitchen/errors'
+require 'kitchen/logger'
+require 'kitchen/logging'
+require 'kitchen/shell_out'
+require 'kitchen/util'
+
+require 'kitchen/busser'
+require 'kitchen/chef_data_uploader'
+require 'kitchen/color'
+require 'kitchen/collection'
+require 'kitchen/config'
+require 'kitchen/driver'
+require 'kitchen/driver/base'
+require 'kitchen/driver/ssh_base'
+require 'kitchen/instance'
+require 'kitchen/instance_actor'
+require 'kitchen/loader/yaml'
+require 'kitchen/manager'
+require 'kitchen/metadata_chopper'
+require 'kitchen/platform'
+require 'kitchen/state_file'
+require 'kitchen/suite'
+require 'kitchen/version'
+
+module Kitchen
+
+  class << self
+
+    attr_accessor :logger
+    attr_accessor :crashes
+    attr_accessor :mutex
+
+    # Returns the root path of the Kitchen gem source code.
+    #
+    # @return [Pathname] root path of gem
+    def source_root
+      @source_root ||= Pathname.new(File.expand_path('../../', __FILE__))
+    end
+
+    def crashes?
+      ! crashes.empty?
+    end
+
+    def default_logger
+      Logger.new(:stdout => STDOUT, :level => env_log)
+    end
+
+    def default_file_logger
+      logfile = File.expand_path(File.join(".kitchen", "logs", "kitchen.log"))
+      Logger.new(:stdout => STDOUT, :logdev => logfile, :level => env_log)
+    end
+
+    private
+
+    def env_log
+      level = ENV['KITCHEN_LOG'] && ENV['KITCHEN_LOG'].downcase.to_sym
+      level = Util.to_logger_level(level) unless level.nil?
+    end
+  end
+
+  # Default log level verbosity
+  DEFAULT_LOG_LEVEL = :info
+end
+
+# Initialize the base logger and use that for Celluloid's logger
+Kitchen.logger = Kitchen.default_logger
+Celluloid.logger = Kitchen.logger
+
+# Setup a collection of instance crash exceptions for error reporting
+Kitchen.crashes = []
+Celluloid.exception_handler do |exception|
+  Kitchen.logger.debug("An instance crashed because of #{exception.inspect}")
+  Kitchen.mutex.synchronize { Kitchen.crashes << exception }
+end
+
+Kitchen.mutex = Mutex.new

data/lib/vendor/hash_recursive_merge.rb

@@ -0,0 +1,74 @@
+#
+# = Hash Recursive Merge
+#
+# Merges a Ruby Hash recursively, Also known as deep merge.
+# Recursive version of Hash#merge and Hash#merge!.
+#
+# Category::    Ruby
+# Package::     Hash
+# Author::      Simone Carletti <weppos@weppos.net>
+# Copyright::   2007-2008 The Authors
+# License::     MIT License
+# Link::        http://www.simonecarletti.com/
+# Source::      http://gist.github.com/gists/6391/
+#
+module HashRecursiveMerge
+
+  #
+  # Recursive version of Hash#merge!
+  #
+  # Adds the contents of +other_hash+ to +hsh+,
+  # merging entries in +hsh+ with duplicate keys with those from +other_hash+.
+  #
+  # Compared with Hash#merge!, this method supports nested hashes.
+  # When both +hsh+ and +other_hash+ contains an entry with the same key,
+  # it merges and returns the values from both arrays.
+  #
+  #    h1 = {"a" => 100, "b" => 200, "c" => {"c1" => 12, "c2" => 14}}
+  #    h2 = {"b" => 254, "c" => {"c1" => 16, "c3" => 94}}
+  #    h1.rmerge!(h2)   #=> {"a" => 100, "b" => 254, "c" => {"c1" => 16, "c2" => 14, "c3" => 94}}
+  #
+  # Simply using Hash#merge! would return
+  #
+  #    h1.merge!(h2)    #=> {"a" => 100, "b" = >254, "c" => {"c1" => 16, "c3" => 94}}
+  #
+  def rmerge!(other_hash)
+    merge!(other_hash) do |key, oldval, newval|
+      oldval.class == self.class ? oldval.rmerge!(newval) : newval
+    end
+  end
+
+  #
+  # Recursive version of Hash#merge
+  #
+  # Compared with Hash#merge!, this method supports nested hashes.
+  # When both +hsh+ and +other_hash+ contains an entry with the same key,
+  # it merges and returns the values from both arrays.
+  #
+  # Compared with Hash#merge, this method provides a different approch
+  # for merging nasted hashes.
+  # If the value of a given key is an Hash and both +other_hash+ abd +hsh
+  # includes the same key, the value is merged instead replaced with
+  # +other_hash+ value.
+  #
+  #    h1 = {"a" => 100, "b" => 200, "c" => {"c1" => 12, "c2" => 14}}
+  #    h2 = {"b" => 254, "c" => {"c1" => 16, "c3" => 94}}
+  #    h1.rmerge(h2)    #=> {"a" => 100, "b" => 254, "c" => {"c1" => 16, "c2" => 14, "c3" => 94}}
+  #
+  # Simply using Hash#merge would return
+  #
+  #    h1.merge(h2)     #=> {"a" => 100, "b" = >254, "c" => {"c1" => 16, "c3" => 94}}
+  #
+  def rmerge(other_hash)
+    r = {}
+    merge(other_hash) do |key, oldval, newval|
+      r[key] = oldval.class == self.class ? oldval.rmerge(newval) : newval
+    end
+  end
+
+end
+
+
+class Hash
+  include HashRecursiveMerge
+end

data/spec/kitchen/collection_spec.rb

@@ -0,0 +1,80 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
+#
+# Copyright (C) 2012, 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 'ostruct'
+
+require 'kitchen/collection'
+
+describe Kitchen::Collection do
+
+  let(:collection) do
+    Kitchen::Collection.new([
+      obj('one'), obj('two', 'a'), obj('two', 'b'), obj('three')
+    ])
+  end
+
+  it "transparently wraps an Array" do
+    collection.must_be_instance_of Array
+  end
+
+  describe "#get" do
+
+    it "returns a single object by its name" do
+      collection.get('three').must_equal obj('three')
+    end
+
+    it "returns the first occurance of an object by its name" do
+      collection.get('two').must_equal obj('two', 'a')
+    end
+
+    it "returns nil if an object cannot be found by its name" do
+      collection.get('nope').must_be_nil
+    end
+  end
+
+  describe "#get_all" do
+
+    it "returns a Collection of objects whose name matches the regex" do
+      result = collection.get_all(/(one|three)/)
+      result.size.must_equal 2
+      result[0].must_equal obj('one')
+      result[1].must_equal obj('three')
+      result.get_all(/one/).size.must_equal 1
+    end
+
+    it "returns an empty Collection if on matches are found" do
+      result = collection.get_all(/noppa/)
+      result.must_equal []
+      result.get("nahuh").must_be_nil
+    end
+  end
+
+  describe "#as_name" do
+
+    it "returns an Array of names as strings" do
+      collection.as_names.must_equal %w{one two two three}
+    end
+  end
+
+  private
+
+  def obj(name, extra = nil)
+    OpenStruct.new(:name => name, :extra => extra)
+  end
+end

data/spec/kitchen/color_spec.rb

@@ -0,0 +1,54 @@
+# -*- 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/color'
+
+describe Kitchen::Color do
+
+  describe ".escape" do
+
+    it "returns an empty string if name is nil" do
+      Kitchen::Color.escape(nil).must_equal ""
+    end
+
+    it "returns an empty string if name is not in the ANSI hash" do
+      Kitchen::Color.escape(:puce).must_equal ""
+    end
+
+    it "returns an ansi escape sequence string for cyan" do
+      Kitchen::Color.escape(:cyan).must_equal "\e[36m"
+    end
+
+    it "returns an ansi escape sequence string for reset" do
+      Kitchen::Color.escape(:reset).must_equal "\e[0m"
+    end
+  end
+
+  describe ".colorize" do
+
+    it "returns an ansi escaped string colored yellow" do
+      Kitchen::Color.colorize("hello", :yellow).must_equal "\e[33mhello\e[0m"
+    end
+
+    it "returns an unescaped string if color is not in the ANSI hash" do
+      Kitchen::Color.colorize("double", :rainbow).must_equal "double"
+    end
+  end
+end