kitchen-terraform 5.1.1 → 5.6.0

data/lib/kitchen/terraform/outputs_parser.rb

@@ -0,0 +1,39 @@
+# 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 "json"
+require "kitchen"
+
+module Kitchen
+  module Terraform
+    # OutputsParser parses Terraform output variables as JSON.
+    class OutputsParser
+      # #parse parses the outputs.
+      #
+      # @param json_outputs [String] the output variables as a string of JSON.
+      # @raise [Kitchen::TransientFailure] if parsing the output variables fails.
+      # @yieldparam parsed_outputs [Hash] the output variables as a hash.
+      # @return [self]
+      def parse(json_outputs:)
+        yield parsed_outputs: ::JSON.parse(json_outputs)
+
+        self
+      rescue ::JSON::ParserError
+        raise ::Kitchen::TransientFailure, "Parsing the Terraform output variables as JSON failed."
+      end
+    end
+  end
+end

data/lib/kitchen/terraform/outputs_reader.rb

@@ -0,0 +1,63 @@
+# 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
+    # OutputsReader is the class of objects which read Terraform output variables.
+    class OutputsReader
+      # #read reads the output variables.
+      #
+      # @param command [Kitchen::Terraform::Command::Output] the output command.
+      # @raise [Kitchen::TransientFailure] if running the output command fails.
+      # @yieldparam json_outputs [String] the output variables as a string of JSON.
+      # @return [self]
+      def read(command:, options:)
+        run command: command, options: options do |json_outputs:|
+          yield json_outputs: json_outputs
+        end
+
+        self
+      end
+
+      # #initialize prepares a new instance of the class.
+      #
+      # @param command_executor [Kitchen::Terraform::CommandExecutor] an executor to run the output command.
+      # @return [Kitchen::Terraform::OutputsReader]
+      def initialize(command_executor:)
+        self.command_executor = command_executor
+        self.no_outputs_defined = /no\\ outputs\\ defined/
+      end
+
+      private
+
+      attr_accessor :command_executor, :no_outputs_defined
+
+      def run(command:, options:)
+        command_executor.run command: command, options: options do |standard_output:|
+          yield json_outputs: standard_output
+        end
+      rescue ::Kitchen::TransientFailure => error
+        if no_outputs_defined.match ::Regexp.escape error.original.to_s
+          yield json_outputs: "{}"
+        else
+          raise error
+        end
+      end
+    end
+  end
+end

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

data/lib/kitchen/terraform/provisioner/converge.rb

