kitchen-terraform 3.3.0 → 3.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5dadb3ef6bcfc581ca13d112850bee34e8e8ead663fdcd6ce8e84128c75dfe04
-  data.tar.gz: c3e0c635603f71e2db719186632c2d419be6a3b804021f2e7734827654d3ceaf
+  metadata.gz: f583f33eb358a79ac661e3e108e4d236f7fe4f303f9022947efb8a83b05cb1b2
+  data.tar.gz: 32fcb9bb51b28bb1a806d9137055edc6a27adc668906da9e4d3cbc1e0fc81daf
 SHA512:
-  metadata.gz: f5992349fc8f42707f084531a2ad961c135c59c9769947a4ade17074b86059ff5f941f7a38185512cf63080bdafe700eccac3f010946cc22d0b6aa62cd6f0010
-  data.tar.gz: b4b38453c237aed8817b9577f123c7d4050b21ccf7da3bf3ec12b49931143994078879868f0c7f40a76b63652b55db19af2218e8a582fbecbde9ed810c12ec75
+  metadata.gz: c45754dc6cf770e90a5cf9ba2d1e664a19b3495c14a1ecb60283feac045cf0cfef916b5246a79f1f8f3b008c6e5a4ff32801465ce6ed1b056af06b465a3784be
+  data.tar.gz: 66af7f6b159e36b97c1c5c331dd1409b2a9143471c0be43e506a401836acfb1904fd6e8b8fb2dfae8d107d9953f395ceaef6ca2091a32319eeacc0c092b8b06e

data/lib/kitchen/driver/terraform.rb

@@ -14,8 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "kitchen/driver/base"
-require "kitchen/errors"
+require "kitchen"
 require "kitchen/terraform/client_version_verifier"
 require "kitchen/terraform/command/output"
 require "kitchen/terraform/config_attribute/backend_configurations"
@@ -30,6 +29,13 @@ require "kitchen/terraform/config_attribute/variable_files"
 require "kitchen/terraform/config_attribute/variables"
 require "kitchen/terraform/configurable"
 require "kitchen/terraform/shell_out"
+require "shellwords"
+
+# This namespace is defined by Kitchen.
+#
+# @see http://www.rubydoc.info/gems/test-kitchen/Kitchen/Driver
+module ::Kitchen::Driver
+end
 
 # The driver is the bridge between Test Kitchen and Terraform. It manages the
 # {https://www.terraform.io/docs/state/index.html state} of the Terraform root module by shelling out and running
@@ -176,8 +182,6 @@ require "kitchen/terraform/shell_out"
 class ::Kitchen::Driver::Terraform < ::Kitchen::Driver::Base
   kitchen_driver_api_version 2
 
-  no_parallel_for
-
   include ::Kitchen::Terraform::ConfigAttribute::BackendConfigurations
 
   include ::Kitchen::Terraform::ConfigAttribute::Color
@@ -200,6 +204,35 @@ class ::Kitchen::Driver::Terraform < ::Kitchen::Driver::Base
 
   include ::Kitchen::Terraform::Configurable
 
+  # This method queries for the names of the action methods which must be run in serial via a shared mutex.
+  #
+  # If the version satisfies the requirement of ~> 3.3 then no names are returned.
+  #
+  # If the version satisfies the requirement of >= 4 then +:create+, +:converge+, +:setup+, and +:destroy+ are returned.
+  #
+  # @param version [::Kitchen::Terraform::Version] the version to compare against the requirements.
+  # @return [::Array<Symbol>] the action method names.
+  def self.serial_actions(version: ::Kitchen::Terraform::Version.new)
+    version
+      .if_satisfies requirement: ::Gem::Requirement.new("~> 3.3") do
+        no_parallel_for
+      end
+
+    version
+      .if_satisfies requirement: ::Gem::Requirement.new(">= 4") do
+        super()
+          .empty? and
+          no_parallel_for(
+            :create,
+            :converge,
+            :setup,
+            :destroy
+          )
+      end
+
+    super()
+  end
+
   # Applies changes to the state by selecting the test workspace, updating the dependency modules, validating the root
   # module, applying the state changes, and retrieving the state output.
   #
