Fix Converge Debug Logging and Prepare 7.0.1 (#522)

* Fix connection debug logging * Add entry to changelog * Prepare 7.0.1 --------- Co-authored-by: Aaron Lane <[email protected]>
newcontext-oss · Apr 21, 2023 · 3d20d60 · 3d20d60
1 parent fb2db9f
commit 3d20d60
Show file tree

Hide file tree

Showing 31 changed files with 36 additions and 11 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,10 +8,14 @@ and this project adheres to
 
 ## [Unreleased][unreleased]
 
+## [7.0.1] - 2023-04-20
+
 ### Fixed
 
 - The doctor check for the `client` attribute uses the PATH to validate
   the value.
+- The debug connection logger for `kitchen converge` is properly
+  initialized.
 
 ## [7.0.0] - 2023-04-09
 
@@ -815,7 +819,8 @@ Free-As-In-Beer
 - Initial release
 
 [unreleased]:
-  https://github.com/newcontext/kitchen-terraform/compare/v7.0.0...HEAD
+  https://github.com/newcontext/kitchen-terraform/compare/v7.0.1...HEAD
+[7.0.1]: https://github.com/newcontext/kitchen-terraform/compare/v7.0.0...v7.0.1
 [7.0.0]: https://github.com/newcontext/kitchen-terraform/compare/v6.1.0...v7.0.0
 [6.1.0]: https://github.com/newcontext/kitchen-terraform/compare/v6.0.0...v6.1.0
 [6.0.0]: https://github.com/newcontext/kitchen-terraform/compare/v5.8.0...v6.0.0

diff --git a/README.md b/README.md
@@ -111,7 +111,7 @@ example.
 ---
 
 ```sh
-gem install kitchen-terraform --version 7.0.0
+gem install kitchen-terraform --version 7.0.1
 ```
 
 ---

diff --git a/docs/apple-touch-icon-114x114-precomposed.png b/docs/apple-touch-icon-114x114-precomposed.png
diff --git a/docs/apple-touch-icon-120x120-precomposed.png b/docs/apple-touch-icon-120x120-precomposed.png
diff --git a/docs/apple-touch-icon-144x144-precomposed.png b/docs/apple-touch-icon-144x144-precomposed.png
diff --git a/docs/apple-touch-icon-152x152-precomposed.png b/docs/apple-touch-icon-152x152-precomposed.png
diff --git a/docs/apple-touch-icon-180x180-precomposed.png b/docs/apple-touch-icon-180x180-precomposed.png
diff --git a/docs/apple-touch-icon-57x57-precomposed.png b/docs/apple-touch-icon-57x57-precomposed.png
diff --git a/docs/apple-touch-icon-60x60-precomposed.png b/docs/apple-touch-icon-60x60-precomposed.png
diff --git a/docs/apple-touch-icon-72x72-precomposed.png b/docs/apple-touch-icon-72x72-precomposed.png
diff --git a/docs/apple-touch-icon-76x76-precomposed.png b/docs/apple-touch-icon-76x76-precomposed.png
diff --git a/docs/apple-touch-icon-precomposed.png b/docs/apple-touch-icon-precomposed.png
diff --git a/docs/apple-touch-icon.png b/docs/apple-touch-icon.png
diff --git a/docs/favicon-160x160.png b/docs/favicon-160x160.png
diff --git a/docs/favicon-16x16.png b/docs/favicon-16x16.png
diff --git a/docs/favicon-196x196.png b/docs/favicon-196x196.png
diff --git a/docs/favicon-32x32.png b/docs/favicon-32x32.png
diff --git a/docs/favicon-96x96.png b/docs/favicon-96x96.png
diff --git a/docs/favicon.ico b/docs/favicon.ico
diff --git a/docs/favicon.png b/docs/favicon.png
diff --git a/docs/mstile-144x144.png b/docs/mstile-144x144.png
diff --git a/docs/mstile-150x150.png b/docs/mstile-150x150.png
diff --git a/docs/mstile-310x150.png b/docs/mstile-310x150.png
diff --git a/docs/mstile-310x310.png b/docs/mstile-310x310.png
diff --git a/docs/mstile-70x70.png b/docs/mstile-70x70.png
diff --git a/lib/kitchen/provisioner/terraform.rb b/lib/kitchen/provisioner/terraform.rb
@@ -86,7 +86,7 @@ def call(state)
         ::Kitchen::Terraform::Provisioner::Converge.new(
           config: driver.send(:config),
           connection: transport.connection({}),
-          debug_connection: transport.connection(logger: ::Kitchen::Terraform::DebugLogger.new(logger: logger)),
+          debug_connection: transport.connection(logger: ::Kitchen::Terraform::DebugLogger.new(logger)),
           logger: logger,
           version_requirement: version_requirement,
           workspace_name: workspace_name,

diff --git a/lib/kitchen/terraform/debug_logger.rb b/lib/kitchen/terraform/debug_logger.rb
@@ -20,6 +20,19 @@ module Kitchen
   module Terraform
     # This class delegates to a logger but ensures the debug level is the default level used for logging messages.
     class DebugLogger < ::SimpleDelegator
+      class << self
+        # .new creates a new instance of the class.
+        #
+        # @return [Kitchen::Terraform::DebugLogger]
+        def new(obj)
+          if !obj.kind_of? ::Kitchen::Logger
+            raise ::TypeError, "delegate must be a Kitchen::Logger; recevied #{obj.class}"
+          end
+
+          super
+        end
+      end
+
       # This method overrides the #<< method of the delegate to call #debug.
       #
       # @param message [#to_s] the message to be logged.

diff --git a/lib/kitchen/terraform/version.rb b/lib/kitchen/terraform/version.rb
@@ -71,7 +71,7 @@ def temporarily_override(version:)
 
         # @api private
         def value
-          self.value = ::Gem::Version.new "7.0.0" if not @value
+          self.value = ::Gem::Version.new "7.0.1" if not @value
           @value
         end
 

diff --git a/spec/lib/kitchen/terraform/debug_logger_spec.rb b/spec/lib/kitchen/terraform/debug_logger_spec.rb
@@ -16,23 +16,30 @@
 
 require "kitchen"
 require "kitchen/terraform/debug_logger"
+require "support/kitchen/logger_context"
 
 ::RSpec.describe ::Kitchen::Terraform::DebugLogger do
-  subject do
-    described_class.new logger
+  describe ".new" do
+    specify "raises an error if the delegate is not a Kitchen::Logger" do
+      expect do
+        described_class.new ::Object.new
+      end.to raise_error ::TypeError
+    end
   end
 
-  let :logger do
-    instance_double ::Kitchen::Logger
+  subject do
+    described_class.new ::Kitchen.logger
   end
 
+  include_context "Kitchen::Logger"
+
   shared_examples "#debug" do
     after do
       subject << "message"
     end
 
     specify "forwards the message to #debug of the wrapped logger" do
-      expect(logger).to receive(:debug).with "message"
+      expect(::Kitchen.logger).to receive(:debug).with "message"
     end
   end
 

diff --git a/spec/lib/kitchen/terraform/version_spec.rb b/spec/lib/kitchen/terraform/version_spec.rb
@@ -24,7 +24,7 @@
   end
 
   let :version do
-    ::Gem::Version.new "7.0.0"
+    ::Gem::Version.new "7.0.1"
   end
 
   describe ".assign_plugin_version" do

diff --git a/spec/support/kitchen/terraform/configurable_examples.rb b/spec/support/kitchen/terraform/configurable_examples.rb
@@ -26,7 +26,7 @@
 
   describe "@plugin_version" do
     it "equals the gem version" do
-      expect(described_class.instance_variable_get(:@plugin_version)).to eq "7.0.0"
+      expect(described_class.instance_variable_get(:@plugin_version)).to eq "7.0.1"
     end
   end