test-kitchen 0.7.0 → 1.0.0.alpha.0

data/lib/kitchen/loader/yaml.rb

@@ -0,0 +1,105 @@
+# -*- 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 'erb'
+require 'vendor/hash_recursive_merge'
+require 'safe_yaml'
+
+module Kitchen
+
+  module Loader
+
+    # YAML file loader for Test Kitchen configuration. This class is
+    # responisble for parsing the main YAML file and the local YAML if it
+    # exists. Local file configuration will win over the default configuration.
+    # The client of this class should not require any YAML loading or parsing
+    # logic.
+    #
+    # @author Fletcher Nichol <fnichol@nichol.ca>
+    class YAML
+
+      attr_reader :config_file
+
+      # Creates a new loader that can parse and load YAML files.
+      #
+      # @param config_file [String] path to Kitchen config YAML file
+      # @param options [Hash] configuration for a new loader
+      # @option options [String] :process_erb whether or not to process YAML
+      #   through an ERB processor (default: `true`)
+      # @option options [String] :process_local whether or not to process a
+      #   local kitchen YAML file, if it exists (default: `true`)
+      def initialize(config_file = nil, options = {})
+        @config_file = File.expand_path(config_file || default_config_file)
+        @process_erb = options.fetch(:process_erb, true)
+        @process_local = options.fetch(:process_local, true)
+      end
+
+      # Reads, parses, and merges YAML configuration files and returns a Hash
+      # of tne merged data.
+      #
+      # @return [Hash] merged configuration data
+      def read
+        if ! File.exists?(config_file)
+          raise UserError, "Kitchen YAML file #{config_file} does not exist."
+        end
+
+        Util.symbolized_hash(combined_hash)
+      end
+
+      protected
+
+      def default_config_file
+        File.join(Dir.pwd, '.kitchen.yml')
+      end
+
+      def combined_hash
+        @process_local ? yaml.rmerge(local_yaml) : yaml
+      end
+
+      def yaml
+        parse_yaml_string(yaml_string(config_file), config_file)
+      end
+
+      def local_yaml
+        parse_yaml_string(yaml_string(local_config_file), local_config_file)
+      end
+
+      def yaml_string(file)
+        string = read_file(file)
+
+        @process_erb ? ERB.new(string).result : string
+      end
+
+      def read_file(file)
+        File.exists?(file.to_s) ? IO.read(file) : ""
+      end
+
+      def local_config_file
+        config_file.sub(/(#{File.extname(config_file)})$/, '.local\1')
+      end
+
+      def parse_yaml_string(string, file_name)
+        return Hash.new if string.nil? || string.empty?
+
+        ::YAML.safe_load(string)
+      rescue SyntaxError => ex
+        raise UserError, "Error parsing #{file_name} (#{ex.message})"
+      end
+    end
+  end
+end

data/lib/kitchen/logger.rb

@@ -0,0 +1,145 @@
+# -*- 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 'fileutils'
+require 'logger'
+
+module Kitchen
+
+  # Logging implementation for Kitchen. By default the console/stdout output
+  # will be displayed differently than the file log output. Therefor, this
+  # class wraps multiple loggers that conform to the stdlib `Logger` class
+  # behavior.
+  #
+  # @author Fletcher Nichol <fnichol@nichol.ca>
+  class Logger
+
+    include ::Logger::Severity
+
+    attr_reader :logdev
+
+    def initialize(options = {})
+      color = options[:color] || :bright_white
+
+      @loggers = []
+      @loggers << @logdev = logdev_logger(options[:logdev]) if options[:logdev]
+      @loggers << stdout_logger(options[:stdout], color) if options[:stdout]
+      @loggers << stdout_logger(STDOUT, color) if @loggers.empty?
+
+      self.progname = options[:progname] || "Kitchen"
+      self.level = options[:level] || default_log_level
+    end
+
+    %w{ level progname datetime_format debug? info? error? warn? fatal?
+    }.each do |meth|
+      define_method(meth) do |*args|
+        @loggers.first.public_send(meth, *args)
+      end
+    end
+
+    %w{ level= progname= datetime_format= add <<
+        banner debug info error warn fatal unknown close
+    }.map(&:to_sym).each do |meth|
+      define_method(meth) do |*args|
+        result = nil
+        @loggers.each { |l| result = l.public_send(meth, *args) }
+        result
+      end
+    end
+
+    private
+
+    def default_log_level
+      Util.to_logger_level(Kitchen::DEFAULT_LOG_LEVEL)
+    end
+
+    def stdout_logger(stdout, color)
+      logger = StdoutLogger.new(stdout)
+      logger.formatter = proc do |severity, datetime, progname, msg|
+        Color.colorize("#{msg}\n", color)
+      end
+      logger
+    end
+
+    def logdev_logger(filepath_or_logdev)
+      LogdevLogger.new(resolve_logdev(filepath_or_logdev))
+    end
+
+    def resolve_logdev(filepath_or_logdev)
+      if filepath_or_logdev.is_a? String
+        FileUtils.mkdir_p(File.dirname(filepath_or_logdev))
+        file = File.open(File.expand_path(filepath_or_logdev), "ab")
+        file.sync = true
+        file
+      else
+        filepath_or_logdev
+      end
+    end
+
+    # Internal class which adds a #banner method call that displays the
+    # message with a callout arrow.
+    class LogdevLogger < ::Logger
+
+      alias_method :super_info, :info
+
+      def <<(msg)
+        msg =~ /\n/ ? msg.split("\n").each { |l| format_line(l) } : super
+      end
+
+      def banner(msg = nil, &block)
+        super_info("-----> #{msg}", &block)
+      end
+
+      private
+
+      def format_line(line)
+        case line
+        when %r{^-----> } then banner(line.gsub(%r{^[ >-]{6} }, ''))
+        when %r{^>>>>>> } then error(line.gsub(%r{^[ >-]{6} }, ''))
+        when %r{^       } then info(line.gsub(%r{^[ >-]{6} }, ''))
+        else info(line)
+        end
+      end
+    end
+
+    # Internal class which reformats logging methods for display as console
+    # output.
+    class StdoutLogger < LogdevLogger
+
+      def debug(msg = nil, &block)
+        super("D      #{msg}", &block)
+      end
+
+      def info(msg = nil, &block)
+        super("       #{msg}", &block)
+      end
+
+      def warn(msg = nil, &block)
+        super("$$$$$$ #{msg}", &block)
+      end
+
+      def error(msg = nil, &block)
+        super(">>>>>> #{msg}", &block)
+      end
+
+      def fatal(msg = nil, &block)
+        super("!!!!!! #{msg}", &block)
+      end
+    end
+  end
+end

data/{cookbooks/test-kitchen/libraries/helpers.rb → lib/kitchen/logging.rb}

@@ -1,25 +1,29 @@
+# -*- 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) 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
+#    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.
-#
 
-class Chef::Recipe
-  def recipe_for_project?(project_name)
-    run_context.cookbook_collection['test-kitchen'].recipe_files.any? do |rf|
-      rf =~ Regexp.new(project_name)
+module Kitchen
+
+  module Logging
+
+    %w{banner debug info warn error fatal}.map(&:to_sym).each do |meth|
+      define_method(meth) do |*args|
+        logger.public_send(meth, *args)
+      end
     end
   end
 end

data/lib/kitchen/manager.rb

@@ -0,0 +1,45 @@
+# -*- 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.
+
+module Kitchen
+
+  # A class to manage actors.
+  #
+  # @author Fletcher Nichol <fnichol@nichol.ca>
+  class Manager
+
+    include Celluloid
+
+    trap_exit :actor_died
+
+    # Terminate all actors that are linked.
+    def stop
+      Array(links.to_a).map { |actor| actor.terminate if actor.alive? }
+    end
+
+    private
+
+    def actor_died(actor, reason)
+      if reason.nil?
+        Kitchen.logger.debug("Actor terminated cleanly")
+      else
+        Kitchen.logger.debug("An actor crashed due to #{reason.inspect}")
+      end
+    end
+  end
+end

data/lib/kitchen/metadata_chopper.rb

@@ -0,0 +1,52 @@
+# -*- 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 rather insane and questionable class to quickly consume a metadata.rb
+  # file and return the cookbook name and version attributes.
+  #
+  # @see https://twitter.com/fnichol/status/281650077901144064
+  # @see https://gist.github.com/4343327
+  class MetadataChopper < Hash
+
+    # Return an Array containing the cookbook name and version attributes,
+    # or nil values if they could not be parsed.
+    #
+    # @param metadata_file [String] path to a metadata.rb file
+    # @return [Array<String>] array containing the cookbook name and version
+    #   attributes or nil values if they could not be determined
+    def self.extract(metadata_file)
+      mc = new(File.expand_path(metadata_file))
+      [mc[:name], mc[:version]]
+    end
+
+    # Creates a new instances and loads in the contents of the metdata.rb
+    # file. If you value your life, you may want to avoid reading the
+    # implementation.
+    #
+    # @param metadata_file [String] path to a metadata.rb file
+    def initialize(metadata_file)
+      eval(IO.read(metadata_file), nil, metadata_file)
+    end
+
+    def method_missing(meth, *args, &block)
+      self[meth] = args.first
+    end
+  end
+end

data/lib/kitchen/platform.rb

@@ -0,0 +1,61 @@
+# -*- 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 target operating system environment in which convergence integration
+  # will take place. This may represent a specific operating system, version,
+  # and machine architecture.
+  #
+  # @author Fletcher Nichol <fnichol@nichol.ca>
+  class Platform
+
+    # @return [String] logical name of this platform
+    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
+
+    # Constructs a new platform.
+    #
+    # @param [Hash] options configuration for a new platform
+    # @option options [String] :name logical name of this platform
+    #   (**Required**)
+    # @option options [Array<String>] :run_list Array of Chef run_list
+    #   items
+    # @option options [Hash] :attributes Hash of Chef node attributes
+    def initialize(options = {})
+      validate_options(options)
+
+      @name = options[:name]
+      @run_list = Array(options[:run_list])
+      @attributes = options[:attributes] || Hash.new
+    end
+
+    private
+
+    def validate_options(opts)
+      [:name].each do |k|
+        raise ClientError, "Platform#new requires option :#{k}" if opts[k].nil?
+      end
+    end
+  end
+end

data/lib/kitchen/rake_tasks.rb

@@ -0,0 +1,59 @@
+# -*- 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 'rake/tasklib'
+
+require 'kitchen'
+
+module Kitchen
+
+  # Kitchen Rake task generator.
+  #
+  # @author Fletcher Nichol <fnichol@nichol.ca>
+  class RakeTasks < ::Rake::TaskLib
+
+    # Creates Kitchen Rake tasks and allows the callee to configure it.
+    #
+    # @yield [self] gives itself to the block
+    def initialize
+      @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
+      namespace "kitchen" do
+        config.instances.each do |instance|
+          desc "Run #{instance.name} test instance"
+          task instance.name do
+            instance.test(:always)
+          end
+        end
+
+        desc "Run all test instances"
+        task "all" => config.instances.map { |i| i.name }
+      end
+    end
+  end
+end

data/lib/kitchen/shell_out.rb

@@ -0,0 +1,65 @@
+# -*- 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 'mixlib/shellout'
+
+module Kitchen
+
+  # Mixin that wraps a command shell out invocation, providing a #run_command
+  # method.
+  #
+  # @author Fletcher Nichol <fnichol@nichol.ca>
+  module ShellOut
+
+    # Wrapped exception for any interally raised shell out commands.
+    class ShellCommandFailed < TransientFailure ; end
+
+    # Executes a command in a subshell on the local running system.
+    #
+    # @param cmd [String] command to be executed locally
+    # @param use_sudo [TrueClass, FalseClass] whether or not to use sudo
+    # @param log_subject [String] used in the output or log header for clarity
+    #   and context
+    # @raise [ShellCommandFailed] if the command fails
+    # @raise [Error] for all other unexpected exceptions
+    def run_command(cmd, use_sudo = false, log_subject = "local")
+      cmd = "sudo #{cmd}" if use_sudo
+      subject = "[#{log_subject} command]"
+
+      info("#{subject} BEGIN (#{display_cmd(cmd)})")
+      sh = Mixlib::ShellOut.new(cmd, :live_stream => logger, :timeout => 60000)
+      sh.run_command
+      info("#{subject} END #{Util.duration(sh.execution_time)}")
+      sh.error!
+    rescue Mixlib::ShellOut::ShellCommandFailed => ex
+      raise ShellCommandFailed, ex.message
+    rescue Exception => error
+      error.extend(Kitchen::Error)
+      raise
+    end
+
+    private
+
+    def display_cmd(cmd)
+      first_line, newline, rest = cmd.partition("\n")
+      last_char = cmd[cmd.size - 1]
+
+      newline == "\n" ? "#{first_line}\\n...#{last_char}" : cmd
+    end
+  end
+end

data/lib/kitchen/state_file.rb

@@ -0,0 +1,88 @@
+# -*- 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 'safe_yaml'
+
+module Kitchen
+
+  # Exception class for any exceptions raised when reading and parsing a state
+  # file from disk
+  class StateFileLoadError < StandardError ; end
+
+  # State persistence manager for instances between actions and invocations.
+  class StateFile
+
+    # Constructs an new instance taking the kitchen root and instance name.
+    #
+    # @param kitchen_root [String] path to the Kitchen project's root directory
+    # @param name [String] name of the instance representing this state
+    def initialize(kitchen_root, name)
+      @file_name = File.expand_path(
+        File.join(kitchen_root, ".kitchen", "#{name}.yml")
+      )
+    end
+
+    # Reads and loads an instance's state into a Hash data structure which is
+    # returned.
+    #
+    # @return [Hash] a hash representation of an instance's state
+    # @raise [StateFileLoadError] if there is a problem loading the state file
+    #   from disk and loading it into a Hash
+    def read
+      if File.exists?(file_name)
+        Util.symbolized_hash(deserialize_string(read_file))
+      else
+        Hash.new
+      end
+    end
+
+    # Serializes the state hash and writes a state file to disk.
+    #
+    # @param state [Hash] the current state of the instance
+    def write(state)
+      dir = File.dirname(file_name)
+      serialized_string = serialize_hash(Util.stringified_hash(state))
+
+      FileUtils.mkdir_p(dir) if ! File.directory?(dir)
+      File.open(file_name, "wb") { |f| f.write(serialized_string) }
+    end
+
+    # Destroys a state file on disk if it exists.
+    def destroy
+      FileUtils.rm_f(file_name) if File.exists?(file_name)
+    end
+
+    private
+
+    attr_reader :file_name
+
+    def read_file
+      IO.read(file_name)
+    end
+
+    def deserialize_string(string)
+      ::YAML.safe_load(string)
+    rescue SyntaxError => ex
+      raise StateFileLoadError, "Error parsing #{file_name} (#{ex.message})"
+    end
+
+    def serialize_hash(hash)
+      ::YAML.dump(hash)
+    end
+  end
+end