@@ -287,16 +320,16 @@ class ::Kitchen::Driver::Terraform < ::Kitchen::Driver::Base
       .run(
         command:
           "apply " \
-            "#{config_lock_flag} " \
-            "#{config_lock_timeout_flag} " \
+            "#{lock_flag} " \
+            "#{lock_timeout_flag} " \
             "-input=false " \
             "-auto-approve=true " \
-            "#{config_color_flag} " \
-            "#{config_parallelism_flag} " \
+            "#{color_flag} " \
+            "#{parallelism_flag} " \
             "-refresh=true " \
-            "#{config_variables_flags} " \
-            "#{config_variable_files_flags} " \
-            "#{config_root_module_directory}",
+            "#{variables_flags} " \
+            "#{variable_files_flags} " \
+            "#{root_module_directory}",
         duration: config_command_timeout,
         logger: logger
       )
@@ -306,7 +339,7 @@ class ::Kitchen::Driver::Terraform < ::Kitchen::Driver::Base
   def apply_run_get
     ::Kitchen::Terraform::ShellOut
       .run(
-        command: "get -update #{config_root_module_directory}",
+        command: "get -update #{root_module_directory}",
         duration: config_command_timeout,
         logger: logger
       )
@@ -319,15 +352,29 @@ class ::Kitchen::Driver::Terraform < ::Kitchen::Driver::Base
         command:
           "validate " \
             "-check-variables=true " \
-            "#{config_color_flag} " \
-            "#{config_variables_flags} " \
-            "#{config_variable_files_flags} " \
-            "#{config_root_module_directory}",
+            "#{color_flag} " \
+            "#{variables_flags} " \
+            "#{variable_files_flags} " \
+            "#{root_module_directory}",
         duration: config_command_timeout,
         logger: logger
       )
   end
 
+  # @api private
+  def backend_configurations_flags
+    config_backend_configurations
+      .map do |key, value|
+        "-backend-config=#{::Shellwords.escape "#{key}=#{value}"}"
+      end
+      .join " "
+  end
+
+  # api private
+  def color_flag
+    config_color and "" or "-no-color"
+  end
+
   # @api private
   def create_run_init
     ::Kitchen::Terraform::ShellOut
@@ -335,18 +382,18 @@ class ::Kitchen::Driver::Terraform < ::Kitchen::Driver::Base
         command:
           "init " \
             "-input=false " \
-            "#{config_lock_flag} " \
-            "#{config_lock_timeout_flag} " \
-            "#{config_color_flag} " \
+            "#{lock_flag} " \
+            "#{lock_timeout_flag} " \
+            "#{color_flag} " \
             "-upgrade " \
             "-force-copy " \
             "-backend=true " \
-            "#{config_backend_configurations_flags} " \
+            "#{backend_configurations_flags} " \
             "-get=true " \
             "-get-plugins=true " \
-            "#{config_plugin_directory_flag} " \
+            "#{plugin_directory_flag} " \
             "-verify-plugins=true " \
-            "#{config_root_module_directory}",
+            "#{root_module_directory}",
         duration: config_command_timeout,
         logger: logger
       )
@@ -359,15 +406,15 @@ class ::Kitchen::Driver::Terraform < ::Kitchen::Driver::Base
         command:
           "destroy " \
             "-force " \
-            "#{config_lock_flag} " \
-            "#{config_lock_timeout_flag} " \
+            "#{lock_flag} " \
+            "#{lock_timeout_flag} " \
             "-input=false " \
-            "#{config_color_flag} " \
-            "#{config_parallelism_flag} " \
+            "#{color_flag} " \
+            "#{parallelism_flag} " \
             "-refresh=true " \
