kitchen-terraform 3.3.0 → 3.3.1

data/lib/kitchen/terraform/config_attribute_type/integer.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+# Copyright 2016 New Context Services, 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 "dry-validation"
+require "kitchen/terraform/config_attribute"
+require "kitchen/terraform/config_attribute_type"
+
+# This module applies the behaviour of a configuration attribute of type integer to a module which must be included by a
+# plugin class.
+#
+# @see http://dry-rb.org/gems/dry-validation/basics/working-with-schemas/ DRY Validation Working With Schemas
+module ::Kitchen::Terraform::ConfigAttributeType::Integer
+  # This method applies the configuration attribute behaviour to a module.
+  #
+  # @param attribute [::Symbol] the symbol corresponding to the configuration attribute.
+  # @param config_attribute [::Module] a module.
+  # @param default_value [::Proc] a proc which returns the default value.
+  # @return [self]
+  def self.apply(attribute:, config_attribute:, default_value:)
+    ::Kitchen::Terraform::ConfigAttribute
+      .new(
+        attribute: attribute,
+        default_value: default_value,
+        schema:
+          ::Dry::Validation
+            .Schema do
+              required(:value).filled :int?
+            end
+      )
+      .apply config_attribute: config_attribute
+
+    self
+  end
+end

data/lib/kitchen/terraform/config_predicates/hash_of_symbols_and_strings.rb

@@ -23,6 +23,15 @@ require "kitchen/terraform/config_predicates"
 #
 # @see http://dry-rb.org/gems/dry-validation/custom-predicates/ DRY Logic Custom Predicates
 module ::Kitchen::Terraform::ConfigPredicates::HashOfSymbolsAndStrings
+  # A callback to configure an extending schema with this predicate.
+  #
+  # @param schema [::Dry::Validation::Schema] the schema to be configured.
+  # @return [self]
+  def self.extended(schema)
+    schema.predicates self
+    self
+  end
+
   include ::Dry::Logic::Predicates
 
   predicate :hash_of_symbols_and_strings? do |value|

data/lib/kitchen/terraform/configurable.rb

@@ -16,6 +16,7 @@
 
 require "kitchen"
 require "kitchen/terraform"
+require "kitchen/terraform/kitchen_instance"
 require "kitchen/terraform/version"
 
 # Refinements to Kitchen::Configurable.
@@ -24,33 +25,36 @@ require "kitchen/terraform/version"
 module ::Kitchen::Terraform::Configurable
   # A callback to define the plugin version which is invoked when this module is included in a plugin class.
   #
-  # @return [void]
+  # @return [self]
   def self.included(configurable_class)
-    configurable_class.plugin_version ::Kitchen::Terraform::VERSION
+    ::Kitchen::Terraform::Version
+      .new
+      .assign_plugin_version configurable_class: configurable_class
+
+    self
   end
 
   # Alternative implementation of Kitchen::Configurable#finalize_config! which validates the configuration before
   # attempting to expand paths.
   #
   # @note this method should be removed when Test Kitchen: Issue #1229 is solved.
-  # @param instance [::Kitchen::Instance] an associated instance.
+  # @param kitchen_instance [::Kitchen::Instance] an associated Test Kitchen instance.
   # @return [self] itself, for use in chaining.
   # @raise [::Kitchen::ClientError] if the instance is nil.
   # @see https://github.com/test-kitchen/test-kitchen/blob/v1.16.0/lib/kitchen/configurable.rb#L46
   #   Kitchen::Configurable#finalize_config!
   # @see https://github.com/test-kitchen/test-kitchen/issues/1229 Test Kitchen: Issue #1229
-  def finalize_config!(instance)
-    instance or
+  def finalize_config!(kitchen_instance)
+    kitchen_instance or
       raise(
         ::Kitchen::ClientError,
         "Instance must be provided to #{self}"
       )
 
-    @instance = instance
+    @instance = ::Kitchen::Terraform::KitchenInstance.new kitchen_instance: kitchen_instance
     validate_config!
     expand_paths!
     load_needed_dependencies!
-
     self
   end
 end

data/lib/kitchen/terraform/{config_schemas/integer.rb → deprecating.rb}

@@ -14,14 +14,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "dry-validation"
-require "kitchen/terraform/config_schemas"
+require "kitchen/terraform"
 
-# A validation schema for a configuration attribute which is an integer.
-#
-# @see http://dry-rb.org/gems/dry-validation/basics/working-with-schemas/ DRY Validation Working With Schemas
-::Kitchen::Terraform::ConfigSchemas::Integer =
-  ::Dry::Validation
-    .Schema do
-      required(:value).filled :int?
-    end
+# The namespace for objects with deprecating changes.
+module ::Kitchen::Terraform::Deprecating
+end

