kitchen-terraform 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fab118f04f2357e74aea7dc6cd9a3d41ce176e86
-  data.tar.gz: 1184130c5eb929bb545689877cb6b4d86896be7c
+  metadata.gz: 1df0e3998d394adc8988feb446bfc1149575e5a0
+  data.tar.gz: 0f0915e9ad1c7be1a4c941bf4b0d357a455d6b4e
 SHA512:
-  metadata.gz: 2920103244e6bed6c7679692d86a21770f16cad1f6bf8346ef1db3f8f5afc78eba46105c0a7b444cedc227cce550dff0bba56c32f86dbdae23da647dfa1cbe79
-  data.tar.gz: e4656ec4baaf076ba378ff90db2c6972c5e25ed3de91024f72bd826c0257aac91a47c8438db1e223f68a64af19759c49ae22bacbb202153fdbb3944bac9409d9
+  metadata.gz: eca7ed84aaa1026a85260bffca9696d0f5d0af5c3b14a414ae97514fed568ef95b17eacd89bac1e474be491ed4a2a399475b37daafae62e27836854260c83e66
+  data.tar.gz: 9db90acbe78ad0f876de61b00af6ec2a490115a4a82ed21be8ec35351e24ba19834d4c7a2e3a6a3c31704e560ba185c6bcf9b78b9a9c8e6a856614341074f032

data/README.md

