test-kitchen-rsync 3.0.0.pre.1

data/lib/kitchen/provisioner/chef_infra.rb

@@ -0,0 +1,167 @@
+#
+# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
+#
+# Copyright (C) 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_relative "chef_base"
+
+module Kitchen
+  module Provisioner
+    # Chef Zero provisioner.
+    #
+    # @author Fletcher Nichol <fnichol@nichol.ca>
+    class ChefInfra < ChefBase
+      kitchen_provisioner_api_version 2
+
+      plugin_version Kitchen::VERSION
+
+      default_config :client_rb, {}
+      default_config :named_run_list, {}
+      default_config :json_attributes, true
+      default_config :chef_zero_host, nil
+      default_config :chef_zero_port, 8889
+
+      default_config :chef_client_path do |provisioner|
+        provisioner
+          .remote_path_join(%W{#{provisioner[:chef_omnibus_root]} bin chef-client})
+          .tap { |path| path.concat(".bat") if provisioner.windows_os? }
+      end
+
+      default_config :ruby_bindir do |provisioner|
+        provisioner
+          .remote_path_join(%W{#{provisioner[:chef_omnibus_root]} embedded bin})
+      end
+
+      # (see Base#create_sandbox)
+      def create_sandbox
+        super
+        prepare_validation_pem
+        prepare_config_rb
+      end
+
+      def run_command
+        cmd = "#{sudo(config[:chef_client_path])} --local-mode".tap { |str| str.insert(0, "& ") if powershell_shell? }
+
+        chef_cmd(cmd)
+      end
+
+      private
+
+      # Adds optional flags to a chef-client command, depending on
+      # configuration data. Note that this method mutates the incoming Array.
+      #
+      # @param args [Array<String>] array of flags
+      # @api private
+      # rubocop:disable Metrics/CyclomaticComplexity
+      def add_optional_chef_client_args!(args)
+        if config[:json_attributes]
+          json = remote_path_join(config[:root_path], "dna.json")
+          args << "--json-attributes #{json}"
+        end
+
+        args << "--logfile #{config[:log_file]}" if config[:log_file]
+
+        # these flags are chef-client local mode only and will not work
+        # on older versions of chef-client
+        if config[:chef_zero_host]
+          args << "--chef-zero-host #{config[:chef_zero_host]}"
+        end
+
+        if config[:chef_zero_port]
+          args << "--chef-zero-port #{config[:chef_zero_port]}"
+        end
+
+        args << "--profile-ruby" if config[:profile_ruby]
+
+        if config[:slow_resource_report]
+          if config[:slow_resource_report].is_a?(Integer)
+            args << "--slow-report #{config[:slow_resource_report]}"
+          else
+            args << "--slow-report"
+          end
+        end
+      end
+      # rubocop:enable Metrics/CyclomaticComplexity
+
+      # Returns an Array of command line arguments for the chef client.
+      #
+      # @return [Array<String>] an array of command line arguments
+      # @api private
+      def chef_args(client_rb_filename)
+        level = config[:log_level]
+        args = [
+            "--config #{remote_path_join(config[:root_path], client_rb_filename)}",
+            "--log_level #{level}",
+            "--force-formatter",
+            "--no-color",
+        ]
+        add_optional_chef_client_args!(args)
+
+        args
+      end
+
+      # Generates a string of shell environment variables needed for the
+      # chef-client-zero.rb shim script to properly function.
+      #
+      # @return [String] a shell script string
+      # @api private
+      def chef_client_zero_env
+        root = config[:root_path]
+        gem_home = gem_path = remote_path_join(root, "chef-client-zero-gems")
+        gem_cache = remote_path_join(gem_home, "cache")
+
+        [
+            shell_env_var("CHEF_REPO_PATH", root),
+            shell_env_var("GEM_HOME", gem_home),
+            shell_env_var("GEM_PATH", gem_path),
+            shell_env_var("GEM_CACHE", gem_cache),
+        ].join("\n").concat("\n")
+      end
+
+      # Writes a fake (but valid) validation.pem into the sandbox directory.
+      #
+      # @api private
+      def prepare_validation_pem
+        info("Preparing validation.pem")
+        debug("Using a dummy validation.pem")
+
+        source = File.join(File.dirname(__FILE__),
+                           %w{.. .. .. support dummy-validation.pem})
+        FileUtils.cp(source, File.join(sandbox_path, "validation.pem"))
+      end
+
+      # Returns the command that will run a backwards compatible shim script
+      # that approximates local mode in a modern chef-client run.
+      #
+      # @return [String] the command string
+      # @api private
+      def shim_command
+        ruby = remote_path_join(config[:ruby_bindir], "ruby")
+          .tap { |path| path.concat(".exe") if windows_os? }
+        shim = remote_path_join(config[:root_path], "chef-client-zero.rb")
+
+        "#{chef_client_zero_env}\n#{sudo(ruby)} #{shim}"
+      end
+
+      # This provisioner supports policyfiles, so override the default (which
+      # is false)
+      # @return [true] always returns true
+      # @api private
+      def supports_policyfile?
+        true
+      end
+    end
+  end
+end

data/lib/kitchen/provisioner/chef_solo.rb

@@ -0,0 +1,82 @@
+#
+# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
+#
+# Copyright (C) 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_relative "chef_base"
+
+module Kitchen
+  module Provisioner
+    # Chef Solo provisioner.
+    #
+    # @author Fletcher Nichol <fnichol@nichol.ca>
+    class ChefSolo < ChefBase
+      kitchen_provisioner_api_version 2
+
+      plugin_version Kitchen::VERSION
+
+      # ChefSolo is dependent on Berkshelf, which is not thread-safe.
+      # See discussion on https://github.com/test-kitchen/test-kitchen/issues/1307
+      no_parallel_for :converge
+
+      default_config :solo_rb, {}
+
+      default_config :chef_solo_path do |provisioner|
+        provisioner
+          .remote_path_join(%W{#{provisioner[:chef_omnibus_root]} bin chef-solo})
+          .tap { |path| path.concat(".bat") if provisioner.windows_os? }
+      end
+
+      # (see Base#config_filename)
+      def config_filename
+        "solo.rb"
+      end
+
+      # (see Base#create_sandbox)
+      def create_sandbox
+        super
+        prepare_config_rb
+      end
+
+      # (see Base#run_command)
+      def run_command
+        cmd = sudo(config[:chef_solo_path]).dup
+          .tap { |str| str.insert(0, "& ") if powershell_shell? }
+
+        chef_cmd(cmd)
+      end
+
+      private
+
+      # Returns an Array of command line arguments for the chef client.
+      #
+      # @return [Array<String>] an array of command line arguments
+      # @api private
+      def chef_args(solo_rb_filename)
+        args = [
+          "--config #{remote_path_join(config[:root_path], solo_rb_filename)}",
+          "--log_level #{config[:log_level]}",
+          "--force-formatter",
+          "--no-color",
+          "--json-attributes #{remote_path_join(config[:root_path], "dna.json")}",
+        ]
+        args << "--logfile #{config[:log_file]}" if config[:log_file]
+        args << "--profile-ruby" if config[:profile_ruby]
+        args << "--legacy-mode" if config[:legacy_mode]
+        args
+      end
+    end
+  end
+end

data/lib/kitchen/provisioner/chef_zero.rb

@@ -0,0 +1,12 @@
+# Deprecated AS PER THE PR - https://github.com/test-kitchen/test-kitchen/pull/1730
+require_relative "chef_infra"
+
+module Kitchen
+  module Provisioner
+    # Chef Zero provisioner.
+    #
+    # @author Fletcher Nichol <fnichol@nichol.ca>
+    class ChefZero < ChefInfra
+    end
+  end
+end

data/lib/kitchen/provisioner/dummy.rb

@@ -0,0 +1,75 @@
+#
+# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
+#
+# Copyright (C) 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_relative "../../kitchen"
+
+module Kitchen
+  module Provisioner
+    # Dummy provisioner for Kitchen. This driver does nothing but report what
+    # would happen if this provisioner did anything of consequence. As a result
+    # it may be a useful provisioner to use when debugging or developing new
+    # features or plugins.
+    #
+    # @author Fletcher Nichol <fnichol@nichol.ca>
+    class Dummy < Kitchen::Provisioner::Base
+      kitchen_provisioner_api_version 2
+
+      plugin_version Kitchen::VERSION
+
+      default_config :sleep, 0
+      default_config :random_failure, false
+
+      # (see Base#call)
+      def call(state)
+        info("[#{name}] Converge on instance=#{instance} with state=#{state}")
+        sleep_if_set
+        failure_if_set
+        debug("[#{name}] Converge 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 Provisioner #{name}.")
+          raise ActionFailed, "Action #converge failed for #{instance.to_str}."
+        elsif config[:random_failure] && randomly_fail?
+          debug("Random failure for Provisioner #{name}.")
+          raise ActionFailed, "Action #converge 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/provisioner/shell.rb

@@ -0,0 +1,157 @@
+#
+# Author:: Chris Lundquist (<chris.lundquist@github.com>)
+#
+# Copyright (C) 2013, Chris Lundquist
+#
+# 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 "shellwords" unless defined?(Shellwords)
+
+require_relative "base"
+require_relative "../version"
+
+module Kitchen
+  module Provisioner
+    # Basic shell provisioner.
+    #
+    # @author Chris Lundquist (<chris.ludnquist@github.com>)
+    class Shell < Base
+      kitchen_provisioner_api_version 2
+
+      plugin_version Kitchen::VERSION
+
+      default_config :script do |provisioner|
+        src = provisioner.powershell_shell? ? "bootstrap.ps1" : "bootstrap.sh"
+        provisioner.calculate_path(src, type: :file)
+      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
+      expand_path_for :data_path
+
+      # (see Base#create_sandbox)
+      def create_sandbox
+        super
+        prepare_data
+        prepare_script
+      end
+
+      # (see Base#init_command)
+      def init_command
+        return nil if config[:command]
+
+        root = config[:root_path]
+        data = remote_path_join(root, "data")
+
+        code = if powershell_shell?
+                 Util.outdent!(<<-POWERSHELL)
+            if (Test-Path "#{data}") {
+              Remove-Item "#{data}" -Recurse -Force
+            }
+            if (-Not (Test-Path "#{root}")) {
+              New-Item "#{root}" -ItemType directory | Out-Null
+            }
+                 POWERSHELL
+               else
+                 "#{sudo("rm")} -rf #{data} ; mkdir -p #{root}"
+               end
+
+        prefix_command(wrap_shell_code(code))
+      end
+
+      # (see Base#prepare_command)
+      def prepare_command
+        # On a windows host, the supplied script does not get marked as executable
+        # due to windows not having the concept of an executable flag
+        #
+        # When the guest instance is *nix, `chmod +x` the script in the guest, prior to executing
+        return unless unix_os? && config[:script] && !config[:command]
+
+        debug "Marking script as executable"
+        script = remote_path_join(
+          config[:root_path],
+          File.basename(config[:script])
+        )
+        prefix_command(wrap_shell_code(sudo("chmod +x #{script}")))
+      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] && !config[:arguments].empty?
+          if config[:arguments].is_a?(Array)
+            if powershell_shell?
+              script = ([script] + config[:arguments]).join(" ")
+            else
+              script = Shellwords.join([script] + config[:arguments])
+            end
+          else
+            script.concat(" ").concat(config[:arguments].to_s)
+          end
+        end
+
+        code = powershell_shell? ? %{& #{script}} : sudo(script)
+
+        prefix_command(wrap_shell_code(code))
+      end
+
+      private
+
+      # Creates a data directory in the sandbox directory, if a data directory
+      # can be found and copies in the tree.
+      #
+      # @api private
+      def prepare_data
+        return unless config[:data_path]
+
+        info("Preparing data")
+        debug("Using data from #{config[:data_path]}")
+
+        tmpdata_dir = File.join(sandbox_path, "data")
+        FileUtils.mkdir_p(tmpdata_dir)
+        FileUtils.cp_r(Util.list_directory(config[:data_path]), tmpdata_dir)
+      end
+
+      # Copies the executable script to the sandbox directory or creates a
+      # stub script if one cannot be found.
+      #
+      # @api private
+      def prepare_script
+        info("Preparing script")
+
+        if config[:script]
+          debug("Using script from #{config[:script]}")
+          FileUtils.cp_r(config[:script], sandbox_path)
+        else
+          info("No provisioner script file specified, skipping")
+        end
+      end
+
+    end
+  end
+end

data/lib/kitchen/provisioner.rb

@@ -0,0 +1,42 @@
+#
+# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
+#
+# Copyright (C) 2013, Fletcher Nichol
+# Copyright (C) Chef Software Inc.
+#
+# 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 provisioner is responsible for generating the commands necessary to
+  # install set up and use a configuration management tool such as Chef and
+  # Puppet.
+  #
+  # @author Fletcher Nichol <fnichol@nichol.ca>
+  module Provisioner
+    # Default provisioner to use
+    DEFAULT_PLUGIN = "chef_infra".freeze
+
+    # Returns an instance of a provisioner given a plugin type string.
+    #
+    # @param plugin [String] a provisioner plugin type, to be constantized
+    # @param config [Hash] a configuration hash to initialize the provisioner
+    # @return [Provisioner::Base] a provisioner instance
+    # @raise [ClientError] if a provisioner instance could not be created
+    def self.for_plugin(plugin, config)
+      plugin, config[:name] = "chef_infra", "chef_infra" if plugin == "chef_zero"
+      Kitchen::Plugin.load(self, plugin, config)
+    end
+  end
+end

data/lib/kitchen/rake_tasks.rb

@@ -0,0 +1,80 @@
+#
+# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
+#
+# Copyright (C) 2012, 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 "rake/tasklib"
+
+require_relative "../kitchen"
+
+module Kitchen
+  # Kitchen Rake task generator.
+  #
+  # @author Fletcher Nichol <fnichol@nichol.ca>
+  class RakeTasks < ::Rake::TaskLib
+    # Creates Kitchen Rake tasks and allows the callee to configure it.
+    #
+    # @yield [self] gives itself to the block
+    def initialize(cfg = {})
+      @loader = Kitchen::Loader::YAML.new(
+        project_config: ENV["KITCHEN_YAML"],
+        local_config: ENV["KITCHEN_LOCAL_YAML"],
+        global_config: ENV["KITCHEN_GLOBAL_YAML"]
+      )
+      @config = Kitchen::Config.new(
+        { loader: @loader }.merge(cfg)
+      )
+      Kitchen.logger = Kitchen.default_file_logger(nil, false)
+      yield self if block_given?
+      define
+    end
+
+    # @return [Config] a Kitchen::Config
+    attr_reader :config
+
+    private
+
+    # Generates a test Rake task for each instance and one to test all
+    # instances in serial.
+    #
+    # @api private
+    def define
+      namespace "kitchen" do
+        kitchen_commands = %w{create converge setup verify destroy}
+        config.instances.each do |instance|
+          desc "Run #{instance.name} test instance"
+          task instance.name do
+            instance.test(:always)
+          end
+
+          kitchen_commands.each do |cmd|
+            namespace cmd do
+              task instance.name do
+                instance.send(cmd)
+              end
+              desc "Run all #{cmd} instances"
+              task "all" => config.instances.map(&:name)
+            end
+          end
+        end
+
+        desc "Run all test instances"
+        task "all" => config.instances.map(&:name)
+
+        kitchen_commands.each { |cmd| task cmd => "#{cmd}:all" }
+      end
+    end
+  end
+end