kitchen-terraform 0.7.0 → 1.0.0

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# Copyright 2016 New Context Services, 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 "dry/monads"
+require "kitchen/driver/terraform"
+
+# Verifies that the provided Terraform Client version is supported.
+#
+# Supported:: Terraform version 0.9.
+#
+# Deprecated:: Terraform versions 0.7 and 0.8.
+#
+# Not Supported:: Terraform versions 0.6 and older.
+module ::Kitchen::Driver::Terraform::VerifyClientVersion
+  extend ::Dry::Monads::Either::Mixin
+
+  # Invokes the function.
+  #
+  # @param version [::Float] the Terraform Client version.
+  # @return [::Dry::Monads::Either] the result of the function.
+  def self.call(version:)
+    if version == 0.9
+      Right "Terraform version #{version} is supported"
+    elsif (0.7..0.8).cover? version
+      Right "Terraform version #{version} is deprecated and will not be supported by kitchen-terraform version " \
+              "2.0; upgrade to Terraform version 0.9 to remain supported"
+    else
+      Left "Terraform version #{version} is not supported; supported Terraform versions are 0.7 through 0.9"
+    end
+  end
+end

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

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+# Copyright 2016 New Context Services, 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 "dry/monads"
+require "kitchen/driver/terraform"
+require "kitchen/terraform/client/apply"
+require "kitchen/terraform/client/get"
+require "kitchen/terraform/client/validate"
+require "kitchen/terraform/create_directories"
+
+# Creates the directories to contain the root Terraform module, the Terraform execution plan, and the Terraform state,
+# then validates the Terraform configuration, updates any Terraform dependencies, and applies a constructive or
+# destructive Terraform execution plan to the Terraform state.
+module ::Kitchen::Driver::Terraform::Workflow
+  extend ::Dry::Monads::Either::Mixin
+
+  # Invokes the function.
+  #
+  # @param config [::Kitchen::Config] the configuration of the kitchen-terraform driver.
+  # @param destroy [::TrueClass, ::FalseClass] the flag that controls constructive or destructive planning.
+  # @param logger [#<<] a logger to receive the execution output of the Terraform Client functions.
+  # @return [::Dry::Monads::Either] the result of the function.
+  # @see ::Kitchen::Terraform::Client::Apply
+  # @see ::Kitchen::Terraform::Client::Get
+  # @see ::Kitchen::Terraform::Client::Plan
+  # @see ::Kitchen::Terraform::Client::Validate
+  # @see ::Kitchen::Terraform::CreateDirectories
+  def self.call(config:, destroy: false, logger:)
+    ::Kitchen::Terraform::CreateDirectories.call(
+      directories: [
+        config.fetch(:directory),
+        ::File.dirname(config.fetch(:plan)),
+        ::File.dirname(config.fetch(:state))
+      ]
+    ).fmap do |created_directories|
+      logger.debug created_directories
+    end.bind do
+      ::Kitchen::Terraform::Client::Validate.call cli: config.fetch(:cli),
+                                                  directory: config.fetch(:directory),
+                                                  logger: logger,
+                                                  timeout: config.fetch(:command_timeout)
+    end.bind do
+      ::Kitchen::Terraform::Client::Get.call cli: config.fetch(:cli),
+                                             logger: logger,
+                                             root_module: config.fetch(:directory),
+                                             timeout: config.fetch(:command_timeout)
+    end.bind do
+      ::Kitchen::Terraform::Client::Plan.call cli: config.fetch(:cli),
+                                              logger: logger,
+                                              options: {
+                                                color: config.fetch(:color),
+                                                destroy: destroy,
+                                                out: config.fetch(:plan),
+                                                parallelism: config.fetch(:parallelism),
+                                                state: config.fetch(:state),
+                                                var: config.fetch(:variables),
+                                                var_file: config.fetch(:variable_files)
+                                              },
+                                              root_module: config.fetch(:directory),
+                                              timeout: config.fetch(:command_timeout)
+    end.bind do
+      ::Kitchen::Terraform::Client::Apply.call cli: config.fetch(:cli),
+                                               logger: logger,
+                                               options: {
+                                                 color: config.fetch(:color),
+                                                 parallelism: config.fetch(:parallelism),
+                                                 state_out: config.fetch(:state)
+                                               },
+                                               plan: config.fetch(:plan),
+                                               timeout: config.fetch(:command_timeout)
+    end.fmap do
+      "driver workflow was a success"
+    end.or do |error|
+      Left "driver workflow was a failure\n#{error}"
+    end
+  end
+end

data/lib/kitchen/provisioner/terraform.rb

@@ -14,43 +14,37 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'kitchen'
-require 'terraform/apply_timeout_config'
-require 'terraform/color_config'
-require 'terraform/configurable'
-require 'terraform/directory_config'
-require 'terraform/file_configs'
-require 'terraform/parallelism_config'
-require 'terraform/variable_files_config'
-require 'terraform/variables_config'
+require "kitchen"
+require "terraform/configurable"
 
