kitchen-terraform 5.1.1 → 5.6.0

data/lib/kitchen/terraform/config_attribute_type/integer.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016 New Context Services, Inc.
+# Copyright 2016-2019 New Context, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -25,9 +25,9 @@ require "kitchen/terraform/config_attribute_type"
 module ::Kitchen::Terraform::ConfigAttributeType::Integer
   # This method applies the configuration attribute behaviour to a module.
   #
-  # @param attribute [::Symbol] the symbol corresponding to the configuration attribute.
-  # @param config_attribute [::Module] a module.
-  # @param default_value [::Proc] a proc which returns the default value.
+  # @param attribute [Symbol] the symbol corresponding to the configuration attribute.
+  # @param config_attribute [Module] a module.
+  # @param default_value [Proc] a proc which returns the default value.
   # @return [self]
   def self.apply(attribute:, config_attribute:, default_value:)
     ::Kitchen::Terraform::ConfigAttribute

data/lib/kitchen/terraform/config_predicates.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016 New Context Services, Inc.
+# Copyright 2016-2019 New Context, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -14,8 +14,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "kitchen/terraform"
-
-# The namespace for configuration attribute predicates.
-module ::Kitchen::Terraform::ConfigPredicates
+module Kitchen
+  module Terraform
+    # The namespace for configuration attribute predicates.
+    module ConfigPredicates
+    end
+  end
 end

data/lib/kitchen/terraform/config_predicates/hash_of_symbols_and_strings.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016 New Context Services, Inc.
+# Copyright 2016-2019 New Context, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -25,7 +25,7 @@ require "kitchen/terraform/config_predicates"
 module ::Kitchen::Terraform::ConfigPredicates::HashOfSymbolsAndStrings
   # A callback to configure an extending schema with this predicate.
   #
-  # @param schema [::Dry::Validation::Schema] the schema to be configured.
+  # @param schema [Dry::Validation::Schema] the schema to be configured.
   # @return [self]
   def self.extended(schema)
     schema.predicates self
@@ -45,8 +45,8 @@ module ::Kitchen::Terraform::ConfigPredicates::HashOfSymbolsAndStrings
   # If all keys are symbols then the result is +true+; else the result is +false+.
   #
   # @api private
-  # @param keys [::Enumerable] keys that must be only symbols
-  # @return [::TrueClass, ::FalseClass] the result
+  # @param keys [Enumerable] keys that must be only symbols
+  # @return [TrueClass, ::FalseClass] the result
   def self.all_symbols?(keys:)
     keys
       .all? do |key|
@@ -57,8 +57,8 @@ module ::Kitchen::Terraform::ConfigPredicates::HashOfSymbolsAndStrings
   # If all values are strings then the result is +true+; else the result is +false+.
   #
   # @api private
-  # @param values [::Enumerable] values that must be only strings
-  # @return [::TrueClass, ::FalseClass] the result
+  # @param values [Enumerable] values that must be only strings
+  # @return [TrueClass, ::FalseClass] the result
   def self.all_strings?(values:)
     values
       .all? do |value|

data/lib/kitchen/terraform/config_schemas.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016 New Context Services, Inc.
+# Copyright 2016-2019 New Context, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -14,8 +14,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "kitchen/terraform"
-
-# The namespace for configuration attribute schemas.
-module ::Kitchen::Terraform::ConfigSchemas
+module Kitchen
+  module Terraform
+    # The namespace for configuration attribute schemas.
+    module ConfigSchemas
+    end
+  end
 end

data/lib/kitchen/terraform/config_schemas/array_of_strings.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016 New Context Services, Inc.
+# Copyright 2016-2019 New Context, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,17 +15,24 @@
 # limitations under the License.
 
 require "dry/validation"
-require "kitchen/terraform/config_schemas"
 
