mirror of
https://github.com/opentofu/opentofu.git
synced 2025-01-01 11:47:07 -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.
144 lines
3.1 KiB
Go
144 lines
3.1 KiB
Go
package command
|
|
|
|
import (
|
|
"fmt"
|
|
"path/filepath"
|
|
"strings"
|
|
|
|
"github.com/hashicorp/terraform/tfdiags"
|
|
|
|
"github.com/hashicorp/terraform/config"
|
|
"github.com/hashicorp/terraform/terraform"
|
|
)
|
|
|
|
// ValidateCommand is a Command implementation that validates the terraform files
|
|
type ValidateCommand struct {
|
|
Meta
|
|
}
|
|
|
|
const defaultPath = "."
|
|
|
|
func (c *ValidateCommand) Run(args []string) int {
|
|
args, err := c.Meta.process(args, true)
|
|
if err != nil {
|
|
return 1
|
|
}
|
|
var checkVars bool
|
|
|
|
cmdFlags := c.Meta.flagSet("validate")
|
|
cmdFlags.BoolVar(&checkVars, "check-variables", true, "check-variables")
|
|
cmdFlags.Usage = func() {
|
|
c.Ui.Error(c.Help())
|
|
}
|
|
if err := cmdFlags.Parse(args); err != nil {
|
|
return 1
|
|
}
|
|
|
|
args = cmdFlags.Args()
|
|
|
|
var dirPath string
|
|
if len(args) == 1 {
|
|
dirPath = args[0]
|
|
} else {
|
|
dirPath = "."
|
|
}
|
|
dir, err := filepath.Abs(dirPath)
|
|
if err != nil {
|
|
c.Ui.Error(fmt.Sprintf(
|
|
"Unable to locate directory %v\n", err.Error()))
|
|
}
|
|
|
|
// Check for user-supplied plugin path
|
|
if c.pluginPath, err = c.loadPluginPath(); err != nil {
|
|
c.Ui.Error(fmt.Sprintf("Error loading plugin path: %s", err))
|
|
return 1
|
|
}
|
|
|
|
rtnCode := c.validate(dir, checkVars)
|
|
|
|
return rtnCode
|
|
}
|
|
|
|
func (c *ValidateCommand) Synopsis() string {
|
|
return "Validates the Terraform files"
|
|
}
|
|
|
|
func (c *ValidateCommand) Help() string {
|
|
helpText := `
|
|
Usage: terraform validate [options] [dir]
|
|
|
|
Validate the terraform files in a directory. Validation includes a
|
|
basic check of syntax as well as checking that all variables declared
|
|
in the configuration are specified in one of the possible ways:
|
|
|
|
-var foo=...
|
|
-var-file=foo.vars
|
|
TF_VAR_foo environment variable
|
|
terraform.tfvars
|
|
default value
|
|
|
|
If dir is not specified, then the current directory will be used.
|
|
|
|
Options:
|
|
|
|
-check-variables=true If set to true (default), the command will check
|
|
whether all required variables have been specified.
|
|
|
|
-no-color If specified, output won't contain any color.
|
|
|
|
-var 'foo=bar' Set a variable in the Terraform configuration. This
|
|
flag can be set multiple times.
|
|
|
|
-var-file=foo Set variables in the Terraform configuration from
|
|
a file. If "terraform.tfvars" is present, it will be
|
|
automatically loaded if this flag is not specified.
|
|
`
|
|
return strings.TrimSpace(helpText)
|
|
}
|
|
|
|
func (c *ValidateCommand) validate(dir string, checkVars bool) int {
|
|
var diags tfdiags.Diagnostics
|
|
|
|
cfg, err := config.LoadDir(dir)
|
|
if err != nil {
|
|
diags = diags.Append(err)
|
|
c.showDiagnostics(err)
|
|
return 1
|
|
}
|
|
|
|
diags = diags.Append(cfg.Validate())
|
|
|
|
if diags.HasErrors() {
|
|
c.showDiagnostics(diags)
|
|
return 1
|
|
}
|
|
|
|
if checkVars {
|
|
mod, modDiags := c.Module(dir)
|
|
diags = diags.Append(modDiags)
|
|
if modDiags.HasErrors() {
|
|
c.showDiagnostics(diags)
|
|
return 1
|
|
}
|
|
|
|
opts := c.contextOpts()
|
|
opts.Module = mod
|
|
|
|
tfCtx, err := terraform.NewContext(opts)
|
|
if err != nil {
|
|
diags = diags.Append(err)
|
|
c.showDiagnostics(diags)
|
|
return 1
|
|
}
|
|
|
|
diags = diags.Append(tfCtx.Validate())
|
|
}
|
|
|
|
c.showDiagnostics(diags)
|
|
if diags.HasErrors() {
|
|
return 1
|
|
}
|
|
|
|
return 0
|
|
}
|