data/lib/kitchen/terraform/deprecating/kitchen_instance.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+# Copyright 2016 New Context Services, 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 "delegate"
+require "kitchen"
+require "kitchen/terraform/deprecating"
+
+# This class provides the deprecating change to the KitchenInstance.
+class ::Kitchen::Terraform::Deprecating::KitchenInstance < DelegateClass ::Kitchen::Instance
+  private
+
+  # Runs a given action block directly.
+  #
+  # If the desired action is one of +:create+, +:converge+, +:setup+, or +:destroy+, and there is more than one thread
+  # active, then a warning is issued about deprecating support for concurrency with the desired action.
+  #
+  # @api private
+  # @param action [::Symbol] the action to be performed
+  # @param state [::Hash] a mutable state hash for this instance
+  # @see ::Kitchen::Instance
+  # @yieldparam state [::Hash] a mutable state hash for this instance
+  def synchronize_or_call(action, state)
+    ::Thread
+      .list
+      .length
+      .>(1) and
+      issue_warning action: action
+
+    yield state
+  end
+
+  # @api private
+  def issue_warning(action:)
+    [
+      :create,
+      :converge,
+      :setup,
+      :destroy
+    ]
+      .grep action do |serial_action|
+        warn(
+          "DEPRECATING: #{to_str} is about to invoke #{driver.class}##{serial_action} with concurrency " \
+            "activated; this action will be forced to run serially in an upcoming major version of " \
+            "Kitchen-Terraform"
+        )
+      end
+  end
+end

data/lib/kitchen/terraform/kitchen_instance.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# Copyright 2016 New Context Services, 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 "kitchen/terraform"
+require "kitchen/terraform/breaking/kitchen_instance"
+require "kitchen/terraform/deprecating/kitchen_instance"
+require "kitchen/terraform/version"
+require "rubygems"
+
+# This module is a factory for KitchenInstances.
+#
+# KitchenInstances wrap ::Kitchen::Instance in order to provide a contextual deprecation warning for actions which will
+# no longer support concurrency.
+module ::Kitchen::Terraform::KitchenInstance
+  # Creates a new KitchenInstance.
+  #
+  # If the version satisfies the requirement of +~> 3.3+ then a breaking KitchenInstance is created.
+  #
+  # If the version satisfies the requirement of +>= 4+ then a breaking KitchenInstance is created.
+  #
+  # @param kitchen_instance [::Kitchen::Instance] the ::Kitchen::Instance which will act as the delegate.
+  # @param version [::Kitchen::Terraform::Version] the version to compare against the requirement.
+  # @return [::Kitchen::Terraform::Breaking::KitchenInstance, ::Kitchen::Terraform::Deprecating::KitchenInstance] the
+  #   new KitchenInstance.
+  def self.new(kitchen_instance:, version: ::Kitchen::Terraform::Version.new)
+    version
+      .if_satisfies requirement: ::Gem::Requirement.new("~> 3.3") do
+        return ::Kitchen::Terraform::Deprecating::KitchenInstance.new kitchen_instance
+      end
+
+    version
+      .if_satisfies requirement: ::Gem::Requirement.new(">= 4") do
+        return ::Kitchen::Terraform::Breaking::KitchenInstance.new kitchen_instance
+      end
+  end
+end

data/lib/kitchen/terraform/version.rb

@@ -14,7 +14,29 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require "rubygems"
 require "kitchen/terraform"
 
 # The version of the kitchen-terraform gem.
-::Kitchen::Terraform::VERSION = "3.3.0".freeze
+class ::Kitchen::Terraform::Version
+  def assign_specification_version(specification:)
+    specification.version = @version.to_s
+    self
+  end
+
+  def assign_plugin_version(configurable_class:)
+    configurable_class.plugin_version @version.to_s
+    self
+  end
+
+  def if_satisfies(requirement:)
+    yield if requirement.satisfied_by? @version
+    self
+  end
+
+  private
+
+  def initialize(version: "3.3.1")
+    @version = ::Gem::Version.new version
+  end
+end

data/lib/kitchen/verifier/terraform.rb

@@ -14,13 +14,19 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "kitchen/verifier"
+require "kitchen"
 require "kitchen/terraform/config_attribute/color"
 require "kitchen/terraform/config_attribute/groups"
 require "kitchen/terraform/configurable"
 require "kitchen/terraform/error"
 require "kitchen/verifier/inspec"
 