-# A validation schema for a configuration attribute which is an array including only strings.
-#
-# @see http://dry-rb.org/gems/dry-validation/basics/working-with-schemas/ DRY Validation Working With Schemas
-::Kitchen::Terraform::ConfigSchemas::ArrayOfStrings =
-  ::Dry::Validation
-    .Schema do
-    required(:value)
-      .each(
-        :filled?,
-        :str?
-      )
+module Kitchen
+  module Terraform
+    module ConfigSchemas
+      # A validation schema for a configuration attribute which is an array including only strings.
+      #
+      # @see http://dry-rb.org/gems/dry-validation/basics/working-with-schemas/ DRY Validation Working With Schemas
+      ArrayOfStrings = ::Dry::Validation.Schema do
+        required(:value)
+          .each(
+            :filled?,
+            :str?
+          )
+      end.dup
+
+      ArrayOfStrings.define_singleton_method :to_s do
+        "Kitchen::Terraform::ConfigSchemas::ArrayOfStrings"
+      end
+    end
   end
+end

data/lib/kitchen/terraform/config_schemas/boolean.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016 New Context Services, Inc.
+# Copyright 2016-2019 New Context, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,13 +15,20 @@
 # limitations under the License.
 
 require "dry/validation"
-require "kitchen/terraform/config_schemas"
 
-# A validation schema for a configuration attribute which is a boolean.
-#
-# @see http://dry-rb.org/gems/dry-validation/basics/working-with-schemas/ DRY Validation Working With Schemas
-::Kitchen::Terraform::ConfigSchemas::Boolean =
-  ::Dry::Validation
-    .Schema do
-    required(:value).filled :bool?
+module Kitchen
+  module Terraform
+    module ConfigSchemas
+      # A validation schema for a configuration attribute which is a boolean.
+      #
+      # @see http://dry-rb.org/gems/dry-validation/basics/working-with-schemas/ DRY Validation Working With Schemas
+      Boolean = ::Dry::Validation.Schema do
+        required(:value).filled :bool?
+      end.dup
+
+      Boolean.define_singleton_method :to_s do
+        "Kitchen::Terraform::ConfigSchemas::Boolean"
+      end
+    end
   end
+end

data/lib/kitchen/terraform/config_schemas/optional_string.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016 New Context Services, Inc.
+# Copyright 2016-2019 New Context, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,17 +15,24 @@
 # limitations under the License.
 
 require "dry/validation"
-require "kitchen/terraform/config_schemas"
 
-# A validation schema for a configuration attribute which is an optional string.
-#
-# @see http://dry-rb.org/gems/dry-validation/basics/working-with-schemas/ DRY Validation Working With Schemas
-::Kitchen::Terraform::ConfigSchemas::OptionalString =
-  ::Dry::Validation
-    .Schema do
-    required(:value)
-      .maybe(
-        :str?,
-        :filled?
-      )
+module Kitchen
+  module Terraform
+    module ConfigSchemas
+      # A validation schema for a configuration attribute which is an optional string.
+      #
+      # @see http://dry-rb.org/gems/dry-validation/basics/working-with-schemas/ DRY Validation Working With Schemas
+      OptionalString = ::Dry::Validation.Schema do
+        required(:value)
+          .maybe(
+            :str?,
+            :filled?
+          )
+      end.dup
+
+      OptionalString.define_singleton_method :to_s do
+        "Kitchen::Terraform::ConfigSchemas::OptionalString"
+      end
+    end
   end
+end

data/lib/kitchen/terraform/config_schemas/string.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016 New Context Services, Inc.
+# Copyright 2016-2019 New Context, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,12 +15,18 @@
 # limitations under the License.
 
 require "dry/validation"
-require "kitchen/terraform/config_schemas"
 
-# Defines a validation schema for a string.
+module Kitchen
+  module Terraform
+    module ConfigSchemas
+      # Defines a validation schema for a string.
+      String = ::Dry::Validation.Schema do
+        required(:value).filled :str?
+      end.dup
 
-::Kitchen::Terraform::ConfigSchemas::String =
-  ::Dry::Validation
-    .Schema do
-    required(:value).filled :str?
+      String.define_singleton_method :to_s do
+        "Kitchen::Terraform::ConfigSchemas::String"
+      end
+    end
   end
+end

data/lib/kitchen/terraform/config_schemas/system.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016 New Context Services, Inc.
+# Copyright 2016-2019 New Context, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,7 +15,6 @@
 # limitations under the License.
 
 require "dry/validation"
