Merge pull request #1627 from gruntwork-io/update-terragrunt-test-version

Upgrade terragrunt module tests to v0.93.10

Author: james00012

.circleci/config.yml

@@ -8,6 +8,7 @@ env: &env
     TOFU_VERSION: 1.8.0
     PACKER_VERSION: 1.10.0
     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
     GO111MODULE: auto
@@ -80,6 +81,15 @@ install_tofu: &install_tofu
     rm -rf tofu.zip
     tofu --version
 
+install_terragrunt_latest: &install_terragrunt_latest
+  name: Install Terragrunt (latest test version)
+  command: |
+    echo "Installing Terragrunt ${TERRAGRUNT_TEST_VERSION}..."
+    curl -sL "https://github.com/gruntwork-io/terragrunt/releases/download/${TERRAGRUNT_TEST_VERSION}/terragrunt_linux_amd64" -o /tmp/terragrunt
+    chmod +x /tmp/terragrunt
+    sudo mv /tmp/terragrunt /usr/local/bin/terragrunt
+    terragrunt --version
+
 install_docker_buildx: &install_docker_buildx
   name: install docker buildx
   command: |
@@ -177,7 +187,7 @@ jobs:
             - project
 
   # run tests with terraform binary
-  test_terraform:
+  terraform_test:
     <<: *defaults
     resource_class: xlarge
     steps:
@@ -218,7 +228,7 @@ jobs:
           path: /tmp/logs
 
   # run tests with tofu binary
-  test_tofu:
+  terraform_test_tofu:
     <<: *defaults
     resource_class: large
     steps:
@@ -243,10 +253,13 @@ jobs:
       # to kill the build after more than 10 minutes without log output.
       # NOTE: because this doesn't build with the kubernetes tag, it will not run the kubernetes tests. See
       # kubernetes_test build steps.
+      # NOTE: terragrunt tests are excluded here and run in a separate terragrunt_test job.
       - run: mkdir -p /tmp/logs
       # check we can compile the azure code, but don't actually run the tests
       - run: run-go-tests --packages "-p 1 -tags=azure -run IDontExist ./modules/azure"
-      - run: run-go-tests --packages "-p 1 ./..." | tee /tmp/logs/test_output.log
+      - run: |
+          # Run all tests except terragrunt module (which has its own dedicated job)
+          run-go-tests --packages "-p 1 $(go list ./... | grep -v './modules/terragrunt' | tr '\n' ' ')" | tee /tmp/logs/test_output.log
 
       - run:
           command: |
@@ -381,7 +394,7 @@ jobs:
       - store_test_results:
           path: /tmp/logs
 
-  # Dedicated terragrunt tests that require terragrunt binary to be available
+  # Dedicated terragrunt tests with terraform as the underlying IaC binary
   terragrunt_test:
     <<: *defaults
     resource_class: large
@@ -391,6 +404,8 @@ jobs:
 
       - run:
           <<: *install_gruntwork_utils
+      - run:
+          <<: *install_terragrunt_latest
       - run:
           <<: *install_docker_buildx
 
@@ -417,6 +432,50 @@ jobs:
       - store_test_results:
           path: /tmp/logs
 
+  # Dedicated terragrunt tests with tofu as the underlying IaC binary
+  terragrunt_test_tofu:
+    <<: *defaults
+    resource_class: large
+    steps:
+      - attach_workspace:
+          at: /home/circleci
+
+      - run:
+          <<: *install_gruntwork_utils
+      - run:
+          <<: *install_tofu
+      - run:
+          <<: *install_terragrunt_latest
+      - run:
+          <<: *install_docker_buildx
+
+      # The weird way you have to set PATH in Circle 2.0
+      - run: |
+          echo 'export PATH=$HOME/.local/bin:$HOME/terraform:$HOME/packer:$PATH' >> $BASH_ENV
+          # Remove terraform binary so tofu will be used by terragrunt
+          sudo rm -f $(which terraform)
+          # Verify tofu is available
+          which tofu
+          tofu --version
+
+      # Run the terragrunt-specific tests with tofu as the backend
+      - run:
+          command: |
+            mkdir -p /tmp/logs
+            # Run only the terragrunt module tests
+            run-go-tests --packages "-p 1 ./modules/terragrunt" | tee /tmp/logs/test_output.log
+
+      - run:
+          command: |
+            ./cmd/bin/terratest_log_parser_linux_amd64 --testlog /tmp/logs/test_output.log --outputdir /tmp/logs
+          when: always
+
+      # Store test result and log artifacts for browsing purposes
+      - store_artifacts:
+          path: /tmp/logs
+      - store_test_results:
+          path: /tmp/logs
+
   deploy:
     <<: *defaults
     steps:
@@ -473,7 +532,17 @@ workflows:
             tags:
               only: /^v.*/
 
