test-kitchen 1.2.1 → 1.3.0

data/spec/kitchen/driver_spec.rb

@@ -16,13 +16,13 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require_relative '../spec_helper'
+require_relative "../spec_helper"
 
-require 'kitchen/errors'
-require 'kitchen/logging'
-require 'kitchen/shell_out'
-require 'kitchen/driver'
-require 'kitchen/driver/base'
+require "kitchen/errors"
+require "kitchen/logging"
+require "kitchen/shell_out"
+require "kitchen/driver"
+require "kitchen/driver/base"
 
 module Kitchen
 
@@ -63,28 +63,28 @@ describe Kitchen::Driver do
     end
 
     it "returns a driver object of the correct class" do
-      driver = Kitchen::Driver.for_plugin('coolbeans', {})
+      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 = Kitchen::Driver.for_plugin("coolbeans", :jelly => "beans")
 
-      driver[:jelly].must_equal 'beans'
+      driver[:jelly].must_equal "beans"
     end
 
     it "calls #verify_dependencies on the driver object" do
-      driver = Kitchen::Driver.for_plugin('it_depends', {})
+      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 = Kitchen::Driver.for_plugin("it_depends", {})
       driver1.verify_call_count.must_equal 1
-      driver2 = Kitchen::Driver.for_plugin('it_depends', {})
+      driver2 = Kitchen::Driver.for_plugin("it_depends", {})
 
       driver2.verify_call_count.must_equal 0
     end
@@ -92,19 +92,19 @@ describe Kitchen::Driver do
     it "raises ClientError if the driver could not be required" do
       Kitchen::Driver.stubs(:require).raises(LoadError)
 
-      proc { Kitchen::Driver.for_plugin('coolbeans', {}) }.
+      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', {}) }.
+      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', {}) }.
+      proc { Kitchen::Driver.for_plugin("unstable_depends", {}) }.
         must_raise Kitchen::UserError
     end
   end

data/spec/kitchen/errors_spec.rb

