kitchen-terraform 5.1.1 → 5.6.0

data/lib/kitchen/terraform/verify_version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016 New Context Services, Inc.
+# 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.
@@ -14,27 +14,70 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "kitchen/terraform"
-require "kitchen/terraform/command/version"
-require "kitchen/terraform/error"
+require "kitchen"
+require "kitchen/terraform/unsupported_client_version_error"
+require "kitchen/terraform/verify_version_rescue_strategy_factory"
+require "kitchen/terraform/version_verifier"
 require "rubygems"
 
-# Verifies that the output of the Terraform version command indicates a supported version of Terraform.
-#
-# Supported:: Terraform version >= 0.11.4, < 0.12.0.
-module ::Kitchen::Terraform::VerifyVersion
-  class << self
-    # Runs the function.
-    #
-    # @raise [::Kitchen::Terraform::Error] if the version is not supported or `terraform version` fails.
-    # @return [void]
-    def call
-      ::Kitchen::Terraform::Command::Version.run do |version:|
-        if !::Gem::Requirement.new(">= 0.11.4", "< 0.13.0").satisfied_by? version
-          raise(
-            ::Kitchen::Terraform::Error,
-            "Terraform v#{version} is not supported; supported versions are in the range of >= v0.11.4, < v0.13.0"
-          )
+module Kitchen
+  module Terraform
+    # VerifyVersion is the class of objects which verify the version of the Terraform client against a version
+    # requirement.
+    class VerifyVersion
+      # #call invokes the verification.
+      #
+      # @param command [Kitchen::Terraform::Command::Version] the version command.
+      # @param options [Hash] options for running the command.
+      # @raise [Kitchen::ActionFailed] if the verification fails.
+      # @return [self]
+      def call(command:, options:)
+        logger.warn start_message
+        run_version_and_verify command: command, options: options
+        logger.warn finish_message
+      rescue ::Kitchen::Terraform::UnsupportedClientVersionError
+        rescue_strategy.call
+
+        self
+      end
+
+      # #initialize prepares a new instance of the class.
+      #
+      # @param config [Hash] the configuration of the driver.
+      # @param logger [Kitchen::Logger] a logger for logging messages.
+      # @param version_requirement [Gem::VersionRequirement] the required version of the Terraform client.
+      # @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
+        self.finish_message = "Finished verifying the Terraform client version."
+        self.logger = logger
+        self.rescue_strategy = ::Kitchen::Terraform::VerifyVersionRescueStrategyFactory.new(
+          verify_version: config.fetch(:verify_version),
+        ).build logger: logger
+        self.start_message = "Verifying the Terraform client version is in the supported interval of " \
+                             "#{version_requirement}..."
+        self.version_verifier = ::Kitchen::Terraform::VersionVerifier.new version_requirement: version_requirement
+      end
+
+      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

data/lib/kitchen/terraform/verify_version_rescue_strategy.rb

@@ -0,0 +1,23 @@
+# 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.
+
+module Kitchen
+  module Terraform
+    # VerifyVersionRescueStrategy is the namespace for rescue strategies of instances of VerifyVersion.
+    module VerifyVersionRescueStrategy
+    end
+  end
+end

data/lib/kitchen/terraform/verify_version_rescue_strategy/permissive.rb

@@ -0,0 +1,50 @@
+# 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"
+
+module Kitchen
+  module Terraform
+    module VerifyVersionRescueStrategy
+      # Permissive is the class of objects which provide a permissive rescue strategy to handle a failure to verify the
+      # Terraform client version.
+      class Permissive
+        # #call warns the user that the version is unsupported.
+        #
+        # @return [self]
+        def call
+          logger.warn message
+
+          self
+        end
+
+        # #initialize prepares a new instance of the class.
+        #
+        # @param logger [Kitchen::Logger] a logger to log messages.
+        # @return [Kitchen::Terraform::VerifyVersionRescueStrategy::Permissive]
+        def initialize(logger:)
+          self.logger = logger
+          self.message = "Verifying the Terraform client version failed. Set `driver.verify_version: true` to " \
+                         "upgrade this warning to an error."
+        end
+
+        private
+
+        attr_accessor :logger, :message
+      end
+    end
+  end
+end

