kitchen-terraform 3.3.0 → 3.3.1

data/lib/kitchen/terraform/config_attribute/color.rb

@@ -16,8 +16,6 @@
 
 require "kitchen"
 require "kitchen/terraform/config_attribute"
-require "kitchen/terraform/config_attribute_cacher"
-require "kitchen/terraform/config_attribute_definer"
 require "kitchen/terraform/config_schemas/boolean"
 
 # This attribute toggles colored output from systems invoked by the plugin.
@@ -30,38 +28,15 @@ require "kitchen/terraform/config_schemas/boolean"
 # Caveat:: This attribute does not toggle colored output from the Test Kitchen core, though it does use the same default
 #          logic. To toggle colored output from the core, the +--color+ and +--no-color+ command-line flags must be
 #          used.
-#
-# @abstract It must be included by plugin class in order to be used.
 module ::Kitchen::Terraform::ConfigAttribute::Color
-  # A callback to define the configuration attribute which is invoked when this module is included in a plugin class.
-  #
-  # @param plugin_class [::Kitchen::Configurable] A plugin class.
-  # @return [void]
-  def self.included(plugin_class)
-    ::Kitchen::Terraform::ConfigAttributeDefiner
-      .new(
-        attribute: self,
-        schema: ::Kitchen::Terraform::ConfigSchemas::Boolean
-      )
-      .define plugin_class: plugin_class
-  end
-
-  # @return [::Symbol] the symbol corresponding to the attribute.
-  def self.to_sym
-    :color
-  end
-
-  extend ::Kitchen::Terraform::ConfigAttributeCacher
-
-  # The default value depends on the presence of a terminal device associated with the Test Kitchen process.
-  #
-  # @return [Boolean] if a terminal device is associated then +true+; else +false+.
-  def config_color_default_value
-    ::Kitchen.tty?
-  end
-
-  # @return [::String] the toggle converted to a flag.
-  def config_color_flag
-    config_color and "" or "-no-color"
-  end
+  ::Kitchen::Terraform::ConfigAttribute
+    .new(
+      attribute: :color,
+      default_value:
+        lambda do
+          ::Kitchen.tty?
+        end,
+      schema: ::Kitchen::Terraform::ConfigSchemas::Boolean
+    )
+    .apply config_attribute: self
 end

data/lib/kitchen/terraform/config_attribute/command_timeout.rb

@@ -15,9 +15,7 @@
 # limitations under the License.
 
 require "kitchen/terraform/config_attribute"
-require "kitchen/terraform/config_attribute_cacher"
-require "kitchen/terraform/config_attribute_definer"
-require "kitchen/terraform/config_schemas/integer"
+require "kitchen/terraform/config_attribute_type/integer"
 
 # This attribute controls the number of seconds that the plugin will wait for Terraform commands to finish running.
 #
@@ -25,31 +23,14 @@ require "kitchen/terraform/config_schemas/integer"
 # Required:: False
 # Default:: +600+
 # Example:: <code>command_timeout: 1200</code>
-#
-# @abstract It must be included by a plugin class in order to be used.
 module ::Kitchen::Terraform::ConfigAttribute::CommandTimeout
-  # A callback to define the configuration attribute which is invoked when this module is included in a plugin class.
-  #
-  # @param plugin_class [::Kitchen::Configurable] A plugin class.
-  # @return [void]
-  def self.included(plugin_class)
-    ::Kitchen::Terraform::ConfigAttributeDefiner
-      .new(
-        attribute: self,
-        schema: ::Kitchen::Terraform::ConfigSchemas::Integer
-      )
-      .define plugin_class: plugin_class
-  end
-
-  # @return [::Symbol] the symbol corresponding to the attribute.
-  def self.to_sym
-    :command_timeout
-  end
-
-  extend ::Kitchen::Terraform::ConfigAttributeCacher
-
-  # @return [::Integer] 600.
-  def config_command_timeout_default_value
-    600
-  end
+  ::Kitchen::Terraform::ConfigAttributeType::Integer
+    .apply(
+      attribute: :command_timeout,
+      config_attribute: self,
+      default_value:
+        lambda do
+          600
+        end
+    )
 end

