test-kitchen 1.3.1 → 1.4.0.beta.1

data/spec/kitchen/provisioner/dummy_spec.rb

@@ -0,0 +1,91 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
+#
+# Copyright (C) 2015, 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 "logger"
+require "stringio"
+
+require "kitchen/provisioner/dummy"
+
+describe Kitchen::Provisioner::Dummy do
+
+  let(:logged_output) { StringIO.new }
+  let(:logger)        { Logger.new(logged_output) }
+  let(:platform)      { stub(:os_type => nil, :shell_type => nil) }
+  let(:suite)         { stub(:name => "fries") }
+  let(:state)         { Hash.new }
+
+  let(:config) do
+    { :test_base_path => "/basist", :kitchen_root => "/rooty" }
+  end
+
+  let(:instance) do
+    stub(
+      :name => "coolbeans",
+      :to_str => "instance",
+      :logger => logger,
+      :suite => suite,
+      :platform => platform
+    )
+  end
+
+  let(:provisioner) do
+    Kitchen::Provisioner::Dummy.new(config).finalize_config!(instance)
+  end
+
+  describe "configuration" do
+
+    it "sets :sleep to 0 by default" do
+      provisioner[:sleep].must_equal 0
+    end
+
+    it "sets :random_failure to false by default" do
+      provisioner[:random_failure].must_equal false
+    end
+  end
+
+  describe "#call" do
+
+    it "calls sleep if :sleep value is greater than 0" do
+      config[:sleep] = 12.5
+      provisioner.expects(:sleep).with(12.5).returns(true)
+
+      provisioner.call(state)
+    end
+
+    it "raises ActionFailed if :fail is set" do
+      config[:fail] = true
+
+      proc { provisioner.call(state) }.must_raise Kitchen::ActionFailed
+    end
+
+    it "randomly raises ActionFailed if :random_failure is set" do
+      config[:random_failure] = true
+      provisioner.stubs(:randomly_fail?).returns(true)
+
+      proc { provisioner.call(state) }.must_raise Kitchen::ActionFailed
+    end
+
+    it "logs a converge event to INFO" do
+      provisioner.call(state)
+
+      logged_output.string.must_match(/^.+ INFO .+ \[Dummy\] Converge on .+$/)
+    end
+  end
+end

data/spec/kitchen/provisioner/shell_spec.rb

@@ -25,17 +25,20 @@ describe Kitchen::Provisioner::Shell do
 
   let(:logged_output)   { StringIO.new }
   let(:logger)          { Logger.new(logged_output) }
+  let(:platform)        { stub(:os_type => nil, :shell_type => nil) }
+  let(:suite)           { stub(:name => "fries") }
 
   let(:config) do
     { :test_base_path => "/basist", :kitchen_root => "/rooty" }
   end
 
-  let(:suite) do
-    stub(:name => "fries")
-  end
-
   let(:instance) do
-    stub(:name => "coolbeans", :logger => logger, :suite => suite)
+    stub(
+      :name => "coolbeans",
+      :logger => logger,
+      :suite => suite,
+      :platform => platform
+    )
   end
 
   let(:provisioner) do
@@ -48,8 +51,22 @@ describe Kitchen::Provisioner::Shell do
 
   describe "configuration" do
 
-    it ":script uses calculate_path and is expanded" do
-      provisioner[:script].must_equal "/rooty/<calculated>/bootstrap.sh"
+    describe "for bourne shells" do
+
+      before { platform.stubs(:shell_type).returns("bourne") }
+
+      it ":script uses calculate_path and is expanded" do
+        provisioner[:script].must_equal "/rooty/<calculated>/bootstrap.sh"
+      end
+    end
+
+    describe "for powershell shells" do
+
+      before { platform.stubs(:shell_type).returns("powershell") }
+
+      it ":script uses calculate_path and is expanded" do
+        provisioner[:script].must_equal "/rooty/<calculated>/bootstrap.ps1"
+      end
     end
 
     it ":data_path uses calculate_path and is expanded" do
@@ -61,36 +78,69 @@ describe Kitchen::Provisioner::Shell do
 
     let(:cmd) { provisioner.init_command }
 
