Contents

# frozen_string_literal: true

require_relative 'base'
require_relative '../options/common'

module RubyTerraform
  module Commands
    # Wraps the +terraform force-unlock+ command which manually unlocks the
    # state for the defined configuration.
    #
    # This will not modify your infrastructure. This command removes the lock on
    # the state for the current workspace. The behavior of this lock is
    # dependent on the backend being used. Local state files cannot be unlocked
    # by another process.
    #
    # For options accepted on construction, see {#initialize}.
    #
    # When executing an instance of {ForceUnlock} via {#execute}, the following
    # options are supported:
    #
    # * +:lock_id+: the lock ID output when attempting an operation that failed
    #   due to a lock; required.
    # * +:chdir+: the path of a working directory to switch to before executing
    #   the given subcommand.
    # * +:force+: If +true+, does not ask for input for unlock confirmation;
    #   defaults to +false+.
    #
    # @example Basic Invocation
    #   RubyTerraform::Commands::ForceUnlock.new.execute(
    #     lock_id: '50e844a7-ebb0-fcfd-da85-5cce5bd1ec90')
    #
    class ForceUnlock < Base
      include RubyTerraform::Options::Common

      # @!visibility private
      def subcommands
        %w[force-unlock]
      end

      # @!visibility private
      def options
        %w[-force] + super
      end

      # @!visibility private
      # @todo Add directory option.
      def arguments(parameters)
        [parameters[:lock_id]]
      end
    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
ruby-terraform-0.65.0.pre.15	lib/ruby_terraform/commands/force_unlock.rb