kitchen-terraform 1.0.2 → 2.0.0

data/lib/kitchen/verifier/terraform.rb

@@ -16,153 +16,65 @@
 
 require "dry/monads"
 require "kitchen"
-require "kitchen/terraform/define_config_attribute"
+require "kitchen/terraform/config_attribute/color"
+require "kitchen/terraform/config_attribute/groups"
+require "kitchen/terraform/configurable"
 require "kitchen/verifier/inspec"
-require "terraform/configurable"
 
-# The verifier utilizes the InSpec infrastructure testing framework to verify the behaviour and state of resources in
-# the Terraform state.
+# The kitchen-terraform verifier utilizes the InSpec infrastructure testing framework to verify the behaviour and state
+# of resources in the Terraform state.
 #
-# InSpec profiles are assumed to be located in `test/integration/<suite-name>/`.
+# It is a subclass of the kitchen-inspec verifier.
 #
-# === Configuration
+# === Test Kitchen Configuration
 #
-# ==== Example .kitchen.yml snippet
+# The configuration of the verifier is used to control the behaviour of the InSpec runner.
+#
+# More information about the available configuration attributes is located with the respective modules.
+#
+# Test Kitchen configuration is defined in +.kitchen.yml+ and optionally overridden in +.kitchen.local.yml+.
+#
+# ==== Example
 #
 #   verifier:
-#     name: terraform
+#     name: "terraform"
+#     color: false
 #     groups:
-#       - name: group_one
+#       -
+#         name: "group_one"
 #         attributes:
-#           foo: bar
+#           foo: "bar"
 #         controls:
-#           - biz
-#         hostnames: hostnames_output
-#         port: 123
-#         username: test-user
-#       - name: group_two
-#
-# ==== Attributes
-#
-# ===== groups
-#
-# Description:: A collection of maps that configure which InSpec profile will be run against different resources in the
-#               Terraform state.
-#
-# Type:: Array
-#
-# Status:: Optional
-#
-# Default:: +[]+
-#
-# ====== name
-#
-# Description:: A label that is used to identify the group.
-#
-# Type:: String
-#
-# Status:: Required
-#
-# ====== attributes
-#
-# Description:: A map that associates InSpec profile attribute names to Terraform output variable names.
-#
-# Type:: Hash
-#
-# Status:: Optional
-#
-# Default:: +{}+
-#
-# ====== controls
-#
-# Description:: A collection of controls to selectively include from the suite's InSpec profile.
-#
-# Type:: Array
+#           - "biz"
+#         hostnames: "hostnames_output"
+#         port: "123"
+#         username: "test-user"
+#       -
+#         name: "group_two"
 #
-# Status:: Optional
+# === InSpec Profiles
 #
-# Default:: +[]+
-#
-# ====== hostnames
-#
-# Description:: The name of a Terraform output variable of type String or Array which contains one or more hostnames
-#               from the Terraform state that will be targeted with the suite's InSpec profile.
-#
-# Type:: String
-#
-# Status:: Optional
-#
-# ====== port
-#
-# Description:: The port to use when connecting to the group's hosts with Secure Shell (SSH).
-#
-# Type:: Integer
-#
-# Status:: Optional
-#
-# ====== username
-#
-# Description:: The username to use when connecting to the group's hosts with SSH.
-#
-# Type:: String
-#
-# Status:: Optional
+# The InSpec profile for a Test Kitchen suite exists under +./test/integration/<Test Kitchen suite name>/+.
 #
+# @see ::Kitchen::Terraform::ConfigAttribute::Color
+# @see ::Kitchen::Terraform::ConfigAttribute::Groups
 # @see https://en.wikipedia.org/wiki/Secure_Shell Secure Shell
+# @see https://github.com/chef/kitchen-inspec/ kitchen-inspec
+# @see https://github.com/chef/kitchen-inspec/blob/master/lib/kitchen/verifier/inspec.rb kitchen-inspec: Verifier
 # @see https://www.inspec.io/ InSpec
-# @see https://www.inspec.io/docs/reference/dsl_inspec/ InSpec Controls
-# @see https://www.inspec.io/docs/reference/profiles/ InSpec Profiles
-# @see https://www.terraform.io/docs/configuration/outputs.html Terraform Output Variables
-# @see https://www.terraform.io/docs/state/index.html Terraform State
+# @see https://www.inspec.io/docs/reference/profiles/ InSpec: Profiles
+# @see https://www.terraform.io/docs/state/index.html Terraform: State
 # @version 2
 class ::Kitchen::Verifier::Terraform < ::Kitchen::Verifier::Inspec
   kitchen_verifier_api_version 2
 