+# This namespace is defined by Kitchen.
+#
+# @see http://www.rubydoc.info/gems/test-kitchen/Kitchen/Verifier
+module ::Kitchen::Verifier
+end
+
 # The verifier utilizes the {https://www.inspec.io/ InSpec infrastructure testing framework} to verify the behaviour and
 # state of resources in the Terraform state.
 #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-terraform
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.3.1
 platform: ruby
 authors:
 - Aaron Lane
@@ -55,7 +55,7 @@ cert_chain:
   XjOfZudLs1zJ8ZNOuwj6KkGJ9J3XHd9hM95MtBEWlxAfYdCuW1+v7zCTfbieBEba
   UIyyldg4TuVcuRs8uKJyempT0hqx2DniseBWw3nvtgom3A==
   -----END CERTIFICATE-----
-date: 2018-03-22 00:00:00.000000000 Z
+date: 2018-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler-audit
@@ -71,20 +71,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.6.0
-- !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -309,6 +295,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
 - !ruby/object:Gem::Dependency
   name: travis
   requirement: !ruby/object:Gem::Requirement
@@ -416,11 +416,11 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
-- lib/kitchen/driver.rb
 - lib/kitchen/driver/terraform.rb
-- lib/kitchen/provisioner.rb
 - lib/kitchen/provisioner/terraform.rb
 - lib/kitchen/terraform.rb
+- lib/kitchen/terraform/breaking.rb
+- lib/kitchen/terraform/breaking/kitchen_instance.rb
 - lib/kitchen/terraform/client_version_verifier.rb
 - lib/kitchen/terraform/command.rb
 - lib/kitchen/terraform/command/output.rb
@@ -438,22 +438,25 @@ files:
 - lib/kitchen/terraform/config_attribute/variables.rb
 - lib/kitchen/terraform/config_attribute_cacher.rb
 - lib/kitchen/terraform/config_attribute_definer.rb
+- lib/kitchen/terraform/config_attribute_type.rb
+- lib/kitchen/terraform/config_attribute_type/hash_of_symbols_and_strings.rb
+- lib/kitchen/terraform/config_attribute_type/integer.rb
 - lib/kitchen/terraform/config_predicates.rb
 - lib/kitchen/terraform/config_predicates/hash_of_symbols_and_strings.rb
 - lib/kitchen/terraform/config_schemas.rb
 - lib/kitchen/terraform/config_schemas/array_of_strings.rb
 - lib/kitchen/terraform/config_schemas/boolean.rb
 - lib/kitchen/terraform/config_schemas/groups.rb
-- lib/kitchen/terraform/config_schemas/hash_of_symbols_and_strings.rb
-- lib/kitchen/terraform/config_schemas/integer.rb
 - lib/kitchen/terraform/config_schemas/optional_string.rb
 - lib/kitchen/terraform/config_schemas/string.rb
 - lib/kitchen/terraform/configurable.rb
+- lib/kitchen/terraform/deprecating.rb
+- lib/kitchen/terraform/deprecating/kitchen_instance.rb
 - lib/kitchen/terraform/error.rb
 - lib/kitchen/terraform/file_path_config_attribute_definer.rb
+- lib/kitchen/terraform/kitchen_instance.rb
 - lib/kitchen/terraform/shell_out.rb
 - lib/kitchen/terraform/version.rb
-- lib/kitchen/verifier.rb
 - lib/kitchen/verifier/terraform.rb
 - lib/kitchen/verifier/terraform/configure_inspec_runner_attributes.rb
 - lib/kitchen/verifier/terraform/configure_inspec_runner_backend.rb
@@ -467,7 +470,8 @@ homepage: https://github.com/newcontext-oss/kitchen-terraform
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message: 'DEPRECATING: the current version of Ruby is 2.2.7; this version
+  will not be supported in an upcoming major release of Kitchen-Terraform'
 rdoc_options: []
 require_paths:
 - lib

data/lib/kitchen/terraform/config_schemas/hash_of_symbols_and_strings.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright 2016 New Context Services, 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 "dry-validation"
-require "kitchen/terraform/config_predicates/hash_of_symbols_and_strings"
-require "kitchen/terraform/config_schemas"
-
-# A validation schema for a configuration attribute which is a hash including only symbol keys and string values.
-#
-# @see http://dry-rb.org/gems/dry-validation/basics/working-with-schemas/ DRY Validation Working With Schemas
-::Kitchen::Terraform::ConfigSchemas::HashOfSymbolsAndStrings =
-  ::Dry::Validation
-    .Schema do
-      configure do
-        predicates ::Kitchen::Terraform::ConfigPredicates::HashOfSymbolsAndStrings
-        extend ::Kitchen::Terraform::ConfigPredicates::HashOfSymbolsAndStrings
-      end
-      required(:value).value :hash_of_symbols_and_strings?
-    end