kitchen-terraform 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 19a43500f0b93a18ec62875671a8a902a1ffd2ac
-  data.tar.gz: 2f00ae9168495da55d2ef5ba87787faeb98b1202
+  metadata.gz: 1ad31536d7fa989d59755d148c04a6ea0895a2f6
+  data.tar.gz: c817dde749927ce21795cdde40a8c9d1e65713b4
 SHA512:
-  metadata.gz: fa18168d24b9d081b23d181946b59452d606af078ff1e559a9bfbb501cf6e776329606b2cd6f5ec0eee751acf8e9a4fb08044d9e2275f1412c53faa733e92de2
-  data.tar.gz: 604c970071fe3224ece676255d9d807fa3f29c93a5435d4e0f5f9a2dea963ad1da7ff3b782f808dcf4cd58dfe587a2c2cc5e907337e175e7568b1120c1c1b2d0
+  metadata.gz: 7882c3a7f177c5325210d8ecb5c4681ab3c0bff524b20e0d9ff929c4f6f69ec18a72c18b25e796a05ac7c512b3b0dd3db53ac113d3a1bb0bc4f43eecb66edd22
+  data.tar.gz: 770b9530932c84a4ecfef885f6d2c5800d4960f225d4522301b4c8edf258baff7102bd9e5ec48e9f45cfc72fcd8e44d2a1163c54bcea010e17a511359e269c26

data.tar.gz.sig

@@ -1,2 +1,2 @@
-�:����ce�
-e�Q诣|0��6!���A2T��Hy�c�w���m��a?��&�	z�Ԋ���5O�#��KsO��\{��W�Uh�9>���F�3'J0mhK�?U;1�Ţ�KS�g畝�y_��)g�}tK����*���(�ʍbLY|T}PÇ�w�鸡������F����`AEx������S�ՔJς,-{�&���?�[�$뚵d�P���MV���e��jsf���U�k�%�(
+)!"��k���O��؝�L��j꾧$3+�F��O��،$��/�>����s���*��~�S�=W������S0��w�:c����`z�DR�xC�Ѽ��6n����g�lgꞾb�&�j8���w�$�6]��1|	�Ѭ�9l��)�Ԫ�e��7��0���zKGgA����簃3H���t��r��QM��/�p~���O��[]d���.w�OPs�3�Z��
+��k�����3

data/README.md

@@ -38,7 +38,7 @@ Once Bundler is installed, add kitchen-terraform to the project's Gemfile:
 
 ```rb
 source 'https://rubygems.org/' do
-  gem 'kitchen-terraform', '~> 0.5'
+  gem 'kitchen-terraform', '~> 0.6'
 end
 ```
 
@@ -60,7 +60,7 @@ Terraform configuration.
 
 [Test Kitchen configuration]: https://docs.chef.io/config_yml_kitchen.html
 
-Refer to [Getting Started Readme](examples/getting_started/README.md) for a detailed walkthrough of setting up and using kitchen-terraform.
+Refer to [Getting Started Readme](examples/aws_provider/getting_started.md) for a detailed walkthrough of setting up and using kitchen-terraform.
 
 Refer to the [examples directory] for a detailed example project.
 
@@ -97,16 +97,29 @@ provisioner.
 
 #### Configuration
 
-There are no configuration options for the driver.
+##### cli
 
-##### Example .kitchen.yml
+The pathname of the Terraform command-line interface (CLI) executable or
+an executable that implements an equivalent interface.
+
+[command-line interface]: https://www.terraform.io/docs/commands/index.html
+
+###### Example .kitchen.yml
 
 ```yaml
 ---
 driver:
   name: terraform
+  cli: /usr/local/bin/terraform
 ```
 
+###### Default
+
+The default `cli` is `'terraform'`, and is assumed to exist in the
+user's [PATH].
+
+[PATH]: http://www.linfo.org/path_env_var.html
+
 ### Provisioner
 
 The [provisioner] is the bridge between Terraform and Test Kitchen. It
@@ -198,6 +211,47 @@ provisioner:
 
 The default `parallelism` is 10.
 
+##### plan
+
+The pathname of the [execution plan] that Terraform will generate and
+apply.
+
+[execution plan]: https://www.terraform.io/docs/commands/plan.html#_out_path
+
+###### Example .kitchen.yml
+
+```yaml
+---
+provisioner:
+  name: terraform
+  plan: /terraform/plan
+```
+
+###### Default
+
+The default `plan` is under the current working directory of Test
+Kitchen at `.kitchen/kitchen-terraform/<suite_name>/terraform.tfplan`.
+
+##### state
+
+The pathname of the [state file] that Terraform will generate.
+
+[state file]: https://www.terraform.io/docs/commands/apply.html#_state_out_path
+
+###### Example .kitchen.yml
+
+```yaml
+---
+provisioner:
+  name: terraform
+  state: /terraform/state
+```
+
+###### Default
+
+The default `state` is under the current working directory of Test
+Kitchen at `.kitchen/kitchen-terraform/<suite_name>/terraform.tfstate`.
+
 ##### variable_files
 
 A collection of pathnames of [Terraform variable files] to be evaluated
