kitchen-terraform 0.1.0

data/lib/terraform/command_options.rb

@@ -0,0 +1,45 @@
+# 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
+  # Manages options for Terraform commands
+  class CommandOptions
+    def to_s
+      key_flags.each_with_object String.new('') do |(flag, values), string|
+        values.each { |value| string.concat "#{flag}=#{value} " }
+      end.chomp ' '
+    end
+
+    private
+
+    attr_accessor :options
+
+    def key_flags
+      options
+        .map { |key, value| [key.to_s.tr('_', '-').prepend('-'), value] }.to_h
+    end
+
+    def initialize(**options)
+      self.options = options
+      normalize_values
+      yield self if block_given?
+    end
+
+    def normalize_values
+      options.each_pair { |key, value| options.store key, Array(value) }
+    end
+  end
+end

data/lib/terraform/error.rb

@@ -0,0 +1,20 @@
+# 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
+  class Error < StandardError
+  end
+end

data/lib/terraform/get_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 get modules
+  class GetCommand
+    include Command
+
+    private
+
+    def initialize_attributes(dir:)
+      self.name = 'get'
+      self.options = { update: true }
+      self.target = dir
+    end
+  end
+end

data/lib/terraform/inspec_runner.rb

@@ -0,0 +1,44 @@
+# 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 'inspec'
+
+module Terraform
+  # Inspec::Runner with convenience methods for use by
+  # Kitchen::Verifier::Terraform
+  class InspecRunner < Inspec::Runner
+    attr_reader :conf
+
+    def add(targets:)
+      targets.each { |target| add_target target, conf }
+    end
+
+    def define_attribute(name:, value:)
+      conf.fetch('attributes').store name.to_s, value
+    end
+
+    def verify_run(verifier:)
+      verifier.evaluate exit_code: run
+    end
+
+    private
+
+    def initialize(conf = {})
+      super
+      yield self if block_given?
+    end
+  end
+end

data/lib/terraform/invalid_version.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.
+
+require_relative 'error'
+
+module Terraform
+  # Error of an invalid Terraform version
+  class InvalidVersion < Error
+    def message
+      "Terraform version must match #{supported_version}"
+    end
+
+    private
+
+    attr_accessor :supported_version
+
+    def initialize(supported_version)
+      self.supported_version = supported_version
+    end
+  end
+end

data/lib/terraform/output_command.rb

@@ -0,0 +1,38 @@
+# 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'
+require_relative 'output_not_found'
+
+module Terraform
+  # Command to extract values of output variables
+  class OutputCommand
+    include Command
+
+    def handle(error:)
+      raise OutputNotFound, error.message, error.backtrace if
+        error.message =~ /no(?:thing to)? output/
+    end
+
+    private
+
+    def initialize_attributes(state:, name:)
+      self.name = 'output'
+      self.options = { state: state }
+      self.target = name
+    end
+  end
+end

data/lib/terraform/output_not_found.rb

@@ -0,0 +1,23 @@
+# 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 'error'
+
+module Terraform
+  # Error of an output not found
+  class OutputNotFound < Error
+  end
+end

data/lib/terraform/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_relative 'command'
+
+module Terraform
+  # Command to plan an execution
+  class PlanCommand
+    include Command
+
+    private
+
+    def initialize_attributes(destroy:, out:, state:, var:, var_file:, dir:)
+      self.name = 'plan'
+      self.options = {
+        destroy: destroy, input: false, out: out, state: state, var: var,
+        var_file: var_file
+      }
+      self.target = dir
+    end
+  end
+end

data/lib/terraform/validate_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 valdidate configuration files
+  class ValidateCommand
+    include Command
+
+    private
+
+    def initialize_attributes(dir:)
+      self.name = 'validate'
+      self.options = {}
+      self.target = dir
+    end
+  end
+end

data/lib/terraform/version.rb

@@ -0,0 +1,19 @@
+# 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
+  VERSION = '0.1.0'
+end

data/lib/terraform/version_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 obtain the version
+  class VersionCommand
+    include Command
+
+    private
+
+    def initialize_attributes(**_)
+      self.name = 'version'
+      self.options = {}
+      self.target = ''
+    end
+  end
+end

data/spec/lib/kitchen/driver/terraform_spec.rb

@@ -0,0 +1,126 @@
+# 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/driver/terraform'
+require 'terraform/error'
+require 'support/terraform/client_holder_context'
+require 'support/terraform/client_holder_examples'
+require 'support/terraform/versions_are_set_examples'
+
+RSpec.describe Kitchen::Driver::Terraform do
+  let(:described_instance) { described_class.new }
+
+  it_behaves_like Terraform::ClientHolder
+
+  it_behaves_like 'versions are set'
+
+  describe '.serial_actions' do
+    subject(:serial_actions) { described_class.serial_actions }
+
+    it('is empty') { is_expected.to be_empty }
+  end
+
+  describe '#create(_state = nil)' do
+    include_context '#client'
+
+    before do
+      allow(client).to receive(:fetch_version).with(no_args).and_yield output
+    end
+
+    subject { proc { described_instance.create } }
+
+    context 'when the Terraform version is supported' do
+      let(:output) { 'v0.6.1' }
+
+      it('does not raise an error') { is_expected.to_not raise_error }
+    end
+
+    context 'when the Terraform version is not supported' do
+      let(:output) { 'v0.5.2' }
+
+      it 'does raise an error' do
+        is_expected.to raise_error Kitchen::ActionFailed
+      end
+    end
+
+    context 'when the client command fails' do
+      before do
+        allow(client).to receive(:fetch_version).with(no_args)
+          .and_raise Terraform::Error
+      end
+
+      it 'does raise an error' do
+        is_expected.to raise_error Kitchen::ActionFailed
+      end
+    end
+  end
+
+  describe '#destroy(_state = nil)' do
+    include_context '#client'
+
+    let(:call_method) { described_instance.destroy }
+
+    context 'when the Terraform state can be destroyed' do
+      before do
+        allow(client).to receive(:validate_configuration_files).with no_args
+
+        allow(client).to receive(:download_modules).with no_args
+
+        allow(client).to receive(:plan_destructive_execution).with no_args
+
+        allow(client).to receive(:apply_execution_plan).with no_args
+      end
+
+      after { call_method }
+
+      subject { client }
+
+      it 'validates the configuration files' do
+        is_expected.to receive(:validate_configuration_files).with no_args
+      end
+
+      it 'gets the modules' do
+        is_expected.to receive(:download_modules).with no_args
+      end
+
+      it 'plans the destructive execution' do
+        is_expected.to receive(:plan_destructive_execution).with no_args
+      end
+
+      it 'applies the execution plan' do
+        is_expected.to receive(:apply_execution_plan).with no_args
+      end
+    end
+
+    context 'when a client command fails' do
+      before do
+        allow(client).to receive(:validate_configuration_files).and_raise
+      end
+
+      subject { proc { call_method } }
+
+      it 'raises an error' do
+        is_expected.to raise_error Kitchen::ActionFailed
+      end
+    end
+  end
+
+  describe '#supported_version' do
+    subject { described_instance.supported_version }
+
+    it('equals v0.6') { is_expected.to eq 'v0.6' }
+  end
+end