kitchen-terraform 1.0.2 → 2.0.0

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

@@ -1,90 +0,0 @@
-# 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/terraform/client/apply.rb

@@ -1,38 +0,0 @@
-# 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

@@ -1,56 +0,0 @@
-# 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

@@ -1,35 +0,0 @@
-# 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

@@ -1,50 +0,0 @@
-# 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

@@ -1,42 +0,0 @@
-# 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

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

@@ -1,87 +0,0 @@
-# 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"
-
-# Processes Terraform Client function options in to Terraform Command-Line Interface (CLI) flags.
-#
-# @see https://www.terraform.io/docs/commands/index.html Terraform commands
-module ::Kitchen::Terraform::Client::ProcessOptions
-  extend ::Dry::Monads::Either::Mixin
-  extend ::Dry::Monads::Maybe::Mixin
-  extend ::Dry::Monads::List::Mixin
-  extend ::Dry::Monads::Try::Mixin
-
-  OPTIONS_FLAGS = {
-    color: lambda do |value:|
-      "-no-color" if not value
-    end,
-    destroy: lambda do |value:|
-      "-destroy" if value
-    end,
-    input: lambda do |value:|
-      "-input=#{value}"
-    end,
-    json: lambda do |value:|
-      "-json" if value
-    end,
-    out: lambda do |value:|
-      "-out=#{value}"
-    end,
-    parallelism: lambda do |value:|
-      "-parallelism=#{value}"
-    end,
-    state: lambda do |value:|
-      "-state=#{value}"
-    end,
-    state_out: lambda do |value:|
-      "-state-out=#{value}"
-    end,
-    update: lambda do |value:|
-      "-update" if value
-    end,
-    var: lambda do |value:|
-      value.map do |variable_name, variable_value|
-        "-var='#{variable_name}=#{variable_value}'"
-      end
-    end,
-    var_file: lambda do |value:|
-      value.map do |file|
-        "-var-file=#{file}"
-      end
-    end
-  }.freeze
-
-  # Invokes the function.
-  #
-  # @param unprocessed_options [::Hash{::Symbol => TrueClass, FalseClass, #to_s, #map}] underscore delimited option keys
-  #        associated with their values.
-  # @return [::Dry::Monads::Either] the result of the function.
-  def self.call(unprocessed_options:)
-    List(unprocessed_options.to_a).fmap(&method(:Right)).typed(::Dry::Monads::Either).traverse do |member|
-      member.bind do |key, value|
-        Maybe(::Kitchen::Terraform::Client::ProcessOptions::OPTIONS_FLAGS[key]).bind do |processor|
-          Right processor.call value: value
-        end.or do
-          Left ":#{key} is not a supported Terraform Client option"
-        end
-      end
-    end.fmap do |options|
-      options.value.flatten.compact.sort
-    end
-  end
-end

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

@@ -1,35 +0,0 @@
-# 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"
-
-# Validates the syntax of Terraform configuration files.
-#
-# @see https://www.terraform.io/docs/commands/validate.html Terraform validate command
-module ::Kitchen::Terraform::Client::Validate
-  # Invokes the function.
-  #
-  # @param cli [::String] the path of the Terraform CLI to use to execute the validate command.
-  # @param directory [::String] the directory containing files to validate.
-  # @param logger [#<<] a logger to receive the stdout and stderr of the validate command.
-  # @param timeout [::Integer] the maximum execution time in seconds for the validate command.
-  # @return [::Dry::Monads::Either] the result of the function.
-  def self.call(cli:, directory:, logger:, timeout:)
-    ::Kitchen::Terraform::Client::ExecuteCommand.call cli: cli, command: "validate", logger: logger, target: directory,
-                                                      timeout: timeout
-  end
-end

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

@@ -1,48 +0,0 @@
-# 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/execute_command"
-
-# Retrieves the version of the Terraform Command-Line Interface (CLI).
-#
-# @see https://www.terraform.io/docs/commands/index.html Terraform commands
-module ::Kitchen::Terraform::Client::Version
-  extend ::Dry::Monads::Either::Mixin
-
-  extend ::Dry::Monads::Maybe::Mixin
-
-  # Invokes the function.
-  #
-  # @param cli [::String] the path of the Terraform CLI to use to execute the version command.
-  # @param logger [#<<] a logger to receive the stdout and stderr of the version command.
-  # @param timeout [::Integer] the time in seconds to wait for the version command to finish.
-  # @return [::Dry::Monads::Either] the result of the function.
-  def self.call(cli:, logger:, timeout:)
-    ::Kitchen::Terraform::Client::ExecuteCommand
-      .call(cli: cli, command: "version", logger: logger, timeout: timeout)
-      .bind do |output|
-        Maybe output.slice /v(\d+\.\d+)/, 1
-      end.bind do |major_minor_versions|
-        Right Float major_minor_versions
-      end.or do |error|
-        error.nil? and Left "Terraform client version output did not match 'vX.Y'" or Left error
-      end.or do |error|
-        Left "Unable to parse Terraform client version output\n#{error}"
-      end
-  end
-end