test-kitchen 1.0.0.alpha.4 → 1.0.0.alpha.5

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 1.0.0.alpha.5 / 2013-04-23
+
+### Improvements
+
+* Pull request [#81][]: Clean up error reporting in CLI output. ([@fnichol][])
+* Pull request [#76][]: Swap out shell-based kb for Ruby-based Busser gem. ([@fnichol][])
+* Pull request [#82][], issue [#61][]: Install Omnibus package via either wget or curl. ([@fnichol][])
+* Catch YAML data merging errors as user errors. ([@fnichol][])
+* Issue [#80][]: Add a more helpful error message when a driver could not be loaded. ([@fnichol][])
+
+
 ## 1.0.0.alpha.4 / 2013-04-10
 
 ### Bug fixes
@@ -70,11 +81,16 @@
 The initial release.
 
 <!--- The following link definition list is generated by PimpMyChangelog --->
+[#61]: https://github.com/opscode/test/issues/61
 [#64]: https://github.com/opscode/test/issues/64
 [#65]: https://github.com/opscode/test/issues/65
 [#71]: https://github.com/opscode/test/issues/71
 [#73]: https://github.com/opscode/test/issues/73
 [#74]: https://github.com/opscode/test/issues/74
+[#76]: https://github.com/opscode/test/issues/76
+[#80]: https://github.com/opscode/test/issues/80
+[#81]: https://github.com/opscode/test/issues/81
+[#82]: https://github.com/opscode/test/issues/82
 [@ChrisLundquist]: https://github.com/ChrisLundquist
 [@bryanwb]: https://github.com/bryanwb
 [@fnichol]: https://github.com/fnichol

data/bin/kitchen

@@ -8,5 +8,6 @@ Signal.trap("INT") { exit 1 }
 $:.unshift File.join(File.dirname(__FILE__), %w{.. lib})
 require 'rubygems'
 require 'kitchen/cli'
+require 'kitchen/errors'
 
-Kitchen::CLI.start
+Kitchen.with_friendly_errors { Kitchen::CLI.start }

data/lib/kitchen/busser.rb

@@ -18,18 +18,17 @@
 
 require 'base64'
 require 'digest'
-require 'net/https'
 
 module Kitchen
 
-  # Command string generator to interface with Kitchen Busser (kb). The
-  # commands that are generated are safe to pass to an SSH command or as an
-  # unix command argument (escaped in single quotes).
+  # Command string generator to interface with Busser. The commands that are
+  # generated are safe to pass to an SSH command or as an unix command
+  # argument (escaped in single quotes).
   #
   # @author Fletcher Nichol <fnichol@nichol.ca>
   class Busser
 
-    # Constructs a new busser command generator, given a suite name.
+    # Constructs a new Busser command generator, given a suite name.
     #
     # @param [String] suite_name name of suite on which to operate
     #   (**Required**)
@@ -43,8 +42,8 @@ module Kitchen
       @use_sudo = opts[:use_sudo]
     end
 
-    # Returns a command string which installs the Kitchen Busser (kb), installs
-    # all required kb plugins for the suite.
+    # Returns a command string which installs Busser, and installs all
+    # required Busser plugins for the suite.
     #
     # If no work needs to be performed, for example if there are no tests for
     # the given suite, then `nil` will be returned.
@@ -56,11 +55,11 @@ module Kitchen
         nil
       else
         <<-INSTALL_CMD.gsub(/^ {10}/, '')
-          #{sudo}#{ruby_bin} -e "$(cat <<"EOF"
-          #{install_script}
-          EOF
-          )"
-          #{sudo}#{kb_bin} install #{plugins.join(' ')}
+          if ! #{sudo}#{ruby_binpath}/gem list busser -i >/dev/null ; then
+            #{sudo}#{ruby_binpath}/gem install #{busser_gem} --no-rdoc --no-ri
+          fi
+          #{sudo}#{ruby_binpath}/busser setup
+          #{sudo}#{busser_bin} plugin install #{plugins.join(' ')}
         INSTALL_CMD
       end
     end
@@ -78,13 +77,13 @@ module Kitchen
         nil
       else
         <<-INSTALL_CMD.gsub(/^ {10}/, '')
-          #{sudo}#{kb_bin} cleanup-suites
+          #{sudo}#{busser_bin} suite cleanup
           #{local_suite_files.map { |f| stream_file(f, remote_file(f)) }.join}
         INSTALL_CMD
       end
     end
 
-    # Returns a command string which runs all kb suite tests for the suite.
+    # Returns a command string which runs all Busser suite tests for the suite.
     #
     # If no work needs to be performed, for example if there are no tests for
     # the given suite, then `nil` will be returned.
@@ -92,34 +91,23 @@ 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}#{kb_bin} test"
+      @run_cmd ||= local_suite_files.empty? ? nil : "#{sudo}#{busser_bin} test"
     end
 
     private
 
-    INSTALL_URL = "https://raw.github.com/opscode/kb/go".freeze
     DEFAULT_RUBY_BINPATH = "/opt/chef/embedded/bin".freeze
-    DEFAULT_KB_ROOT = "/opt/kb".freeze
+    DEFAULT_BUSSER_ROOT = "/opt/busser".freeze
     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?
     end
 
-    def install_script
-      @install_script ||= begin
-        uri = URI.parse(INSTALL_URL)
-        http = Net::HTTP.new(uri.host, 443)
-        http.use_ssl = true
-        response = http.request(Net::HTTP::Get.new(uri.path))
-        response.body
-      end
-    end
-
     def plugins
       Dir.glob(File.join(test_root, @suite_name, "*")).select { |d|
         File.directory?(d) && File.basename(d) != "data_bags"
-      }.map { |d| File.basename(d) }.sort.uniq
+      }.map { |d| "busser-#{File.basename(d)}" }.sort.uniq
     end
 
     def local_suite_files
@@ -130,18 +118,24 @@ module Kitchen
 
     def remote_file(file)
       local_prefix = File.join(test_root, @suite_name)
-      "$(#{kb_bin} suitepath)/".concat(file.sub(%r{^#{local_prefix}/}, ''))
+      "$(#{busser_bin} suite path)/".concat(file.sub(%r{^#{local_prefix}/}, ''))
     end
 
     def stream_file(local_path, remote_path)
       local_file = IO.read(local_path)
       md5 = Digest::MD5.hexdigest(local_file)
-      perms = sprintf("%o", File.stat(local_path).mode)[3, 3]
-      kb_stream_file = "#{kb_bin} stream-file #{remote_path} #{md5} #{perms}"
+      perms = sprintf("%o", File.stat(local_path).mode)[2, 4]
+      stream_cmd = [
+        busser_bin,
+        "deserialize",
+        "--destination=#{remote_path}",
+        "--md5sum=#{md5}",
+        "--perms=#{perms}"
+      ].join(" ")
 
       <<-STREAMFILE.gsub(/^ {8}/, '')
         echo "Uploading #{remote_path} (mode=#{perms})"
-        cat <<"__EOFSTREAM__" | #{sudo}#{kb_stream_file}
+        cat <<"__EOFSTREAM__" | #{sudo}#{stream_cmd}
         #{Base64.encode64(local_file)}
         __EOFSTREAM__
       STREAMFILE
@@ -151,12 +145,16 @@ module Kitchen
       @use_sudo ? "sudo " : ""
     end
 
-    def ruby_bin
-      File.join(DEFAULT_RUBY_BINPATH, "ruby")
+    def ruby_binpath
+      DEFAULT_RUBY_BINPATH
+    end
+
+    def busser_bin
+      File.join(DEFAULT_BUSSER_ROOT, "bin/busser")
     end
 
-    def kb_bin
-      File.join(DEFAULT_KB_ROOT, "bin/kb")
+    def busser_gem
+      "busser"
     end
 
     def test_root

data/lib/kitchen/cli.rb

@@ -39,12 +39,12 @@ module Kitchen
     def initialize(*args)
       super
       $stdout.sync = true
+      Kitchen.logger = Kitchen.default_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,
         :supervised => false
       )
-      Kitchen.logger = Kitchen.default_file_logger
     end
 
     desc "list [(all|<REGEX>)]", "List all instances"
@@ -304,12 +304,14 @@ module Kitchen
       when nil then set_color("<Not Created>", :red)
       else set_color("<Unknown>", :white)
       end
-      [set_color(instance.name, :white), action]
+      [instance.name, action]
     end
 
     def update_config!
       if options[:log_level]
-        @config.log_level = options[:log_level].downcase.to_sym
+        level = options[:log_level].downcase.to_sym
+        @config.log_level = level
+        Kitchen.logger.level = Util.to_logger_level(level)
       end
     end
 

data/lib/kitchen/driver/base.rb

@@ -146,15 +146,15 @@ module Kitchen
         super(cmd, base_options)
       end
 
-      def kb_setup_cmd
+      def busser_setup_cmd
         busser.setup_cmd
       end
 
-      def kb_sync_cmd
+      def busser_sync_cmd
         busser.sync_cmd
       end
 
-      def kb_run_cmd
+      def busser_run_cmd
         busser.run_cmd
       end
 

data/lib/kitchen/driver/ssh_base.rb

@@ -47,17 +47,17 @@ module Kitchen
       def setup(state)
         ssh_args = build_ssh_args(state)
 
-        if kb_setup_cmd
-          ssh(ssh_args, kb_setup_cmd)
+        if busser_setup_cmd
+          ssh(ssh_args, busser_setup_cmd)
         end
       end
 
       def verify(state)
         ssh_args = build_ssh_args(state)
 
-        if kb_run_cmd
-          ssh(ssh_args, kb_sync_cmd)
-          ssh(ssh_args, kb_run_cmd)
+        if busser_run_cmd
+          ssh(ssh_args, busser_sync_cmd)
+          ssh(ssh_args, busser_run_cmd)
         end
       end
 
@@ -98,6 +98,7 @@ module Kitchen
       end
 
       def install_omnibus(ssh_args)
+        url = "https://www.opscode.com/chef/install.sh"
         flag = config[:require_chef_omnibus]
         version = if flag.is_a?(String) && flag != "latest"
           "-s -- -v #{flag.downcase}"
@@ -115,8 +116,14 @@ module Kitchen
 
           if [ ! -d "/opt/chef" ] || should_update_chef ; then
             echo "-----> Installing Chef Omnibus (#{flag})"
-            curl -sSL https://www.opscode.com/chef/install.sh \
-              | sudo bash #{version}
+            if command -v wget &>/dev/null ; then
+              wget #{url} -O - | sudo bash #{version}
+            elif command -v curl &>/dev/null ; then
+              curl -sSL #{url} | sudo bash #{version}
+            else
+              echo ">>>>>> Neither wget nor curl found on this instance."
+              exit 1
+            fi
           fi
         INSTALL
       end

data/lib/kitchen/driver.rb

@@ -39,7 +39,10 @@ module Kitchen
     rescue UserError
       raise
     rescue LoadError, NameError
-      raise ClientError, "Could not require '#{plugin}' plugin from load path"
+      raise ClientError,
+        "Could not load the '#{plugin}' driver from the load path." +
+          " Please ensure that your driver is installed as a gem or included" +
+          " in your Gemfile if using Bundler."
     end
   end
 end

data/lib/kitchen/errors.rb

@@ -18,7 +18,28 @@
 
 module Kitchen
 
-  module Error ; end
+  module Error
+
+    def self.formatted_trace(exception)
+      arr = formatted_exception(exception).dup
+      last = arr.pop
+      if exception.respond_to?(:original) && exception.original
+        arr += formatted_exception(exception.original, "Nested Exception")
+        last = arr.pop
+      end
+      arr += ["Backtrace".center(22, "-"), exception.backtrace, last].flatten
+      arr
+    end
+
+    def self.formatted_exception(exception, title = "Exception")
+      [
+        title.center(22, "-"),
+        "Class: #{exception.class}",
+        "Message: #{exception.message}",
+        "".center(22, "-"),
+      ]
+    end
+  end
 
   # Base exception class from which all Kitchen exceptions derive. This class
   # nests an exception when this class is re-raised from a rescue block.
@@ -49,4 +70,56 @@ module Kitchen
   # Exception class for any exceptions raised when performing an instance
   # action.
   class ActionFailed < TransientFailure ; end
+
+  # Exception class capturing what caused an instance to die.
+  class InstanceFailure < TransientFailure ; end
+
+  def self.with_friendly_errors
+    yield
+  rescue Kitchen::InstanceFailure => e
+    Kitchen.mutex.synchronize do
+      handle_instance_failure(e)
+    end
+    exit 10
+  rescue Kitchen::Error => e
+    Kitchen.mutex.synchronize do
+      handle_error(e)
+    end
+    exit 20
+  end
+
+  private
+
+  def self.file_log(level, lines)
+    Array(lines).each do |line|
+      if Kitchen.logger.debug?
+        Kitchen.logger.debug(line)
+      else
+        Kitchen.logger.logdev && Kitchen.logger.logdev.public_send(level, line)
+      end
+    end
+  end
+
+  def self.stderr_log(lines)
+    Array(lines).each do |line|
+      $stderr.puts(Color.colorize(">>>>>> #{line}", :red))
+    end
+  end
+
+  def self.debug_log(lines)
+    Array(lines).each { |line| Kitchen.logger.debug(line) }
+  end
+
+  def self.handle_instance_failure(e)
+    stderr_log(e.message.split(/\s{2,}/))
+    stderr_log(Error.formatted_exception(e.original))
+    file_log(:error, e.message.split(/\s{2,}/).first)
+    debug_log(Error.formatted_trace(e))
+  end
+
+  def self.handle_error(e)
+    stderr_log(Error.formatted_exception(e))
+    stderr_log("Please see .kitchen/logs/kitchen.log for more details\n")
+    file_log(:error, Error.formatted_trace(e))
+  end
 end

data/lib/kitchen/instance.rb

@@ -260,10 +260,14 @@ module Kitchen
       end
       state[:last_action] = what.to_s
       elapsed
-    rescue ActionFailed
-      raise
+    rescue ActionFailed => e
+      log_failure(what, e)
+      raise InstanceFailure, failure_message(what) +
+        "  Please see .kitchen/logs/#{self.name}.log for more details", caller
     rescue Exception => e
-      raise ActionFailed, "Failed to complete ##{what} action: [#{e.message}]"
+      log_failure(what, e)
+      raise ActionFailed,
+        "Failed to complete ##{what} action: [#{e.message}]", caller
     ensure
       state_file.write(state)
     end
@@ -289,6 +293,17 @@ module Kitchen
       super
     end
 
+    def log_failure(what, e)
+      return if logger.logdev.nil?
+
+      logger.logdev.error(failure_message(what))
+      Error.formatted_trace(e).each { |line| logger.logdev.error(line) }
+    end
+
+    def failure_message(what)
+      "#{what.capitalize} failed on instance #{self.to_str}."
+    end
+
     # The simplest finite state machine pseudo-implementation needed to manage
     # an Instance.
     #

data/lib/kitchen/loader/yaml.rb

@@ -69,6 +69,9 @@ module Kitchen
 
       def combined_hash
         @process_local ? yaml.rmerge(local_yaml) : yaml
+      rescue NoMethodError
+        raise UserError, "Error merging #{File.basename(config_file)} and" +
+          "#{File.basename(local_config_file)}"
       end
 
       def yaml
@@ -97,8 +100,8 @@ module Kitchen
         return Hash.new if string.nil? || string.empty?
 
         ::YAML.safe_load(string)
-      rescue SyntaxError, Psych::SyntaxError => ex
-        raise UserError, "Error parsing #{file_name} (#{ex.message})"
+      rescue SyntaxError, Psych::SyntaxError
+        raise UserError, "Error parsing #{file_name}"
       end
     end
   end

data/lib/kitchen/logger.rb

@@ -34,7 +34,7 @@ module Kitchen
     attr_reader :logdev
 
     def initialize(options = {})
-      color = options[:color] || :bright_white
+      color = options[:color]
 
       @loggers = []
       @loggers << @logdev = logdev_logger(options[:logdev]) if options[:logdev]

data/lib/kitchen/version.rb

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

data/lib/kitchen.rb

@@ -72,6 +72,11 @@ module Kitchen
       Logger.new(:stdout => STDOUT, :logdev => logfile, :level => env_log)
     end
 
+    def celluloid_file_logger
+      logfile = File.expand_path(File.join(".kitchen", "logs", "celluloid.log"))
+      Logger.new(:logdev => logfile, :level => env_log, :progname => "Celluloid")
+    end
+
     private
 
     def env_log
@@ -86,7 +91,7 @@ end
 
 # Initialize the base logger and use that for Celluloid's logger
 Kitchen.logger = Kitchen.default_logger
-Celluloid.logger = Kitchen.logger
+Celluloid.logger = Kitchen.celluloid_file_logger
 
 # Setup a collection of instance crash exceptions for error reporting
 Kitchen.crashes = []

data/spec/kitchen/loader/yaml_spec.rb

@@ -152,6 +152,13 @@ describe Kitchen::Loader::YAML do
       proc { loader.read }.must_raise Kitchen::UserError
     end
 
+    it "raises a UserError if kitchen.yml cannot be parsed" do
+      FileUtils.mkdir_p "/tmp"
+      File.open("/tmp/.kitchen.yml", "wb") { |f| f.write 'uhoh' }
+
+      proc { loader.read }.must_raise Kitchen::UserError
+    end
+
     it "raises a UserError if kitchen.local.yml cannot be parsed" do
       FileUtils.mkdir_p "/tmp"
       File.open("/tmp/.kitchen.local.yml", "wb") { |f| f.write '&*%^*' }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: test-kitchen
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha.4
+  version: 1.0.0.alpha.5
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-10 00:00:00.000000000 Z
+date: 2013-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: celluloid