newcontext-oss/kitchen-terraform

# frozen_string_literal: true

# Copyright 2016-2021 Copado NCS LLC
#
# 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