kitchen-terraform 5.1.1 → 5.6.0

data/lib/kitchen/terraform/system_bastion_host_resolver.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+# Copyright 2016-2019 New Context, 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"
+
+module Kitchen
+  module Terraform
+    # SystemBastionHostResolver is the class of objects which resolve a bastion host of a system which may be either
+    # dynamically obtained from a Terraform output variable or statically defined.
+    class SystemBastionHostResolver
+      # #initialize prepares a new instance of the class.
+      #
+      # @param outputs [Hash] a map of Terraform output variables.
+      # @return [Kitchen::Terraform::SystemBastionHostResolver]
+      def initialize(outputs:)
+        self.outputs = Hash[outputs]
+      end
+
+      # #resolve resolves a bastion host from either the specified Terraform output or the static value.
+      #
+      # @param bastion_host [String] a statically defined host.
+      # @param bastion_host_output [String] the name of the Terraform output which contains a bastion host.
+      # @yieldparam bastion_host [String] the bastion host.
+      # @raise [Kitchen::ClientError] if the specified Terraform output is not found.
+      # @return [self]
+      def resolve(bastion_host:, bastion_host_output:)
+        if !bastion_host.empty?
+          yield bastion_host: bastion_host
+        elsif !bastion_host_output.empty?
+          yield bastion_host: resolved_output(bastion_host_output: bastion_host_output).fetch(:value)
+        end
+
+        self
+      rescue ::KeyError
+        raise(
+          ::Kitchen::ClientError,
+          "Resolving the system bastion host failed due to the absence of the 'value' key from the " \
+          "'#{bastion_host_output}' Terraform output of the Kitchen instance state. This error indicates that the " \
+          "output format of `terraform output -json` is unexpected."
+        )
+      end
+
+      private
+
+      attr_accessor :outputs
+
+      def resolved_output(bastion_host_output:)
+        outputs.fetch bastion_host_output.to_sym
+      rescue ::KeyError
+        raise(
+          ::Kitchen::ClientError,
+          "Resolving the system bastion host failed due to the absence of the '#{bastion_host_output}' key from the " \
+          "Terraform outputs of the Kitchen instance state. This error indicates either that `kitchen converge` must " \
+          "be executed again to update the Terraform outputs or that the wrong key was provided."
+        )
+      end
+    end
+  end
+end

data/lib/kitchen/terraform/system_hosts_resolver.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016 New Context Services, Inc.
+# Copyright 2016-2019 New Context, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -14,31 +14,53 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "kitchen/terraform"
-require "kitchen/terraform/error"
+require "kitchen"
 
 module Kitchen
   module Terraform
-    # SystemHostsResolver is the class of objects which resolve for systems the hosts which are contained in outputs.
+    # SystemHostsResolver is the class of objects which resolve the hosts of a system which are contained in Terraform
+    # outputs.
     class SystemHostsResolver
-      # #resolve resolves the hosts.
+      # #initialize prepares a new instance of the class.
       #
-      # @param hosts_output [::String] the name of the Terraform output which has a value of hosts for the system.
-      # @param system [::Kitchen::Terraform::System] the system.
-      # @raise [::Kitchen::Terraform::Error] if the fetching the value of the output fails.
-      def resolve(hosts_output:, system:)
-        system.add_hosts hosts: @outputs.fetch(hosts_output).fetch("value")
-      rescue ::KeyError => key_error
-        raise ::Kitchen::Terraform::Error, "Resolving hosts failed\n#{key_error}"
+      # @param outputs [Hash] a map of Terraform output variables.
+      # @return [Kitchen::Terraform::SystemHostsResolver]
+      def initialize(outputs:)
+        self.outputs = Hash[outputs]
+      end
+
+      # #resolve reads the specified Terraform output and stores the value in a list of hosts.
+      #
+      # @param hosts [Array] the list of hosts.
+      # @param hosts_output [String] the name of the Terraform output which contains hosts.
+      # @raise [Kitchen::ClientError] if the specified Terraform output is not found.
+      # @return [self]
+      def resolve(hosts:, hosts_output:)
+        hosts.concat Array resolved_output(hosts_output: hosts_output).fetch :value
+
+        self
+      rescue ::KeyError
+        raise(
+          ::Kitchen::ClientError,
+          "Resolving the system hosts failed due to the absence of the 'value' key from the '#{hosts_output}' " \
+          "Terraform output of the Kitchen instance state. This error indicates that the output format of " \
+          "`terraform output -json` is unexpected."
+        )
       end
 
       private
 
