// Copyright (c) The OpenTofu Authors // SPDX-License-Identifier: MPL-2.0 // Copyright (c) 2023 HashiCorp, Inc. // SPDX-License-Identifier: MPL-2.0 package command import ( "context" "fmt" "strings" "github.com/opentofu/opentofu/internal/states/statemgr" "github.com/mitchellh/cli" "github.com/opentofu/opentofu/internal/tfdiags" "github.com/opentofu/opentofu/internal/tofu" ) // UnlockCommand is a cli.Command implementation that manually unlocks // the state. type UnlockCommand struct { Meta } func (c *UnlockCommand) Run(args []string) int { ctx := c.CommandContext() args = c.Meta.process(args) var force bool cmdFlags := c.Meta.defaultFlagSet("force-unlock") c.Meta.varFlagSet(cmdFlags) cmdFlags.BoolVar(&force, "force", false, "force") cmdFlags.Usage = func() { c.Ui.Error(c.Help()) } if err := cmdFlags.Parse(args); err != nil { c.Ui.Error(fmt.Sprintf("Error parsing command-line flags: %s\n", err.Error())) return 1 } args = cmdFlags.Args() if len(args) != 1 { c.Ui.Error("Expected a single argument: LOCK_ID") return cli.RunResultHelp } lockID := args[0] args = args[1:] // assume everything is initialized. The user can manually init if this is // required. configPath, err := modulePath(args) if err != nil { c.Ui.Error(err.Error()) return 1 } // Load the encryption configuration enc, encDiags := c.EncryptionFromPath(ctx, configPath) if encDiags.HasErrors() { c.showDiagnostics(encDiags) return 1 } var diags tfdiags.Diagnostics backendConfig, backendDiags := c.loadBackendConfig(ctx, configPath) diags = diags.Append(backendDiags) if diags.HasErrors() { c.showDiagnostics(diags) return 1 } // Load the backend b, backendDiags := c.Backend(ctx, &BackendOpts{ Config: backendConfig, }, enc.State()) diags = diags.Append(backendDiags) if backendDiags.HasErrors() { c.showDiagnostics(diags) return 1 } // unlocking is read only when looking at state data c.ignoreRemoteVersionConflict(b) env, err := c.Workspace(ctx) if err != nil { c.Ui.Error(fmt.Sprintf("Error selecting workspace: %s", err)) return 1 } stateMgr, err := b.StateMgr(ctx, env) if err != nil { c.Ui.Error(fmt.Sprintf("Failed to load state: %s", err)) return 1 } _, isLocal := stateMgr.(*statemgr.Filesystem) if optionalLocker, ok := stateMgr.(statemgr.OptionalLocker); ok { // Now we can safely call IsLockingEnabled() on optionalLocker if !optionalLocker.IsLockingEnabled() { c.Ui.Error("Locking is disabled for this backend") return 1 } } // Proceed with unlocking logic if locking is enabled if !force { // Forcing this doesn't do anything, but doesn't break anything either, // and allows us to run the basic command test too. if isLocal { c.Ui.Error("Local state cannot be unlocked by another process") return 1 } desc := "OpenTofu will remove the lock on the remote state.\n" + "This will allow local OpenTofu commands to modify this state, even though it\n" + "may still be in use. Only 'yes' will be accepted to confirm." v, err := c.UIInput().Input(context.Background(), &tofu.InputOpts{ Id: "force-unlock", Query: "Do you really want to force-unlock?", Description: desc, }) if err != nil { c.Ui.Error(fmt.Sprintf("Error asking for confirmation: %s", err)) return 1 } if v != "yes" { c.Ui.Output("force-unlock cancelled.") return 1 } } if err := stateMgr.Unlock(context.TODO(), lockID); err != nil { c.Ui.Error(fmt.Sprintf("Failed to unlock state: %s", err)) return 1 } c.Ui.Output(c.Colorize().Color(strings.TrimSpace(outputUnlockSuccess))) return 0 } func (c *UnlockCommand) Help() string { helpText := ` Usage: tofu [global options] force-unlock [options] LOCK_ID Manually unlock 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. Options: -force Don't ask for input for unlock confirmation. -var 'foo=bar' Set a value for one of the input variables in the root module of the configuration. Use this option more than once to set more than one variable. -var-file=filename Load variable values from the given file, in addition to the default files terraform.tfvars and *.auto.tfvars. Use this option more than once to include more than one variables file. ` return strings.TrimSpace(helpText) } func (c *UnlockCommand) Synopsis() string { return "Release a stuck lock on the current workspace" } const outputUnlockSuccess = ` [reset][bold][green]OpenTofu state has been successfully unlocked![reset][green] The state has been unlocked, and OpenTofu commands should now be able to obtain a new lock on the remote state. `