test-kitchen 1.2.1 → 1.3.0

data/spec/kitchen/diagnostic_spec.rb

@@ -0,0 +1,79 @@
+# -*- 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/diagnostic"
+
+describe Kitchen::Diagnostic do
+
+  let(:loader) do
+    stub(:diagnose => { :who => "loader" })
+  end
+
+  let(:instances) do
+    [
+      stub(:name => "i1", :diagnose => { :stuff => "sup" }),
+      stub(:name => "i2", :diagnose => { :stuff => "yo" })
+    ]
+  end
+
+  it "#read returns a Hash" do
+    Kitchen::Diagnostic.new.read.must_be_instance_of Hash
+  end
+
+  it "#read returns the version of Test Kitchen" do
+    Kitchen::Diagnostic.new.read["kitchen_version"].must_equal Kitchen::VERSION
+  end
+
+  it "#read returns a timestamp in UTC" do
+    Time.stubs(:now).returns(Time.at(0))
+
+    Kitchen::Diagnostic.new.read["timestamp"].
+      must_equal "1970-01-01 00:00:00 UTC"
+  end
+
+  it "#read doesn't return a loader hash if not given one" do
+    Kitchen::Diagnostic.new.read.key?("loader").must_equal false
+  end
+
+  it "#read returns the loader's diganose hash if a loader is present" do
+    Kitchen::Diagnostic.new(:loader => loader).
+      read["loader"].must_equal("who" => "loader")
+  end
+
+  it "#read returns an error hash for loader if error hash is passed in" do
+    Kitchen::Diagnostic.new(:loader => { :error => "damn" }).
+      read["loader"].must_equal("error" => "damn")
+  end
+
+  it "#read returns an empty hash if no instances were given" do
+    Kitchen::Diagnostic.new.read["instances"].must_equal Hash.new
+  end
+
+  it "#read returns the instances' diganose hashes if instances are present" do
+    Kitchen::Diagnostic.new(:instances => instances).
+      read["instances"].
+      must_equal("i1" => { "stuff" => "sup" }, "i2" => { "stuff" => "yo" })
+  end
+
+  it "#read returns an error hash for instances if error hash is passed in" do
+    Kitchen::Diagnostic.new(:instances => { :error => "shoot" }).
+      read["instances"].must_equal("error" => "shoot")
+  end
+end

data/spec/kitchen/driver/base_spec.rb

@@ -16,41 +16,28 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require_relative '../../spec_helper'
-require 'logger'
-require 'stringio'
+require_relative "../../spec_helper"
+require "logger"
+require "stringio"
 
-require 'kitchen'
+require "kitchen"
 
 module Kitchen
 
   module Driver
 
-    class StaticDefaults < Base
-
-      default_config :beans, "kidney"
-      default_config :tunables, { 'flimflam' => 'positate' }
-      default_config :edible, true
+    class Speedy < Base
     end
 
-    class SubclassDefaults < StaticDefaults
+    class Dodgy < Base
 
-      default_config :yea, "ya"
+      no_parallel_for :converge
     end
 
-    class ComputedDefaults < Base
-
-      default_config :beans, "kidney"
-      default_config :fetch_command, "curl"
-      default_config :beans_url do |driver|
-        "http://gim.me/#{driver[:beans]}"
-      end
-      default_config :command do |driver|
-        "#{driver[:fetch_command]} #{driver[:beans_url]}"
-      end
-      default_config :fetch_url do |driver|
-        "http://gim.me/beans-for/#{driver.instance.name}"
-      end
+    class Slow < Base
+
+      no_parallel_for :create, :destroy
+      no_parallel_for :verify
     end
   end
 end
@@ -62,96 +49,104 @@ describe Kitchen::Driver::Base do
   let(:config)        { Hash.new }
   let(:state)         { Hash.new }
 
-  let(:instance) do
-    stub(:name => "coolbeans", :logger => logger, :to_str => "instance")
+  let(:busser) do
+    stub(:setup_cmd => "setup", :sync_cmd => "sync", :run_cmd => "run")
   end
 
-  describe "user config" do
+  let(:instance) do
+    stub(
+      :name => "coolbeans",
+      :logger => logger,
+      :busser => busser,
+      :to_str => "instance"
+    )
+  end
 
-    let(:driver) do
-      d = Kitchen::Driver::Base.new(config)
-      d.instance = instance
-      d
-    end
+  let(:driver) do
+    Kitchen::Driver::Base.new(config).finalize_config!(instance)
+  end
 