@@ -1,4 +1,10 @@
-# kitchen-terraform
+# ![kitchen-terraform logo](assets/logo.png) kitchen-terraform
+
+[![Gem Version](https://badge.fury.io/rb/kitchen-terraform.svg)](https://badge.fury.io/rb/kitchen-terraform)
+[![Code Climate](https://codeclimate.com/github/newcontext-oss/kitchen-terraform/badges/gpa.svg)](https://codeclimate.com/github/newcontext-oss/kitchen-terraform)
+[![Issue Count](https://codeclimate.com/github/newcontext-oss/kitchen-terraform/badges/issue_count.svg)](https://codeclimate.com/github/newcontext-oss/kitchen-terraform)
+[![Build Status Master](https://travis-ci.org/newcontext-oss/kitchen-terraform.svg?branch=master)](https://travis-ci.org/newcontext-oss/kitchen-terraform)
+[![Test Coverage](https://codeclimate.com/github/newcontext-oss/kitchen-terraform/badges/coverage.svg)](https://codeclimate.com/github/newcontext-oss/kitchen-terraform/coverage)
 
 kitchen-terraform is a set of [Test Kitchen] plugins for testing
 [Terraform configuration].
@@ -9,7 +15,7 @@ kitchen-terraform is a set of [Test Kitchen] plugins for testing
 
 ## Requirements
 
-- [Ruby] **(~> 2.3)**
+- [Ruby] **(~> 2.1)**
 
 - [Bundler] **(~> 1.12)**
 
@@ -31,9 +37,9 @@ which means it can be [installed with Bundler].
 Once Bundler is installed, add kitchen-terraform to the project's Gemfile:
 
 ```rb
-source 'https://rubygems.org'
-
-gem 'kitchen-terraform', '~> 0.1'
+source 'https://rubygems.org/' do
+  gem 'kitchen-terraform', '~> 0.4'
+end
 ```
 
 Then, use Bundler to install the gems:
@@ -175,6 +181,23 @@ provisioner:
 
 The default `directory` is the current working directory of Test Kitchen.
 
+##### parallelism
+
+The number of concurrent operations to allow for the Terraform `apply` and
+`plan` commands.
+
+###### Example .kitchen.yml
+
+```yaml
+provisioner:
+  name: terraform
+  parallelism: 2
+```
+
+###### Default
+
+The default `parallelism` is 10.
+
 ##### variable_files
 
 A collection of pathnames of [Terraform variable files] to be evaluated
@@ -262,43 +285,50 @@ configuration defined by that plugin with the exception of the `port` and
 
 ##### groups
 
-A collection of group mappings containing [InSpec control] and
-connection options for the different server instance groups in the
+A collection of mappings that define how to test different resources in the
 Terraform configuration.
 
-[InSpec control]: http://inspec.io/docs/reference/dsl_inspec/
-
 Each group consists of:
 
-- a name to use for logging purposes
+- a `name` to use for logging purposes
 
-- a mapping of InSpec attribute names to Terraform output variable
-  names to define for the suite's InSpec profile
+- an optional `attributes` mapping of InSpec profile attribute names to
+  Terraform output variable names to define for the suite's InSpec profile
 
-- a collection of controls to include from the suite's InSpec profile
+- a `controls` collection of [InSpec controls] to include from the suite's
+  InSpec profile
 
-- a hostnames output variable name to use for extracting hostnames from
-  the Terraform state; the output value is assumed to be in CSV format
+- a mapping of InSpec profile attribute names to Terraform output variable
+  names; the attributes will be with the resolved output values
 
-- the port to use when connecting to the group's hosts
+- an optional `hostnames` output variable name to use for extracting hostnames
+  from the Terraform state; the resolved output value is assumed to be a
+  list of strings or a string in CSV format
 
-- the username to use when connecting to the group's hosts
+- an optional `port` to use when connecting to the group's hosts
+
+- an optional `username` to use when connecting to the group's hosts
+
+If `hostnames` is empty then the group's `controls` will be executed
+locally; this enables testing of a provider's API to verify non-server
+resources.
+
+[InSpec controls]: http://inspec.io/docs/reference/dsl_inspec/
 
 ###### Example .kitchen.yml
 
 ```yaml
----
 verifier:
   name: terraform
   groups:
-    - name: arbitrary
-      attributes:
-        foo: bar
-      controls:
-        - biz
-      hostnames: hostnames_output
-      port: 123
-      username: test-user
+  - name: arbitrary
+    attributes:
+      foo: bar
+    controls:
+    - biz
+    hostnames: hostnames_output
+    port: 123
+    username: test-user
 ```
 
 ###### Defaults
@@ -307,10 +337,14 @@ The default `groups` collection is empty.
 
 For each group:
 
-- the default `attributes` mapping is empty
+- the default `attributes` mapping consists of equivalently named
+  attributes for each output variable; additional or overridden
+  associations can be added.
 
 - the default `controls` collection is empty
 
+- the default `hostnames` string is empty
+
 - the default `port` is obtained from the transport
 
 - the default `username` is obtained from the transport

data/lib/kitchen/driver/terraform.rb

@@ -48,12 +48,11 @@ module Kitchen
 
       def verify_dependencies
         case version
-        when /v0\.7/
+        when /(v[^0]|v0\.[^67])/
+          raise Kitchen::UserError, 'Only Terraform v0.7 and v0.6 are supported'
         when /v0\.6/
           log_deprecation aspect: 'v0.6', remediation: 'Update to v0.7',
                           version: '1.0'
-        else
-          raise Kitchen::UserError, 'Only Terraform v0.7 and v0.6 are supported'
         end
       end
     end

data/lib/kitchen/provisioner/terraform.rb

@@ -19,6 +19,7 @@ require 'terraform/apply_timeout_config'
 require 'terraform/color_config'
 require 'terraform/configurable'
 require 'terraform/directory_config'
+require 'terraform/parallelism_config'
 require 'terraform/plan_config'
 require 'terraform/state_config'
 require 'terraform/variable_files_config'
@@ -36,6 +37,8 @@ module Kitchen
 
       include ::Terraform::DirectoryConfig
 
+      include ::Terraform::ParallelismConfig
+
       include ::Terraform::PlanConfig
 
       include ::Terraform::StateConfig

data/lib/kitchen/verifier/terraform.rb

@@ -29,48 +29,63 @@ module Kitchen
 
       kitchen_verifier_api_version 2
 
+      def call(state)
+        verify_groups options: runner_options(transport, state)
+      end
+
+      private
+
       def add_targets(runner:)
         collect_tests.each { |test| runner.add_target test }
       end
 
-      def call(state)
-        self.inspec_runner_options = runner_options transport, state
-        config[:groups].each { |group| group.evaluate verifier: self }
+      def execute(group:, options:)
+        options.merge! group.options
+        ::Inspec::Runner.new(options).tap do |runner|
+          add_targets runner: runner
+          validate exit_code: runner.run
+        end
       end
 
-      def execute
-        ::Terraform::InspecRunner.new(inspec_runner_options)
-                                 .tap do |inspec_runner|
-                                   inspec_runner.evaluate verifier: self
-                                 end
+      def execute_local(group:, options:)
+        options[:backend] = 'local'
+        info "Verifying group '#{group.name}'"
+        execute group: group, options: options
       end
 
-      def merge(options:)
-        inspec_runner_options.merge! options
+      def execute_remote(group:, options:)
+        driver.output_value list: true, name: group.hostnames do |hostname|
+          options[:host] = hostname
+          info "Verifying host '#{hostname}' of group '#{group.name}'"
+          execute group: group, options: options
+        end
       end
 
       def resolve_attributes(group:)
+        driver.each_output_name do |output_name|
+          group.store_attribute key: output_name, value: output_name
+        end
         group.each_attribute do |key, output_name|
           group.store_attribute key: key,
                                 value: driver.output_value(name: output_name)
         end
       end
 
-      def resolve_hostnames(group:, &block)
-        driver.output_value list: true, name: group.hostnames, &block
-      end
+      def validate(exit_code:)
+        return if exit_code.zero?
 
-      def verify(exit_code:)
-        raise InstanceFailure, "Inspec Runner returns #{exit_code}" unless
-          exit_code.zero?
+        raise ::Kitchen::InstanceFailure, "Inspec Runner returns #{exit_code}"
       end
 
-      private
-
-      attr_accessor :inspec_runner_options
+      def verify(group:, options:)
+        resolve_attributes group: group
+        group.if_local { return execute_local group: group, options: options }
+        execute_remote group: group, options: options
+      end
 
-      def load_needed_dependencies!
-        require 'terraform/inspec_runner'
+      def verify_groups(options:)
+        config[:groups]
+          .each { |group| verify group: group, options: options.dup }
       end
     end
   end

data/lib/terraform/apply_command.rb

@@ -27,15 +27,16 @@ module Terraform
     end
 
     def options
-      "-input=false -state=#{state} #{color_switch}"
+      "-input=false -parallelism=#{parallelism} -state=#{state} #{color_switch}"
     end
 
     private
 
-    attr_accessor :state
+    attr_accessor :parallelism, :state
 
-    def initialize_attributes(color:, state:)
+    def initialize_attributes(color:, parallelism:, state:)
       self.color = color
+      self.parallelism = parallelism
       self.state = state
     end
   end

data/lib/terraform/client.rb

@@ -30,8 +30,8 @@ module Terraform
 
     def apply_execution_plan
       execute command: ApplyCommand.new(
-        color: provisioner[:color], state: provisioner[:state],
-        target: provisioner[:plan]
+        color: provisioner[:color], parallelism: provisioner[:parallelism],
+        state: provisioner[:state], target: provisioner[:plan]
       ), timeout: provisioner[:apply_timeout]
     end
 
@@ -54,13 +54,17 @@ module Terraform
       ) { |value| list ? value.each(&block) : (return value) }
     end
 
+    def each_output_name(&block)
+      execute(
+        command: OutputCommand.new(
+          list: false, state: provisioner[:state], version: version,
+          return_raw: true
+        )
+      ) { |output| JSON.parse(output).each_key(&block) }
+    end
+
     def plan_execution(destroy:)
-      execute command: PlanCommand.new(
-        color: provisioner[:color], destroy: destroy, out: provisioner[:plan],
-        state: provisioner[:state], target: provisioner[:directory],
-        variables: provisioner[:variables],
-        variable_files: provisioner[:variable_files]
-      )
+      execute command: plan_command(destroy: destroy)
     end
 
     def validate_configuration_files
@@ -72,5 +76,16 @@ module Terraform
         return value.slice(/v\d+\.\d+\.\d+/)
       end
     end
+
+    private
+
+    def plan_command(destroy:)
+      PlanCommand
+        .new color: provisioner[:color], destroy: destroy,
+             out: provisioner[:plan], parallelism: provisioner[:parallelism],
+             state: provisioner[:state], target: provisioner[:directory],
+             variables: provisioner[:variables],
+             variable_files: provisioner[:variable_files]
+    end
   end
 end

data/lib/terraform/command.rb

@@ -52,8 +52,7 @@ module Terraform
                        .new "terraform #{name} #{options} #{target}", returns: 0
     end
 
-    def initialize_attributes(**_keyword_arguments)
-    end
+    def initialize_attributes(**_keyword_arguments) end
 
     def processed_output(raw_output:)
       raw_output

data/lib/terraform/group.rb

@@ -14,27 +14,34 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'kitchen/util'
+
 module Terraform
   # Group of Terraform server instances to be verified
   class Group
     def each_attribute(&block)
-      data[:attributes].each_pair(&block)
-    end
-
-    def evaluate(verifier:)
-      verifier.merge options: options
-      verifier.resolve_attributes group: self
-      verifier.resolve_hostnames group: self do |hostname|
-        verifier.info "Verifying host '#{hostname}' of group '#{data[:name]}'"
-        verifier.merge options: { host: hostname }
-        verifier.execute
-      end
+      data[:attributes].dup.each_pair(&block)
     end
 
     def hostnames
       data[:hostnames]
     end
 
+    def if_local
+      yield if hostnames.empty?
+    end
+
+    def name
+      data[:name]
+    end
+
+    def options
+      {
+        attributes: attributes, controls: data[:controls], port: data[:port],
+        user: data[:username]
+      }
+    end
+
     def store_attribute(key:, value:)
       data[:attributes][key] = value
     end
@@ -43,15 +50,12 @@ module Terraform
 
     attr_accessor :data
 
-    def initialize(data:)
-      self.data = data
+    def attributes
+      ::Kitchen::Util.stringified_hash data[:attributes]
     end
 
-    def options
-      {
-        attributes: data[:attributes], controls: data[:controls],
-        port: data[:port], user: data[:username]
-      }
+    def initialize(data:)
+      self.data = data
     end
   end
 end

data/lib/terraform/output_command.rb

@@ -30,12 +30,13 @@ module Terraform
 
     private
 
-    attr_accessor :list, :state
+    attr_accessor :list, :state, :return_raw
 
-    def initialize_attributes(list:, version:, state:)
+    def initialize_attributes(list:, version:, state:, return_raw: false)
       extend_behaviour version: version
       self.list = list
       self.state = state
+      self.return_raw = return_raw
     end
 
     def version_behaviours

data/lib/terraform/{inspec_runner.rb → parallelism_config.rb}

@@ -14,25 +14,21 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'inspec'
-require 'kitchen'
-
 module Terraform
-  # Inspec::Runner with convenience methods for use by
-  # Kitchen::Verifier::Terraform
-  class InspecRunner < Inspec::Runner
-    attr_reader :conf
-
-    def evaluate(verifier:)
-      verifier.add_targets runner: self
-      verifier.verify exit_code: run
+  # Behaviour for the [:parallelism] config option
+  module ParallelismConfig
+    def self.included(configurable_class)
+      configurable_class
+        .required_config :parallelism do |_, value, configurable|
+          configurable.coerce_parallelism value: value
+        end
+      configurable_class.default_config :parallelism, 10
     end
 
-    private
-
-    def initialize(conf = {})
-      conf[:attributes] = Kitchen::Util.stringified_hash conf[:attributes]
-      super
+    def coerce_parallelism(value:)
+      config[:parallelism] = Integer value
+    rescue ::ArgumentError, ::TypeError
+      config_error attribute: 'parallelism', expected: 'an integer'
     end
   end
 end

data/lib/terraform/plan_command.rb

@@ -27,20 +27,23 @@ module Terraform
     end
 
     def options
-      "-destroy=#{destroy} -input=false -out=#{out} -state=#{state} " \
+      "-destroy=#{destroy} -input=false -out=#{out} " \
+        "-parallelism=#{parallelism} -state=#{state} " \
         "#{color_switch}#{processed_variables}#{processed_variable_files}"
     end
 
     private
 
-    attr_accessor :destroy, :out, :state, :variables, :variable_files
+    attr_accessor :destroy, :out, :parallelism, :state, :variables,
+                  :variable_files
 
     def initialize_attributes(
-      color:, destroy:, out:, state:, variables:, variable_files:
+      color:, destroy:, out:, parallelism:, state:, variables:, variable_files:
     )
       self.color = color
       self.destroy = destroy
       self.out = out
+      self.parallelism = parallelism
       self.state = state
       self.variables = variables
       self.variable_files = variable_files

data/lib/terraform/version.rb

@@ -15,5 +15,5 @@
 # limitations under the License.
 
 module Terraform
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/lib/terraform/zero_seven_output.rb

@@ -26,6 +26,7 @@ module Terraform
     private
 
     def processed_output(raw_output:)
+      return raw_output if return_raw
       JSON.parse(raw_output).fetch('value')
           .tap { |value| return list ? Array(value) : value }
     end

data/lib/terraform/zero_six_output.rb

@@ -24,6 +24,7 @@ module Terraform
     private
 
     def processed_output(raw_output:)
+      return raw_output if return_raw
       raw_output.chomp.tap { |value| return list ? value.split(',') : value }
     end
   end

metadata

@@ -1,14 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-terraform
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Aaron Lane
+- Clay Thomas
+- Erik R. Rygg
+- Ewa Czechowska
 - Kevin Dickerson
+- Kyle Sexton
 - Michael Glenney
 - Nell Shamrell-Harrington
 - Nick Willever
+- Walter Dolce
 autorequire: 
 bindir: bin
 cert_chain:
@@ -35,7 +40,7 @@ cert_chain:
   KucGZX3OeACVUSpmCOCQyma6sDHYWQZM/IgWi7tbLtG5b2GslkauPm4S3wadHi6W
   LOU=
   -----END CERTIFICATE-----
-date: 2016-10-04 00:00:00.000000000 Z
+date: 2016-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler-audit
@@ -57,6 +62,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -191,6 +210,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.10.3
+- !ruby/object:Gem::Dependency
+  name: pry-coolline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -232,39 +265,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.40.0
 - !ruby/object:Gem::Dependency
-  name: rubycritic
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.9'
-- !ruby/object:Gem::Dependency
-  name: simplecov
+  name: travis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.11.2
+        version: '1.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.11.2
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: inspec
   requirement: !ruby/object:Gem::Requirement
@@ -363,8 +376,8 @@ files:
 - lib/terraform/get_command.rb
 - lib/terraform/group.rb
 - lib/terraform/groups_config.rb
-- lib/terraform/inspec_runner.rb
 - lib/terraform/output_command.rb
+- lib/terraform/parallelism_config.rb
 - lib/terraform/plan_command.rb
 - lib/terraform/plan_config.rb
 - lib/terraform/show_command.rb
@@ -376,7 +389,7 @@ files:
 - lib/terraform/version_command.rb
 - lib/terraform/zero_seven_output.rb
 - lib/terraform/zero_six_output.rb
-homepage: https://github.com/newcontext/kitchen-terraform
+homepage: https://github.com/newcontext-oss/kitchen-terraform
 licenses:
 - Apache-2.0
 metadata: {}
@@ -386,24 +399,21 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
-    - !ruby/object:Gem::Version
-      version: '2.3'
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.1
+      version: '2.1'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
-    - !ruby/object:Gem::Version
-      version: '2.6'
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.3
+      version: '0'
 requirements:
 - Terraform >= 0.6.0, < 0.8.0
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Test Kitchen plugins for testing Terraform projects

metadata.gz.sig

@@ -1,4 +1,2 @@
-2!P��
-��,�t{E*��C
-Uk�����x�+q�xO�񯸜d���)�R�P8��ٌ�f��t��tb��Oi�v�����.>��f���G�E��mY���{^M��Fr"�-��x��\
-�����.�o�S{�
X�-JG��P,�`8M�!���*��s��-N��+[�(UÐ}�����~�4�Ap��Ve��H�efyăo
+���o��6��p�����ZT�B;zH�N��W˔N��p9^^d2�$H������W�U[zy��Ώ������sج��s�U��jRYs����z7�B����h�(;Pn�W�k��ϯ�0;��L`4�1k�
�HW�ŢP�h}���)5�9Vaeʕi��O{�����Y
|
+KP�Y��
�f>�����1�z��|)�(33t�XS9']�HJS