kitchen-terraform 3.3.1 → 4.0.0

data/lib/kitchen/terraform/kitchen_instance.rb

@@ -1,49 +0,0 @@
-# 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/breaking/kitchen_instance"
-require "kitchen/terraform/deprecating/kitchen_instance"
-require "kitchen/terraform/version"
-require "rubygems"
-
-# This module is a factory for KitchenInstances.
-#
-# KitchenInstances wrap ::Kitchen::Instance in order to provide a contextual deprecation warning for actions which will
-# no longer support concurrency.
-module ::Kitchen::Terraform::KitchenInstance
-  # Creates a new KitchenInstance.
-  #
-  # If the version satisfies the requirement of +~> 3.3+ then a breaking KitchenInstance is created.
-  #
-  # If the version satisfies the requirement of +>= 4+ then a breaking KitchenInstance is created.
-  #
-  # @param kitchen_instance [::Kitchen::Instance] the ::Kitchen::Instance which will act as the delegate.
-  # @param version [::Kitchen::Terraform::Version] the version to compare against the requirement.
-  # @return [::Kitchen::Terraform::Breaking::KitchenInstance, ::Kitchen::Terraform::Deprecating::KitchenInstance] the
-  #   new KitchenInstance.
-  def self.new(kitchen_instance:, version: ::Kitchen::Terraform::Version.new)
-    version
-      .if_satisfies requirement: ::Gem::Requirement.new("~> 3.3") do
-        return ::Kitchen::Terraform::Deprecating::KitchenInstance.new kitchen_instance
-      end
-
-    version
-      .if_satisfies requirement: ::Gem::Requirement.new(">= 4") do
-        return ::Kitchen::Terraform::Breaking::KitchenInstance.new kitchen_instance
-      end
-  end
-end

data/lib/kitchen/verifier/terraform/configure_inspec_runner_attributes.rb

@@ -1,98 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright 2016-2017 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/error"
-require "kitchen/verifier/terraform"
-
-# Configures the InSpec profile attributes for the Inspec::Runner used by the verifier to verify a group.
-#
-# Three different maps are merged to create the profile attributes.
-#
-# The first map is comprised of attributes that are external to the Terraform state.
-#
-#   {
-#     "terraform_state" => "/path/to/terraform/state"
-#   }
-#
-# The second map is comprised of attributes that represent the Terraform output variables of the Terraform state. This
-# map takes precedence in any key conflicts with the first map.
-#
-#   {
-#     "first_output_variable_name" => "first_output_variable_value",
-#     "second_output_variable_name" => "second_output_variable_value"
-#   }
-#
-# The third map is comprised of attributes defined by a group's +:attributes+; the keys are converted to strings and the
-# values are assumed to be Terraform output variable names which are resolved. This map takes precedence in any key
-# conflicts with the second map.
-#
-#   {
-#     first_attribute_name: "second_output_variable_name"
-#   }
-#
-#   # becomes
-#
-#   {
-#     "first_attribute_name" => "second_output_variable_value"
-#   }
-#
-# @see https://github.com/chef/inspec/blob/master/lib/inspec/runner.rb Inspec::Runner
-# @see https://github.com/chef/kitchen-inspec/blob/master/lib/kitchen/verifier/inspec.rb kitchen-inspec verifier
-# @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::Verifier::Terraform::ConfigureInspecRunnerAttributes
-  # Invokes the function
-  #
-  # @param group [::Hash] a kitchen-terraform verifier group.
-  # @param output [::String] the output of the Terraform state.
-  # @raise [::Kitchen::Terraform::Error] if the configuration fails.
-  # @return [::Hash] the configured attributes.
-  def self.call(group:, output:)
-    group
-      .fetch(
-        :attributes,
-        {}
-      )
-      .tap do |group_attributes|
-        return(
-          output
-            .keys
-            .+(group_attributes.keys)
-            .zip(
-              output
-                .keys
-                .+(group_attributes.values)
-            )
-            .reduce ::Hash.new do |resolved_attributes, (attribute_name, output_name)|
-              resolved_attributes
-                .merge(
-                  attribute_name
-                    .to_s =>
-                      output
-                        .fetch(output_name.to_s)
-                        .fetch("value")
-                )
-            end
-        )
-      end
-  rescue ::KeyError => error
-    raise(
-      ::Kitchen::Terraform::Error,
-      "Configuring InSpec runner attributes resulted in failure: #{error.message}"
-    )
-  end
-end

data/lib/kitchen/verifier/terraform/configure_inspec_runner_backend.rb

@@ -1,32 +0,0 @@
-# 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/verifier/terraform"
-
-# Configures the backend for the Inspec::Runner used by the verifier to verify a group's host.
-#
-# If the hostname is "localhost" then the existing backend is overwritten to be "local".
-#
-# @see https://github.com/chef/inspec/blob/master/lib/inspec/runner.rb Inspec::Runner
-module ::Kitchen::Verifier::Terraform::ConfigureInspecRunnerBackend
-  # Invokes the function.
-  #
-  # @param hostname [::String] the hostname being verified.
-  # @param options [::Hash] the verifier's Inspec::Runner options.
-  def self.call(hostname:, options:)
-    hostname == "localhost" and options.store "backend", "local"
-  end
-end

data/lib/kitchen/verifier/terraform/configure_inspec_runner_controls.rb

