kitchen-terraform 5.1.1 → 5.6.0

data/lib/kitchen/provisioner/terraform.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,96 +15,98 @@
 # limitations under the License.
 
 require "kitchen"
+require "kitchen/terraform/raise/action_failed"
 require "kitchen/terraform/configurable"
-require "kitchen/terraform/error"
+require "kitchen/terraform/provisioner/converge"
 
-# This namespace is defined by Kitchen.
-#
-# @see http://www.rubydoc.info/gems/test-kitchen/Kitchen/Provisioner
-module ::Kitchen::Provisioner
-end
+module Kitchen
+  # This namespace is defined by Kitchen.
+  #
+  # @see http://www.rubydoc.info/gems/test-kitchen/Kitchen/Provisioner
+  module Provisioner
+    # The provisioner applies changes to the Terraform state based on the configuration of the root module.
+    #
+    # === Commands
+    #
+    # The following command-line actions are provided by the provisioner.
+    #
+    # ==== kitchen converge
+    #
+    # {include:Kitchen::Terraform::Provisioner::Converge}
+    #
+    # === Configuration Attributes
+    #
+    # The provisioner has no configuration attributes, but the +provisioner+ mapping must be declared with the plugin name
+    # within the {http://kitchen.ci/docs/getting-started/kitchen-yml Test Kitchen configuration file}.
+    #
+    #   provisioner:
+    #     name: terraform
+    #
+    # === Ruby Interface
+    #
+    # This class implements the interface of Kitchen::Configurable which requires the following Reek suppressions:
+    # :reek:MissingSafeMethod { exclude: [ finalize_config! ] }
+    #
+    # @example Describe the converge command
+    #   kitchen help converge
+    # @example Converge a Test Kitchen instance
+    #   kitchen converge default-ubuntu
+    # @version 2
+    class Terraform < ::Kitchen::Provisioner::Base
+      # UNSUPPORTED_BASE_ATTRIBUTES is the list of attributes inherited from
+      # Kitchen::Provisioner::Base which are not supported by Kitchen::Provisioner::Terraform.
+      UNSUPPORTED_BASE_ATTRIBUTES = [
+        :command_prefix,
+        :downloads,
+        :http_proxy,
+        :https_proxy,
+        :ftp_proxy,
+        :max_retries,
+        :root_path,
+        :retry_on_exit_code,
+        :sudo,
+        :sudo_command,
+        :wait_for_retry,
+      ]
+      defaults.delete_if do |key|
+        UNSUPPORTED_BASE_ATTRIBUTES.include? key
+      end
+      kitchen_provisioner_api_version 2
 
-# The provisioner utilizes the driver to apply changes to the Terraform state in order to reach the desired
-# configuration of the root module.
-#
-# === Commands
-#
-# The following command-line actions are provided by the provisioner.
-#
-# ==== kitchen converge
-#
-# A Test Kitchen instance is converged through the following steps.
-#
-# ===== Selecting the Test Terraform Workspace
-#
-#   terraform workspace select kitchen-terraform-<instance>
-#
-# ===== Updating the Terraform Dependency Modules
-#
-#   terraform get -update <directory>
-#
-# ===== Validating the Terraform Root Module
-#
-#   terraform validate \
+      include ::Kitchen::Terraform::Configurable
 
