test-kitchen 1.3.1 → 1.4.0.beta.1

data/lib/kitchen/verifier/busser.rb

@@ -0,0 +1,266 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
+#
+# Copyright (C) 2012, 2013, 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 "base64"
+require "digest"
+
+require "kitchen/verifier/base"
+
+module Kitchen
+
+  module Verifier
+
+    # Command string generator to interface with Busser. The commands that are
+    # generated are safe to pass to an SSH command or as an unix command
+    # argument (escaped in single quotes).
+    #
+    # @author Fletcher Nichol <fnichol@nichol.ca>
+    class Busser < Kitchen::Verifier::Base
+
+      default_config :busser_bin do |verifier|
+        verifier.
+          remote_path_join(%W[#{verifier[:root_path]} bin busser]).
+          tap { |path| path.concat(".bat") if verifier.windows_os? }
+      end
+
+      default_config :ruby_bindir do |verifier|
+        if verifier.windows_os?
+          "$env:systemdrive\\opscode\\chef\\embedded\\bin"
+        else
+          "/opt/chef/embedded/bin"
+        end
+      end
+
+      default_config :version, "busser"
+
+      expand_path_for :test_base_path
+
+      # Creates a new Busser object using the provided configuration data
+      # which will be merged with any default configuration.
+      #
+      # @param config [Hash] provided driver configuration
+      def initialize(config = {})
+        init_config(config)
+      end
+
+      # (see Base#create_sandbox)
+      def create_sandbox
+        super
+        prepare_helpers
+        prepare_suites
+      end
+
+      # (see Base#init_command)
+      def init_command
+        return if local_suite_files.empty?
+
+        cmd = sudo(config[:busser_bin]).dup.
+          tap { |str| str.insert(0, "& ") if powershell_shell? }
+
+        wrap_shell_code(Util.outdent!(<<-CMD))
+          #{busser_env}
+
+          #{cmd} suite cleanup
+        CMD
+      end
+
+      # (see Base#install_command)
+      def install_command
+        return if local_suite_files.empty?
+
+        vars = install_command_vars
+
+        shell_code_from_file(vars, "busser_install_command")
+      end
+
+      # (see Base#run_command)
+      def run_command
+        return if local_suite_files.empty?
+
+        cmd = sudo(config[:busser_bin]).dup.
+          tap { |str| str.insert(0, "& ") if powershell_shell? }
+
+        wrap_shell_code(Util.outdent!(<<-CMD))
+          #{busser_env}
+
+          #{cmd} test
+        CMD
+      end
+
+      # Legacy method stub for `#setup_cmd` which calls `#install_command`.
+      #
+      # @return [String] command string
+      # @deprecated When backwards compatibility for old Busser methods is
+      #   removed, this method will no longer be available. Use
+      #   `#install_command` in its place.
+      define_method(:setup_cmd) { install_command }
+
+      # Legacy method stub for `#run_cmd` which calls `#run_command`.
+      #
+      # @return [String] command string
+      # @deprecated When backwards compatibility for old Busser methods is
+      #   removed, this method will no longer be available. Use
+      #   `#run_command` in its place.
+      define_method(:run_cmd) { run_command }
+
+      # Legacy method stub for `#sync_cmd`.
+      #
+      # @deprecated When backwards compatibility for old Busser methods is
+      #   removed, this method will no longer be available. Use
+      #   `transport#upload` to transfer test files in its place.
+      def sync_cmd
+        warn("Legacy call to #sync_cmd cannot be preserved, meaning that " \
+          "test files will not be uploaded. " \
+          "Code that calls #sync_cmd can now use the transport#upload " \
+          "method to transfer files.")
+      end
+
+      private
+
+      # Returns a command string that sets appropriate environment variables for
+      # busser commands.
+      #
+      # @return [String] command string
+      # @api private
+      def busser_env
+        root = config[:root_path]
+        gem_home = gem_path = remote_path_join(root, "gems")
+        gem_cache = remote_path_join(gem_home, "cache")
+
+        [
+          shell_env_var("BUSSER_ROOT", root),
+          shell_env_var("GEM_HOME", gem_home),
+          shell_env_var("GEM_PATH", gem_path),
+          shell_env_var("GEM_CACHE", gem_cache)
+        ].join("\n")
+      end
+
+      # Determines whether or not a local workstation file exists under a
+      # Chef-related directory.
+      #
+      # @return [truthy,falsey] whether or not a given file is some kind of
+      #   Chef-related file
+      # @api private
+      def chef_data_dir?(base, file)
+        file =~ %r{^#{base}/(data|data_bags|environments|nodes|roles)/}
+      end
+
+      # Returns arguments to a `gem install` command, suitable to install the
+      # Busser gem.
+      #
+      # @return [String] arguments string
+      # @api private
+      def gem_install_args
+        gem, version = config[:version].split("@")
+        gem, version = "busser", gem if gem =~ /^\d+\.\d+\.\d+/
+
+        args = gem
+        args += " --version #{version}" if version
+        args += " --no-rdoc --no-ri"
+        args
+      end
+
+      # Returns an Array of common helper filenames currently residing on the
+      # local workstation.
+      #
+      # @return [Array<String>] array of helper files
+      # @api private
+      def helper_files
+        glob = File.join(config[:test_base_path], "helpers", "*/**/*")
+        Dir.glob(glob).reject { |f| File.directory?(f) }
+      end
+
+      def install_command_vars
+        ruby = remote_path_join(config[:ruby_bindir], "ruby").
+          tap { |path| path.concat(".exe") if windows_os? }
+        gem = remote_path_join(config[:ruby_bindir], "gem")
+
+        [
+          busser_env,
+          shell_var("ruby", ruby),
+          shell_var("gem", gem),
+          shell_var("version", config[:version]),
+          shell_var("gem_install_args", gem_install_args),
+          shell_var("busser", sudo(config[:busser_bin])),
+          shell_var("plugins", plugins.join(" "))
+        ].join("\n")
+      end
+
+      # Returns an Array of test suite filenames for the related suite currently
+      # residing on the local workstation. Any special provisioner-specific
+      # directories (such as a Chef roles/ directory) are excluded.
+      #
+      # @return [Array<String>] array of suite files
+      # @api private
+      def local_suite_files
+        base = File.join(config[:test_base_path], config[:suite_name])
+        glob = File.join(base, "*/**/*")
+        Dir.glob(glob).reject do |f|
+          chef_data_dir?(base, f) || File.directory?(f)
+        end
+      end
+
+      # Returns a uniquely sorted Array of Busser plugin gems that need to
+      # be installed for the related suite.
+      #
+      # @return [Array<String>] a lexically sorted, unique item array of Busser
+      #   plugin gem names
+      # @api private
+      def plugins
+        non_suite_dirs = %w[data data_bags environments nodes roles]
+        glob = File.join(config[:test_base_path], config[:suite_name], "*")
+        Dir.glob(glob).reject { |d|
+          !File.directory?(d) || non_suite_dirs.include?(File.basename(d))
+        }.map { |d| "busser-#{File.basename(d)}" }.sort.uniq
+      end
+
+      # Copies all common testing helper files into the suites directory in
+      # the sandbox.
+      #
+      # @api private
+      def prepare_helpers
+        base = File.join(config[:test_base_path], "helpers")
+
+        helper_files.each do |src|
+          dest = File.join(sandbox_suites_dir, src.sub("#{base}/", ""))
+          FileUtils.mkdir_p(File.dirname(dest))
+          FileUtils.cp(src, dest, :preserve => true)
+        end
+      end
+
+      # Copies all test suite files into the suites directory in the sandbox.
+      #
+      # @api private
+      def prepare_suites
+        base = File.join(config[:test_base_path], config[:suite_name])
+
+        local_suite_files.each do |src|
+          dest = File.join(sandbox_suites_dir, src.sub("#{base}/", ""))
+          FileUtils.mkdir_p(File.dirname(dest))
+          FileUtils.cp(src, dest, :preserve => true)
+        end
+      end
+
+      # @return [String] path to suites directory under sandbox path
+      # @api private
+      def sandbox_suites_dir
+        File.join(sandbox_path, "suites")
+      end
+    end
+  end
+end

data/lib/kitchen/verifier/dummy.rb

@@ -0,0 +1,75 @@
+# -*- 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 "kitchen/verifier/base"
+
+module Kitchen
+
+  module Verifier
+
+    # Dummy verifier for Kitchen. This verifier does nothing but report what
+    # would happen if this verifier did anything of consequence. As a result
+    # it may be a useful verifier to use when debugging or developing new
+    # features or plugins.
+    #
+    # @author Fletcher Nichol <fnichol@nichol.ca>
+    class Dummy < Kitchen::Verifier::Base
+
+      default_config :sleep, 0
+      default_config :random_failure, false
+
+      # (see Base#call)
+      def call(state)
+        info("[#{name}] Verify on instance=#{instance} with state=#{state}")
+        sleep_if_set
+        failure_if_set
+        debug("[#{name}] Verify completed (#{config[:sleep]}s).")
+      end
+
+      private
+
+      # Sleep for a period of time, if a value is set in the config.
+      #
+      # @api private
+      def sleep_if_set
+        sleep(config[:sleep].to_f) if config[:sleep].to_f > 0.0
+      end
+
+      # Simulate a failure in an action, if set in the config.
+      #
+      # @api private
+      def failure_if_set
+        if config[:"fail"]
+          debug("Failure for Verifier #{name}.")
+          raise ActionFailed, "Action #verify failed for #{instance.to_str}."
+        elsif config[:random_failure] && randomly_fail?
+          debug("Random failure for Verifier #{name}.")
+          raise ActionFailed, "Action #verify failed for #{instance.to_str}."
+        end
+      end
+
+      # Determine whether or not to randomly fail.
+      #
+      # @return [true, false]
+      # @api private
+      def randomly_fail?
+        [true, false].sample
+      end
+    end
+  end
+end

data/lib/kitchen/version.rb

@@ -18,5 +18,5 @@
 
 module Kitchen
 
-  VERSION = "1.3.1"
+  VERSION = "1.4.0.beta.1"
 end

data/spec/kitchen/cli_spec.rb

@@ -0,0 +1,56 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Tyler Ball (<tball@chef.io>)
+#
+# 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 "kitchen/cli"
+require "kitchen"
+
+module Kitchen
+  describe CLI do
+
+    let(:cli) { CLI.new }
+
+    before do
+      @orig_env = ENV.to_hash
+    end
+
+    after do
+      ENV.clear
+      @orig_env.each do |k, v|
+        ENV[k] = v
+      end
+    end
+
+    describe "#initialize" do
+      it "does not set logging config when environment variables are missing" do
+        assert_equal Kitchen::DEFAULT_LOG_LEVEL, cli.config.log_level
+        assert_equal Kitchen::DEFAULT_LOG_OVERWRITE, cli.config.log_overwrite
+      end
+
+      it "does set logging config when environment variables are present" do
+        ENV["KITCHEN_LOG"] = "warn"
+        ENV["KITCHEN_LOG_OVERWRITE"] = "false"
+
+        assert_equal :warn, cli.config.log_level
+        assert_equal false, cli.config.log_overwrite
+      end
+    end
+
+  end
+end

data/spec/kitchen/config_spec.rb

@@ -27,7 +27,9 @@ require "kitchen/instance"
 require "kitchen/platform"
 require "kitchen/provisioner"
 require "kitchen/suite"
+require "kitchen/transport"
 require "kitchen/util"
+require "kitchen/verifier"
 
 module Kitchen
 
@@ -52,7 +54,8 @@ describe Kitchen::Config do
       :kitchen_root   => "/tmp/that/place",
       :log_root       => "/tmp/logs",
       :test_base_path => "/testing/yo",
-      :log_level      => :debug
+      :log_level      => :debug,
+      :log_overwrite  => false
     }
   end
 
@@ -60,11 +63,14 @@ describe Kitchen::Config do
     {
       :defaults => {
         :driver => "dummy",
-        :provisioner => "chef_solo"
+        :provisioner => "chef_solo",
+        :transport => "ssh",
+        :verifier => "busser"
       },
       :kitchen_root => "/tmp/that/place",
       :test_base_path => "/testing/yo",
-      :log_level => :debug
+      :log_level => :debug,
+      :log_overwrite  => false
     }
   end
 
@@ -133,6 +139,19 @@ describe Kitchen::Config do
     end
   end
 
+  describe "#log_overwrite" do
+
+    it "returns its log level" do
+      config.log_overwrite.must_equal false
+    end
+
+    it "uses :info by default" do
+      opts.delete(:log_overwrite)
+
+      config.log_overwrite.must_equal true
+    end
+  end
+
   describe "#platforms" do
 
     before do
@@ -152,11 +171,13 @@ describe Kitchen::Config do
       config.platforms
     end
 
-    it "constucts a munger with loader data and defaults" do
+    it "constructs a munger with loader data and defaults" do
       loader.stubs(:read).returns("datum")
 
-      Kitchen::DataMunger.expects(:new).with("datum", default_kitchen_config).
-        returns(munger)
+      Kitchen::DataMunger.expects(:new).with { |data, kitchen_config|
+        data.must_equal "datum"
+        kitchen_config.is_a?(Hash).must_equal true
+      }.returns(munger)
 
       config.platforms
     end
@@ -206,8 +227,10 @@ describe Kitchen::Config do
     it "constucts a munger with loader data and defaults" do
       loader.stubs(:read).returns("datum")
 
-      Kitchen::DataMunger.expects(:new).with("datum", default_kitchen_config).
-        returns(munger)
+      Kitchen::DataMunger.expects(:new).with { |data, kitchen_config|
+        data.must_equal "datum"
+        kitchen_config.is_a?(Hash).must_equal true
+      }.returns(munger)
 
       config.suites
     end
@@ -247,17 +270,19 @@ describe Kitchen::Config do
 
     let(:munger) do
       stub(
-        :busser_data_for => { "junk" => true },
         :driver_data_for => { "junk" => true },
-        :provisioner_data_for => { "junk" => true }
+        :provisioner_data_for => { "junk" => true },
+        :transport_data_for => { "junk" => true },
+        :verifier_data_for => { "junk" => true }
       )
     end
 
     before do
       Kitchen::Instance.stubs(:new).returns("instance")
-      Kitchen::Busser.stubs(:new).returns("busser")
       Kitchen::Driver.stubs(:for_plugin).returns("driver")
       Kitchen::Provisioner.stubs(:for_plugin).returns("provisioner")
+      Kitchen::Transport.stubs(:for_plugin).returns("transport")
+      Kitchen::Verifier.stubs(:for_plugin).returns("verifier")
       Kitchen::Logger.stubs(:new).returns("logger")
       Kitchen::StateFile.stubs(:new).returns("state_file")
 
@@ -266,14 +291,6 @@ describe Kitchen::Config do
       config.stubs(:suites).returns(suites)
     end
 
-    it "constructs a Busser object" do
-      munger.expects(:busser_data_for).with("tiny", "unax").returns("datum")
-      Kitchen::Busser.unstub(:new)
-      Kitchen::Busser.expects(:new).with("tiny", "datum")
-
-      config.instances
-    end
-
     it "constructs a Driver object" do
       munger.expects(:driver_data_for).with("tiny", "unax").
         returns(:name => "drivey", :datum => "lots")
@@ -294,12 +311,33 @@ describe Kitchen::Config do
       config.instances
     end
 
+    it "constructs a Transport object" do
+      munger.expects(:transport_data_for).with("tiny", "unax").
+        returns(:name => "transey", :datum => "lots")
+      Kitchen::Transport.unstub(:for_plugin)
+      Kitchen::Transport.expects(:for_plugin).
+        with("transey", :name => "transey", :datum => "lots")
+
+      config.instances
+    end
+
+    it "constructs a Verifier object" do
+      munger.expects(:verifier_data_for).with("tiny", "unax").
+        returns(:name => "vervey", :datum => "lots")
+      Kitchen::Verifier.unstub(:for_plugin)
+      Kitchen::Verifier.expects(:for_plugin).
+        with("vervey", :name => "vervey", :datum => "lots")
+
+      config.instances
+    end
+
     it "constructs a Logger object" do
       Kitchen::Logger.unstub(:new)
       Kitchen::Logger.expects(:new).with(
         :stdout => STDOUT,
         :color => :cyan,
         :logdev => "/tmp/logs/tiny-unax.log",
+        :log_overwrite => false,
         :level => 0,
         :progname => "tiny-unax"
       )
@@ -316,15 +354,18 @@ describe Kitchen::Config do
 
     it "constructs an Instance object from all built objects" do
       Kitchen::Instance.unstub(:new)
+
       Kitchen::Instance.expects(:new).with(
-        :busser => "busser",
         :driver => "driver",
         :logger => "logger",
         :suite => suites.first,
         :platform => platforms.first,
         :provisioner => "provisioner",
+        :transport => "transport",
+        :verifier => "verifier",
         :state_file => "state_file"
       )
+
       config.instances
     end
   end