kitchen-terraform 4.6.0 → 4.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e916889997cb402f0784bca7fd292359454ccebd072cf4a83d2859f54c689c7
-  data.tar.gz: 40837369dda96179987ea46fb225dc72f857ed4a47cee224f60eaa52f1bcb3f1
+  metadata.gz: '0848f7074fecffac74e56a1b39e4598dfd594d82e3bed471f0b1a63e169e9ff5'
+  data.tar.gz: a41ea06cd4949a662e4ca66b859afa44d2730653b59ff62b4d6dee3fc37c8d22
 SHA512:
-  metadata.gz: 6f3a09a6ed6392d19f8a78502a3dc1a16db82eebeae3b4e2f30e527cbebdbc4b50acc1e5b542b876620c02653d034548d20dad0e6e3568a3bf73785721cffbb5
-  data.tar.gz: d9ee18045c6070dd4b500e7c8208af3adc8662ecb756bcafdfe32279c49a0598d471caf7909f99c751e71b68f18307bd1dc0246f1f164553d02bef03fb896aee
+  metadata.gz: af6738cff28a4109dd94722f81e162cebe0723388a038f7db1fd96f5776b082145898748bae44e3794e14627e842f282a460dffc762cb693be1ee92400f8ef49
+  data.tar.gz: 52a8f5091ea9203bf8a3c44ca1af5d7ee3190395283ad94e096c2486c0bc84ebca5cd39d4abc15090af9a840e577c1254b79284100f8cecf6cbb343907fd2503

data/README.md

@@ -7,8 +7,9 @@
 [![Gem downloads total][gem-downloads-total-shield]][kitchen-terraform-gem]
 
 [![Build status][build-status-shield]][build-status]
-[![Test coverage][test-coverage-shield]][test-coverage]
+[![Code coverage][code-coverage-shield]][code-coverage]
 [![Maintainability][maintainability-shield]][maintainability]
+[![Technical debt][technical-debt-shield]][technical-debt]
 [![Dependencies][hakiri-shield]][hakiri]
 
 [![Gitter chat][gitter-shield]][gitter]
@@ -355,12 +356,14 @@ Kitchen-Terraform is distributed under the [Apache License][license].
 
 <!-- Markdown links and image definitions -->
 
-[build-status-shield]: https://img.shields.io/travis/newcontext-oss/kitchen-terraform.svg
+[build-status-shield]: https://img.shields.io/travis/com/newcontext-oss/kitchen-terraform.svg
 [build-status]: https://travis-ci.com/newcontext-oss/kitchen-terraform
 [bundler-getting-started]: https://bundler.io/#getting-started
 [bundler-in-depth]: https://bundler.io/gemfile.html
 [bundler]: https://bundler.io/index.html#getting-started
 [changelog]: https://github.com/newcontext-oss/kitchen-terraform/blob/master/CHANGELOG.md
+[code-coverage-shield]: https://img.shields.io/codeclimate/coverage/newcontext-oss/kitchen-terraform.svg
+[code-coverage]: https://codeclimate.com/github/newcontext-oss/kitchen-terraform/
 [contributing-document]: https://github.com/newcontext-oss/kitchen-terraform/blob/master/CONTRIBUTING.md
 [docker]: https://www.docker.com/
 [docker-community-edition]: https://store.docker.com/editions/community/docker-ce-server-ubuntu
@@ -377,8 +380,8 @@ Kitchen-Terraform is distributed under the [Apache License][license].
 [kitchen-terraform-logo]: https://raw.githubusercontent.com/newcontext-oss/kitchen-terraform/master/assets/logo.png
 [kitchen-terraform-tutorials]: https://newcontext-oss.github.io/kitchen-terraform/tutorials/
 [license]: https://github.com/newcontext-oss/kitchen-terraform/blob/master/LICENSE
-[maintainability-shield]: https://api.codeclimate.com/v1/badges/73d4a2280a30e680bac4/maintainability
-[maintainability]: https://codeclimate.com/github/newcontext-oss/kitchen-terraform/maintainability
+[maintainability-shield]: https://img.shields.io/codeclimate/maintainability-percentage/newcontext-oss/kitchen-terraform.svg
+[maintainability]: https://codeclimate.com/github/newcontext-oss/kitchen-terraform/
 [new-context-github]: https://github.com/newcontext
 [new-context-linkedin]: https://www.linkedin.com/company/-new-context-
 [new-context-twitter]: https://twitter.com/newcontext