data/lib/kitchen/terraform/config_attribute/groups.rb

@@ -15,8 +15,6 @@
 # limitations under the License.
 
 require "kitchen/terraform/config_attribute"
-require "kitchen/terraform/config_attribute_cacher"
-require "kitchen/terraform/config_attribute_definer"
 require "kitchen/terraform/config_schemas/groups"
 
 # This attribute configures the execution of {https://www.inspec.io/docs/reference/profiles/ InSpec profiles} against
@@ -136,31 +134,15 @@ require "kitchen/terraform/config_schemas/groups"
 #         name: a_group_with_a_username
 #         username: tester
 # Caveat:: If this key is omitted then the username of the Test Kitcen SSH Transport will be used.
-#
-# @abstract It must be included by a plugin class in order to be used.
 module ::Kitchen::Terraform::ConfigAttribute::Groups
-  # A callback to define the configuration attribute which is invoked when this module is included in a plugin class.
-  #
-  # @param plugin_class [::Kitchen::Configurable] A plugin class.
-  # @return [void]
-  def self.included(plugin_class)
-    ::Kitchen::Terraform::ConfigAttributeDefiner
-      .new(
-        attribute: self,
-        schema: ::Kitchen::Terraform::ConfigSchemas::Groups
-      )
-      .define plugin_class: plugin_class
-  end
-
-  # @return [::Symbol] the symbol corresponding to the attribute.
-  def self.to_sym
-    :groups
-  end
-
-  extend ::Kitchen::Terraform::ConfigAttributeCacher
-
-  # @return [::Array] an empty array.
-  def config_groups_default_value
-    []
-  end
+  ::Kitchen::Terraform::ConfigAttribute
+    .new(
+      attribute: :groups,
+      default_value:
+        lambda do
+          []
+        end,
+      schema: ::Kitchen::Terraform::ConfigSchemas::Groups
+    )
+    .apply config_attribute: self
 end

data/lib/kitchen/terraform/config_attribute/lock.rb

@@ -16,8 +16,6 @@
 
 require "kitchen"
 require "kitchen/terraform/config_attribute"
-require "kitchen/terraform/config_attribute_cacher"
-require "kitchen/terraform/config_attribute_definer"
 require "kitchen/terraform/config_schemas/boolean"
 
 # This attribute toggles {https://www.terraform.io/docs/state/locking.html locking of the Terraform state file}.
@@ -26,36 +24,15 @@ require "kitchen/terraform/config_schemas/boolean"
 # Required:: False
 # Default:: +true+
 # Example:: <code>lock: false</code>
-#
-# @abstract It must be included by plugin class in order to be used.
 module ::Kitchen::Terraform::ConfigAttribute::Lock
-  # A callback to define the configuration attribute which is invoked when this module is included in a plugin class.
-  #
-  # @param plugin_class [::Kitchen::Configurable] A plugin class.
-  # @return [void]
-  def self.included(plugin_class)
-    ::Kitchen::Terraform::ConfigAttributeDefiner
-      .new(
-        attribute: self,
-        schema: ::Kitchen::Terraform::ConfigSchemas::Boolean
-      )
-      .define plugin_class: plugin_class
-  end
-
-  # @return [::Symbol] the symbol corresponding to the attribute.
-  def self.to_sym
-    :lock
-  end
-
-  extend ::Kitchen::Terraform::ConfigAttributeCacher
-
-  # @return [true]
-  def config_lock_default_value
-    true
-  end
-
-  # @return [::String] the toggle converted to a flag.
-  def config_lock_flag
-    "-lock=#{config_lock}"
-  end
+  ::Kitchen::Terraform::ConfigAttribute
+    .new(
+      attribute: :lock,
+      default_value:
+        lambda do
+          true
+        end,
+      schema: ::Kitchen::Terraform::ConfigSchemas::Boolean
+    )
+    .apply config_attribute: self
 end

data/lib/kitchen/terraform/config_attribute/lock_timeout.rb

@@ -15,9 +15,7 @@
 # limitations under the License.
 
 require "kitchen/terraform/config_attribute"