-require "kitchen/terraform/config_schemas"
 
 module Kitchen
   module Terraform
@@ -32,17 +31,16 @@ module Kitchen
       # implemented in the directory located at `<Kitchen root>/test/integration/<suite name>`. This behaviour can be
       # overridden with the <code>profile_locations</code> key.
       #
-      # The values of any {https://www.terraform.io/docs/configuration/variables.html Terraform input variables}
-      # configured with the driver's <code>variables</code> attribute and the values of any
-      # {https://www.terraform.io/docs/configuration/outputs.html Terraform output variables} which exist in the
-      # Terraform state are associated with equivalently named
+      # The values of any {https://www.terraform.io/docs/configuration/variables.html Terraform variables} configured
+      # with the driver's <code>variables</code> attribute and the values of any
+      # {https://www.terraform.io/docs/configuration/outputs.html Terraform outputs} which exist in the Terraform state
+      # are associated with equivalently named
       # {https://www.inspec.io/docs/reference/profiles/#profile-attributes InSpec profile attributes}, prefixed with
-      # <code>input_</code> or <code>output_</code>, respectively. The values of the output variables are also
-      # associated with equivalently named profile attributes without any prefixes for backward compatibility. Output
-      # variable associations can be overridden with the <code>attrs_outputs</code> key. For example, the value of an
-      # input variable named `test` will be associated with an attribute named `input_test`, and the value of an output
-      # variable named `test` will be associated with an attribute named `output_test` as well as an attribute named
-      # `test`.
+      # <code>input_</code> or <code>output_</code>, respectively. The values of the outputs are also associated with
+      # equivalently named profile attributes without any prefixes for backward compatibility. Output associations can
+      # be overridden with the <code>attrs_outputs</code> key. For example, the value of a variable named `test` will
+      # be associated with an attribute named `input_test`, and the value of an output named `test` will be associated
+      # with an attribute named `output_test` as well as an attribute named `test`.
       #
       # ===== Required Keys
       #
@@ -132,6 +130,8 @@ module Kitchen
       #
       # The +bastion_host+ key must be used in combination with a backend which supports remote connections.
       #
+      # The +bastion_host_output+ key will take priority over the +bastion_host+ key.
+      #
       # <em>Example kitchen.yml</em>
       #   verifier:
       #     name: terraform
@@ -140,12 +140,29 @@ module Kitchen
       #         backend: ssh
       #         bastion_host: bastion-host.domain
       #
+      # ====== bastion_host_output
+      #
+      # The value of the +bastion_host_output+ key is a scalar which is used to obtain the address of a bastion host in
+      # the system from a Terraform output.
+      #
+      # The scalar must match the name of an output with a value which is a string.
+      #
+      # The +bastion_host_output+ key must be used in combination with a backend which enables remote connections.
+      #
+      # <em>Example kitchen.yml</em>
+      #   verifier:
+      #     name: terraform
+      #     systems:
+      #       - name: a system
+      #         backend: ssh
+      #         bastion_host_output: an_output
+      #
       # ====== bastion_port
       #
       # The value of the +bastion_port+ key is an integer which is used as the port number to connect to on the bastion
       # host.
       #
-      # The +bastion_port+ key must be used in combination with the +bastion_host+ key.
+      # The +bastion_port+ key must be used in combination with the +bastion_host_output+ key or the +bastion_host+ key.
       #
       # <em>Example kitchen.yml</em>
       #   verifier:
@@ -153,7 +170,7 @@ module Kitchen
       #     systems:
       #       - name: a system
       #         backend: ssh
-      #         bastion_host: bastion-host.domain
+      #         bastion_host_output: an_output
       #         bastion_port: 1234
       #
       # ====== bastion_user
@@ -161,7 +178,7 @@ module Kitchen
       # The value of the +bastion_user+ key is a scalar which is used as the username for authentication with the
       # bastion host.
       #
-      # The +bastion_user+ key must be used in combination with the +bastion_host+ key.
+      # The +bastion_user+ key must be used in combination with the +bastion_host_output+ key or the +bastion_host+ key.
       #
       # <em>Example kitchen.yml</em>
       #   verifier:
