terraform/command/graph.go

117 lines
2.9 KiB
Go
Raw Normal View History

2014-07-01 19:02:13 +02:00
package command
import (
"flag"
"fmt"
2014-07-12 05:41:47 +02:00
"os"
2014-07-01 19:02:13 +02:00
"strings"
2015-02-20 07:58:42 +01:00
"github.com/hashicorp/terraform/dag"
2015-02-20 07:58:42 +01:00
"github.com/hashicorp/terraform/terraform"
2014-07-01 19:02:13 +02:00
)
// GraphCommand is a Command implementation that takes a Terraform
// configuration and outputs the dependency tree in graphical form.
type GraphCommand struct {
Meta
2014-07-01 19:02:13 +02:00
}
func (c *GraphCommand) Run(args []string) int {
2014-09-25 02:36:27 +02:00
var moduleDepth int
var verbose bool
var drawCycles bool
2014-09-25 02:36:27 +02:00
args = c.Meta.process(args, false)
2014-07-01 19:02:13 +02:00
cmdFlags := flag.NewFlagSet("graph", flag.ContinueOnError)
c.addModuleDepthFlag(cmdFlags, &moduleDepth)
cmdFlags.BoolVar(&verbose, "verbose", false, "verbose")
cmdFlags.BoolVar(&drawCycles, "draw-cycles", false, "draw-cycles")
2014-07-01 19:02:13 +02:00
cmdFlags.Usage = func() { c.Ui.Error(c.Help()) }
if err := cmdFlags.Parse(args); err != nil {
return 1
}
2014-07-12 05:41:47 +02:00
var path string
2014-07-01 19:02:13 +02:00
args = cmdFlags.Args()
2014-07-12 05:41:47 +02:00
if len(args) > 1 {
2014-07-01 19:02:13 +02:00
c.Ui.Error("The graph command expects one argument.\n")
cmdFlags.Usage()
return 1
2014-07-12 05:41:47 +02:00
} 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))
}
2014-07-01 19:02:13 +02:00
}
ctx, _, err := c.Context(contextOpts{
Path: path,
StatePath: "",
})
2014-07-01 19:02:13 +02:00
if err != nil {
2014-07-13 04:25:50 +02:00
c.Ui.Error(fmt.Sprintf("Error loading Terraform: %s", err))
2014-07-01 19:02:13 +02:00
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,
})
2014-07-01 19:02:13 +02:00
if err != nil {
c.Ui.Error(fmt.Sprintf("Error creating graph: %s", err))
return 1
}
graphStr, err := terraform.GraphDot(g, &dag.DotOpts{
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)
2014-07-01 19:02:13 +02:00
return 0
}
func (c *GraphCommand) Help() string {
helpText := `
Usage: terraform graph [options] [DIR]
2014-07-01 19:02:13 +02:00
Outputs the visual dependency graph of Terraform resources according to
configuration files in DIR (or the current directory if omitted).
2014-07-01 19:02:13 +02:00
2014-07-12 05:38:03 +02:00
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.
2014-09-25 02:36:27 +02:00
Options:
-draw-cycles Highlight any cycles in the graph with colored edges.
This helps when diagnosing cycle errors.
2014-09-25 02:36:27 +02:00
-module-depth=n The maximum depth to expand modules. By default this is
-1, which will expand resources within all modules.
2014-09-25 02:36:27 +02:00
-verbose Generate a verbose, "worst-case" graph, with all nodes
for potential operations in place.
2015-06-22 14:14:01 +02:00
-no-color If specified, output won't contain any color.
2014-07-01 19:02:13 +02:00
`
return strings.TrimSpace(helpText)
}
func (c *GraphCommand) Synopsis() string {
2014-07-13 04:28:38 +02:00
return "Create a visual graph of Terraform resources"
2014-07-01 19:02:13 +02:00
}