-      - test_terraform:
+      - terragrunt_test_tofu:
+          context:
+            - AWS__PHXDEVOPS__circle-ci-test
+            - GITHUB__PAT__gruntwork-ci
+          requires:
+            - setup
+          filters:
+            tags:
+              only: /^v.*/
+
+      - terraform_test:
           context:
             - AWS__PHXDEVOPS__circle-ci-test
             - GITHUB__PAT__gruntwork-ci
@@ -486,7 +555,7 @@ workflows:
             tags:
               only: /^v.*/
 
-      - test_tofu:
+      - terraform_test_tofu:
           context:
             - AWS__PHXDEVOPS__circle-ci-test
             - GITHUB__PAT__gruntwork-ci

modules/terragrunt/cmd_args_test.go

@@ -1,6 +1,7 @@
 package terragrunt
 
 import (
+	"os/exec"
 	"path/filepath"
 	"testing"
 
@@ -249,11 +250,21 @@ func TestEnvVarsPropagation(t *testing.T) {
 		"../../test/fixtures/terragrunt/terragrunt-stack-init", t.Name())
 	require.NoError(t, err)
 
+	// Detect which IaC binary is available (terraform or tofu)
+	tfBinary := "terraform"
+	if _, err := exec.LookPath("terraform"); err != nil {
+		// terraform not found, try tofu
+		if _, err := exec.LookPath("tofu"); err != nil {
+			t.Skip("Neither terraform nor tofu found in PATH")
+		}
+		tfBinary = "tofu"
+	}
+
 	options := &Options{
 		TerragruntDir: filepath.Join(testFolder, "live"),
 		EnvVars: map[string]string{
-			"TERRAGRUNT_TFPATH": "terraform", // Explicitly set terraform binary
-			"TG_LOG_LEVEL":      "error",     // Alternative to --log-level flag
+			"TERRAGRUNT_TFPATH": tfBinary, // Use whichever binary is available
+			"TG_LOG_LEVEL":      "error",  // Alternative to --log-level flag
 		},
 	}
 

modules/terragrunt/format.go

@@ -5,14 +5,14 @@ import (
 	"github.com/stretchr/testify/require"
 )
 
-// FormatAll runs terragrunt hclfmt to format all terragrunt.hcl files and returns stdout/stderr
+// FormatAll runs terragrunt hcl format to format all terragrunt.hcl files and returns stdout/stderr
 func FormatAll(t testing.TestingT, options *Options) string {
 	out, err := FormatAllE(t, options)
 	require.NoError(t, err)
 	return out
 }
 
-// FormatAllE runs terragrunt hclfmt to format all terragrunt.hcl files and returns stdout/stderr
+// FormatAllE runs terragrunt hcl format to format all terragrunt.hcl files and returns stdout/stderr
 func FormatAllE(t testing.TestingT, options *Options) (string, error) {
-	return runTerragruntCommandE(t, options, "hclfmt")
+	return runTerragruntCommandE(t, options, "hcl", "format")
 }

modules/terragrunt/format_test.go

@@ -31,8 +31,20 @@ foo="bar"
 		TerragruntBinary: "terragrunt",
 	}
 
-	out := FormatAll(t, options)
-	require.NotEmpty(t, out)
+	// Run format command
+	FormatAll(t, options)
+
+	// Read the formatted file to verify it was actually formatted
+	formattedContent, err := os.ReadFile(tgFile)
+	require.NoError(t, err)
+
+	// Verify the file was formatted (should have proper spacing now)
+	require.Contains(t, string(formattedContent), `source = "git::[email protected]:foo/modules.git//app"`,
+		"Expected file to be formatted with proper spacing")
+	require.Contains(t, string(formattedContent), `inputs = {`,
+		"Expected inputs block to be formatted with spaces around =")
+	require.Contains(t, string(formattedContent), `foo = "bar"`,
+		"Expected key-value pairs to be formatted with spaces around =")
 }
 
 func TestFormatAllE(t *testing.T) {
@@ -41,12 +53,29 @@ func TestFormatAllE(t *testing.T) {
 	testFolder, err := files.CopyTerragruntFolderToTemp("../../test/fixtures/terragrunt/terragrunt-multi-plan", t.Name())
 	require.NoError(t, err)
 
+	// Create an unformatted file to ensure the command actually does something
+	unformattedContent := `terraform {
+source = "git::[email protected]:foo/modules.git//app"
+}
+inputs={
+foo="bar"
+}`
+	tgFile := filepath.Join(testFolder, "foo", "terragrunt.hcl")
+	err = os.WriteFile(tgFile, []byte(unformattedContent), 0644)
+	require.NoError(t, err)
+
 	options := &Options{
 		TerragruntDir:    testFolder,
 		TerragruntBinary: "terragrunt",
 	}
 
-	out, err := FormatAllE(t, options)
+	// Run format command - should succeed
+	_, err = FormatAllE(t, options)
+	require.NoError(t, err)
+
+	// Verify the file was actually formatted by reading it
+	formattedContent, err := os.ReadFile(tgFile)
 	require.NoError(t, err)
-	require.NotEmpty(t, out)
+	require.Contains(t, string(formattedContent), `inputs = {`,
+		"File should be formatted with proper spacing")
 }

modules/terragrunt/init_test.go

@@ -20,7 +20,8 @@ func TestInit(t *testing.T) {
 		TerragruntBinary: "terragrunt",
 		TerraformArgs:    []string{"-upgrade=true"},
 	})
