mirror of
https://github.com/opentofu/opentofu.git
synced 2024-12-28 01:41:48 -06:00
ef9054562e
A lot of commands used `c.Meta.flagSet()` to create the initial flagset for the command, while quite a few of them didn’t actually use or support the flags that are then added. So I updated a few commands to use `flag.NewFlagSet()` instead to only add the flags that are actually needed/supported. Additionally this prevents a few commands from using locking while they actually don’t need locking (as locking is enabled as a default in `c.Meta.flagSet()`.
124 lines
3.3 KiB
Go
124 lines
3.3 KiB
Go
package command
|
|
|
|
import (
|
|
"fmt"
|
|
"strings"
|
|
|
|
"github.com/hashicorp/terraform/states"
|
|
"github.com/mitchellh/cli"
|
|
)
|
|
|
|
// StateListCommand is a Command implementation that lists the resources
|
|
// within a state file.
|
|
type StateListCommand struct {
|
|
Meta
|
|
StateMeta
|
|
}
|
|
|
|
func (c *StateListCommand) Run(args []string) int {
|
|
args, err := c.Meta.process(args, true)
|
|
if err != nil {
|
|
return 1
|
|
}
|
|
|
|
cmdFlags := c.Meta.defaultFlagSet("state list")
|
|
cmdFlags.StringVar(&c.Meta.statePath, "state", "", "path")
|
|
lookupId := cmdFlags.String("id", "", "Restrict output to paths with a resource having the specified ID.")
|
|
if err := cmdFlags.Parse(args); err != nil {
|
|
return cli.RunResultHelp
|
|
}
|
|
args = cmdFlags.Args()
|
|
|
|
// Load the backend
|
|
b, backendDiags := c.Backend(nil)
|
|
if backendDiags.HasErrors() {
|
|
c.showDiagnostics(backendDiags)
|
|
return 1
|
|
}
|
|
|
|
// Get the state
|
|
env := c.Workspace()
|
|
stateMgr, err := b.StateMgr(env)
|
|
if err != nil {
|
|
c.Ui.Error(fmt.Sprintf(errStateLoadingState, err))
|
|
return 1
|
|
}
|
|
if err := stateMgr.RefreshState(); err != nil {
|
|
c.Ui.Error(fmt.Sprintf("Failed to refresh state: %s", err))
|
|
return 1
|
|
}
|
|
|
|
state := stateMgr.State()
|
|
if state == nil {
|
|
c.Ui.Error(fmt.Sprintf(errStateNotFound))
|
|
return 1
|
|
}
|
|
|
|
filter := &states.Filter{State: state}
|
|
results, err := filter.Filter(args...)
|
|
if err != nil {
|
|
c.Ui.Error(fmt.Sprintf(errStateFilter, err))
|
|
return cli.RunResultHelp
|
|
}
|
|
|
|
for _, result := range results {
|
|
if is, ok := result.Value.(*states.ResourceInstance); ok {
|
|
if *lookupId == "" || *lookupId == states.LegacyInstanceObjectID(is.Current) {
|
|
c.Ui.Output(result.Address.String())
|
|
}
|
|
}
|
|
}
|
|
|
|
return 0
|
|
}
|
|
|
|
func (c *StateListCommand) Help() string {
|
|
helpText := `
|
|
Usage: terraform state list [options] [pattern...]
|
|
|
|
List resources in the Terraform state.
|
|
|
|
This command lists resources in the Terraform state. The pattern argument
|
|
can be used to filter the resources by resource or module. If no pattern
|
|
is given, all resources are listed.
|
|
|
|
The pattern argument is meant to provide very simple filtering. For
|
|
advanced filtering, please use tools such as "grep". The output of this
|
|
command is designed to be friendly for this usage.
|
|
|
|
The pattern argument accepts any resource targeting syntax. Please
|
|
refer to the documentation on resource targeting syntax for more
|
|
information.
|
|
|
|
Options:
|
|
|
|
-state=statefile Path to a Terraform state file to use to look
|
|
up Terraform-managed resources. By default it will
|
|
use the state "terraform.tfstate" if it exists.
|
|
|
|
-id=ID Restricts the output to objects whose id is ID.
|
|
|
|
`
|
|
return strings.TrimSpace(helpText)
|
|
}
|
|
|
|
func (c *StateListCommand) Synopsis() string {
|
|
return "List resources in the state"
|
|
}
|
|
|
|
const errStateFilter = `Error filtering state: %[1]s
|
|
|
|
Please ensure that all your addresses are formatted properly.`
|
|
|
|
const errStateLoadingState = `Error loading the state: %[1]s
|
|
|
|
Please ensure that your Terraform state exists and that you've
|
|
configured it properly. You can use the "-state" flag to point
|
|
Terraform at another state file.`
|
|
|
|
const errStateNotFound = `No state file was found!
|
|
|
|
State management commands require a state file. Run this command
|
|
in a directory where Terraform has been run or use the -state flag
|
|
to point the command to a specific state location.`
|