Files
opentf/internal/command/workspace_show.go
2026-03-03 12:44:56 +02:00

111 lines
3.4 KiB
Go

// 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 (
"fmt"
"strings"
"github.com/mitchellh/cli"
"github.com/opentofu/opentofu/internal/command/arguments"
"github.com/opentofu/opentofu/internal/command/flags"
"github.com/opentofu/opentofu/internal/command/views"
"github.com/opentofu/opentofu/internal/tfdiags"
"github.com/posener/complete"
)
type WorkspaceShowCommand struct {
Meta
}
func (c *WorkspaceShowCommand) Run(rawArgs []string) int {
ctx := c.CommandContext()
common, rawArgs := arguments.ParseView(rawArgs)
c.View.Configure(common)
// Because the legacy UI was using println to show diagnostics and the new view is using, by default, print,
// in order to keep functional parity, we setup the view to add a new line after each diagnostic.
c.View.DiagsWithNewline()
// Propagate -no-color for legacy use of Ui. The remote backend and
// cloud package use this; it should be removed when/if they are
// migrated to views.
c.Meta.color = !common.NoColor
c.Meta.Color = c.Meta.color
// Parse and validate flags
args, closer, diags := arguments.ParseWorkspaceShow(rawArgs)
defer closer()
// Instantiate the view, even if there are flag errors, so that we render
// diagnostics according to the desired view
view := views.NewWorkspace(args.ViewOptions, c.View)
// ... and initialise the Meta.Ui to wrap Meta.View into a new implementation
// that is able to print by using View abstraction and use the Meta.Ui
// to ask for the user input.
c.Meta.configureUiFromView(args.ViewOptions)
if diags.HasErrors() {
view.Diagnostics(diags)
if args.ViewOptions.ViewType == arguments.ViewJSON {
return 1 // in case it's json, do not print the help of the command
}
return cli.RunResultHelp
}
c.GatherVariables(args.Vars)
workspace, err := c.Workspace(ctx)
if err != nil {
view.Diagnostics(tfdiags.Diagnostics{tfdiags.Sourceless(
tfdiags.Error,
"Error getting the current workspace",
fmt.Sprintf("Failed getting the current workspace: %s", err),
)})
return 1
}
view.WorkspaceShow(workspace)
return 0
}
func (c *WorkspaceShowCommand) AutocompleteArgs() complete.Predictor {
return complete.PredictNothing
}
func (c *WorkspaceShowCommand) AutocompleteFlags() complete.Flags {
return nil
}
func (c *WorkspaceShowCommand) Help() string {
helpText := `
Usage: tofu [global options] workspace show
Show the name of the current workspace.
`
return strings.TrimSpace(helpText)
}
func (c *WorkspaceShowCommand) Synopsis() string {
return "Show the name of the current workspace"
}
// TODO meta-refactor: move this to arguments once all commands are using the same shim logic
func (c *WorkspaceShowCommand) GatherVariables(args *arguments.Vars) {
// FIXME the arguments package currently trivially gathers variable related
// arguments in a heterogeneous slice, in order to minimize the number of
// code paths gathering variables during the transition to this structure.
// Once all commands that gather variables have been converted to this
// structure, we could move the variable gathering code to the arguments
// package directly, removing this shim layer.
varArgs := args.All()
items := make([]flags.RawFlag, len(varArgs))
for i := range varArgs {
items[i].Name = varArgs[i].Name
items[i].Value = varArgs[i].Value
}
c.Meta.variableArgs = flags.RawFlags{Items: &items}
}