test-kitchen-rsync 3.0.0.pre.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 29d0736fe0c4a14aac48efa417d50780d2f48e216662733a3a4d526e6b6ea917
+  data.tar.gz: cd4485fb111391400af85845b9927a19a745b496411059d4f00eae9ab9ddcc1b
+SHA512:
+  metadata.gz: 03c21555b0be1dd75b89d4cf1f7d63eea0dafefb29fd1bb9af8c7d6da575a449575adba2b067e654fb8e8d9d654503d4b930046f27456ed3fe92c8375a26ea02
+  data.tar.gz: a57aa49fcce002ef96be611b0ae70e4f284419d4c5da38609179f40a2fe207b2ee177dd104c3bf4dff2999fb01d8d638c62f99be08745e76169100bf0b3fc1ef

data/Gemfile

@@ -0,0 +1,21 @@
+source "https://rubygems.org"
+
+# Specify your gem"s dependencies in test-kitchen.gemspec
+gemspec
+
+group :integration do
+  gem "berkshelf"
+  gem "kitchen-inspec"
+  gem "kitchen-dokken"
+  gem "kitchen-vagrant"
+end
+
+group :debug do
+  gem "pry", "~>0.12"
+  gem "pry-byebug"
+  gem "pry-stack_explorer"
+end
+
+group :chefstyle do
+  gem "chefstyle", "2.0.9"
+end

data/LICENSE

@@ -0,0 +1,15 @@
+Author:: Fletcher Nichol (<fnichol@nichol.ca>)
+
+Copyright 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.

data/Rakefile

@@ -0,0 +1,53 @@
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+Rake::TestTask.new(:unit) do |t|
+  t.libs.push "lib"
+  t.test_files = FileList["spec/**/*_spec.rb"]
+  t.verbose = true
+end
+
+begin
+  require "cucumber"
+  require "cucumber/rake/task"
+  Cucumber::Rake::Task.new(:features) do |t|
+    t.cucumber_opts = ["features", "-x", "--format progress", "--no-color", "--tags 'not @ignore'"]
+  end
+rescue LoadError
+  puts "cucumber is not available. (sudo) gem install cucumber to run tests."
+end
+
+desc "Run all test suites"
+task test: %i{unit features}
+
+desc "Display LOC stats"
+task :stats do
+  puts "\n## Production Code Stats"
+  sh "countloc -r lib/kitchen lib/kitchen.rb"
+  puts "\n## Test Code Stats"
+  sh "countloc -r spec features"
+end
+
+begin
+  require "chefstyle"
+  require "rubocop/rake_task"
+  RuboCop::RakeTask.new(:style) do |task|
+    task.options += ["--display-cop-names", "--no-color"]
+  end
+rescue LoadError
+  puts "chefstyle is not available. (sudo) gem install chefstyle to do style checking."
+end
+
+desc "Run all quality tasks"
+task quality: %i{style stats}
+
+task default: %i{test quality}
+
+namespace :docs do
+  desc "Deploy docs"
+  task :deploy do
+    sh "cd docs && hugo"
+    sh "aws --profile chef-cd s3 sync docs/public s3://test-kitchen-legacy.cd.chef.co --delete --acl public-read"
+    sh "aws --profile chef-cd cloudfront create-invalidation --distribution-id EQD8MRW086SRT --paths '/*'"
+  end
+end

data/bin/zl-kitchen

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# Trap interrupts to quit cleanly. See
+# https://twitter.com/mitchellh/status/283014103189053442
+Signal.trap("INT") { exit 1 }
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), %w{.. lib})
+require "rubygems" unless defined?(Gem)
+require "kitchen/cli"
+require "kitchen/errors"
+
+Kitchen.with_friendly_errors { Kitchen::CLI.start }

data/lib/kitchen/base64_stream.rb