-  ::Kitchen::Terraform::DefineConfigAttribute.call(
-    attribute: :groups,
-    initialize_default_value: lambda do |_plugin|
-      []
-    end,
-    plugin_class: self,
-    schema: lambda do
-      configure do
-        def self.messages
-          super.merge en: {
-            errors: {
-              keys_are_strings_or_symbols?: "keys must be strings or symbols",
-              values_are_strings?: "values must be strings"
-            }
-          }
-        end
-
-        def keys_are_strings_or_symbols?(hash)
-          hash.keys.all? do |key|
-            key.is_a?(::String) | key.is_a?(::Symbol)
-          end
-        end
+  include ::Dry::Monads::Either::Mixin
 
-        def values_are_strings?(hash)
-          hash.values.all? do |value|
-            value.is_a? ::String
-          end
-        end
-      end
-      required(:value).each do
-        schema do
-          required(:name).filled :str?
-          optional(:attributes).value :hash?, :keys_are_strings_or_symbols?, :values_are_strings?
-          optional(:controls).each :filled?, :str?
-          optional(:hostnames).value :str?
-          optional(:port).value :int?
-          optional(:username).value :str?
-        end
-      end
-    end
-  )
+  include ::Kitchen::Terraform::ConfigAttribute::Color
 
-  include ::Dry::Monads::Either::Mixin
+  include ::Kitchen::Terraform::ConfigAttribute::Groups
 
-  include ::Terraform::Configurable
+  include ::Kitchen::Terraform::Configurable
 
   # The verifier enumerates through each hostname of each group and verifies the associated InSpec controls.
   #
@@ -172,13 +84,13 @@ class ::Kitchen::Verifier::Terraform < ::Kitchen::Verifier::Inspec
   # @raise [::Kitchen::ActionFailed] if the result of the action is a failure.
   # @return [::Dry::Monads::Either] the result of the action.
   def call(state)
-    self.class::EnumerateGroupsAndHostnames.call driver: driver, groups: config.fetch(:groups) do |group:, hostname:|
+    self.class::EnumerateGroupsAndHostnames.call driver: driver, groups: config_groups do |group:, hostname:|
       state.store :group, group
       state.store :hostname, hostname
       info "Verifying host '#{hostname}' of group '#{group.fetch :name}'"
       super state
-    end.fmap do |success|
-      logger.debug success
+    end.bind do |success|
+      Right logger.debug success
     end.or do |failure|
       raise ::Kitchen::ActionFailed, failure
     end
@@ -192,7 +104,6 @@ class ::Kitchen::Verifier::Terraform < ::Kitchen::Verifier::Inspec
   # @api private
   # @return [::Hash] Inspec Runner options.
   # @see https://github.com/chef/inspec/blob/master/lib/inspec/runner.rb ::Inspec::Runner
-  # @see https://github.com/chef/kitchen-inspec/blob/master/lib/kitchen/verifier.rb kitchen-inspec verifier
   def runner_options(transport, state = {}, platform = nil, suite = nil)
     super(transport, state, platform, suite).tap do |options|
       self.class::ConfigureInspecRunnerBackend.call hostname: state.fetch(:hostname), options: options

data/lib/kitchen/verifier/terraform/configure_inspec_runner_attributes.rb

@@ -69,8 +69,11 @@ module ::Kitchen::Verifier::Terraform::ConfigureInspecRunnerAttributes
   # @return [::Dry::Monads::Either] the result of the function
   def self.call(driver:, group:, terraform_state:)
     Right("terraform_state" => terraform_state).bind do |attributes|
-      driver.output.fmap do |output|
-        [attributes, output]
+      driver.output.bind do |output|
+        Right [
+          attributes,
+          output
+        ]
       end
     end.bind do |attributes, output|
       Try ::KeyError do
@@ -79,13 +82,13 @@ module ::Kitchen::Verifier::Terraform::ConfigureInspecRunnerAttributes
         end
         [attributes, output]
       end
-    end.fmap do |attributes, output|
+    end.bind do |attributes, output|
       Maybe(group[:attributes]).bind do |group_attributes|
         group_attributes.each_pair do |attribute_name, output_name|
           attributes.store attribute_name.to_s, output.fetch(output_name.to_s).fetch("value")
         end
       end
-      attributes
+      Right attributes
     end.to_either.or do |error|
       Left "configuring Inspec::Runner attributes failed\n#{error}"
     end

