kitchen-terraform 4.7.0 → 4.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0848f7074fecffac74e56a1b39e4598dfd594d82e3bed471f0b1a63e169e9ff5'
-  data.tar.gz: a41ea06cd4949a662e4ca66b859afa44d2730653b59ff62b4d6dee3fc37c8d22
+  metadata.gz: 47a51e0ce916a62c6b14c16662703371bdff9256fb2ab127080cc3b18723f80a
+  data.tar.gz: 5088420cf548532cf0f845f208ede28e41fe1d9a9d989c01cfd72eaba9fceaa0
 SHA512:
-  metadata.gz: af6738cff28a4109dd94722f81e162cebe0723388a038f7db1fd96f5776b082145898748bae44e3794e14627e842f282a460dffc762cb693be1ee92400f8ef49
-  data.tar.gz: 52a8f5091ea9203bf8a3c44ca1af5d7ee3190395283ad94e096c2486c0bc84ebca5cd39d4abc15090af9a840e577c1254b79284100f8cecf6cbb343907fd2503
+  metadata.gz: 1f9bb569f6a8a0b9da54935a1b3e4009ca4f5d7174d989949f5fb919490f4cf0ff4e422bc00c15b4629ca62776620753e9d4cab71c1d3c23579c380a6b9806ee
+  data.tar.gz: 742477dc25ee6e48d39a477a3f3e2565c3b3563a8f0f4112b949d670a4778db224822a6c96c0a83e08992d20859107b94d8746f62e161aa0b020fb37eae3ec80

data/lib/kitchen/driver/terraform.rb

@@ -266,19 +266,31 @@ class ::Kitchen::Driver::Terraform < ::Kitchen::Driver::Base
     raise ::Kitchen::ActionFailed, error.message
   end
 
+  # Retrieves the Terraform input variables for a Kitchen instance provided by the configuration.
+  #
+  # @return [self]
+  # @yieldparam inputs [::Hash] the input variables.
+  def retrieve_inputs
+    yield inputs: config_variables
+
+    self
+  end
+
   # Retrieves the Terraform state outputs for a Kitchen instance by selecting the test workspace and fetching the
   # outputs.
   #
   # @raise [::Kitchen::ActionFailed] if the result of the action is a failure.
-  # @return [void]
-  # @yieldparam output [::Hash] the state output.
+  # @return [self]
+  # @yieldparam outputs [::Hash] the state output.
   def retrieve_outputs(&block)
     run_workspace_select_instance
     ::Kitchen::Terraform::Command::Output.run(
       client: config_client,
-      options: {cwd: config_root_module_directory,  live_stream: debug_logger,  timeout: config_command_timeout},
+      options: { cwd: config_root_module_directory, live_stream: debug_logger, timeout: config_command_timeout },
       &block
     )
+
+    self
   rescue ::Kitchen::Terraform::Error => error
     raise ::Kitchen::ActionFailed, error.message
   end

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

@@ -62,7 +62,7 @@ module ::Kitchen::Terraform::Command::Output
     # @api private
     def run_shell_out(client:, options:)
       ::Kitchen::Terraform::ShellOut.run client: client, command: "output -json", options: options do |standard_output:|
-        yield outputs: ::JSON.parse(standard_output)
+        yield outputs: ::Kitchen::Util.stringified_hash(::JSON.parse(standard_output))
       end
     end
   end

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

@@ -21,19 +21,28 @@ module Kitchen
   module Terraform
     module ConfigSchemas
       # A system is a mapping which is used to configure the execution of {https://www.inspec.io/docs/ InSpec tests}
-      # against a system in the Terraform state.
+      # against a system in the Terraform state. The keys of a system mapping correlate to the arguments and the
+      # options of the {https://www.inspec.io/docs/reference/cli/#exec +inspec exec+} command-line interface
+      # subcomamand.
       #