@@ -338,8 +392,9 @@ The default `groups` collection is empty.
 For each group:
 
 - the default `attributes` mapping consists of equivalently named
-  attributes for each output variable; additional or overridden
-  associations can be added.
+  attributes for each output variable as well as a "terraform_state"
+  attribute containing the pathname of the state file; additional or
+  overridden associations can be added.
 
 - the default `controls` collection is empty
 

data/lib/kitchen/driver/terraform.rb

@@ -14,16 +14,16 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'fileutils'
 require 'kitchen'
-require 'terraform/client'
+require 'terraform/cli_config'
 require 'terraform/configurable'
+require 'terraform/version'
 
 module Kitchen
   module Driver
     # Terraform state lifecycle activities manager
-    class Terraform < Base
-      include ::Terraform::Client
+    class Terraform < ::Kitchen::Driver::Base
+      extend ::Terraform::CLIConfig
 
       include ::Terraform::Configurable
 
@@ -31,31 +31,46 @@ module Kitchen
 
       no_parallel_for
 
-      def create(_state = nil)
-        %i(plan state)
-          .each { |option| FileUtils.mkdir_p File.dirname provisioner[option] }
-      end
+      def create(_state = nil); end
 
       def destroy(_state = nil)
-        return if !File.exist?(provisioner[:state]) || current_state.empty?
-
-        create
-        validate_configuration_files
-        download_modules
-        plan_execution destroy: true
-        apply_execution_plan
+        load_state { client.apply_destructively }
+      rescue ::Kitchen::StandardError, ::SystemCallError => error
+        raise ::Kitchen::ActionFailed, error.message
       end
 
       def verify_dependencies
-        case version
-        when /(v[^0]|v0\.[^678])/
-          raise Kitchen::UserError,
-                'Only Terraform v0.8, v0.7, and v0.6 are supported'
-        when /v0\.6/
-          log_deprecation aspect: 'v0.6', remediation: 'Update to v0.8 or v0.7',
-                          version: '1.0'
+        verify_supported_version
+        check_deprecated_version
+      end
+
+      private
+
+      def check_deprecated_version
+        version.if_deprecated do
+          log_deprecation aspect: version.to_s,
+                          remediation: "Install #{::Terraform::Version.latest}"
+        end
+      end
+
+      def load_state(&block)
+        silent_client.load_state(&block)
+      rescue ::Errno::ENOENT => error
+        debug error.message
+      end
+
+      def verify_supported_version
+        version.if_not_supported do
+          raise ::Kitchen::UserError,
+                "#{version} is not supported\nInstall " \
+                  "#{::Terraform::Version.latest}"
         end
       end
+
+      def version
+        @version ||=
+          ::Terraform::Client.new(config: self, logger: debug_logger).version
+      end
     end
   end
 end

data/lib/kitchen/provisioner/terraform.rb

@@ -19,41 +19,37 @@ require 'terraform/apply_timeout_config'
 require 'terraform/color_config'
 require 'terraform/configurable'
 require 'terraform/directory_config'
+require 'terraform/file_configs'
 require 'terraform/parallelism_config'
-require 'terraform/plan_config'
-require 'terraform/state_config'
 require 'terraform/variable_files_config'
 require 'terraform/variables_config'
 
 module Kitchen
   module Provisioner
-    # Terraform configuration applier
-    class Terraform < Base
-      include ::Terraform::ApplyTimeoutConfig
+    # Applies constructive Terraform plans
+    class Terraform < ::Kitchen::Provisioner::Base
+      extend ::Terraform::ApplyTimeoutConfig
 
-      include ::Terraform::ColorConfig
+      extend ::Terraform::ColorConfig
 
-      include ::Terraform::Configurable
-
-      include ::Terraform::DirectoryConfig
+      extend ::Terraform::DirectoryConfig
 
-      include ::Terraform::ParallelismConfig
+      extend ::Terraform::FileConfigs
 
-      include ::Terraform::PlanConfig
+      extend ::Terraform::ParallelismConfig
 
-      include ::Terraform::StateConfig
+      extend ::Terraform::VariableFilesConfig
 
-      include ::Terraform::VariableFilesConfig
+      extend ::Terraform::VariablesConfig
 
-      include ::Terraform::VariablesConfig
+      include ::Terraform::Configurable
 
       kitchen_provisioner_api_version 2
 
       def call(_state = nil)
-        driver.validate_configuration_files
-        driver.download_modules
-        driver.plan_execution destroy: false
-        driver.apply_execution_plan
+        client.apply_constructively
+      rescue ::Kitchen::StandardError, ::SystemCallError => error
+        raise ::Kitchen::ActionFailed, error.message
       end
     end
   end

