Merge pull request #1633 from gruntwork-io/fix/terragrunt-cli-redesign

james00012 · web-flow · commit 861ec5b841e4 · 2025-12-03T10:05:50.000-05:00
Upgrade Go to 1.24.0 and update terragrunt module for CLI redesign
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -10,7 +10,7 @@ env: &env
     TERRAGRUNT_VERSION: v0.80.4
     TERRAGRUNT_TEST_VERSION: v0.93.10  # Version used for terragrunt module tests
     OPA_VERSION: v1.1.0
-    GO_VERSION: 1.21.1
+    GO_VERSION: 1.24.0
     GO111MODULE: auto
     K8S_VERSION: v1.20.0  # Same as EKS
     MINIKUBE_VERSION: v1.22.0
diff --git a/modules/terraform/apply.go b/modules/terraform/apply.go
@@ -49,14 +49,14 @@ func ApplyE(t testing.TestingT, options *Options) (string, error) {
 	return RunTerraformCommandE(t, options, FormatArgs(options, prepend(options.ExtraArgs.Apply, "apply", "-input=false", "-auto-approve")...)...)
 }
 
-// TgApplyAllE runs terragrunt apply-all with the given options and return stdout/stderr. Note that this method does NOT call destroy and
+// TgApplyAllE runs terragrunt apply --all with the given options and return stdout/stderr. Note that this method does NOT call destroy and
 // assumes the caller is responsible for cleaning up any resources created by running apply.
 func TgApplyAllE(t testing.TestingT, options *Options) (string, error) {
 	if options.TerraformBinary != "terragrunt" {
 		return "", TgInvalidBinary(options.TerraformBinary)
 	}
 
-	return RunTerraformCommandE(t, options, FormatArgs(options, prepend(options.ExtraArgs.Apply, "run-all", "apply", "-input=false", "-auto-approve")...)...)
+	return RunTerraformCommandE(t, options, FormatArgs(options, prepend(options.ExtraArgs.Apply, "apply", "--all", "-input=false", "-auto-approve")...)...)
 }
 
 // ApplyAndIdempotent runs terraform apply with the given options and return stdout/stderr from the apply command. It then runs
diff --git a/modules/terraform/cmd.go b/modules/terraform/cmd.go
@@ -31,7 +31,6 @@ var commandsWithParallelism = []string{
 	"apply",
 	"destroy",
 	"plan-all",
-	"run-all",
 	"apply-all",
 	"destroy-all",
 }
@@ -55,17 +54,18 @@ func GetCommonOptions(options *Options, args ...string) (*Options, []string) {
 		options.TerraformBinary = DefaultExecutable
 	}
 
+	if options.Parallelism > 0 && len(args) > 0 && collections.ListContains(commandsWithParallelism, args[0]) {
+		args = append(args, fmt.Sprintf("--parallelism=%d", options.Parallelism))
+	}
+
 	if options.TerraformBinary == TerragruntDefaultPath {
-		args = append(args, "--terragrunt-non-interactive")
+		// Prepend --non-interactive as a global flag (must come before subcommand)
+		args = append([]string{"--non-interactive"}, args...)
 
 		// for newer Terragrunt version, setting simplified log formatting
 		setTerragruntLogFormatting(options)
 	}
 
