kitchen-terraform 5.5.0 → 5.8.0

data/lib/kitchen/terraform/command/validate/pre_zero_fifteen_zero.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+# Copyright 2016-2019 New Context, 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/command_flag/color"
+require "kitchen/terraform/command_flag/var_file"
+require "kitchen/terraform/command_flag/var"
+require "shellwords"
+
+module Kitchen
+  module Terraform
+    module Command
+      module Validate
+        # The root module is validated by running a command like the following example:
+        #   terraform validate \
+        #     [-no-color] \
+        #     [-var=<variables.first>...] \
+        #     [-var-file=<variable_files.first>...] \
+        #     <directory>
+        class PreZeroFifteenZero
+          # #initialize prepares a new instance of the class.
+          #
+          # @param config [Hash] the configuration of the driver.
+          # @option config [Boolean] :color a toggle of colored output from the Terraform client.
+          # @option config [Array<String>] :variable_files a list of pathnames of Terraform variable files to evaluate.
+          # @option config [Hash{String=>String}] :variables a mapping of Terraform variables to evaluate.
+          # @return [Kitchen::Terraform::Command::Validate]
+          def initialize(config:)
+            self.color = ::Kitchen::Terraform::CommandFlag::Color.new enabled: config.fetch(:color)
+            self.var_file = ::Kitchen::Terraform::CommandFlag::VarFile.new pathnames: config.fetch(:variable_files)
+            self.var = ::Kitchen::Terraform::CommandFlag::Var.new arguments: config.fetch(:variables)
+          end
+
+          # @return [String] the command with flags.
+          def to_s
+            "validate " \
+            "#{color} " \
+            "#{var} " \
+            "#{var_file}"
+          end
+
+          private
+
+          attr_accessor(
+            :color,
+            :var_file,
+            :var,
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+# Copyright 2016-2019 New Context, 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/command/validate/post_zero_fifteen_zero"
+require "kitchen/terraform/command/validate/pre_zero_fifteen_zero"
+require "rubygems"
+
+module Kitchen
+  module Terraform
+    module Command
+      # ValidateFactory is the class of objects which build Validate objects.
+      class ValidateFactory
+        # #build creates a new instance of an Validate object.
+        #
+        # @param config [Hash] the configuration of the driver.
+        # @return [Kitchen::Terraform::Command::Validate::PreZeroFifteenZero,
+        #   Kitchen::Terraform::Command::Validate::PostZeroFifteenZero]
+        def build(config:)
+          if requirement.satisfied_by? version
+            return ::Kitchen::Terraform::Command::Validate::PreZeroFifteenZero.new config: config
+          end
+
+          ::Kitchen::Terraform::Command::Validate::PostZeroFifteenZero.new config: config
+        end
+
+        # #initialize prepares a new instance of the class
+        #
+        # @param version [Gem::Version] a client version.
+        # @return [Kitchen::Terraform::Command::ValidateFactory]
+        def initialize(version:)
+          self.requirement = ::Gem::Requirement.new "< 0.15.0"
+          self.version = version
+        end
+
+        private
+
+        attr_accessor :requirement, :version
+      end
+    end
+  end
+end

data/lib/kitchen/terraform/command_flag/upgrade.rb

@@ -30,7 +30,7 @@ module Kitchen
         # @return [String] the upgrade flag.
         def to_s
           if enabled
-            "-upgrade"
+            "-upgrade=true"
           else
             ""
           end

data/lib/kitchen/terraform/configurable.rb

@@ -42,7 +42,7 @@ module Kitchen
       # @see Kitchen::Configurable#finalize_config!
       def finalize_config!(instance)
         super instance
-        self.version_requirement = ::Gem::Requirement.new ">= 0.11.4", "< 0.14.0"
+        self.version_requirement = ::Gem::Requirement.new ">= 0.11.4", "< 1.1.0"
         self.workspace_name = "kitchen-terraform-#{::Shellwords.escape instance.name}"
       end
 

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

@@ -15,12 +15,13 @@
 # limitations under the License.
 
 require "kitchen"
-require "kitchen/terraform/command/init"
+require "kitchen/terraform/command/init_factory"
 require "kitchen/terraform/command/version"
 require "kitchen/terraform/command/workspace_new"
 require "kitchen/terraform/command/workspace_select"
 require "kitchen/terraform/command_executor"
 require "kitchen/terraform/verify_version"
+require "rubygems"
 
 module Kitchen
   module Terraform
@@ -29,7 +30,13 @@ module Kitchen
       #
       # ===== Initializing the Terraform Working Directory
       #
-      # {include:Kitchen::Terraform::Command::Init}
+      # ====== Terraform >= 0.15.0
+      #
+      # {include:Kitchen::Terraform::Command::Init::PostZeroFifteenZero}
+      #
+      # ====== Terraform < 0.15.0
+      #
+      # {include:Kitchen::Terraform::Command::Init::PreZeroFifteenZero}
       #
       # ===== Creating or Selecting the Test Terraform Workspace
       #
@@ -42,7 +49,8 @@ module Kitchen
         # @raise [Kitchen::TransientFailure] if a command fails.
         # @return [self]
         def call
-          verify_version.call command: version, options: options
+          read_client_version
+          verify_version.call version: client_version
           initialize_directory
           create_or_select_workspace
 
@@ -58,20 +66,22 @@ module Kitchen
         # @option config [String] :client the pathname of the Terraform client.
         # @return [Kitchen::Terraform::Driver::Create]
         def initialize(config:, logger:, version_requirement:, workspace_name:)
-          hash_config = config.to_hash.merge upgrade_during_init: true, workspace_name: workspace_name
+          self.complete_config = config.to_hash.merge upgrade_during_init: true, workspace_name: workspace_name
+          self.client_version = ::Gem::Version.new "0.0.0"
           self.command_executor = ::Kitchen::Terraform::CommandExecutor.new(
-            client: config.fetch(:client),
+            client: complete_config.fetch(:client),
             logger: logger,
           )
-          self.init = ::Kitchen::Terraform::Command::Init.new config: hash_config
           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.workspace_new = ::Kitchen::Terraform::Command::WorkspaceNew.new config: hash_config
-          self.workspace_select = ::Kitchen::Terraform::Command::WorkspaceSelect.new config: hash_config
+          self.workspace_new = ::Kitchen::Terraform::Command::WorkspaceNew.new config: complete_config
+          self.workspace_select = ::Kitchen::Terraform::Command::WorkspaceSelect.new config: complete_config
           self.verify_version = ::Kitchen::Terraform::VerifyVersion.new(
-            command_executor: command_executor,
-            config: config,
+            config: complete_config,
             logger: logger,
             version_requirement: version_requirement,
           )
@@ -81,8 +91,9 @@ module Kitchen
         private
 
         attr_accessor(
+          :client_version,
           :command_executor,
-          :init,
+          :complete_config,
           :logger,
           :options,
           :verify_version,
@@ -103,11 +114,23 @@ module Kitchen
 
         def initialize_directory
           logger.warn "Initializing the Terraform working directory..."
-          command_executor.run command: init, options: options do |standard_output:|
+          command_executor.run(
+            command: ::Kitchen::Terraform::Command::InitFactory.new(version: client_version)
+              .build(config: complete_config),
+            options: options,
+          ) do |standard_output:|
           end
           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
+          logger.warn "Finished reading the Terraform client version."
+        end
+
         def select_workspace
           logger.warn "Selecting the #{workspace_name} Terraform workspace..."
           command_executor.run command: workspace_select, options: options do |standard_output:|

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

@@ -17,12 +17,13 @@
 require "kitchen"
 require "kitchen/terraform/command_executor"
 require "kitchen/terraform/command/destroy"
-require "kitchen/terraform/command/init"
+require "kitchen/terraform/command/init_factory"
 require "kitchen/terraform/command/version"
 require "kitchen/terraform/command/workspace_delete"
 require "kitchen/terraform/command/workspace_new"
 require "kitchen/terraform/command/workspace_select"
 require "kitchen/terraform/verify_version"
+require "rubygems"
 
 module Kitchen
   module Terraform
@@ -31,7 +32,13 @@ module Kitchen
       #
       # ===== Initializing the Terraform Working Directory
       #
-      # {include:Kitchen::Terraform::Command::Init}
+      # ====== Terraform >= 0.15.0
+      #
+      # {include:Kitchen::Terraform::Command::Init::PostZeroFifteenZero}
+      #
+      # ====== Terraform < 0.15.0
+      #
+      # {include:Kitchen::Terraform::Command::Init::PreZeroFifteenZero}
       #
       # ===== Selecting or Creating the Test Terraform Workspace
       #
@@ -56,7 +63,8 @@ module Kitchen
         # @raise [Kitchen::TransientFailure] if a command fails.
         # @return [self]
         def call
-          verify_version.call command: version, options: options
+          read_client_version
+          verify_version.call version: client_version
           execute_workflow
 
           self
@@ -70,25 +78,24 @@ module Kitchen
         # @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:)
-          hash_config = config.to_hash.merge upgrade_during_init: false, workspace_name: workspace_name
+          self.complete_config = config.to_hash.merge upgrade_during_init: false, workspace_name: workspace_name
+          self.client_version = ::Gem::Version.new "0.0.0"
           self.command_executor = ::Kitchen::Terraform::CommandExecutor.new(
-            client: config.fetch(:client),
+            client: complete_config.fetch(:client),
             logger: logger,
           )
           self.logger = logger
-          self.options = { cwd: config.fetch(:root_module_directory), timeout: config.fetch(:command_timeout) }
+          define_options
           self.workspace_name = workspace_name
-          self.destroy = ::Kitchen::Terraform::Command::Destroy.new config: config
-          self.init = ::Kitchen::Terraform::Command::Init.new config: hash_config
-          self.workspace_delete_test = ::Kitchen::Terraform::Command::WorkspaceDelete.new config: hash_config
-          self.workspace_new_test = ::Kitchen::Terraform::Command::WorkspaceNew.new config: hash_config
-          self.workspace_select_test = ::Kitchen::Terraform::Command::WorkspaceSelect.new config: hash_config
+          self.destroy = ::Kitchen::Terraform::Command::Destroy.new config: complete_config
+          self.workspace_delete_test = ::Kitchen::Terraform::Command::WorkspaceDelete.new config: complete_config
+          self.workspace_new_test = ::Kitchen::Terraform::Command::WorkspaceNew.new config: complete_config
+          self.workspace_select_test = ::Kitchen::Terraform::Command::WorkspaceSelect.new config: complete_config
           self.workspace_select_default = ::Kitchen::Terraform::Command::WorkspaceSelect.new(
-            config: hash_config.merge(workspace_name: "default"),
+            config: complete_config.merge(workspace_name: "default"),
           )
           self.verify_version = ::Kitchen::Terraform::VerifyVersion.new(
-            command_executor: command_executor,
-            config: config,
+            config: complete_config,
             logger: logger,
             version_requirement: version_requirement,
           )
@@ -98,7 +105,10 @@ module Kitchen
         private
 
         attr_accessor(
+          :client_version,
           :command_executor,
+          :complete_config,
+          :destroy_options,
           :destroy,
           :init,
           :logger,
@@ -119,9 +129,19 @@ module Kitchen
           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: options do |standard_output:|
+          command_executor.run command: destroy, options: destroy_options do |standard_output:|
           end
           logger.warn "Finished destroying the Terraform-managed infrastructure."
         end
@@ -143,11 +163,23 @@ module Kitchen
 
         def initialize_directory
           logger.warn "Initializing the Terraform working directory..."
-          command_executor.run command: init, options: options do |standard_output:|
+          command_executor.run(
+            command: ::Kitchen::Terraform::Command::InitFactory.new(version: client_version)
+              .build(config: complete_config),
+            options: options,
+          ) do |standard_output:|
           end
           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
+          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:|

data/lib/kitchen/terraform/inspec_runner.rb

@@ -60,7 +60,14 @@ module Kitchen
         self.host = options.fetch :host do
           ""
         end
+
+        ::Inspec::Plugin::V2::Loader.new.tap do |loader|
+          loader.load_all
+          loader.exit_on_load_error
+        end
+
         self.runner = ::Inspec::Runner.new options.merge logger: ::Inspec::Log.logger
+
         profile_locations.each do |profile_location|
           runner.add_target profile_location
         end

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

@@ -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,51 +83,50 @@ 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
@@ -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,10 +187,18 @@ 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
-          logger.warn "Finished writing the output varibales to the Kitchen instance state."
+          logger.warn "Finished writing the output variables to the Kitchen instance state."
         end
 
         def save_variables_and_outputs(state:)
@@ -196,7 +219,11 @@ module Kitchen
 
         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