test-kitchen 1.23.5 → 1.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 488771ed1b9c558d2fe1b635bd63dc6090996ad4a11c67594f17cbca7444e1bc
-  data.tar.gz: 6bd56d4fd594bcf27505242dc932715d90e915c06410e29ee940388b7a34512f
+  metadata.gz: 4f96d164d3286ff8f8445c248a0457012d3e633fd99cd27844cbd869409b971b
+  data.tar.gz: dea0f61a598f25e833fe700381033a4c1b90c38c46c8177ef3518922c09eb860
 SHA512:
-  metadata.gz: bbc21a4b26579941bc3b122cfe739cf692070a8b7d5647c9568fb315def7f2001d1d48774601733c0f9651e7cb4c6a193f072dc4f4c79f0ad2b99b870d851d9c
-  data.tar.gz: 22f76ecbe748a429765881be7cd604bbdc5036d5ee1d069cdd099aeaa82133b5c70d9393af4830350b6a42a1cf3d2f91239d3829665a683821aabd54599e65db
+  metadata.gz: 26b4c8102ae775129437252c33c387d379e6099e2c7b4147a61e4c729a859fc6ee4816f38e4f157f406080ebe59c00976249df9d55854aed04819feda880a6ac
+  data.tar.gz: 93a9e042dff74b4ef29870bb990edce9556fd559724666164c4aaa891e2b5e4cb4ea07ea0abfa66b6e5ba4fba2c0c7d64dd66e53613569abf9d7dd3ff6d45bcf

data/Gemfile

@@ -2,8 +2,6 @@
 source "https://rubygems.org"
 gemspec
 
-gem "train", "~> 0.22"
-
 group :integration do
   gem "berkshelf"
   gem "kitchen-inspec"

data/Rakefile

