kitchen-terraform 6.0.0 → 7.0.0

data/lib/kitchen/terraform/driver/destroy.rb

@@ -15,7 +15,7 @@
 # limitations under the License.
 
 require "kitchen"
-require "kitchen/terraform/command_executor"
+require "kitchen/shell_out"
 require "kitchen/terraform/command/destroy"
 require "kitchen/terraform/command/init_factory"
 require "kitchen/terraform/command/version"
@@ -60,7 +60,7 @@ module Kitchen
       class Destroy
         # #call executes the action.
         #
-        # @raise [Kitchen::TransientFailure] if a command fails.
+        # @raise [Kitchen::StandardError] if a command fails.
         # @return [self]
         def call
           read_client_version
@@ -73,19 +73,16 @@ module Kitchen
         # #initialize prepares a new instance of the class.
         #
         # @param config [Hash] the configuration of the driver.
+        # @param connection [Kitchen::Terraform::Transport::Connection] a Terraform connection.
         # @param logger [Kitchen::Logger] a logger for logging messages.
         # @param version_requirement [Gem::VersionRequirement] the required version of the Terraform client.
         # @param workspace_name [String] the name of the Terraform workspace to select or to create.
         # @return [Kitchen::Terraform::Driver::Destroy]
-        def initialize(config:, logger:, version_requirement:, workspace_name:)
+        def initialize(config:, connection:, logger:, version_requirement:, workspace_name:)
           self.complete_config = config.to_hash.merge upgrade_during_init: false, workspace_name: workspace_name
+          self.connection = connection
           self.client_version = ::Gem::Version.new "0.0.0"
-          self.command_executor = ::Kitchen::Terraform::CommandExecutor.new(
-            client: complete_config.fetch(:client),
-            logger: logger,
-          )
           self.logger = logger
-          define_options
           self.workspace_name = workspace_name
           self.destroy = ::Kitchen::Terraform::Command::Destroy.new config: complete_config
           self.workspace_delete_test = ::Kitchen::Terraform::Command::WorkspaceDelete.new config: complete_config
