kitchen-terraform 3.0.0 → 3.1.0

data/lib/kitchen/provisioner/terraform.rb

@@ -16,6 +16,7 @@
 
 require "kitchen/provisioner"
 require "kitchen/terraform/configurable"
+require "kitchen/terraform/error"
 
 # The provisioner utilizes the driver to apply changes to the Terraform state in order to reach the desired
 # configuration of the root module.
@@ -88,19 +89,17 @@ class ::Kitchen::Provisioner::Terraform < ::Kitchen::Provisioner::Base
   def call(state)
     instance
       .driver
-      .apply
-      .fmap do |output|
+      .apply do |output:|
         state
           .store(
             :kitchen_terraform_output,
             output
           )
       end
-      .or do |failure|
-        raise(
-          ::Kitchen::ActionFailed,
-          failure
-        )
-      end
+  rescue ::Kitchen::Terraform::Error => error
+    raise(
+      ::Kitchen::ActionFailed,
+      error.message
+    )
   end
 end

data/lib/kitchen/terraform/client_version_verifier.rb

@@ -14,43 +14,45 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "dry/monads"
 require "kitchen/terraform"
+require "kitchen/terraform/error"
 require "rubygems"
 
-# Verifies that the output of the Terraform Client version subcommand indicates a supported version of Terraform.
+# Verifies that the output of the Terraform version command indicates a supported version of Terraform.
+#
+# Supported:: Terraform version >= 0.10.2, < 0.12.0.
 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.
+  # Verifies output from the Terraform version command against the support version.
   #
   # @param version_output [::String] the Terraform Client version subcommand output.
-  # @return [::Dry::Monads::Either] the result of the function.
+  # @raise [::Kitchen::Terraform::Error] if the version is not supported.
+  # @return [::String] a confirmation that the version is supported.
   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 v#{version} is supported"
-      else
-        Left "Terraform v#{version} is not supported; install Terraform ~> v0.11.0"
+    ::Gem::Version
+      .new(
+        version_output
+          .slice(
+            /v(\d+\.\d+\.\d+)/,
+            1
+          )
+      )
+      .tap do |version|
+        requirement
+          .satisfied_by? version or
+          raise(
+            ::Kitchen::Terraform::Error,
+            "Terraform v#{version} is not supported; install Terraform ~> v0.11.0"
+          )
+
+        return "Terraform v#{version} is supported"
       end
-    end
   end
 
   private
 
   attr_reader :requirement
 
+  # @api private
   def initialize
     @requirement =
       ::Gem::Requirement

data/lib/kitchen/terraform/command.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 Terraform commands.
+module ::Kitchen::Terraform::Command
+end

data/lib/kitchen/terraform/command/output.rb

@@ -0,0 +1,71 @@
+# 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 "json"
+require "kitchen/terraform/command"
+require "kitchen/terraform/error"
+require "kitchen/terraform/shell_out"
+
+# Behaviour to run the `terraform output` command.
+module ::Kitchen::Terraform::Command::Output
+  # Runs the command with JSON foramtting.
+  #
+  # @param duration [::Integer] the maximum duration in seconds to run the command.
+  # @param logger [::Kitchen::Logger] a Test Kitchen logger to capture the output from running the command.
+  # @yieldparam output [::String] the standard output of the command parsed as JSON.
+  def self.run(duration:, logger:, &block)
+    run_shell_out(
+      duration: duration,
+      logger: logger,
+      &block
+    )
+  rescue ::JSON::ParserError => error
+    handle_json_parser error: error
+  rescue ::Kitchen::Terraform::Error => error
+    handle_kitchen_terraform(
+      error: error,
+      &block
+    )
+  end
+
+  private_class_method
+
+  # @api private
+  def self.handle_json_parser(error:)
+    raise(
+      ::Kitchen::Terraform::Error,
+      "Parsing Terraform output as JSON failed: #{error.message}"
+    )
+  end
+
+  # @api private
+  def self.handle_kitchen_terraform(error:)
+    /no\\ outputs\\ defined/.match ::Regexp.escape error.to_s or raise error
+    yield output: {}
+  end
+
+  # @api private
+  def self.run_shell_out(duration:, logger:)
+    ::Kitchen::Terraform::ShellOut
+      .run(
+        command: "output -json",
+        duration: duration,
+        logger: logger
+      ) do |standard_output:|
+        yield output: ::JSON.parse(standard_output)
+      end
+  end
+end

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

@@ -62,7 +62,7 @@ module ::Kitchen::Terraform::ConfigAttribute::BackendConfigurations
   def config_backend_configurations_flags
     config_backend_configurations
       .map do |key, value|
-        "-backend-config='#{key}=#{value}'"
+        "-backend-config=\"#{key}=#{value}\""
       end
       .join " "
   end

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