-      # #initialize prepares the instance to be used.
-      #
-      # @param outputs [#to_hash] the outputs of the Terraform state under test.
-      def initialize(outputs:)
-        @outputs = Hash[outputs]
+      attr_accessor :outputs
+
+      def resolved_output(hosts_output:)
+        outputs.fetch hosts_output.to_sym
+      rescue ::KeyError
+        raise(
+          ::Kitchen::ClientError,
+          "Resolving the system hosts failed due to the absence of the '#{hosts_output}' key from the Terraform " \
+          "outputs of the Kitchen instance state. This error indicates either that `kitchen converge` must be " \
+          "executed again to update the Terraform outputs or that the wrong key was provided."
+        )
       end
     end
   end

data/lib/kitchen/terraform/system_inspec_map.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# Copyright 2016-2019 New Context, 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 Kitchen
+  module Terraform
+    # SYSTEM_INSPEC_MAP is a mapping of system configuration attribute keys to InSpec option keys.
+    SYSTEM_INSPEC_MAP = {
+      attrs: :input_file,
+      backend_cache: :backend_cache,
+      backend: :backend,
+      bastion_port: :bastion_port,
+      bastion_user: :bastion_user,
+      color: "color",
+      controls: :controls,
+      enable_password: :enable_password,
+      key_files: :key_files,
+      password: :password,
+      path: :path,
+      port: :port,
+      proxy_command: :proxy_command,
+      reporter: "reporter",
+      self_signed: :self_signed,
+      shell_command: :shell_command,
+      shell_options: :shell_options,
+      shell: :shell,
+      show_progress: :show_progress,
+      ssl: :ssl,
+      sudo_command: :sudo_command,
+      sudo_options: :sudo_options,
+      sudo_password: :sudo_password,
+      sudo: :sudo,
+      user: :user,
+      vendor_cache: :vendor_cache,
+    }
+  end
+end

data/lib/kitchen/terraform/systems_verifier.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# Copyright 2016-2019 New Context, 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 Kitchen
+  module Terraform
+    # SystemsVerifier is the namespace of the classes of objects which verify systems.
+    module SystemsVerifier
+    end
+  end
+end

data/lib/kitchen/terraform/systems_verifier/fail_fast.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# Copyright 2016-2019 New Context, 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"
+
+module Kitchen
+  module Terraform
+    module SystemsVerifier
+      # FailFast is the class of objects which verify systems and raise rescued errors immediately.
+      class FailFast
+        # #initialize prepares a new instance of the class.
+        #
+        # @param systems [Array<::Kitchen::Terraform::System>] a list of systems to be verified.
+        # @return [Kitchen::Terraform::SystemsVerifier::FailFast]
+        def initialize(systems:)
+          self.systems = systems
+        end
+
+        # #verify verifies each system.
+        #
+        # @param outputs [Hash] a mapping of Terraform outputs.
+        # @param variables [Hash] a mapping of Terraform variables.
+        # @raise [Kitchen::TransientFailure] if verification of a system fails.
+        # @return [self]
+        def verify(outputs:, variables:)
+          systems.each do |system|
+            system.verify fail_fast: true, outputs: outputs, variables: variables
+          end
+
+          self
+        end
+
+        private
+
+        attr_accessor :systems
+      end
+    end
+  end
+end