-#     [-no-color] \
-#     [-var=<variables.first>...] \
-#     [-var-file=<variable_files.first>...] \
-#     <directory>
-#
-# ===== Applying the Terraform State Changes
-#
-#   terraform apply\
-#     -lock=<lock> \
-#     -lock-timeout=<lock_timeout>s \
-#     -input=false \
-#     -auto-approve=true \
-#     [-no-color] \
-#     -parallelism=<parallelism> \
-#     -refresh=true \
-#     [-var=<variables.first>...] \
-#     [-var-file=<variable_files.first>...] \
-#     <directory>
-#
-# === Configuration Attributes
-#
-# The provisioner has no configuration attributes, but the +provisioner+ mapping must be declared with the plugin name
-# within the {http://kitchen.ci/docs/getting-started/kitchen-yml Test Kitchen configuration file}.
-#
-#   provisioner:
-#     name: terraform
-#
-# @example Describe the converge command
-#   kitchen help converge
-# @example Converge a Test Kitchen instance
-#   kitchen converge default-ubuntu
-# @version 2
-class ::Kitchen::Provisioner::Terraform < ::Kitchen::Provisioner::Base
-  UNSUPPORTED_BASE_ATTRIBUTES = [
-    :command_prefix,
-    :downloads,
-    :http_proxy,
-    :https_proxy,
-    :ftp_proxy,
-    :max_retries,
-    :root_path,
-    :retry_on_exit_code,
-    :sudo,
-    :sudo_command,
-    :wait_for_retry,
-  ]
-  defaults.delete_if do |key|
-    UNSUPPORTED_BASE_ATTRIBUTES.include? key
-  end
-  kitchen_provisioner_api_version 2
+      # Converges a Test Kitchen instance.
+      #
+      # @param state [Hash] the mutable instance and provisioner state.
+      # @raise [Kitchen::ActionFailed] if the result of the action is a failure.
+      def call(state)
+        converge_strategy.call state: state
+      rescue => error
+        action_failed.call message: error.message
+      end
 
-  include ::Kitchen::Terraform::Configurable
+      # #finalize_config! invokes the super implementation and then initializes the strategy.
+      #
+      # @param instance [Kitchen::Instance] an associated instance.
+      # @raise [Kitchen::ClientError] if the instance is nil.
+      # @return [self]
+      # @see Kitchen::Configurable#finalize_config!
+      def finalize_config!(instance)
+        super instance
+        self.action_failed = ::Kitchen::Terraform::Raise::ActionFailed.new logger: logger
+        self.converge_strategy = ::Kitchen::Terraform::Provisioner::Converge.new(
+          config: instance.driver.send(:config),
+          logger: logger,
+          version_requirement: version_requirement,
+          workspace_name: workspace_name,
+        )
 
-  # Converges a Test Kitchen instance.
-  #
-  # @param _state [::Hash] the mutable instance and provisioner state.
-  # @raise [::Kitchen::ActionFailed] if the result of the action is a failure.
-  def call(_state)
-    instance.driver.apply
+        self
+      end
+
+      private
+
+      attr_accessor :action_failed, :converge_strategy
+    end
   end
 end

data/lib/kitchen/terraform.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,9 +15,8 @@
 # limitations under the License.
 
 # Dummy namespace for Test Kitchen to allow loading of Kitchen::Terraform::Version from gem specification.
-module ::Kitchen
-end
-
-# The namespace for kitchen-terraform.
-module ::Kitchen::Terraform
+module Kitchen
+  # The namespace for Kitchen-Terraform.
+  module Terraform
+  end
 end

data/lib/kitchen/terraform/breaking.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,8 +14,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "kitchen/terraform"
-
-# The namespace for objects with breaking changes.
-module ::Kitchen::Terraform::Breaking
+module Kitchen
+  module Terraform
+    # The namespace for objects with breaking changes.
+    module Breaking
+    end
+  end
 end

data/lib/kitchen/terraform/command.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,8 +14,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "kitchen/terraform"
-
-# The namespace for Terraform commands.
-module ::Kitchen::Terraform::Command
+module Kitchen
+  module Terraform
+    # The namespace for Terraform commands.
+    module Command
+    end
+  end
 end

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