@@ -169,7 +186,7 @@ module Kitchen
       #     systems:
       #       - name: a system
       #         backend: ssh
-      #         bastion_host: bastion-host.domain
+      #         bastion_host_output: an_output
       #         bastion_user: bastion-user
       #
       # ====== controls
@@ -556,6 +573,7 @@ module Kitchen
         optional(:attrs_outputs).filled :hash?
         optional(:backend_cache).value :bool?
         optional(:bastion_host).filled :str?
+        optional(:bastion_host_output).filled :str?
         optional(:bastion_port).value :int?
         optional(:bastion_user).filled :str?
         optional(:controls).each(:filled?, :str?)
@@ -581,6 +599,10 @@ module Kitchen
         optional(:sudo_password).filled :str?
         optional(:user).filled :str?
         optional(:vendor_cache).filled :str?
+      end.dup
+
+      System.define_singleton_method :to_s do
+        "Kitchen::Terraform::ConfigSchemas::System"
       end
     end
   end

data/lib/kitchen/terraform/config_schemas/systems.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016 New Context Services, Inc.
+# Copyright 2016-2019 New Context, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,7 +15,6 @@
 # limitations under the License.
 
 require "dry/validation"
-require "kitchen/terraform/config_schemas"
 require "kitchen/terraform/config_schemas/system"
 
 module Kitchen
@@ -28,6 +27,10 @@ module Kitchen
         required(:value).each do
           schema ::Kitchen::Terraform::ConfigSchemas::System
         end
+      end.dup
+
+      Systems.define_singleton_method :to_s do
+        "Kitchen::Terraform::ConfigSchemas::Systems"
       end
     end
   end

data/lib/kitchen/terraform/configurable.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016 New Context Services, Inc.
+# Copyright 2016-2019 New Context, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,30 +15,50 @@
 # limitations under the License.
 
 require "kitchen"
-require "kitchen/terraform"
 require "kitchen/terraform/version"
+require "rubygems"
+require "shellwords"
 
-# Refinements to Kitchen::Configurable.
-#
-# @see https://github.com/test-kitchen/test-kitchen/blob/v1.16.0/lib/kitchen/configurable.rb Kitchen::Configurable
-module ::Kitchen::Terraform::Configurable
-  # A callback to define the plugin version which is invoked when this module is included in a plugin class.
-  #
-  # @return [self]
-  def self.included(configurable_class)
-    ::Kitchen::Terraform::Version.assign_plugin_version configurable_class: configurable_class
-    self
-  end
+module Kitchen
+  module Terraform
+    # Refinements to Kitchen::Configurable.
+    # This class implements the interface of Kitchen::Configurable which requires the following Reek suppressions:
+    # :reek:MissingSafeMethod { exclude: [ finalize_config! ] }
+    # @see https://github.com/test-kitchen/test-kitchen/blob/v1.16.0/lib/kitchen/configurable.rb Kitchen::Configurable
+    module Configurable
+      # A callback to define the plugin version which is invoked when this module is included in a plugin class.
+      #
+      # @return [self]
+      def self.included(configurable_class)
+        ::Kitchen::Terraform::Version.assign_plugin_version configurable_class: configurable_class
+        self
+      end
 
-  private
+      # #finalize_config! invokes the super implementation and then defines the workspace name and version requirement.
+      #
+      # @param instance [Kitchen::Instance] an associated instance.
+      # @raise [Kitchen::ClientError] if the instance is nil.
+      # @return [self]
+      # @see Kitchen::Configurable#finalize_config!
+      def finalize_config!(instance)
+        super instance
+        self.version_requirement = ::Gem::Requirement.new ">= 0.11.4", "< 0.15.0"
+        self.workspace_name = "kitchen-terraform-#{::Shellwords.escape instance.name}"
+      end
 
-  def expand_paths!
-    validate_config! if !@validate_config_called
-    super
-  end
+      private
+
+      attr_accessor :version_requirement, :workspace_name
+
+      def expand_paths!
+        validate_config! if !@validate_config_called
+        super
+      end
 
-  def validate_config!
-    @validate_config_called ||= true
-    super
+      def validate_config!
+        @validate_config_called ||= true
+        super
+      end
+    end
   end
 end