data/lib/kitchen/verifier/terraform/enumerate_groups_and_hostnames.rb

@@ -60,8 +60,8 @@ module ::Kitchen::Verifier::Terraform::EnumerateGroupsAndHostnames
           Right block.call group: group, hostname: "localhost"
         end
       end
-    end.fmap do
-      "finished enumeration of groups and hostnames"
+    end.bind do
+      Right "finished enumeration of groups and hostnames"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-terraform
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Aaron Lane
@@ -23,28 +23,38 @@ bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIDjjCCAnagAwIBAgIBATANBgkqhkiG9w0BAQUFADBGMRMwEQYDVQQDDAphYXJv
+  MIIFjjCCA3agAwIBAgIBATANBgkqhkiG9w0BAQUFADBGMRMwEQYDVQQDDAphYXJv
   bi5sYW5lMRowGAYKCZImiZPyLGQBGRYKbmV3Y29udGV4dDETMBEGCgmSJomT8ixk
-  ARkWA2NvbTAeFw0xNjA3MjIxODAzMzNaFw0xNzA3MjIxODAzMzNaMEYxEzARBgNV
+  ARkWA2NvbTAeFw0xNzA5MTQwMzMxNDJaFw0xODA5MTQwMzMxNDJaMEYxEzARBgNV
   BAMMCmFhcm9uLmxhbmUxGjAYBgoJkiaJk/IsZAEZFgpuZXdjb250ZXh0MRMwEQYK