-    it "injects config into driver" do
-      config[:fruit] = %w{apples oranges}
-      config[:cool_enough] = true
+  it "#instance returns its instance" do
+    driver.instance.must_equal instance
+  end
 
-      driver[:fruit].must_equal ['apples', 'oranges']
-      driver[:cool_enough].must_equal true
-    end
+  it "#name returns the name of the driver" do
+    driver.name.must_equal "Base"
   end
 
-  describe "static default config" do
+  describe "#logger" do
 
-    let(:driver) do
-      d = Kitchen::Driver::StaticDefaults.new(config)
-      d.instance = instance
-      d
-    end
+    before  { @klog = Kitchen.logger }
+    after   { Kitchen.logger = @klog }
 
-    it "uses default config" do
-      driver[:beans].must_equal "kidney"
-      driver[:tunables]['flimflam'].must_equal 'positate'
-      driver[:edible].must_equal true
+    it "returns the instance's logger if defined" do
+      driver.send(:logger).must_equal logger
     end
 
-    it "uses user config over default config" do
-      config[:beans] = "pinto"
-      config[:edible] = false
+    it "returns the default logger if instance's logger is not set" do
+      driver = Kitchen::Driver::Base.new(config)
+      Kitchen.logger = "yep"
 
-      driver[:beans].must_equal "pinto"
-      driver[:edible].must_equal false
+      driver.send(:logger).must_equal Kitchen.logger
     end
   end
 
-  describe "inherited static default config" do
+  it "#puts calls logger.info" do
+    driver.send(:puts, "yo")
 
-    let(:driver) do
-      p = Kitchen::Driver::SubclassDefaults.new(config)
-      p.instance = instance
-      p
-    end
+    logged_output.string.must_match(/I, /)
+    logged_output.string.must_match(/yo\n/)
+  end
 
-    it "contains defaults from superclass" do
-      driver[:beans].must_equal "kidney"
-      driver[:tunables]['flimflam'].must_equal 'positate'
-      driver[:edible].must_equal true
-      driver[:yea].must_equal "ya"
-    end
+  it "#print calls logger.info" do
+    driver.send(:print, "yo")
+
+    logged_output.string.must_match(/I, /)
+    logged_output.string.must_match(/yo\n/)
+  end
 
-    it "uses user config over default config" do
-      config[:beans] = "pinto"
-      config[:edible] = false
+  [:create, :converge, :setup, :verify, :destroy].each do |action|
 
-      driver[:beans].must_equal "pinto"
-      driver[:edible].must_equal false
-      driver[:yea].must_equal "ya"
+    it "has a #{action} method that takes state" do
+      state = Hash.new
+      driver.public_send(action, state).must_be_nil
     end
   end
 
-  describe "computed default config" do
+  it "has a login command that raises ActionFailed by default" do
+    proc { driver.login_command(Hash.new) }.must_raise Kitchen::ActionFailed
+  end
 
-    let(:driver) do
-      d = Kitchen::Driver::ComputedDefaults.new(config)
-      d.instance = instance
-      d
-    end
+  it "has a default verify dependencies method" do
+    driver.verify_dependencies.must_be_nil
+  end
 
-    it "uses computed config" do
-      driver[:beans_url].must_equal "http://gim.me/kidney"
-      driver[:command].must_equal "curl http://gim.me/kidney"
+  it "#busser returns the instance's busser" do
+    driver.send(:busser).must_equal busser
+  end
+
+  describe ".no_parallel_for" do
+
+    it "registers no serial actions when none are declared" do
+      Kitchen::Driver::Speedy.serial_actions.must_equal nil
     end
 
-    it "has access to instance object" do
-      driver[:fetch_url].must_equal "http://gim.me/beans-for/coolbeans"
+    it "registers a single serial action method" do
+      Kitchen::Driver::Dodgy.serial_actions.must_equal [:converge]
     end
 
-    it "uses user config over default config" do
-      config[:command] = "echo listentome"
+    it "registers multiple serial action methods" do
+      actions = Kitchen::Driver::Slow.serial_actions
+
+      actions.must_include :create
+      actions.must_include :verify
+      actions.must_include :destroy
+    end
 
-      driver[:command].must_equal "echo listentome"
+    it "raises a ClientError if value is not an action method" do
+      proc {
+        Class.new(Kitchen::Driver::Base) { no_parallel_for :telling_stories }
+      }.must_raise Kitchen::ClientError
     end
   end
 end

