kitchen-terraform 5.8.0 → 6.0.0

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016-2019 New Context, Inc.
+# Copyright 2016-2021 Copado NCS LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -16,7 +16,7 @@
 
 require "kitchen/terraform/config_attribute"
 require "kitchen/terraform/config_attribute_cacher"
-require "kitchen/terraform/config_schemas/array_of_strings"
+require "kitchen/terraform/config_attribute_contract/array_of_strings"
 require "kitchen/terraform/file_path_config_attribute_definer"
 
 module Kitchen
@@ -42,7 +42,7 @@ module Kitchen
           def included(plugin_class)
             ::Kitchen::Terraform::FilePathConfigAttributeDefiner.new(
               attribute: self,
-              schema: ::Kitchen::Terraform::ConfigSchemas::ArrayOfStrings,
+              schema: ::Kitchen::Terraform::ConfigAttributeContract::ArrayOfStrings.new,
             ).define plugin_class: plugin_class
           end
 

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016-2019 New Context, Inc.
+# Copyright 2016-2021 Copado NCS LLC
 #
 # 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-2019 New Context, Inc.
+# Copyright 2016-2021 Copado NCS LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -16,7 +16,7 @@
 
 require "kitchen"
 require "kitchen/terraform/config_attribute"
-require "kitchen/terraform/config_schemas/boolean"
+require "kitchen/terraform/config_attribute_contract/boolean"
 
 module Kitchen
   module Terraform
@@ -34,7 +34,7 @@ module Kitchen
           default_value: lambda do
             true
           end,
-          schema: ::Kitchen::Terraform::ConfigSchemas::Boolean,
+          schema: ::Kitchen::Terraform::ConfigAttributeContract::Boolean.new,
         ).apply config_attribute: self
       end
     end

data/lib/kitchen/terraform/config_attribute_cacher.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016-2019 New Context, Inc.
+# Copyright 2016-2021 Copado NCS LLC
 #
 # 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_predicates.rb → config_attribute_contract.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016-2019 New Context, Inc.
+# Copyright 2016-2021 Copado NCS LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -16,8 +16,8 @@
 
 module Kitchen
   module Terraform
-    # The namespace for configuration attribute predicates.
-    module ConfigPredicates
+    # ConfigAttributeContract is the namespace for configuration attribute contracts.
+    module ConfigAttributeContract
     end
   end
 end

data/lib/kitchen/terraform/config_attribute_contract/array_of_strings.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# Copyright 2016-2021 Copado NCS LLC
+#
+# 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"
+
+module Kitchen
+  module Terraform
+    module ConfigAttributeContract
+      # ArrayOfStrings is the class of objects that provide a configuration attribute contract for an array of strings.
+      class ArrayOfStrings < ::Dry::Validation::Contract
+        schema do
+          required(:value).array :filled?, :str?
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/terraform/{config_schemas → config_attribute_contract}/boolean.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016-2019 New Context, Inc.
+# Copyright 2016-2021 Copado NCS LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -18,16 +18,12 @@ require "dry/validation"
 
 module Kitchen
   module Terraform
-    module ConfigSchemas
-      # A validation schema for a configuration attribute which is a boolean.
-      #
-      # @see http://dry-rb.org/gems/dry-validation/basics/working-with-schemas/ DRY Validation Working With Schemas
-      Boolean = ::Dry::Validation.Schema do
-        required(:value).filled :bool?
-      end.dup
-
-      Boolean.define_singleton_method :to_s do
-        "Kitchen::Terraform::ConfigSchemas::Boolean"
+    module ConfigAttributeContract
+      # Boolean is the class of objects that provide a configuration attribute contract for a boolean.
+      class Boolean < ::Dry::Validation::Contract
+        schema do
+          required(:value).filled :bool?
+        end
       end
     end
   end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# Copyright 2016-2021 Copado NCS LLC
+#
+# 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"
+
+module Kitchen
+  module Terraform
+    module ConfigAttributeContract
+      # HashOfSymbolsAndStrings is the class of objects that provide a configuration attribute contract for a hash
+      # including only symbol keys and string values.
+      class HashOfSymbolsAndStrings < ::Dry::Validation::Contract
+        schema do
+          required(:value).hash
+        end
+
+        rule :value do
+          value.each_pair do |symbol, string|
+            if ::Symbol != symbol.class
+              key.failure "the key of the key-value pair '#{symbol} => #{string}' must be a scalar"
+            elsif ::String != string.class
+              key.failure "the value of the key-value pair '#{symbol} => #{string}' must be a scalar"
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016-2019 New Context, Inc.
+# Copyright 2016-2021 Copado NCS LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -14,10 +14,17 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require "dry/validation"
+
 module Kitchen
   module Terraform
-    # The namespace for configuration attribute schemas.
-    module ConfigSchemas
+    module ConfigAttributeContract
+      # Integer is the class of objects that provide a configuration attribute contract for an integer.
+      class Integer < ::Dry::Validation::Contract
+        schema do
+          required(:value).value :int?
+        end
+      end
     end
   end
 end

