kitchen-terraform 0.2.0 → 0.3.0

data/lib/terraform/apply_command.rb

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

data/lib/terraform/apply_timeout_config.rb

@@ -0,0 +1,34 @@
+# 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
+  # 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
+
+    def coerce_apply_timeout(value:)
+      config[:apply_timeout] = Integer value
+    rescue ArgumentError, TypeError
+      config_error attribute: 'apply_timeout', expected: 'an integer'
+    end
+  end
+end

data/lib/terraform/client.rb

@@ -0,0 +1,76 @@
+# 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_relative 'apply_command'
+require_relative 'command_executor'
+require_relative 'get_command'
+require_relative 'output_command'
+require_relative 'plan_command'
+require_relative 'show_command'
+require_relative 'validate_command'
+require_relative 'version_command'
+
+module Terraform
+  # Behaviour for implementing the workflow
+  module Client
+    include CommandExecutor
+
+    def apply_execution_plan
+      execute command: ApplyCommand.new(
+        color: provisioner[:color], state: provisioner[:state],
+        target: provisioner[:plan]
+      ), timeout: provisioner[:apply_timeout]
+    end
+
+    def current_state
+      execute(
+        command: ShowCommand
+          .new(color: provisioner[:color], target: provisioner[:state])
+      ) { |value| return value.gsub(/(\e\[\d+m|\n)/, '') }
+    end
+
+    def download_modules
+      execute command: GetCommand.new(target: provisioner[:directory])
+    end
+
+    def output_value(list: false, name:, &block)
+      execute(
+        command: OutputCommand.new(
+          list: list, state: provisioner[:state], target: name, version: version
+        )
+      ) { |value| list ? value.each(&block) : (return value) }
+    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]
+      )
+    end
+
+    def validate_configuration_files
+      execute command: ValidateCommand.new(target: provisioner[:directory])
+    end
+
+    def version
+      execute command: VersionCommand.new do |value|
+        return value.slice(/v\d+\.\d+\.\d+/)
+      end
+    end
+  end
+end

data/lib/terraform/color_config.rb

@@ -0,0 +1,34 @@
+# 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
+  # Behaviour for the [:color] config option
+  module ColorConfig
+    def self.included(configurable_class)
+      configurable_class.required_config :color do |_, value, configurable|
+        configurable.coerce_color value: value
+      end
+      configurable_class.default_config :color, true
+    end
+
+    def coerce_color(value:)
+      raise TypeError unless [TrueClass, FalseClass].include? value.class
+      config[:color] = value
+    rescue TypeError
+      config_error attribute: 'color', expected: 'a boolean'
+    end
+  end
+end

data/lib/terraform/color_switch.rb

@@ -15,10 +15,14 @@
 # limitations under the License.
 
 module Terraform
-  # Shared color switche for Terraform
+  # Shared color switch for Terraform
   module ColorSwitch
     def color_switch
-      color ? '' : ' -no-color'
+      color ? '' : '-no-color'
     end
+
+    private
+
+    attr_accessor :color
   end
 end

data/lib/terraform/command.rb

@@ -14,27 +14,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'kitchen'
 require 'mixlib/shellout'
 
 module Terraform
-  # Interface to the Terraform command line client
+  # Terraform command to be executed
   class Command
-    def self.execute(**keyword_arguments, &block)
-      new(**keyword_arguments).execute(&block)
-    end
-
-    def execute
-      shell_out.run_command
-      shell_out.error!
-      yield shell_out.stdout if block_given?
-    rescue Errno::EACCES, Errno::ENOENT => error
-      command_error error: error, type: Kitchen::InstanceFailure
-    rescue Mixlib::ShellOut::CommandTimeout,
-           Mixlib::ShellOut::ShellCommandFailed => error
-      command_error error: error, type: Kitchen::TransientFailure
-    end
-
     def name
       ''
     end
@@ -43,25 +27,36 @@ module Terraform
       '--help'
     end
 
-    private
+    def output
+      processed_output raw_output: shell_out.stdout
+    end
 
-    attr_accessor :shell_out
+    def run(logger:, timeout:)
+      shell_out.live_stream = logger
+      shell_out.timeout = timeout
+      shell_out.run_command
+      shell_out.error!
+    end
 
-    def command_error(error:, type:)
-      raise type, %(`#{shell_out.command}` failed: "#{error}")
+    def to_s
+      shell_out.command
     end
 
-    def initialize(
-      logger:, target: '', timeout: Mixlib::ShellOut::DEFAULT_READ_TIMEOUT,
-      **keyword_arguments
-    )
+    private
+
+    attr_accessor :shell_out
+
+    def initialize(target: '', **keyword_arguments)
       initialize_attributes(**keyword_arguments)
       self.shell_out = Mixlib::ShellOut
-                       .new "terraform #{name} #{options} #{target}",
-                            live_stream: logger, returns: 0, timeout: timeout
+                       .new "terraform #{name} #{options} #{target}", returns: 0
     end
 
     def initialize_attributes(**_keyword_arguments)
     end
+
+    def processed_output(raw_output:)
+      raw_output
+    end
   end
 end

