kitchen-terraform 1.0.2 → 2.0.0

data/lib/kitchen/terraform/client_version_verifier.rb

@@ -0,0 +1,57 @@
+# 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/monads"
+require "kitchen/terraform"
+require "rubygems"
+
+# Verifies that the output of the Terraform Client version subcommand indicates a supported version of Terraform.
+class ::Kitchen::Terraform::ClientVersionVerifier
+  include ::Dry::Monads::Either::Mixin
+
+  # Verifies output from the Terraform Client version subcommand against the support version.
+  #
+  # Supported:: Terraform version ~> 0.10.2.
+  #
+  # @param version_output [::String] the Terraform Client version subcommand output.
+  # @return [::Dry::Monads::Either] the result of the function.
+  def verify(version_output:)
+    Right(
+      ::Gem::Version
+        .new(
+          version_output
+            .slice(
+              /v(\d+\.\d+\.\d+)/,
+              1
+            )
+        )
+    ).bind do |version|
+      if requirement.satisfied_by? version
+        Right "Terraform version #{version} is supported"
+      else
+        Left "Terraform version #{version} is not supported; upgrade to Terraform version ~> 0.10.2"
+      end
+    end
+  end
+
+  private
+
+  attr_reader :requirement
+
+  def initialize
+    @requirement = ::Gem::Requirement.new "~> 0.10.2"
+  end
+end

data/lib/{terraform/debug_logger.rb → kitchen/terraform/config_attribute.rb}

@@ -14,21 +14,15 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "terraform"
+require "kitchen/terraform"
 
-# Wrapper for a logger to always use the debug level
-class ::Terraform::DebugLogger
-  def debug(message)
-    logger.debug message
+# The namespace for configuration attributes.
+#
+# @abstract It defines the interface for configuration attributes to implement.
+module ::Kitchen::Terraform::ConfigAttribute
+  def self.default_value(_plugin:)
   end
 
-  alias << debug
-
-  private
-
-  attr_accessor :logger
-
-  def initialize(logger:)
-    self.logger = logger
+  def self.to_sym
   end
 end

data/lib/kitchen/terraform/config_attribute/backend_configurations.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 +:backend_configurations+ configuration attribute is an optional hash of symobls and strings comprising Terraform
+# backend configuration arguments to complete a partial backend.
+#
+# @abstract It must be included by a plugin class in order to be used.
+# @see https://www.terraform.io/docs/backends/config.html#partial-configuration Terraform: Backend Configuration:
+#   Partial Configuration
+module ::Kitchen::Terraform::ConfigAttribute::BackendConfigurations
+  # 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 the attribute.
+  def self.to_sym
+    :backend_configurations
+  end
+
+  extend ::Kitchen::Terraform::ConfigAttributeCacher
+
+  # @return [::Hash] an empty hash.
+  def config_backend_configurations_default_value
+    {}
+  end
+end

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

@@ -0,0 +1,56 @@
+# 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/config_attribute"
+require "kitchen/terraform/config_attribute_cacher"
+require "kitchen/terraform/config_attribute_definer"
+require "kitchen/terraform/config_schemas/boolean"
+
+# The +:color+ configuration attribute is an optional boolean which toggles colored output from the Terraform Client
+# commands.
+#
+# @abstract It must be included by plugin class in order to be used.
+# @see ::Kitchen::Terraform::Client::Command
+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+.
+  # @see https://en.wikipedia.org/wiki/Terminal_emulator Terminal emulator
+  def config_color_default_value
+    ::Kitchen.tty?
+  end
+end

data/lib/kitchen/terraform/config_attribute/command_timeout.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/integer"
+
+# The +:command_timeout+ configuration attribute is an optional integer which represents the number of seconds to wait
+# for the Terraform Client commands to finish.
+#
+# @abstract It must be included by a plugin class in order to be used.
+# @see ::Kitchen::Terraform::Client::Command
+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 seconds.
+  def config_command_timeout_default_value
+    600
+  end
+end

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

@@ -0,0 +1,54 @@
+# 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 +:directory+ configuration attribute is an optional string which contains the path to the directory containing the
+# root Terraform module to be tested.
+#
+# @abstract It must be included by a plugin class in order to be used.
+# @see https://www.terraform.io/docs/commands/init.html#copy-a-source-module Terraform: Command: init: Copy a Source
+#   Module
+# @see https://en.wikipedia.org/wiki/Working_directory Working directory
+module ::Kitchen::Terraform::ConfigAttribute::Directory
+  # 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 the attribute.
+  def self.to_sym
+    :directory
+  end
+
+  extend ::Kitchen::Terraform::ConfigAttributeCacher
+
+  # @return [::String] the working directory of the Test Kitchen process.
+  def config_directory_default_value
+    "."
+  end
+end

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

@@ -0,0 +1,96 @@
+# 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/array_of_hashes_of_symbols_and_strings"
+
+# The +:groups+ configuration attribute is an optional array including hashes comprising properties to manage the
+# execution of InSpec profiles against different resources in the Terraform state.
+#
+# === Hash Keys
+#
+# ==== name
+#
+# A required string which contains the name of the group.
+#
+# ==== attributes
+#
+# An optional hash of symbols and strings which associates the names of InSpec profile attributes to the names of
+# Terraform outputs.
+#
+# The attributes will be associated with the values of the outputs when InSpec runs.
+#
+# ==== controls
+#
+# An optional array of strings which contain the names of controls to exclusively include from the InSpec profile of the
+# Test Kitchen suite.
+#
+# ==== hostnames
+#
+# An optional string which contains the name of a Terraform output.
+#
+# The output must be of type String or Array and must contain one or more hostnames that will be the targets of the
+# InSpec profile of the Test Kitchen suite.
+#
+# If this key is omitted then localhost will be the target of the profile.
+#
+# ==== port
+#
+# An optional integer which represents the port to use when connecting to the hosts of the group with Secure Shell
+# (SSH).
+#
+# If this key is omitted then the port of the Test Kitchen SSH Transport will be used.
+#
+# ==== username
+#
+# An optional string which contains the username to use when connecting to the hosts of the group with SSH.
+#
+# 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.
+# @see https://github.com/test-kitchen/test-kitchen/blob/master/lib/kitchen/transport/ssh.rb Test Kitchen: SSH Transport
+# @see https://www.inspec.io/docs/reference/dsl_inspec/ InSpec: Controls
+# @see https://www.inspec.io/docs/reference/profiles/ InSpec: Profiles
+# @see https://www.terraform.io/docs/configuration/outputs.html Terraform: Output Variables
+# @see https://www.terraform.io/docs/state/index.html Terraform: State
+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::ArrayOfHashesOfSymbolsAndStrings
+      )
+      .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
+end

data/lib/kitchen/terraform/config_attribute/lock_timeout.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/string"
+
+# The +:lock_timeout+ configuration attribute is an optional string which contains the duration to wait for a lock on
+# the Terraform state to be obtained.
+#
+# @abstract It must be included by a plugin class in order to be used.
+# @see https://www.terraform.io/docs/commands/apply.html#lock-timeout-0s Terraform: Command: apply: -lock-timeout
+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::String
+      )
+      .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 [::String] 0 seconds.
+  def config_lock_timeout_default_value
+    "0s"
+  end
+end