data/lib/kitchen/terraform/verify_version_rescue_strategy/strict.rb

@@ -0,0 +1,47 @@
+# 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/unsupported_client_version_error"
+
+module Kitchen
+  module Terraform
+    module VerifyVersionRescueStrategy
+      # Strict is the class of objects which provide a strict strategy rescue strategy to handle a failure to verify the
+      # Terraform client version.
+      class Strict
+        # #call raises an error.
+        #
+        # @raise [Kitchen::Terraform::UnsupportedClientVersionError]
+        # @return [void]
+        def call
+          raise ::Kitchen::Terraform::UnsupportedClientVersionError, message
+        end
+
+        # #initialize prepares a new instance of the class.
+        #
+        # @return [Kitchen::Terraform::VerifyVersionRescueStrategy::Permissive]
+        def initialize
+          self.message = "Verifying the Terraform client version failed. Set `driver.verify_version: false` to " \
+                         "downgrade this error to a warning."
+        end
+
+        private
+
+        attr_accessor :message
+      end
+    end
+  end
+end

data/lib/kitchen/terraform/verify_version_rescue_strategy_factory.rb

@@ -0,0 +1,51 @@
+# 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/verify_version_rescue_strategy/permissive"
+require "kitchen/terraform/verify_version_rescue_strategy/strict"
+
+module Kitchen
+  module Terraform
+    # VerifyVersionRescueStrategyFactory is the class of objects which build rescue strategies for instances of
+    # VerifyVersion.
+    class VerifyVersionRescueStrategyFactory
+      # #build creates a strategy.
+      #
+      # @param logger [Kitchen::Logger] a logger to log messages.
+      # @return [Kitchen::Terraform::VerifyVersionRescueStrategy::Strict,
+      #   Kitchen::Terraform::VerifyVersionRescueStrategy::Permissive]
+      def build(logger:)
+        if verify_version
+          ::Kitchen::Terraform::VerifyVersionRescueStrategy::Strict.new
+        else
+          ::Kitchen::Terraform::VerifyVersionRescueStrategy::Permissive.new logger: logger
+        end
+      end
+
+      # #initialize prepares a new instance of the class.
+      #
+      # @param verify_version [Boolean] a toggle for a strict strategy or a permissive strategy.
+      # @return [Kitchen::Terraform::VerifyVersionRescueStrategyFactory]
+      def initialize(verify_version:)
+        self.verify_version = verify_version
+      end
+
+      private
+
+      attr_accessor :verify_version
+    end
+  end
+end

data/lib/kitchen/terraform/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016 New Context Services, Inc.
+# 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.
@@ -15,71 +15,72 @@
 # limitations under the License.
 
 require "rubygems"
-require "kitchen/terraform"
 
-# Kitchen::Terraform::Version represents the version of the Kitchen-Terraform gem. The module can send the version to
-# different containers as well as conditionally yield to blocks based on version requirements.
-module ::Kitchen::Terraform::Version
-  class << self
-    # assign_plugin_version assigns the version to a class which includes Kitchen::Configurable.
-    #
-    # @param configurable_class [::Kitchen::Configurable] the configurable class to which the version will be assigned.
-    # @return [self]
-    def assign_plugin_version(configurable_class:)
-      configurable_class.plugin_version value.to_s
-      self
-    end
+module Kitchen
+  module Terraform
+    # Kitchen::Terraform::Version represents the version of the Kitchen-Terraform gem. The module can send the version to
+    # different containers as well as conditionally yield to blocks based on version requirements.
+    module Version
+      class << self
+        # assign_plugin_version assigns the version to a class which includes Kitchen::Configurable.
+        #
+        # @param configurable_class [Kitchen::Configurable] the configurable class to which the version will be assigned.
+        # @return [self]
+        def assign_plugin_version(configurable_class:)
+          configurable_class.plugin_version value.to_s
+          self
+        end
 
