mirror of
https://github.com/opentffoundation/opentf.git
synced 2025-12-19 17:59:05 -05:00
101 lines
3.0 KiB
Go
101 lines
3.0 KiB
Go
// Copyright (c) The OpenTofu Authors
|
|
// SPDX-License-Identifier: MPL-2.0
|
|
// Copyright (c) 2023 HashiCorp, Inc.
|
|
// SPDX-License-Identifier: MPL-2.0
|
|
|
|
package arguments
|
|
|
|
import (
|
|
"github.com/opentofu/opentofu/internal/tfdiags"
|
|
)
|
|
|
|
// Plan represents the command-line arguments for the plan command.
|
|
type Plan struct {
|
|
// State, Operation, and Vars are the common extended flags
|
|
State *State
|
|
Operation *Operation
|
|
Vars *Vars
|
|
|
|
// DetailedExitCode enables different exit codes for error, success with
|
|
// changes, and success with no changes.
|
|
DetailedExitCode bool
|
|
|
|
// InputEnabled is used to disable interactive input for unspecified
|
|
// variable and backend config values. Default is true.
|
|
InputEnabled bool
|
|
|
|
// OutPath contains an optional path to store the plan file
|
|
OutPath string
|
|
|
|
// GenerateConfigPath tells OpenTofu that config should be generated for
|
|
// unmatched import target paths and which path the generated file should
|
|
// be written to.
|
|
GenerateConfigPath string
|
|
|
|
// ViewType specifies which output format to use
|
|
ViewType ViewType
|
|
|
|
// ShowSensitive is used to display the value of variables marked as sensitive.
|
|
ShowSensitive bool
|
|
|
|
// ModuleDeprecationWarnLevel stores the level that will be used for selecting what deprecation warnings to show.
|
|
ModuleDeprecationWarnLevel string
|
|
}
|
|
|
|
// ParsePlan processes CLI arguments, returning a Plan value and errors.
|
|
// If errors are encountered, a Plan value is still returned representing
|
|
// the best effort interpretation of the arguments.
|
|
func ParsePlan(args []string) (*Plan, tfdiags.Diagnostics) {
|
|
var diags tfdiags.Diagnostics
|
|
plan := &Plan{
|
|
State: &State{},
|
|
Operation: &Operation{},
|
|
Vars: &Vars{},
|
|
}
|
|
|
|
cmdFlags := extendedFlagSet("plan", plan.State, plan.Operation, plan.Vars)
|
|
cmdFlags.BoolVar(&plan.DetailedExitCode, "detailed-exitcode", false, "detailed-exitcode")
|
|
cmdFlags.BoolVar(&plan.InputEnabled, "input", true, "input")
|
|
cmdFlags.StringVar(&plan.OutPath, "out", "", "out")
|
|
cmdFlags.StringVar(&plan.GenerateConfigPath, "generate-config-out", "", "generate-config-out")
|
|
cmdFlags.BoolVar(&plan.ShowSensitive, "show-sensitive", false, "displays sensitive values")
|
|
cmdFlags.StringVar(&plan.ModuleDeprecationWarnLevel, "deprecation", "", "control the level of deprecation warnings")
|
|
|
|
var json bool
|
|
cmdFlags.BoolVar(&json, "json", false, "json")
|
|
|
|
if err := cmdFlags.Parse(args); err != nil {
|
|
diags = diags.Append(tfdiags.Sourceless(
|
|
tfdiags.Error,
|
|
"Failed to parse command-line flags",
|
|
err.Error(),
|
|
))
|
|
}
|
|
|
|
args = cmdFlags.Args()
|
|
|
|
if len(args) > 0 {
|
|
diags = diags.Append(tfdiags.Sourceless(
|
|
tfdiags.Error,
|
|
"Too many command line arguments",
|
|
"To specify a working directory for the plan, use the global -chdir flag.",
|
|
))
|
|
}
|
|
|
|
diags = diags.Append(plan.Operation.Parse())
|
|
|
|
// JSON view currently does not support input, so we disable it here
|
|
if json {
|
|
plan.InputEnabled = false
|
|
}
|
|
|
|
switch {
|
|
case json:
|
|
plan.ViewType = ViewJSON
|
|
default:
|
|
plan.ViewType = ViewHuman
|
|
}
|
|
|
|
return plan, diags
|
|
}
|