kitchen-terraform 5.1.1 → 5.6.0

data/lib/kitchen/terraform/debug_logger.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.

data/lib/kitchen/terraform/deprecating.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 deprecating changes.
-module ::Kitchen::Terraform::Deprecating
+module Kitchen
+  module Terraform
+    # The namespace for objects with deprecating changes.
+    module Deprecating
+    end
+  end
 end

data/lib/kitchen/terraform/driver.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
+    # Driver is the namespace for driver strategies.
+    module Driver
+    end
+  end
+end

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

@@ -0,0 +1,120 @@
+# 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"
+require "kitchen/terraform/command/init"
+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"
+
+module Kitchen
+  module Terraform
+    module Driver
+      # A Test Kitchen instance is created through the following steps.
+      #
+      # ===== Initializing the Terraform Working Directory
+      #
+      # {include:Kitchen::Terraform::Command::Init}
+      #
+      # ===== Creating or Selecting the Test Terraform Workspace
+      #
+      # {include:Kitchen::Terraform::Command::WorkspaceNew}
+      #
+      # {include:Kitchen::Terraform::Command::WorkspaceSelect}
+      class Create
+        # #call executes the action.
+        #
+        # @raise [Kitchen::TransientFailure] if a command fails.
+        # @return [self]
+        def call
+          verify_version.call command: version, options: options
+          initialize_directory
+          create_or_select_workspace
+
+          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.
+        # @param workspace_name [String] the name of the Terraform workspace to select or to create.
+        # @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.command_executor = ::Kitchen::Terraform::CommandExecutor.new(
+            client: 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.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.verify_version = ::Kitchen::Terraform::VerifyVersion.new(
+            command_executor: command_executor,
+            config: config,
+            logger: logger,
+            version_requirement: version_requirement,
+          )
+          self.version = ::Kitchen::Terraform::Command::Version.new
+        end
+
+        private
+
+        attr_accessor(
+          :command_executor,
+          :init,
+          :logger,
+          :options,
+          :verify_version,
+          :version,
+          :workspace_name,
+          :workspace_new,
+          :workspace_select,
+        )
+
+        def create_or_select_workspace
+          logger.warn "Creating the #{workspace_name} Terraform workspace..."
+          command_executor.run command: workspace_new, options: options do |standard_output:|
+          end
+          logger.warn "Finished creating the #{workspace_name} Terraform workspace."
+        rescue ::Kitchen::TransientFailure
+          select_workspace
+        end
+
+        def initialize_directory
+          logger.warn "Initializing the Terraform working directory..."
+          command_executor.run command: init, options: options do |standard_output:|
+          end
+          logger.warn "Finished initializing the Terraform working directory."
+        end
+
+        def select_workspace
+          logger.warn "Selecting the #{workspace_name} Terraform workspace..."
+          command_executor.run command: workspace_select, options: options do |standard_output:|
+          end
+          logger.warn "Finished selecting the #{workspace_name} Terraform workspace."
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,169 @@
+# 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"
+require "kitchen/terraform/command_executor"
+require "kitchen/terraform/command/destroy"
+require "kitchen/terraform/command/init"
+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"
+
+module Kitchen
+  module Terraform
+    module Driver
+      # A Test Kitchen instance is destroyed through the following steps.
+      #
+      # ===== Initializing the Terraform Working Directory
+      #
+      # {include:Kitchen::Terraform::Command::Init}
+      #
+      # ===== Selecting or Creating the Test Terraform Workspace
+      #
+      # {include:Kitchen::Terraform::Command::WorkspaceSelect}
+      #
+      # {include:Kitchen::Terraform::Command::WorkspaceNew}
+      #
+      # ===== Destroying the Terraform State
+      #
+      # {include:Kitchen::Terraform::Command::Destroy}
+      #
+      # ===== Selecting the Default Terraform Workspace
+      #
+      # {include:Kitchen::Terraform::Command::WorkspaceSelect}
+      #
+      # ===== Deleting the Test Terraform Workspace
+      #
+      # {include:Kitchen::Terraform::Command::WorkspaceDelete}
+      class Destroy
+        # #call executes the action.
+        #
+        # @raise [Kitchen::TransientFailure] if a command fails.
+        # @return [self]
+        def call
+          verify_version.call command: version, options: options
+          execute_workflow
+
+          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.
+        # @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.command_executor = ::Kitchen::Terraform::CommandExecutor.new(
+            client: config.fetch(:client),
+            logger: logger,
+          )
+          self.logger = logger
+          self.options = { cwd: config.fetch(:root_module_directory), timeout: config.fetch(:command_timeout) }
+          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.workspace_select_default = ::Kitchen::Terraform::Command::WorkspaceSelect.new(
+            config: hash_config.merge(workspace_name: "default"),
+          )
+          self.verify_version = ::Kitchen::Terraform::VerifyVersion.new(
+            command_executor: command_executor,
+            config: config,
+            logger: logger,
+            version_requirement: version_requirement,
+          )
+          self.version = ::Kitchen::Terraform::Command::Version.new
+        end
+
+        private
+
+        attr_accessor(
+          :command_executor,
+          :destroy,
+          :init,
+          :logger,
+          :options,
+          :verify_version,
+          :version,
+          :workspace_delete_test,
+          :workspace_name,
+          :workspace_new_test,
+          :workspace_select_default,
+          :workspace_select_test,
+        )
+
+        def create_test_workspace
+          logger.warn "Creating the #{workspace_name} Terraform workspace..."
+          command_executor.run command: workspace_new_test, options: options do |standard_output:|
+          end
+          logger.warn "Finished creating the #{workspace_name} Terraform workspace."
+        end
+
+        def destroy_infrastructure
+          logger.warn "Destroying the Terraform-managed infrastructure..."
+          command_executor.run command: destroy, options: options do |standard_output:|
+          end
+          logger.warn "Finished destroying the Terraform-managed infrastructure."
+        end
+
+        def delete_test_workspace
+          logger.warn "Deleting the #{workspace_name} Terraform workspace..."
+          command_executor.run command: workspace_delete_test, options: options do |standard_output:|
+          end
+          logger.warn "Finished deleting the #{workspace_name} Terraform workspace."
+        end
+
+        def execute_workflow
+          initialize_directory
+          select_or_create_test_workspace
+          destroy_infrastructure
+          select_default_workspace
+          delete_test_workspace
+        end
+
+        def initialize_directory
+          logger.warn "Initializing the Terraform working directory..."
+          command_executor.run command: init, options: options do |standard_output:|
+          end
+          logger.warn "Finished initializing the Terraform working directory."
+        end
+
+        def select_default_workspace
+          logger.warn "Selecting the default Terraform workspace..."
+          command_executor.run command: workspace_select_default, options: options do |standard_output:|
+          end
+          logger.warn "Finished selecting the default Terraform workspace."
+        end
+
+        def select_or_create_test_workspace
+          logger.warn "Selecting the #{workspace_name} Terraform workspace..."
+          command_executor.run command: workspace_select_test, options: options do |standard_output:|
+          end
+          logger.warn "Finished selecting the #{workspace_name} Terraform workspace."
+        rescue ::Kitchen::TransientFailure
+          create_test_workspace
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/terraform/error.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"
-
-# This class represents errors that occur while Kitchen-Terraform is executing.
-class ::Kitchen::Terraform::Error < ::StandardError
+module Kitchen
+  module Terraform
+    # Error is the class of objects which are raised Kitchen-Terraform experiences an error.
+    class Error < ::StandardError
+    end
+  end
 end