data/lib/kitchen/terraform/systems_verifier/fail_slow.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+# Copyright 2016-2019 New Context, 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"
+
+module Kitchen
+  module Terraform
+    module SystemsVerifier
+      # FailSlow is the class of objects which verify systems and raise rescued errors after all systems have been
+      # verified.
+      class FailSlow
+        # #initialize prepares a new instance of the class.
+        #
+        # @param systems [Array<::Kitchen::Terraform::System>] a list of systems to be verified.
+        # @return [Kitchen::Terraform::SystemsVerifier::FailSlow]
+        def initialize(systems:)
+          self.messages = []
+          self.systems = systems
+        end
+
+        # #verify verifies each system.
+        #
+        # @param outputs [Hash] a mapping of Terraform outputs.
+        # @param variables [Hash] a mapping of Terraform variables.
+        # @raise [Kitchen::TransientFailure] if verification of a system fails.
+        # @return [self]
+        def verify(outputs:, variables:)
+          systems.each do |system|
+            verify_and_continue outputs: outputs, system: system, variables: variables
+          end
+
+          raise ::Kitchen::TransientFailure, messages.join("\n\n") if !messages.empty?
+
+          self
+        end
+
+        private
+
+        attr_accessor :messages, :systems
+
+        def verify_and_continue(outputs:, system:, variables:)
+          system.verify fail_fast: false, outputs: outputs, variables: variables
+        rescue ::Kitchen::TransientFailure => error
+          messages.push error.message
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/terraform/systems_verifier_factory.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# Copyright 2016-2019 New Context, 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/terraform/systems_verifier/fail_fast"
+require "kitchen/terraform/systems_verifier/fail_slow"
+
+module Kitchen
+  module Terraform
+    # SystemsVerifierFactory is the class of objects which build SystemVerifiers.
+    class SystemsVerifierFactory
+      # #build creates a SystemVerifier.
+      #
+      # @param systems [Array<::Kitchen::Terraform::System>] the Systems to be verified.
+      # @return [Kitchen::Terraform::SystemsVerifier::FailFast, ::Kitchen::Terraform::SystemsVerifier::FailSlow] a
+      #   SystemsVerifier.
+      def build(systems:)
+        if fail_fast
+          ::Kitchen::Terraform::SystemsVerifier::FailFast.new systems: systems
+        else
+          ::Kitchen::Terraform::SystemsVerifier::FailSlow.new systems: systems
+        end
+      end
+
+      # #initialize prepares a new instance of the class.
+      #
+      # @param fail_fast [Boolean] a toggle to fail fast or fail slow.
+      # @return [Kitchen::Terraform::SystemsVerifierFactory]
+      def initialize(fail_fast:)
+        self.fail_fast = fail_fast
+      end
+
+      private
+
+      attr_accessor :fail_fast
+    end
+  end
+end

data/lib/kitchen/terraform/unsupported_client_version_error.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# Copyright 2016-2019 New Context, 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/terraform/error"
+
+module Kitchen
+  module Terraform
+    # UnsupportedClientVersionError is the class of objects which are raised when the Terraform client version is
+    # unsupported.
+    class UnsupportedClientVersionError < ::Kitchen::Terraform::Error
+    end
+  end
+end

data/lib/kitchen/terraform/variables_manager.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+# Copyright 2016-2019 New Context, 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"
+
+module Kitchen
+  module Terraform
+    # VariablesManager manages Terraform variables in the Kitchen instance state.
+    class VariablesManager
+      # #initialize prepares a new instance of the class.
+      #
+      # @return [Kitchen::Terraform::VariablesManager]
+      def initialize
+        self.state_key = :kitchen_terraform_variables
+      end
+
+      # #load reads the Terraform variables from the Kitchen instance state and writes them to a container.
+      #
+      # @param variables [Hash] the container to which the Terraform variables will be written.
+      # @param state [Hash] the Kitchen instance state from which the Terraform variables will be read.
+      # @return [self]
+      def load(variables:, state:)
+        variables.replace state.fetch state_key
+
+        self
+      rescue ::KeyError => error
+        raise(
+          ::Kitchen::ClientError,
+          "Reading the Terraform input variables from the Kitchen instance state failed due to the absence of the " \
+          "'#{state_key}' key. This error could indicate that the Kitchen-Terraform provisioner plugin was not used " \
+          "to converge the Kitchen instance."
+        )
+      end
+
+      # #save reads the Terraform variables from a container and writes them to the Kitchen instance state.
+      #
+      # @param variables [Hash] the container from which the Terraform variables will be read.
+      # @param state [Hash] the Kitchen instance state to which the Terraform variables will be written.
+      # @return [self]
+      def save(variables:, state:)
+        state.store state_key, variables
+
+        self
+      end
+
+      private
+
+      attr_accessor :state_key
+    end
+  end
+end