-	require.Contains(t, out, "Terraform has been successfully initialized!")
+	// Check for common success indicator (works with both Terraform and OpenTofu)
+	require.Contains(t, out, "successfully initialized")
 }
 
 func TestInitE(t *testing.T) {
@@ -36,7 +37,8 @@ func TestInitE(t *testing.T) {
 		TerraformArgs:    []string{"-upgrade=true"}, // Common terraform init flag
 	})
 	require.NoError(t, err)
-	require.Contains(t, out, "Terraform has been successfully initialized!")
+	// Check for common success indicator (works with both Terraform and OpenTofu)
+	require.Contains(t, out, "successfully initialized")
 }
 
 func TestInitWithInvalidConfig(t *testing.T) {

modules/terragrunt/stack_generate_test.go

@@ -69,70 +69,6 @@ func TestStackGenerateE(t *testing.T) {
 	}
 }
 
-func TestStackGenerateWithNoColor(t *testing.T) {
-	t.Parallel()
-
-	testFolder, err := files.CopyTerraformFolderToTemp(
-		"../../test/fixtures/terragrunt/terragrunt-stack-init", t.Name())
-	require.NoError(t, err)
-
-	// First initialize the stack
-	_, err = InitE(t, &Options{
-		TerragruntDir:    path.Join(testFolder, "live"),
-		TerragruntBinary: "terragrunt",
-		TerraformArgs:    []string{"-upgrade=true"},
-	})
-	require.NoError(t, err)
-
-	// Generate with no-color option
-	out, err := StackGenerateE(t, &Options{
-		TerragruntDir:    path.Join(testFolder, "live"),
-		TerragruntBinary: "terragrunt",
-		TerragruntArgs:   []string{"--no-color"},
-	})
-	require.NoError(t, err)
-
-	// Validate that generate command produced output
-	// Terragrunt v0.80.4+ outputs "Processing unit", older versions output "Generating unit"
-	require.True(t, containsEitherString(out, "Processing unit", "Generating unit"), "Output should contain either 'Processing unit' or 'Generating unit'")
-
-	// Verify that the .terragrunt-stack directory was created
-	stackDir := path.Join(testFolder, "live", ".terragrunt-stack")
-	require.DirExists(t, stackDir)
-}
-
-func TestStackGenerateWithExtraArgs(t *testing.T) {
-	t.Parallel()
-
-	testFolder, err := files.CopyTerraformFolderToTemp(
-		"../../test/fixtures/terragrunt/terragrunt-stack-init", t.Name())
-	require.NoError(t, err)
-
-	// First initialize the stack
-	_, err = InitE(t, &Options{
-		TerragruntDir:    path.Join(testFolder, "live"),
-		TerragruntBinary: "terragrunt",
-		TerraformArgs:    []string{"-upgrade=true"},
-	})
-	require.NoError(t, err)
-
-	// Generate with extra args
-	out, err := StackGenerateE(t, &Options{
-		TerragruntDir:    path.Join(testFolder, "live"),
-		TerragruntBinary: "terragrunt",
-		TerragruntArgs:   []string{"--log-level", "info"},
-	})
-	require.NoError(t, err)
-
-	// Validate that generate command produced output
-	// Terragrunt v0.80.4+ outputs "Processing unit", older versions output "Generating unit"
-	require.True(t, containsEitherString(out, "Processing unit", "Generating unit"), "Output should contain either 'Processing unit' or 'Generating unit'")
-
-	// Verify that the .terragrunt-stack directory was created
-	stackDir := path.Join(testFolder, "live", ".terragrunt-stack")
-	require.DirExists(t, stackDir)
-}
-
 func TestStackGenerateNonExistentDir(t *testing.T) {
 	t.Parallel()
 

modules/terragrunt/terragrunt_e2e_test.go

@@ -88,7 +88,8 @@ func TestStackEndToEndIntegration(t *testing.T) {
 	runOptions.TerraformArgs = []string{"plan"}
 	planOutput, err := StackRunE(t, &runOptions)
 	require.NoError(t, err)
-	require.Contains(t, planOutput, "Terraform will perform", "Stack run should execute plan")
+	// Check for common plan indicator (works with both Terraform and OpenTofu)
+	require.Contains(t, planOutput, "will perform")
 
 	// Step 4: Clean stack
 	t.Log("Step 4: Cleaning stack")