kitchen-terraform 1.0.2 → 2.0.0

data/lib/kitchen/provisioner/terraform.rb

@@ -15,7 +15,7 @@
 # limitations under the License.
 
 require "kitchen"
-require "terraform/configurable"
+require "kitchen/terraform/configurable"
 
 # 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
@@ -35,7 +35,7 @@ require "terraform/configurable"
 class ::Kitchen::Provisioner::Terraform < ::Kitchen::Provisioner::Base
   kitchen_provisioner_api_version 2
 
-  include ::Terraform::Configurable
+  include ::Kitchen::Terraform::Configurable
 
   # Proxies the driver's create action.
   #
@@ -43,7 +43,6 @@ class ::Kitchen::Provisioner::Terraform < ::Kitchen::Provisioner::Base
   #   `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

data/lib/kitchen/terraform.rb

@@ -14,7 +14,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "kitchen"
+# 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

data/lib/kitchen/terraform/clear_directory.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 "dry/monads"
+require "fileutils"
+require "kitchen/terraform"
+
+# Clears a directory on the filesystem of specified files.
+module ::Kitchen::Terraform::ClearDirectory
+  extend ::Dry::Monads::Either::Mixin
+
+  # Invokes the function.
+  #
+  # @param directory ::String the path of the directory to clear.
+  # @param files [::Array<::String>, ::String] a list of files to clear from the directory.
+  # @return [::Dry::Monads::Either] the result of the function.
+  def self.call(directory:, files:)
+    ::FileUtils.safe_unlink(
+      files.map do |file|
+        ::Dir.glob ::File.join directory, file
+      end.flatten
+    )
+    Right "Cleared directory \"#{directory}\" of files #{files}"
+  end
+end

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

@@ -0,0 +1,168 @@
+# 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 "mixlib/shellout"
+require "kitchen/terraform/client/options"
+
+# Represents the result of running a Terraform command.
+#
+# @see https://www.terraform.io/docs/commands/index.html Terraform commands
+module ::Kitchen::Terraform::Client::Command
+  extend ::Dry::Monads::Either::Mixin
+
+  extend ::Dry::Monads::Try::Mixin
+
+  # Creates the apply command shell out.
+  #
+  # @param options [::Kitchen::Terraform::Client::Options] options for the command.
+  # @param working_directory[::String] the path to the directory in which to run the shell out.
+  # @return [::Dry::Monads::Either] the result of creating the shell out.
+  # @see https://www.terraform.io/docs/commands/apply.html Terraform Command: apply
+  def self.apply(options:, working_directory:)
+    create(
+      options: options,
+      subcommand: "apply",
+      working_directory: working_directory
+    )
+  end
+
+  #
+  # Creates the destroy command shell out.
+  #
+  # @param options [::Kitchen::Terraform::Client::Options] options for the command.
+  # @param working_directory[::String] the path to the directory in which to run the shell out.
+  # @return [::Dry::Monads::Either] the result of creating the shell out.
+  # @see https://www.terraform.io/docs/commands/destroy.html Terraform Command: destroy
+  def self.destroy(options:, working_directory:)
+    create(
+      options: options,
+      subcommand: "destroy",
+      working_directory: working_directory
+    )
+  end
+
+  # Creates the init command shell out.
+  #
+  # @param options [::Kitchen::Terraform::Client::Options] options for the command.
+  # @param working_directory[::String] the path to the directory in which to run the shell out.
+  # @return [::Dry::Monads::Either] the result of creating the shell out.
+  # @see https://www.terraform.io/docs/commands/destroy.html Terraform Command: init
+  def self.init(options:, working_directory:)
+    create(
+      options: options,
+      subcommand: "init",
+      working_directory: working_directory
+    )
+  end
+
+  # Creates the output command shell out.
+  #
+  # @param options [::Kitchen::Terraform::Client::Options] options for the command.
+  # @param working_directory[::String] the path to the directory in which to run the shell out.
+  # @return [::Dry::Monads::Either] the result of creating the shell out.
+  # @see https://www.terraform.io/docs/commands/destroy.html Terraform Command: output
+  def self.output(options:, working_directory:)
+    create(
+      options: options,
+      subcommand: "output",
+      working_directory: working_directory
+    )
+  end
+
+  # Runs a command shell out.
+  #
+  # @param logger [::Kitchen::Logger, ::Terraform::DebugLogger] a logger to capture the run output of the command.
+  # @param shell_out [::Mixlib::ShellOut] the shell out to run.
+  # @param timeout [::Integer] the number of seconds to wait for the command to finish.
+  # @return [::Dry::Monads::Either] the result of running the shell out.
+  def self.run(logger:, shell_out:, timeout:)
+    try_to_run(
+      logger: logger,
+      shell_out: shell_out,
+      timeout: timeout
+    )
+      .bind do
+        Right shell_out.stdout
+      end
+      .or do |error|
+        Left error.to_s
+      end
+  end
+
+  # Creates the validate command shell out.
+  #
+  # @param options [::Kitchen::Terraform::Client::Options] options for the command.
+  # @param working_directory[::String] the path to the directory in which to run the shell out.
+  # @return [::Dry::Monads::Either] the result of creating the shell out.
+  # @see https://www.terraform.io/docs/commands/destroy.html Terraform Command: validate
+  def self.validate(options:, working_directory:)
+    create(
+      options: options,
+      subcommand: "validate",
+      working_directory: working_directory
+    )
+  end
+
+  # Creates the version command shell out.
+  #
+  # @param options [::Kitchen::Terraform::Client::Options] options for the command.
+  # @param working_directory[::String] the path to the directory in which to run the shell out.
+  # @return [::Dry::Monads::Either] the result of creating the shell out.
+  # @see https://www.terraform.io/docs/commands/destroy.html Terraform Command: version
+  def self.version(options: ::Kitchen::Terraform::Client::Options, working_directory:)
+    create(
+      options: options,
+      subcommand: "version",
+      working_directory: working_directory
+    )
+  end
+
+  private_class_method
+
+  # @api private
+  # @param options [::Kitchen::Terraform::Client::Options] options for the command.
+  # @param subcommand [::String] the subcommand to run through shell out.
+  # @param working_directory [::String] the path to the directory in which to run the shell out.
+  def self.create(options:, subcommand:, working_directory:)
+    Try ::Mixlib::ShellOut::InvalidCommandOption do
+      ::Mixlib::ShellOut.new(
+        "terraform #{subcommand} #{options}".strip,
+        cwd: working_directory
+      )
+    end
+      .to_either
+      .or do |error|
+        Left "Failed to create `terraform #{subcommand}`: #{error}"
+      end
+  end
+
+  def self.try_to_run(logger:, shell_out:, timeout:)
+    Try(
+      ::Errno::EACCES,
+      ::Errno::ENOENT,
+      ::Mixlib::ShellOut::CommandTimeout,
+      ::Mixlib::ShellOut::ShellCommandFailed
+    ) do
+      shell_out.live_stream = logger
+      shell_out.timeout = timeout
+      shell_out.run_command
+      shell_out.error!
+    end
+      .to_either
+  end
+end

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