-  CZImiZPyLGQBGRYDY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA
-  1MSucgJvoMZmrwOGvdgbtCfhnDATQk7K2ab9zskq/dCemRp3go/Zq9o7NPxP8zbo
-  Eaek77rRQIbcVkv5afA7NchY0ndEWiESIETYTaiFDb7ayl2zSBNlffY+Ot1pYfsR
-  DzChXPFOMWLZKTjVxSw+uP/uW5X6v/Oo1OKBVjNbOTA+bQJ8lrgAht0U/78xYQ8U
-  55GvbJG9JaZbKh3JQMk24I7D5Y2HS+m5heE+EcgFOjtdgVFBF8ANMOUmmuv1YfLg
-  ZPAbqEcM2G/7FNq0CEPmcGEBcVSTmp+2yO/tSZ/z4aT9N53eq6Jv7SmIpmbfVLLT
-  yVwOIkynWceVDlfKx/l6nwIDAQABo4GGMIGDMAkGA1UdEwQCMAAwCwYDVR0PBAQD
-  AgSwMB0GA1UdDgQWBBS8ziFqW+VD1xS+MDeG+/1tTtyWTDAkBgNVHREEHTAbgRlh
-  YXJvbi5sYW5lQG5ld2NvbnRleHQuY29tMCQGA1UdEgQdMBuBGWFhcm9uLmxhbmVA
-  bmV3Y29udGV4dC5jb20wDQYJKoZIhvcNAQEFBQADggEBAEcUZAIF5QRFQU6YnO3s
-  axJJJ6okQiBjCI4IJcmkrDgZkg6rLA9enFSvu0LCR7BdZvY2d15WOABI0uL+H4rG
-  1+PjgRLGli+5gVpCNiHJr1Jnk3pRRqgbcvbDbGOXkOc+PIeVFR+VAo2rsyt7hXku
-  COSYOAQah0+rOT7/B4vC5pwCVKnJ/Buyt6hGGRJUaOE3NoGcf6rl6N2AfV7a2inp
-  bn5YnUfdwK56LsUAp9MEpqs8NfaZV9midxSztw9M16j5PgOT19RBOCGcks0g5K8U
-  KucGZX3OeACVUSpmCOCQyma6sDHYWQZM/IgWi7tbLtG5b2GslkauPm4S3wadHi6W
-  LOU=
+  CZImiZPyLGQBGRYDY29tMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEA
+  6SlE8WTS9Jx2647BAxjQNp8rmt4503z3MNZDN2Ee2xOi/9BLTrRNDEEN3KL06ekN
+  3a1KoEQv4Q34w3RJYUZTTH8758+X586wcpE4OSBpKmCmnnvnCQ41AmAgmulx3a23
+  eon/4r6QDaOet7GOW8HMlKSLokyAGlqqkJKasiAtYF8c1RBt4PRb7spsOyD1fx6d
+  2dOsEe8nC5AE+JUVLb51aXCaeBGr8kxJLBkPvOouI2fZxnh3T7IbKhJgHi0G4FU2
+  5p2nKeqcJkeGw8ZuVO58ttb4HELYgZgyr+WzhBjGaPLIF9sUvT0ou+feY67/Ds+K
+  E6ibwNPxBZra5x9wqeBoIKFu56CrTzBCL6EpY+gfhPSn2evJujccBjUcRi1w+V7z
+  eRjYOQaTg1OzJC8ZaGSVi8F69v7WSLwQKKn1NJtrGHzz3i1q/0vsin8WL7qluYh/
+  fjt+vfqS0FB8CWZnXchOCT4uIYYRs1QI6wsVSRj+qoWMh+nDGlaaVXlKQInBUnlC
+  gRfTbCC61AMywFCSaUapfsZbfUC5bs1aGEZiefITyFQ2/mLiuBz4itx3nkWRXjYk
+  12cjlhMtyNhlc522RqZpb9ASL5SwXc4yVx88lSoYNa4baFEvdvXke66b7gk0e0Fy
+  7FwaprnMxgOzqGNVS3I2FxGoPaw2Xm8fAu44irCsavcCAwEAAaOBhjCBgzAJBgNV
+  HRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQUbK28Yq+mCLk/xOMbjtmyPCaA
+  Dm4wJAYDVR0RBB0wG4EZYWFyb24ubGFuZUBuZXdjb250ZXh0LmNvbTAkBgNVHRIE
+  HTAbgRlhYXJvbi5sYW5lQG5ld2NvbnRleHQuY29tMA0GCSqGSIb3DQEBBQUAA4IC
+  AQB9cEhqE6y3xULIMuYGmFqgNb7+X5/yQgMgNZ/hSOOOeLqJG+Hi5ju9fE3Gph6/
+  6BSfpE4ebzdM+oHJymCq7X6SckGbJFz7QO2j8u1tXUVgN9nxx4CFA2y0aBYhVNVM
+  9MMc23x9/425ajx/566gDv4v21iXOEd/vtqdGzBYsVFlNthBAV+Bv4uom9mOb7WA
+  Ru77ydRePbyBLeeEU46QiimhQpHkPxcIa6jjSoOf3pOATGq6vh2zcNXepsO/3wnw
+  G3xgAys43aUU+TiCBYruQ1P7xchbWGxCjk2ShFx9GWhThAi/0cUFl8uTi3dUd52R
+  m9a1mkr0D6TWUl4xe/b6OU9Kc6w1tJoSVnuyabBZuTfzi/QUa014m7SK/JgyPay8
+  kNPUrxdWziojztp6tDYnZfNWeRyehRzdrdi4AZNrrmesdIpmevnCadt+vjSw7C11
+  vP6lkMIqRPl1kkpVbab6ljszfzZXGMsSilrbLeuC8ey+eymPhghdBM0Fxx+9zVvI
+  txx/nHF8OT3dFr5sni1qko0hXzKhv6OolNU+9a9CVS/+apVKRyoYu7GFFBdLBdGc
+  XjOfZudLs1zJ8ZNOuwj6KkGJ9J3XHd9hM95MtBEWlxAfYdCuW1+v7zCTfbieBEba
+  UIyyldg4TuVcuRs8uKJyempT0hqx2DniseBWw3nvtgom3A==
   -----END CERTIFICATE-----
-date: 2017-07-17 00:00:00.000000000 Z
+date: 2017-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
@@ -262,15 +272,16 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: 1.16.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
-description: 
+        version: 1.16.0
+description: kitchen-terraform is a set of Test Kitchen plugins for testing Terraform
+  configuration
 email: kitchen-terraform@newcontext.com
 executables: []
 extensions: []
@@ -279,23 +290,42 @@ files:
 - LICENSE
 - README.md
 - lib/kitchen/driver/terraform.rb
-- lib/kitchen/driver/terraform/verify_client_version.rb
-- lib/kitchen/driver/terraform/workflow.rb
 - lib/kitchen/provisioner/terraform.rb
 - lib/kitchen/terraform.rb
+- lib/kitchen/terraform/clear_directory.rb
 - lib/kitchen/terraform/client.rb