-	if options.Parallelism > 0 && len(args) > 0 && collections.ListContains(commandsWithParallelism, args[0]) {
-		args = append(args, fmt.Sprintf("--parallelism=%d", options.Parallelism))
-	}
-
 	// if SshAgent is provided, override the local SSH agent with the socket of our in-process agent
 	if options.SshAgent != nil {
 		// Initialize EnvVars, if it hasn't been set yet
@@ -217,8 +217,8 @@ func hasWarning(opts *Options, out string) error {
 // if it is not already set in options.EnvVars or OS environment vars
 func setTerragruntLogFormatting(options *Options) {
 	const (
-		tgLogFormatKey       = "TERRAGRUNT_LOG_FORMAT"
-		tgLogCustomFormatKey = "TERRAGRUNT_LOG_CUSTOM_FORMAT"
+		tgLogFormatKey       = "TG_LOG_FORMAT"
+		tgLogCustomFormatKey = "TG_LOG_CUSTOM_FORMAT"
 	)
 
 	if options.EnvVars == nil {
diff --git a/modules/terraform/destroy.go b/modules/terraform/destroy.go
@@ -24,11 +24,11 @@ func DestroyE(t testing.TestingT, options *Options) (string, error) {
 	return RunTerraformCommandE(t, options, FormatArgs(options, prepend(options.ExtraArgs.Destroy, "destroy", "-auto-approve", "-input=false")...)...)
 }
 
-// TgDestroyAllE runs terragrunt destroy with the given options and return stdout.
+// TgDestroyAllE runs terragrunt destroy --all with the given options and return stdout.
 func TgDestroyAllE(t testing.TestingT, options *Options) (string, error) {
 	if options.TerraformBinary != "terragrunt" {
 		return "", TgInvalidBinary(options.TerraformBinary)
 	}
 
-	return RunTerraformCommandE(t, options, FormatArgs(options, prepend(options.ExtraArgs.Destroy, "run-all", "destroy", "-auto-approve", "-input=false")...)...)
+	return RunTerraformCommandE(t, options, FormatArgs(options, prepend(options.ExtraArgs.Destroy, "destroy", "--all", "-auto-approve", "-input=false")...)...)
 }
diff --git a/modules/terraform/format.go b/modules/terraform/format.go
@@ -10,8 +10,6 @@ import (
 	"github.com/gruntwork-io/terratest/modules/collections"
 )
 
-const runAllCmd = "run-all"
-
 // TerraformCommandsWithLockSupport is a list of all the Terraform commands that
 // can obtain locks on Terraform state
 var TerraformCommandsWithLockSupport = []string{
@@ -42,12 +40,6 @@ var TerraformCommandsWithPlanFileSupport = []string{
 func FormatArgs(options *Options, args ...string) []string {
 	var terraformArgs []string
 	commandType := args[0]
-	// If the user is trying to run with run-all, then we need to make sure the command based args are based on the
-	// actual terraform command. E.g., we want to base the logic on `plan` when `run-all plan` is passed in, not
-	// `run-all`.
-	if commandType == runAllCmd {
-		commandType = args[1]
-	}
 	lockSupported := collections.ListContains(TerraformCommandsWithLockSupport, commandType)
 	planFileSupported := collections.ListContains(TerraformCommandsWithPlanFileSupport, commandType)
 
diff --git a/modules/terraform/format_test.go b/modules/terraform/format_test.go
@@ -99,8 +99,8 @@ func TestFormatArgsAppliesLockCorrectly(t *testing.T) {
 		{[]string{"plan"}, []string{"plan", "-lock=false"}},
 		{[]string{"validate"}, []string{"validate"}},
 		{[]string{"plan-all"}, []string{"plan-all", "-lock=false"}},
-		{[]string{"run-all", "validate"}, []string{"run-all", "validate"}},
-		{[]string{"run-all", "plan"}, []string{"run-all", "plan", "-lock=false"}},
+		{[]string{"validate", "--all"}, []string{"validate", "--all"}},
+		{[]string{"plan", "--all"}, []string{"plan", "--all", "-lock=false"}},
 	}
 
 	for _, testCase := range testCases {
diff --git a/modules/terraform/options_test.go b/modules/terraform/options_test.go
@@ -78,7 +78,7 @@ func TestExtraArgsHelp(t *testing.T) {
 			},
 		},
 		{
-			name: "validate-inputs",
+			name: "hcl validate",
 			fn: func() (string, error) {
 				return ValidateInputsE(t, &Options{
 					ExtraArgs: ExtraArgs{ValidateInputs: []string{"-help"}}, TerraformBinary: "terragrunt"})
diff --git a/modules/terraform/plan.go b/modules/terraform/plan.go
@@ -134,17 +134,17 @@ func TgPlanAllExitCode(t testing.TestingT, options *Options) int {
 	return exitCode
 }
 
-// TgPlanAllExitCodeE runs terragrunt plan-all with the given options and returns the detailed exitcode.
+// TgPlanAllExitCodeE runs terragrunt plan --all with the given options and returns the detailed exitcode.
 func TgPlanAllExitCodeE(t testing.TestingT, options *Options) (int, error) {
 	if options.TerraformBinary != "terragrunt" {
 		return 1, fmt.Errorf("terragrunt must be set as TerraformBinary to use this method")
 	}
 
-	return GetExitCodeForTerraformCommandE(t, options, FormatArgs(options, prepend(options.ExtraArgs.Plan, "run-all", "plan", "--input=false",
+	return GetExitCodeForTerraformCommandE(t, options, FormatArgs(options, prepend(options.ExtraArgs.Plan, "plan", "--all", "--input=false",
 		"--lock=true", "--detailed-exitcode")...)...)
 }
 
-// AssertTgPlanAllExitCode asserts the succuess (or failure) of a terragrunt run-all plan.
+// AssertTgPlanAllExitCode asserts the success (or failure) of a terragrunt plan --all.
 // On success, terragrunt will exit 0 on a plan that has previously been applied (has state)
 // and exit with 2 for plans that have never been applied when ran with `-detailed-exitcode`.
 func AssertTgPlanAllExitCode(t testing.TestingT, exitCode int, assertTrue bool) {
diff --git a/modules/terraform/validate.go b/modules/terraform/validate.go
@@ -12,7 +12,7 @@ func Validate(t testing.TestingT, options *Options) string {
 	return out
 }
 
-// ValidateInputs calls terragrunt validate and returns stdout/stderr.
+// ValidateInputs calls terragrunt hcl validate and returns stdout/stderr.
 func ValidateInputs(t testing.TestingT, options *Options) string {
 	out, err := ValidateInputsE(t, options)
 	require.NoError(t, err)
@@ -24,12 +24,12 @@ func ValidateE(t testing.TestingT, options *Options) (string, error) {
 	return RunTerraformCommandE(t, options, FormatArgs(options, prepend(options.ExtraArgs.Validate, "validate")...)...)
 }
 
-// ValidateInputsE calls terragrunt validate-inputs and returns stdout/stderr
+// ValidateInputsE calls terragrunt hcl validate and returns stdout/stderr
 func ValidateInputsE(t testing.TestingT, options *Options) (string, error) {
 	if options.TerraformBinary != "terragrunt" {
 		return "", TgInvalidBinary(options.TerraformBinary)
 	}
-	return RunTerraformCommandE(t, options, FormatArgs(options, prepend(options.ExtraArgs.ValidateInputs, "validate-inputs")...)...)
+	return RunTerraformCommandE(t, options, FormatArgs(options, prepend(options.ExtraArgs.ValidateInputs, "hcl", "validate")...)...)
 }
 
 // InitAndValidate runs terraform init and validate with the given options and returns stdout/stderr from the validate command.
@@ -40,7 +40,7 @@ func InitAndValidate(t testing.TestingT, options *Options) string {
 	return out
 }
 
-// InitAndValidateInputs runs terragrunt init and validate-inputs with the given options and returns stdout/stderr from the validate command.
+// InitAndValidateInputs runs terragrunt init and hcl validate with the given options and returns stdout/stderr from the validate command.
 func InitAndValidateInputs(t testing.TestingT, options *Options) string {
 	out, err := InitAndValidateInputsE(t, options)
 	require.NoError(t, err)
@@ -56,7 +56,7 @@ func InitAndValidateE(t testing.TestingT, options *Options) (string, error) {
 	return ValidateE(t, options)
 }
 
-// InitAndValidateInputsE runs terragrunt init and validate with the given options and returns stdout/stderr
+// InitAndValidateInputsE runs terragrunt init and hcl validate with the given options and returns stdout/stderr
 func InitAndValidateInputsE(t testing.TestingT, options *Options) (string, error) {
 	if _, err := InitE(t, options); err != nil {
 		return "", err
diff --git a/modules/test-structure/test_structure.go b/modules/test-structure/test_structure.go
@@ -157,7 +157,7 @@ func ValidateAllTerraformModules(t *go_test.T, opts *ValidationOptions) {
 				tfOpts.TerraformBinary = "terragrunt"
 				// First call init and terraform validate
 				terraform.InitAndValidate(t, tfOpts)
-				// Next, call terragrunt validate-inputs which will catch mis-aligned inputs provided via Terragrunt
+				// Next, call terragrunt hcl validate which will catch mis-aligned inputs provided via Terragrunt
 				terraform.ValidateInputs(t, tfOpts)
 			} else if fileType == TF {
 				terraform.InitAndValidate(t, tfOpts)
diff --git a/modules/test-structure/validate_struct.go b/modules/test-structure/validate_struct.go
@@ -166,7 +166,7 @@ func FindTerraformModulePathsInRootE(opts *ValidationOptions) ([]string, error)
 	terraformDirSet := make(map[string]string)
 	for _, match := range matches {
 		// The glob match returns all full paths to every target file, whereas we're only interested in their root
-		// directories for the purposes of running Terraform validate / terragrunt validate-inputs
+		// directories for the purposes of running Terraform validate / terragrunt hcl validate
 		rootDir := path.Dir(match)
 		// Don't include hidden .terraform directories when finding paths to validate
 		if !files.PathContainsHiddenFileOrFolder(rootDir) {
diff --git a/test/terragrunt_example_test.go b/test/terragrunt_example_test.go
@@ -42,7 +42,7 @@ func TestTerragruntConsole(t *testing.T) {
 	// website::tag::6:: Clean up resources with "terragrunt destroy" at the end of the test.
 	defer terraform.Destroy(t, terraformOptions)
 
-	// website::tag::4:: Run "terragrunt console".
-	out := terraform.RunTerraformCommand(t, terraformOptions, "console")
+	// website::tag::4:: Run "terragrunt run -- console".
+	out := terraform.RunTerraformCommand(t, terraformOptions, "run", "--", "console")
 	assert.Contains(t, out, `"local variable named mylocal"`)
 }

Original file line number	Diff line number	Diff line change
`@@ -49,14 +49,14 @@ func ApplyE(t testing.TestingT, options *Options) (string, error) {`
`49`	`49`	`return RunTerraformCommandE(t, options, FormatArgs(options, prepend(options.ExtraArgs.Apply, "apply", "-input=false", "-auto-approve")...)...)`
`50`	`50`	`}`
`51`	`51`
`52`		`-// TgApplyAllE runs terragrunt apply-all with the given options and return stdout/stderr. Note that this method does NOT call destroy and`
	`52`	`+// TgApplyAllE runs terragrunt apply --all with the given options and return stdout/stderr. Note that this method does NOT call destroy and`
`53`	`53`	`// assumes the caller is responsible for cleaning up any resources created by running apply.`
`54`	`54`	`func TgApplyAllE(t testing.TestingT, options *Options) (string, error) {`
`55`	`55`	`if options.TerraformBinary != "terragrunt" {`
`56`	`56`	`return "", TgInvalidBinary(options.TerraformBinary)`
`57`	`57`	`}`
`58`	`58`
`59`		`- return RunTerraformCommandE(t, options, FormatArgs(options, prepend(options.ExtraArgs.Apply, "run-all", "apply", "-input=false", "-auto-approve")...)...)`
	`59`	`+ return RunTerraformCommandE(t, options, FormatArgs(options, prepend(options.ExtraArgs.Apply, "apply", "--all", "-input=false", "-auto-approve")...)...)`
`60`	`60`	`}`
`61`	`61`
`62`	`62`	`// ApplyAndIdempotent runs terraform apply with the given options and return stdout/stderr from the apply command. It then runs`
Original file line number	Diff line number	Diff line change
`@@ -24,11 +24,11 @@ func DestroyE(t testing.TestingT, options *Options) (string, error) {`
`24`	`24`	`return RunTerraformCommandE(t, options, FormatArgs(options, prepend(options.ExtraArgs.Destroy, "destroy", "-auto-approve", "-input=false")...)...)`
`25`	`25`	`}`
`26`	`26`
`27`		`-// TgDestroyAllE runs terragrunt destroy with the given options and return stdout.`
	`27`	`+// TgDestroyAllE runs terragrunt destroy --all with the given options and return stdout.`
`28`	`28`	`func TgDestroyAllE(t testing.TestingT, options *Options) (string, error) {`
`29`	`29`	`if options.TerraformBinary != "terragrunt" {`
`30`	`30`	`return "", TgInvalidBinary(options.TerraformBinary)`
`31`	`31`	`}`
`32`	`32`
`33`		`- return RunTerraformCommandE(t, options, FormatArgs(options, prepend(options.ExtraArgs.Destroy, "run-all", "destroy", "-auto-approve", "-input=false")...)...)`
	`33`	`+ return RunTerraformCommandE(t, options, FormatArgs(options, prepend(options.ExtraArgs.Destroy, "destroy", "--all", "-auto-approve", "-input=false")...)...)`
`34`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -78,7 +78,7 @@ func TestExtraArgsHelp(t *testing.T) {`
`78`	`78`	`},`
`79`	`79`	`},`
`80`	`80`	`{`
`81`		`- name: "validate-inputs",`
	`81`	`+ name: "hcl validate",`
`82`	`82`	`fn: func() (string, error) {`
`83`	`83`	`return ValidateInputsE(t, &Options{`
`84`	`84`	`ExtraArgs: ExtraArgs{ValidateInputs: []string{"-help"}}, TerraformBinary: "terragrunt"})`
Original file line number	Diff line number	Diff line change
`@@ -134,17 +134,17 @@ func TgPlanAllExitCode(t testing.TestingT, options *Options) int {`
`134`	`134`	`return exitCode`
`135`	`135`	`}`
`136`	`136`
`137`		`-// TgPlanAllExitCodeE runs terragrunt plan-all with the given options and returns the detailed exitcode.`
	`137`	`+// TgPlanAllExitCodeE runs terragrunt plan --all with the given options and returns the detailed exitcode.`
`138`	`138`	`func TgPlanAllExitCodeE(t testing.TestingT, options *Options) (int, error) {`
`139`	`139`	`if options.TerraformBinary != "terragrunt" {`
`140`	`140`	`return 1, fmt.Errorf("terragrunt must be set as TerraformBinary to use this method")`
`141`	`141`	`}`
`142`	`142`
`143`		`- return GetExitCodeForTerraformCommandE(t, options, FormatArgs(options, prepend(options.ExtraArgs.Plan, "run-all", "plan", "--input=false",`
	`143`	`+ return GetExitCodeForTerraformCommandE(t, options, FormatArgs(options, prepend(options.ExtraArgs.Plan, "plan", "--all", "--input=false",`
`144`	`144`	`"--lock=true", "--detailed-exitcode")...)...)`
`145`	`145`	`}`
`146`	`146`
`147`		`-// AssertTgPlanAllExitCode asserts the succuess (or failure) of a terragrunt run-all plan.`
	`147`	`+// AssertTgPlanAllExitCode asserts the success (or failure) of a terragrunt plan --all.`
`148`	`148`	`// On success, terragrunt will exit 0 on a plan that has previously been applied (has state)`
`149`	`149`	// and exit with 2 for plans that have never been applied when ran with `-detailed-exitcode`.
`150`	`150`	`func AssertTgPlanAllExitCode(t testing.TestingT, exitCode int, assertTrue bool) {`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ func Validate(t testing.TestingT, options *Options) string {`
`12`	`12`	`return out`
`13`	`13`	`}`
`14`	`14`
`15`		`-// ValidateInputs calls terragrunt validate and returns stdout/stderr.`
	`15`	`+// ValidateInputs calls terragrunt hcl validate and returns stdout/stderr.`
`16`	`16`	`func ValidateInputs(t testing.TestingT, options *Options) string {`
`17`	`17`	`out, err := ValidateInputsE(t, options)`
`18`	`18`	`require.NoError(t, err)`
`@@ -24,12 +24,12 @@ func ValidateE(t testing.TestingT, options *Options) (string, error) {`
`24`	`24`	`return RunTerraformCommandE(t, options, FormatArgs(options, prepend(options.ExtraArgs.Validate, "validate")...)...)`
`25`	`25`	`}`
`26`	`26`
`27`		`-// ValidateInputsE calls terragrunt validate-inputs and returns stdout/stderr`
	`27`	`+// ValidateInputsE calls terragrunt hcl validate and returns stdout/stderr`
`28`	`28`	`func ValidateInputsE(t testing.TestingT, options *Options) (string, error) {`
`29`	`29`	`if options.TerraformBinary != "terragrunt" {`
`30`	`30`	`return "", TgInvalidBinary(options.TerraformBinary)`
`31`	`31`	`}`
`32`		`- return RunTerraformCommandE(t, options, FormatArgs(options, prepend(options.ExtraArgs.ValidateInputs, "validate-inputs")...)...)`
	`32`	`+ return RunTerraformCommandE(t, options, FormatArgs(options, prepend(options.ExtraArgs.ValidateInputs, "hcl", "validate")...)...)`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`// InitAndValidate runs terraform init and validate with the given options and returns stdout/stderr from the validate command.`
`@@ -40,7 +40,7 @@ func InitAndValidate(t testing.TestingT, options *Options) string {`
`40`	`40`	`return out`
`41`	`41`	`}`
`42`	`42`
`43`		`-// InitAndValidateInputs runs terragrunt init and validate-inputs with the given options and returns stdout/stderr from the validate command.`
	`43`	`+// InitAndValidateInputs runs terragrunt init and hcl validate with the given options and returns stdout/stderr from the validate command.`
`44`	`44`	`func InitAndValidateInputs(t testing.TestingT, options *Options) string {`
`45`	`45`	`out, err := InitAndValidateInputsE(t, options)`
`46`	`46`	`require.NoError(t, err)`
`@@ -56,7 +56,7 @@ func InitAndValidateE(t testing.TestingT, options *Options) (string, error) {`
`56`	`56`	`return ValidateE(t, options)`
`57`	`57`	`}`
`58`	`58`
`59`		`-// InitAndValidateInputsE runs terragrunt init and validate with the given options and returns stdout/stderr`
	`59`	`+// InitAndValidateInputsE runs terragrunt init and hcl validate with the given options and returns stdout/stderr`
`60`	`60`	`func InitAndValidateInputsE(t testing.TestingT, options *Options) (string, error) {`
`61`	`61`	`if _, err := InitE(t, options); err != nil {`
`62`	`62`	`return "", err`