data/lib/kitchen/terraform/file_path_config_attribute_definer.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,35 +14,38 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "kitchen/terraform"
 require "kitchen/terraform/config_attribute_definer"
 
-# Defines a file path configuration attribute on a plugin class.
-class ::Kitchen::Terraform::FilePathConfigAttributeDefiner
-  # Defines the file path configuration attribute on a plugin class.
-  #
-  # @param plugin_class [::Kitchen::ConfigAttributeVerifier] A plugin class which has configuration
-  #   attribute verification behaviour.
-  # @return [void]
-  def define(plugin_class:)
-    @definer.define plugin_class: plugin_class
-    plugin_class.expand_path_for @attribute.to_sym
-  end
+module Kitchen
+  module Terraform
+    # FilePathConfigAttributeDefiner is the class of objects which define a file path configuration attribute on a
+    # plugin class.
+    class FilePathConfigAttributeDefiner
+      # #define defines the file path configuration attribute on a plugin class.
+      #
+      # @param plugin_class [Kitchen::ConfigAttributeVerifier] a plugin class which has configuration
+      #   attribute verification behaviour.
+      # @return [self]
+      def define(plugin_class:)
+        definer.define plugin_class: plugin_class
+        plugin_class.expand_path_for attribute.to_sym
+
+        self
+      end
+
+      # #initialize prepares a new instance of the class.
+      #
+      # @param attribute [Kitchen::Terraform::ConfigAttribute] an attribute to be defined on a plugin class.
+      # @param schema [Dry::Validation::Schema] a schema to use for validation of values of the attribute.
+      # @return [Kitchen::Terraform::FilePathConfigAttributeDefiner]
+      def initialize(attribute:, schema:)
+        self.attribute = attribute
+        self.definer = ::Kitchen::Terraform::ConfigAttributeDefiner.new attribute: attribute, schema: schema
+      end
 
