mirror of
https://github.com/opentofu/opentofu.git
synced 2024-12-30 10:47:14 -06:00
9a5c865040
Previously we required callers to separately call .Validate on the root module to determine if there were any value errors, but we did that inconsistently and would thus see crashes in some cases where later code would try to use invalid configuration as if it were valid. Now we run .Validate automatically after config loading, returning the resulting diagnostics. Since we return a diagnostics here, it's possible to return both warnings and errors. We return the loaded module even if it's invalid, so callers are free to ignore returned errors and try to work with the config anyway, though they will need to be defensive against invalid configuration themselves in that case. As a result of this, all of the commands that load configuration now need to use diagnostic printing to signal errors. For the moment this just allows us to return potentially-multiple config errors/warnings in full fidelity, but also sets us up for later when more subsystems are able to produce rich diagnostics so we can show them all together. Finally, this commit also removes some stale, commented-out code for the "legacy" (pre-0.8) graph implementation, which has not been available for some time.
134 lines
3.1 KiB
Go
134 lines
3.1 KiB
Go
package command
|
|
|
|
import (
|
|
"fmt"
|
|
"sort"
|
|
|
|
"github.com/hashicorp/terraform/moduledeps"
|
|
"github.com/hashicorp/terraform/terraform"
|
|
"github.com/xlab/treeprint"
|
|
)
|
|
|
|
// ProvidersCommand is a Command implementation that prints out information
|
|
// about the providers used in the current configuration/state.
|
|
type ProvidersCommand struct {
|
|
Meta
|
|
}
|
|
|
|
func (c *ProvidersCommand) Help() string {
|
|
return providersCommandHelp
|
|
}
|
|
|
|
func (c *ProvidersCommand) Synopsis() string {
|
|
return "Prints a tree of the providers used in the configuration"
|
|
}
|
|
|
|
func (c *ProvidersCommand) Run(args []string) int {
|
|
c.Meta.process(args, false)
|
|
|
|
cmdFlags := c.Meta.flagSet("providers")
|
|
cmdFlags.Usage = func() { c.Ui.Error(c.Help()) }
|
|
if err := cmdFlags.Parse(args); err != nil {
|
|
return 1
|
|
}
|
|
|
|
configPath, err := ModulePath(cmdFlags.Args())
|
|
if err != nil {
|
|
c.Ui.Error(err.Error())
|
|
return 1
|
|
}
|
|
|
|
// Load the config
|
|
root, diags := c.Module(configPath)
|
|
if diags.HasErrors() {
|
|
c.showDiagnostics(diags)
|
|
return 1
|
|
}
|
|
if root == nil {
|
|
c.Ui.Error(fmt.Sprintf(
|
|
"No configuration files found in the directory: %s\n\n"+
|
|
"This command requires configuration to run.",
|
|
configPath))
|
|
return 1
|
|
}
|
|
|
|
// Load the backend
|
|
b, err := c.Backend(&BackendOpts{
|
|
Config: root.Config(),
|
|
})
|
|
if err != nil {
|
|
c.Ui.Error(fmt.Sprintf("Failed to load backend: %s", err))
|
|
return 1
|
|
}
|
|
|
|
// Get the state
|
|
env := c.Workspace()
|
|
state, err := b.State(env)
|
|
if err != nil {
|
|
c.Ui.Error(fmt.Sprintf("Failed to load state: %s", err))
|
|
return 1
|
|
}
|
|
if err := state.RefreshState(); err != nil {
|
|
c.Ui.Error(fmt.Sprintf("Failed to load state: %s", err))
|
|
return 1
|
|
}
|
|
|
|
s := state.State()
|
|
|
|
depTree := terraform.ModuleTreeDependencies(root, s)
|
|
depTree.SortDescendents()
|
|
|
|
printRoot := treeprint.New()
|
|
providersCommandPopulateTreeNode(printRoot, depTree)
|
|
|
|
c.Ui.Output(printRoot.String())
|
|
|
|
c.showDiagnostics(diags)
|
|
if diags.HasErrors() {
|
|
return 1
|
|
}
|
|
|
|
return 0
|
|
}
|
|
|
|
func providersCommandPopulateTreeNode(node treeprint.Tree, deps *moduledeps.Module) {
|
|
names := make([]string, 0, len(deps.Providers))
|
|
for name := range deps.Providers {
|
|
names = append(names, string(name))
|
|
}
|
|
sort.Strings(names)
|
|
|
|
for _, name := range names {
|
|
dep := deps.Providers[moduledeps.ProviderInstance(name)]
|
|
versionsStr := dep.Constraints.String()
|
|
if versionsStr != "" {
|
|
versionsStr = " " + versionsStr
|
|
}
|
|
var reasonStr string
|
|
switch dep.Reason {
|
|
case moduledeps.ProviderDependencyInherited:
|
|
reasonStr = " (inherited)"
|
|
case moduledeps.ProviderDependencyFromState:
|
|
reasonStr = " (from state)"
|
|
}
|
|
node.AddNode(fmt.Sprintf("provider.%s%s%s", name, versionsStr, reasonStr))
|
|
}
|
|
|
|
for _, child := range deps.Children {
|
|
childNode := node.AddBranch(fmt.Sprintf("module.%s", child.Name))
|
|
providersCommandPopulateTreeNode(childNode, child)
|
|
}
|
|
}
|
|
|
|
const providersCommandHelp = `
|
|
Usage: terraform providers [dir]
|
|
|
|
Prints out a tree of modules in the referenced configuration annotated with
|
|
their provider requirements.
|
|
|
|
This provides an overview of all of the provider requirements across all
|
|
referenced modules, as an aid to understanding why particular provider
|
|
plugins are needed and why particular versions are selected.
|
|
|
|
`
|