kitchen-terraform 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f03cf599dfe3f84c964a2ee046ee339fec308920
+  data.tar.gz: a796e35249231547ce68cef067bd1408f30295b7
+SHA512:
+  metadata.gz: fee5b34d17854a32f579363580050bd6406e3fa3e9628e88102d1b0c888e19546d2df7e259c4bdb4bfa3f133323304f4d3bf41daa5e6469ef61f44a9cbae38eb
+  data.tar.gz: 1c1cff573cf5973649ec40728443a78f7aaa147204ec09d10db9ffd21d6eeab99ccc89c33edf418bd67d49c0104691cec0884d41bcc440f9285f4ca4b5082e06

checksums.yaml.gz.sig

@@ -0,0 +1 @@
+y�ޭ�H#�&��lmD���5��ō:N��/���[!�?�*�\a1f�2<�r�I�zi�OH8���o؊���xo�\����r�Ў��R#ҶL���ӓ�z�RJb~ĭ��M�-E,�q��*I�u��+�=��3�JK�"..��6��U�m1S�B�����b)�`�Z%�ħy��U�'��S�'ce�'���]v=���]�5Mi�n���L��[g�.�����r�au":�L��6���h���J��

data/lib/kitchen/driver/terraform.rb

@@ -0,0 +1,57 @@
+# 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 'terraform/client_holder'
+require 'terraform/invalid_version'
+require 'terraform/version'
+
+module Kitchen
+  module Driver
+    # Terraform state lifecycle activities manager
+    class Terraform < Base
+      include ::Terraform::ClientHolder
+
+      kitchen_driver_api_version 2
+
+      plugin_version ::Terraform::VERSION
+
+      no_parallel_for
+
+      def create(_state = nil)
+        client.fetch_version do |output|
+          raise ::Terraform::InvalidVersion, supported_version, caller unless
+            output.match supported_version
+        end
+      rescue => error
+        raise Kitchen::ActionFailed, error.message, error.backtrace
+      end
+
+      def destroy(_state = nil)
+        client.validate_configuration_files
+        client.download_modules
+        client.plan_destructive_execution
+        client.apply_execution_plan
+      rescue => error
+        raise Kitchen::ActionFailed, error.message, error.backtrace
+      end
+
+      def supported_version
+        'v0.6'
+      end
+    end
+  end
+end

data/lib/kitchen/provisioner/terraform.rb

@@ -0,0 +1,58 @@
+# 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 'pathname'
+require 'terraform/client_holder'
+require 'terraform/version'
+
+module Kitchen
+  module Provisioner
+    # Terraform configuration applier
+    class Terraform < Base
+      include ::Terraform::ClientHolder
+
+      kitchen_provisioner_api_version 2
+
+      plugin_version ::Terraform::VERSION
+
+      def call(_state = nil)
+        client.validate_configuration_files
+        client.download_modules
+        client.plan_execution
+        client.apply_execution_plan
+      rescue => error
+        raise Kitchen::ActionFailed, error.message, error.backtrace
+      end
+
+      def directory
+        config.fetch(:directory) { kitchen_root }
+      end
+
+      def kitchen_root
+        Pathname.new config.fetch :kitchen_root
+      end
+
+      def variable_files
+        config.fetch(:variable_files) { [] }
+      end
+
+      def variables
+        config.fetch(:variables) { [] }
+      end
+    end
+  end
+end

data/lib/kitchen/verifier/terraform.rb

@@ -0,0 +1,109 @@
+# 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 'kitchen/verifier/inspec'
+require 'terraform/client_holder'
+require 'terraform/inspec_runner'
+require 'terraform/version'
+
+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::ClientHolder
+
+      kitchen_verifier_api_version 2
+
+      plugin_version ::Terraform::VERSION
+
+      def attributes(group:)
+        group.fetch(:attributes) { {} }
+      end
+
+      def call(state)
+        groups.each do |group|
+          client.extract_list_output name: group.fetch(:hostnames) do |output|
+            verify group: group, hostnames: output, state: state
+          end
+        end
+      rescue => error
+        raise ActionFailed, error.message, error.backtrace
+      end
+
+      def controls(group:)
+        group.fetch(:controls) { [] }
+      end
+
+      def evaluate(exit_code:)
+        raise "Inspec Runner returns #{exit_code}" unless 0 == exit_code
+      end
+
+      def groups
+        config.fetch(:groups) { [] }
+      end
+
+      def initialize_runner(group:, hostname:, state:)
+        ::Terraform::InspecRunner
+          .new runner_options_for_terraform group: group, hostname: hostname,
+                                            state: state do |runner|
+          resolve_attributes group: group do |name, value|
+            runner.define_attribute name: name, value: value
+          end
+          runner.add targets: collect_tests
+          yield runner
+        end
+      end
+
+      def port(group:)
+        # FIXME: apply the principle of least knowledge
+        group.fetch(:port) { instance.transport.send(:config).fetch :port }
+      end
+
+      def resolve_attributes(group:)
+        attributes(group: group).each_pair do |method_name, variable_name|
+          client.extract_output name: variable_name do |output|
+            yield method_name, output
+          end
+        end
+      end
+
+      def runner_options_for_terraform(group:, hostname:, state:)
+        runner_options(instance.transport, state)
+          .merge controls: controls(group: group), host: hostname,
+                 port: port(group: group), user: username(group: group)
+      end
+
+      def username(group:)
+        # FIXME: apply the principle of least knowledge
+        group.fetch :username do
+          instance.transport.send(:config).fetch :username
+        end
+      end
+
+      def verify(group:, hostnames:, state:)
+        hostnames.each do |hostname|
+          info "Verifying group: #{group.fetch :name}; hostname #{hostname}\n"
+          initialize_runner group: group, hostname: hostname,
+                            state: state do |runner|
+            runner.verify_run verifier: self
+          end
+        end
+      end
+    end
+  end
+end