@@ -106,13 +103,11 @@ module Kitchen
 
         attr_accessor(
           :client_version,
-          :command_executor,
           :complete_config,
-          :destroy_options,
+          :connection,
           :destroy,
           :init,
           :logger,
-          :options,
           :verify_version,
           :version,
           :workspace_delete_test,
@@ -124,32 +119,19 @@ module Kitchen
 
         def create_test_workspace
           logger.warn "Creating the #{workspace_name} Terraform workspace..."
-          command_executor.run command: workspace_new_test, options: options do |standard_output|
-          end
+          connection.execute workspace_new_test
           logger.warn "Finished creating the #{workspace_name} Terraform workspace."
         end
 
-        def define_options
-          self.options = {
-            cwd: complete_config.fetch(:root_module_directory),
-            timeout: complete_config.fetch(:command_timeout),
-          }
-          self.destroy_options = options.merge(
-            environment: { "LC_ALL" => nil, "TF_IN_AUTOMATION" => "true", "TF_WARN_OUTPUT_ERRORS" => "true" },
-          )
-        end
-
         def destroy_infrastructure
           logger.warn "Destroying the Terraform-managed infrastructure..."
-          command_executor.run command: destroy, options: destroy_options do |standard_output|
-          end
+          connection.execute destroy
           logger.warn "Finished destroying the Terraform-managed infrastructure."
         end
 
         def delete_test_workspace
           logger.warn "Deleting the #{workspace_name} Terraform workspace..."
-          command_executor.run command: workspace_delete_test, options: options do |standard_output|
-          end
+          connection.execute workspace_delete_test
           logger.warn "Finished deleting the #{workspace_name} Terraform workspace."
         end
 
@@ -163,36 +145,28 @@ module Kitchen
 
         def initialize_directory
           logger.warn "Initializing the Terraform working directory..."
-          command_executor.run(
-            command: ::Kitchen::Terraform::Command::InitFactory.new(version: client_version)
-              .build(config: complete_config),
-            options: options,
-          ) do |standard_output|
-          end
+          connection.execute ::Kitchen::Terraform::Command::InitFactory.new(version: client_version)
+                               .build(config: complete_config)
           logger.warn "Finished initializing the Terraform working directory."
         end
 
         def read_client_version
           logger.warn "Reading the Terraform client version..."
-          command_executor.run command: version, options: options do |standard_output|
-            self.client_version = ::Gem::Version.new standard_output.slice /Terraform v(\d+\.\d+\.\d+)/, 1
-          end
+          self.client_version = ::Gem::Version.new connection.execute(version).slice /Terraform v(\d+\.\d+\.\d+)/, 1
           logger.warn "Finished reading the Terraform client version."
         end
 
         def select_default_workspace
           logger.warn "Selecting the default Terraform workspace..."
-          command_executor.run command: workspace_select_default, options: options do |standard_output|
-          end
+          connection.execute workspace_select_default
           logger.warn "Finished selecting the default Terraform workspace."
         end
 
         def select_or_create_test_workspace
           logger.warn "Selecting the #{workspace_name} Terraform workspace..."
-          command_executor.run command: workspace_select_test, options: options do |standard_output|
-          end
+          connection.execute workspace_select_test
           logger.warn "Finished selecting the #{workspace_name} Terraform workspace."
-        rescue ::Kitchen::TransientFailure
+        rescue ::Kitchen::ShellOut::ShellCommandFailed
           create_test_workspace
         end
       end

data/lib/kitchen/terraform/outputs_reader.rb

@@ -26,38 +26,32 @@ module Kitchen
       # @raise [Kitchen::TransientFailure] if running the output command fails.
       # @yieldparam json_outputs [String] the output variables as a string of JSON.
       # @return [self]
-      def read(command:, options:)
-        run command: command, options: options do |json_outputs:|
-          yield json_outputs: json_outputs
+      def read(command:)
+        json_outputs = "{}"
+
+        begin
+          json_outputs = connection.execute command
+        rescue ::Kitchen::StandardError => error
+          no_outputs_defined.match ::Regexp.escape error.original.to_s or raise ::Kitchen::TransientFailure, error.message
         end
 
+        yield json_outputs: json_outputs
+
         self
       end
 
       # #initialize prepares a new instance of the class.
       #
-      # @param command_executor [Kitchen::Terraform::CommandExecutor] an executor to run the output command.
+      # @param connection [Kitchen::Terraform::Transport::Connection] a Terraform connection.
       # @return [Kitchen::Terraform::OutputsReader]
-      def initialize(command_executor:)
-        self.command_executor = command_executor
+      def initialize(connection:)
+        self.connection = connection
         self.no_outputs_defined = /no\\ outputs\\ defined/
       end
 
       private
 
-      attr_accessor :command_executor, :no_outputs_defined
-
-      def run(command:, options:)
-        command_executor.run command: command, options: options do |standard_output|
-          yield json_outputs: standard_output
-        end
-      rescue ::Kitchen::TransientFailure => error
-        if no_outputs_defined.match ::Regexp.escape error.original.to_s
-          yield json_outputs: "{}"
-        else
-          raise error
-        end
-      end
+      attr_accessor :connection, :no_outputs_defined
     end
   end
 end

data/lib/kitchen/terraform/provisioner/converge.rb

@@ -15,7 +15,6 @@
 # limitations under the License.
 
 require "kitchen"
-require "kitchen/terraform/command_executor"
 require "kitchen/terraform/command/apply"
 require "kitchen/terraform/command/get"
 require "kitchen/terraform/command/output"
@@ -78,26 +77,22 @@ module Kitchen
         # #initialize prepares a new instance of the class.
         #
         # @param config [Hash] the configuration of the driver.
+        # @param connection [Kitchen::Terraform::Transport::Connection] a Terraform connection.
+        # @param debug_connection [Kitchen::Terraform::Transport::Connection] a Terraform connection that logs at the
+        #        debug level.
         # @param logger [Kitchen::Logger] a logger for logging messages.
         # @param version_requirement [Gem::VersionRequirement] the required version of the Terraform client.
         # @param workspace_name [String] the name of the Terraform workspace to select or to create.
         # @return [Kitchen::Terraform::Driver::Converge]
-        def initialize(config:, logger:, version_requirement:, workspace_name:)
+        def initialize(config:, connection:, debug_connection:, logger:, version_requirement:, workspace_name:)
           self.complete_config = config.to_hash.merge workspace_name: workspace_name
-          client = complete_config.fetch :client
           self.client_version = ::Gem::Version.new "0.0.0"
-          self.command_executor = ::Kitchen::Terraform::CommandExecutor.new(
-            client: client,
-            logger: logger,
-          )
+          self.connection = connection
+          self.debug_connection = debug_connection
           self.logger = logger
-          self.options = {
-            cwd: complete_config.fetch(:root_module_directory),
-            timeout: complete_config.fetch(:command_timeout),
-          }
           self.workspace_name = workspace_name
           initialize_commands
-          initialize_outputs_handlers client: client, logger: logger
+          initialize_outputs_handlers
           self.variables = complete_config.fetch :variables
           self.variables_manager = ::Kitchen::Terraform::VariablesManager.new
           self.verify_version = ::Kitchen::Terraform::VerifyVersion.new(
@@ -110,13 +105,12 @@ module Kitchen
         private
 
         attr_accessor(
-          :apply,
           :client_version,
-          :command_executor,
           :complete_config,
+          :connection,
+          :debug_connection,
           :get,
           :logger,
-          :options,
           :output,
           :outputs_manager,
           :outputs_parser,
@@ -131,15 +125,13 @@ module Kitchen
 
         def build_infrastructure
           logger.warn "Building the infrastructure based on the Terraform configuration..."
-          command_executor.run command: apply, options: options do |standard_output|
-          end
+          connection.execute ::Kitchen::Terraform::Command::Apply.new config: complete_config
           logger.warn "Finished building the infrastructure based on the Terraform configuration."
         end
 
         def download_modules
           logger.warn "Downloading the modules needed for the Terraform configuration..."
-          command_executor.run command: get, options: options do |standard_output|
-          end
+          connection.execute get
           logger.warn "Finished downloading the modules needed for the Terraform configuration."
         end
 
@@ -151,22 +143,16 @@ module Kitchen
         end
 
         def initialize_commands
-          self.apply = ::Kitchen::Terraform::Command::Apply.new config: complete_config
           self.get = ::Kitchen::Terraform::Command::Get.new
           self.output = ::Kitchen::Terraform::Command::Output.new
           self.workspace_select = ::Kitchen::Terraform::Command::WorkspaceSelect.new config: complete_config
           self.version = ::Kitchen::Terraform::Command::Version.new
         end
 
-        def initialize_outputs_handlers(client:, logger:)
+        def initialize_outputs_handlers
           self.outputs_manager = ::Kitchen::Terraform::OutputsManager.new
           self.outputs_parser = ::Kitchen::Terraform::OutputsParser.new
-          self.outputs_reader = ::Kitchen::Terraform::OutputsReader.new(
-            command_executor: ::Kitchen::Terraform::CommandExecutor.new(
-              client: client,
-              logger: ::Kitchen::Terraform::DebugLogger.new(logger),
-            ),
-          )
+          self.outputs_reader = ::Kitchen::Terraform::OutputsReader.new connection: debug_connection
         end
 
         def parse_outputs(json_outputs:)
@@ -180,7 +166,7 @@ module Kitchen
 
         def read_and_parse_outputs(&block)
           logger.warn "Reading the output variables from the Terraform state..."
-          outputs_reader.read command: output, options: options do |json_outputs:|
+          outputs_reader.read command: output do |json_outputs:|
             logger.warn "Finished reading the output variables from the Terraform state."
 
             parse_outputs json_outputs: json_outputs, &block
@@ -189,9 +175,7 @@ module Kitchen
 
         def read_client_version
           logger.warn "Reading the Terraform client version..."
-          command_executor.run command: version, options: options do |standard_output|
-            self.client_version = ::Gem::Version.new standard_output.slice /Terraform v(\d+\.\d+\.\d+)/, 1
-          end
+          self.client_version = ::Gem::Version.new connection.execute(version).slice /Terraform v(\d+\.\d+\.\d+)/, 1
           logger.warn "Finished reading the Terraform client version."
         end
 
@@ -212,19 +196,14 @@ module Kitchen
 
         def select_workspace
           logger.warn "Selecting the #{workspace_name} Terraform workspace..."
-          command_executor.run command: workspace_select, options: options do |standard_output|
-          end
+          connection.execute workspace_select
           logger.warn "Finished selecting the #{workspace_name} Terraform workspace."
         end
 
         def validate_files
           logger.warn "Validating the Terraform configuration files..."
-          command_executor.run(
-            command: ::Kitchen::Terraform::Command::ValidateFactory.new(version: client_version)
-              .build(config: complete_config),
-            options: options,
-          ) do |standard_output|
-          end
+          connection.execute ::Kitchen::Terraform::Command::ValidateFactory.new(version: client_version)
+                               .build(config: complete_config)
           logger.warn "Finished validating the Terraform configuration files."
         end
       end

data/lib/kitchen/terraform/transport/connection.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+# Copyright 2016-2021 Copado NCS LLC
+#
+# 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/transport/exec"
+
+module Kitchen
+  module Terraform
+    module Transport
+      # Terraform commands are run by shelling out and using the
+      # {https://www.terraform.io/docs/commands/index.html command-line interface}.
+      #
+      # The shell out environment includes the 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}.
+      class Connection < ::Kitchen::Transport::Exec::Connection
+        # #execute executes a Terraform CLI command on the local host.
+        #
+        # @param command [String] the Terraform command to be executed locally.
+        # @return [String] the standard output of the command.
+        # @raise [Kitchen::Transport::TransportFailed] if the command does not exit successfully.
+        def execute(command)
+          super "#{client} #{command}"
+
+          stdout
+        end
+
+        # #run_command executes a command in a subshell on the local running system.
+        #
+        # @param command [String] the command to be executed locally.
+        # @param options [Hash] additional configuration of the command.
+        # @return [String] the standard output of the command.
+        # @raise [Kitchen::ShellOut::ShellCommandFailed] if the command fails.
+        # @raise [Kitchen::StandardError] for all other unexpected exceptions.
+        def run_command(command, options = {})
+          self.stdout = super command, options.merge(
+            cwd: root_module_directory,
+            environment: environment.merge("LC_ALL" => nil, "TF_IN_AUTOMATION" => "true"),
+            timeout: command_timeout,
+          )
+        end
+
+        private
+
+        attr_accessor :client, :command_timeout, :environment, :options, :root_module_directory, :stdout
+
+        # #init_options initializes incoming options for use by the object.
+        #
+        # @param options [Hash] configuration options.
+        # @return [void]
+        # @api private
+        def init_options(options)
+          super
+
+          self.client = options.delete :client
+          self.command_timeout = options.delete :command_timeout
+          self.environment = options.delete(:environment) || {}
+          self.root_module_directory = options.delete :root_module_directory
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/terraform/transport.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# Copyright 2016-2021 Copado NCS LLC
+#
+# 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.
+
+module Kitchen
+  module Terraform
+    # Transport is the namespace for transport strategies.
+    module Transport
+    end
+  end
+end

data/lib/kitchen/terraform/verifier.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# Copyright 2016-2021 Copado NCS LLC
+#
+# 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.
+
+module Kitchen
+  module Terraform
+    # Verifier is the namespace for verifier strategies.
+    module Verifier
+    end
+  end
+end

data/lib/kitchen/terraform/version.rb

@@ -71,7 +71,7 @@ module Kitchen
 
         # @api private
         def value
-          self.value = ::Gem::Version.new "6.0.0" if not @value
+          self.value = ::Gem::Version.new "7.0.0" if not @value
           @value
         end
 

data/lib/kitchen/transport/terraform.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+# Copyright 2016-2021 Copado NCS LLC
+#
+# 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/client"
+require "kitchen/terraform/config_attribute/command_timeout"
+require "kitchen/terraform/config_attribute/root_module_directory"
+require "kitchen/terraform/configurable"
+require "kitchen/terraform/transport/connection"
+require "kitchen/transport/exec"
+
+module Kitchen
+  # This namespace is defined by Kitchen.
+  #
+  # @see http://www.rubydoc.info/gems/test-kitchen/Kitchen/Transport
+  module Transport
+    # The Terraform transport is responsible for the integration with the
+    # {https://developer.hashicorp.com/terraform/cli/commands Terraform CLI}.
+    #
+    # === Configuration Attributes
+    #
+    # The configuration attributes of the transport control the behaviour of the Terraform commands that are run.
+    # Within the
+    # {http://kitchen.ci/docs/getting-started/kitchen-yml Test Kitchen configuration file}, these attributes must be
+    # declared in the +transport+ mapping along with the plugin name.
+    #
+    #   transport:
+    #     name: terraform
+    #     a_configuration_attribute: some value
+    #
+    # ==== client
+    #
+    # {include:Kitchen::Terraform::ConfigAttribute::Client}
+    #
+    # ==== command_timeout
+    #
+    # {include:Kitchen::Terraform::ConfigAttribute::CommandTimeout}
+    #
+    # ==== root_module_directory
+    #
+    # {include:Kitchen::Terraform::ConfigAttribute::RootModuleDirectory}
+    #
+    # === Ruby Interface
+    #
+    # This class implements the interface of Kitchen::Configurable which requires the following Reek suppressions:
+    # :reek:MissingSafeMethod { exclude: [ finalize_config! ] }
+    #
+    # @version 2
+    class Terraform < ::Kitchen::Transport::Exec
+      kitchen_transport_api_version 2
+
+      include ::Kitchen::Terraform::ConfigAttribute::Client
+
+      include ::Kitchen::Terraform::ConfigAttribute::CommandTimeout
+
+      include ::Kitchen::Terraform::ConfigAttribute::RootModuleDirectory
+
+      include ::Kitchen::Terraform::Configurable
+
+      # #connection creates a new Connection, configured by a merging of configuration
+      # and state data.
+      #
+      # @param state [Hash] mutable instance state.
+      # @return [Kitchen::Terraform::Transport::Connection] a connection for this transport.
+      # @raise [Kitchen::Transport::TransportFailed] if a connection could not be returned.
+      def connection(state, &block)
+        options = connection_options config.to_hash.merge state
+
+        ::Kitchen::Terraform::Transport::Connection.new options, &block
+      end
+
+      # doctor checks the system and configuration for common errors.
+      #
+      # @param _state [Hash] the mutable Kitchen instance state.
+      # @return [Boolean] +true+ if any errors are found; +false+ if no errors are found.
+      def doctor(_state)
+        errors = false
+
+        methods.each do |method|
+          next if !method.match? /doctor_config_.*/
+
+          error = send method
+          errors = errors || error
+        end
+
+        errors
+      end
+
+      # #finalize_config! invokes the super implementation and then initializes the strategies.
+      #
+      # @param instance [Kitchen::Instance] an associated instance.
+      # @raise [Kitchen::ClientError] if the instance is nil.
+      # @return [self]
+      def finalize_config!(instance)
+        super instance
+
+        self
+      end
+
+      # #initialize prepares a new instance of the class.
+      #
+      # @param config [Hash] the transport configuration.
+      # @return [Kitchen::Transport::Terraform]
+      def initialize(config = {})
+        super config
+      end
+
+      private
+
+      # #connection_options builds the hash of options needed by the Connection object on construction.
+      #
+      # @param data [Hash] merged configuration and mutable state data.
+      # @return [Hash] hash of connection options.
+      # @api private
+      def connection_options(data)
+        opts = super
+
+        opts.merge! data
+        opts.merge! logger: logger
+
+        opts
+      end
+    end
+  end
+end

data/lib/kitchen/verifier/terraform.rb

@@ -30,7 +30,7 @@ module Kitchen
   #
   # @see https://www.rubydoc.info/gems/test-kitchen/Kitchen/Verifier
   module Verifier
-    # The verifier utilizes the {https://www.inspec.io/ InSpec infrastructure testing framework} to verify the
+    # The Terraform verifier utilizes {https://community.chef.io/tools/chef-inspec InSpec} to verify the
     # behaviour and state of resources in the Terraform state.
     #
     # === Commands
@@ -118,9 +118,17 @@ module Kitchen
       #
       # @param _state [Hash] the mutable Kitchen instance state.
       # @return [Boolean] +true+ if any errors are found; +false+ if no errors are found.
-      # @see https://github.com/test-kitchen/test-kitchen/blob/v1.21.2/lib/kitchen/verifier/base.rb#L85-L91
       def doctor(_state)
-        false
+        errors = false
+
+        methods.each do |method|
+          next if !method.match? /doctor_config_.*/
+
+          error = send method
+          errors = errors || error
+        end
+
+        errors
       end
 
       # #initialize prepares a new instance of the class.