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"
require "kitchen/terraform/config_attribute"
require "kitchen/terraform/config_attribute_contract/boolean"

module Kitchen
  module Terraform
    class ConfigAttribute
      # This attribute toggles {https://www.terraform.io/docs/state/locking.html locking of the Terraform state file}.
      #
      # Type:: {http://www.yaml.org/spec/1.2/spec.html#id2803629 Boolean}
      # Required:: False
      # Default:: +true+
      # Example:: <code>lock: false</code>
      module Lock
        ::Kitchen::Terraform::ConfigAttribute.new(
          attribute: :lock,
          default_value: lambda do
            true
          end,
          schema: ::Kitchen::Terraform::ConfigAttributeContract::Boolean.new,
        ).apply config_attribute: self
      end
    end
  end
end