-  private
+      private
 
-  # Initializes a definer.
-  #
-  # @api private
-  # @param attribute [::Kitchen::Terraform::ConfigAttribute] an attribute to be defined on a plugin class.
-  # @param schema [::Dry::Validation::Schema] a schema to use for validation of values of the attribute.
-  def initialize(attribute:, schema:)
-    @attribute = attribute
-    @definer =
-      ::Kitchen::Terraform::ConfigAttributeDefiner
-        .new(
-          attribute: attribute,
-          schema: schema,
-        )
+      attr_accessor :attribute, :definer
+    end
   end
 end

data/lib/kitchen/terraform/inspec.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,64 +14,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "inspec"
-require "kitchen/terraform/error"
-require "train"
-
 module Kitchen
   module Terraform
-    # InSpec is the class of objects which act as interfaces to InSpec.
-    class InSpec
-      class << self
-        # .logger= sets the logger for all InSpec processes.
-        #
-        # The logdev of the logger is extended to conform to interface expected by InSpec.
-        #
-        # @param logger [::Kitchen::Logger] the logger to use.
-        # @return [void]
-        def logger=(logger)
-          logger.logdev.define_singleton_method :filename do
-            false
-          end
-
-          ::Inspec::Log.logger = logger
-        end
-      end
-
-      # #exec executes InSpec.
-      #
-      # @raise [::Kitchen::Terraform::Error] if executing InSpec fails.
-      # @return [self]
-      def exec
-        @runner.run.tap do |exit_code|
-          if 0 != exit_code
-            raise ::Kitchen::Terraform::Error, "InSpec Runner exited with #{exit_code}"
-          end
-        end
-
-        self
-      rescue ::ArgumentError, ::RuntimeError, ::Train::UserError => error
-        raise ::Kitchen::Terraform::Error, "Executing InSpec failed\n#{error.message}"
-      end
-
-      # #info logs an information message using the InSpec logger.
-      #
-      # @param message [::String] the message to be logged.
-      # @return [self]
-      def info(message:)
-        ::Inspec::Log.info ::String.new message
-
-        self
-      end
-
-      private
-
-      def initialize(options:, profile_locations:)
-        @runner = ::Inspec::Runner.new options.merge logger: ::Inspec::Log.logger
-        profile_locations.each do |profile_location|
-          @runner.add_target profile_location
-        end
-      end
+    # InSpec is the namespace for the classes of objects which execute InSpec.
+    module InSpec
     end
   end
 end