-            "#{config_variables_flags} " \
-            "#{config_variable_files_flags} " \
-            "#{config_root_module_directory}",
+            "#{variables_flags} " \
+            "#{variable_files_flags} " \
+            "#{root_module_directory}",
         duration: config_command_timeout,
         logger: logger
       )
@@ -380,17 +427,17 @@ class ::Kitchen::Driver::Terraform < ::Kitchen::Driver::Base
         command:
           "init " \
             "-input=false " \
-            "#{config_lock_flag} " \
-            "#{config_lock_timeout_flag} " \
-            "#{config_color_flag} " \
+            "#{lock_flag} " \
+            "#{lock_timeout_flag} " \
+            "#{color_flag} " \
             "-force-copy " \
             "-backend=true " \
-            "#{config_backend_configurations_flags} " \
+            "#{backend_configurations_flags} " \
             "-get=true " \
             "-get-plugins=true " \
-            "#{config_plugin_directory_flag} " \
+            "#{plugin_directory_flag} " \
             "-verify-plugins=true " \
-            "#{config_root_module_directory}",
+            "#{root_module_directory}",
         duration: config_command_timeout,
         logger: logger
       )
@@ -421,6 +468,33 @@ class ::Kitchen::Driver::Terraform < ::Kitchen::Driver::Base
     @instance_name ||= instance.name
   end
 
+  # @api private
+  def lock_flag
+    "-lock=#{config_lock}"
+  end
+
+  # @api private
+  def lock_timeout_flag
+    "-lock-timeout=#{config_lock_timeout}s"
+  end
+
+  # @api private
+  def parallelism_flag
+    "-parallelism=#{config_parallelism}"
+  end
+
+  # @api private
+  def plugin_directory_flag
+    config_plugin_directory and
+      "-plugin-dir=#{::Shellwords.escape config_plugin_directory}" or
+      ""
+  end
+
+  # @api private
+  def root_module_directory
+    ::Shellwords.escape config_root_module_directory
+  end
+
   # @api private
   def run_workspace_select_instance
     ::Kitchen::Terraform::ShellOut
@@ -437,4 +511,22 @@ class ::Kitchen::Driver::Terraform < ::Kitchen::Driver::Base
         logger: logger
       )
   end
+
+  # @api private
+  def variable_files_flags
+    config_variable_files
+      .map do |path|
+        "-var-file=#{::Shellwords.escape path}"
+      end
+      .join " "
+  end
+
+  # @api private
+  def variables_flags
+    config_variables
+      .map do |key, value|
+        "-var=#{::Shellwords.escape "#{key}=#{value}"}"
+      end
+      .join " "
+  end
 end

data/lib/kitchen/provisioner/terraform.rb

@@ -14,10 +14,16 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "kitchen/provisioner"
+require "kitchen"
 require "kitchen/terraform/configurable"
 require "kitchen/terraform/error"
 
+# This namespace is defined by Kitchen.
+#
+# @see http://www.rubydoc.info/gems/test-kitchen/Kitchen/Provisioner
+module ::Kitchen::Provisioner
+end
+
 # The provisioner utilizes the driver to apply changes to the Terraform state in order to reach the desired
 # configuration of the root module.
 #

data/lib/kitchen/{verifier.rb → terraform/breaking.rb}

@@ -14,9 +14,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "kitchen"
+require "kitchen/terraform"
 
-# This is the namespace for Test Kitchen verifier plugins. This namespace is already defined in Test Kitchen but YARD
-# requires it to be redefined here in order to include documenation from the Kitchen::Terraform namespace.
-module Kitchen::Verifier
+# The namespace for objects with breaking changes.
+module ::Kitchen::Terraform::Breaking
 end

data/lib/kitchen/{driver.rb → terraform/breaking/kitchen_instance.rb}

@@ -14,9 +14,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require "delegate"
 require "kitchen"
+require "kitchen/terraform/breaking"
 
