Merge branch 'main' into feature/modularize-terragrunt

Author: james00012

modules/terragrunt/README.md

@@ -88,19 +88,17 @@ Work with standard terragrunt configurations (dependencies via `dependency` bloc
 - `ApplyAll(t, options)` - Apply all modules with dependencies
 - `DestroyAll(t, options)` - Destroy all modules with dependencies
 - `PlanAllExitCode(t, options)` - Plan all and return exit code (0=no changes, 2=changes)
-- `TgInit(t, options)` - Initialize configuration
+- `Init(t, options)` - Initialize configuration
 
 ### Stack Commands
 Work with `terragrunt.stack.hcl` configurations:
 
-- `TgStackGenerate(t, options)` - Generate stack from stack.hcl
-- `TgStackRun(t, options)` - Run command on generated stack
-- `TgStackClean(t, options)` - Remove .terragrunt-stack directory
-- `TgOutput(t, options, key)` - Get stack output value
-- `TgOutputJson(t, options, key)` - Get stack output as JSON
-- `TgOutputAll(t, options)` - Get all stack outputs as map
-
-> **Note**: Function naming is inconsistent - run-all commands lack the `Tg` prefix while stack commands have it. This is for historical reasons.
+- `StackGenerate(t, options)` - Generate stack from stack.hcl
+- `StackRun(t, options)` - Run command on generated stack
+- `StackClean(t, options)` - Remove .terragrunt-stack directory
+- `Output(t, options, key)` - Get stack output value
+- `OutputJson(t, options, key)` - Get stack output as JSON
+- `OutputAll(t, options)` - Get all stack outputs as map
 
 ## Examples
 
@@ -135,7 +133,7 @@ func TestWithCustomArgs(t *testing.T) {
         TerraformArgs:  []string{"-upgrade"},
     }
 
-    terragrunt.TgInit(t, options)
+    terragrunt.Init(t, options)
 }
 ```
 
@@ -153,11 +151,11 @@ func TestStackOutput(t *testing.T) {
     defer terragrunt.DestroyAll(t, options)
 
     // Get specific output
-    vpcID := terragrunt.TgOutput(t, options, "vpc_id")
+    vpcID := terragrunt.Output(t, options, "vpc_id")
     assert.NotEmpty(t, vpcID)
 
     // Get all outputs
-    outputs := terragrunt.TgOutputAll(t, options)
+    outputs := terragrunt.OutputAll(t, options)
     assert.Contains(t, outputs, "vpc_id")
 }
 ```

modules/terragrunt/cmd.go

@@ -10,7 +10,7 @@ import (
 	"github.com/gruntwork-io/terratest/modules/testing"
 )
 
