test-kitchen-rsync 3.0.0.pre.1

data/lib/kitchen/verifier/busser.rb

@@ -0,0 +1,275 @@
+#
+# 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" unless defined?(Base64)
+require "digest" unless defined?(Digest)
+
+require_relative "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
+      kitchen_verifier_api_version 1
+
+      plugin_version Kitchen::VERSION
+
+      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
+          verifier.remote_path_join(%W{#{verifier[:chef_omnibus_root]} 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? }
+
+        prefix_command(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
+
+        prefix_command(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? }
+
+        prefix_command(wrap_shell_code(Util.outdent!(<<-CMD)))
+          #{busser_env}
+
+          #{cmd} test #{plugins.join(" ").gsub!("busser-", "")}
+        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")
+          .tap { |str| str.insert(0, reload_ps1_path) if windows_os? }
+      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("@")
+        if /^\d+\.\d+\.\d+/.match?(gem)
+          version = gem
+          gem = "busser"
+        end
+
+        root = config[:root_path]
+        gem_bin = remote_path_join(root, "bin")
+
+        # We don't want the gems to be installed in the home directory,
+        # this will force the bindir and the gem install location both
+        # to be under /tmp/verifier
+        args = gem
+        args += " --version #{version}" if version
+        args += " --no-document --no-format-executable -n #{gem_bin}"
+        args += " --no-user-install"
+        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("helpers", "*/**/*")
+        Util.safe_glob(config[:test_base_path], 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])
+        Util.safe_glob(base, "*/**/*").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}
+        Util.list_directory(File.join(config[:test_base_path], config[:suite_name])).reject do |d|
+          !File.directory?(d) || non_suite_dirs.include?(File.basename(d))
+        end.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 @@
+#
+# 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 "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
+      kitchen_verifier_api_version 1
+
+      plugin_version Kitchen::VERSION
+
+      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/verifier/shell.rb

@@ -0,0 +1,99 @@
+#
+# Author:: SAWANOBORI Yukihiko (<sawanoboriyu@higanworks.com>)
+#
+# Copyright (C) 2015, HiganWorks LLC
+#
+# 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 "base"
+
+module Kitchen
+  module Verifier
+    # Shell verifier for Kitchen. This verifier just execute shell command from local.
+    #
+    # @author SAWANOBORI Yukihiko (<sawanoboriyu@higanworks.com>)
+    class Shell < Kitchen::Verifier::Base
+      require "mixlib/shellout" unless defined?(Mixlib::ShellOut)
+
+      kitchen_verifier_api_version 1
+
+      plugin_version Kitchen::VERSION
+
+      default_config :sleep, 0
+      default_config :command, "true"
+      default_config :shellout_opts, {}
+      default_config :live_stream, $stdout
+      default_config :remote_exec, false
+
+      # (see Base#call)
+      def call(state)
+        info("[#{name}] Verify on instance #{instance.name} with state=#{state}")
+        sleep_if_set
+        merge_state_to_env(state)
+        if config[:remote_exec]
+          instance.transport.connection(state) do |conn|
+            conn.execute(config[:command])
+          end
+        else
+          shellout
+        end
+        debug("[#{name}] Verify completed.")
+      end
+
+      # for legacy drivers.
+      def run_command
+        if config[:remote_exec]
+          config[:command]
+        else
+          shellout
+          nil
+        end
+      end
+
+      private
+
+      # Sleep for a period of time, if a value is set in the config.
+      #
+      # @api private
+      def sleep_if_set
+        config[:sleep].to_i.times do
+          info(".")
+          sleep 1
+        end
+      end
+
+      def shellout
+        cmd = Mixlib::ShellOut.new(config[:command], config[:shellout_opts])
+        cmd.live_stream = config[:live_stream]
+        cmd.run_command
+        begin
+          cmd.error!
+        rescue Mixlib::ShellOut::ShellCommandFailed
+          raise ActionFailed, "Action #verify failed for #{instance.to_str}."
+        end
+      end
+
+      def merge_state_to_env(state)
+        env_state = { environment: {} }
+        env_state[:environment]["KITCHEN_INSTANCE"] = instance.name
+        env_state[:environment]["KITCHEN_PLATFORM"] = instance.platform.name
+        env_state[:environment]["KITCHEN_SUITE"] = instance.suite.name
+        env_state[:environment]["KITCHEN_USERNAME"] = instance.transport[:username] if instance.respond_to?(:transport)
+        state.each_pair do |key, value|
+          env_state[:environment]["KITCHEN_" + key.to_s.upcase] = value.to_s
+        end
+        config[:shellout_opts].merge!(env_state)
+      end
+    end
+  end
+end

data/lib/kitchen/verifier.rb

@@ -0,0 +1,39 @@
+#
+# 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 "plugin"
+
+module Kitchen
+  # A verifier is responsible for running tests post-converge to confirm that
+  # the instance is in a known/consistent state.
+  #
+  # @author Fletcher Nichol <fnichol@nichol.ca>
+  module Verifier
+    # Default verifier to use
+    DEFAULT_PLUGIN = "busser".freeze
+
+    # Returns an instance of a verifier given a plugin type string.
+    #
+    # @param plugin [String] a verifier plugin type, to be constantized
+    # @param config [Hash] a configuration hash to initialize the verifier
+    # @return [Verifier::Base] a verifier instance
+    # @raise [ClientError] if a verifier instance could not be created
+    def self.for_plugin(plugin, config)
+      Kitchen::Plugin.load(self, plugin, config)
+    end
+  end
+end

data/lib/kitchen/version.rb

@@ -0,0 +1,20 @@
+#
+# 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.
+
+module Kitchen
+  VERSION = "3.0.0-1".freeze
+end

data/lib/kitchen/which.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+#
+# Copyright:: Copyright (c) Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# 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 "chef-utils/dsl/which" unless defined?(ChefUtils::DSL::Which)
+require_relative "chef_utils_wiring" unless defined?(Kitchen::ChefUtilsWiring)
+
+module Kitchen
+  module Which
+    include ChefUtils::DSL::Which
+    include ChefUtilsWiring
+  end
+end

data/lib/kitchen.rb

@@ -0,0 +1,152 @@
+#
+# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
+#
+# Copyright (C) 2012, 2013, 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 "pathname" unless defined?(Pathname)
+require_relative "kitchen/errors"
+require_relative "kitchen/logger"
+require_relative "kitchen/logging"
+require_relative "kitchen/shell_out"
+require_relative "kitchen/configurable"
+require_relative "kitchen/util"
+
+require_relative "kitchen/provisioner"
+require_relative "kitchen/provisioner/base"
+require_relative "kitchen/color"
+require_relative "kitchen/collection"
+require_relative "kitchen/config"
+require_relative "kitchen/data_munger"
+require_relative "kitchen/driver"
+require_relative "kitchen/driver/base"
+require_relative "kitchen/driver/ssh_base"
+require_relative "kitchen/driver/proxy"
+require_relative "kitchen/instance"
+require_relative "kitchen/lifecycle_hooks"
+require_relative "kitchen/transport"
+require_relative "kitchen/transport/base"
+require_relative "kitchen/loader/yaml"
+require_relative "kitchen/metadata_chopper"
+require_relative "kitchen/platform"
+require_relative "kitchen/state_file"
+require_relative "kitchen/ssh"
+require_relative "kitchen/suite"
+require_relative "kitchen/verifier"
+require_relative "kitchen/verifier/base"
+require_relative "kitchen/version"
+
+# Test Kitchen base module.
+#
+# @author Fletcher Nichol <fnichol@nichol.ca>
+module Kitchen
+  class << self
+    # @return [Logger] the common Kitchen logger
+    attr_accessor :logger
+
+    # @return [Mutex] a common mutex for global coordination
+    attr_accessor :mutex
+
+    # @return [Mutex] a mutex used for Dir.chdir coordination
+    attr_accessor :mutex_chdir
+
+    # Returns the root path of the Kitchen gem source code.
+    #
+    # @return [Pathname] root path of gem
+    def source_root
+      @source_root ||= Pathname.new(File.expand_path("..", __dir__))
+    end
+
+    # Returns a default logger which emits on standard output.
+    #
+    # @return [Logger] a logger
+    def default_logger
+      Logger.new(stdout: $stdout, level: Util.to_logger_level(env_log))
+    end
+
+    # Returns a default file logger which emits on standard output and to a
+    # log file.
+    #
+    # @param [Symbol] level logging level
+    # @param [Boolean] log_overwrite logging level
+    # @return [Logger] a logger
+    def default_file_logger(level = nil, log_overwrite = nil)
+      level ||= env_log
+      log_overwrite = log_overwrite.nil? ? env_log_overwrite : log_overwrite
+      log_location = File.expand_path(File.join(DEFAULT_LOG_DIR, "kitchen.log"))
+      log_location = log_location.to_s
+
+      Logger.new(
+        stdout: $stdout,
+        logdev: log_location,
+        level: Util.to_logger_level(level),
+        log_overwrite: log_overwrite
+      )
+    end
+
+    # Returns whether or not standard output is associated with a terminal
+    # device (tty).
+    #
+    # @return [true,false] is there a tty?
+    def tty?
+      $stdout.tty?
+    end
+
+    # Determine the default log level from an environment variable, if it is
+    # set.
+    #
+    # @return [Symbol,nil] a log level or nil if not set
+    # @api private
+    def env_log
+      ENV["KITCHEN_LOG"] && ENV["KITCHEN_LOG"].downcase.to_sym
+    end
+
+    # Determine the log overwriting logic from an environment variable,
+    # if it is set.
+    #
+    # @return [Boolean,nil]
+    # @api private
+    def env_log_overwrite
+      case ENV["KITCHEN_LOG_OVERWRITE"] && ENV["KITCHEN_LOG_OVERWRITE"].downcase
+      when nil, ""
+        nil
+      when "false", "f", "no"
+        false
+      else
+        true
+      end
+    end
+  end
+
+  # Default log level verbosity
+  DEFAULT_LOG_LEVEL = :info
+
+  # Overwrite the log file when Test Kitchen runs
+  DEFAULT_LOG_OVERWRITE = true
+
+  # Default base directory for integration tests, fixtures, etc.
+  DEFAULT_TEST_DIR = "test/integration".freeze
+
+  # Default base directory for instance and common log files
+  DEFAULT_LOG_DIR = ".kitchen/logs".freeze
+end
+
+# Initialize the base logger
+Kitchen.logger = Kitchen.default_logger
+
+# Setup a collection of instance crash exceptions for error reporting
+Kitchen.mutex = Mutex.new
+
+# Initialize the mutex for Dir.chdir coordination
+Kitchen.mutex_chdir = Mutex.new