-# This is the namespace for Test Kitchen driver plugins. This namespace is already defined in Test Kitchen but YARD
-# requires it to be redefined here in order to include documenation from the Kitchen::Terraform namespace.
-module Kitchen::Driver
+# This class provides the breaking change to the KitchenInstance.
+class ::Kitchen::Terraform::Breaking::KitchenInstance < DelegateClass ::Kitchen::Instance
 end

data/lib/kitchen/terraform/config_attribute.rb

@@ -15,9 +15,73 @@
 # limitations under the License.
 
 require "kitchen/terraform"
+require "kitchen/terraform/config_attribute_cacher"
+require "kitchen/terraform/config_attribute_definer"
 
-# The namespace for configuration attributes.
-#
-# @abstract It defines the interface for configuration attributes to implement.
-module ::Kitchen::Terraform::ConfigAttribute
+# This class applies the behaviour of a configuration attribute to a module which must be included by a plugin class.
+class ::Kitchen::Terraform::ConfigAttribute
+  # This method applies the configuration attribute behaviour to a module.
+  #
+  # @param config_attribute [::Module] a module.
+  # @return [self]
+  def apply(config_attribute:)
+    self.config_attribute = config_attribute
+    define_singleton_included
+    define_singleton_to_sym
+    define_config_attribute_default_value
+    self
+  end
+
+  private
+
+  attr_accessor(
+    :attribute,
+    :config_attribute,
+    :default_value,
+    :schema
+  )
+
+  # @api private
+  def define_config_attribute_default_value
+    config_attribute
+      .send(
+        :define_method,
+        "config_#{attribute}_default_value",
+        &default_value
+      )
+  end
+
+  # @api private
+  def define_singleton_included
+    local_schema = schema
+
+    config_attribute
+      .define_singleton_method :included do |plugin_class|
+        ::Kitchen::Terraform::ConfigAttributeDefiner
+          .new(
+            attribute: self,
+            schema: local_schema
+          )
+          .define plugin_class: plugin_class
+      end
+  end
+
+  # @api private
+  def define_singleton_to_sym
+    local_attribute = attribute
+
+    config_attribute
+      .define_singleton_method :to_sym do
+        local_attribute
+      end
+
+    config_attribute.extend ::Kitchen::Terraform::ConfigAttributeCacher
+  end
+
+  # @api private
+  def initialize(attribute:, default_value:, schema:)
+    self.attribute = attribute
+    self.default_value = default_value
+    self.schema = schema
+  end
 end

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

@@ -15,9 +15,7 @@
 # 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/hash_of_symbols_and_strings"
+require "kitchen/terraform/config_attribute_type/hash_of_symbols_and_strings"
 
 # This attribute comprises {https://www.terraform.io/docs/backends/config.html Terraform backend configuration}
 # arguments to complete a
@@ -30,40 +28,14 @@ require "kitchen/terraform/config_schemas/hash_of_symbols_and_strings"
 #     backend_configurations:
 #       address: demo.consul.io
 #       path: example_app/terraform_state
-#
-# @abstract It must be included by a plugin class in order to be used.
 module ::Kitchen::Terraform::ConfigAttribute::BackendConfigurations
-  # 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::HashOfSymbolsAndStrings
-      )
-      .define plugin_class: plugin_class
-  end
-
-  # @return [::Symbol] the symbol corresponding to the attribute.
-  def self.to_sym
-    :backend_configurations
-  end
-
-  extend ::Kitchen::Terraform::ConfigAttributeCacher
-
-  # @return [::Hash] an empty hash.
-  def config_backend_configurations_default_value
-    {}
-  end
-
-  # @return [::String] the elements of the value converted to flags, joined by white space.
-  def config_backend_configurations_flags
-    config_backend_configurations
-      .map do |key, value|
-        "-backend-config=\"#{key}=#{value}\""
-      end
-      .join " "
-  end
+  ::Kitchen::Terraform::ConfigAttributeType::HashOfSymbolsAndStrings
+    .apply(
+      attribute: :backend_configurations,
+      config_attribute: self,
+      default_value:
+        lambda do
+          {}
+        end
+    )
 end