@@ -0,0 +1,48 @@
+#
+# 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.
+
+module Kitchen
+  # Base64 encoder/decoder that operates on IO objects so as to minimize
+  # memory allocations on large payloads.
+  #
+  # @author Fletcher Nichol <fnichol@nichol.ca>
+  module Base64Stream
+    # Encodes an input stream into a Base64 output stream. The input and ouput
+    # objects must be opened IO resources. In other words, opening and closing
+    # the resources are not the responsibilty of this method.
+    #
+    # @param io_in [#read] input stream
+    # @param io_out [#write] output stream
+    def self.strict_encode(io_in, io_out)
+      buffer = ""
+      io_out.write([buffer].pack("m0")) while io_in.read(3 * 1000, buffer)
+      buffer = nil # rubocop:disable Lint/UselessAssignment
+    end
+
+    # Decodes a Base64 input stream into an output stream. The input and ouput
+    # objects must be opened IO resources. In other words, opening and closing
+    # the resources are not the responsibilty of this method.
+    #
+    # @param io_in [#read] input stream
+    # @param io_out [#write] output stream
+    def self.strict_decode(io_in, io_out)
+      buffer = ""
+      io_out.write(buffer.unpack("m0").first) while io_in.read(3 * 1000, buffer)
+      buffer = nil # rubocop:disable Lint/UselessAssignment
+    end
+  end
+end

data/lib/kitchen/chef_utils_wiring.rb

@@ -0,0 +1,40 @@
+# 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.
+#
+
+module Kitchen
+  # Common Dependency Injection wiring for ChefUtils-related modules
+  module ChefUtilsWiring
+    private
+
+    def __config
+      # this would need to be some kind of Chef::Config looking thing, which probably requires
+      # a translation object from t-k config to Chef::Config layout if that ever becomes necessary.
+      # this ISNT the t-k config.
+      {}
+    end
+
+    def __log
+      @logger
+    end
+
+    def __transport_connection
+      # this could be wired up to train at some point, but need to be careful because about local vs. remote
+      # uses of helpers with test-kitchen, right now we're using it for local.
+    end
+  end
+end

data/lib/kitchen/cli.rb

