kitchen-terraform 0.5.1 → 0.6.0

data/lib/terraform/command_options.rb

@@ -0,0 +1,95 @@
+# 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 'set'
+require_relative 'command_option'
+
+module Terraform
+  # Options for commands
+  class CommandOptions
+    def color=(value)
+      store key: { false => 'no-color' }.fetch(value) { return }
+    end
+
+    def destroy=(value)
+      store key: 'destroy', value: value
+    end
+
+    def input=(value)
+      store key: 'input', value: value
+    end
+
+    def json=(value)
+      store key: 'json', value: value
+    end
+
+    def out
+      fetch key: 'out'
+    end
+
+    def out=(value)
+      store key: 'out', value: value
+    end
+
+    def parallelism=(value)
+      store key: 'parallelism', value: value
+    end
+
+    def state
+      fetch key: 'state'
+    end
+
+    def state=(value)
+      store key: 'state', value: value
+    end
+
+    def update=(value)
+      store key: 'update', value: value
+    end
+
+    def var=(value)
+      value.each_pair do |variable_name, variable_value|
+        store key: 'var', value: "'#{variable_name}=#{variable_value}'"
+      end
+    end
+
+    def var_file=(value)
+      value.each { |file| store key: 'var-file', value: file }
+    end
+
+    def to_s
+      options.each_with_object ::String.new do |option, string|
+        string.concat "#{option} "
+      end
+    end
+
+    private
+
+    attr_accessor :options
+
+    def fetch(key:)
+      options.find { |option| option.key == key }.value
+    end
+
+    def initialize(options: ::Set.new)
+      self.options = options
+    end
+
+    def store(**keyword_arguments)
+      options.add ::Terraform::CommandOption.new(**keyword_arguments)
+    end
+  end
+end

data/lib/terraform/configurable.rb

@@ -16,45 +16,70 @@
 
 require 'forwardable'
 require 'kitchen'
-require_relative 'version'
+require 'pathname'
+require 'terraform/client'
+require 'terraform/debug_logger'
+require 'terraform/project_version'
 
 module Terraform
-  # Common logic for classes that include Kitchen::Configurable
+  # Behaviour for objects that extend ::Kitchen::Configurable
   module Configurable
-    extend Forwardable
+    extend ::Forwardable
+
+    def_delegator :config, :[]=
 
     def_delegators :instance, :driver, :provisioner, :transport
 
     def self.included(configurable_class)
-      configurable_class.plugin_version VERSION
+      configurable_class.plugin_version ::Terraform::PROJECT_VERSION
+    end
+
+    def client
+      ::Terraform::Client.new config: verbose_config, logger: logger
     end
 
-    def config_deprecated(attribute:, remediation:, type:, version:)
-      log_deprecation aspect: "#{formatted(attribute: attribute)} as #{type}",
-                      remediation: remediation, version: version
+    def config_deprecated(attr:, remediation:, type:)
+      log_deprecation aspect: "#{formatted_config attr: attr} as #{type}",
+                      remediation: remediation
     end
 
-    def config_error(attribute:, expected:)
-      raise Kitchen::UserError, "#{formatted attribute: attribute} must be " \
-                                  "interpretable as #{expected}"
+    def config_error(attr:, expected:)
+      raise ::Kitchen::UserError, "#{formatted_config attr: attr} must be " \
+                                    "interpretable as #{expected}"
+    end
+
+    def debug_logger
+      ::Terraform::DebugLogger.new logger: logger
     end
 
     def instance_pathname(filename:)
-      File.join config[:kitchen_root], '.kitchen', 'kitchen-terraform',
-                instance.name, filename
+      ::Pathname.new(config[:kitchen_root])
+                .join '.kitchen', 'kitchen-terraform', instance.name, filename
     end
 
-    def log_deprecation(aspect:, remediation:, version:)
+    def log_deprecation(aspect:, remediation:)
       logger.warn 'DEPRECATION NOTICE'