-require "kitchen/terraform/config_attribute_cacher"
-require "kitchen/terraform/config_attribute_definer"
-require "kitchen/terraform/config_schemas/integer"
+require "kitchen/terraform/config_attribute_type/integer"
 
 # This attribute controls the number of seconds that Terraform will wait for a lock on the state to be obtained during
 # {https://www.terraform.io/docs/state/locking.html operations related to state}.
@@ -26,36 +24,14 @@ require "kitchen/terraform/config_schemas/integer"
 # Required:: False
 # Default:: +0+
 # Example:: <code>lock_timeout: 10</code>
-#
-# @abstract It must be included by a plugin class in order to be used.
 module ::Kitchen::Terraform::ConfigAttribute::LockTimeout
-  # A callback to define the configuration attribute which is invoked when this module is included in a plugin class.
-  #
-  # @param plugin_class [::Kitchen::Configurable] A plugin class.
-  # @return [void]
-  def self.included(plugin_class)
-    ::Kitchen::Terraform::ConfigAttributeDefiner
-      .new(
-        attribute: self,
-        schema: ::Kitchen::Terraform::ConfigSchemas::Integer
-      )
-      .define plugin_class: plugin_class
-  end
-
-  # @return [::Symbol] the symbol corresponding to the attribute.
-  def self.to_sym
-    :lock_timeout
-  end
-
-  extend ::Kitchen::Terraform::ConfigAttributeCacher
-
-  # @return [::Integer] 0.
-  def config_lock_timeout_default_value
-    0
-  end
-
-  # @return [::String] the value converted to a flag.
-  def config_lock_timeout_flag
-    "-lock-timeout=#{config_lock_timeout}s"
-  end
+  ::Kitchen::Terraform::ConfigAttributeType::Integer
+    .apply(
+      attribute: :lock_timeout,
+      config_attribute: self,
+      default_value:
+        lambda do
+          0
+        end
+    )
 end

data/lib/kitchen/terraform/config_attribute/parallelism.rb

@@ -15,9 +15,7 @@
 # limitations under the License.
 
 require "kitchen/terraform/config_attribute"
-require "kitchen/terraform/config_attribute_cacher"
-require "kitchen/terraform/config_attribute_definer"
-require "kitchen/terraform/config_schemas/integer"
+require "kitchen/terraform/config_attribute_type/integer"
 
 # This attribute controls the number of concurrent operations to use while Terraform
 # {https://www.terraform.io/docs/internals/graph.html#walking-the-graph walks the resource graph}.
@@ -26,36 +24,14 @@ require "kitchen/terraform/config_schemas/integer"
 # Required:: False
 # Default:: +10+
 # Example:: <code>parallelism: 50</code>
-#
-# @abstract It must be included by a plugin class in order to be used.
 module ::Kitchen::Terraform::ConfigAttribute::Parallelism
-  # A callback to define the configuration attribute which is invoked when this module is included in a plugin class.
-  #
-  # @param plugin_class [::Kitchen::Configurable] A plugin class.
-  # @return [void]
-  def self.included(plugin_class)
-    ::Kitchen::Terraform::ConfigAttributeDefiner
-      .new(
-        attribute: self,
-        schema: ::Kitchen::Terraform::ConfigSchemas::Integer
-      )
-      .define plugin_class: plugin_class
-  end
-
-  # @return [::Symbol] the symbol corresponding to the attribute.
-  def self.to_sym
-    :parallelism
-  end
-
-  extend ::Kitchen::Terraform::ConfigAttributeCacher
-
-  # @return [::Integer] a maximum of 10 concurrent operations.
-  def config_parallelism_default_value
-    10
-  end
-
-  # @return [::String] the value converted to a flag.
-  def config_parallelism_flag
-    "-parallelism=#{config_parallelism}"
-  end
+  ::Kitchen::Terraform::ConfigAttributeType::Integer
+    .apply(
+      attribute: :parallelism,
+      config_attribute: self,
+      default_value:
+        lambda do
+          10
+        end
+    )
 end

data/lib/kitchen/terraform/config_attribute/plugin_directory.rb