-      # All systems within the same {https://kitchen.ci/docs/getting-started/adding-suite Kitchen suite} are tested
-      # using the same {https://www.inspec.io/docs/reference/profiles/ InSpec profile} by default. The profile must be
+      # ===== InSpec Profiles
+      #
+      # All systems within the same {https://kitchen.ci/docs/getting-started/adding-suite Kitchen suite} are by default
+      # tested using the same {https://www.inspec.io/docs/reference/profiles/ InSpec profile}. The profile must be
       # 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 all {https://www.terraform.io/docs/configuration/outputs.html Terraform outputs} are associated
-      # with equivalently named
-      # {https://www.inspec.io/docs/reference/profiles/#profile-attributes InSpec profile attributes}.
-      #
-      # The keys of a system mapping correlate to the arguments and the options of the
-      # {https://www.inspec.io/docs/reference/cli/#exec +inspec exec+} command-line interface subcomamand.
+      # 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
+      # {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`.
       #
       # ===== Required Keys
       #

data/lib/kitchen/terraform/system.rb

@@ -65,10 +65,12 @@ module Kitchen
 
       # #verify verifies the system by executing InSpec.
       #
+      # @param inputs [::Hash] the Terraform input variables to be utilized as InSpec profile attributes.
       # @param inspec_options [::Hash] the options to be passed to InSpec.
+      # @param outputs [::Hash] the Terraform output variables to be utilized as InSpec profile attributes.
       # @return [self]
-      def verify(inspec_options:, outputs:)
-        resolve outputs: outputs
+      def verify(inputs:, inspec_options:, outputs:)
+        resolve inputs: inputs, outputs: outputs
         execute_inspec options: inspec_options
 
         self
@@ -81,7 +83,7 @@ module Kitchen
       def execute_inspec(options:)
         inspec.new(
           options: options_with_attributes(options: options),
-          profile_locations: @mapping.fetch(:profile_locations)
+          profile_locations: @mapping.fetch(:profile_locations),
         ).exec(system: self)
       end
 
@@ -108,16 +110,16 @@ module Kitchen
         options.merge attributes: @attributes
       end
 
-      def resolve(outputs:)
-        resolve_attrs outputs: outputs
+      def resolve(inputs:, outputs:)
+        resolve_attrs inputs: inputs, outputs: outputs
         resolve_hosts outputs: outputs
       end
 
