mirror of
https://github.com/opentffoundation/opentf.git
synced 2026-03-13 01:00:50 -04:00
ce49dd6080
When you specify `-verbose` you'll get the whole graph of operations,
which gives a better idea of the operations terraform performs and in
what order.
The DOT graph is now generated with a small internal library instead of
simple string building. This allows us to ensure the graph generation is
as consistent as possible, among other benefits.
We set `newrank = true` in the graph, which I've found does just as good
a job organizing things visually as manually attempting to rank the nodes
based on depth.
This also fixes `-module-depth`, which was broken post-AST refector.
Modules are now expanded into subgraphs with labels and borders. We
have yet to regain the plan graphing functionality, so I removed that
from the docs for now.
Finally, if `-draw-cycles` is added, extra colored edges will be drawn
to indicate the path of any cycles detected in the graph.
A notable implementation change included here is that
{Reverse,}DepthFirstWalk has been made deterministic. (Before it was
dependent on `map` ordering.) This turned out to be unnecessary to gain
determinism in the final DOT-level implementation, but it seemed
a desirable enough of a property that I left it in.
113 lines
2.8 KiB
Go
113 lines
2.8 KiB
Go
package command
|
|
|
|
import (
|
|
"flag"
|
|
"fmt"
|
|
"os"
|
|
"strings"
|
|
|
|
"github.com/hashicorp/terraform/terraform"
|
|
)
|
|
|
|
// GraphCommand is a Command implementation that takes a Terraform
|
|
// configuration and outputs the dependency tree in graphical form.
|
|
type GraphCommand struct {
|
|
Meta
|
|
}
|
|
|
|
func (c *GraphCommand) Run(args []string) int {
|
|
var moduleDepth int
|
|
var verbose bool
|
|
var drawCycles bool
|
|
|
|
args = c.Meta.process(args, false)
|
|
|
|
cmdFlags := flag.NewFlagSet("graph", flag.ContinueOnError)
|
|
cmdFlags.IntVar(&moduleDepth, "module-depth", 0, "module-depth")
|
|
cmdFlags.BoolVar(&verbose, "verbose", false, "verbose")
|
|
cmdFlags.BoolVar(&drawCycles, "draw-cycles", false, "draw-cycles")
|
|
cmdFlags.Usage = func() { c.Ui.Error(c.Help()) }
|
|
if err := cmdFlags.Parse(args); err != nil {
|
|
return 1
|
|
}
|
|
|
|
var path string
|
|
args = cmdFlags.Args()
|
|
if len(args) > 1 {
|
|
c.Ui.Error("The graph command expects one argument.\n")
|
|
cmdFlags.Usage()
|
|
return 1
|
|
} else if len(args) == 1 {
|
|
path = args[0]
|
|
} else {
|
|
var err error
|
|
path, err = os.Getwd()
|
|
if err != nil {
|
|
c.Ui.Error(fmt.Sprintf("Error getting pwd: %s", err))
|
|
}
|
|
}
|
|
|
|
ctx, _, err := c.Context(contextOpts{
|
|
Path: path,
|
|
StatePath: "",
|
|
})
|
|
if err != nil {
|
|
c.Ui.Error(fmt.Sprintf("Error loading Terraform: %s", err))
|
|
return 1
|
|
}
|
|
|
|
// Skip validation during graph generation - we want to see the graph even if
|
|
// it is invalid for some reason.
|
|
g, err := ctx.Graph(&terraform.ContextGraphOpts{
|
|
Verbose: verbose,
|
|
Validate: false,
|
|
})
|
|
if err != nil {
|
|
c.Ui.Error(fmt.Sprintf("Error creating graph: %s", err))
|
|
return 1
|
|
}
|
|
|
|
graphStr, err := terraform.GraphDot(g, &terraform.GraphDotOpts{
|
|
DrawCycles: drawCycles,
|
|
MaxDepth: moduleDepth,
|
|
Verbose: verbose,
|
|
})
|
|
if err != nil {
|
|
c.Ui.Error(fmt.Sprintf("Error converting graph: %s", err))
|
|
return 1
|
|
}
|
|
|
|
c.Ui.Output(graphStr)
|
|
|
|
return 0
|
|
}
|
|
|
|
func (c *GraphCommand) Help() string {
|
|
helpText := `
|
|
Usage: terraform graph [options] [DIR]
|
|
|
|
Outputs the visual dependency graph of Terraform resources according to
|
|
configuration files in DIR (or the current directory if omitted).
|
|
|
|
The graph is outputted in DOT format. The typical program that can
|
|
read this format is GraphViz, but many web services are also available
|
|
to read this format.
|
|
|
|
Options:
|
|
|
|
-draw-cycles Highlight any cycles in the graph with colored edges.
|
|
This helps when diagnosing cycle errors.
|
|
|
|
-module-depth=n The maximum depth to expand modules. By default this is
|
|
zero, which will not expand modules at all.
|
|
|
|
-verbose Generate a verbose, "worst-case" graph, with all nodes
|
|
for potential operations in place.
|
|
`
|
|
return strings.TrimSpace(helpText)
|
|
}
|
|
|
|
func (c *GraphCommand) Synopsis() string {
|
|
return "Create a visual graph of Terraform resources"
|
|
}
|