@@ -390,14 +393,14 @@ Kitchen-Terraform is distributed under the [Apache License][license].
 [ruby-installation]: https://www.ruby-lang.org/en/documentation/installation/
 [ruby]: https://www.ruby-lang.org/en/
 [rubygems-installing-gems]: http://guides.rubygems.org/rubygems-basics/#rubygems-installing-gems
+[technical-debt-shield]: https://img.shields.io/codeclimate/tech-debt/newcontext-oss/kitchen-terraform.svg
+[technical-debt]: https://codeclimate.com/github/newcontext-oss/kitchen-terraform/
 [terraform-cli]: https://www.terraform.io/docs/commands/index.html
 [terraform-driver]: http://www.rubydoc.info/github/newcontext-oss/kitchen-terraform/Kitchen/Driver/Terraform
 [terraform-install]: https://www.terraform.io/intro/getting-started/install.html
 [terraform-provisioner]: http://www.rubydoc.info/github/newcontext-oss/kitchen-terraform/Kitchen/Provisioner/Terraform
 [terraform-verifier]: http://www.rubydoc.info/github/newcontext-oss/kitchen-terraform/Kitchen/Verifier/Terraform
 [terraform]: https://www.terraform.io/
-[test-coverage-shield]: https://api.codeclimate.com/v1/badges/73d4a2280a30e680bac4/test_coverage
-[test-coverage]: https://codeclimate.com/github/newcontext-oss/kitchen-terraform/test_coverage
 [test-kitchen-configuration-file]: https://docs.chef.io/config_yml_kitchen.html
 [test-kitchen]: http://kitchen.ci/index.html
 [tfenv]: https://github.com/kamatama41/tfenv

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

@@ -24,14 +24,15 @@ module Kitchen
       # against a system in the Terraform state.
       #
       # 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}. The profile must be implemented
-      # in the directory located at `<Kitchen root>/test/integration/<suite name>`.
+      # using the same {https://www.inspec.io/docs/reference/profiles/ InSpec profile} by default. 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 options of the
+      # 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.
       #
       # ===== Required Keys
@@ -66,7 +67,7 @@ module Kitchen
       # ===== Optional Keys
       #
       # The following keys may be included by any system to alter the behaviour of InSpec. Any key which is omitted
-      # will be associated with a default value as defined by InSpec.
+      # will be associated with a default value as defined by InSpec except where otherwise noted.
       #
       # ====== attrs
       #
@@ -297,6 +298,27 @@ module Kitchen
       #         backend: ssh
       #         port: 1234
       #
+      # ====== profile_locations
+      #
+      # The value of the <code>profile_locations</code> key is a sequence of scalars which is used to locate
+      # {https://www.inspec.io/docs/reference/profiles/ InSpec profiles} containing the controls to be executed against
+      # the system. This key corresponds to the LOCATIONS argument of <code>inspec exec</code>.
+      #
+      # The default value contains a single scalar which assumes that a profile exists locally for the associated
+      # {https://kitchen.ci/docs/getting-started/adding-suite Kitchen suite} at
+      # <code><KITCHEN ROOT>/test/integration/<KITCHEN SUITE NAME></code>.
+      #
+      # <em>Example kitchen.yml</em>
+      #   verifier:
+      #     name: terraform
+      #     systems:
+      #       - name: a system
+      #         backend: local
+      #         profile_locations:
+      #           - supermarket://username/linux-baseline
+      #           - /path/to/profile
+      #           - /path/to/a_test.rb
+      #
       # ====== proxy_command
       #
       # The value of the +proxy_command+ key is a scalar which is used as a proxy command when connecting to a host via
@@ -535,6 +557,7 @@ module Kitchen
         optional(:password).filled :str?
         optional(:path).filled :str?
         optional(:port).value :int?
+        optional(:profile_locations).each :filled?, :str?
         optional(:proxy_command).filled :str?
         optional(:reporter).each(:filled?, :str?)
         optional(:self_signed).value :bool?

data/lib/kitchen/terraform/inspec.rb

@@ -66,9 +66,11 @@ module Kitchen
 
       private
 
-      def initialize(options:, profile_path:)
+      def initialize(options:, profile_locations:)
         @runner = ::Inspec::Runner.new options.merge logger: ::Inspec::Log.logger
-        @runner.add_target path: profile_path
+        profile_locations.each do |profile_location|
+          @runner.add_target profile_location
+        end
       end
     end
   end

data/lib/kitchen/terraform/inspec_with_hosts.rb

@@ -29,20 +29,21 @@ module Kitchen
       def exec(system:)
         system.each_host do |host:|
           ::Kitchen::Terraform::InSpec