-      def resolve_attrs(outputs:)
-        ::Kitchen::Terraform::SystemAttrsResolver.new(outputs: outputs).resolve(
+      def resolve_attrs(inputs:, outputs:)
+        ::Kitchen::Terraform::SystemAttrsResolver.new(inputs: inputs, outputs: outputs).resolve(
           attrs_outputs_keys: @attrs_outputs.keys,
           attrs_outputs_values: @attrs_outputs.values,
-          system: self
+          system: self,
         )
 
         self

data/lib/kitchen/terraform/system_attrs_resolver.rb

@@ -28,9 +28,9 @@ module Kitchen
       # @param system [::Kitchen::Terraform::System] the system.
       # @raise [::Kitchen::Terraform::Error] if the fetching the value of the output fails.
       def resolve(attrs_outputs_keys:, attrs_outputs_values:, system:)
-        system.add_attrs attrs: @outputs.merge(
-          attrs_outputs_keys.lazy.map(&:to_s).zip(@outputs.fetch_values(*attrs_outputs_values)).to_h
-        )
+        system.add_attrs(attrs: @inputs.merge(@outputs.merge(
+                           attrs_outputs_keys.lazy.map(&:to_s).zip(@outputs.fetch_values(*attrs_outputs_values)).to_h
+                         )))
 
         self
       rescue ::KeyError => key_error
@@ -42,12 +42,16 @@ module Kitchen
       # #initialize prepares the instance to be used.
       #
       # @param outputs [#to_hash] the outputs of the Terraform state under test.
-      def initialize(outputs:)
-        @outputs = Hash[outputs].inject({}) do |hash, (key, value)|
-          hash.store key, value.fetch("value")
-
-          hash
-        end
+      def initialize(inputs:, outputs:)
+        @inputs = inputs.map do |key, value|
+          ["input_#{key}", value]
+        end.to_h
+        @outputs = Hash[outputs].map do |key, value|
+          [key, value.fetch("value")]
+        end.to_h
+        @outputs.merge!(@outputs.map do |key, value|
+          ["output_#{key}", value]
+        end.to_h)
       rescue ::KeyError => key_error
         raise ::Kitchen::Terraform::Error, "Preparing to resolve attrs failed\n#{key_error}"
       end

data/lib/kitchen/terraform/version.rb

@@ -72,7 +72,7 @@ module ::Kitchen::Terraform::Version
 
     # @api private
     def value
-      self.value = ::Gem::Version.new "4.7.0" if not @value
+      self.value = ::Gem::Version.new "4.8.0" if not @value
       @value
     end
 

data/lib/kitchen/verifier/terraform.rb

@@ -87,7 +87,7 @@ module Kitchen
       # @raise [::Kitchen::ActionFailed] if the result of the action is a failure.
       # @return [void]
       def call(_kitchen_state)
-        load_outputs
+        load_variables
         verify_systems
         if !@error_messages.empty?
           raise ::Kitchen::ActionFailed, @error_messages.join("\n\n")
@@ -105,17 +105,6 @@ module Kitchen
         false
       end
 
-      # finalize_config! configures InSpec options which remain consistent between systems.
-      #
-      # @param kitchen_instance [::Kitchen::Instance] an associated Kitchen instance.
-      # @return [self]
-      def finalize_config!(kitchen_instance)
-        super kitchen_instance
-        @inspec_options.merge! "color" => config_color
-
-        self
-      end
-
       private
 
       def handle_error(message:)
@@ -127,20 +116,21 @@ module Kitchen
         end
       end
 
-      def load_outputs
+      def load_variables
         instance.driver.retrieve_outputs do |outputs:|
-          @outputs.replace ::Kitchen::Util.stringified_hash outputs
+          @outputs.replace outputs
+        end.retrieve_inputs do |inputs:|
+          @inputs.replace inputs
         end
       end
 
       def initialize(configuration = {})
         init_config configuration
         @error_messages = []
-        @inspec_options = { "distinct_exit" => false }
+        @inputs = {}
         @outputs = {}
       end
 
-
       # load_needed_dependencies! loads the InSpec libraries required to verify a Terraform state.
       #
       # @raise [::Kitchen::ClientError] if loading the InSpec libraries fails.
@@ -154,13 +144,15 @@ module Kitchen
       end
 
       def system_inspec_options(system:)
-        ::Kitchen::Terraform::InSpecOptionsMapper.new(system: system).map options: @inspec_options.dup
+        ::Kitchen::Terraform::InSpecOptionsMapper.new(system: system)
+          .map(options: { "color" => config_color, "distinct_exit" => false })
       end
 
       def verify(system:)
         ::Kitchen::Terraform::System.new(
-          mapping: {profile_locations: [::File.join(config.fetch(:test_base_path), instance.suite.name)]}.merge(system)
-        ).verify(inspec_options: system_inspec_options(system: system), outputs: @outputs)
+          mapping: { profile_locations: [::File.join(config.fetch(:test_base_path), instance.suite.name)] }
+            .merge(system),
+        ).verify(inputs: @inputs, inspec_options: system_inspec_options(system: system), outputs: @outputs)
       rescue => error
         handle_error message: error.message
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-terraform
 version: !ruby/object:Gem::Version
-  version: 4.7.0
+  version: 4.8.0
 platform: ruby
 authors:
 - Aaron Lane
@@ -61,7 +61,7 @@ cert_chain:
   XAjP/LERlXAwM+NCUycJw7BZMn7L2wIdnq6Le1rL6VJS17CZt2heuRtsF+3g0egR
   x97GmUumeM67PGeVodlIV65tdXrdlqKlHcE=
   -----END CERTIFICATE-----
-date: 2019-04-13 00:00:00.000000000 Z
+date: 2019-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard-bundler