@@ -0,0 +1,275 @@
+# 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"
+
+# Represents supported options for client commands.
+class ::Kitchen::Terraform::Client::Options
+  # Adds -backend-config with arguments to the options.
+  #
+  # @param key [#to_s] the backend configuration key
+  # @param value [#to_s] the backend configuration value
+  # @return [::Kitchen::Terraform::Client::Options] the expanded options
+  def backend_config(key:, value:)
+    add option: "-backend-config='#{key}=#{value}'"
+  end
+
+  # Adds -backend-config with arguments to the options multiple times.
+  #
+  # @param keys_and_values [::Hash<#to_s, #to_s>] the backend configuration keys and values
+  # @return [::Kitchen::Terraform::Client::Options] the expanded options
+  def backend_configs(keys_and_values:)
+    keys_and_values
+      .inject self do |additional_options, (key, value)|
+        additional_options
+          .backend_config(
+            key: key,
+            value: value
+          )
+      end
+  end
+
+  # Adds -input=false to the options.
+  #
+  # @return [::Kitchen::Terraform::Client::Options] the expanded options
+  def disable_input
+    add option: "-input=false"
+  end
+
+  # Adds -auto-approve=true to the options.
+  #
+  # @return [::Kitchen::Terraform::Client::Options] the expanded options
+  def enable_auto_approve
+    add option: "-auto-approve=true"
+  end
+
+  # Adds -backend=true to the options.
+  #
+  # @return [::Kitchen::Terraform::Client::Options] the expanded options
+  def enable_backend
+    add option: "-backend=true"
+  end
+
+  # Adds -check-variables=true to the options.
+  #
+  # @return [::Kitchen::Terraform::Client::Options] the expanded options
+  def enable_check_variables
+    add option: "-check-variables=true"
+  end
+
+  # Adds -get=true to the options.
+  #
+  # @return [::Kitchen::Terraform::Client::Options] the expanded options
+  def enable_get
+    add option: "-get=true"
+  end
+
+  # Adds -force to the options.
+  #
+  # @return [::Kitchen::Terraform::Client::Options] the expanded options
+  def force
+    add option: "-force"
+  end
+
+  # Adds -force-copy to the options.
+  #
+  # @return [::Kitchen::Terraform::Client::Options] the expanded options
+  def force_copy
+    add option: "-force-copy"
+  end
+
+  # Adds -from-module with an argument to the options.
+  #
+  # @param source [#to_s] the module source
+  # @return [::Kitchen::Terraform::Client::Options] the expanded options
+  def from_module(source:)
+    add option: "-from-module=#{source}"
+  end
+
+  # Adds -json to the options.
+  #
+  # @return [::Kitchen::Terraform::Client::Options] the expanded options
+  def json
+    add option: "-json"
+  end
+
+  # Adds -lock=true to the options.
+  #
+  # @return [::Kitchen::Terraform::Client::Options] the expanded options
+  def enable_lock
+    add option: "-lock=true"
+  end
+
+  # Adds -refresh=true to the options.
+  #
+  # @return [::Kitchen::Terraform::Client::Options] the expanded options
+  def enable_refresh
+    add option: "-refresh=true"
+  end
+
+  # Adds -lock-timeout with an argument to the options.
+  #
+  # @param duration [#to_s] the lock timeout duration
+  # @return [::Kitchen::Terraform::Client::Options] the expanded options
+  def lock_timeout(duration:)
+    add option: "-lock-timeout=#{duration}"
+  end
+
+  # Conditionally adds -no-color to the options.
+  #
+  # @param toggle [::TrueClass, ::FalseClass] the flag toggle
+  # @return [::Kitchen::Terraform::Client::Options] the expanded options
+  def maybe_no_color(toggle:)
+    toggle and no_color or self
+  end
+
+  # Conditionally adds -plugin-dir to the options.
+  #
+  # @param path [::TrueClass, ::FalseClass] the path to the plugin directory
+  # @return [::Kitchen::Terraform::Client::Options] the expanded options
+  def maybe_plugin_dir(path:)
+    path and plugin_dir path: path or self
+  end
+
+  # Adds -no-color to the options.
+  #
+  # @return [::Kitchen::Terraform::Client::Options] the expanded options
+  def no_color
+    add option: "-no-color"
+  end
+
+  # Adds -parallelism with an argument to the options.
+  #
+  # @param concurrent_operations [#to_s] the number of concurrent operations
+  # @return [::Kitchen::Terraform::Client::Options] the expanded options
+  def parallelism(concurrent_operations:)
+    add option: "-parallelism=#{concurrent_operations}"
+  end
+
+  # Adds -plugin-dir with an argument to the options.
+  #
+  # @param path [#to_s] the path to the plugin directory
+  # @return [::Kitchen::Terraform::Client::Options] the expanded options
+  def plugin_dir(path:)
+    add option: "-plugin-dir=#{path}"
+  end
+
+  # Adds -state with an argument to the options.
+  #
+  # @param path [#to_s] the path to the input state file
+  # @return [::Kitchen::Terraform::Client::Options] the expanded options
+  def state(path:)
+    add option: "-state=#{path}"
+  end
+
+  # Adds -state-out with an argument to the options.
+  #
+  # @param path [#to_s] the path to the output state file
+  # @return [::Kitchen::Terraform::Client::Options] the expanded options
+  def state_out(path:)
+    add option: "-state-out=#{path}"
+  end
+
+  # Adds -upgrade to the options.
+  #
+  # @return [::Kitchen::Terraform::Client::Options] the expanded options
+  def upgrade
+    add option: "-upgrade"
+  end
+
+  # Adds -var with arguments to the options.
+  #
+  # @param key [#to_s] the variable key
+  # @param value [#to_s] the variable value
+  # @return [::Kitchen::Terraform::Client::Options] the expanded options
+  def var(key:, value:)
+    add option: "-var='#{key}=#{value}'"
+  end
+
+  # Adds -var with arguments to the options multiple times.
+  #
+  # @param keys_and_values [::Hash<#to_s, #to_s>] the variable keys and values
+  # @return [::Kitchen::Terraform::Client::Options] the expanded options
+  def vars(keys_and_values:)
+    keys_and_values
+      .inject self do |additional_options, (key, value)|
+        additional_options
+          .var(
+            key: key,
+            value: value
+          )
+      end
+  end
+
+  # Adds -var-file with an argument to the options.
+  #
+  # @param path [#to_s] the path to the variable file
+  # @return [::Kitchen::Terraform::Client::Options] the expanded options
+  def var_file(path:)
+    add option: "-var-file=#{path}"
+  end
+
+  # Adds -var-file with an argument to the options multiple times.
+  #
+  # @param paths [::Array<#to_s>] the paths to the variable files
+  # @return [::Kitchen::Terraform::Client::Options] the expanded options
+  def var_files(paths:)
+    paths
+      .inject self do |additional_options, path|
+        additional_options.var_file path: path
+      end
+  end
+
+  # Adds -verify-plugins with an argument to the options.
+  #
+  # @param toggle [#to_s] toggle to enable or disable
+  # @return [::Kitchen::Terraform::Client::Options] the expanded options
+  def verify_plugins(toggle:)
+    add option: "-verify-plugins=#{toggle}"
+  end
+
+  # The options expressed as a space delimited string.
+  #
+  # @return [::String] the options string
+  def to_s
+    @options.join " "
+  end
+
+  private
+
+  # Adds an option to the collection.
+  #
+  # @api private
+  # @param option [::String] the option to be added
+  # @return [::Kitchen::Terraform::Client::Options] the expanded options
+  def add(option:)
+    self
+      .class
+      .new(
+        option: option,
+        options: @options
+      )
+  end
+
+  # Initializes the collection of options.
+  #
+  # @api private
+  # @param option [::String] a new option to add to the collection.
+  # @param options [::Array] the current collection
+  def initialize(option: nil, options: [])
+    @options = options + [option].compact
+  end
+end