kitchen-terraform 1.0.2 → 2.0.0

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

@@ -0,0 +1,53 @@
+# 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/config_attribute"
+require "kitchen/terraform/config_attribute_cacher"
+require "kitchen/terraform/config_attribute_definer"
+require "kitchen/terraform/config_schemas/integer"
+
+# The +:parallelism+ configuration attribute is an optional integer which represents the maximum number of concurrent
+# operations to allow while walking the resource graph for the Terraform Client apply command.
+#
+# @abstract It must be included by a plugin class in order to be used.
+# @see https://www.terraform.io/docs/commands/apply.html#parallelism-n Terraform: Command: apply: -parallelism
+# @see https://www.terraform.io/docs/internals/graph.html Terraform: Resource Graph
+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
+end

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

@@ -0,0 +1,55 @@
+# 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/config_attribute"
+require "kitchen/terraform/config_attribute_cacher"
+require "kitchen/terraform/config_schemas/optional_string"
+require "kitchen/terraform/file_path_config_attribute_definer"
+
+# The +:plugin_directory+ configuration attribute is an optional string which contains the path to the directory
+# containing customized Terraform provider plugins to install in place of the official Terraform provider plugins.
+#
+# @abstract It must be included by a plugin class in order to be used.
+# @see https://www.terraform.io/docs/commands/init.html#plugin-installation Terraform: Command: init: Plugin
+#   Installation
+module ::Kitchen::Terraform::ConfigAttribute::PluginDirectory
+  # 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::FilePathConfigAttributeDefiner
+      .new(
+        attribute: self,
+        schema: ::Kitchen::Terraform::ConfigSchemas::OptionalString
+      )
+      .define plugin_class: plugin_class
+  end
+
+  # @return [::Symbol] the symbol corresponding to this attribute.
+  def self.to_sym
+    :plugin_directory
+  end
+
+  extend ::Kitchen::Terraform::ConfigAttributeCacher
+
+  # There is no default value because any value will disable the normal Terraform plugin retrieval process.
+  #
+  # @return [nil]
+  def config_plugin_directory_default_value
+    nil
+  end
+end

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

@@ -0,0 +1,55 @@
+# 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/config_attribute"
+require "kitchen/terraform/config_attribute_cacher"
+require "kitchen/terraform/config_schemas/string"
+require "kitchen/terraform/file_path_config_attribute_definer"
+
+# The +:state+ configuration attribute is an optianl string which contains the path to the Terraform state file which
+# will be generated and managed.
+#
+# @abstract It must be included by a plugin class in order to be used.
+# @see https://www.terraform.io/docs/commands/apply.html#state-path Terraform: Command: apply: -state-path
+# @see https://www.terraform.io/docs/state/index.html Terraform: State
+module ::Kitchen::Terraform::ConfigAttribute::State
+  # 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::FilePathConfigAttributeDefiner
+      .new(
+        attribute: self,
+        schema: ::Kitchen::Terraform::ConfigSchemas::String
+      )
+      .define plugin_class: plugin_class
+  end
+
+  # @return [::Symbol] the symbol corresponding to this attribute.
+  def self.to_sym
+    :state
+  end
+
+  extend ::Kitchen::Terraform::ConfigAttributeCacher
+
+  # The path to a file under the kitchen-terraform suite directory.
+  #
+  # @return [::String] +".kitchen/kitchen-terraform/<suite_name>/terraform.tfstate"+.
+  def config_state_default_value
+    instance_pathname filename: "terraform.tfstate"
+  end
+end

data/lib/kitchen/terraform/config_attribute/variable_files.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 "kitchen/terraform/config_attribute"
+require "kitchen/terraform/config_attribute_cacher"
+require "kitchen/terraform/config_schemas/array_of_strings"
+require "kitchen/terraform/file_path_config_attribute_definer"
+
+# The +:variable_files+ configuration attribute is an optional array of string which represent file paths.
+#
+# @abstract It must be included by a plugin class in order to be used.
+# @see https://www.terraform.io/docs/commands/apply.html#var-file-foo Terraform: Command: apply: -var-file
+module ::Kitchen::Terraform::ConfigAttribute::VariableFiles
+  # 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::FilePathConfigAttributeDefiner
+      .new(
+        attribute: self,
+        schema: ::Kitchen::Terraform::ConfigSchemas::ArrayOfStrings
+      )
+      .define plugin_class: plugin_class
+  end
+
+  # @return [::Symbol] the symbol corresponding to this attribute.
+  def self.to_sym
+    :variable_files
+  end
+
+  extend ::Kitchen::Terraform::ConfigAttributeCacher
+
+  # @return [::Array] an empty array.
+  def config_variable_files_default_value
+    []
+  end
+end

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

@@ -0,0 +1,53 @@
+# 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/config_attribute"
+require "kitchen/terraform/config_attribute_cacher"
+require "kitchen/terraform/config_attribute_definer"
+require "kitchen/terraform/config_schemas/hash_of_symbols_and_strings"
+
+# The +:variables+ configuration attribute is an optional hash of symbols and strings comprising Terraform variables to
+# be overridden during the application of Terraform state changes.
+#
+# @abstract It must be included by a plugin class in order to be used.
+# @see https://www.terraform.io/docs/commands/apply.html#var-39-foo-bar-39- Terraform: Command: apply: -var
+# @see https://www.terraform.io/docs/configuration/variables.html Terraform: Variables
+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
+end

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

@@ -0,0 +1,52 @@
+# 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/config_attribute"
+require "kitchen/terraform/config_attribute_cacher"
+require "kitchen/terraform/config_attribute_definer"
+require "kitchen/terraform/config_schemas/boolean"
+
+# The +:verify_plugins+ configuration attribute is an optional boolean which toggles verification of Terraform plugins.
+#
+# @abstract It must be included by a plugin class in order to be used.
+# @see https://www.terraform.io/docs/commands/init.html#plugin-installation Terraform: Command: init: Plugin
+#   Installation
+module ::Kitchen::Terraform::ConfigAttribute::VerifyPlugins
+  # 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
+    :verify_plugins
+  end
+
+  extend ::Kitchen::Terraform::ConfigAttributeCacher
+
+  # @return [true]
+  def config_verify_plugins_default_value
+    true
+  end
+end

data/lib/kitchen/terraform/config_attribute_cacher.rb

@@ -0,0 +1,44 @@
+# 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"
+
+# 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)
+        )
+    end
+  end
+end

data/lib/kitchen/terraform/config_attribute_definer.rb

@@ -0,0 +1,66 @@
+# 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"
+
+# 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
+
+  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.to_sym
+    @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}"
+      )
+  end
+end

data/lib/kitchen/terraform/config_predicates.rb

@@ -0,0 +1,21 @@
+# 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"
+
+# The namespace for configuration attribute predicates.
+module ::Kitchen::Terraform::ConfigPredicates
+end