-      logger.warn "Support for #{aspect} will be dropped in " \
-                    "kitchen-terraform v#{version}"
+      logger
+        .warn "Support for #{aspect} will be dropped in kitchen-terraform v1.0"
       logger.warn remediation
     end
 
+    def silent_client
+      ::Terraform::Client.new config: silent_config, logger: debug_logger
+    end
+
     private
 
-    def formatted(attribute:)
-      "#{self.class}#{instance.to_str}#config[:#{attribute}]"
+    def formatted_config(attr:)
+      "#{self.class}#{instance.to_str}#config[:#{attr}]"
+    end
+
+    def silent_config
+      verbose_config.tap { |config| config[:color] = false }
+    end
+
+    def verbose_config
+      provisioner.dup.tap { |config| config[:cli] = driver[:cli] }
     end
   end
 end

data/lib/terraform/{zero_six_output.rb → debug_logger.rb}

@@ -15,17 +15,20 @@
 # limitations under the License.
 
 module Terraform
-  # Behaviour for OutputCommand with Terraform 0.6
-  module ZeroSixOutput
-    def options
-      "-state=#{state}"
+  # Wrapper for a logger to always use the debug level
+  class DebugLogger
+    def debug(message)
+      logger.debug message
     end
 
+    alias << debug
+
     private
 
-    def processed_output(raw_output:)
-      return raw_output if return_raw
-      raw_output.chomp.tap { |value| return list ? value.split(',') : value }
+    attr_accessor :logger
+
+    def initialize(logger:)
+      self.logger = logger
     end
   end
 end

data/lib/terraform/deprecated_output_parser.rb

@@ -0,0 +1,41 @@
+# 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.
+
+module Terraform
+  # A parser for deprecated output command values
+  class DeprecatedOutputParser
+    def each_name(&block)
+      output.scan(/(\w+)\s*=/).flatten.each(&block)
+    end
+
+    def iterate_parsed_output(&block)
+      Array(parsed_output)
+        .each { |list_value| list_value.split(',').each(&block) }
+    end
+
+    def parsed_output
+      output.strip
+    end
+
+    private
+
+    attr_accessor :output
+
+    def initialize(output:)
+      self.output = output
+    end
+  end
+end

data/lib/terraform/deprecated_variables_coercer.rb

@@ -0,0 +1,35 @@
+# 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.
+
+module Terraform
+  # Coerces deprecated variables config
+  class DeprecatedVariablesCoercer
+    def coerce(attr:, value:)
+      configurable.config_deprecated attr: attr, remediation: 'Use a mapping',
+                                     type: 'a list or string'
+      configurable[attr] =
+        ::Hash[Array(value).map { |string| string.split '=' }]
+    end
+
+    private
+
+    attr_accessor :configurable
+
+    def initialize(configurable:)
+      self.configurable = configurable
+    end
+  end
+end

data/lib/terraform/{command_extender.rb → deprecated_version.rb}

@@ -14,14 +14,17 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'delegate'
+
 module Terraform
-  # Logic to extend a command's behaviour based on the Terraform version
-  module CommandExtender
-    def extend_behaviour(version:)
-      extend version_behaviours.fetch(
-        version_behaviours.keys
-          .find { |extended_version| extended_version =~ version }
-      ) { return }
+  # A deprecated version of Terraform
+  class DeprecatedVersion < ::SimpleDelegator
+    def if_deprecated
+      yield
+    end
+
+    def if_json_not_supported
+      yield
     end
   end
 end

data/lib/terraform/destructive_plan_command.rb

@@ -0,0 +1,35 @@
+# 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 'terraform/prepare_input_file'
+require 'terraform/plan_command'
+
+module Terraform
+  # A command to plan a destructive execution
+  class DestructivePlanCommand < ::Terraform::PlanCommand
+    def name
+      'plan'
+    end
+
+    private
+
+    def initialize(target: '')
+      super
+      preparations
+        .push ::Terraform::PrepareInputFile.new file: options.state
+    end
+  end
+end