-            .new(options: options.merge(host: host), profile_path: profile_path)
-            .info(message: "Verifying host #{host} of #{system}").exec
+            .new(options: options.merge(host: host), profile_locations: profile_locations)
+            .info(message: "#{system}: Verifying host #{host}").exec
         end
       end
 
       private
 
-      attr_accessor :options, :profile_path
+      attr_accessor :options, :profile_locations
 
       # @param options [::Hash] options for execution.
-      # @param profile_path [::String] the path to the InSpec profile which contains the controls to be executed.
-      def initialize(options:, profile_path:)
+      # @param profile_locations [::Array<::String>] the locations of the InSpec profiles which contain the controls to
+      #   be executed.
+      def initialize(options:, profile_locations:)
         self.options = options
-        self.profile_path = profile_path
+        self.profile_locations = profile_locations
       end
     end
   end

data/lib/kitchen/terraform/inspec_without_hosts.rb

@@ -26,18 +26,19 @@ module Kitchen
       # @return [void]
       def exec(system:)
         ::Kitchen::Terraform::InSpec
-          .new(options: options, profile_path: profile_path).info(message: "Verifying #{system}").exec
+          .new(options: options, profile_locations: profile_locations).info(message: "#{system}: Verifying").exec
       end
 
       private
 
-      attr_accessor :options, :profile_path
+      attr_accessor :options, :profile_locations
 
       # @param options [::Hash] options for execution.
-      # @param profile_path [::String] the path to the InSpec profile which contains the controls to be executed.
-      def initialize(options:, profile_path:)
+      # @param profile_locations [::Array<::String>] the locations of the InSpec profiles which contain the controls to
+      #   be executed.
+      def initialize(options:, profile_locations:)
         self.options = options
-        self.profile_path = profile_path
+        self.profile_locations = profile_locations
       end
     end
   end

data/lib/kitchen/terraform/system.rb

@@ -66,11 +66,10 @@ module Kitchen
       # #verify verifies the system by executing InSpec.
       #
       # @param inspec_options [::Hash] the options to be passed to InSpec.
-      # @param inspec_profile_path [::String] the path to the profile which InSpec will execute.
       # @return [self]
-      def verify(inspec_options:, inspec_profile_path:, outputs:)
+      def verify(inspec_options:, outputs:)
         resolve outputs: outputs
-        execute_inspec options: inspec_options, profile_path: inspec_profile_path
+        execute_inspec options: inspec_options
 
         self
       rescue => error
@@ -79,10 +78,11 @@ module Kitchen
 
       private
 
-      def execute_inspec(options:, profile_path:)
-        inspec.new(options: options_with_attributes(options: options), profile_path: profile_path).exec(
-          system: self
-        )
+      def execute_inspec(options:)
+        inspec.new(
+          options: options_with_attributes(options: options),
+          profile_locations: @mapping.fetch(:profile_locations)
+        ).exec(system: self)
       end
 
       def initialize(mapping:)

data/lib/kitchen/terraform/version.rb

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

data/lib/kitchen/verifier/terraform.rb

@@ -122,6 +122,7 @@ module Kitchen
         if config_fail_fast
           raise ::Kitchen::Terraform::Error, message
         else
+          logger.error message
           @error_messages.push message
         end
       end
@@ -139,9 +140,6 @@ module Kitchen
         @outputs = {}
       end
 
-      def inspec_profile_path
-        @inspec_profile_path ||= ::File.join config.fetch(:test_base_path), instance.suite.name
-      end
 
       # load_needed_dependencies! loads the InSpec libraries required to verify a Terraform state.
       #
@@ -160,11 +158,9 @@ module Kitchen
       end
 
       def verify(system:)
-        ::Kitchen::Terraform::System.new(mapping: system).verify(
-          inspec_options: system_inspec_options(system: system),
-          inspec_profile_path: inspec_profile_path,
-          outputs: @outputs
-        )
+        ::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)
       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.6.0
+  version: 4.7.0
 platform: ruby
 authors:
 - Aaron Lane
@@ -61,7 +61,7 @@ cert_chain:
   XAjP/LERlXAwM+NCUycJw7BZMn7L2wIdnq6Le1rL6VJS17CZt2heuRtsF+3g0egR
   x97GmUumeM67PGeVodlIV65tdXrdlqKlHcE=
   -----END CERTIFICATE-----
-date: 2019-04-11 00:00:00.000000000 Z
+date: 2019-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard-bundler