@@ -0,0 +1,309 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
+#
+# Copyright (C) 2014, 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"
+require "kitchen/errors"
+
+describe Kitchen::Error do
+
+  let(:exception) { Kitchen::StandardError.new("shoot") }
+
+  describe ".formatted_exception" do
+
+    it "returns an array of a formatted message" do
+      Kitchen::Error.formatted_exception(exception).must_equal([
+        "------Exception-------",
+        "Class: Kitchen::StandardError",
+        "Message: shoot",
+        "----------------------"
+      ])
+    end
+
+    it "takes a customized title" do
+      Kitchen::Error.formatted_exception(exception, "Trouble").first.
+        must_equal("-------Trouble--------")
+    end
+  end
+
+  describe ".formatted_exception" do
+
+    it "returns an array of a formatted message with a nil backtrace" do
+      Kitchen::Error.formatted_trace(exception).must_equal([
+        "------Exception-------",
+        "Class: Kitchen::StandardError",
+        "Message: shoot",
+        "------Backtrace-------",
+        nil,
+        "----------------------"
+      ])
+    end
+
+    it "returns an array containing the exception's backtrace" do
+      begin
+        raise Kitchen::StandardError, "shoot"
+      rescue => e
+        Kitchen::Error.formatted_trace(e)[4...-1].must_equal e.backtrace
+      end
+    end
+
+    it "returns an array containing a nested exception, if given" do
+      begin
+        raise IOError, "no disk, yo"
+      rescue
+        e = Kitchen::StandardError.new("shoot")
+
+        Kitchen::Error.formatted_trace(e).must_equal([
+          "------Exception-------",
+          "Class: Kitchen::StandardError",
+          "Message: shoot",
+          "---Nested Exception---",
+          "Class: IOError",
+          "Message: no disk, yo",
+          "------Backtrace-------",
+          nil,
+          "----------------------"
+        ])
+      end
+    end
+  end
+end
+
+describe Kitchen::StandardError do
+
+  it "is a kind of Kitchen::Error" do
+    Kitchen::StandardError.new("oops").must_be_kind_of Kitchen::Error
+  end
+
+  it "by default, sets original exception to the last raised exception" do
+    begin
+      raise IOError, "crap"
+    rescue
+      original = Kitchen::StandardError.new("oops").original
+      original.must_be_kind_of IOError
+      original.message.must_equal "crap"
+    end
+  end
+
+  it "can embed an exception when constructing" do
+    original = Kitchen::StandardError.new("durn", IOError.new("ack")).original
+    original.must_be_kind_of IOError
+    original.message.must_equal "ack"
+  end
+end
+
+[
+  Kitchen::UserError, Kitchen::ClientError, Kitchen::TransientFailure
+].each do |klass|
+  describe klass do
+
+    it "is a kind of Kitchen::StandardError" do
+      klass.new("oops").must_be_kind_of Kitchen::StandardError
+    end
+  end
+end
+
+[
+  Kitchen::ActionFailed, Kitchen::InstanceFailure
+].each do |klass|
+  describe klass do
+
+    it "is a kind of Kitchen::TransientFailure" do
+      klass.new("oops").must_be_kind_of Kitchen::TransientFailure
+    end
+  end
+end
+
+describe Kitchen do
+
+  describe ".with_friendly_errors" do
+
+    let(:logger_io) { StringIO.new }
+    let(:logger)    { Kitchen::Logger.new(:logdev => logger_io) }
+
+    before do
+      Kitchen.stubs(:tty?).returns(true)
+      @orig_stderr = $stderr
+      $stderr = StringIO.new
+      @orig_logger = Kitchen.logger
+      Kitchen.logger = logger
+    end
+
+    after do
+      $stderr = @orig_stderr
+      Kitchen.logger = @orig_logger
+    end
+
+    describe "for instance failures" do
+
+      def go_boom
+        Kitchen.with_friendly_errors do
+          begin
+            raise IOError, "no stuff"
+          rescue
+            raise Kitchen::InstanceFailure, "cannot do that"
+          end
+        end
+      end
+
+      it "exits with 10" do
+        begin
+          go_boom
+        rescue SystemExit => e
+          e.status.must_equal 10
+        end
+      end
+
+      it "prints a message on STDERR" do
+        output = [
+          ">>>>>> cannot do that",
+          ">>>>>> ------Exception-------",
+          ">>>>>> Class: IOError",
+          ">>>>>> Message: no stuff",
+          ">>>>>> ----------------------"
+        ].map { |l| Kitchen::Color.colorize(l, :red) }.join("\n").concat("\n")
+
+        begin
+          go_boom
+        rescue SystemExit
+          $stderr.string.must_equal output
+        end
+      end
+
+      it "prints a message on STDERR without color" do
+        Kitchen.stubs(:tty?).returns(false)
+        output = [
+          ">>>>>> cannot do that",
+          ">>>>>> ------Exception-------",
+          ">>>>>> Class: IOError",
+          ">>>>>> Message: no stuff",
+          ">>>>>> ----------------------"
+        ].join("\n").concat("\n")
+
+        begin
+          go_boom
+        rescue SystemExit
+          $stderr.string.must_equal output
+        end
+      end
+
+      it "logs the exception message on the common logger's error severity" do
+        begin
+          go_boom
+        rescue SystemExit
+          logger_io.string.must_match(/ERROR -- Kitchen: cannot do that$/)
+        end
+      end
+
+      it "logs the exception message on debug, if set" do
+        logger.level = ::Logger::DEBUG
+
+        begin
+          go_boom
+        rescue SystemExit
+          logger_io.string.must_match(/DEBUG -- Kitchen: cannot do that$/)
+        end
+      end
+    end
+
+    describe "for unexpected failures" do
+
+      def go_boom
+        Kitchen.with_friendly_errors do
+          begin
+            raise IOError, "wtf?"
+          rescue
+            raise Kitchen::StandardError, "ah crap"
+          end
+        end
+      end
+
+      it "exits with 20" do
+        begin
+          go_boom
+        rescue SystemExit => e
+          e.status.must_equal 20
+        end
+      end
+
+      it "prints a message on STDERR" do
+        output = [
+          ">>>>>> ------Exception-------",
+          ">>>>>> Class: Kitchen::StandardError",
+          ">>>>>> Message: ah crap",
+          ">>>>>> ----------------------",
+          ">>>>>> Please see .kitchen/logs/kitchen.log for more details",
+          ">>>>>> Also try running `kitchen diagnose --all` for configuration\n"
+        ].map { |l| Kitchen::Color.colorize(l, :red) }.join("\n").concat("\n")
+
+        begin
+          go_boom
+        rescue SystemExit
+          $stderr.string.must_equal output
+        end
+      end
+
+      it "prints a message on STDERR without color" do
+        Kitchen.stubs(:tty?).returns(false)
+        output = [
+          ">>>>>> ------Exception-------",
+          ">>>>>> Class: Kitchen::StandardError",
+          ">>>>>> Message: ah crap",
+          ">>>>>> ----------------------",
+          ">>>>>> Please see .kitchen/logs/kitchen.log for more details",
+          ">>>>>> Also try running `kitchen diagnose --all` for configuration"
+        ].join("\n").concat("\n")
+
+        begin
+          go_boom
+        rescue SystemExit
+          $stderr.string.must_equal output
+        end
+      end
+
+      it "logs the exception message on the common logger's error severity" do
+        begin
+          go_boom
+        rescue SystemExit
+          logger_io.string.
+            must_match(/ERROR -- Kitchen: ------Exception-------$/)
+          logger_io.string.
+            must_match(/ERROR -- Kitchen: Class: Kitchen::StandardError$/)
+          logger_io.string.
+            must_match(/ERROR -- Kitchen: ------Backtrace-------$/)
+        end
+      end
+
+      it "logs the exception message on debug, if set" do
+        logger.level = ::Logger::DEBUG
+
+        begin
+          go_boom
+        rescue SystemExit
+          logger_io.string.
+            must_match(/DEBUG -- Kitchen: ------Exception-------$/)
+          logger_io.string.
+            must_match(/DEBUG -- Kitchen: Class: Kitchen::StandardError$/)
+          logger_io.string.
+            must_match(/DEBUG -- Kitchen: ------Backtrace-------$/)
+        end
+      end
+    end
+  end
+end