data/lib/terraform/apply_command.rb

@@ -0,0 +1,32 @@
+# 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 'command'
+
+module Terraform
+  # Command to apply an execution plan
+  class ApplyCommand
+    include Command
+
+    private
+
+    def initialize_attributes(state:, plan:)
+      self.name = 'apply'
+      self.options = { input: false, state: state }
+      self.target = plan
+    end
+  end
+end

data/lib/terraform/client.rb

@@ -0,0 +1,102 @@
+# 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 'get_command'
+require_relative 'output_command'
+require_relative 'plan_command'
+require_relative 'validate_command'
+require_relative 'version_command'
+
+module Terraform
+  # Runs Mixlib Terraform Command instances
+  class Client
+    extend Forwardable
+
+    def_delegators :provisioner, :directory, :info, :kitchen_root,
+                   :variable_files, :variables
+
+    def apply_execution_plan
+      run command_class: ApplyCommand, state: state_pathname,
+          plan: plan_pathname
+    end
+
+    def download_modules
+      run command_class: GetCommand, dir: directory
+    end
+
+    def extract_list_output(name:)
+      extract_output(name: name) { |output| yield output.split ',' }
+    end
+
+    def extract_output(name:)
+      run(
+        command_class: OutputCommand, state: state_pathname, name: name
+      ) { |output| yield output.chomp }
+    end
+
+    def fetch_version
+      run(command_class: VersionCommand) { |output| yield output }
+    end
+
+    def instance_directory
+      kitchen_root.join '.kitchen', 'kitchen-terraform', instance_name
+    end
+
+    def plan_destructive_execution
+      run command_class: PlanCommand, destroy: true, out: plan_pathname,
+          state: state_pathname, var: variables, var_file: variable_files,
+          dir: directory
+    end
+
+    def plan_execution
+      run command_class: PlanCommand, destroy: false, out: plan_pathname,
+          state: state_pathname, var: variables, var_file: variable_files,
+          dir: directory
+    end
+
+    def plan_pathname
+      instance_directory.join 'terraform.tfplan'
+    end
+
+    def run(command_class:, **parameters)
+      command_class.new(**parameters) do |command|
+        info command
+        command.execute do |output|
+          info output
+          yield output if block_given?
+        end
+      end
+    end
+
+    def state_pathname
+      instance_directory.join 'terraform.tfstate'
+    end
+
+    def validate_configuration_files
+      run command_class: ValidateCommand, dir: directory
+    end
+
+    private
+
+    attr_accessor :instance_name, :provisioner
+
+    def initialize(instance:)
+      self.instance_name = instance.name
+      self.provisioner = instance.provisioner
+    end
+  end
+end

data/lib/terraform/client_holder.rb

@@ -0,0 +1,26 @@
+# 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 'client'
+
+module Terraform
+  # Logic to provide a lazily initialized Client instance
+  module ClientHolder
+    def client
+      @client ||= Client.new instance: instance
+    end
+  end
+end

data/lib/terraform/command.rb

@@ -0,0 +1,58 @@
+# 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 'mixlib/shellout'
+require 'pathname'
+require_relative 'command_options'
+require_relative 'error'
+
+module Terraform
+  # Common logic for Mixlib::ShellOut Terraform commands
+  module Command
+    attr_reader :name, :options, :target
+
+    def execute
+      # TODO: use the live output stream
+      shell_out.run_command
+      shell_out.error!
+      yield shell_out.stdout if block_given?
+    rescue => error
+      handle error: error
+      raise Error, error.message, error.backtrace
+    end
+
+    def handle(**_)
+    end
+
+    def to_s
+      CommandOptions.new options do |command_options|
+        return "terraform #{name} #{command_options} #{target}"
+      end
+    end
+
+    private
+
+    attr_accessor :shell_out
+
+    attr_writer :name, :options, :target
+
+    def initialize(**keyword_arguments)
+      initialize_attributes(**keyword_arguments)
+      self.shell_out = Mixlib::ShellOut.new to_s, returns: 0
+      yield self if block_given?
+    end
+  end
+end