test-kitchen 1.18.0 → 1.19.0

data/lib/kitchen/driver/proxy.rb

@@ -18,7 +18,7 @@
 # limitations under the License.
 #
 
-require "kitchen"
+require "kitchen/driver/ssh_base"
 require "kitchen/version"
 
 module Kitchen
@@ -40,6 +40,7 @@ module Kitchen
 
       # (see Base#create)
       def create(state)
+        # TODO: Once this isn't using SSHBase, it should call `super` to support pre_create_command.
         state[:hostname] = config[:host]
         reset_instance(state)
       end

data/lib/kitchen/instance.rb

@@ -54,20 +54,20 @@ module Kitchen
 
     # @return [Driver::Base] driver object which will manage this instance's
     #   lifecycle actions
-    attr_reader :driver
+    attr_accessor :driver
 
     # @return [Provisioner::Base] provisioner object which will the setup
     #   and invocation instructions for configuration management and other
     #   automation tools
-    attr_reader :provisioner
+    attr_accessor :provisioner
 
     # @return [Transport::Base] transport object which will communicate with
     #   an instance.
-    attr_reader :transport
+    attr_accessor :transport
 
     # @return [Verifier] verifier object for instance to manage the verifier
     #   installation on this instance
-    attr_reader :verifier
+    attr_accessor :verifier
 
     # @return [Logger] the logger for this instance
     attr_reader :logger
@@ -233,6 +233,15 @@ module Kitchen
       driver.package(state_file.read)
     end
 
+    # Check system and configuration for common errors.
+    #
+    def doctor_action
+      banner "The doctor is in"
+      [driver, provisioner, transport, verifier].any? do |obj|
+        obj.doctor(state_file.read)
+      end
+    end
+
     # Returns a Hash of configuration and other useful diagnostic information.
     #
     # @return [Hash] a diagnostic hash

data/lib/kitchen/provisioner/base.rb

@@ -85,6 +85,14 @@ module Kitchen
         cleanup_sandbox
       end
 
+      # Check system and configuration for common errors.
+      #
+      # @param state [Hash] mutable instance state
+      # @returns [Boolean] Return true if a problem is found.
+      def doctor(state)
+        false
+      end
+
       # Generates a command string which will install and configure the
       # provisioner software on an instance. If no work is required, then `nil`
       # will be returned.

data/lib/kitchen/provisioner/chef_base.rb

@@ -49,7 +49,9 @@ module Kitchen
       default_config :attributes, {}
       default_config :config_path, nil
       default_config :log_file, nil
-      default_config :log_level, "auto"
+      default_config :log_level do |provisioner|
+        provisioner[:debug] ? "debug" : "auto"
+      end
       default_config :profile_ruby, false
       # The older policyfile_zero used `policyfile` so support it for compat.
       default_config :policyfile, nil

data/lib/kitchen/provisioner/shell.rb

@@ -16,6 +16,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require "shellwords"
+
 require "kitchen/provisioner/base"
 require "kitchen/version"
 
@@ -35,6 +37,12 @@ module Kitchen
       end
       expand_path_for :script
 
+      # Run a single command instead of managing and running a script.
+      default_config :command, nil
+
+      # Add extra arguments to the converge script.
+      default_config :arguments, []
+
       default_config :data_path do |provisioner|
         provisioner.calculate_path("data")
       end
@@ -49,6 +57,7 @@ module Kitchen
 
       # (see Base#init_command)
       def init_command
+        return nil if config[:command]
         root = config[:root_path]
         data = remote_path_join(root, "data")
 
@@ -65,18 +74,24 @@ module Kitchen
                  "#{sudo('rm')} -rf #{data} ; mkdir -p #{root}"
                end
 
-        wrap_shell_code(code)
+        prefix_command(wrap_shell_code(code))
       end
 
       # (see Base#run_command)
       def run_command
+        return prefix_command(wrap_shell_code(config[:command])) if config[:command]
+        return unless config[:script]
         script = remote_path_join(
           config[:root_path],
           File.basename(config[:script])
         )
 
-        if config[:arguments]
-          script.concat(" ").concat(config[:arguments])
+        if config[:arguments] && !config[:arguments].empty?
+          if config[:arguments].is_a?(Array)
+            script = Shellwords.join([script] + config[:arguments])
+          else
+            script.concat(" ").concat(config[:arguments].to_s)
+          end
         end
 
         code = powershell_shell? ? %{& "#{script}"} : sudo(script)
@@ -111,30 +126,13 @@ module Kitchen
         if config[:script]
           debug("Using script from #{config[:script]}")
           FileUtils.cp_r(config[:script], sandbox_path)
+          FileUtils.chmod(0755,
+                          File.join(sandbox_path, File.basename(config[:script])))
         else
-          prepare_stubbed_script
+          info("No provisioner script file specified, skipping")
         end
-
-        FileUtils.chmod(0755,
-                        File.join(sandbox_path, File.basename(config[:script])))
       end
 
