kitchen-terraform 5.6.0 → 6.0.0

data/lib/kitchen/terraform/outputs_reader.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016-2019 New Context, Inc.
+# 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.
@@ -48,7 +48,7 @@ module Kitchen
       attr_accessor :command_executor, :no_outputs_defined
 
       def run(command:, options:)
-        command_executor.run command: command, options: options do |standard_output:|
+        command_executor.run command: command, options: options do |standard_output|
           yield json_outputs: standard_output
         end
       rescue ::Kitchen::TransientFailure => error

data/lib/kitchen/terraform/provisioner.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016-2019 New Context, Inc.
+# 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.

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016-2019 New Context, Inc.
+# 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.
@@ -19,7 +19,7 @@ require "kitchen/terraform/command_executor"
 require "kitchen/terraform/command/apply"
 require "kitchen/terraform/command/get"
 require "kitchen/terraform/command/output"
-require "kitchen/terraform/command/validate"
+require "kitchen/terraform/command/validate_factory"
 require "kitchen/terraform/command/workspace_select"
 require "kitchen/terraform/debug_logger"
 require "kitchen/terraform/outputs_manager"
@@ -28,6 +28,7 @@ require "kitchen/terraform/outputs_reader"
 require "kitchen/terraform/variables_manager"
 require "kitchen/terraform/verify_version"
 require "kitchen/terraform/version"
+require "rubygems"
 
 module Kitchen
   module Terraform
@@ -44,7 +45,13 @@ module Kitchen
       #
       # ===== Validating the Terraform Root Module
       #
-      # {include:Kitchen::Terraform::Command::Validate}
+      # ====== Terraform >= 0.15.0
+      #
+      # {include:Kitchen::Terraform::Command::Validate::PostZeroFifteenZero}
+      #
+      # ====== Terraform < 0.15.0
+      #
+      # {include:Kitchen::Terraform::Command::Validate::PreZeroFifteenZero}
       #
       # ===== Applying the Terraform State Changes
       #
@@ -60,7 +67,8 @@ module Kitchen
         # @raise [Kitchen::TransientFailure] if a command fails.
         # @return [self]
         def call(state:)
-          verify_version.call command: version, options: options
+          read_client_version
+          verify_version.call version: client_version
           execute_workflow
           save_variables_and_outputs state: state
 
@@ -75,63 +83,62 @@ module Kitchen
         # @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:)
-          client = config.fetch :client
-          hash_config = config.to_hash.merge workspace_name: 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.logger = logger
-          self.options = { cwd: config.fetch(:root_module_directory), timeout: config.fetch(:command_timeout) }
+          self.options = {
+            cwd: complete_config.fetch(:root_module_directory),
+            timeout: complete_config.fetch(:command_timeout),
+          }
           self.workspace_name = workspace_name
-          self.apply = ::Kitchen::Terraform::Command::Apply.new config: config
-          self.get = ::Kitchen::Terraform::Command::Get.new
-          self.output = ::Kitchen::Terraform::Command::Output.new
+          initialize_commands
           initialize_outputs_handlers client: client, logger: logger
-          self.validate = ::Kitchen::Terraform::Command::Validate.new config: config
-          self.workspace_select = ::Kitchen::Terraform::Command::WorkspaceSelect.new config: hash_config
-          self.variables = config.fetch :variables
+          self.variables = complete_config.fetch :variables
           self.variables_manager = ::Kitchen::Terraform::VariablesManager.new
           self.verify_version = ::Kitchen::Terraform::VerifyVersion.new(
-            command_executor: command_executor,
-            config: config,
+            config: complete_config,
             logger: logger,
             version_requirement: version_requirement,
           )
-          self.version = ::Kitchen::Terraform::Command::Version.new
         end
 
         private
 
         attr_accessor(
-          :command_executor,
           :apply,
+          :client_version,
+          :command_executor,
+          :complete_config,
           :get,
-          :output,
-          :validate,
-          :workspace_select,
           :logger,
           :options,
+          :output,
           :outputs_manager,
           :outputs_parser,
           :outputs_reader,
-          :variables,
           :variables_manager,
+          :variables,
           :verify_version,
           :version,
           :workspace_name,
+          :workspace_select,
         )
 
         def build_infrastructure
           logger.warn "Building the infrastructure based on the Terraform configuration..."
-          command_executor.run command: apply, options: options do |standard_output:|
+          command_executor.run command: apply, options: options do |standard_output|
           end
           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:|
+          command_executor.run command: get, options: options do |standard_output|
           end
           logger.warn "Finished downloading the modules needed for the Terraform configuration."
         end
@@ -143,6 +150,14 @@ module Kitchen
           build_infrastructure
         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:)
           self.outputs_manager = ::Kitchen::Terraform::OutputsManager.new
           self.outputs_parser = ::Kitchen::Terraform::OutputsParser.new
@@ -172,6 +187,14 @@ module Kitchen
           end
         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
+          logger.warn "Finished reading the Terraform client version."
+        end
+
         def save_outputs(parsed_outputs:, state:)
           logger.warn "Writing the output variables to the Kitchen instance state..."
           outputs_manager.save outputs: parsed_outputs, state: state
@@ -189,14 +212,18 @@ module Kitchen
 
         def select_workspace
           logger.warn "Selecting the #{workspace_name} Terraform workspace..."