@@ -0,0 +1,87 @@
+# 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/lock_timeout"
+require "kitchen/terraform/command_flag/var_file"
+require "kitchen/terraform/command_flag/var"
+require "shellwords"
+
+module Kitchen
+  module Terraform
+    module Command
+      # The state changes are applied by running a command like the following example:
+      #   terraform apply\
+      #     -lock=<lock> \
+      #     -lock-timeout=<lock_timeout>s \
+      #     -input=false \
+      #     -auto-approve=true \
+      #     [-no-color] \
+      #     -parallelism=<parallelism> \
+      #     -refresh=true \
+      #     [-var=<variables.first>...] \
+      #     [-var-file=<variable_files.first>...] \
+      #     <directory>
+      class Apply
+        # #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 [Boolean] :lock a toggle of locking for the Terraform state file.
+        # @option config [Integer] :lock_timeout the number of seconds that the Terraform client will wait for a lock
+        #   on the state to be obtained during operations.
+        # @option config [Integer] :parallelism the number of concurrent operations to use while Terraform walks the
+        #   resource graph.
+        # @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::Apply]
+        def initialize(config:)
+          self.color = ::Kitchen::Terraform::CommandFlag::Color.new enabled: config.fetch(:color)
+          self.lock = config.fetch :lock
+          self.lock_timeout = ::Kitchen::Terraform::CommandFlag::LockTimeout.new duration: config.fetch(:lock_timeout)
+          self.parallelism = config.fetch :parallelism
+          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
+          "apply " \
+          "-auto-approve " \
+          "-lock=#{lock} " \
+          "#{lock_timeout} " \
+          "-input=false " \
+          "#{color} " \
+          "-parallelism=#{parallelism} " \
+          "-refresh=true " \
+          "#{var} " \
+          "#{var_file}"
+        end
+
+        private
+
+        attr_accessor(
+          :color,
+          :lock,
+          :lock_timeout,
+          :parallelism,
+          :var_file,
+          :var,
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,88 @@
+# 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/lock_timeout"
+require "kitchen/terraform/command_flag/var_file"
+require "kitchen/terraform/command_flag/var"
+require "shellwords"
+
+module Kitchen
+  module Terraform
+    module Command
+      # The state is destroyed by running a command like the following example:
+      #   terraform destroy \
+      #     -auto-approve \
+      #     -lock=<lock> \
+      #     -lock-timeout=<lock_timeout>s \
+      #     -input=false \
+      #     [-no-color] \
+      #     -parallelism=<parallelism> \
+      #     -refresh=true \
+      #     [-var=<variables.first>...] \
+      #     [-var-file=<variable_files.first>...] \
+      #     <root_module_directory>
+      class Destroy
+        # #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 [Boolean] :lock a toggle of locking for the Terraform state file.
+        # @option config [Integer] :lock_timeout the number of seconds that the Terraform client will wait for a lock
+        #   on the state to be obtained during operations.
+        # @option config [Integer] :parallelism the number of concurrent operations to use while Terraform walks the
+        #   resource graph.
+        # @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::Destroy]
+        def initialize(config:)
+          self.color = ::Kitchen::Terraform::CommandFlag::Color.new enabled: config.fetch(:color)
+          self.lock = config.fetch :lock
+          self.lock_timeout = ::Kitchen::Terraform::CommandFlag::LockTimeout.new duration: config.fetch(:lock_timeout)
+          self.parallelism = config.fetch :parallelism
+          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
+          "destroy " \
+          "-auto-approve " \
+          "-lock=#{lock} " \
+          "#{lock_timeout} " \
+          "-input=false " \
+          "#{color} " \
+          "-parallelism=#{parallelism} " \
+          "-refresh=true " \
+          "#{var} " \
+          "#{var_file}"
+        end
+
+        private
+
+        attr_accessor(
+          :color,
+          :lock,
+          :lock_timeout,
+          :options,
+          :parallelism,
+          :var_file,
+          :var,
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# 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 "shellwords"
+
+module Kitchen
+  module Terraform
+    module Command
+      # The dependency modules are updated by running a command like the following example:
+      #   terraform get -update <directory>
+      class Get
+        # @return [String] the command with flags.
+        def to_s
+          "get -update"
+        end
+      end
+    end
+  end
+end