test-kitchen 1.7.0 → 1.7.1.dev

data/spec/kitchen/provisioner/dummy_spec.rb

@@ -1,99 +1,99 @@
-# -*- 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
-
-  it "provisioner api_version is 2" do
-    provisioner.diagnose_plugin[:api_version].must_equal 2
-  end
-
-  it "plugin_version is set to Kitchen::VERSION" do
-    provisioner.diagnose_plugin[:version].must_equal Kitchen::VERSION
-  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
+# -*- 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
+
+  it "provisioner api_version is 2" do
+    provisioner.diagnose_plugin[:api_version].must_equal 2
+  end
+
+  it "plugin_version is set to Kitchen::VERSION" do
+    provisioner.diagnose_plugin[:version].must_equal Kitchen::VERSION
+  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

@@ -1,566 +1,566 @@
-# -*- 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/provisioner/shell"
-
-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(:instance) do
-    stub(
-      :name => "coolbeans",
-      :logger => logger,
-      :suite => suite,
-      :platform => platform
-    )
-  end
-
-  let(:provisioner) do
-    Class.new(Kitchen::Provisioner::Shell) {
-      def calculate_path(path, _opts = {})
-        "<calculated>/#{path}"
-      end
-    }.new(config).finalize_config!(instance)
-  end
-
-  it "provisioner api_version is 2" do
-    provisioner = Kitchen::Provisioner::Shell.new(config).finalize_config!(instance)
-    provisioner.diagnose_plugin[:api_version].must_equal 2
-  end
-
-  it "plugin_version is set to Kitchen::VERSION" do
-    provisioner = Kitchen::Provisioner::Shell.new(config).finalize_config!(instance)
-    provisioner.diagnose_plugin[:version].must_equal Kitchen::VERSION
-  end
-
-  describe "configuration" do
-
-    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 os_safe_root_path("/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 os_safe_root_path("/rooty/<calculated>/bootstrap.ps1")
-      end
-    end
-
-    it ":data_path uses calculate_path and is expanded" do
-      provisioner[:data_path].must_equal os_safe_root_path("/rooty/<calculated>/data")
-    end
-  end
-
-  describe "#init_command" do
-
-    let(:cmd) { provisioner.init_command }
-
-    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 "ends with a single quote" do
-        cmd.must_match(/'\Z/)
-      end
-
-      it "exports http_proxy & HTTP_PROXY when :http_proxy is set" do
-        config[:http_proxy] = "http://proxy"
-
-        cmd.lines.to_a[1..2].must_equal([
-          %{http_proxy="http://proxy"; export http_proxy\n},
-          %{HTTP_PROXY="http://proxy"; export HTTP_PROXY\n}
-        ])
-      end
-
-      it "exports https_proxy & HTTPS_PROXY when :https_proxy is set" do
-        config[:https_proxy] = "https://proxy"
-
-        cmd.lines.to_a[1..2].must_equal([
-          %{https_proxy="https://proxy"; export https_proxy\n},
-          %{HTTPS_PROXY="https://proxy"; export HTTPS_PROXY\n}
-        ])
-      end
-
-      it "exports ftp_proxy & FTP_PROXY when :ftp_proxy is set" do
-        config[:ftp_proxy] = "ftp://proxy"
-
-        cmd.lines.to_a[1..2].must_equal([
-          %{ftp_proxy="ftp://proxy"; export ftp_proxy\n},
-          %{FTP_PROXY="ftp://proxy"; export FTP_PROXY\n}
-        ])
-      end
-
-      it "exports all proxy variables when all are set" do
-        config[:http_proxy] = "http://proxy"
-        config[:https_proxy] = "https://proxy"
-        config[:ftp_proxy] = "ftp://proxy"
-
-        cmd.lines.to_a[1..6].must_equal([
-          %{http_proxy="http://proxy"; export http_proxy\n},
-          %{HTTP_PROXY="http://proxy"; export HTTP_PROXY\n},
-          %{https_proxy="https://proxy"; export https_proxy\n},
-          %{HTTPS_PROXY="https://proxy"; export HTTPS_PROXY\n},
-          %{ftp_proxy="ftp://proxy"; export ftp_proxy\n},
-          %{FTP_PROXY="ftp://proxy"; export FTP_PROXY\n}
-        ])
-      end
-
-      it "uses sudo for rm when configured" do
-        config[:sudo] = true
-
-        cmd.must_match regexify("sudo -E rm -rf ", :partial_line)
-      end
-
-      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
-
-      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
-
-    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 "exports http_proxy & HTTP_PROXY when :http_proxy is set" do
-        config[:http_proxy] = "http://proxy"
-
-        cmd.lines.to_a[0..1].must_equal([
-          %{$env:http_proxy = "http://proxy"\n},
-          %{$env:HTTP_PROXY = "http://proxy"\n}
-        ])
-      end
-
-      it "exports https_proxy & HTTPS_PROXY when :https_proxy is set" do
-        config[:https_proxy] = "https://proxy"
-
-        cmd.lines.to_a[0..1].must_equal([
-          %{$env:https_proxy = "https://proxy"\n},
-          %{$env:HTTPS_PROXY = "https://proxy"\n}
-        ])
-      end
-
-      it "exports ftp_proxy & FTP_PROXY when :ftp_proxy is set" do
-        config[:ftp_proxy] = "ftp://proxy"
-
-        cmd.lines.to_a[0..1].must_equal([
-          %{$env:ftp_proxy = "ftp://proxy"\n},
-          %{$env:FTP_PROXY = "ftp://proxy"\n}
-        ])
-      end
-
-      it "exports all proxy variables when all are set" do
-        config[:http_proxy] = "http://proxy"
-        config[:https_proxy] = "https://proxy"
-        config[:ftp_proxy] = "ftp://proxy"
-
-        cmd.lines.to_a[0..5].must_equal([
-          %{$env:http_proxy = "http://proxy"\n},
-          %{$env:HTTP_PROXY = "http://proxy"\n},
-          %{$env:https_proxy = "https://proxy"\n},
-          %{$env:HTTPS_PROXY = "https://proxy"\n},
-          %{$env:ftp_proxy = "ftp://proxy"\n},
-          %{$env:FTP_PROXY = "ftp://proxy"\n}
-        ])
-      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(Kitchen::Util.outdent!(<<-POWERSHELL).chomp)
-          if (-Not (Test-Path "\\route")) {
-            New-Item "\\route" -ItemType directory | Out-Null
-          }
-        POWERSHELL
-      end
-    end
-  end
-
-  describe "#run_command" do
-
-    let(:cmd) { provisioner.run_command }
-
-    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 "ends with a single quote" do
-        cmd.must_match(/'\Z/)
-      end
-
-      it "exports http_proxy & HTTP_PROXY when :http_proxy is set" do
-        config[:http_proxy] = "http://proxy"
-
-        cmd.lines.to_a[1..2].must_equal([
-          %{http_proxy="http://proxy"; export http_proxy\n},
-          %{HTTP_PROXY="http://proxy"; export HTTP_PROXY\n}
-        ])
-      end
-
-      it "exports https_proxy & HTTPS_PROXY when :https_proxy is set" do
-        config[:https_proxy] = "https://proxy"
-
-        cmd.lines.to_a[1..2].must_equal([
-          %{https_proxy="https://proxy"; export https_proxy\n},
-          %{HTTPS_PROXY="https://proxy"; export HTTPS_PROXY\n}
-        ])
-      end
-
-      it "exports ftp_proxy & FTP_PROXY when :ftp_proxy is set" do
-        config[:ftp_proxy] = "ftp://proxy"
-
-        cmd.lines.to_a[1..2].must_equal([
-          %{ftp_proxy="ftp://proxy"; export ftp_proxy\n},
-          %{FTP_PROXY="ftp://proxy"; export FTP_PROXY\n}
-        ])
-      end
-
-      it "exports all proxy variables when all are set" do
-        config[:http_proxy] = "http://proxy"
-        config[:https_proxy] = "https://proxy"
-        config[:ftp_proxy] = "ftp://proxy"
-
-        cmd.lines.to_a[1..6].must_equal([
-          %{http_proxy="http://proxy"; export http_proxy\n},
-          %{HTTP_PROXY="http://proxy"; export HTTP_PROXY\n},
-          %{https_proxy="https://proxy"; export https_proxy\n},
-          %{HTTPS_PROXY="https://proxy"; export HTTPS_PROXY\n},
-          %{ftp_proxy="ftp://proxy"; export ftp_proxy\n},
-          %{FTP_PROXY="ftp://proxy"; export FTP_PROXY\n}
-        ])
-      end
-
-      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
-
-      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
-
-    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 "exports http_proxy & HTTP_PROXY when :http_proxy is set" do
-        config[:http_proxy] = "http://proxy"
-
-        cmd.lines.to_a[0..1].must_equal([
-          %{$env:http_proxy = "http://proxy"\n},
-          %{$env:HTTP_PROXY = "http://proxy"\n}
-        ])
-      end
-
-      it "exports https_proxy & HTTPS_PROXY when :https_proxy is set" do
-        config[:https_proxy] = "https://proxy"
-
-        cmd.lines.to_a[0..1].must_equal([
-          %{$env:https_proxy = "https://proxy"\n},
-          %{$env:HTTPS_PROXY = "https://proxy"\n}
-        ])
-      end
-
-      it "exports ftp_proxy & FTP_PROXY when :ftp_proxy is set" do
-        config[:ftp_proxy] = "ftp://proxy"
-
-        cmd.lines.to_a[0..1].must_equal([
-          %{$env:ftp_proxy = "ftp://proxy"\n},
-          %{$env:FTP_PROXY = "ftp://proxy"\n}
-        ])
-      end
-
-      it "exports all proxy variables when all are set" do
-        config[:http_proxy] = "http://proxy"
-        config[:https_proxy] = "https://proxy"
-        config[:ftp_proxy] = "ftp://proxy"
-
-        cmd.lines.to_a[0..5].must_equal([
-          %{$env:http_proxy = "http://proxy"\n},
-          %{$env:HTTP_PROXY = "http://proxy"\n},
-          %{$env:https_proxy = "https://proxy"\n},
-          %{$env:HTTPS_PROXY = "https://proxy"\n},
-          %{$env:ftp_proxy = "ftp://proxy"\n},
-          %{$env:FTP_PROXY = "ftp://proxy"\n}
-        ])
-      end
-
-      it "invokes the bootstrap.ps1 script" do
-        config[:root_path] = "\\r"
-
-        cmd.must_match regexify(%{& "\\r\\bootstrap.ps1"})
-      end
-    end
-  end
-
-  describe "#create_sandbox" do
-
-    before do
-      @root = Dir.mktmpdir
-      config[:kitchen_root] = @root
-    end
-
-    after do
-      FileUtils.remove_entry(@root)
-      begin
-        provisioner.cleanup_sandbox
-      rescue # rubocop:disable Lint/HandleExceptions
-      end
-    end
-
-    let(:provisioner) do
-      Kitchen::Provisioner::Shell.new(config).finalize_config!(instance)
-    end
-
-    describe "data files" do
-
-      before do
-        create_files_under("#{config[:kitchen_root]}/my_data")
-        config[:data_path] = "#{config[:kitchen_root]}/my_data"
-      end
-
-      it "skips directory creation if :data_path is not set" do
-        config[:data_path] = nil
-        provisioner.create_sandbox
-
-        sandbox_path("data").directory?.must_equal false
-      end
-
-      it "copies tree from :data_path into sandbox" do
-        provisioner.create_sandbox
-
-        sandbox_path("data/alpha.txt").file?.must_equal true
-        IO.read(sandbox_path("data/alpha.txt")).must_equal "stuff"
-        sandbox_path("data/sub").directory?.must_equal true
-        sandbox_path("data/sub/bravo.txt").file?.must_equal true
-        IO.read(sandbox_path("data/sub/bravo.txt")).must_equal "junk"
-      end
-
-      it "logs a message on info" do
-        provisioner.create_sandbox
-
-        logged_output.string.must_match info_line("Preparing data")
-      end
-
-      it "logs a message on debug" do
-        provisioner.create_sandbox
-
-        logged_output.string.must_match debug_line(
-          "Using data from #{config[:kitchen_root]}/my_data")
-      end
-    end
-
-    describe "script file" do
-
-      describe "with a valid :script file" do
-
-        before do
-          File.open("#{config[:kitchen_root]}/my_script", "wb") do |file|
-            file.write("gonuts")
-          end
-          config[:script] = "#{config[:kitchen_root]}/my_script"
-        end
-
-        it "creates a file in the sandbox directory" do
-          provisioner.create_sandbox
-
-          sandbox_path("my_script").file?.must_equal true
-          unless running_tests_on_windows?
-            # Windows doesn't have the concept of executable
-            sandbox_path("my_script").executable?.must_equal true
-          end
-          IO.read(sandbox_path("my_script")).must_equal "gonuts"
-        end
-
-        it "logs a message on info" do
-          provisioner.create_sandbox
-
-          logged_output.string.must_match info_line("Preparing script")
-        end
-
-        it "logs a message on debug" do
-          provisioner.create_sandbox
-
-          logged_output.string.must_match debug_line(
-            "Using script from #{config[:kitchen_root]}/my_script")
-        end
-      end
-
-      describe "with no :script file" do
-
-        before { config[:script] = nil }
-
-        describe "for bourne shells" do
-
-          before { platform.stubs(:shell_type).returns("bourne") }
-
-          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.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
-            unless running_tests_on_windows?
-              # Windows doesn't have the concept of executable
-              sandbox_path("bootstrap.sh").executable?.must_equal true
-            end
-            IO.read(sandbox_path("bootstrap.sh")).
-              must_match(/NO BOOTSTRAP SCRIPT PRESENT/)
-          end
-        end
-
-        describe "for powershell shells" do
-
-          before { platform.stubs(:shell_type).returns("powershell") }
-
-          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
-            unless running_tests_on_windows?
-              # Windows doesn't have the concept of executable
-              sandbox_path("bootstrap.ps1").executable?.must_equal true
-            end
-            IO.read(sandbox_path("bootstrap.ps1")).
-              must_match(/Write-Host "NO BOOTSTRAP SCRIPT PRESENT`n"/)
-          end
-        end
-      end
-    end
-
-    def sandbox_path(path)
-      Pathname.new(provisioner.sandbox_path).join(path)
-    end
-
-    def create_files_under(path)
-      FileUtils.mkdir_p(File.join(path, "sub"))
-      File.open(File.join(path, "alpha.txt"), "wb") do |file|
-        file.write("stuff")
-      end
-      File.open(File.join(path, "sub", "bravo.txt"), "wb") do |file|
-        file.write("junk")
-      end
-    end
-
-    def info_line(msg)
-      %r{^I, .* : #{Regexp.escape(msg)}$}
-    end
-
-    def debug_line(msg)
-      %r{^D, .* : #{Regexp.escape(msg)}$}
-    end
-  end
-
-  def regexify(str, line = :whole_line)
-    r = Regexp.escape(str)
-    r = "^\s*#{r}$" if line == :whole_line
-    Regexp.new(r)
-  end
-end
+# -*- 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/provisioner/shell"
+
+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(:instance) do
+    stub(
+      :name => "coolbeans",
+      :logger => logger,
+      :suite => suite,
+      :platform => platform
+    )
+  end
+
+  let(:provisioner) do
+    Class.new(Kitchen::Provisioner::Shell) {
+      def calculate_path(path, _opts = {})
+        "<calculated>/#{path}"
+      end
+    }.new(config).finalize_config!(instance)
+  end
+
+  it "provisioner api_version is 2" do
+    provisioner = Kitchen::Provisioner::Shell.new(config).finalize_config!(instance)
+    provisioner.diagnose_plugin[:api_version].must_equal 2
+  end
+
+  it "plugin_version is set to Kitchen::VERSION" do
+    provisioner = Kitchen::Provisioner::Shell.new(config).finalize_config!(instance)
+    provisioner.diagnose_plugin[:version].must_equal Kitchen::VERSION
+  end
+
+  describe "configuration" do
+
+    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 os_safe_root_path("/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 os_safe_root_path("/rooty/<calculated>/bootstrap.ps1")
+      end
+    end
+
+    it ":data_path uses calculate_path and is expanded" do
+      provisioner[:data_path].must_equal os_safe_root_path("/rooty/<calculated>/data")
+    end
+  end
+
+  describe "#init_command" do
+
+    let(:cmd) { provisioner.init_command }
+
+    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 "ends with a single quote" do
+        cmd.must_match(/'\Z/)
+      end
+
+      it "exports http_proxy & HTTP_PROXY when :http_proxy is set" do
+        config[:http_proxy] = "http://proxy"
+
+        cmd.lines.to_a[1..2].must_equal([
+          %{http_proxy="http://proxy"; export http_proxy\n},
+          %{HTTP_PROXY="http://proxy"; export HTTP_PROXY\n}
+        ])
+      end
+
+      it "exports https_proxy & HTTPS_PROXY when :https_proxy is set" do
+        config[:https_proxy] = "https://proxy"
+
+        cmd.lines.to_a[1..2].must_equal([
+          %{https_proxy="https://proxy"; export https_proxy\n},
+          %{HTTPS_PROXY="https://proxy"; export HTTPS_PROXY\n}
+        ])
+      end
+
+      it "exports ftp_proxy & FTP_PROXY when :ftp_proxy is set" do
+        config[:ftp_proxy] = "ftp://proxy"
+
+        cmd.lines.to_a[1..2].must_equal([
+          %{ftp_proxy="ftp://proxy"; export ftp_proxy\n},
+          %{FTP_PROXY="ftp://proxy"; export FTP_PROXY\n}
+        ])
+      end
+
+      it "exports all proxy variables when all are set" do
+        config[:http_proxy] = "http://proxy"
+        config[:https_proxy] = "https://proxy"
+        config[:ftp_proxy] = "ftp://proxy"
+
+        cmd.lines.to_a[1..6].must_equal([
+          %{http_proxy="http://proxy"; export http_proxy\n},
+          %{HTTP_PROXY="http://proxy"; export HTTP_PROXY\n},
+          %{https_proxy="https://proxy"; export https_proxy\n},
+          %{HTTPS_PROXY="https://proxy"; export HTTPS_PROXY\n},
+          %{ftp_proxy="ftp://proxy"; export ftp_proxy\n},
+          %{FTP_PROXY="ftp://proxy"; export FTP_PROXY\n}
+        ])
+      end
+
+      it "uses sudo for rm when configured" do
+        config[:sudo] = true
+
+        cmd.must_match regexify("sudo -E rm -rf ", :partial_line)
+      end
+
+      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
+
+      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
+
+    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 "exports http_proxy & HTTP_PROXY when :http_proxy is set" do
+        config[:http_proxy] = "http://proxy"
+
+        cmd.lines.to_a[0..1].must_equal([
+          %{$env:http_proxy = "http://proxy"\n},
+          %{$env:HTTP_PROXY = "http://proxy"\n}
+        ])
+      end
+
+      it "exports https_proxy & HTTPS_PROXY when :https_proxy is set" do
+        config[:https_proxy] = "https://proxy"
+
+        cmd.lines.to_a[0..1].must_equal([
+          %{$env:https_proxy = "https://proxy"\n},
+          %{$env:HTTPS_PROXY = "https://proxy"\n}
+        ])
+      end
+
+      it "exports ftp_proxy & FTP_PROXY when :ftp_proxy is set" do
+        config[:ftp_proxy] = "ftp://proxy"
+
+        cmd.lines.to_a[0..1].must_equal([
+          %{$env:ftp_proxy = "ftp://proxy"\n},
+          %{$env:FTP_PROXY = "ftp://proxy"\n}
+        ])
+      end
+
+      it "exports all proxy variables when all are set" do
+        config[:http_proxy] = "http://proxy"
+        config[:https_proxy] = "https://proxy"
+        config[:ftp_proxy] = "ftp://proxy"
+
+        cmd.lines.to_a[0..5].must_equal([
+          %{$env:http_proxy = "http://proxy"\n},
+          %{$env:HTTP_PROXY = "http://proxy"\n},
+          %{$env:https_proxy = "https://proxy"\n},
+          %{$env:HTTPS_PROXY = "https://proxy"\n},
+          %{$env:ftp_proxy = "ftp://proxy"\n},
+          %{$env:FTP_PROXY = "ftp://proxy"\n}
+        ])
+      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(Kitchen::Util.outdent!(<<-POWERSHELL).chomp)
+          if (-Not (Test-Path "\\route")) {
+            New-Item "\\route" -ItemType directory | Out-Null
+          }
+        POWERSHELL
+      end
+    end
+  end
+
+  describe "#run_command" do
+
+    let(:cmd) { provisioner.run_command }
+
+    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 "ends with a single quote" do
+        cmd.must_match(/'\Z/)
+      end
+
+      it "exports http_proxy & HTTP_PROXY when :http_proxy is set" do
+        config[:http_proxy] = "http://proxy"
+
+        cmd.lines.to_a[1..2].must_equal([
+          %{http_proxy="http://proxy"; export http_proxy\n},
+          %{HTTP_PROXY="http://proxy"; export HTTP_PROXY\n}
+        ])
+      end
+
+      it "exports https_proxy & HTTPS_PROXY when :https_proxy is set" do
+        config[:https_proxy] = "https://proxy"
+
+        cmd.lines.to_a[1..2].must_equal([
+          %{https_proxy="https://proxy"; export https_proxy\n},
+          %{HTTPS_PROXY="https://proxy"; export HTTPS_PROXY\n}
+        ])
+      end
+
+      it "exports ftp_proxy & FTP_PROXY when :ftp_proxy is set" do
+        config[:ftp_proxy] = "ftp://proxy"
+
+        cmd.lines.to_a[1..2].must_equal([
+          %{ftp_proxy="ftp://proxy"; export ftp_proxy\n},
+          %{FTP_PROXY="ftp://proxy"; export FTP_PROXY\n}
+        ])
+      end
+
+      it "exports all proxy variables when all are set" do
+        config[:http_proxy] = "http://proxy"
+        config[:https_proxy] = "https://proxy"
+        config[:ftp_proxy] = "ftp://proxy"
+
+        cmd.lines.to_a[1..6].must_equal([
+          %{http_proxy="http://proxy"; export http_proxy\n},
+          %{HTTP_PROXY="http://proxy"; export HTTP_PROXY\n},
+          %{https_proxy="https://proxy"; export https_proxy\n},
+          %{HTTPS_PROXY="https://proxy"; export HTTPS_PROXY\n},
+          %{ftp_proxy="ftp://proxy"; export ftp_proxy\n},
+          %{FTP_PROXY="ftp://proxy"; export FTP_PROXY\n}
+        ])
+      end
+
+      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
+
+      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
+
+    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 "exports http_proxy & HTTP_PROXY when :http_proxy is set" do
+        config[:http_proxy] = "http://proxy"
+
+        cmd.lines.to_a[0..1].must_equal([
+          %{$env:http_proxy = "http://proxy"\n},
+          %{$env:HTTP_PROXY = "http://proxy"\n}
+        ])
+      end
+
+      it "exports https_proxy & HTTPS_PROXY when :https_proxy is set" do
+        config[:https_proxy] = "https://proxy"
+
+        cmd.lines.to_a[0..1].must_equal([
+          %{$env:https_proxy = "https://proxy"\n},
+          %{$env:HTTPS_PROXY = "https://proxy"\n}
+        ])
+      end
+
+      it "exports ftp_proxy & FTP_PROXY when :ftp_proxy is set" do
+        config[:ftp_proxy] = "ftp://proxy"
+
+        cmd.lines.to_a[0..1].must_equal([
+          %{$env:ftp_proxy = "ftp://proxy"\n},
+          %{$env:FTP_PROXY = "ftp://proxy"\n}
+        ])
+      end
+
+      it "exports all proxy variables when all are set" do
+        config[:http_proxy] = "http://proxy"
+        config[:https_proxy] = "https://proxy"
+        config[:ftp_proxy] = "ftp://proxy"
+
+        cmd.lines.to_a[0..5].must_equal([
+          %{$env:http_proxy = "http://proxy"\n},
+          %{$env:HTTP_PROXY = "http://proxy"\n},
+          %{$env:https_proxy = "https://proxy"\n},
+          %{$env:HTTPS_PROXY = "https://proxy"\n},
+          %{$env:ftp_proxy = "ftp://proxy"\n},
+          %{$env:FTP_PROXY = "ftp://proxy"\n}
+        ])
+      end
+
+      it "invokes the bootstrap.ps1 script" do
+        config[:root_path] = "\\r"
+
+        cmd.must_match regexify(%{& "\\r\\bootstrap.ps1"})
+      end
+    end
+  end
+
+  describe "#create_sandbox" do
+
+    before do
+      @root = Dir.mktmpdir
+      config[:kitchen_root] = @root
+    end
+
+    after do
+      FileUtils.remove_entry(@root)
+      begin
+        provisioner.cleanup_sandbox
+      rescue # rubocop:disable Lint/HandleExceptions
+      end
+    end
+
+    let(:provisioner) do
+      Kitchen::Provisioner::Shell.new(config).finalize_config!(instance)
+    end
+
+    describe "data files" do
+
+      before do
+        create_files_under("#{config[:kitchen_root]}/my_data")
+        config[:data_path] = "#{config[:kitchen_root]}/my_data"
+      end
+
+      it "skips directory creation if :data_path is not set" do
+        config[:data_path] = nil
+        provisioner.create_sandbox
+
+        sandbox_path("data").directory?.must_equal false
+      end
+
+      it "copies tree from :data_path into sandbox" do
+        provisioner.create_sandbox
+
+        sandbox_path("data/alpha.txt").file?.must_equal true
+        IO.read(sandbox_path("data/alpha.txt")).must_equal "stuff"
+        sandbox_path("data/sub").directory?.must_equal true
+        sandbox_path("data/sub/bravo.txt").file?.must_equal true
+        IO.read(sandbox_path("data/sub/bravo.txt")).must_equal "junk"
+      end
+
+      it "logs a message on info" do
+        provisioner.create_sandbox
+
+        logged_output.string.must_match info_line("Preparing data")
+      end
+
+      it "logs a message on debug" do
+        provisioner.create_sandbox
+
+        logged_output.string.must_match debug_line(
+          "Using data from #{config[:kitchen_root]}/my_data")
+      end
+    end
+
+    describe "script file" do
+
+      describe "with a valid :script file" do
+
+        before do
+          File.open("#{config[:kitchen_root]}/my_script", "wb") do |file|
+            file.write("gonuts")
+          end
+          config[:script] = "#{config[:kitchen_root]}/my_script"
+        end
+
+        it "creates a file in the sandbox directory" do
+          provisioner.create_sandbox
+
+          sandbox_path("my_script").file?.must_equal true
+          unless running_tests_on_windows?
+            # Windows doesn't have the concept of executable
+            sandbox_path("my_script").executable?.must_equal true
+          end
+          IO.read(sandbox_path("my_script")).must_equal "gonuts"
+        end
+
+        it "logs a message on info" do
+          provisioner.create_sandbox
+
+          logged_output.string.must_match info_line("Preparing script")
+        end
+
+        it "logs a message on debug" do
+          provisioner.create_sandbox
+
+          logged_output.string.must_match debug_line(
+            "Using script from #{config[:kitchen_root]}/my_script")
+        end
+      end
+
+      describe "with no :script file" do
+
+        before { config[:script] = nil }
+
+        describe "for bourne shells" do
+
+          before { platform.stubs(:shell_type).returns("bourne") }
+
+          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.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
+            unless running_tests_on_windows?
+              # Windows doesn't have the concept of executable
+              sandbox_path("bootstrap.sh").executable?.must_equal true
+            end
+            IO.read(sandbox_path("bootstrap.sh")).
+              must_match(/NO BOOTSTRAP SCRIPT PRESENT/)
+          end
+        end
+
+        describe "for powershell shells" do
+
+          before { platform.stubs(:shell_type).returns("powershell") }
+
+          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
+            unless running_tests_on_windows?
+              # Windows doesn't have the concept of executable
+              sandbox_path("bootstrap.ps1").executable?.must_equal true
+            end
+            IO.read(sandbox_path("bootstrap.ps1")).
+              must_match(/Write-Host "NO BOOTSTRAP SCRIPT PRESENT`n"/)
+          end
+        end
+      end
+    end
+
+    def sandbox_path(path)
+      Pathname.new(provisioner.sandbox_path).join(path)
+    end
+
+    def create_files_under(path)
+      FileUtils.mkdir_p(File.join(path, "sub"))
+      File.open(File.join(path, "alpha.txt"), "wb") do |file|
+        file.write("stuff")
+      end
+      File.open(File.join(path, "sub", "bravo.txt"), "wb") do |file|
+        file.write("junk")
+      end
+    end
+
+    def info_line(msg)
+      %r{^I, .* : #{Regexp.escape(msg)}$}
+    end
+
+    def debug_line(msg)
+      %r{^D, .* : #{Regexp.escape(msg)}$}
+    end
+  end
+
+  def regexify(str, line = :whole_line)
+    r = Regexp.escape(str)
+    r = "^\s*#{r}$" if line == :whole_line
+    Regexp.new(r)
+  end
+end