@@ -1,41 +0,0 @@
-# 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/verifier/terraform"
-
-# Configures a group's InSpec profile controls to be inclued by the Inspec::Runner used by the verifier.
-#
-# If a group omits +:controls+ or if +:controls+ is empty then all of the profile's controls will be included.
-#
-# @see https://github.com/chef/inspec/blob/master/lib/inspec/runner.rb ::Inspec::Runner
-# @see https://www.inspec.io/docs/reference/profiles/ InSpec profiles
-module ::Kitchen::Verifier::Terraform::ConfigureInspecRunnerControls
-  # Invokes the function
-  #
-  # @param group [::Hash] the group being verified.
-  # @param options [:Hash] the verifier's Inspec::Runner's options.
-  def self.call(group:, options:)
-    group[:controls]
-      .tap do |controls|
-        controls and
-          options
-            .store(
-              :controls,
-              controls
-            )
-      end
-  end
-end

data/lib/kitchen/verifier/terraform/configure_inspec_runner_port.rb

@@ -1,40 +0,0 @@
-# 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/verifier/terraform"
-
-# Configures the port for the Inspec::Runner used by the verifier to verify a group.
-#
-# The default port is the transport's +:port+.
-#
-# @see https://github.com/chef/inspec/blob/master/lib/inspec/runner.rb Inspec::Runner
-module ::Kitchen::Verifier::Terraform::ConfigureInspecRunnerPort
-  # Invokes the function.
-  #
-  # @param group [::Hash] the group being verified.
-  # @param options [::Hash] the Inspec::Runner's options.
-  def self.call(group:, options:)
-    group[:port]
-      .tap do |port|
-        port and
-          options
-            .store(
-              "port",
-              port
-            )
-      end
-  end
-end

data/lib/kitchen/verifier/terraform/configure_inspec_runner_ssh_key.rb

@@ -1,41 +0,0 @@
-# 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/verifier/terraform"
-
-# Configures the private SSH key to be used by the verifier's InSpec Runner to verify a group.
-#
-# The default value is the Test Kitchen SSH Transport's +:ssh_key+ configuration attribute.
-#
-# @see https://github.com/chef/inspec/blob/master/lib/inspec/runner.rb InSpec Runner
-# @see https://github.com/test-kitchen/test-kitchen/blob/v1.16.0/lib/kitchen/transport/ssh.rb Test Kitchen SSH Transport
-module ::Kitchen::Verifier::Terraform::ConfigureInspecRunnerSSHKey
-  # Invoke the function.
-  #
-  # @param group [::Hash] the group being verified.
-  # @param options [::Hash] the Inspec::Runner's options.
-  def self.call(group:, options:)
-    group[:ssh_key]
-      .tap do |ssh_key|
-        ssh_key and
-          options
-            .store(
-              "key_files",
-              [ssh_key]
-            )
-      end
-  end
-end

data/lib/kitchen/verifier/terraform/configure_inspec_runner_user.rb

@@ -1,40 +0,0 @@
-# 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/verifier/terraform"
-
-# Configures the user for the Inspec::Runner used by the verifier to verify a group.
-#
-# The default user is the transport's +:username+.
-#
-# @see https://github.com/chef/inspec/blob/master/lib/inspec/runner.rb Inspec::Runner
-module ::Kitchen::Verifier::Terraform::ConfigureInspecRunnerUser
-  # Invoke the function.
-  #
-  # @param group [::Hash] the group being verified.
-  # @param options [::Hash] the Inspec::Runner's options.
-  def self.call(group:, options:)
-    group[:username]
-      .tap do |username|
-        username and
-          options
-            .store(
-              "user",
-              username
-            )
-      end
-  end
-end

data/lib/kitchen/verifier/terraform/enumerate_groups_and_hostnames.rb

@@ -1,82 +0,0 @@
-# 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/error"
-require "kitchen/verifier/terraform"
-
-# Enumerates each group and the hostnames of each group.
-#
-# If a group associates +:hostnames+ with a value then that value is assumed to be the name of a Terraform output
-# variable which has a value of a string or array containing one or more hostnames; those hostnames will be enumerated
-# with the group.
-#
-# If a group omits +:hostnames+ then the hostname +"localhost"+ will be enumerated with that group; this hostname will
-# cause the InSpec profile to be executed locally and enable verification of resources in the Terraform state without
-# the use of Secure Shell (SSH).
-#
-# @see https://en.wikipedia.org/wiki/Secure_Shell Secure Shell
-# @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::Verifier::Terraform::EnumerateGroupsAndHostnames
-  # Invokes the function.
-  #
-  # @param groups [::Array] a collection of groups.
-  # @raise [::Kitchen::Terraform::Error] if the enumeration fails.
-  # @return [void]
-  # @yieldparam group [::Hash] the group from which hostnamess are being enumerated.
-  # @yieldparam hostname [::String] a hostname from the group.
-  def self.call(groups:, output:, &block)
-    groups
-      .each do |group|
-        each_resolved_hostname_and_group(
-          group: group,
-          hostnames: group[:hostnames],
-          output: output,
-          &block
-        )
-      end
-  rescue ::KeyError => error
-    raise(
-      ::Kitchen::Terraform::Error,
-      "Enumeration of groups and hostnames resulted in failure due to the omission of the configured :hostnames " \
-        "output or an unexpected output structure: #{error.message}"
-    )
-  end
-
-  private_class_method
-
-  # @api private
-  def self.each_resolved_hostname_and_group(group:, hostnames:, output:)
-    if hostnames
-      Array(
-        output
-          .fetch(hostnames)
-          .fetch("value")
-      )
-        .each do |hostname|
-          yield(
-            group: group,
-            hostname: hostname
-          )
-        end
-    else
-      yield(
-        group: group,
-        hostname: "localhost"
-      )
-    end
-  end
-end