data/lib/kitchen/verifier/terraform.rb

@@ -22,71 +22,48 @@ module Kitchen
   module Verifier
     # Runs tests post-converge to confirm that instances in the Terraform state
     # are in an expected state
-    class Terraform < Inspec
-      include ::Terraform::Configurable
+    class Terraform < ::Kitchen::Verifier::Inspec
+      extend ::Terraform::GroupsConfig
 
-      include ::Terraform::GroupsConfig
+      include ::Terraform::Configurable
 
       kitchen_verifier_api_version 2
 
       def call(state)
-        verify_groups options: runner_options(transport, state)
+        resolve_groups do |group|
+          self.group = group
+          config[:attributes] = {
+            'terraform_state' => provisioner[:state].to_path
+          }.merge group.attributes
+          info "Verifying #{group.description}"
+          super
+        end
+      rescue ::Kitchen::StandardError, ::SystemCallError => error
+        raise ::Kitchen::ActionFailed, error.message
       end
 
       private
 
-      def add_targets(runner:)
-        collect_tests.each { |test| runner.add_target test }
-      end
+      attr_accessor :group
 
-      def execute(group:, options:)
-        options.merge! group.options
-        ::Inspec::Runner.new(options).tap do |runner|
-          add_targets runner: runner
-          validate exit_code: runner.run
+      def configure_backend(options:)
+        /(local)host/.match group.hostname do |match|
+          options.merge! 'backend' => match[1]
         end
       end
 
-      def execute_local(group:, options:)
-        options[:backend] = 'local'
-        info "Verifying group '#{group.name}'"
-        execute group: group, options: options
-      end
-
-      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
+      def resolve_groups(&block)
+        config[:groups]
+          .each { |group| group.resolve client: silent_client, &block }
       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)
+      def runner_options(transport, state = {}, platform = nil, suite = nil)
+        super.tap do |options|
+          options.merge! controls: group.controls, 'host' => group.hostname,
+                         'port' => group.port, 'user' => group.username
+          configure_backend options: options
         end
       end
-
-      def validate(exit_code:)
-        return if exit_code.zero?
-
-        raise ::Kitchen::InstanceFailure, "Inspec Runner returns #{exit_code}"
-      end
-
-      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 verify_groups(options:)
-        config[:groups]
-          .each { |group| verify group: group, options: options.dup }
-      end
     end
   end
 end

data/lib/terraform/apply_command.rb

@@ -14,30 +14,21 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require_relative 'command'
-require_relative 'color_switch'
+require 'terraform/command'
+require 'terraform/prepare_input_file'
+require 'terraform/prepare_output_file'
 
 module Terraform
-  # Command to apply an execution plan
-  class ApplyCommand < Command
-    include ColorSwitch
-
-    def name
-      'apply'
-    end
-
-    def options
-      "-input=false -parallelism=#{parallelism} -state=#{state} #{color_switch}"
-    end
-
+  # A command to apply an execution plan
+  class ApplyCommand < ::Terraform::Command
     private
 
-    attr_accessor :parallelism, :state
-
-    def initialize_attributes(color:, parallelism:, state:)
-      self.color = color
-      self.parallelism = parallelism
-      self.state = state
+    def initialize(target: '')
+      super
+      preparations.concat [
+        ::Terraform::PrepareInputFile.new(file: target),
+        ::Terraform::PrepareOutputFile.new(file: options.state)
+      ]
     end
   end
 end

data/lib/terraform/apply_timeout_config.rb

@@ -14,21 +14,19 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'terraform/integer_coercer'
+require 'terraform/simple_config'
+
 module Terraform
   # Behaviour for the [:apply_timeout] config option
   module ApplyTimeoutConfig
-    def self.included(configurable_class)
-      configurable_class
-        .required_config :apply_timeout do |_, value, configurable|
-          configurable.coerce_apply_timeout value: value
-        end
-      configurable_class.default_config :apply_timeout, 600
-    end
+    include ::Terraform::SimpleConfig
 
-    def coerce_apply_timeout(value:)
-      config[:apply_timeout] = Integer value
-    rescue ArgumentError, TypeError
-      config_error attribute: 'apply_timeout', expected: 'an integer'
+    def self.extended(configurable_class)
+      configurable_class
+        .configure_required attr: :apply_timeout,
+                            coercer_class: ::Terraform::IntegerCoercer,
+                            default_value: 600
     end
   end
 end

data/lib/terraform/cli_config.rb

@@ -0,0 +1,29 @@
+# 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 'ptools'
+
+module Terraform
+  # Behaviour for the [:cli] config option
+  module CLIConfig
+    def self.extended(configurable_class)
+      configurable_class.required_config :cli do |key, value, configurable|
+        configurable[key] = ::File.expand_path value
+      end
+      configurable_class.default_config(:cli) { ::File.which 'terraform' }
+    end
+  end
+end