data/lib/terraform/command_executor.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.
+
+require 'kitchen'
+require 'mixlib/shellout'
+
+module Terraform
+  # Behaviour for executing commands
+  module CommandExecutor
+    def execute(command:, timeout: Mixlib::ShellOut::DEFAULT_READ_TIMEOUT)
+      command.run logger: logger, timeout: timeout
+      yield command.output if block_given?
+    rescue Errno::EACCES, Errno::ENOENT => error
+      command_error command: command, error: error,
+                    type: Kitchen::InstanceFailure
+    rescue Mixlib::ShellOut::CommandTimeout,
+           Mixlib::ShellOut::ShellCommandFailed => error
+      command_error command: command, error: error,
+                    type: Kitchen::TransientFailure
+    end
+
+    private
+
+    def command_error(command:, error:, type:)
+      raise type, %(`#{command}` failed: "#{error}")
+    end
+  end
+end

data/lib/terraform/command_extender.rb

@@ -0,0 +1,27 @@
+# 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
+  # 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 }
+    end
+  end
+end

data/lib/terraform/configurable.rb

@@ -16,30 +16,45 @@
 
 require 'forwardable'
 require 'kitchen'
+require_relative 'version'
 
 module Terraform
   # Common logic for classes that include Kitchen::Configurable
   module Configurable
     extend Forwardable
 
-    def_delegators :instance, :provisioner, :transport
+    def_delegators :instance, :driver, :provisioner, :transport
 
-    def config_deprecated(attribute:, expected:)
-      logger.warn 'DEPRECATION NOTICE'
-      logger.warn formatted attribute: attribute,
-                            message: "should be #{expected}"
+    def self.included(configurable_class)
+      configurable_class.plugin_version VERSION
+    end
+
+    def config_deprecated(attribute:, remediation:, type:, version:)
+      log_deprecation aspect: "#{formatted(attribute: attribute)} as #{type}",
+                      remediation: remediation, version: version
     end
 
     def config_error(attribute:, expected:)
-      raise Kitchen::UserError, formatted(
-        attribute: attribute, message: "must be interpretable as #{expected}"
-      )
+      raise Kitchen::UserError, "#{formatted attribute: attribute} must be " \
+                                  "interpretable as #{expected}"
+    end
+
+    def instance_pathname(filename:)
+      File.join config[:kitchen_root], '.kitchen', 'kitchen-terraform',
+                instance.name, filename
+    end
+
+    def log_deprecation(aspect:, remediation:, version:)
+      logger.warn 'DEPRECATION NOTICE'
+      logger.warn "Support for #{aspect} will be dropped in " \
+                    "kitchen-terraform v#{version}"
+      logger.warn remediation
     end
 
     private
 
-    def formatted(attribute:, message:)
-      "#{self.class}#{instance.to_str}#config[:#{attribute}] #{message}"
+    def formatted(attribute:)
+      "#{self.class}#{instance.to_str}#config[:#{attribute}]"
     end
   end
 end

data/lib/terraform/directory_config.rb

@@ -0,0 +1,27 @@
+# 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
+  # 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
+    end
+  end
+end

data/lib/terraform/group.rb

@@ -14,81 +14,44 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'delegate'
-
 module Terraform
-  # Group to be verified
-  class Group < DelegateClass Hash
-    def populate(runner:)
-      dig(:attributes).each_pair do |key, output_name|
-        runner.set_attribute key: key,
-                             value: provisioner.output(name: output_name)
-      end
-    end
-
-    def verify_each_host(options:)
-      require 'terraform/inspec_runner'
-      provisioner.each_list_output name: dig(:hostnames) do |hostname|
-        store :host, hostname
-        verifier.info "Verifying group: #{dig :name}; current host #{hostname}"
-        InspecRunner.run_and_verify group: self, options: options.merge(self),
-                                    verifier: verifier
+  # 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
     end
 
-    private
-
-    attr_accessor :provisioner, :transport, :verifier
-
-    def coerce_attributes
-      store :attributes, Hash(dig(:attributes))
-    rescue ArgumentError, TypeError
-      verifier.config_error attribute: "groups][#{self}][:attributes",
-                            expected: 'a mapping of Inspec attribute names ' \
-                                        'to Terraform output variable names'
-    end
-
-    def coerce_controls
-      store :controls, Array(dig(:controls))
-    end
-
-    def coerce_hostnames
-      store :hostnames, String(dig(:hostnames))
+    def hostnames
+      data[:hostnames]
     end
 
-    def coerce_name
-      store :name, String(dig(:name))
+    def store_attribute(key:, value:)
+      data[:attributes][key] = value
     end
 
-    def coerce_parameters
-      coerce_attributes
-      coerce_controls
-      coerce_hostnames
-      coerce_name
-      coerce_port
-      coerce_username
-    end
+    private
 
-    def coerce_port
-      store :port, Integer(dig(:port) || transport[:port])
-    rescue ArgumentError, TypeError
-      verifier.config_error attribute: "groups][#{self}][:port",
-                            expected: 'an integer'
-    end
+    attr_accessor :data
 
-    def coerce_username
-      store :user, String(dig(:username) || transport[:username])
+    def initialize(data:)
+      self.data = data
     end
 
-    def initialize(value:, verifier:)
-      super Hash value
-      self.provisioner = verifier.provisioner
-      self.transport = verifier.transport
-      self.verifier = verifier
-      coerce_parameters
-    rescue ArgumentError, TypeError
-      verifier.config_error attribute: "groups][#{self}",
-                            expected: 'a group mapping'
+    def options
+      {
+        attributes: data[:attributes], controls: data[:controls],
+        port: data[:port], user: data[:username]
+      }
     end
   end
 end