@@ -0,0 +1,206 @@
+# 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/apply"
+require "kitchen/terraform/command/get"
+require "kitchen/terraform/command/output"
+require "kitchen/terraform/command/validate"
+require "kitchen/terraform/command/workspace_select"
+require "kitchen/terraform/debug_logger"
+require "kitchen/terraform/outputs_manager"
+require "kitchen/terraform/outputs_parser"
+require "kitchen/terraform/outputs_reader"
+require "kitchen/terraform/variables_manager"
+require "kitchen/terraform/verify_version"
+require "kitchen/terraform/version"
+
+module Kitchen
+  module Terraform
+    module Provisioner
+      # A Test Kitchen instance is converged through the following steps.
+      #
+      # ===== Selecting the Test Terraform Workspace
+      #
+      # {include:Kitchen::Terraform::Command::WorkspaceSelect}
+      #
+      # ===== Updating the Terraform Dependency Modules
+      #
+      # {include:Kitchen::Terraform::Command::Get}
+      #
+      # ===== Validating the Terraform Root Module
+      #
+      # {include:Kitchen::Terraform::Command::Validate}
+      #
+      # ===== Applying the Terraform State Changes
+      #
+      # {include:Kitchen::Terraform::Command::Apply}
+      #
+      # ===== Retrieving the Terraform Output
+      #
+      # {include:Kitchen::Terraform::Command::Output}
+      class Converge
+        # #call executes the action.
+        #
+        # @param state [Hash] the Kitchen instance state.
+        # @raise [Kitchen::TransientFailure] if a command fails.
+        # @return [self]
+        def call(state:)
+          verify_version.call command: version, options: options
+          execute_workflow
+          save_variables_and_outputs state: state
+
+          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::Converge]
+        def initialize(config:, logger:, version_requirement:, workspace_name:)
+          client = config.fetch :client
+          hash_config = config.to_hash.merge workspace_name: workspace_name
+          self.command_executor = ::Kitchen::Terraform::CommandExecutor.new(
+            client: 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.apply = ::Kitchen::Terraform::Command::Apply.new config: config
+          self.get = ::Kitchen::Terraform::Command::Get.new
+          self.output = ::Kitchen::Terraform::Command::Output.new
+          initialize_outputs_handlers client: client, logger: logger
+          self.validate = ::Kitchen::Terraform::Command::Validate.new config: config
+          self.workspace_select = ::Kitchen::Terraform::Command::WorkspaceSelect.new config: hash_config
+          self.variables = config.fetch :variables
+          self.variables_manager = ::Kitchen::Terraform::VariablesManager.new
+          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,
+          :apply,
+          :get,
+          :output,
+          :validate,
+          :workspace_select,
+          :logger,
+          :options,
+          :outputs_manager,
+          :outputs_parser,
+          :outputs_reader,
+          :variables,
+          :variables_manager,
+          :verify_version,
+          :version,
+          :workspace_name,
+        )
+
+        def build_infrastructure
+          logger.warn "Building the infrastructure based on the Terraform configuration..."
+          command_executor.run command: apply, options: options do |standard_output:|
+          end
+          logger.warn "Finished building the infrastructure based on the Terraform configuration."
+        end
+
+        def download_modules
+          logger.warn "Downloading the modules needed for the Terraform configuration..."
+          command_executor.run command: get, options: options do |standard_output:|
+          end
+          logger.warn "Finished downloading the modules needed for the Terraform configuration."
+        end
+
+        def execute_workflow
+          select_workspace
+          download_modules
+          validate_files
+          build_infrastructure
+        end
+
+        def initialize_outputs_handlers(client:, logger:)
+          self.outputs_manager = ::Kitchen::Terraform::OutputsManager.new
+          self.outputs_parser = ::Kitchen::Terraform::OutputsParser.new
+          self.outputs_reader = ::Kitchen::Terraform::OutputsReader.new(
+            command_executor: ::Kitchen::Terraform::CommandExecutor.new(
+              client: client,
+              logger: ::Kitchen::Terraform::DebugLogger.new(logger),
+            ),
+          )
+        end
+
+        def parse_outputs(json_outputs:)
+          logger.warn "Parsing the Terraform output variables as JSON..."
+          outputs_parser.parse json_outputs: json_outputs do |parsed_outputs:|
+            logger.warn "Finished parsing the Terraform output variables as JSON."
+
+            yield parsed_outputs: parsed_outputs
+          end
+        end
+
+        def read_and_parse_outputs(&block)
+          logger.warn "Reading the output variables from the Terraform state..."
+          outputs_reader.read command: output, options: options do |json_outputs:|
+            logger.warn "Finished reading the output variables from the Terraform state."
+
+            parse_outputs json_outputs: json_outputs, &block
+          end
+        end
+
+        def save_outputs(parsed_outputs:, state:)
+          logger.warn "Writing the output variables to the Kitchen instance state..."
+          outputs_manager.save outputs: parsed_outputs, state: state
+          logger.warn "Finished writing the output variables to the Kitchen instance state."
+        end
+
+        def save_variables_and_outputs(state:)
+          read_and_parse_outputs do |parsed_outputs:|
+            save_outputs parsed_outputs: parsed_outputs, state: state
+          end
+          logger.warn "Writing the input variables to the Kitchen instance state..."
+          variables_manager.save variables: variables, state: state
+          logger.warn "Finished writing the input variables to the Kitchen instance state."
+        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
+
+        def validate_files
+          logger.warn "Validating the Terraform configuration files..."
+          command_executor.run command: validate, options: options do |standard_output:|
+          end
+          logger.warn "Finished validating the Terraform configuration files."
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/terraform/raise.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
+    # Raise is the namespace for objects which raise errors.
+    module Raise
+    end
+  end
+end

data/lib/kitchen/terraform/raise/action_failed.rb

@@ -0,0 +1,49 @@
+# 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 Raise
+      # ActionFailed is the class of objects which handle errors resulting in failed actions.
+      class ActionFailed
+        # #call logs an error message and raises an error with the message.
+        #
+        # @param message [String] the error message.
+        # @raise [Kitchen::ActionFailed]
+        # @return [void]
+        def call(message:)
+          logger.error message
+
+          raise ::Kitchen::ActionFailed, message
+        end
+
+        # #initialize prepares a new instance of the class.
+        #
+        # @param logger [Kitchen::Logger] a logger to log messages.
+        # @return [Kitchen::Terraform::ActionFailed]
+        def initialize(logger:)
+          self.logger = logger
+        end
+
+        private
+
+        attr_accessor :logger
+      end
+    end
+  end
+end

data/lib/kitchen/terraform/raise/client_error.rb

@@ -0,0 +1,49 @@
+# 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 Raise
+      # ClientError is the class of objects which handle errors that are caused by incorrect use of an API.
+      class ClientError
+        # #call logs an error message and raises an error with the message.
+        #
+        # @param message [String] the error message.
+        # @raise [Kitchen::ClientError]
+        # @return [void]
+        def call(message:)
+          logger.error message
+
+          raise ::Kitchen::ClientError, message
+        end
+
+        # #initialize prepares a new instance of the class.
+        #
+        # @param logger [Kitchen::Logger] a logger to log messages.
+        # @return [Kitchen::Terraform::ClientError]
+        def initialize(logger:)
+          self.logger = logger
+        end
+
+        private
+
+        attr_accessor :logger
+      end
+    end
+  end
+end