@@ -19,30 +19,25 @@ require "kitchen/terraform/config_attribute_cacher"
 require "kitchen/terraform/config_attribute_definer"
 require "kitchen/terraform/config_schemas/groups"
 
-# This attribute is an optional array including hashes comprising properties to manage the execution of
-# {https://www.inspec.io/docs/reference/profiles/ InSpec profiles} against different resources in the Terraform state.
+# This attribute configures the execution of {https://www.inspec.io/docs/reference/profiles/ InSpec profiles} against
+# different groups of resources in the Terraform state. Each group may be configured by using the proceeding attributes.
 #
 # Type:: {http://www.yaml.org/spec/1.2/spec.html#id2760193 Sequence of mappings}
 # Required:: False
-# Example::
-#   _
-#     groups:
-#       -
-#         name: a_group
 #
-# === Mapping Keys
-#
-# These keys must be declared in each of the mappings in the sequence.
-#
-# ==== name
+# ===== name
 #
 # This key contains the name of the group to be used for logging purposes.
 #
 # Type:: {http://www.yaml.org/spec/1.2/spec.html#id2760844 Scalar}
 # Required:: True
-# Example:: <code>name: a_group</code>
+# Example::
+#   _
+#     groups:
+#       -
+#         name: a_group
 #
-# ==== attributes
+# ===== attributes
 #
 # This key comprises associations of the names of
 # {https://www.inspec.io/docs/reference/profiles/#profile-attributes InSpec profile attributes} with the names of
@@ -53,61 +48,93 @@ require "kitchen/terraform/config_schemas/groups"
 # Required:: False
 # Example::
 #   _
-#     attributes:
-#       an_attribute: an_output
+#     groups:
+#       -
+#         name: a_group_with_overridden_attributes
+#         attributes:
+#           an_attribute: an_output
 # Caveat:: As all Terraform outputs are associated with equivalently named InSpec profile attributes by default, this
 #          key is only necessary to provide alternative attribute names.
 #
-# ==== controls
+# ===== controls
 #
 # This key comprises the names of {https://www.inspec.io/docs/reference/dsl_inspec/ InSpec controls} to exclusively
-# include from the InSpec profile of the Test Kitchen suite.
+# include from the InSpec profile of the associated Test Kitchen instance.
 #
 # Type:: {http://www.yaml.org/spec/1.2/spec.html#id2760118 Sequince of scalars}
 # Required:: False
 # Example::
 #   _
-#     controls:
-#       - first_control
-#       - third_control
+#     groups:
+#       -
+#         name: a_group_with_a_first_subset_of_controls
+#         controls:
+#           - control_one
+#           - control_three
+#       -
+#         name: a_group_with_a_second_subset_of_controls
+#         controls:
+#           - control_two
+#           - control_four
 #
-# ==== hostnames
+# ===== hostnames
 #
-# This key contains the name of a Terraform output.
+# This key contains the name of a Terraform output which provides one or more hostnames to be targeted by the InSpec
+# profile of the associated Test Kitchen instance.
 #
 # Type:: {http://www.yaml.org/spec/1.2/spec.html#id2760844 Scalar}
 # Required:: False
-# Example:: <code>hostnames: an_output</code>
-# Caveat:: 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.
+# Example::
+#   _
+#     groups:
+#       -
+#         name: a_group_with_hostnames
+#         hostnames: an_output
+# Caveat:: The output must be a string or an array of strings. If this key is omitted then +"localhost"+ will be the
+#          target of the profile. To connect to the hosts through a bastion host, a +ProxyCommand+ in the
+#          appropriate {https://linux.die.net/man/5/ssh_config SSH configuration file} must be configured on the system.
 #
-# ==== port
+# ===== port
 #
 # This key contains the port to use when connecting with {https://en.wikipedia.org/wiki/Secure_Shell Secure Shell (SSH)}
 # to the hosts of the group.
 #
 # Type:: {http://www.yaml.org/spec/1.2/spec.html#id2803828 Integer}
 # Required:: False
-# Example:: <code>port: 1234</code>
+# Example::
+#   _
+#     groups:
+#       -
+#         name: a_group_with_a_port
+#         port: 1234
 # Caveat:: If this key is omitted then the port of the Test Kitchen SSH transport will be used.
 #
-# ==== ssh_key
+# ===== ssh_key
 #
 # This key contains the path to a private SSH key to use when connecting with SSH to the hosts of the group.
 #
 # Type:: {http://www.yaml.org/spec/1.2/spec.html#id2760844 Scalar}
 # Required:: False
-# Example:: <code>ssh_key: /path/to/an/ssh/key</code>
+# Example::
+#   _
+#     groups:
+#       -
+#         name: a_group_with_an_ssh_key
+#         ssh_key: /path/to/an/ssh/key</
 # Caveat:: If this key is omitted then the private SSH key of the Test Kitchen SSH Transport will be used.
 #
