kitchen-terraform 5.1.1 → 5.6.0

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016 New Context Services, Inc.
+# Copyright 2016-2019 New Context, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016 New Context Services, Inc.
+# Copyright 2016-2019 New Context, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -39,6 +39,11 @@ module Kitchen
       # Example:: <code>client: terraform</code>
       module Client
         class << self
+          # .included is 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 [self]
           def included(plugin_class)
             ::Kitchen::Terraform::ConfigAttributeDefiner.new(
               attribute: self,
@@ -47,9 +52,11 @@ module Kitchen
             plugin_class.expand_path_for to_sym do |plugin|
               !::TTY::Which.exist? plugin[to_sym]
             end
+
+            self
           end
 
-          # @return [::Symbol] the symbol corresponding to this attribute.
+          # @return [Symbol] the symbol corresponding to this attribute.
           def to_sym
             :client
           end
@@ -57,7 +64,7 @@ module Kitchen
 
         extend ::Kitchen::Terraform::ConfigAttributeCacher
 
-        # @return [::String] </code>"terraform"</code>
+        # @return [String] </code>"terraform"</code>
         def config_client_default_value
           "terraform"
         end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016 New Context Services, Inc.
+# Copyright 2016-2019 New Context, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016 New Context Services, Inc.
+# Copyright 2016-2019 New Context, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016 New Context Services, Inc.
+# Copyright 2016-2019 New Context, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016 New Context Services, Inc.
+# Copyright 2016-2019 New Context, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016 New Context Services, Inc.
+# Copyright 2016-2019 New Context, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016 New Context Services, Inc.
+# Copyright 2016-2019 New Context, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016 New Context Services, Inc.
+# Copyright 2016-2019 New Context, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -36,7 +36,7 @@ module Kitchen
           # 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.
+          # @param plugin_class [Kitchen::Configurable] A plugin class.
           # @return [void]
           def included(plugin_class)
             ::Kitchen::Terraform::FilePathConfigAttributeDefiner.new(
@@ -45,7 +45,7 @@ module Kitchen
             ).define plugin_class: plugin_class
           end
 
-          # @return [::Symbol] the symbol corresponding to this attribute.
+          # @return [Symbol] the symbol corresponding to this attribute.
           def to_sym
             :plugin_directory
           end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016 New Context Services, Inc.
+# Copyright 2016-2019 New Context, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -33,7 +33,7 @@ module Kitchen
           # 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.
+          # @param plugin_class [Kitchen::Configurable] A plugin class.
           # @return [void]
           def included(plugin_class)
             ::Kitchen::Terraform::FilePathConfigAttributeDefiner.new(
@@ -42,7 +42,7 @@ module Kitchen
             ).define plugin_class: plugin_class
           end
 
-          # @return [::Symbol] the symbol corresponding to the attribute.
+          # @return [Symbol] the symbol corresponding to the attribute.
           def to_sym
             :root_module_directory
           end
@@ -50,7 +50,7 @@ module Kitchen
 
         extend ::Kitchen::Terraform::ConfigAttributeCacher
 
-        # @return [::String] the working directory of the Test Kitchen process.
+        # @return [String] the working directory of the Test Kitchen process.
         def config_root_module_directory_default_value
           "."
         end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016 New Context Services, Inc.
+# Copyright 2016-2019 New Context, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016 New Context Services, Inc.
+# Copyright 2016-2019 New Context, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -37,7 +37,7 @@ module Kitchen
           # 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.
+          # @param plugin_class [Kitchen::Configurable] A plugin class.
           # @return [void]
           def included(plugin_class)
             ::Kitchen::Terraform::FilePathConfigAttributeDefiner.new(
@@ -46,7 +46,7 @@ module Kitchen
             ).define plugin_class: plugin_class
           end
 
-          # @return [::Symbol] the symbol corresponding to this attribute.
+          # @return [Symbol] the symbol corresponding to this attribute.
           def to_sym
             :variable_files
           end
@@ -54,7 +54,7 @@ module Kitchen
 
         extend ::Kitchen::Terraform::ConfigAttributeCacher
 
-        # @return [::Array] an empty array.
+        # @return [Array] an empty array.
         def config_variable_files_default_value
           []
         end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016 New Context Services, Inc.
+# Copyright 2016-2019 New Context, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016 New Context Services, Inc.
+# Copyright 2016-2019 New Context, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -21,7 +21,7 @@ require "kitchen/terraform/config_schemas/boolean"
 module Kitchen
   module Terraform
     class ConfigAttribute
-      # This attribute toggles verification of support for the version of the Terraform client specified by the
+      # This attribute toggles strict or permissive verification of support for the version of the Terraform client specified by the
       # <code>client</code> attribute.
       #
       # Type:: {http://www.yaml.org/spec/1.2/spec.html#id2803629 Boolean}

data/lib/kitchen/terraform/config_attribute_cacher.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016 New Context Services, Inc.
+# Copyright 2016-2019 New Context, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -14,31 +14,33 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "kitchen/terraform"
+module Kitchen
+  module Terraform
+    # Behaviour to cache configuration attribute lookups.
+    module ConfigAttributeCacher
+      # A callback to define an attribute lookup cache which is invoked when this module is extended by a
+      # configuration attribute.
+      #
+      # @param configuration_attribute [::Kitchen::Terraform::ConfigAttribute] a configuration attribute.
+      # @return [void]
+      def self.extended(configuration_attribute)
+        configuration_attribute.define_cache
+      end
 
-# Behaviour to cache configuration attribute lookups.
-module ::Kitchen::Terraform::ConfigAttributeCacher
-  # A callback to define an attribute lookup cache which is invoked when this module is extended by a
-  # configuration attribute.
-  #
-  # @param configuration_attribute [::Kitchen::Terraform::ConfigAttribute] a configuration attribute.
-  # @return [void]
-  def self.extended(configuration_attribute)
-    configuration_attribute.define_cache
-  end
-
-  # Defines an instance method named "config_<attribute_name>" which caches the value of the configuration attribute
-  # lookup using an equivalently named instance variable.
-  #
-  # @param attribute_name [::Symbol] the name of the attribute
-  def define_cache(attribute_name: to_sym)
-    define_method "config_#{attribute_name}" do
-      instance_variable_defined? "@config_#{attribute_name}" and
-        instance_variable_get "@config_#{attribute_name}" or
-        instance_variable_set(
-          "@config_#{attribute_name}",
-          config.fetch(attribute_name)
-        )
+      # Defines an instance method named "config_<attribute_name>" which caches the value of the configuration attribute
+      # lookup using an equivalently named instance variable.
+      #
+      # @param attribute_name [Symbol] the name of the attribute
+      def define_cache(attribute_name: to_sym)
+        define_method "config_#{attribute_name}" do
+          instance_variable_defined? "@config_#{attribute_name}" and
+            instance_variable_get "@config_#{attribute_name}" or
+            instance_variable_set(
+              "@config_#{attribute_name}",
+              config.fetch(attribute_name)
+            )
+        end
+      end
     end
   end
 end

data/lib/kitchen/terraform/config_attribute_definer.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016 New Context Services, Inc.
+# Copyright 2016-2019 New Context, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -14,50 +14,44 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "kitchen/terraform"
-
-# Defines a configuration attribute on a plugin class.
-class ::Kitchen::Terraform::ConfigAttributeDefiner
-  # Defines the configuration attribute on a plugin class.
-  #
-  # @param plugin_class [::Kitchen::Configurable] a plugin class.
-  # @return [void]
-  def define(plugin_class:)
-    plugin_class.required_config @attribute do |_attribute, value, _plugin|
-      process(
-        messages: @schema
-          .call(value: value)
-          .messages,
-        plugin_class: plugin_class,
-      )
-    end
-    plugin_class.default_config @attribute do |plugin|
-      plugin.send "config_#{@attribute}_default_value"
-    end
-  end
+module Kitchen
+  module Terraform
+    # ConfigAttributeDefiner is the class of objects which define configuration attributes on a plugin class.
+    class ConfigAttributeDefiner
+      # #define defines a configuration attribute on a plugin class.
+      #
+      # @param plugin_class [Kitchen::Configurable] a plugin class.
+      # @return [self]
+      def define(plugin_class:)
+        plugin_class.required_config attribute do |_attribute, value, _plugin|
+          process messages: schema.call(value: value).messages, plugin_class: plugin_class
+        end
+        plugin_class.default_config attribute do |plugin|
+          plugin.send "config_#{attribute}_default_value"
+        end
 
-  private
+        self
+      end
 
-  # Initializes a definer.
-  #
-  # @api private
-  # @param attribute [::Kitchen::Terraform::ConfigAttribute] an attribute to be defined on a plugin class.
-  # @param schema [::Dry::Validation::Schema] a schema to use for validation of values of the attribute.
-  def initialize(attribute:, schema:)
-    @attribute = attribute.to_sym
-    @schema = schema
-  end
+      # #initialize prepares a new instance of the class.
+      #
+      # @param attribute [Kitchen::Terraform::ConfigAttribute] an attribute to be defined on a plugin class.
+      # @param schema [Dry::Validation::Schema] a schema to use for validation of values of the attribute.
+      # @return [Kitchen::Terraform::ConfigAttributeDefined]
+      def initialize(attribute:, schema:)
+        self.attribute = attribute.to_sym
+        self.schema = schema
+      end
 
-  # Processes the schema messages of the configuration attribute.
-  #
-  # @api private
-  # @param messages [::Array] messages generated by validating the schema against a value.
-  # @param plugin_class [::Kitchen::Configurable] a plugin class.
-  def process(messages:, plugin_class:)
-    messages.empty? or
-      raise(
-        ::Kitchen::UserError,
-        "#{plugin_class} configuration: #{@attribute} #{messages}"
-      )
+      private
+
+      attr_accessor :attribute, :schema
+
+      def process(messages:, plugin_class:)
+        return if messages.empty?
+
+        raise ::Kitchen::UserError, "#{plugin_class} configuration: #{attribute} #{messages}"
+      end
+    end
   end
 end

data/lib/kitchen/terraform/config_attribute_type.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016 New Context Services, Inc.
+# Copyright 2016-2019 New Context, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -14,8 +14,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "kitchen/terraform"
-
-# The namespace for configuration attribute types.
-module ::Kitchen::Terraform::ConfigAttributeType
+module Kitchen
+  module Terraform
+    # The namespace for configuration attribute types.
+    module ConfigAttributeType
+    end
+  end
 end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016 New Context Services, Inc.
+# Copyright 2016-2019 New Context, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -16,34 +16,39 @@
 
 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
+module Kitchen
+  module Terraform
+    module ConfigAttributeType
+      # 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 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
+          self
+        end
+      end
+    end
   end
 end