-    # assign_specification_version assigns the version to a Gem::Specification.
-    #
-    # @param specification [::Gem::Specification] the specification to which the version will be assigned.
-    # @return [self]
-    def assign_specification_version(specification:)
-      specification.version = value
-      self
-    end
+        # assign_specification_version assigns the version to a Gem::Specification.
+        #
+        # @param specification [Gem::Specification] the specification to which the version will be assigned.
+        # @return [self]
+        def assign_specification_version(specification:)
+          specification.version = value
+          self
+        end
 
-    # if_satisfies yields control if the provided requirement is satisfied by the version.
-    #
-    # @param requirement [::Gem::Requirement, ::String] the requirement to be satisfied by the version.
-    # @raise [::Gem::Requirement::BadRequirementError] if the requirement is illformed.
-    # @return [self]
-    # @yield [] if the requirement is satisfied by the version.
-    def if_satisfies(requirement:)
-      yield if
-        ::Gem::Requirement
-        .new(requirement).satisfied_by? value
+        # if_satisfies yields control if the provided requirement is satisfied by the version.
+        #
+        # @param requirement [Gem::Requirement, ::String] the requirement to be satisfied by the version.
+        # @raise [Gem::Requirement::BadRequirementError] if the requirement is illformed.
+        # @return [self]
+        # @yield [] if the requirement is satisfied by the version.
+        def if_satisfies(requirement:)
+          yield if ::Gem::Requirement.new(requirement).satisfied_by? value
 
-      self
-    end
+          self
+        end
 
-    # temporarily_override overrides the current version with the version provided, yields control, and then resets the
-    # version.
-    #
-    # @note temporarily_override must only be used in tests to validate version flow control logic.
-    # @raise [::ArgumentError] if the version is malformed.
-    # @return [self]
-    # @yield [] the value of the version will be overridden while control is yielded.
-    def temporarily_override(version:)
-      current_value = value
-      self.value = version
-      yield
-      self.value = current_value
-      self
-    end
+        # temporarily_override overrides the current version with the version provided, yields control, and then resets the
+        # version.
+        #
+        # @note temporarily_override must only be used in tests to validate version flow control logic.
+        # @raise [ArgumentError] if the version is malformed.
+        # @return [self]
+        # @yield [] the value of the version will be overridden while control is yielded.
+        def temporarily_override(version:)
+          current_value = value
+          self.value = version
+          yield
+          self.value = current_value
+          self
+        end
 
-    private
+        private
 
-    # @api private
-    def value
-      self.value = ::Gem::Version.new "5.1.1" if not @value
-      @value
-    end
+        # @api private
+        def value
+          self.value = ::Gem::Version.new "5.6.0" if not @value
+          @value
+        end
 
-    # @api private
-    def value=(version)
-      @value = ::Gem::Version.new version
-      self
+        # @api private
+        def value=(version)
+          @value = ::Gem::Version.new version
+          self
+        end
+      end
     end
   end
 end

data/lib/kitchen/terraform/version_verifier.rb

@@ -0,0 +1,50 @@
+# 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/version_verifier_strategy_factory"
+
+module Kitchen
+  module Terraform
+    # VersionVerifier is the class of objects which verify a Terraform client version against a requirement.
+    class VersionVerifier
+      # #verify verifies a version against the requirement.
+      #
+      # @param version [Gem::Version] the Terraform client version.
+      # @raise [Kitchen::TransientFailure] if running the command fails.
+      # @raise [Kitchen::UserError] if the version is unsupported.
+      # @return [self]
+      def verify(version:)
+        version_verifier_strategy_factory.build(version: version).call
+
+        self
+      end
+
+      # #initialize prepares a new instance of the class.
+      #
+      # @param version_requirement [Gem::Requirement] the requirement for version support.
+      # @return [Kitchen::Terraform::VersionVerifier]
+      def initialize(version_requirement:)
+        self.version_verifier_strategy_factory = ::Kitchen::Terraform::VersionVerifierStrategyFactory.new(
+          version_requirement: version_requirement,
+        )
+      end
+
+      private
+
+      attr_accessor :version_verifier_strategy_factory
+    end
+  end
+end