data/spec/kitchen/driver/dummy_spec.rb

@@ -16,11 +16,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require_relative '../../spec_helper'
-require 'logger'
-require 'stringio'
+require_relative "../../spec_helper"
+require "logger"
+require "stringio"
 
-require 'kitchen/driver/dummy'
+require "kitchen/driver/dummy"
 
 describe Kitchen::Driver::Dummy do
 
@@ -34,9 +34,7 @@ describe Kitchen::Driver::Dummy do
   end
 
   let(:driver) do
-    d = Kitchen::Driver::Dummy.new(config)
-    d.instance = instance
-    d
+    Kitchen::Driver::Dummy.new(config).finalize_config!(instance)
   end
 
   describe "default_config" do
@@ -55,7 +53,7 @@ describe Kitchen::Driver::Dummy do
     it "sets :my_id to a unique value as an example" do
       driver.create(state)
 
-      state[:my_id].must_match /^coolbeans-/
+      state[:my_id].must_match(/^coolbeans-/)
     end
 
     it "calls sleep if :sleep value is greater than 0" do
@@ -65,6 +63,12 @@ describe Kitchen::Driver::Dummy do
       driver.create(state)
     end
 
+    it "raises ActionFailed if :fail_create is set" do
+      config[:fail_create] = true
+
+      proc { driver.create(state) }.must_raise Kitchen::ActionFailed
+    end
+
     it "randomly raises ActionFailed if :random_failure is set" do
       config[:random_failure] = true
       driver.stubs(:randomly_fail?).returns(true)
@@ -77,16 +81,17 @@ describe Kitchen::Driver::Dummy do
 
       begin
         driver.create(state)
-      rescue Kitchen::ActionFailed => ex
+      rescue Kitchen::ActionFailed
         # If exception is anything other than Kitchen::ActionFailed, this spec
         # will fail
+        true
       end
     end
 
     it "logs a create event to INFO" do
       driver.create(state)
 
-      logged_output.string.must_match /^.+ INFO .+ \[Dummy\] Create on .+$/
+      logged_output.string.must_match(/^.+ INFO .+ \[Dummy\] Create on .+$/)
     end
   end
 
@@ -99,6 +104,12 @@ describe Kitchen::Driver::Dummy do
       driver.create(state)
     end
 
+    it "raises ActionFailed if :fail_converge is set" do
+      config[:fail_converge] = true
+
+      proc { driver.converge(state) }.must_raise Kitchen::ActionFailed
+    end
+
     it "randomly raises ActionFailed if :random_failure is set" do
       config[:random_failure] = true
       driver.stubs(:randomly_fail?).returns(true)
@@ -109,7 +120,7 @@ describe Kitchen::Driver::Dummy do
     it "logs a converge event to INFO" do
       driver.converge(state)
 
-      logged_output.string.must_match /^.+ INFO .+ \[Dummy\] Converge on .+$/
+      logged_output.string.must_match(/^.+ INFO .+ \[Dummy\] Converge on .+$/)
     end
   end
 
@@ -122,6 +133,12 @@ describe Kitchen::Driver::Dummy do
       driver.setup(state)
     end
 
+    it "raises ActionFailed if :fail_setup is set" do
+      config[:fail_setup] = true
+
+      proc { driver.setup(state) }.must_raise Kitchen::ActionFailed
+    end
+
     it "randomly raises ActionFailed if :random_failure is set" do
       config[:random_failure] = true
       driver.stubs(:randomly_fail?).returns(true)
@@ -132,7 +149,7 @@ describe Kitchen::Driver::Dummy do
     it "logs a setup event to INFO" do
       driver.setup(state)
 
-      logged_output.string.must_match /^.+ INFO .+ \[Dummy\] Setup on .+$/
+      logged_output.string.must_match(/^.+ INFO .+ \[Dummy\] Setup on .+$/)
     end
   end
 
@@ -145,6 +162,12 @@ describe Kitchen::Driver::Dummy do
       driver.verify(state)
     end
 
+    it "raises ActionFailed if :fail_verify is set" do
+      config[:fail_verify] = true
+
+      proc { driver.verify(state) }.must_raise Kitchen::ActionFailed
+    end
+
     it "randomly raises ActionFailed if :random_failure is set" do
       config[:random_failure] = true
       driver.stubs(:randomly_fail?).returns(true)
