Remove TF_WARN_OUTPUT_ERRORS from terraform apply (#320)

* Only set TF_WARN_OUTPUT_ERRORS on destroy Setting this variable on apply can hide configuration issues which would normally generate an error. * Implement the spec * Disable redundant Code Climate plugins These plugins duplicate behaviour performed by Code Climate checks. * Include erroneously excluded spec/ in Code Climate * Update version to 4.3.0 * Add entry to CHANGELOG * Cache chocolately downloads * Revert "Cache chocolately downloads" This reverts commit c2f5a89. * Update release date
newcontext-oss · Jan 21, 2019 · 7cdfa11 · 7cdfa11
1 parent 4065a99
commit 7cdfa11
Show file tree

Hide file tree

Showing 13 changed files with 254 additions and 208 deletions.
diff --git a/.codeclimate.yml b/.codeclimate.yml
@@ -4,14 +4,14 @@ plugins:
   bundler-audit:
     enabled: false
   duplication:
-    enabled: true
+    enabled: false
     config:
       languages:
         - "ruby"
   fixme:
     enabled: true
   flog:
-    enabled: true
+    enabled: false
   markdownlint:
     enabled: true
   reek:

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,14 @@ adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased][unreleased]
 
+## [4.3.0] - 2019-01-20
+
+### Changed
+
+- `TF_WARN_OUTPUT_ERRORS` is no longer automatically set when running
+  `terraform apply` during `kitchen converge`. This change should allow
+  output errors to be more quickly exposed to the user.
+
 ## [4.2.1] - 2019-01-19
 
 ### Changed
@@ -588,7 +596,8 @@ Gandalf the Free-As-In-Beer
 
 - Initial release
 
-[unreleased]: https://github.com/newcontext/kitchen-terraform/compare/v4.2.1...HEAD
+[unreleased]: https://github.com/newcontext/kitchen-terraform/compare/v4.3.0...HEAD
+[4.3.0]: https://github.com/newcontext/kitchen-terraform/compare/v4.2.1...v4.3.0
 [4.2.1]: https://github.com/newcontext/kitchen-terraform/compare/v4.2.0...v4.2.1
 [4.2.0]: https://github.com/newcontext/kitchen-terraform/compare/v4.1.1...v4.2.0
 [4.1.1]: https://github.com/newcontext/kitchen-terraform/compare/v4.1.0...v4.1.1

diff --git a/Gemfile.lock b/Gemfile.lock
@@ -14,7 +14,7 @@ GIT
 PATH
   remote: .
   specs:
-    kitchen-terraform (4.2.1)
+    kitchen-terraform (4.3.0)
       dry-types (~> 0.9)
       dry-validation (~> 0.10)
       inspec (~> 3.0)

diff --git a/lib/kitchen/driver/terraform.rb b/lib/kitchen/driver/terraform.rb
@@ -397,6 +397,7 @@ def destroy_run_destroy
       "#{variable_files_flags}",
       options: {
         cwd: config_root_module_directory,
+        environment: {"TF_WARN_OUTPUT_ERRORS" => "true"},
         live_stream: logger,
         timeout: config_command_timeout,
       },

diff --git a/lib/kitchen/terraform/shell_out.rb b/lib/kitchen/terraform/shell_out.rb
@@ -31,6 +31,7 @@ module ::Kitchen::Terraform::ShellOut
   #   command.
   # @option options [::Integer] :timeout the maximum duration in seconds to run the command.
   # @param command [::String] the command to run.
+  # @option options [::Hash] :environment environment variables to define when running the command.
   # @param options [::Hash] options which adjust the execution of the command.
   # @raise [::Kitchen::Terraform::Error] if running the command fails.
   # @return [::String] the standard output from running the command.
@@ -67,22 +68,19 @@ def self.handle(error:)
 
   # @api private
   def self.run_shell_out(command:, options:)