-    it "uses bourne shell" do
-      cmd.must_match(/\Ash -c '$/)
-      cmd.must_match(/'\Z/)
-    end
+    describe "for bourne shells" do
 
-    it "uses sudo for rm when configured" do
-      config[:sudo] = true
+      before { platform.stubs(:shell_type).returns("bourne") }
 
-      cmd.must_match regexify("sudo -E rm -rf ", :partial_line)
-    end
+      it "uses bourne shell" do
+        cmd.must_match(/\Ash -c '$/)
+        cmd.must_match(/'\Z/)
+      end
 
-    it "does not use sudo for rm when configured" do
-      config[:sudo] = false
+      it "uses sudo for rm when configured" do
+        config[:sudo] = true
 
-      provisioner.init_command.
-        must_match regexify("rm -rf ", :partial_line)
-      provisioner.init_command.
-        wont_match regexify("sudo -E rm -rf ", :partial_line)
-    end
+        cmd.must_match regexify("sudo -E rm -rf ", :partial_line)
+      end
 
-    it "removes the data directory" do
-      config[:root_path] = "/route"
+      it "does not use sudo for rm when configured" do
+        config[:sudo] = false
+
+        provisioner.init_command.
+          must_match regexify("rm -rf ", :partial_line)
+        provisioner.init_command.
+          wont_match regexify("sudo -E rm -rf ", :partial_line)
+      end
 
-      cmd.must_match %r{rm -rf\b.*\s+/route/data\s+}
+      it "removes the data directory" do
+        config[:root_path] = "/route"
+
+        cmd.must_match %r{rm -rf\b.*\s+/route/data\s+}
+      end
+
+      it "creates :root_path directory" do
+        config[:root_path] = "/root/path"
+
+        cmd.must_match regexify("mkdir -p /root/path", :partial_line)
+      end
     end
 
-    it "creates :root_path directory" do
-      config[:root_path] = "/root/path"
+    describe "for powershell shells on windows os types" do
+
+      before do
+        platform.stubs(:os_type).returns("windows")
+        platform.stubs(:shell_type).returns("powershell")
+      end
+
+      it "removes the data directory" do
+        config[:root_path] = "\\route"
+
+        cmd.must_match regexify(Kitchen::Util.outdent!(<<-POWERSHELL).chomp)
+          if (Test-Path "\\route\\data") {
+            Remove-Item "\\route\\data" -Recurse -Force
+          }
+        POWERSHELL
+      end
+
+      it "creates the :root_path directory" do
+        config[:root_path] = "\\route"
 
-      cmd.must_match regexify("mkdir -p /root/path", :partial_line)
+        cmd.must_match regexify(Kitchen::Util.outdent!(<<-POWERSHELL).chomp)
+          if (-Not (Test-Path "\\route")) {
+            New-Item "\\route" -ItemType directory | Out-Null
+          }
+        POWERSHELL
+      end
     end
   end
 
@@ -98,24 +148,43 @@ describe Kitchen::Provisioner::Shell do
 
     let(:cmd) { provisioner.run_command }
 
-    it "uses bourne shell" do
-      cmd.must_match(/\Ash -c '$/)
-      cmd.must_match(/'\Z/)
-    end
+    describe "for bourne shells" do
+
+      before { platform.stubs(:shell_type).returns("bourne") }
+
+      it "uses bourne shell" do
+        cmd.must_match(/\Ash -c '$/)
+        cmd.must_match(/'\Z/)
+      end
+
+      it "uses sudo for script when configured" do
+        config[:root_path] = "/r"
+        config[:sudo] = true
 
-    it "uses sudo for script when configured" do
-      config[:root_path] = "/r"
-      config[:sudo] = true
+        cmd.must_match regexify("sudo -E /r/bootstrap.sh", :partial_line)
+      end
 
-      cmd.must_match regexify("sudo -E /r/bootstrap.sh", :partial_line)
+      it "does not use sudo for script when configured" do
+        config[:root_path] = "/r"
+        config[:sudo] = false
+
+        cmd.must_match regexify("/r/bootstrap.sh", :partial_line)
+        cmd.wont_match regexify("sudo -E /r/bootstrap.sh", :partial_line)
+      end
     end
 
-    it "does not use sudo for script when configured" do
-      config[:root_path] = "/r"
-      config[:sudo] = false
+    describe "for powershell shells on windows os types" do
+
+      before do
+        platform.stubs(:shell_type).returns("powershell")
+        platform.stubs(:os_type).returns("windows")
+      end
+
+      it "invokes the bootstrap.ps1 script" do
+        config[:root_path] = "\\r"
 
-      cmd.must_match regexify("/r/bootstrap.sh", :partial_line)
-      cmd.wont_match regexify("sudo -E /r/bootstrap.sh", :partial_line)
+        cmd.must_equal %{& "\\r\\bootstrap.ps1"}
+      end
     end
   end
 
@@ -213,27 +282,60 @@ describe Kitchen::Provisioner::Shell do
 
         before { config[:script] = nil }
 
-        it "logs a message on info" do
-          provisioner.create_sandbox
+        describe "for bourne shells" do
 
-          logged_output.string.must_match info_line("Preparing script")
-        end
+          before { platform.stubs(:shell_type).returns("bourne") }
 
-        it "logs a warning on info" do
-          provisioner.create_sandbox
+          it "logs a message on info" do
+            provisioner.create_sandbox
+
+            logged_output.string.must_match info_line("Preparing script")
+          end
 
-          logged_output.string.must_match info_line(
-            "bootstrap.sh not found so Kitchen will run a stubbed script. " \
-            "Is this intended?")
+          it "logs a warning on info" do
+            provisioner.create_sandbox
+
+            logged_output.string.must_match info_line(
+              "bootstrap.sh not found so Kitchen will run a stubbed script. " \
+              "Is this intended?")
+          end
+
+          it "creates a file in the sandbox directory" do
+            provisioner.create_sandbox
+
+            sandbox_path("bootstrap.sh").file?.must_equal true
+            sandbox_path("bootstrap.sh").executable?.must_equal true
+            IO.read(sandbox_path("bootstrap.sh")).
+              must_match(/NO BOOTSTRAP SCRIPT PRESENT/)
+          end
         end
 
-        it "creates a file in the sandbox directory" do
-          provisioner.create_sandbox
+        describe "for powershell shells" do
+
+          before { platform.stubs(:shell_type).returns("powershell") }
 
-          sandbox_path("bootstrap.sh").file?.must_equal true
-          sandbox_path("bootstrap.sh").executable?.must_equal true
-          IO.read(sandbox_path("bootstrap.sh")).
-            must_match(/NO BOOTSTRAP SCRIPT PRESENT/)
+          it "logs a message on info" do
+            provisioner.create_sandbox
+
+            logged_output.string.must_match info_line("Preparing script")
+          end
+
+          it "logs a warning on info" do
+            provisioner.create_sandbox
+
+            logged_output.string.must_match info_line(
+              "bootstrap.ps1 not found so Kitchen will run a stubbed script. " \
+              "Is this intended?")
+          end
+
+          it "creates a file in the sandbox directory" do
+            provisioner.create_sandbox
+
+            sandbox_path("bootstrap.ps1").file?.must_equal true
+            sandbox_path("bootstrap.ps1").executable?.must_equal true
+            IO.read(sandbox_path("bootstrap.ps1")).
+              must_match(/Write-Host "NO BOOTSTRAP SCRIPT PRESENT`n"/)
+          end
         end
       end
     end

data/spec/kitchen/provisioner_spec.rb

@@ -18,6 +18,7 @@
 
 require_relative "../spec_helper"
 
+require "kitchen/configurable"
 require "kitchen/errors"
 require "kitchen/logging"
 require "kitchen/provisioner"
@@ -29,6 +30,27 @@ module Kitchen
 
     class Coolbeans < Kitchen::Provisioner::Base
     end
+
+    class ItDepends < Kitchen::Provisioner::Base
+
+      attr_reader :verify_call_count
+
+      def initialize(config = {})
+        @verify_call_count = 0
+        super
+      end
+
+      def verify_dependencies
+        @verify_call_count += 1
+      end
+    end
+
+    class UnstableDepends < Kitchen::Provisioner::Base
+
+      def verify_dependencies
+        raise UserError, "Oh noes, you don't have software!"
+      end
+    end
   end
 end
 
@@ -52,6 +74,21 @@ describe Kitchen::Provisioner do
       provisioner[:foo].must_equal "bar"
     end
 
+    it "calls #verify_dependencies on the provisioner object" do
+      provisioner = Kitchen::Provisioner.for_plugin("it_depends", {})
+
+      provisioner.verify_call_count.must_equal 1
+    end
+
+    it "calls #verify_dependencies once per provisioner require" do
+      Kitchen::Provisioner.stubs(:require).returns(true, false)
+      provisioner1 = Kitchen::Provisioner.for_plugin("it_depends", {})
+      provisioner1.verify_call_count.must_equal 1
+      provisioner2 = Kitchen::Provisioner.for_plugin("it_depends", {})
+
+      provisioner2.verify_call_count.must_equal 0
+    end
+
     it "raises ClientError if the provisioner could not be required" do
       Kitchen::Provisioner.stubs(:require).raises(LoadError)
 

data/spec/kitchen/ssh_spec.rb

@@ -19,8 +19,8 @@
 require_relative "../spec_helper"
 
 require "net/ssh/test"
-
 require "kitchen/ssh"
+require "tmpdir"
 
 # Hack to sort results in `Dir.entries` only within the yielded block, to limit
 # the "behavior pollution" to other code. This was needed for Net::SCP, as
@@ -406,7 +406,7 @@ describe Kitchen::SSH do
     end
 
     it "logs upload progress to debug" do
-      remote_base = "/tmp/#{File.basename(@dir)}"
+      remote_base = "#{Dir.tmpdir}/#{File.basename(@dir)}"
 
       with_sorted_dir_entries do
         assert_scripted { ssh.upload_path!(@dir, "/tmp/remote") }
@@ -492,84 +492,84 @@ describe Kitchen::SSH do
   describe "#login_command" do
 
     let(:login_command) { ssh.login_command }
-    let(:cmd)           { login_command.cmd_array.join(" ") }
+    let(:args)          { login_command.arguments.join(" ") }
 
     it "returns a LoginCommand" do
       login_command.must_be_instance_of Kitchen::LoginCommand
     end
 
     it "is an SSH command" do
-      cmd.must_match %r{^ssh }
-      cmd.must_match %r{ me@foo$}
+      login_command.command.must_equal "ssh"
+      args.must_match %r{ me@foo$}
     end
 
     it "sets the UserKnownHostsFile option" do
-      cmd.must_match regexify(" -o UserKnownHostsFile=/dev/null ")
+      args.must_match regexify("-o UserKnownHostsFile=/dev/null ")
     end
 
     it "sets the StrictHostKeyChecking option" do
-      cmd.must_match regexify(" -o StrictHostKeyChecking=no ")
+      args.must_match regexify(" -o StrictHostKeyChecking=no ")
     end
 
     it "won't set IdentitiesOnly option by default" do
-      cmd.wont_match regexify(" -o IdentitiesOnly=")
+      args.wont_match regexify(" -o IdentitiesOnly=")
     end
 
     it "sets the IdentiesOnly option if :keys option is given" do
       opts[:keys] = ["yep"]
 
-      cmd.must_match regexify(" -o IdentitiesOnly=yes ")
+      args.must_match regexify(" -o IdentitiesOnly=yes ")
     end
 
     it "sets the LogLevel option to VERBOSE if logger is set to debug" do
       logger.level = ::Logger::DEBUG
       opts[:logger] = logger
 
-      cmd.must_match regexify(" -o LogLevel=VERBOSE ")
+      args.must_match regexify(" -o LogLevel=VERBOSE ")
     end
 
     it "sets the LogLevel option to ERROR if logger is not set to debug" do
       logger.level = ::Logger::INFO
       opts[:logger] = logger
 
-      cmd.must_match regexify(" -o LogLevel=ERROR ")
+      args.must_match regexify(" -o LogLevel=ERROR ")
     end
 
     it "won't set the ForwardAgent option by default" do
-      cmd.wont_match regexify(" -o ForwardAgent=")
+      args.wont_match regexify(" -o ForwardAgent=")
     end
 
     it "sets the ForwardAgent option to yes if truthy" do
       opts[:forward_agent] = "yep"
 
-      cmd.must_match regexify(" -o ForwardAgent=yes")
+      args.must_match regexify(" -o ForwardAgent=yes")
     end
 
     it "sets the ForwardAgent option to no if falsey" do
       opts[:forward_agent] = false
 
-      cmd.must_match regexify(" -o ForwardAgent=no")
+      args.must_match regexify(" -o ForwardAgent=no")
     end
 
     it "won't add any SSH keys by default" do
-      cmd.wont_match regexify(" -i ")
+      args.wont_match regexify(" -i ")
     end
 
     it "sets SSH keys options if given" do
       opts[:keys] = %w[one two]
 
-      cmd.must_match regexify(" -i one ")
-      cmd.must_match regexify(" -i two ")
+      args.must_match regexify(" -i one ")
+      args.must_match regexify(" -i two ")
     end
 
     it "sets the port option to 22 by default" do
-      cmd.must_match regexify(" -p 22 ")
+      args.must_match regexify(" -p 22 ")
     end
 
     it "sets the port option" do
       opts[:port] = 1234
 
-      cmd.must_match regexify(" -p 1234 ")
+      args.must_match regexify(" -p 1234 ")
     end
   end