-// runTerragruntStackCommandE executes tg stack commands
+// runTerragruntStackCommandE executes terragrunt stack commands
 // It handles argument construction, retry logic, and error handling for all stack commands
 func runTerragruntStackCommandE(
 	t testing.TestingT, opts *Options, subCommand string, additionalArgs ...string) (string, error) {

modules/terragrunt/cmd_args_test.go

@@ -25,7 +25,7 @@ func TestTerragruntArgsIncluded(t *testing.T) {
 	}
 
 	// Run init - if TerragruntArgs work, we should only see error-level logs
-	output, err := TgInitE(t, options)
+	output, err := InitE(t, options)
 	require.NoError(t, err)
 
 	// With --log-level error, we shouldn't see info-level messages
@@ -51,7 +51,7 @@ func TestTerraformArgsIncluded(t *testing.T) {
 	}
 
 	// Run init with -backend=false flag
-	output, err := TgInitE(t, options)
+	output, err := InitE(t, options)
 	require.NoError(t, err)
 
 	// With -backend=false, we should NOT see backend initialization messages
@@ -112,7 +112,7 @@ func TestCombinedArgsOrdering(t *testing.T) {
 	}
 
 	// Run init - both args should be passed in the correct order
-	output, err := TgInitE(t, options)
+	output, err := InitE(t, options)
 	require.NoError(t, err)
 
 	// Verify TerragruntArgs effect: should not see info-level logs
@@ -258,7 +258,7 @@ func TestEnvVarsPropagation(t *testing.T) {
 	}
 
 	// Run init - should succeed with env vars set
-	output, err := TgInitE(t, options)
+	output, err := InitE(t, options)
 	require.NoError(t, err)
 	require.NotEmpty(t, output)
 	// With TG_LOG_LEVEL=error, should not see info logs

modules/terragrunt/init.go

@@ -5,22 +5,22 @@ import (
 	"github.com/gruntwork-io/terratest/modules/testing"
 )
 
-// TgInit calls tg init and return stdout/stderr
-func TgInit(t testing.TestingT, options *Options) string {
-	out, err := TgInitE(t, options)
+// Init calls terragrunt init and return stdout/stderr
+func Init(t testing.TestingT, options *Options) string {
+	out, err := InitE(t, options)
 	if err != nil {
 		t.Fatal(err)
 	}
 	return out
 }
 
-// TgInitE calls tg init and return stdout/stderr
-func TgInitE(t testing.TestingT, options *Options) (string, error) {
-	// Use regular tg init command (not tg stack init)
+// InitE calls terragrunt init and return stdout/stderr
+func InitE(t testing.TestingT, options *Options) (string, error) {
+	// Use regular terragrunt init command (not terragrunt stack init)
 	return runTerragruntCommandE(t, options, "init", initArgs(options)...)
 }
 
-// initArgs builds the argument list for tg init command.
+// initArgs builds the argument list for terragrunt init command.
 // This function handles complex configuration that requires special formatting.
 func initArgs(options *Options) []string {
 	var args []string

modules/terragrunt/init_test.go

@@ -8,14 +8,14 @@ import (
 	"github.com/stretchr/testify/require"
 )
 
-func TestTgInit(t *testing.T) {
+func TestInit(t *testing.T) {
 	t.Parallel()
 
 	testFolder, err := files.CopyTerraformFolderToTemp(
 		"../../test/fixtures/terragrunt/terragrunt-no-error", t.Name())
 	require.NoError(t, err)
 
-	out, err := TgInitE(t, &Options{
+	out, err := InitE(t, &Options{
 		TerragruntDir:    testFolder,
 		TerragruntBinary: "terragrunt",
 		TerraformArgs:    []string{"-upgrade=true"}, // Common terraform init flag
@@ -24,15 +24,15 @@ func TestTgInit(t *testing.T) {
 	require.Contains(t, out, "Terraform has been successfully initialized!")
 }
 
-func TestTgInitWithInvalidConfig(t *testing.T) {
+func TestInitWithInvalidConfig(t *testing.T) {
 	t.Parallel()
 	// Test error handling when tg.hcl has invalid HCL syntax
 	testFolder, err := files.CopyTerraformFolderToTemp(
 		"../../test/fixtures/terragrunt/terragrunt-stack-init-error", t.Name())
 	require.NoError(t, err)
 
 	// This should fail due to invalid HCL syntax in tg.hcl
-	_, err = TgInitE(t, &Options{
+	_, err = InitE(t, &Options{
 		TerragruntDir:    testFolder,
 		TerragruntBinary: "terragrunt",
 		TerraformArgs:    []string{"-upgrade=true"}, // Common terraform init flag
@@ -42,8 +42,8 @@ func TestTgInitWithInvalidConfig(t *testing.T) {
 	require.Contains(t, err.Error(), "Missing expression")
 }
 
-// TestTgInitWithBothArgTypes verifies init works with both TerragruntArgs and TerraformArgs
-func TestTgInitWithBothArgTypes(t *testing.T) {
+// TestInitWithBothArgTypes verifies init works with both TerragruntArgs and TerraformArgs
+func TestInitWithBothArgTypes(t *testing.T) {
 	t.Parallel()
 
 	testFolder, err := files.CopyTerraformFolderToTemp(
@@ -57,7 +57,7 @@ func TestTgInitWithBothArgTypes(t *testing.T) {
 		TerraformArgs:    []string{"-upgrade"},
 	}
 
-	output, err := TgInitE(t, options)
+	output, err := InitE(t, options)
 	require.NoError(t, err)
 	// Verify TerragruntArgs: no info logs
 	require.NotContains(t, output, "level=info")

modules/terragrunt/options.go

@@ -17,7 +17,7 @@ import (
 // Example:
 //
 //	// For init with terraform flags
-//	TgInitE(t, &Options{
+//	InitE(t, &Options{
 //	    TerragruntDir: "/path/to/config",
 //	    TerragruntArgs: []string{"--log-level", "info"},
 //	    TerraformArgs: []string{"-upgrade=true"},

modules/terragrunt/plan_test.go

@@ -30,7 +30,7 @@ func TestTgPlanAllNoError(t *testing.T) {
 		t.Fatal(errExitCode)
 	}
 
-	// Since PlanAllExitCodeTgE returns error codes, we want to compare against 1
+	// Since PlanAllExitCodeE returns error codes, we want to compare against 1
 	require.Equal(t, 0, getExitCode)
 }
 
@@ -52,7 +52,7 @@ func TestTgPlanAllWithError(t *testing.T) {
 	require.Equal(t, 1, getExitCode)
 }
 
-func TestAssertTgPlanAllExitCodeNoError(t *testing.T) {
+func TestAssertPlanAllExitCodeNoError(t *testing.T) {
 	t.Parallel()
 
 	testFolder, err := files.CopyTerragruntFolderToTemp("../../test/fixtures/terragrunt/terragrunt-multi-plan", t.Name())
@@ -84,7 +84,7 @@ func TestAssertTgPlanAllExitCodeNoError(t *testing.T) {
 	assertPlanAllExitCode(t, getExitCode, true)
 }
 
-func TestAssertTgPlanAllExitCodeWithError(t *testing.T) {
+func TestAssertPlanAllExitCodeWithError(t *testing.T) {
 	t.Parallel()
 
 	testFolder, err := files.CopyTerragruntFolderToTemp("../../test/fixtures/terragrunt/terragrunt-with-plan-error", t.Name())

modules/terragrunt/stack_clean.go

@@ -4,18 +4,18 @@ import (
 	"github.com/gruntwork-io/terratest/modules/testing"
 )
 
-// TgStackClean calls tg stack clean to remove the .terragrunt-stack directory
+// StackClean calls terragrunt stack clean to remove the .terragrunt-stack directory
 // This command cleans up the generated stack files created by stack generate or stack run
-func TgStackClean(t testing.TestingT, options *Options) string {
-	out, err := TgStackCleanE(t, options)
+func StackClean(t testing.TestingT, options *Options) string {
+	out, err := StackCleanE(t, options)
 	if err != nil {
 		t.Fatal(err)
 	}
 	return out
 }
 
-// TgStackCleanE calls tg stack clean to remove the .terragrunt-stack directory
+// StackCleanE calls terragrunt stack clean to remove the .terragrunt-stack directory
 // This command cleans up the generated stack files created by stack generate or stack run
-func TgStackCleanE(t testing.TestingT, options *Options) (string, error) {
+func StackCleanE(t testing.TestingT, options *Options) (string, error) {
 	return runTerragruntStackCommandE(t, options, "clean")
 }

modules/terragrunt/stack_clean_test.go

@@ -8,7 +8,7 @@ import (
 	"github.com/stretchr/testify/require"
 )
 
-func TestTgStackClean(t *testing.T) {
+func TestStackClean(t *testing.T) {
 	t.Parallel()
 
 	testFolder, err := files.CopyTerraformFolderToTemp(
@@ -18,7 +18,7 @@ func TestTgStackClean(t *testing.T) {
 	stackDir := path.Join(testFolder, "live", ".terragrunt-stack")
 
 	// First generate the stack to create .terragrunt-stack directory
-	_, err = TgStackGenerateE(t, &Options{
+	_, err = StackGenerateE(t, &Options{
 		TerragruntDir:    path.Join(testFolder, "live"),
 		TerragruntBinary: "terragrunt",
 	})
@@ -28,7 +28,7 @@ func TestTgStackClean(t *testing.T) {
 	require.DirExists(t, stackDir)
 
 	// Clean the stack
-	out, err := TgStackCleanE(t, &Options{
+	out, err := StackCleanE(t, &Options{
 		TerragruntDir:    path.Join(testFolder, "live"),
 		TerragruntBinary: "terragrunt",
 	})
@@ -41,7 +41,7 @@ func TestTgStackClean(t *testing.T) {
 	require.NoDirExists(t, stackDir)
 }
 
-func TestTgStackCleanNonExistentStack(t *testing.T) {
+func TestStackCleanNonExistentStack(t *testing.T) {
 	t.Parallel()
 
 	testFolder, err := files.CopyTerraformFolderToTemp(
@@ -54,14 +54,14 @@ func TestTgStackCleanNonExistentStack(t *testing.T) {
 	require.NoDirExists(t, stackDir)
 
 	// Clean should succeed even if .terragrunt-stack doesn't exist
-	_, err = TgStackCleanE(t, &Options{
+	_, err = StackCleanE(t, &Options{
 		TerragruntDir:    path.Join(testFolder, "live"),
 		TerragruntBinary: "terragrunt",
 	})
 	require.NoError(t, err)
 }
 
-func TestTgStackCleanAfterRun(t *testing.T) {
+func TestStackCleanAfterRun(t *testing.T) {
 	t.Parallel()
 
 	testFolder, err := files.CopyTerraformFolderToTemp(
@@ -71,15 +71,15 @@ func TestTgStackCleanAfterRun(t *testing.T) {
 	stackDir := path.Join(testFolder, "live", ".terragrunt-stack")
 
 	// Initialize the stack
-	_, err = TgInitE(t, &Options{
+	_, err = InitE(t, &Options{
 		TerragruntDir:    path.Join(testFolder, "live"),
 		TerragruntBinary: "terragrunt",
 		TerraformArgs:    []string{"-upgrade=true"},
 	})
 	require.NoError(t, err)
 
 	// Run plan to generate the stack
-	_, err = TgStackRunE(t, &Options{
+	_, err = StackRunE(t, &Options{
 		TerragruntDir:    path.Join(testFolder, "live"),
 		TerragruntBinary: "terragrunt",
 		TerraformArgs:    []string{"plan"},
@@ -90,7 +90,7 @@ func TestTgStackCleanAfterRun(t *testing.T) {
 	require.DirExists(t, stackDir)
 
 	// Clean the stack
-	out, err := TgStackCleanE(t, &Options{
+	out, err := StackCleanE(t, &Options{
 		TerragruntDir:    path.Join(testFolder, "live"),
 		TerragruntBinary: "terragrunt",
 	})

modules/terragrunt/stack_generate.go

@@ -4,16 +4,16 @@ import (
 	"github.com/gruntwork-io/terratest/modules/testing"
 )
 
-// TgStackGenerate calls tg stack generate and returns stdout/stderr
-func TgStackGenerate(t testing.TestingT, options *Options) string {
-	out, err := TgStackGenerateE(t, options)
+// StackGenerate calls terragrunt stack generate and returns stdout/stderr
+func StackGenerate(t testing.TestingT, options *Options) string {
+	out, err := StackGenerateE(t, options)
 	if err != nil {
 		t.Fatal(err)
 	}
 	return out
 }
 
-// TgStackGenerateE calls tg stack generate and returns stdout/stderr
-func TgStackGenerateE(t testing.TestingT, options *Options) (string, error) {
+// StackGenerateE calls terragrunt stack generate and returns stdout/stderr
+func StackGenerateE(t testing.TestingT, options *Options) (string, error) {
 	return runTerragruntStackCommandE(t, options, "generate")
 }