-      # Creates a minimal, no-op script in the sandbox path.
-      #
-      # @api private
-      def prepare_stubbed_script
-        base = powershell_shell? ? "bootstrap.ps1" : "bootstrap.sh"
-        config[:script] = File.join(sandbox_path, base)
-        info("#{File.basename(config[:script])} not found " \
-          "so Kitchen will run a stubbed script. Is this intended?")
-        File.open(config[:script], "wb") do |file|
-          if powershell_shell?
-            file.write(%{Write-Host "NO BOOTSTRAP SCRIPT PRESENT`n"\n})
-          else
-            file.write(%{#!/bin/sh\necho "NO BOOTSTRAP SCRIPT PRESENT"\n})
-          end
-        end
-      end
     end
   end
 end

data/lib/kitchen/transport/base.rb

@@ -64,6 +64,14 @@ module Kitchen
         raise ClientError, "#{self.class}#connection must be implemented"
       end
 
+      # Check system and configuration for common errors.
+      #
+      # @param state [Hash] mutable instance state
+      # @returns [Boolean] Return true if a problem is found.
+      def doctor(state)
+        false
+      end
+
       # Closes the connection, if it is still active.
       #
       # @return [void]

data/lib/kitchen/transport/exec.rb

@@ -0,0 +1,59 @@
+# -*- encoding: utf-8 -*-
+#
+# 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 "fileutils"
+
+require "kitchen/shell_out"
+require "kitchen/transport/base"
+require "kitchen/version"
+
+module Kitchen
+  module Transport
+    # Exec transport for Kitchen. This transport runs all commands locally.
+    #
+    # @since 1.19
+    class Exec < Kitchen::Transport::Base
+      kitchen_transport_api_version 1
+
+      plugin_version Kitchen::VERSION
+
+      def connection(state, &block)
+        options = config.to_hash.merge(state)
+        Kitchen::Transport::Exec::Connection.new(options, &block)
+      end
+
+      # Fake connection which just does local operations.
+      class Connection < Kitchen::Transport::Base::Connection
+        include ShellOut
+
+        # (see Base#execute)
+        def execute(command)
+          return if command.nil?
+          run_command(command)
+        end
+
+        # "Upload" the files by copying them locally.
+        #
+        # @see Base#upload
+        def upload(locals, remote)
+          FileUtils.mkdir_p(remote)
+          Array(locals).each do |local|
+            FileUtils.cp_r(local, remote)
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/kitchen/verifier/base.rb

@@ -82,6 +82,14 @@ module Kitchen
         cleanup_sandbox
       end
 
+      # Check system and configuration for common errors.
+      #
+      # @param state [Hash] mutable instance state
+      # @returns [Boolean] Return true if a problem is found.
+      def doctor(state)
+        false
+      end
+
       # Deletes the sandbox path. Without calling this method, the sandbox path
       # will persist after the process terminates. In other words, cleanup is
       # explicit. This method is safe to call multiple times.

data/lib/kitchen/version.rb

@@ -17,5 +17,5 @@
 # limitations under the License.
 
 module Kitchen
-  VERSION = "1.18.0".freeze
+  VERSION = "1.19.0".freeze
 end

data/spec/kitchen/config_spec.rb

@@ -63,6 +63,7 @@ describe Kitchen::Config do
       log_level: :debug,
       log_overwrite: false,
       colorize: false,
+      debug: true,
     }
   end
 
@@ -166,6 +167,18 @@ describe Kitchen::Config do
     end
   end
 
+  describe "#debug" do
+    it "returns its debug" do
+      config.debug.must_equal true
+    end
+
+    it "uses false by default" do
+      opts.delete(:debug)
+
+      config.debug.must_equal false
+    end
+  end
+
   describe "#platforms" do
     before do
       Kitchen::DataMunger.stubs(:new).returns(munger)

data/spec/kitchen/driver/base_spec.rb

@@ -88,6 +88,24 @@ describe Kitchen::Driver::Base do
     end
   end
 
+  describe ".pre_create_command" do
+    it "run command" do
+      Kitchen::Driver::Base.any_instance.stubs(:run_command).returns(true)
+
+      config[:pre_create_command] = "echo works 2&>1 > /dev/null"
+      driver.expects(:run_command).with("echo works 2&>1 > /dev/null")
+      driver.send(:pre_create_command)
+    end
+
+    it "error if cannot run" do
+      class ShellCommandFailed < Kitchen::ShellOut::ShellCommandFailed; end
+      Kitchen::Driver::Base.any_instance.stubs(:run_command).raises(ShellCommandFailed, "Expected process to exit with [0], but received '1'")
+
+      config[:pre_create_command] = "touch /this/dir/does/not/exist 2&>1 > /dev/null"
+      proc { driver.send(:pre_create_command) }.must_raise Kitchen::ActionFailed
+    end
+  end
+
   describe ".no_parallel_for" do
     it "registers no serial actions when none are declared" do
       Kitchen::Driver::Speedy.serial_actions.must_be_nil

data/spec/kitchen/driver/exec_spec.rb

@@ -0,0 +1,75 @@
+#
+# 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/exec"
+
+describe Kitchen::Driver::Exec do
+  let(:logged_output) { StringIO.new }
+  let(:logger)        { Logger.new(logged_output) }
+  let(:state)         { Hash.new }
+
+  let(:config) do
+    { reset_command: "mulligan" }
+  end
+
+  let(:instance) do
+    stub(name: "coolbeans", logger: logger, to_str: "instance", :"transport=" => nil)
+  end
+
+  let(:driver) do
+    Kitchen::Driver::Exec.new(config).finalize_config!(instance)
+  end
+
+  it "plugin_version is set to Kitchen::VERSION" do
+    driver.diagnose_plugin[:version].must_equal Kitchen::VERSION
+  end
+
+  it "sets the transport to exec" do
+    instance.expects(:"transport=").with { |v| v.is_a?(Kitchen::Transport::Exec) }
+    driver
+  end
+
+  describe "#create" do
+    it "runs the reset command" do
+      driver.expects(:run_command).with("mulligan")
+
+      driver.create(state)
+    end
+
+    it "skips the reset command if :reset_command is falsey" do
+      config[:reset_command] = false
+      driver.expects(:run_command).never
+
+      driver.create(state)
+    end
+  end
+
+  describe "#destroy" do
+    it "calls the reset command" do
+      driver.expects(:run_command).with("mulligan")
+
+      driver.destroy(state)
+    end
+
+    it "skips reset command if :reset_command is falsey" do
+      config[:reset_command] = false
+      driver.expects(:run_command).never
+
+      driver.destroy(state)
+    end
+  end
+
+end

data/spec/kitchen/provisioner/chef_base_spec.rb

@@ -90,6 +90,15 @@ describe Kitchen::Provisioner::ChefBase do
       provisioner[:attributes].must_equal Hash.new
     end
 
+    it ":log_level defaults to auto" do
+      provisioner[:log_level].must_equal "auto"
+    end
+
+    it ":log_level is debug when in debug mode" do
+      config[:debug] = true
+      provisioner[:log_level].must_equal "debug"
+    end
+
     it ":log_file defaults to nil" do
       provisioner[:log_file].must_be_nil
     end

data/spec/kitchen/provisioner/chef_solo_spec.rb

@@ -285,7 +285,7 @@ describe Kitchen::Provisioner::ChefSolo do
         config[:enforce_idempotency] = true
         provisioner.create_sandbox
 
-        file_no_updated_resources.join.must_match /handler_file =.*chef-client-fail-if-update-handler.rb/
+        file_no_updated_resources.join.must_match(/handler_file =.*chef-client-fail-if-update-handler.rb/)
       end
     end
 

data/spec/kitchen/provisioner/chef_zero_spec.rb

@@ -310,7 +310,7 @@ describe Kitchen::Provisioner::ChefZero do
         config[:enforce_idempotency] = true
         provisioner.create_sandbox
 
-        file_no_updated_resources.join.must_match /handler_file =.*chef-client-fail-if-update-handler.rb/
+        file_no_updated_resources.join.must_match(/handler_file =.*chef-client-fail-if-update-handler.rb/)
       end
     end
 

data/spec/kitchen/provisioner/shell_spec.rb

@@ -163,6 +163,12 @@ describe Kitchen::Provisioner::Shell do
 
         cmd.must_match regexify("mkdir -p /root/path", :partial_line)
       end
+
+      it "respects command" do
+        config[:command] = "asdf"
+
+        cmd.must_be_nil
+      end
     end
 
     describe "for powershell shells on windows os types" do
@@ -319,6 +325,12 @@ describe Kitchen::Provisioner::Shell do
         config[:arguments] = "--php 70 --mysql 57"
         cmd.must_match(/--php 70 --mysql 57/)
       end
+
+      it "respects command" do
+        config[:command] = "dothingy.rb"
+
+        cmd.must_match regexify("dothingy.rb", :partial_line)
+      end
     end
 
     describe "for powershell shells on windows os types" do
@@ -469,6 +481,10 @@ describe Kitchen::Provisioner::Shell do
       describe "with no :script file" do
         before { config[:script] = nil }
 
+        it "has no run command" do
+          provisioner.run_command.must_be_nil
+        end
+
         describe "for bourne shells" do
           before { platform.stubs(:shell_type).returns("bourne") }
 
@@ -482,20 +498,13 @@ describe Kitchen::Provisioner::Shell 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?")
+              "No provisioner script file specified, skipping")
           end
 
-          it "creates a file in the sandbox directory" do
+          it "does not create 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/)
+            sandbox_path("bootstrap.sh").file?.must_equal false
           end
         end
 
@@ -512,20 +521,13 @@ describe Kitchen::Provisioner::Shell 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?")
+              "No provisioner script file specified, skipping")
           end
 
-          it "creates a file in the sandbox directory" do
+          it "does not create 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"/)
+            sandbox_path("bootstrap.ps1").file?.must_equal false
           end
         end
       end