-module Kitchen
-  module Provisioner
-    # Applies constructive Terraform plans
-    class Terraform < ::Kitchen::Provisioner::Base
-      extend ::Terraform::ApplyTimeoutConfig
-
-      extend ::Terraform::ColorConfig
-
-      extend ::Terraform::DirectoryConfig
-
-      extend ::Terraform::FileConfigs
-
-      extend ::Terraform::ParallelismConfig
-
-      extend ::Terraform::VariableFilesConfig
-
-      extend ::Terraform::VariablesConfig
-
-      include ::Terraform::Configurable
-
-      kitchen_provisioner_api_version 2
-
-      def call(_state = nil)
-        client.apply_constructively
-      rescue ::Kitchen::StandardError, ::SystemCallError => error
-        raise ::Kitchen::ActionFailed, error.message
-      end
-    end
+# The design of the provisioner is unconventional compared to other Test Kitchen provisioner plugins. Since Terraform
+# creates and provisions resources when applying an execution plan, managed by the driver, the provisioner simply
+# proxies the driver's create action to apply any changes to the existing Terraform state.
+#
+# === Configuration
+#
+# ==== Example .kitchen.yml snippet
+#
+#   provisioner:
+#     name: terraform
+#
+# @see ::Kitchen::Driver::Terraform
+# @see https://www.terraform.io/docs/commands/plan.html Terraform execution plan
+# @see https://www.terraform.io/docs/state/index.html Terraform state
+# @version 2
+class ::Kitchen::Provisioner::Terraform < ::Kitchen::Provisioner::Base
+  kitchen_provisioner_api_version 2
+
+  include ::Terraform::Configurable
+
+  # Proxies the driver's create action.
+  #
+  # @example
+  #   `kitchen converge suite-name`
+  # @param state [::Hash] the mutable instance and provisioner state.
+  # @raise [::Kitchen::ActionFailed] if the result of the action is a failure.
+  # @return [::Dry::Monads::Either] the result of the action.
+  def call(state)
+    instance.driver.create state
   end
 end

data/lib/{terraform/get_command.rb → kitchen/terraform.rb}

@@ -14,10 +14,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'terraform/command'
+require "kitchen"
 
-module Terraform
-  # A command to get dependency modules
-  class GetCommand < ::Terraform::Command
-  end
+# The namespace for kitchen-terraform.
+module ::Kitchen::Terraform
 end

data/lib/{terraform/deprecated_version.rb → kitchen/terraform/client.rb}

@@ -14,17 +14,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'delegate'
+require "kitchen/terraform"
 
-module Terraform
-  # A deprecated version of Terraform
-  class DeprecatedVersion < ::SimpleDelegator
-    def if_deprecated
-      yield
-    end
-
-    def if_json_not_supported
-      yield
-    end
-  end
+# The namespace for functions that wrap the Terraform command-line interface (CLI) commands.
+#
+# @see https://www.terraform.io/docs/commands/index.html Terraform CLI
+module ::Kitchen::Terraform::Client
 end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# Copyright 2016 New Context Services, 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/client"
+require "kitchen/terraform/client/execute_command"
+
+# Applies the the pre-determined set of actions generated by a Terraform execution plan.
+#
+# @see https://www.terraform.io/docs/commands/apply.html Terraform apply command
+# @see https://www.terraform.io/docs/commands/plan.html Terraform plan command
+module ::Kitchen::Terraform::Client::Apply
+  # Invokes the function.
+  #
+  # @param cli [::String] the path of the Terraform CLI to use to execute the apply command.
+  # @param logger [#<<] a logger to receive the stdout and stderr of the apply command.
+  # @param options [::Hash] the options for the apply command.
+  # @param plan [::String] the path of the Terraform execution plan to apply.
+  # @param timeout [::Integer] the maximum execution time in seconds for the apply command.
+  # @return [::Dry::Monads::Either] the result of the function.
+  def self.call(cli:, logger:, options:, plan:, timeout:)
+    ::Kitchen::Terraform::Client::ExecuteCommand.call cli: cli, command: "apply", logger: logger,
+                                                      options: options.merge(input: false), target: plan,
+                                                      timeout: timeout
+  end
+end

