kitchen-terraform 1.0.2 → 2.0.0

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

@@ -0,0 +1,72 @@
+# 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/logic"
+require "kitchen/terraform/config_predicates"
+
+# Behaviour to provide a configuration attribute predicate for a hash including only symbol keys and string values.
+#
+# This module must be declared as providing predicates and extended in a schema's configuration in order to be used.
+#
+# @see http://dry-rb.org/gems/dry-validation/custom-predicates/ DRY Logic Custom Predicates
+module ::Kitchen::Terraform::ConfigPredicates::HashOfSymbolsAndStrings
+  include ::Dry::Logic::Predicates
+
+  predicate :hash_of_symbols_and_strings? do |value|
+    value.kind_of? ::Hash and
+      all_symbols? keys: value.keys and
+      all_strings? values: value.values
+  end
+
+  private_class_method
+
+  # If all keys are symbols then the result is +true+; else the result is +false+.
+  #
+  # @api private
+  # @param keys [::Enumerable] keys that must be only symbols
+  # @return [::TrueClass, ::FalseClass] the result
+  def self.all_symbols?(keys:)
+    keys
+      .all? do |key|
+        key.kind_of? ::Symbol
+      end
+  end
+
+  # If all values are strings then the result is +true+; else the result is +false+.
+  #
+  # @api private
+  # @param values [::Enumerable] values that must be only strings
+  # @return [::TrueClass, ::FalseClass] the result
+  def self.all_strings?(values:)
+    values
+      .all? do |value|
+        value.kind_of? ::String
+      end
+  end
+
+  private
+
+  def messages
+    super
+      .merge(
+        en: {
+          errors: {
+            hash_of_symbols_and_strings?: "must be a hash which includes only symbol keys and string values"
+          }
+        }
+      )
+  end
+end

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

@@ -14,6 +14,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# Namespace for kitchen-terraform
-module Terraform
+require "kitchen/terraform"
+
+# The namespace for configuration attribute schemas.
+module ::Kitchen::Terraform::ConfigSchemas
 end

data/lib/kitchen/terraform/config_schemas/array_of_hashes_of_symbols_and_strings.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_predicates/hash_of_symbols_and_strings"
+require "kitchen/terraform/config_schemas"
+
+# A validation schema for a configuration attribute which is an array of hashes 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::ArrayOfHashesOfSymbolsAndStrings =
+  ::Dry::Validation
+    .Schema do
+      configure do
+        predicates ::Kitchen::Terraform::ConfigPredicates::HashOfSymbolsAndStrings
+        extend ::Kitchen::Terraform::ConfigPredicates::HashOfSymbolsAndStrings
+      end
+      required(:value)
+        .each do
+          schema do
+            required(:name).filled :str?
+            optional(:attributes).value :hash_of_symbols_and_strings?
+            optional(:controls)
+              .each(
+                :filled?,
+                :str?
+              )
+            optional(:hostnames).value :str?
+            optional(:port).value :int?
+            optional(:username).value :str?
+          end
+        end
+    end

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

@@ -0,0 +1,31 @@
+# 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_schemas"
+
+# A validation schema for a configuration attribute which is an array including only strings.
+#
+# @see http://dry-rb.org/gems/dry-validation/basics/working-with-schemas/ DRY Validation Working With Schemas
+::Kitchen::Terraform::ConfigSchemas::ArrayOfStrings =
+  ::Dry::Validation
+    .Schema do
+      required(:value)
+        .each(
+          :filled?,
+          :str?
+        )
+    end

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

@@ -0,0 +1,27 @@
+# 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_schemas"
+
+# 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
+::Kitchen::Terraform::ConfigSchemas::Boolean =
+  ::Dry::Validation
+    .Schema do
+      required(:value).filled :bool?
+    end

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

@@ -0,0 +1,32 @@
+# 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

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

@@ -0,0 +1,27 @@
+# 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_schemas"
+
+# 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

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

@@ -0,0 +1,31 @@
+# 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_schemas"
+
+# A validation schema for a configuration attribute which is an optional string.
+#
+# @see http://dry-rb.org/gems/dry-validation/basics/working-with-schemas/ DRY Validation Working With Schemas
+::Kitchen::Terraform::ConfigSchemas::OptionalString =
+  ::Dry::Validation
+    .Schema do
+      required(:value)
+        .maybe(
+          :str?,
+          :filled?
+        )
+    end

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

@@ -0,0 +1,26 @@
+# 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_schemas"
+
+# Defines a validation schema for a string.
+
+::Kitchen::Terraform::ConfigSchemas::String =
+  ::Dry::Validation
+    .Schema do
+      required(:value).filled :str?
+    end

data/lib/kitchen/terraform/configurable.rb

@@ -0,0 +1,75 @@
+# 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"
+require "kitchen/terraform"
+require "kitchen/terraform/version"
+
+# Refinements to Kitchen::Configurable.
+#
+# @see https://github.com/test-kitchen/test-kitchen/blob/v1.16.0/lib/kitchen/configurable.rb Kitchen::Configurable
+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]
+  def self.included(configurable_class)
+    configurable_class.plugin_version ::Kitchen::Terraform::VERSION
+  end
+
+  # @return [::Kitchen::Driver::Terraform] the driver which will manage the lifecycle actions of the instance.
+  def driver
+    instance.driver
+  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.
+  # @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
+      raise(
+        ::Kitchen::ClientError,
+        "Instance must be provided to #{self}"
+      )
+
+    @instance = instance
+    validate_config!
+    expand_paths!
+    load_needed_dependencies!
+
+    self
+  end
+
+  # Constructs a pathname under the Test Kitchen instance directory.
+  #
+  # @return [::String] +"<kitchen-root>/.kitchen/kitchen-terraform/<suite-platform>/<filename>"+.
+  def instance_pathname(filename:)
+    ::File
+      .join(
+        config.fetch(:kitchen_root),
+        ".kitchen",
+        "kitchen-terraform",
+        instance.name,
+        filename
+      )
+  end
+end

data/lib/kitchen/terraform/file_path_config_attribute_definer.rb

@@ -0,0 +1,48 @@
+# 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/config_attribute_definer"
+
+# Defines a file path configuration attribute on a plugin class.
+class ::Kitchen::Terraform::FilePathConfigAttributeDefiner
+  # Defines the file path configuration attribute on a plugin class.
+  #
+  # @param plugin_class [::Kitchen::ConfigAttributeVerifier] A plugin class which has configuration
+  #   attribute verification behaviour.
+  # @return [void]
+  def define(plugin_class:)
+    @definer.define plugin_class: plugin_class
+    plugin_class.expand_path_for @attribute.to_sym
+  end
+
+  private
+
+  # 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
+    @definer =
+      ::Kitchen::Terraform::ConfigAttributeDefiner
+        .new(
+          attribute: attribute,
+          schema: schema
+        )
+  end
+end

data/lib/{terraform/project_version.rb → kitchen/terraform/version.rb}

@@ -14,6 +14,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-module Terraform
-  PROJECT_VERSION = "1.0.2".freeze
-end
+require "kitchen/terraform"
+
+::Kitchen::Terraform::VERSION = "2.0.0".freeze