data/spec/kitchen/instance_spec.rb

@@ -16,21 +16,21 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require_relative '../spec_helper'
-require 'stringio'
-
-require 'kitchen/logging'
-require 'kitchen/instance'
-require 'kitchen/driver'
-require 'kitchen/driver/dummy'
-require 'kitchen/platform'
-require 'kitchen/provisioner'
-require 'kitchen/provisioner/dummy'
-require 'kitchen/suite'
+require_relative "../spec_helper"
+require "stringio"
+
+require "kitchen/logging"
+require "kitchen/instance"
+require "kitchen/driver"
+require "kitchen/driver/dummy"
+require "kitchen/platform"
+require "kitchen/provisioner"
+require "kitchen/provisioner/dummy"
+require "kitchen/suite"
 
 class DummyStateFile
 
-  def initialize(*args) ; end
+  def initialize(*); end
 
   def read
     @_state = Hash.new unless @_state
@@ -44,6 +44,10 @@ class DummyStateFile
   def destroy
     @_state = nil
   end
+
+  def diagnose
+    Hash.new
+  end
 end
 
 class SerialDummyDriver < Kitchen::Driver::Dummy
@@ -100,11 +104,11 @@ describe Kitchen::Instance do
   end
 
   def suite(name = "suite")
-    @suite ||= Kitchen::Suite.new({ :name => name })
+    @suite ||= Kitchen::Suite.new(:name => name)
   end
 
   def platform(name = "platform")
-    @platform ||= Kitchen::Platform.new({ :name => name })
+    @platform ||= Kitchen::Platform.new(:name => name)
   end
 
   describe ".name_for" do
@@ -143,6 +147,21 @@ describe Kitchen::Instance do
       Kitchen::Instance.name_for(suite("_s__s_"), platform("pp_")).
         must_equal "-s--s--pp-"
     end
+
+    it "transforms forward slashes to dashes in suite name" do
+      Kitchen::Instance.name_for(suite("suite/ness"), platform("platform")).
+        must_equal "suite-ness-platform"
+    end
+
+    it "transforms forward slashes to dashes in platform name" do
+      Kitchen::Instance.name_for(suite("suite"), platform("platform/s")).
+        must_equal "suite-platform-s"
+    end
+
+    it "transforms forward slashes to dashes in suite and platform names" do
+      Kitchen::Instance.name_for(suite("/s//s/"), platform("pp/")).
+        must_equal "-s--s--pp-"
+    end
   end
 
   describe "#suite" do
@@ -244,13 +263,69 @@ describe Kitchen::Instance do
   end
 
   it "#login executes the driver's login_command" do
-    driver.stubs(:login_command).with(Hash.new).
-      returns(Kitchen::LoginCommand.new(["echo", "hello"], {:purple => true}))
-    Kernel.expects(:exec).with("echo", "hello", {:purple => true})
+    state_file.write(:last_action => "create")
+    driver.stubs(:login_command).with(:last_action => "create").
+      returns(Kitchen::LoginCommand.new(%w[echo hello], :purple => true))
+    Kernel.expects(:exec).with("echo", "hello", :purple => true)
 
     instance.login
   end
 