-          command_executor.run command: workspace_select, options: options do |standard_output:|
+          command_executor.run command: workspace_select, options: options do |standard_output|
           end
           logger.warn "Finished selecting the #{workspace_name} Terraform workspace."
         end
 
         def validate_files
           logger.warn "Validating the Terraform configuration files..."
-          command_executor.run command: validate, options: options do |standard_output:|
+          command_executor.run(
+            command: ::Kitchen::Terraform::Command::ValidateFactory.new(version: client_version)
+              .build(config: complete_config),
+            options: options,
+          ) do |standard_output|
           end
           logger.warn "Finished validating the Terraform configuration files."
         end

data/lib/kitchen/terraform/raise.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016-2019 New Context, Inc.
+# 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.

data/lib/kitchen/terraform/raise/action_failed.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016-2019 New Context, Inc.
+# 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.

data/lib/kitchen/terraform/raise/client_error.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016-2019 New Context, Inc.
+# 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.

data/lib/kitchen/terraform/shell_out.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016-2019 New Context, Inc.
+# 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.
@@ -29,16 +29,17 @@ module Kitchen
       #
       # @param command [String] the command to run.
       # @param logger [Kitchen::Logger] a logger for logging messages.
+      # @param options [Hash] options which adjust the execution of the command.
       # @return [Kitchen::Terraform::CommandExecutor]
       def initialize(command:, logger:, options:)
         self.command = command
         self.logger = logger
         self.shell_out = ::Mixlib::ShellOut.new(
           command,
-          options.merge(
-            environment: { "LC_ALL" => nil, "TF_IN_AUTOMATION" => "true", "TF_WARN_OUTPUT_ERRORS" => "1" },
+          {
+            environment: { "LC_ALL" => nil, "TF_IN_AUTOMATION" => "true" },
             live_stream: logger,
-          )
+          }.merge(options)
         )
       end
 
@@ -50,7 +51,7 @@ module Kitchen
       def run
         execute_workflow
 
-        yield standard_output: shell_out.stdout
+        yield shell_out.stdout
 
         self
       end

data/lib/kitchen/terraform/system.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016-2019 New Context, Inc.
+# 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.

data/lib/kitchen/terraform/system_attrs_inputs_resolver.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016-2019 New Context, Inc.
+# 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.

data/lib/kitchen/terraform/system_attrs_outputs_resolver.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016-2019 New Context, Inc.
+# 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.

data/lib/kitchen/terraform/system_bastion_host_resolver.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016-2019 New Context, Inc.
+# 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.

data/lib/kitchen/terraform/system_hosts_resolver.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016-2019 New Context, Inc.
+# 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.

data/lib/kitchen/terraform/system_inspec_map.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016-2019 New Context, Inc.
+# 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.

data/lib/kitchen/terraform/systems_verifier.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016-2019 New Context, Inc.
+# 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.

data/lib/kitchen/terraform/systems_verifier/fail_fast.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016-2019 New Context, Inc.
+# 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.

data/lib/kitchen/terraform/systems_verifier/fail_slow.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016-2019 New Context, Inc.
+# 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.

data/lib/kitchen/terraform/systems_verifier_factory.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016-2019 New Context, Inc.
+# 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.

data/lib/kitchen/terraform/unsupported_client_version_error.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016-2019 New Context, Inc.
+# 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.

data/lib/kitchen/terraform/variables_manager.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016-2019 New Context, Inc.
+# 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.

data/lib/kitchen/terraform/verify_version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016-2019 New Context, Inc.
+# 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.
@@ -27,13 +27,12 @@ module Kitchen
     class VerifyVersion
       # #call invokes the verification.
       #
-      # @param command [Kitchen::Terraform::Command::Version] the version command.
-      # @param options [Hash] options for running the command.
+      # @param version [Gem::Version] the Terraform client version.
       # @raise [Kitchen::ActionFailed] if the verification fails.
       # @return [self]
-      def call(command:, options:)
+      def call(version:)
         logger.warn start_message
-        run_version_and_verify command: command, options: options
+        version_verifier.verify version: version
         logger.warn finish_message
       rescue ::Kitchen::Terraform::UnsupportedClientVersionError
         rescue_strategy.call
@@ -49,8 +48,7 @@ module Kitchen
       # @option config [Boolean] :verify_version a toggle of strict or permissive verification of support for the
       #   version of the Terraform client.
       # @return [Kitchen::Terraform::VerifyVersion]
-      def initialize(command_executor:, config:, logger:, version_requirement:)
-        self.command_executor = command_executor
+      def initialize(config:, logger:, version_requirement:)
         self.finish_message = "Finished verifying the Terraform client version."
         self.logger = logger
         self.rescue_strategy = ::Kitchen::Terraform::VerifyVersionRescueStrategyFactory.new(
@@ -64,22 +62,12 @@ module Kitchen
       private
 
       attr_accessor(
-        :command_executor,
         :finish_message,
         :logger,
-        :options,
         :rescue_strategy,
         :start_message,
         :version_verifier
       )
-
-      def run_version_and_verify(command:, options:)
-        logger.warn "Reading the Terraform client version..."
-        command_executor.run command: command, options: options do |standard_output:|
-          logger.warn "Finished reading the Terraform client version."
-          version_verifier.verify version: ::Gem::Version.new(standard_output.slice(/Terraform v(\d+\.\d+\.\d+)/, 1))
-        end
-      end
     end
   end
 end

data/lib/kitchen/terraform/verify_version_rescue_strategy.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016-2019 New Context, Inc.
+# 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.