@@ -0,0 +1,77 @@
+# -*- encoding: utf-8 -*-
+
+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 ~@ignore"]
+  end
+rescue LoadError
+  puts "cucumber is not available. (sudo) gem install cucumber to run tests."
+end
+
+desc "Run all test suites"
+task test: [: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: [:style, :stats]
+
+begin
+  require "yard"
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  puts "yard is not available. (sudo) gem install yard to generate yard documentation."
+end
+
+task default: [:test, :quality]
+
+begin
+  require "github_changelog_generator/task"
+  require "kitchen/version"
+
+  GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+    config.future_release = "v#{Kitchen::VERSION}"
+    config.enhancement_labels = "enhancement,Enhancement,New Feature,Feature,Improvement".split(",")
+    config.bug_labels = "bug,Bug".split(",")
+    config.exclude_labels = %w{Duplicate Question Discussion No_Changelog}
+  end
+rescue LoadError
+  puts "github_changelog_generator is not available." \
+       " (sudo) gem install github_changelog_generator to generate changelogs"
+end
+
+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/lib/kitchen/driver.rb

@@ -16,7 +16,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "thor/util"
+require "kitchen/plugin"
 
 module Kitchen
   # A driver is responsible for carrying out the lifecycle activities of an
@@ -35,20 +35,7 @@ module Kitchen
     # @raise [ClientError] if a driver instance could not be created
     # @raise [UserError] if the driver's dependencies could not be met
     def self.for_plugin(plugin, config)
-      first_load = require("kitchen/driver/#{plugin}")
-
-      str_const = Thor::Util.camel_case(plugin)
-      klass = const_get(str_const)
-      object = klass.new(config)
-      object.verify_dependencies if first_load
-      object
-    rescue UserError
-      raise
-    rescue LoadError, NameError
-      raise ClientError,
-            "Could not load the '#{plugin}' driver from the load path." \
-              " Please ensure that your driver is installed as a gem or included" \
-              " in your Gemfile if using Bundler."
+      Kitchen::Plugin.load(self, plugin, config)
     end
   end
 end

data/lib/kitchen/driver/base.rb

@@ -16,7 +16,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require "kitchen/configurable"
+require "kitchen/errors"
 require "kitchen/lazy_hash"
+require "kitchen/logging"
 require "kitchen/shell_out"
 
 module Kitchen

data/lib/kitchen/plugin.rb

@@ -0,0 +1,77 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
+#
+# Copyright (C) 2012, Fletcher Nichol
+# Copyright (C) 2018, Chef Software
+#
+# 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/errors"
+require "kitchen/util"
+
+module Kitchen
+  module Plugin
+    # Returns an instance of a plugin given a type, name, and config.
+    #
+    # @param type [Module] a Kitchen::<Module> of one of the plugin types
+    #   (Driver, Provisioner, Transport, Verifier)
+    # @param plugin [String] a plugin name, which will be constantized
+    # @param config [Hash] a configuration hash to initialize the plugin
+    # @return [Kitchen::<Module>::Base] a plugin instance
+    # @raise [ClientError] if a plugin instance could not be created
+    # @raise [UserError] if the plugin's dependencies could not be met
+    def self.load(type, plugin, config)
+      type_name = Kitchen::Util.snake_case(type.name.split("::").last)
+      first_load = require("kitchen/#{type_name}/#{plugin}")
+
+      str_const = Kitchen::Util.camel_case(plugin)
+      klass = type.const_get(str_const)
+      object = klass.new(config)
+      object.verify_dependencies if first_load
+      object
+    rescue UserError
+      raise
+    rescue NameError => e
+      raise ClientError, "Could not load the '#{plugin}' #{type_name}. Error: #{e.message}"
+    rescue LoadError => e
+      available_plugins = plugins_available(type_name)
+      error_message = if available_plugins.include?(plugin)
+                        e.message
+                      else
+                        " Did you mean: #{available_plugins.join(", ")} ?" \
+                        " Please ensure that your #{type_name} is installed as a gem or included" \
+                        " in your Gemfile if using Bundler."
+                      end
+      raise ClientError, "Could not load the '#{plugin}' #{type_name} from the load path." + error_message
+    end
+
+    # given a type of plugin, searches the Ruby load path for plugins of that
+    # type based on the path+naming convention that plugin loading is based upon
+    #
+    # @param plugin_type [String] the name of a plugin type (e.g. driver,
+    #   provisioner, transport, verifier)
+    # @return [Array<String>] a collection of Ruby filenames that are probably
+    #   plugins of the given type
+    def self.plugins_available(plugin_type)
+      $LOAD_PATH.map { |load_path| Dir[File.expand_path("kitchen/#{plugin_type}/*.rb", load_path)] }
+                .reject { |plugin_paths| plugin_paths.empty? }
+                .flatten
+                .uniq
+                .select { |plugin_path| File.readlines(plugin_path).grep(/^\s*class \w* </).any? }
+                .map { |plugin_path| File.basename(plugin_path).gsub(/\.rb$/, "") }
+                .reject { |plugin_name| plugin_name == "base" }
+                .sort
+    end
+  end
+end

data/lib/kitchen/provisioner.rb

@@ -16,7 +16,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "thor/util"
+require "kitchen/plugin"
 
 module Kitchen
   # A provisioner is responsible for generating the commands necessary to
@@ -35,18 +35,7 @@ module Kitchen
     # @return [Provisioner::Base] a provisioner instance
     # @raise [ClientError] if a provisioner instance could not be created
     def self.for_plugin(plugin, config)
-      first_load = require("kitchen/provisioner/#{plugin}")
-
-      str_const = Thor::Util.camel_case(plugin)
-      klass = const_get(str_const)
-      object = klass.new(config)
-      object.verify_dependencies if first_load
-      object
-    rescue LoadError, NameError
-      raise ClientError,
-            "Could not load the '#{plugin}' provisioner from the load path." \
-              " Please ensure that your provisioner is installed as a gem or" \
-              " included in your Gemfile if using Bundler."
+      Kitchen::Plugin.load(self, plugin, config)
     end
   end
 end

data/lib/kitchen/provisioner/base.rb

@@ -16,6 +16,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require "kitchen/configurable"
+require "kitchen/errors"
+require "kitchen/logging"
+
 module Kitchen
   module Provisioner
     # Base class for a provisioner.

data/lib/kitchen/transport.rb

@@ -16,7 +16,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "thor/util"
+require "kitchen/plugin"
 
 module Kitchen
   # A transport is responsible for the communication with an instance,
@@ -35,18 +35,7 @@ module Kitchen
     # @return [Transport::Base] a transport instance
     # @raise [ClientError] if a transport instance could not be created
     def self.for_plugin(plugin, config)
-      first_load = require("kitchen/transport/#{plugin}")
-
-      str_const = Thor::Util.camel_case(plugin)
-      klass = const_get(str_const)
-      object = klass.new(config)
-      object.verify_dependencies if first_load
-      object
-    rescue LoadError, NameError
-      raise ClientError,
-            "Could not load the '#{plugin}' transport from the load path." \
-              " Please ensure that your transport is installed as a gem or" \
-              " included in your Gemfile if using Bundler."
+      Kitchen::Plugin.load(self, plugin, config)
     end
   end
 end

data/lib/kitchen/transport/base.rb

@@ -17,8 +17,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require "kitchen/configurable"
 require "kitchen/errors"
 require "kitchen/lazy_hash"
+require "kitchen/logging"
 require "kitchen/login_command"
 
 module Kitchen

data/lib/kitchen/util.rb

@@ -16,6 +16,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require "kitchen/errors"
+require "thor/util"
+
 module Kitchen
   # Stateless utility methods used in different contexts. Essentially a mini
   # PassiveSupport library.
@@ -205,5 +208,13 @@ module Kitchen
         end
       end
     end
+
+    def self.camel_case(a_string)
+      Thor::Util.camel_case(a_string)
+    end
+
+    def self.snake_case(a_string)
+      Thor::Util.snake_case(a_string)
+    end
   end
 end

data/lib/kitchen/verifier.rb

@@ -16,9 +16,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "thor/util"
-
-require "kitchen/errors"
+require "kitchen/plugin"
 
 module Kitchen
   # A verifier is responsible for running tests post-converge to confirm that
@@ -36,18 +34,7 @@ module Kitchen
     # @return [Verifier::Base] a verifier instance
     # @raise [ClientError] if a verifier instance could not be created
     def self.for_plugin(plugin, config)
-      first_load = require("kitchen/verifier/#{plugin}")
-
-      str_const = Thor::Util.camel_case(plugin)
-      klass = const_get(str_const)
-      object = klass.new(config)
-      object.verify_dependencies if first_load
-      object
-    rescue LoadError, NameError
-      raise ClientError,
-            "Could not load the '#{plugin}' verifier from the load path." \
-              " Please ensure that your transport is installed as a gem or" \
-              " included in your Gemfile if using Bundler."
+      Kitchen::Plugin.load(self, plugin, config)
     end
   end
 end

data/lib/kitchen/version.rb

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

data/test-kitchen.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |gem|
   gem.homepage      = "https://kitchen.ci/"
 
   # The gemfile and gemspec are necessary for appbundler in Chef-DK / Workstation
-  gem.files         = %w{LICENSE test-kitchen.gemspec Gemfile} + Dir.glob("{bin,lib,templates,support}/**/*")
+  gem.files         = %w{LICENSE test-kitchen.gemspec Gemfile Rakefile} + Dir.glob("{bin,lib,templates,support}/**/*")
   gem.executables   = %w{kitchen}
   gem.require_paths = ["lib"]
 
@@ -34,7 +34,6 @@ Gem::Specification.new do |gem|
   gem.add_dependency "winrm-fs", "~> 1.1"
 
   gem.add_development_dependency "rb-readline"
-  gem.add_development_dependency "overcommit", "= 0.33.0"
 
   gem.add_development_dependency "bundler"
   gem.add_development_dependency "rake"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-kitchen
 version: !ruby/object:Gem::Version
-  version: 1.23.5
+  version: 1.24.0
 platform: ruby
 authors:
 - Fletcher Nichol
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-11 00:00:00.000000000 Z
+date: 2018-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mixlib-shellout
@@ -162,20 +162,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: overcommit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.33.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.33.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -319,6 +305,7 @@ extra_rdoc_files: []
 files:
 - Gemfile
 - LICENSE
+- Rakefile
 - bin/kitchen
 - lib/kitchen.rb
 - lib/kitchen/base64_stream.rb
@@ -357,6 +344,7 @@ files:
 - lib/kitchen/login_command.rb
 - lib/kitchen/metadata_chopper.rb
 - lib/kitchen/platform.rb
+- lib/kitchen/plugin.rb
 - lib/kitchen/provisioner.rb
 - lib/kitchen/provisioner/base.rb
 - lib/kitchen/provisioner/chef/berkshelf.rb