data/lib/kitchen/terraform/config_attribute_contract/optional_string.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# Copyright 2016-2021 Copado NCS LLC
+#
+# 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"
+
+module Kitchen
+  module Terraform
+    module ConfigAttributeContract
+      # OptionalString is the class of objects that provide a configuration attribute contract for an optional string.
+      class OptionalString < ::Dry::Validation::Contract
+        schema do
+          required(:value).maybe :filled?, :str?
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/terraform/{config_schemas → config_attribute_contract}/string.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016-2019 New Context, Inc.
+# Copyright 2016-2021 Copado NCS LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -18,14 +18,12 @@ require "dry/validation"
 
 module Kitchen
   module Terraform
-    module ConfigSchemas
-      # Defines a validation schema for a string.
-      String = ::Dry::Validation.Schema do
-        required(:value).filled :str?
-      end.dup
-
-      String.define_singleton_method :to_s do
-        "Kitchen::Terraform::ConfigSchemas::String"
+    module ConfigAttributeContract
+      # String is the class of objects that provide a configuration attribute contract for a string.
+      class String < ::Dry::Validation::Contract
+        schema do
+          required(:value).filled :str?
+        end
       end
     end
   end

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

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+# Copyright 2016-2021 Copado NCS LLC
+#
+# 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"
+
+module Kitchen
+  module Terraform
+    module ConfigAttributeContract
+      # Systems is the class of objects that provide a configuration attribute contract for systems.
+      class Systems < ::Dry::Validation::Contract
+        schema do
+          required(:value).array(:hash) do
+            required(:name).filled :str?
+            required(:backend).filled :str?
+            optional(:attrs).array(:filled?, :str?)
+            optional(:attrs_outputs).filled :hash?
+            optional(:backend_cache).value :bool?
+            optional(:bastion_host).filled :str?
+            optional(:bastion_host_output).filled :str?
+            optional(:bastion_port).value :int?
+            optional(:bastion_user).filled :str?
+            optional(:controls).array(:filled?, :str?)
+            optional(:enable_password).filled :str?
+            optional(:hosts).array :filled?, :str?
+            optional(:hosts_output).filled :str?
+            optional(:key_files).array(:filled?, :str?)
+            optional(:password).filled :str?
+            optional(:path).filled :str?
+            optional(:port).value :int?
+            optional(:profile_locations).array :filled?, :str?
+            optional(:proxy_command).filled :str?
+            optional(:reporter).array(:filled?, :str?)
+            optional(:self_signed).value :bool?
+            optional(:shell).value :bool?
+            optional(:shell_command).filled :str?
+            optional(:shell_options).filled :str?
+            optional(:show_progress).value :bool?
+            optional(:ssl).value :bool?
+            optional(:sudo).value :bool?
+            optional(:sudo_command).filled :str?
+            optional(:sudo_options).filled :str?
+            optional(:sudo_password).filled :str?
+            optional(:user).filled :str?
+            optional(:vendor_cache).filled :str?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/terraform/config_attribute_definer.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016-2019 New Context, Inc.
+# Copyright 2016-2021 Copado NCS LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -24,7 +24,7 @@ module Kitchen
       # @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
+          process messages: schema.call(value: value).errors.to_h, plugin_class: plugin_class
         end
         plugin_class.default_config attribute do |plugin|
           plugin.send "config_#{attribute}_default_value"

data/lib/kitchen/terraform/config_attribute_type.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016-2019 New Context, Inc.
+# Copyright 2016-2021 Copado NCS LLC
 #
 # 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_type/hash_of_symbols_and_strings.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016-2019 New Context, Inc.
+# Copyright 2016-2021 Copado NCS LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -16,13 +16,13 @@
 
 require "dry/validation"
 require "kitchen/terraform/config_attribute"
-require "kitchen/terraform/config_predicates/hash_of_symbols_and_strings"
+require "kitchen/terraform/config_attribute_contract/hash_of_symbols_and_strings"
 
 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.
+      # 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
@@ -33,18 +33,11 @@ module Kitchen
         # @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
+          ::Kitchen::Terraform::ConfigAttribute.new(
+            attribute: attribute,
+            default_value: default_value,
+            schema: ::Kitchen::Terraform::ConfigAttributeContract::HashOfSymbolsAndStrings.new,
+          ).apply config_attribute: config_attribute
 
           self
         end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016-2019 New Context, Inc.
+# Copyright 2016-2021 Copado NCS LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -16,30 +16,34 @@
 
 require "dry/validation"
 require "kitchen/terraform/config_attribute"
+require "kitchen/terraform/config_attribute_contract/integer"
 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
+module Kitchen
+  module Terraform
+    module ConfigAttributeType
+      # 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 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: ::Kitchen::Terraform::ConfigAttributeContract::Integer.new,
+            ).apply config_attribute: config_attribute
 
-    self
+          self
+        end
+      end
+    end
   end
 end