data/lib/terraform/directory_config.rb

@@ -14,14 +14,19 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'terraform/pathname_coercer'
+require 'terraform/simple_config'
+
 module Terraform
   # Behaviour for the [:directory] config option
   module DirectoryConfig
-    def self.included(configurable_class)
-      configurable_class.default_config :directory do |configurable|
-        configurable[:kitchen_root]
-      end
-      configurable_class.expand_path_for :directory
+    include ::Terraform::SimpleConfig
+
+    def self.extended(configurable_class)
+      configurable_class.configure_required(
+        attr: :directory, coercer_class: ::Terraform::PathnameCoercer,
+        default_value: ->(configurable) { configurable[:kitchen_root] }
+      )
     end
   end
 end

data/lib/terraform/file_configs.rb

@@ -0,0 +1,36 @@
+# 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 'terraform/pathname_coercer'
+require 'terraform/simple_config'
+
+module Terraform
+  # Behaviour for the [:plan] and [:state] config options
+  module FileConfigs
+    include ::Terraform::SimpleConfig
+
+    def self.extended(configurable_class)
+      %i(plan state).each do |attr|
+        configurable_class.configure_required(
+          attr: attr, coercer_class: ::Terraform::PathnameCoercer,
+          default_value: lambda do |configurable|
+            configurable.instance_pathname filename: "terraform.tf#{attr}"
+          end
+        )
+      end
+    end
+  end
+end

data/lib/terraform/get_command.rb

@@ -14,17 +14,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require_relative 'command'
+require 'terraform/command'
 
 module Terraform
-  # Command to get modules
-  class GetCommand < Command
-    def name
-      'get'
-    end
-
-    def options
-      '-update=true'
-    end
+  # A command to get dependency modules
+  class GetCommand < ::Terraform::Command
   end
 end

data/lib/terraform/group.rb

@@ -14,48 +14,48 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'kitchen/util'
+require 'hashie/dash'
+require 'hashie/extensions/dash/coercion'
+require 'terraform/group_attributes'
+require 'terraform/group_hostnames'
 
 module Terraform
   # Group of Terraform server instances to be verified
-  class Group
-    def each_attribute(&block)
-      data[:attributes].dup.each_pair(&block)
-    end
+  class Group < ::Hashie::Dash
+    include ::Hashie::Extensions::Dash::Coercion
 
-    def hostnames
-      data[:hostnames]
-    end
+    property :attributes, coerce: ::Terraform::GroupAttributes,
+                          default: ::Terraform::GroupAttributes.new
 
-    def if_local
-      yield if hostnames.empty?
-    end
+    property :controls, coerce: ::Array[::String], default: []
 
-    def name
-      data[:name]
-    end
+    property :hostname, coerce: ::String
 
-    def options
-      {
-        attributes: attributes, controls: data[:controls], port: data[:port],
-        user: data[:username]
-      }
-    end
+    property :hostnames, coerce: ::Terraform::GroupHostnames,
+                         default: ::Terraform::GroupHostnames.new
 
-    def store_attribute(key:, value:)
-      data[:attributes][key] = value
-    end
+    property :name, coerce: ::String, required: true
 
-    private
+    property :port
+
+    coerce_key :port, ->(value) { Integer value }
+
+    property :username, coerce: ::String
 
-    attr_accessor :data
+    def description
+      "host '#{hostname}' of group '#{name}'"
+    end
 
-    def attributes
-      ::Kitchen::Util.stringified_hash data[:attributes]
+    def resolve(client:)
+      attributes.resolve client: client
+      hostnames
+        .resolve(client: client) { |hostname| yield merge hostname: hostname }
     end
 
-    def initialize(data:)
-      self.data = data
+    private
+
+    def initialize(attributes = {}, &block)
+      super Hash(attributes), &block
     end
   end
 end