-    yield(
-      standard_output:
-        ::Mixlib::ShellOut
-          .new(
+    yield(standard_output: ::Mixlib::ShellOut.new(
             "terraform #{command}",
-            options.merge(environment: {"TF_IN_AUTOMATION" => "true", "TF_WARN_OUTPUT_ERRORS" => "1"})
-          )
-          .tap do |shell_out|
-            shell_out
-              .live_stream
-              .warn "Running command `#{shell_out.command}` in directory #{shell_out.cwd}"
-
+            options.merge(
+              environment: {"TF_IN_AUTOMATION" => "true", "TF_WARN_OUTPUT_ERRORS" => "1"}.merge(
+                options.fetch(:environment) do
+                  {}
+                end
+              ),
+            )
+          ).tap do |shell_out|
+            shell_out.live_stream.warn "Running command `#{shell_out.command}` in directory #{shell_out.cwd}"
             shell_out.run_command
             shell_out.error!
-          end
-          .stdout
-    )
+          end.stdout)
   end
 end
diff --git a/lib/kitchen/terraform/version.rb b/lib/kitchen/terraform/version.rb
@@ -72,7 +72,7 @@ def temporarily_override(version:)
 
     # @api private
     def value
-      self.value = ::Gem::Version.new "4.2.1" if not @value
+      self.value = ::Gem::Version.new "4.3.0" if not @value
       @value
     end
 

diff --git a/ruby-2.3/Gemfile.lock b/ruby-2.3/Gemfile.lock
@@ -14,7 +14,7 @@ GIT
 PATH
   remote: ..
   specs:
-    kitchen-terraform (4.2.1)
+    kitchen-terraform (4.3.0)
       dry-types (~> 0.9)
       dry-validation (~> 0.10)
       inspec (~> 3.0)

diff --git a/ruby-2.4/Gemfile.lock b/ruby-2.4/Gemfile.lock
@@ -14,7 +14,7 @@ GIT
 PATH
   remote: ..
   specs:
-    kitchen-terraform (4.2.1)
+    kitchen-terraform (4.3.0)
       dry-types (~> 0.9)
       dry-validation (~> 0.10)
       inspec (~> 3.0)

diff --git a/ruby-2.5/Gemfile.lock b/ruby-2.5/Gemfile.lock
@@ -14,7 +14,7 @@ GIT
 PATH
   remote: ..
   specs:
-    kitchen-terraform (4.2.1)
+    kitchen-terraform (4.3.0)
       dry-types (~> 0.9)
       dry-validation (~> 0.10)
       inspec (~> 3.0)

diff --git a/spec/lib/kitchen/driver/terraform_spec.rb b/spec/lib/kitchen/driver/terraform_spec.rb
@@ -524,7 +524,15 @@ def shell_out_run_yield(command:, standard_output: "mocked `terraform` success")
 
       context "when `terraform destroy` results in failure" do
         before do
-          shell_out_run_failure command: /destroy/, message: "mocked `terraform destroy` failure"
+          allow(shell_out).to receive(:run).with(
+            command: /destroy/,
+            options: {
+              cwd: kitchen_root,
+              environment: {"TF_WARN_OUTPUT_ERRORS" => "true"},
+              live_stream: kitchen_logger,
+              timeout: command_timeout,
+            },
+          ).and_raise ::Kitchen::Terraform::Error, "mocked `terraform destroy` failure"
         end
 
         specify "should result in an action failed error with the failed command output" do
@@ -536,7 +544,7 @@ def shell_out_run_yield(command:, standard_output: "mocked `terraform` success")
 
       context "when `terraform destroy` results in success" do
         before do
-          shell_out_run_success(
+          allow(shell_out).to receive(:run).with(
             command: "destroy " \
             "-auto-approve " \
             "-lock=true " \
@@ -549,7 +557,13 @@ def shell_out_run_yield(command:, standard_output: "mocked `terraform` success")
             "-var=\"map={ key = \\\"A Value\\\" }\" " \
             "-var=\"list=[ \\\"Element One\\\", \\\"Element Two\\\" ]\" " \
             "-var-file=\"/Arbitrary Directory/Variable File.tfvars\"",
-          )
+            options: {
+              cwd: kitchen_root,
+              environment: {"TF_WARN_OUTPUT_ERRORS" => "true"},
+              live_stream: kitchen_logger,
+              timeout: command_timeout,
+            },
+          ).and_return "mocked `terraform` success"
         end
 
         context "when `terraform select default` results in failure" do