@@ -0,0 +1,413 @@
+#
+# 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.
+
+# CI tests fail without an explicit unconditional require of Thor
+require "thor" # rubocop:disable Chef/Ruby/UnlessDefinedRequire
+
+require_relative "../kitchen"
+require_relative "generator/init"
+
+module Kitchen
+  # The command line runner for Kitchen.
+  #
+  # @author Fletcher Nichol <fnichol@nichol.ca>
+  class CLI < Thor
+    # Common module to load and invoke a CLI-implementation agnostic command.
+    module PerformCommand
+      # Perform a CLI subcommand.
+      #
+      # @param task [String] action to take, usually corresponding to the
+      #   subcommand name
+      # @param command [String] command class to create and invoke]
+      # @param args [Array] remainder arguments from processed ARGV
+      #   (default: `nil`)
+      # @param additional_options [Hash] additional configuration needed to
+      #   set up the command class (default: `{}`)
+      def perform(task, command, args = nil, additional_options = {})
+        require "kitchen/command/#{command}"
+
+        command_options = {
+          action: task,
+          help: -> { help(task) },
+          config: @config,
+          shell: shell,
+        }.merge(additional_options)
+
+        str_const = Thor::Util.camel_case(command)
+        klass = ::Kitchen::Command.const_get(str_const)
+        klass.new(args, options, command_options).call
+      end
+    end
+
+    include Logging
+    include PerformCommand
+
+    # The maximum number of concurrent instances that can run--which is a bit
+    # high
+    MAX_CONCURRENCY = 9999
+
+    attr_reader :config
+
+    # Constructs a new instance.
+    def initialize(*args)
+      super
+      $stdout.sync = true
+      @loader = Kitchen::Loader::YAML.new(
+        project_config: ENV["KITCHEN_YAML"] || ENV["KITCHEN_YML"],
+        local_config: ENV["KITCHEN_LOCAL_YAML"] || ENV["KITCHEN_LOCAL_YML"],
+        global_config: ENV["KITCHEN_GLOBAL_YAML"] || ENV["KITCHEN_GLOBAL_YML"]
+      )
+      @config = Kitchen::Config.new(
+        loader: @loader
+      )
+      @config.log_level = Kitchen.env_log unless Kitchen.env_log.nil?
+      @config.log_overwrite = Kitchen.env_log_overwrite unless Kitchen.env_log_overwrite.nil?
+    end
+
+    # Sets the logging method_options
+    # @api private
+    def self.log_options
+      method_option :log_level,
+        aliases: "-l",
+        desc: "Set the log level (debug, info, warn, error, fatal)"
+      method_option :log_overwrite,
+        desc: "Set to false to prevent log overwriting each time Test Kitchen runs",
+        type: :boolean
+      method_option :color,
+        type: :boolean,
+        lazy_default: $stdout.tty?,
+        desc: "Toggle color output for STDOUT logger"
+    end
+
+    # Sets the test_base_path method_options
+    # @api private
+    def self.test_base_path
+      method_option :test_base_path,
+        aliases: "-t",
+        desc: "Set the base path of the tests"
+    end
+
+    desc "list [INSTANCE|REGEXP|all]", "Lists one or more instances"
+    method_option :bare,
+      aliases: "-b",
+      type: :boolean,
+      desc: "List the name of each instance only, one per line"
+    method_option :json,
+      aliases: "-j",
+      type: :boolean,
+      desc: "Print data as JSON"
+    method_option :debug,
+      aliases: "-d",
+      type: :boolean,
+      desc: "[Deprecated] Please use `kitchen diagnose'"
+    log_options
+    def list(*args)
+      update_config!
+      perform("list", "list", args)
+    end
+    map status: :list
+
+    desc "diagnose [INSTANCE|REGEXP|all]", "Show computed diagnostic configuration"
+    method_option :loader,
+      type: :boolean,
+      desc: "Include data loader diagnostics"
+    method_option :plugins,
+      type: :boolean,
+      desc: "Include plugin diagnostics"
+    method_option :instances,
+      type: :boolean,
+      default: true,
+      desc: "Include instances diagnostics"
+    method_option :all,
+      type: :boolean,
+      desc: "Include all diagnostics"
+    log_options
+    test_base_path
+    def diagnose(*args)
+      update_config!
+      perform("diagnose", "diagnose", args, loader: @loader)
+    end
+
+    {
+      create: "Change instance state to create. " \
+                   "Start one or more instances",
+      converge: "Change instance state to converge. " \
+                   "Use a provisioner to configure one or more instances",
+      setup: "Change instance state to setup. " \
+                   "Prepare to run automated tests. " \
+                   "Install busser and related gems on one or more instances",
+      verify: "Change instance state to verify. " \
+                   "Run automated tests on one or more instances",
+      destroy: "Change instance state to destroy. " \
+                   "Delete all information for one or more instances",
+    }.each do |action, short_desc|
+      desc(
+        "#{action} [INSTANCE|REGEXP|all]",
+        short_desc
+      )
+      long_desc <<-DESC
+        The instance states are in order: destroy, create, converge, setup, verify, destroy.
+        Change one or more instances from the current state to the #{action} state. Actions for all
+        intermediate states will be executed. See https://kitchen.ci/ for further explanation.
+      DESC
+      method_option :concurrency,
+        aliases: "-c",
+        type: :numeric,
+        lazy_default: MAX_CONCURRENCY,
+        desc: <<-DESC.gsub(/^\s+/, "").tr("\n", " ")
+          Run a #{action} against all matching instances concurrently. Only N
+          instances will run at the same time if a number is given.
+        DESC
+      method_option :parallel,
+        aliases: "-p",
+        type: :boolean,
+        desc: <<-DESC.gsub(/^\s+/, "").tr("\n", " ")
+          [Future DEPRECATION, use --concurrency]
+          Run a #{action} against all matching instances concurrently.
+        DESC
+      if action == :converge || action == :verify
+        method_option :debug,
+          aliases: "-D",
+          type: :boolean,
+          default: false,
+          desc: "Run the #{action} with debugging enabled."
+      end
+      method_option :fail_fast,
+        aliases: "-f",
+        type: :boolean,
+        desc: "Fail immediately when errors occur in concurrency mode"
+
+      test_base_path
+      log_options
+      define_method(action) do |*args|
+        update_config!
+        perform(action, "action", args)
+      end
+    end
+
+    desc "test [INSTANCE|REGEXP|all]",
+      "Test (destroy, create, converge, setup, verify and destroy) one or more instances"
+    long_desc <<-DESC
+      The instance states are in order: destroy, create, converge, setup, verify, destroy.
+      Test changes the state of one or more instances to destroyed, then executes
+      the actions for each state up to destroy. At any sign of failure, executing the
+      actions stops and the instance is left in the last successful execution state.
+
+      There are 3 post-verify modes for instance cleanup, triggered with
+      the `--destroy' flag:
+
+      * passing: instances passing verify will be destroyed afterwards.\n
+      * always: instances will always be destroyed afterwards.\n
+      * never: instances will never be destroyed afterwards.
+    DESC
+    method_option :concurrency,
+      aliases: "-c",
+      type: :numeric,
+      lazy_default: MAX_CONCURRENCY,
+      desc: <<-DESC.gsub(/^\s+/, "").tr("\n", " ")
+        Run a test against all matching instances concurrently. Only N
+        instances will run at the same time if a number is given.
+      DESC
+    method_option :parallel,
+      aliases: "-p",
+      type: :boolean,
+      desc: <<-DESC.gsub(/^\s+/, "").tr("\n", " ")
+        [Future DEPRECATION, use --concurrency]
+        Run a test against all matching instances concurrently.
+      DESC
+    method_option :destroy,
+      aliases: "-d",
+      default: "passing",
+      desc: "Destroy strategy to use after testing (passing, always, never)."
+    method_option :auto_init,
+      type: :boolean,
+      default: false,
+      desc: "Invoke init command if .kitchen.yml is missing"
+    method_option :debug,
+      aliases: "-D",
+      type: :boolean,
+      default: false,
+      desc: "Run the converge and verify with debugging enabled."
+    test_base_path
+    log_options
+    def test(*args)
+      update_config!
+      ensure_initialized
+      perform("test", "test", args)
+    end
+
+    desc "login INSTANCE|REGEXP", "Log in to one instance"
+    log_options
+    def login(*args)
+      update_config!
+      perform("login", "login", args)
+    end
+
+    desc "package INSTANCE|REGEXP", "package an instance"
+    log_options
+    def package(*args)
+      update_config!
+      perform("package", "package", args)
+    end
+
+    desc "doctor INSTANCE|REGEXP", "Check for common system problems"
+    log_options
+    method_option :all,
+      aliases: "-a",
+      desc: "Check all instances"
+    def doctor(*args)
+      update_config!
+      perform("doctor", "doctor", args)
+    end
+
+    desc "exec INSTANCE|REGEXP -c REMOTE_COMMAND",
+      "Execute command on one or more instance"
+    method_option :command,
+      aliases: "-c",
+      desc: "execute via ssh"
+    log_options
+    def exec(*args)
+      update_config!
+      perform("exec", "exec", args)
+    end
+
+    desc "version", "Print Test Kitchen's version information"
+    def version
+      puts "Test Kitchen version #{Kitchen::VERSION}"
+    end
+    map %w{-v --version} => :version
+
+    desc "sink", "Show the Kitchen sink!", hide: true
+    def sink
+      perform("sink", "sink")
+    end
+
+    desc "console", "Test Kitchen Console!"
+    def console
+      perform("console", "console")
+    end
+
+    register Kitchen::Generator::Init, "init",
+      "init", "Adds some configuration to your cookbook so Kitchen can rock"
+    long_desc <<-D, for: "init"
+      Init will add Test Kitchen support to an existing project for
+      convergence integration testing. A default kitchen.yml file (which is
+      intended to be customized) is created in the project's root directory
+      and one or more gems will be added to the project's Gemfile.
+    D
+    tasks["init"].options = Kitchen::Generator::Init.class_options
+
+    class << self
+      private
+
+      # Ensure the any failing commands exit non-zero.
+      #
+      # @return [true] you die always on failure
+      # @api private
+      def exit_on_failure?
+        true
+      end
+    end
+
+    private
+
+    # @return [Logger] the common logger
+    # @api private
+    def logger
+      Kitchen.logger
+    end
+
+    # Update and finalize options for logging, concurrency, and other concerns.
+    #
+    # @api private
+    def update_config!
+      @config.log_level = log_level if log_level
+
+      unless options[:log_overwrite].nil?
+        @config.log_overwrite = options[:log_overwrite]
+      end
+      @config.colorize = options[:color] unless options[:color].nil?
+
+      if options[:test_base_path]
+        # ensure we have an absolute path
+        @config.test_base_path = File.absolute_path(options[:test_base_path])
+      end
+
+      @config.debug = options[:debug]
+
+      # Now that we have required configs, lets create our file logger
+      Kitchen.logger = Kitchen.default_file_logger(
+        log_level,
+        options[:log_overwrite]
+      )
+
+      update_parallel!
+    end
+
+    # Validate the log level from the config / CLI options, defaulting
+    # to :info if the supplied level is empty or invalid
+    #
+    # @api private
+    def log_level
+      return unless options[:log_level]
+      return @log_level if @log_level
+
+      level = options[:log_level].downcase.to_sym
+      unless valid_log_level?(level)
+        level = :info
+        banner "WARNING - invalid log level specified: " \
+          "\"#{options[:log_level]}\" - reverting to :info log level."
+      end
+
+      @log_level = level
+    end
+
+    # Check to whether a provided log level is valid
+    #
+    # @api private
+    def valid_log_level?(level)
+      !Util.to_logger_level(level).nil?
+    end
+
+    # Set parallel concurrency options for Thor
+    #
+    # @api private
+    def update_parallel!
+      if options[:parallel]
+        # warn here in a future release when option is used
+        @options = Thor::CoreExt::HashWithIndifferentAccess.new(options.to_hash)
+        if options[:parallel] && !options[:concurrency]
+          options[:concurrency] = MAX_CONCURRENCY
+        end
+        options.delete(:parallel)
+        options.freeze
+      end
+    end
+
+    # If auto_init option is active, invoke the init generator.
+    #
+    # @api private
+    def ensure_initialized
+      yaml = ENV["KITCHEN_YAML"] || ENV["KITCHEN_YML"] || ".kitchen.yml"
+
+      if options[:auto_init] && !File.exist?(yaml)
+        banner "Invoking init as '#{yaml}' file is missing"
+        invoke "init"
+      end
+    end
+  end
+end

data/lib/kitchen/collection.rb

@@ -0,0 +1,52 @@
+#
+# 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 "delegate"
+
+module Kitchen
+  # Delegate class which adds the ability to find single and multiple
+  # objects by their #name in an Array. Hey, it's better than monkey-patching
+  # Array, right?
+  #
+  # @author Fletcher Nichol <fnichol@nichol.ca>
+  class Collection < SimpleDelegator
+    # Returns a single object by its name, or nil if none are found.
+    #
+    # @param name [String] name of object
+    # @return [Object] first match by name, or nil if none are found
+    def get(name)
+      __getobj__.find { |i| i.name == name }
+    end
+
+    # Returns a Collection of all objects whose #name is matched by the
+    # regular expression.
+    #
+    # @param regexp [Regexp] a regular expression pattern
+    # @return [Kitchen::Config::Collection<Object>] a new collection of
+    #   matched objects
+    def get_all(regexp)
+      Kitchen::Collection.new(__getobj__.select { |i| i.name =~ regexp })
+    end
+
+    # Returns an Array of names from the collection as strings.
+    #
+    # @return [Array<String>] array of name strings
+    def as_names
+      __getobj__.map(&:name)
+    end
+  end
+end