-- lib/kitchen/terraform/client/apply.rb
-- lib/kitchen/terraform/client/execute_command.rb
-- lib/kitchen/terraform/client/get.rb
-- lib/kitchen/terraform/client/output.rb
-- lib/kitchen/terraform/client/plan.rb
-- lib/kitchen/terraform/client/process_options.rb
-- lib/kitchen/terraform/client/validate.rb
-- lib/kitchen/terraform/client/version.rb
+- lib/kitchen/terraform/client/command.rb
+- lib/kitchen/terraform/client/options.rb
+- lib/kitchen/terraform/client_version_verifier.rb
+- lib/kitchen/terraform/config_attribute.rb
+- lib/kitchen/terraform/config_attribute/backend_configurations.rb
+- lib/kitchen/terraform/config_attribute/color.rb
+- lib/kitchen/terraform/config_attribute/command_timeout.rb
+- lib/kitchen/terraform/config_attribute/directory.rb
+- lib/kitchen/terraform/config_attribute/groups.rb
+- lib/kitchen/terraform/config_attribute/lock_timeout.rb
+- lib/kitchen/terraform/config_attribute/parallelism.rb
+- lib/kitchen/terraform/config_attribute/plugin_directory.rb
+- lib/kitchen/terraform/config_attribute/state.rb
+- lib/kitchen/terraform/config_attribute/variable_files.rb
+- lib/kitchen/terraform/config_attribute/variables.rb
+- lib/kitchen/terraform/config_attribute/verify_plugins.rb
+- lib/kitchen/terraform/config_attribute_cacher.rb
+- lib/kitchen/terraform/config_attribute_definer.rb
+- lib/kitchen/terraform/config_predicates.rb
+- lib/kitchen/terraform/config_predicates/hash_of_symbols_and_strings.rb
+- lib/kitchen/terraform/config_schemas.rb
+- lib/kitchen/terraform/config_schemas/array_of_hashes_of_symbols_and_strings.rb
+- lib/kitchen/terraform/config_schemas/array_of_strings.rb
+- lib/kitchen/terraform/config_schemas/boolean.rb
+- lib/kitchen/terraform/config_schemas/hash_of_symbols_and_strings.rb
+- lib/kitchen/terraform/config_schemas/integer.rb
+- lib/kitchen/terraform/config_schemas/optional_string.rb
+- lib/kitchen/terraform/config_schemas/string.rb
+- lib/kitchen/terraform/configurable.rb
 - lib/kitchen/terraform/create_directories.rb
-- lib/kitchen/terraform/define_config_attribute.rb
-- lib/kitchen/terraform/define_integer_config_attribute.rb
-- lib/kitchen/terraform/define_string_config_attribute.rb
+- lib/kitchen/terraform/file_path_config_attribute_definer.rb
+- lib/kitchen/terraform/version.rb
 - lib/kitchen/verifier/terraform.rb
 - lib/kitchen/verifier/terraform/configure_inspec_runner_attributes.rb
 - lib/kitchen/verifier/terraform/configure_inspec_runner_backend.rb
@@ -304,10 +334,6 @@ files:
 - lib/kitchen/verifier/terraform/configure_inspec_runner_port.rb
 - lib/kitchen/verifier/terraform/configure_inspec_runner_user.rb
 - lib/kitchen/verifier/terraform/enumerate_groups_and_hostnames.rb
-- lib/terraform.rb
-- lib/terraform/configurable.rb
-- lib/terraform/debug_logger.rb
-- lib/terraform/project_version.rb
 homepage: https://github.com/newcontext-oss/kitchen-terraform
 licenses:
 - Apache-2.0
@@ -330,10 +356,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements:
-- Terraform >= 0.7, < 0.10
+- Terraform ~> 0.10.2
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
-summary: Test Kitchen plugins for testing Terraform projects
+summary: Test Kitchen plugins for testing Terraform configuration
 test_files: []

data/lib/kitchen/driver/terraform/verify_client_version.rb

@@ -1,44 +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 "kitchen/driver/terraform"
-
-# Verifies that the provided Terraform Client version is supported.
-#
-# Supported:: Terraform version 0.9.
-#
-# Deprecated:: Terraform versions 0.7 and 0.8.
-#
-# Not Supported:: Terraform versions 0.6 and older.
-module ::Kitchen::Driver::Terraform::VerifyClientVersion
-  extend ::Dry::Monads::Either::Mixin
-
-  # Invokes the function.
-  #
-  # @param version [::Float] the Terraform Client version.
-  # @return [::Dry::Monads::Either] the result of the function.
-  def self.call(version:)
-    if version == 0.9
-      Right "Terraform version #{version} is supported"
-    elsif (0.7..0.8).cover? version
-      Right "Terraform version #{version} is deprecated and will not be supported by kitchen-terraform version " \
-              "2.0; upgrade to Terraform version 0.9 to remain supported"
-    else
-      Left "Terraform version #{version} is not supported; supported Terraform versions are 0.7 through 0.9"
-    end
-  end
-end