kitchen-terraform 2.1.0 → 3.0.0

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

@@ -1,275 +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"
-
-# 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

data/lib/kitchen/terraform/config_attribute/state.rb

@@ -1,55 +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/config_attribute"
-require "kitchen/terraform/config_attribute_cacher"
-require "kitchen/terraform/config_schemas/string"
-require "kitchen/terraform/file_path_config_attribute_definer"
-
-# The +:state+ configuration attribute is an optianl string which contains the path to the Terraform state file which
-# will be generated and managed.
-#
-# @abstract It must be included by a plugin class in order to be used.
-# @see https://www.terraform.io/docs/commands/apply.html#state-path Terraform: Command: apply: -state-path
-# @see https://www.terraform.io/docs/state/index.html Terraform: State
-module ::Kitchen::Terraform::ConfigAttribute::State
-  # A callback to define the configuration attribute which is invoked when this module is included in a plugin class.
-  #
-  # @param plugin_class [::Kitchen::Configurable] A plugin class.
-  # @return [void]
-  def self.included(plugin_class)
-    ::Kitchen::Terraform::FilePathConfigAttributeDefiner
-      .new(
-        attribute: self,
-        schema: ::Kitchen::Terraform::ConfigSchemas::String
-      )
-      .define plugin_class: plugin_class
-  end
-
-  # @return [::Symbol] the symbol corresponding to this attribute.
-  def self.to_sym
-    :state
-  end
-
-  extend ::Kitchen::Terraform::ConfigAttributeCacher
-
-  # The path to a file under the kitchen-terraform suite directory.
-  #
-  # @return [::String] +".kitchen/kitchen-terraform/<suite_name>/terraform.tfstate"+.
-  def config_state_default_value
-    instance_pathname filename: "terraform.tfstate"
-  end
-end

data/lib/kitchen/terraform/config_attribute/verify_plugins.rb

@@ -1,52 +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/config_attribute"
-require "kitchen/terraform/config_attribute_cacher"
-require "kitchen/terraform/config_attribute_definer"
-require "kitchen/terraform/config_schemas/boolean"
-
-# The +:verify_plugins+ configuration attribute is an optional boolean which toggles verification of Terraform plugins.
-#
-# @abstract It must be included by a plugin class in order to be used.
-# @see https://www.terraform.io/docs/commands/init.html#plugin-installation Terraform: Command: init: Plugin
-#   Installation
-module ::Kitchen::Terraform::ConfigAttribute::VerifyPlugins
-  # A callback to define the configuration attribute which is invoked when this module is included in a plugin class.
-  #
-  # @param plugin_class [::Kitchen::Configurable] A plugin class.
-  # @return [void]
-  def self.included(plugin_class)
-    ::Kitchen::Terraform::ConfigAttributeDefiner
-      .new(
-        attribute: self,
-        schema: ::Kitchen::Terraform::ConfigSchemas::Boolean
-      )
-      .define plugin_class: plugin_class
-  end
-
-  # @return [::Symbol] the symbol corresponding to the attribute.
-  def self.to_sym
-    :verify_plugins
-  end
-
-  extend ::Kitchen::Terraform::ConfigAttributeCacher
-
-  # @return [true]
-  def config_verify_plugins_default_value
-    true
-  end
-end

data/lib/kitchen/terraform/create_directories.rb

@@ -1,39 +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 "fileutils"
-require "kitchen/terraform"
-
-# Creates directories on the filesystem.
-module ::Kitchen::Terraform::CreateDirectories
-  extend ::Dry::Monads::Either::Mixin
-  extend ::Dry::Monads::Try::Mixin
-
-  # Invokes the function.
-  #
-  # @param directories [::Array<::String>, ::String] the list of directories to create.
-  # @return [::Dry::Monads::Either] the result of the function.
-  def self.call(directories:)
-    Try ::SystemCallError do
-      ::FileUtils.makedirs directories
-    end.to_either.bind do
-      Right "Created directories #{directories}"
-    end.or do |error|
-      Left error.to_s
-    end
-  end
-end