-# ==== username
+# ===== username
 #
 # This key contains the username to use when connecting with SSH to the hosts of the group.
 #
 # Type:: {http://www.yaml.org/spec/1.2/spec.html#id2760844 Scalar}
 # Required:: False
-# Example:: <code>ssh_key: /path/to/an/ssh/key</code>
+# Example::
+#   _
+#     groups:
+#       -
+#         name: a_group_with_a_username
+#         username: tester
 # Caveat:: 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.

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

@@ -60,7 +60,7 @@ module ::Kitchen::Terraform::ConfigAttribute::Variables
   def config_variables_flags
     config_variables
       .map do |key, value|
-        "-var='#{key}=#{value}'"
+        "-var=\"#{key}=#{value}\""
       end
       .join " "
   end

data/lib/kitchen/terraform/error.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"
+
+# This class represents errors that occur while Kitchen-Terraform is executing.
+class ::Kitchen::Terraform::Error < ::StandardError
+end

data/lib/kitchen/terraform/shell_out.rb

@@ -14,9 +14,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "dry/monads"
-require "kitchen/terraform"
 require "kitchen/terraform"
+require "kitchen/terraform/error"
 require "mixlib/shellout"
 
 # Terraform commands are run by shelling out and using the
@@ -25,42 +24,62 @@ require "mixlib/shellout"
 # TF_IN_AUTOMATION environment variable as specified by the
 # {https://www.terraform.io/guides/running-terraform-in-automation.html#controlling-terraform-output-in-automation Running Terraform in Automation guide}.
 module ::Kitchen::Terraform::ShellOut
-  extend ::Dry::Monads::Either::Mixin
-  extend ::Dry::Monads::Try::Mixin
-
   # Runs a Terraform command.
   #
   # @param command [::String] the command to run.
   # @param duration [::Integer] the maximum duration in seconds to run the command.
   # @param logger [::Kitchen::Logger] a Test Kitchen logger to capture the output from running the command.
-  # @return [::Dry::Monads::Either] the result of running the command.
+  # @raise [::Kitchen::Terraform::Error] if running the command fails.
+  # @return [::String] the standard output from running the command.
   # @see https://rubygems.org/gems/mixlib-shellout mixlib-shellout
-  def self.run(command:, duration: ::Mixlib::ShellOut::DEFAULT_READ_TIMEOUT, logger:)
-    Try ::Mixlib::ShellOut::InvalidCommandOption do
-      ::Mixlib::ShellOut
-        .new(
-          "terraform #{command}",
-          environment: {"TF_IN_AUTOMATION" => "true"},
-          live_stream: logger,
-          timeout: duration
-        )
-    end
-      .bind do |shell_out|
-        Try(
-          ::Errno::EACCES,
-          ::Errno::ENOENT,
-          ::Mixlib::ShellOut::CommandTimeout,
-          ::Mixlib::ShellOut::ShellCommandFailed
-        ) do
-          logger.warn "Running command `#{shell_out.command}`"
-          shell_out.run_command
-          shell_out.error!
-          shell_out.stdout
-        end
-      end
-      .to_either
-      .or do |error|
-        Left "Running command resulted in failure: #{error}"
+  # @yieldparam standard_output [::String] the standard output from running the command.
+  def self.run(command:, duration: ::Mixlib::ShellOut::DEFAULT_READ_TIMEOUT, logger:, &block)
+    block ||=
+      lambda do |standard_output:|
+        standard_output
       end
+
+    run_shell_out(
+      command: command,
+      duration: duration,
+      logger: logger,
+      &block
+    )
+  rescue ::Errno::EACCES,
+         ::Errno::ENOENT,
+         ::Mixlib::ShellOut::InvalidCommandOption,
+         ::Mixlib::ShellOut::CommandTimeout,
+         ::Mixlib::ShellOut::ShellCommandFailed => error
+    handle error: error
+  end
+
+  private_class_method
+
+  # @api private
+  def self.handle(error:)
+    raise(
+      ::Kitchen::Terraform::Error,
+      "Running command resulted in failure: #{error.message}"
+    )
+  end
+
+  # @api private
+  def self.run_shell_out(command:, duration:, logger:)
+    yield(
+      standard_output:
+        ::Mixlib::ShellOut
+          .new(
+            "terraform #{command}",
+            environment: {"TF_IN_AUTOMATION" => "true"},
+            live_stream: logger,
+            timeout: duration
+          )
+          .tap do |shell_out|
+            logger.warn "Running command `#{shell_out.command}`"
+            shell_out.run_command
+            shell_out.error!
+          end
+          .stdout
+    )
   end
 end