+  it "#login raises a UserError if the instance is not created" do
+    state_file.write({})
+
+    proc { instance.login }.must_raise Kitchen::UserError
+  end
+
+  describe "#diagnose" do
+
+    it "returns a hash" do
+      instance.diagnose.must_be_instance_of Hash
+    end
+
+    it "sets :state_file key to state_file's diganose info" do
+      state_file.stubs(:diagnose).returns(:a => "b")
+
+      instance.diagnose[:state_file].must_equal(:a => "b")
+    end
+
+    it "sets :state_file key to :unknown if obj can't respond to #diagnose" do
+      opts[:state_file] = Class.new(state_file.class) {
+        undef_method :diagnose
+      }.new
+
+      instance.diagnose[:state_file].must_equal :unknown
+    end
+
+    it "sets :provisioner key to provisioner's diganose info" do
+      provisioner.stubs(:diagnose).returns(:a => "b")
+
+      instance.diagnose[:provisioner].must_equal(:a => "b")
+    end
+
+    it "sets :provisioner key to :unknown if obj can't respond to #diagnose" do
+      opts[:provisioner] = Class.new(provisioner.class) {
+        undef_method :diagnose
+      }.new
+
+      instance.diagnose[:provisioner].must_equal :unknown
+    end
+
+    it "sets :busser key to busser's diganose info" do
+      busser.stubs(:diagnose).returns(:a => "b")
+
+      instance.diagnose[:busser].must_equal(:a => "b")
+    end
+
+    it "sets :busser key to :unknown if obj can't respond to #diagnose" do
+      opts[:busser] = Class.new(busser.class) {
+        undef_method :diagnose
+      }.new(suite.name, {})
+
+      instance.diagnose[:busser].must_equal :unknown
+    end
+  end
+
   describe "performing actions" do
 
     describe "#create" do
@@ -286,7 +361,7 @@ describe Kitchen::Instance do
 
       describe "with last_action of create" do
 
-        before { state_file.write({ :last_action => "create"}) }
+        before { state_file.write(:last_action => "create") }
 
         it "calls Driver#create with state hash" do
           driver.expects(:create).
@@ -337,7 +412,7 @@ describe Kitchen::Instance do
 
       describe "with last action of create" do
 
-        before { state_file.write({ :last_action => "create"}) }
+        before { state_file.write(:last_action => "create") }
 
         it "calls Driver#converge with state hash" do
           driver.expects(:converge).
@@ -355,7 +430,7 @@ describe Kitchen::Instance do
 
       describe "with last action of converge" do
 
-        before { state_file.write({ :last_action => "converge"}) }
+        before { state_file.write(:last_action => "converge") }
 
         it "calls Driver#converge with state hash" do
           driver.expects(:converge).
@@ -408,7 +483,7 @@ describe Kitchen::Instance do
 
       describe "with last action of create" do
 
-        before { state_file.write({ :last_action => "create"}) }
+        before { state_file.write(:last_action => "create") }
 
         it "calls Driver#converge and setup with state hash" do
           driver.expects(:converge).
@@ -428,7 +503,7 @@ describe Kitchen::Instance do
 
       describe "with last action of converge" do
 
-        before { state_file.write({ :last_action => "converge"}) }
+        before { state_file.write(:last_action => "converge") }
 
         it "calls Driver#setup with state hash" do
           driver.expects(:setup).
@@ -446,7 +521,7 @@ describe Kitchen::Instance do
 
       describe "with last action of setup" do
 
-        before { state_file.write({ :last_action => "setup"}) }
+        before { state_file.write(:last_action => "setup") }
 
         it "calls Driver#setup with state hash" do
           driver.expects(:setup).
@@ -501,7 +576,7 @@ describe Kitchen::Instance do
 
       describe "with last of create" do
 
-        before { state_file.write({ :last_action => "create"}) }
+        before { state_file.write(:last_action => "create") }
 
         it "calls Driver#converge, setup, and verify with state hash" do
           driver.expects(:converge).
@@ -523,7 +598,7 @@ describe Kitchen::Instance do
 
       describe "with last of converge" do
 
-        before { state_file.write({ :last_action => "converge"}) }
+        before { state_file.write(:last_action => "converge") }
 
         it "calls Driver#setup, and verify with state hash" do
           driver.expects(:setup).
@@ -543,7 +618,7 @@ describe Kitchen::Instance do
 
       describe "with last of setup" do
 
-        before { state_file.write({ :last_action => "setup"}) }
+        before { state_file.write(:last_action => "setup") }
 
         it "calls Driver#verify with state hash" do
           driver.expects(:verify).