@@ -54,9 +54,4 @@ module ::Kitchen::Terraform::ConfigAttribute::PluginDirectory
   def config_plugin_directory_default_value
     nil
   end
-
-  # @return [::String] the value converted to a flag.
-  def config_plugin_directory_flag
-    config_plugin_directory.nil? and "" or "-plugin-dir=#{config_plugin_directory}"
-  end
 end

data/lib/kitchen/terraform/config_attribute/variable_files.rb

@@ -56,13 +56,4 @@ module ::Kitchen::Terraform::ConfigAttribute::VariableFiles
   def config_variable_files_default_value
     []
   end
-
-  # @return [::String] the elements of the value converted to flags, joined by white space.
-  def config_variable_files_flags
-    config_variable_files
-      .map do |path|
-        "-var-file=#{path}"
-      end
-      .join " "
-  end
 end

data/lib/kitchen/terraform/config_attribute/variables.rb

@@ -15,9 +15,7 @@
 # limitations under the License.
 
 require "kitchen/terraform/config_attribute"
-require "kitchen/terraform/config_attribute_cacher"
-require "kitchen/terraform/config_attribute_definer"
-require "kitchen/terraform/config_schemas/hash_of_symbols_and_strings"
+require "kitchen/terraform/config_attribute_type/hash_of_symbols_and_strings"
 
 # This attribute comprises {https://www.terraform.io/docs/configuration/variables.html Terraform variables}.
 #
@@ -28,40 +26,14 @@ require "kitchen/terraform/config_schemas/hash_of_symbols_and_strings"
 #     variables:
 #       image: image-1234
 #       zone: zone-5
-#
-# @abstract It must be included by a plugin class in order to be used.
 module ::Kitchen::Terraform::ConfigAttribute::Variables
-  # A callback to define the configuration attribute which is invoked when this module is included in a plugin class.
-  #
-  # @param plugin_class [::Kitchen::Configurable] A plugin class.
-  # @return [void]
-  def self.included(plugin_class)
-    ::Kitchen::Terraform::ConfigAttributeDefiner
-      .new(
-        attribute: self,
-        schema: ::Kitchen::Terraform::ConfigSchemas::HashOfSymbolsAndStrings
-      )
-      .define plugin_class: plugin_class
-  end
-
-  # @return [::Symbol] the symbol corresponding to this attribute.
-  def self.to_sym
-    :variables
-  end
-
-  extend ::Kitchen::Terraform::ConfigAttributeCacher
-
-  # @return [::Hash] an empty hash.
-  def config_variables_default_value
-    {}
-  end
-
-  # @return [::String] the elements of the value converted to flags, joined by whitespace.
-  def config_variables_flags
-    config_variables
-      .map do |key, value|
-        "-var=\"#{key}=#{value}\""
-      end
-      .join " "
-  end
+  ::Kitchen::Terraform::ConfigAttributeType::HashOfSymbolsAndStrings
+    .apply(
+      attribute: :variables,
+      config_attribute: self,
+      default_value:
+        lambda do
+          {}
+        end
+    )
 end

data/lib/kitchen/{provisioner.rb → terraform/config_attribute_type.rb}

@@ -14,9 +14,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "kitchen"
+require "kitchen/terraform"
 
-# This is the namespace for Test Kitchen provisioner plugins. This namespace is already defined in Test Kitchen but YARD
-# requires it to be redefined here in order to include documenation from the Kitchen::Terraform namespace.
-module Kitchen::Provisioner
+# The namespace for configuration attribute types.
+module ::Kitchen::Terraform::ConfigAttributeType
 end

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

@@ -0,0 +1,51 @@
+# 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"
+require "kitchen/terraform/config_predicates/hash_of_symbols_and_strings"
+
+# This modules applies the behaviour of a configuration attribute of type hash of symbols and strings 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::HashOfSymbolsAndStrings
+  # 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
+              configure do
+                extend ::Kitchen::Terraform::ConfigPredicates::HashOfSymbolsAndStrings
+              end
+              required(:value).value :hash_of_symbols_and_strings?
+            end
+      )
+      .apply config_attribute: config_attribute
+
+    self
+  end
+end