data/lib/kitchen/terraform/client/execute_command.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+# Copyright 2016 New Context Services, 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 "dry/monads"
+require "kitchen/terraform/client"
+require "kitchen/terraform/client/process_options"
+require "mixlib/shellout"
+
+# Executes Terraform commands.
+#
+# @see https://www.terraform.io/docs/commands/index.html Terraform commands
+module ::Kitchen::Terraform::Client::ExecuteCommand
+  extend ::Dry::Monads::Either::Mixin
+
+  extend ::Dry::Monads::Try::Mixin
+
+  # Invokes the function.
+  #
+  # @param cli [::String] the path of the Terraform CLI to use for command execution.
+  # @param command [::String] the name of the command to execute.
+  # @param logger [#<<] a logger to receive the stdout and stderr of the command.
+  # @param options [::Hash] the options for the command.
+  # @param target [::String] the target of the command.
+  # @param timeout [::Integer] the maximum execution time in seconds for the command.
+  # @return [::Dry::Monads::Either] the result of the function.
+  def self.call(cli:, command:, logger:, options: {}, target: "", timeout:)
+    ::Kitchen::Terraform::Client::ProcessOptions.call(unprocessed_options: options).fmap do |processed_options|
+      ::Mixlib::ShellOut.new [cli, command, *processed_options, target].join(" ").strip,
+                             live_stream: logger, timeout: timeout
+    end.bind do |shell_out|
+      Try ::Errno::EACCES, ::Errno::ENOENT, ::Mixlib::ShellOut::CommandTimeout do
+        shell_out.run_command
+      end
+    end.bind do |shell_out|
+      Try ::Mixlib::ShellOut::ShellCommandFailed do
+        shell_out.error!
+        shell_out
+      end
+    end.to_either.fmap(&:stdout).or do |error|
+      Left "`#{cli} #{command} #{target}` failed: '#{error}'"
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# Copyright 2016 New Context Services, 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/client"
+require "kitchen/terraform/client/execute_command"
+
+# Downloads and updates modules mentioned in the root Terraform module.
+#
+# @see https://www.terraform.io/docs/commands/get.html Terraform get command
+module ::Kitchen::Terraform::Client::Get
+  # Invokes the function.
+  #
+  # @param cli [::String] the path of the Terraform CLI to use to execute the get command.
+  # @param logger [#<<] a logger to receive the stdour and stderr of the get command.
+  # @param root_module [::String] the path of the root module.
+  # @param timeout [::Integer] the maximum execution time in seconds for the get command.
+  # @return [::Dry::Monads::Either] the result of the function.
+  def self.call(cli:, logger:, root_module:, timeout:)
+    ::Kitchen::Terraform::Client::ExecuteCommand.call cli: cli, command: "get", logger: logger, options: {update: true},
+                                                      target: root_module, timeout: timeout
+  end
+end

data/lib/kitchen/terraform/client/output.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# Copyright 2016 New Context Services, 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 "dry/monads"
+require "json"
+require "kitchen/terraform/client"
+require "kitchen/terraform/client/execute_command"
+
+# Extracts the values of Terraform output variables from a Terraform state.
+#
+# @see https://www.terraform.io/docs/commands/output.html Terraform output command
+# @see https://www.terraform.io/docs/configuration/outputs.html Terraform output variables
+# @see https://www.terraform.io/docs/state/index.html Terraform state
+module ::Kitchen::Terraform::Client::Output
+  extend ::Dry::Monads::Either::Mixin
+
+  extend ::Dry::Monads::Try::Mixin
+
+  # Invokes the function.
+  #
+  # @param cli [::String] the path of the Terraform CLI to use to execute the output command.
+  # @param logger [#<<] a logger to receive the stdout and stderr of the output command.
+  # @param options [::Hash] the options for the output command.
+  # @param timeout [::Integer] the maximum execution time in seconds for the output command.
+  # @return [::Dry::Monads::Either] the result of the function.
+  def self.call(cli:, logger:, options:, timeout:)
+    ::Kitchen::Terraform::Client::ExecuteCommand
+      .call(cli: cli, command: "output", logger: logger, options: options.merge(json: true), timeout: timeout)
+      .bind do |output|
+        Try ::JSON::ParserError do
+          ::JSON.parse output
+        end
+      end.to_either.or do |error|
+        Left "parsing Terraform client output as JSON failed\n#{error}"
+      end
+  end
+end

data/lib/kitchen/terraform/client/plan.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# Copyright 2016 New Context Services, 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/client"
+require "kitchen/terraform/client/execute_command"
+
+# Creates a Terraform execution plan.
+#
+# @see https://www.terraform.io/docs/commands/plan.html Terraform plan command
+module ::Kitchen::Terraform::Client::Plan
+  # Invokes the function.
+  #
+  # @param cli [::String] the path of the Terraform CLI to use to execute the plan command.
+  # @param logger [#<<] a logger to receive the stdout and stderr of the plan command.
+  # @param options [::Hash] the options for the plan command.
+  # @param root_module [::String] the path of the root Terraform module.
+  # @param timeout [::Integer] the maximum execution time in seconds for the plan command.
+  # @return [::Dry::Monads::Either] the result of the function.
+  def self.call(cli:, logger:, options:, root_module:, timeout:)
+    ::Kitchen::Terraform::Client::ExecuteCommand.call cli: cli,
+                                                      command: "plan",
+                                                      logger: logger,
+                                                      options: options.merge(
+                                                        input: false
+                                                      ),
+                                                      target: root_module,
+                                                      timeout: timeout
+  end
+end