@@ -561,7 +636,7 @@ describe Kitchen::Instance do
 
       describe "with last of verify" do
 
-        before { state_file.write({ :last_action => "verify"}) }
+        before { state_file.write(:last_action => "verify") }
 
         it "calls Driver#verify with state hash" do
           driver.expects(:verify).
@@ -613,7 +688,7 @@ describe Kitchen::Instance do
 
         describe "with last_action of #{action}" do
 
-          before { state_file.write({ :last_action => action}) }
+          before { state_file.write(:last_action => action) }
 
           it "calls Driver#create with state hash" do
             driver.expects(:destroy).
@@ -664,7 +739,7 @@ describe Kitchen::Instance do
 
         describe "with last action of #{action}" do
 
-          before { state_file.write({ :last_action => action}) }
+          before { state_file.write(:last_action => action) }
 
           it "calls Driver#destroy, create, converge, setup, verify, destroy" do
             driver.expects(:destroy)
@@ -695,28 +770,44 @@ describe Kitchen::Instance do
       describe "with destroy mode of always" do
 
         it "calls Driver#destroy at even when action fails" do
-          driver.stubs(:converge).raises(Kitchen::ActionFailed)
-
           driver.expects(:destroy)
           driver.expects(:create)
-          driver.expects(:converge)
+          driver.expects(:converge).raises(Kitchen::ActionFailed)
           driver.expects(:destroy)
 
-          instance.test(:always)
+          begin
+            instance.test(:always)
+          rescue # rubocop:disable Lint/HandleExceptions
+          end
         end
       end
 
       describe "with destroy mode of passing" do
 
         it "doesn't call Driver#destroy at when action fails" do
-          skip "figure this one out"
-          driver.stubs(:create).raises(Kitchen::ActionFailed, "death")
+          driver.stubs(:create).raises(Kitchen::ActionFailed)
 
-          driver.expects(:destroy)
-          driver.expects(:create)
+          driver.expects(:destroy).once
 
-          instance.test(:passing)
+          begin
+            instance.test(:passing)
+          rescue # rubocop:disable Lint/HandleExceptions
+          end
+        end
+      end
+    end
+
+    describe "#remote_exec" do
+
+      before { state_file.write(:last_action => "create") }
+
+      it "calls Driver#remote_command with state and command" do
+        driver.expects(:remote_command).with do |state, command|
+          state.must_equal(:last_action => "create")
+          command.must_equal "uptime"
         end
+
+        instance.remote_exec("uptime")
       end
     end
 
@@ -731,7 +822,8 @@ describe Kitchen::Instance do
         it "write the state file with last action" do
           begin
             instance.public_send(action)
-          rescue Kitchen::Error => e
+          rescue Kitchen::Error
+            true # no need to act here
           end
 
           state_file.read[:last_action].must_be_nil
@@ -754,7 +846,8 @@ describe Kitchen::Instance do
         it "logs the failure" do
           begin
             instance.public_send(action)
-          rescue Kitchen::Error => e
+          rescue Kitchen::Error
+            true # no need to act here
           end
 
           logger_io.string.must_match regex_for(
@@ -771,7 +864,8 @@ describe Kitchen::Instance do
         it "write the state file with last action" do
           begin
             instance.public_send(action)
-          rescue Kitchen::Error => e
+          rescue Kitchen::Error
+            true # no need to act here
           end
 
           state_file.read[:last_action].must_be_nil
@@ -794,7 +888,8 @@ describe Kitchen::Instance do
         it "logs the failure" do
           begin
             instance.public_send(action)
-          rescue Kitchen::Error => e
+          rescue Kitchen::Error
+            true # no need to act here
           end
 
           logger_io.string.must_match regex_for(
@@ -812,10 +907,11 @@ describe Kitchen::Instance do
       [:create, :converge, :setup].each do |action|
 
         it "for last state #{action}" do
-          state_file.write({ :last_action => action.to_s })
+          state_file.write(:last_action => action.to_s)
           begin
             instance.verify
-          rescue Kitchen::Error => e
+          rescue Kitchen::Error
+            true # no need to act here
           end
 
           state_file.read[:last_action].must_equal "setup"
@@ -823,10 +919,11 @@ describe Kitchen::Instance do
       end
 
       it "for last state verify" do
-        state_file.write({ :last_action => "verify" })
+        state_file.write(:last_action => "verify")
         begin
           instance.verify
-        rescue Kitchen::Error => e
+        rescue Kitchen::Error
+          true # no need to act here
         end
 
         state_file.read[:last_action].must_equal "verify"