@@ -155,7 +178,7 @@ describe Kitchen::Driver::Dummy do
     it "logs a verify event to INFO" do
       driver.verify(state)
 
-      logged_output.string.must_match /^.+ INFO .+ \[Dummy\] Verify on .+$/
+      logged_output.string.must_match(/^.+ INFO .+ \[Dummy\] Verify on .+$/)
     end
   end
 
@@ -175,6 +198,12 @@ describe Kitchen::Driver::Dummy do
       driver.verify(state)
     end
 
+    it "raises ActionFailed if :fail_destroy is set" do
+      config[:fail_destroy] = true
+
+      proc { driver.destroy(state) }.must_raise Kitchen::ActionFailed
+    end
+
     it "randomly raises ActionFailed if :random_failure is set" do
       config[:random_failure] = true
       driver.stubs(:randomly_fail?).returns(true)
@@ -185,7 +214,7 @@ describe Kitchen::Driver::Dummy do
     it "logs a destroy event to INFO" do
       driver.destroy(state)
 
-      logged_output.string.must_match /^.+ INFO .+ \[Dummy\] Destroy on .+$/
+      logged_output.string.must_match(/^.+ INFO .+ \[Dummy\] Destroy on .+$/)
     end
   end
 end

data/spec/kitchen/driver/proxy_spec.rb

@@ -0,0 +1,134 @@
+# -*- 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/driver/proxy"
+
+describe Kitchen::Driver::Proxy do
+
+  let(:logged_output) { StringIO.new }
+  let(:logger)        { Logger.new(logged_output) }
+  let(:state)         { Hash.new }
+
+  let(:config) do
+    { :host => "foobnoobs.com", :reset_command => "mulligan" }
+  end
+
+  let(:instance) do
+    stub(:name => "coolbeans", :logger => logger, :to_str => "instance")
+  end
+
+  let(:driver) do
+    Kitchen::Driver::Proxy.new(config).finalize_config!(instance)
+  end
+
+  describe "non-parallel action" do
+
+    it "create must be serially executed" do
+      Kitchen::Driver::Proxy.serial_actions.must_include :create
+    end
+
+    it "destroy must be serially executed" do
+      Kitchen::Driver::Proxy.serial_actions.must_include :destroy
+    end
+  end
+
+  describe "required_config" do
+
+    [:host, :reset_command].each do |attr|
+      it "requires :#{attr}" do
+        config.delete(attr)
+
+        begin
+          driver
+          flunk "UserError must be raised for missing :#{attr}"
+        rescue Kitchen::UserError => e
+          e.message.must_match regexify("config[:#{attr}] cannot be blank")
+        end
+      end
+    end
+
+    def regexify(str)
+      Regexp.new(Regexp.escape(str))
+    end
+  end
+
+  describe "#create" do
+
+    it "sets :hostname in state config" do
+      driver.stubs(:ssh)
+      driver.create(state)
+
+      state[:hostname].must_equal "foobnoobs.com"
+    end
+
+    it "calls the reset command over ssh" do
+      driver.expects(:ssh).with do |ssh_args, cmd|
+        ssh_args[0].must_equal "foobnoobs.com"
+        cmd.must_equal "mulligan"
+      end
+
+      driver.create(state)
+    end
+
+    it "skips ssh call if :reset_command is falsey" do
+      config[:reset_command] = false
+      driver.expects(:ssh).never
+
+      driver.create(state)
+    end
+  end
+
+  describe "#destroy" do
+
+    before do
+      state[:hostname] = "beep"
+    end
+
+    it "deletes :hostname in state config" do
+      driver.stubs(:ssh)
+      driver.destroy(state)
+
+      state[:hostname].must_equal nil
+    end
+
+    it "calls the reset command over ssh" do
+      driver.expects(:ssh).with do |ssh_args, cmd|
+        ssh_args[0].must_equal "beep"
+        cmd.must_equal "mulligan"
+      end
+
+      driver.destroy(state)
+    end
+
+    it "skips ssh call if :hostname is not in state config" do
+      state.delete(:hostname)
+      driver.expects(:ssh).never
+
+      driver.destroy(state)
+    end
+
+    it "skips ssh call if :reset_command is falsey" do
+      config[:reset_command] = false
+      driver.expects(:ssh).never
+
+      driver.destroy(state)
+    end
+  end
+end