terraform/command/workspace_delete.go

205 lines
4.7 KiB
Go
Raw Normal View History

2017-02-23 19:13:28 +01:00
package command
import (
"context"
2017-02-23 19:13:28 +01:00
"fmt"
"strings"
"time"
2017-02-23 19:13:28 +01:00
"github.com/hashicorp/terraform/command/clistate"
"github.com/hashicorp/terraform/tfdiags"
2017-02-23 19:13:28 +01:00
"github.com/mitchellh/cli"
"github.com/posener/complete"
2017-02-23 19:13:28 +01:00
)
type WorkspaceDeleteCommand struct {
2017-02-23 19:13:28 +01:00
Meta
LegacyName bool
2017-02-23 19:13:28 +01:00
}
func (c *WorkspaceDeleteCommand) Run(args []string) int {
args = c.Meta.process(args)
envCommandShowWarning(c.Ui, c.LegacyName)
var force bool
var stateLock bool
var stateLockTimeout time.Duration
cmdFlags := c.Meta.defaultFlagSet("workspace delete")
cmdFlags.BoolVar(&force, "force", false, "force removal of a non-empty workspace")
cmdFlags.BoolVar(&stateLock, "lock", true, "lock state")
cmdFlags.DurationVar(&stateLockTimeout, "lock-timeout", 0, "lock timeout")
2017-02-23 19:13:28 +01:00
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()))
2017-02-23 19:13:28 +01:00
return 1
}
2017-02-23 19:13:28 +01:00
args = cmdFlags.Args()
if len(args) == 0 {
2017-02-23 19:13:28 +01:00
c.Ui.Error("expected NAME.\n")
return cli.RunResultHelp
}
configPath, err := ModulePath(args[1:])
if err != nil {
c.Ui.Error(err.Error())
return 1
}
var diags tfdiags.Diagnostics
backendConfig, backendDiags := c.loadBackendConfig(configPath)
diags = diags.Append(backendDiags)
if diags.HasErrors() {
c.showDiagnostics(diags)
return 1
}
2017-02-23 19:13:28 +01:00
// Load the backend
b, backendDiags := c.Backend(&BackendOpts{
Config: backendConfig,
})
diags = diags.Append(backendDiags)
if backendDiags.HasErrors() {
c.showDiagnostics(diags)
2017-02-23 19:13:28 +01:00
return 1
}
backend: Validate remote backend Terraform version When using the enhanced remote backend, a subset of all Terraform operations are supported. Of these, only plan and apply can be executed on the remote infrastructure (e.g. Terraform Cloud). Other operations run locally and use the remote backend for state storage. This causes problems when the local version of Terraform does not match the configured version from the remote workspace. If the two versions are incompatible, an `import` or `state mv` operation can cause the remote workspace to be unusable until a manual fix is applied. To prevent this from happening accidentally, this commit introduces a check that the local Terraform version and the configured remote workspace Terraform version are compatible. This check is skipped for commands which do not write state, and can also be disabled by the use of a new command-line flag, `-ignore-remote-version`. Terraform version compatibility is defined as: - For all releases before 0.14.0, local must exactly equal remote, as two different versions cannot share state; - 0.14.0 to 1.0.x are compatible, as we will not change the state version number until at least Terraform 1.1.0; - Versions after 1.1.0 must have the same major and minor versions, as we will not change the state version number in a patch release. If the two versions are incompatible, a diagnostic is displayed, advising that the error can be suppressed with `-ignore-remote-version`. When this flag is used, the diagnostic is still displayed, but as a warning instead of an error. Commands which will not write state can assert this fact by calling the helper `meta.ignoreRemoteBackendVersionConflict`, which will disable the checks. Those which can write state should instead call the helper `meta.remoteBackendVersionCheck`, which will return diagnostics for display. In addition to these explicit paths for managing the version check, we have an implicit check in the remote backend's state manager initialization method. Both of the above helpers will disable this check. This fallback is in place to ensure that future code paths which access state cannot accidentally skip the remote version check.
2020-11-13 22:43:56 +01:00
// This command will not write state
c.ignoreRemoteBackendVersionConflict(b)
workspaces, err := b.Workspaces()
2017-02-23 19:13:28 +01:00
if err != nil {
c.Ui.Error(err.Error())
return 1
}
workspace := args[0]
2017-02-23 19:13:28 +01:00
exists := false
for _, ws := range workspaces {
if workspace == ws {
2017-02-23 19:13:28 +01:00
exists = true
break
}
}
if !exists {
c.Ui.Error(fmt.Sprintf(strings.TrimSpace(envDoesNotExist), workspace))
2017-02-23 19:13:28 +01:00
return 1
}
currentWorkspace, err := c.Workspace()
if err != nil {
c.Ui.Error(fmt.Sprintf("Error selecting workspace: %s", err))
return 1
}
if workspace == currentWorkspace {
c.Ui.Error(fmt.Sprintf(strings.TrimSpace(envDelCurrent), workspace))
return 1
2017-02-23 19:13:28 +01:00
}
// we need the actual state to see if it's empty
stateMgr, err := b.StateMgr(workspace)
2017-02-23 19:13:28 +01:00
if err != nil {
c.Ui.Error(err.Error())
return 1
}
var stateLocker clistate.Locker
if stateLock {
stateLocker = clistate.NewLocker(context.Background(), stateLockTimeout, c.Ui, c.Colorize())
if err := stateLocker.Lock(stateMgr, "workspace_delete"); err != nil {
c.Ui.Error(fmt.Sprintf("Error locking state: %s", err))
return 1
}
} else {
stateLocker = clistate.NewNoopLocker()
}
if err := stateMgr.RefreshState(); err != nil {
// We need to release the lock before exit
stateLocker.Unlock(nil)
2017-02-23 19:13:28 +01:00
c.Ui.Error(err.Error())
return 1
}
hasResources := stateMgr.State().HasResources()
2017-02-23 19:13:28 +01:00
if hasResources && !force {
// We need to release the lock before exit
stateLocker.Unlock(nil)
c.Ui.Error(fmt.Sprintf(strings.TrimSpace(envNotEmpty), workspace))
2017-02-23 19:13:28 +01:00
return 1
}
// We need to release the lock just before deleting the state, in case
// the backend can't remove the resource while holding the lock. This
// is currently true for Windows local files.
//
// TODO: While there is little safety in locking while deleting the
// state, it might be nice to be able to coordinate processes around
// state deletion, i.e. in a CI environment. Adding Delete() as a
// required method of States would allow the removal of the resource to
// be delegated from the Backend to the State itself.
stateLocker.Unlock(nil)
2017-02-23 19:13:28 +01:00
err = b.DeleteWorkspace(workspace)
2017-02-23 19:13:28 +01:00
if err != nil {
c.Ui.Error(err.Error())
return 1
}
c.Ui.Output(
c.Colorize().Color(
fmt.Sprintf(envDeleted, workspace),
2017-02-23 19:13:28 +01:00
),
)
if hasResources {
2017-02-23 19:13:28 +01:00
c.Ui.Output(
c.Colorize().Color(
fmt.Sprintf(envWarnNotEmpty, workspace),
2017-02-23 19:13:28 +01:00
),
)
}
return 0
}
func (c *WorkspaceDeleteCommand) AutocompleteArgs() complete.Predictor {
return completePredictSequence{
complete.PredictNothing, // the "select" subcommand itself (already matched)
c.completePredictWorkspaceName(),
complete.PredictDirs(""),
}
}
func (c *WorkspaceDeleteCommand) AutocompleteFlags() complete.Flags {
return complete.Flags{
"-force": complete.PredictNothing,
}
}
func (c *WorkspaceDeleteCommand) Help() string {
2017-02-23 19:13:28 +01:00
helpText := `
Usage: terraform workspace delete [OPTIONS] NAME [DIR]
2017-02-23 19:13:28 +01:00
Delete a Terraform workspace
2017-02-23 19:13:28 +01:00
Options:
-force remove a non-empty workspace.
-lock=true Lock the state file when locking is supported.
-lock-timeout=0s Duration to retry a state lock.
2017-02-23 19:13:28 +01:00
`
return strings.TrimSpace(helpText)
}
func (c *WorkspaceDeleteCommand) Synopsis() string {
return "Delete a workspace"
2017-02-23 19:13:28 +01:00
}