tmp: Adding some logging to see what symlink experiment usage is causing trouble

Author: yhakbar

.github/workflows/integration-test.yml

@@ -150,17 +150,17 @@ jobs:
             setup_scripts:
               - .github/scripts/setup/experiment-symlinks.sh
 
-          - name: Experiment cas
-            os: ubuntu
-            target: ./...
-            setup_scripts:
-              - .github/scripts/setup/experiment-cas.sh
+          # - name: Experiment cas
+          #   os: ubuntu
+          #   target: ./...
+          #   setup_scripts:
+          #     - .github/scripts/setup/experiment-cas.sh
 
-          - name: Experiment filter-flag
-            os: ubuntu
-            target: ./...
-            setup_scripts:
-              - .github/scripts/setup/experiment-filter-flag.sh
+          # - name: Experiment filter-flag
+          #   os: ubuntu
+          #   target: ./...
+          #   setup_scripts:
+          #     - .github/scripts/setup/experiment-filter-flag.sh
     steps:
       - name: Checkout code
         uses: actions/checkout@v5

cli/commands/run/download_source.go

@@ -47,6 +47,9 @@ func downloadTerraformSource(
 	r *report.Report,
 ) (*options.TerragruntOptions, error) {
 	walkWithSymlinks := opts.Experiments.Evaluate(experiment.Symlinks)
+	if walkWithSymlinks {
+		l.Info("Symlinks experiment enabled. Downloading Terraform source with symlinks.")
+	}
 
 	terraformSource, err := tf.NewSource(l, source, opts.DownloadDir, opts.WorkingDir, walkWithSymlinks)
 	if err != nil {

config/config.go

@@ -186,6 +186,9 @@ func (cfg *TerragruntConfig) GetRemoteState(l log.Logger, opts *options.Terragru
 
 	if sourceURL != "" {
 		walkWithSymlinks := opts.Experiments.Evaluate(experiment.Symlinks)
+		if walkWithSymlinks {
+			l.Info("Symlinks experiment enabled. Walking directory with symlinks.")
+		}
 
 		tfSource, err := tf.NewSource(l, sourceURL, opts.DownloadDir, opts.WorkingDir, walkWithSymlinks)
 		if err != nil {
@@ -1084,11 +1087,13 @@ func GetDefaultConfigPath(workingDir string) string {
 
 // FindConfigFilesInPath returns a list of all Terragrunt config files in the given path or any subfolder of the path. A file is a Terragrunt
 // config file if it has a name as returned by the DefaultConfigPath method
-func FindConfigFilesInPath(rootPath string, opts *options.TerragruntOptions) ([]string, error) {
+func FindConfigFilesInPath(l log.Logger, rootPath string, opts *options.TerragruntOptions) ([]string, error) {
 	configFiles := []string{}
 
 	walkFunc := filepath.Walk
 	if opts.Experiments.Evaluate(experiment.Symlinks) {
+		l.Info("Symlinks experiment enabled. Walking directory with symlinks.")
+
 		walkFunc = util.WalkWithSymlinks
 	}
 

config/config_helpers.go

@@ -615,6 +615,9 @@ func getWorkingDir(ctx *ParsingContext, l log.Logger) (string, error) {
 	}
 
 	walkWithSymlinks := ctx.TerragruntOptions.Experiments.Evaluate(experiment.Symlinks)
+	if walkWithSymlinks {
+		l.Info("Symlinks experiment enabled. Getting working directory with symlinks.")
+	}
 
 	source, err := tf.NewSource(l, sourceURL, ctx.TerragruntOptions.DownloadDir, ctx.TerragruntOptions.WorkingDir, walkWithSymlinks)
 	if err != nil {

config/config_test.go

@@ -1048,11 +1048,13 @@ func TestParseTerragruntJsonConfigTerraformWithMultipleExtraArguments(t *testing
 func TestFindConfigFilesInPathNone(t *testing.T) {
 	t.Parallel()
 
+	l := createLogger()
+
 	expected := []string{}
 	terragruntOptions, err := options.NewTerragruntOptionsForTest("test")
 	require.NoError(t, err)
 
-	actual, err := config.FindConfigFilesInPath("../test/fixtures/config-files/none", terragruntOptions)
+	actual, err := config.FindConfigFilesInPath(l, "../test/fixtures/config-files/none", terragruntOptions)
 
 	require.NoError(t, err, "Unexpected error: %v", err)
 	assert.Equal(t, expected, actual)
@@ -1061,11 +1063,13 @@ func TestFindConfigFilesInPathNone(t *testing.T) {
 func TestFindConfigFilesInPathOneConfig(t *testing.T) {
 	t.Parallel()
 
+	l := createLogger()
+
 	expected := []string{"../test/fixtures/config-files/one-config/subdir/terragrunt.hcl"}
 	terragruntOptions, err := options.NewTerragruntOptionsForTest("test")
 	require.NoError(t, err)
 
-	actual, err := config.FindConfigFilesInPath("../test/fixtures/config-files/one-config", terragruntOptions)
+	actual, err := config.FindConfigFilesInPath(l, "../test/fixtures/config-files/one-config", terragruntOptions)
 
 	require.NoError(t, err, "Unexpected error: %v", err)
 	assert.Equal(t, expected, actual)
@@ -1074,11 +1078,13 @@ func TestFindConfigFilesInPathOneConfig(t *testing.T) {
 func TestFindConfigFilesInPathOneJsonConfig(t *testing.T) {
 	t.Parallel()
 
+	l := createLogger()
+
 	expected := []string{"../test/fixtures/config-files/one-json-config/subdir/terragrunt.hcl.json"}
 	terragruntOptions, err := options.NewTerragruntOptionsForTest("test")
 	require.NoError(t, err)
 
-	actual, err := config.FindConfigFilesInPath("../test/fixtures/config-files/one-json-config", terragruntOptions)
+	actual, err := config.FindConfigFilesInPath(l, "../test/fixtures/config-files/one-json-config", terragruntOptions)
 
 	require.NoError(t, err, "Unexpected error: %v", err)
 	assert.Equal(t, expected, actual)
@@ -1087,6 +1093,8 @@ func TestFindConfigFilesInPathOneJsonConfig(t *testing.T) {
 func TestFindConfigFilesInPathMultipleConfigs(t *testing.T) {
 	t.Parallel()
 
+	l := createLogger()
+
 	expected := []string{
 		"../test/fixtures/config-files/multiple-configs/terragrunt.hcl",
 		"../test/fixtures/config-files/multiple-configs/subdir-2/subdir/terragrunt.hcl",
@@ -1095,7 +1103,7 @@ func TestFindConfigFilesInPathMultipleConfigs(t *testing.T) {
 	terragruntOptions, err := options.NewTerragruntOptionsForTest("test")
 	require.NoError(t, err)
 
-	actual, err := config.FindConfigFilesInPath("../test/fixtures/config-files/multiple-configs", terragruntOptions)
+	actual, err := config.FindConfigFilesInPath(l, "../test/fixtures/config-files/multiple-configs", terragruntOptions)
 
 	require.NoError(t, err, "Unexpected error: %v", err)
 	assert.ElementsMatch(t, expected, actual)
@@ -1104,6 +1112,8 @@ func TestFindConfigFilesInPathMultipleConfigs(t *testing.T) {
 func TestFindConfigFilesInPathMultipleJsonConfigs(t *testing.T) {
 	t.Parallel()
 
+	l := createLogger()
+
 	expected := []string{
 		"../test/fixtures/config-files/multiple-json-configs/terragrunt.hcl.json",
 		"../test/fixtures/config-files/multiple-json-configs/subdir-2/subdir/terragrunt.hcl.json",
@@ -1112,7 +1122,7 @@ func TestFindConfigFilesInPathMultipleJsonConfigs(t *testing.T) {
 	terragruntOptions, err := options.NewTerragruntOptionsForTest("test")
 	require.NoError(t, err)
 
-	actual, err := config.FindConfigFilesInPath("../test/fixtures/config-files/multiple-json-configs", terragruntOptions)
+	actual, err := config.FindConfigFilesInPath(l, "../test/fixtures/config-files/multiple-json-configs", terragruntOptions)
 
 	require.NoError(t, err, "Unexpected error: %v", err)
 	assert.ElementsMatch(t, expected, actual)
@@ -1121,6 +1131,8 @@ func TestFindConfigFilesInPathMultipleJsonConfigs(t *testing.T) {
 func TestFindConfigFilesInPathMultipleMixedConfigs(t *testing.T) {
 	t.Parallel()
 
+	l := createLogger()
+
 	expected := []string{
 		"../test/fixtures/config-files/multiple-mixed-configs/terragrunt.hcl.json",
 		"../test/fixtures/config-files/multiple-mixed-configs/subdir-2/subdir/terragrunt.hcl",
@@ -1129,7 +1141,7 @@ func TestFindConfigFilesInPathMultipleMixedConfigs(t *testing.T) {
 	terragruntOptions, err := options.NewTerragruntOptionsForTest("test")
 	require.NoError(t, err)
 
-	actual, err := config.FindConfigFilesInPath("../test/fixtures/config-files/multiple-mixed-configs", terragruntOptions)
+	actual, err := config.FindConfigFilesInPath(l, "../test/fixtures/config-files/multiple-mixed-configs", terragruntOptions)
 
 	require.NoError(t, err, "Unexpected error: %v", err)
 	assert.ElementsMatch(t, expected, actual)
@@ -1138,13 +1150,15 @@ func TestFindConfigFilesInPathMultipleMixedConfigs(t *testing.T) {
 func TestFindConfigFilesIgnoresTerragruntCache(t *testing.T) {
 	t.Parallel()
 
+	l := createLogger()
+
 	expected := []string{
 		"../test/fixtures/config-files/ignore-cached-config/terragrunt.hcl",
 	}
 	terragruntOptions, err := options.NewTerragruntOptionsForTest("test")
 	require.NoError(t, err)
 
-	actual, err := config.FindConfigFilesInPath("../test/fixtures/config-files/ignore-cached-config", terragruntOptions)
+	actual, err := config.FindConfigFilesInPath(l, "../test/fixtures/config-files/ignore-cached-config", terragruntOptions)
 
 	require.NoError(t, err, "Unexpected error: %v", err)
 	assert.Equal(t, expected, actual)
@@ -1153,6 +1167,8 @@ func TestFindConfigFilesIgnoresTerragruntCache(t *testing.T) {
 func TestFindConfigFilesIgnoresTerraformDataDir(t *testing.T) {
 	t.Parallel()
 
+	l := createLogger()
+
 	expected := []string{
 		"../test/fixtures/config-files/ignore-terraform-data-dir/.tf_data/modules/mod/terragrunt.hcl",
 		"../test/fixtures/config-files/ignore-terraform-data-dir/subdir/terragrunt.hcl",
@@ -1161,7 +1177,7 @@ func TestFindConfigFilesIgnoresTerraformDataDir(t *testing.T) {
 	terragruntOptions, err := options.NewTerragruntOptionsForTest("test")
 	require.NoError(t, err)
 
-	actual, err := config.FindConfigFilesInPath("../test/fixtures/config-files/ignore-terraform-data-dir", terragruntOptions)
+	actual, err := config.FindConfigFilesInPath(l, "../test/fixtures/config-files/ignore-terraform-data-dir", terragruntOptions)
 
 	require.NoError(t, err, "Unexpected error: %v", err)
 	assert.ElementsMatch(t, expected, actual)
@@ -1170,6 +1186,8 @@ func TestFindConfigFilesIgnoresTerraformDataDir(t *testing.T) {
 func TestFindConfigFilesIgnoresTerraformDataDirEnv(t *testing.T) {
 	t.Parallel()
 
+	l := createLogger()
+
 	expected := []string{
 		"../test/fixtures/config-files/ignore-terraform-data-dir/subdir/terragrunt.hcl",
 		"../test/fixtures/config-files/ignore-terraform-data-dir/subdir/.terraform/modules/mod/terragrunt.hcl",
@@ -1179,7 +1197,7 @@ func TestFindConfigFilesIgnoresTerraformDataDirEnv(t *testing.T) {
 
 	terragruntOptions.Env["TF_DATA_DIR"] = ".tf_data"
 
-	actual, err := config.FindConfigFilesInPath("../test/fixtures/config-files/ignore-terraform-data-dir", terragruntOptions)
+	actual, err := config.FindConfigFilesInPath(l, "../test/fixtures/config-files/ignore-terraform-data-dir", terragruntOptions)
 
 	require.NoError(t, err, "Unexpected error: %v", err)
 	assert.ElementsMatch(t, expected, actual)
@@ -1188,6 +1206,8 @@ func TestFindConfigFilesIgnoresTerraformDataDirEnv(t *testing.T) {
 func TestFindConfigFilesIgnoresTerraformDataDirEnvPath(t *testing.T) {
 	t.Parallel()
 
+	l := createLogger()
+
 	expected := []string{
 		"../test/fixtures/config-files/ignore-terraform-data-dir/.tf_data/modules/mod/terragrunt.hcl",
 		"../test/fixtures/config-files/ignore-terraform-data-dir/subdir/terragrunt.hcl",
@@ -1198,7 +1218,7 @@ func TestFindConfigFilesIgnoresTerraformDataDirEnvPath(t *testing.T) {
 
 	terragruntOptions.Env["TF_DATA_DIR"] = "subdir/.tf_data"
 
-	actual, err := config.FindConfigFilesInPath("../test/fixtures/config-files/ignore-terraform-data-dir", terragruntOptions)
+	actual, err := config.FindConfigFilesInPath(l, "../test/fixtures/config-files/ignore-terraform-data-dir", terragruntOptions)
 
 	require.NoError(t, err, "Unexpected error: %v", err)
 	assert.ElementsMatch(t, expected, actual)
@@ -1207,6 +1227,8 @@ func TestFindConfigFilesIgnoresTerraformDataDirEnvPath(t *testing.T) {
 func TestFindConfigFilesIgnoresTerraformDataDirEnvRoot(t *testing.T) {
 	t.Parallel()
 
+	l := createLogger()
+
 	cwd, err := os.Getwd()
 	require.NoError(t, err)
 
@@ -1216,7 +1238,7 @@ func TestFindConfigFilesIgnoresTerraformDataDirEnvRoot(t *testing.T) {
 
 	terragruntOptions.Env["TF_DATA_DIR"] = filepath.Join(workingDir, ".tf_data")
 
-	actual, err := config.FindConfigFilesInPath(workingDir, terragruntOptions)
+	actual, err := config.FindConfigFilesInPath(l, workingDir, terragruntOptions)
 	require.NoError(t, err, "Unexpected error: %v", err)
 
 	// Create expected paths using filepath.Join for cross-platform compatibility
@@ -1248,6 +1270,8 @@ func TestFindConfigFilesIgnoresTerraformDataDirEnvRoot(t *testing.T) {
 func TestFindConfigFilesIgnoresDownloadDir(t *testing.T) {
 	t.Parallel()
 
+	l := createLogger()
+
 	expected := []string{
 		"../test/fixtures/config-files/multiple-configs/terragrunt.hcl",
 		"../test/fixtures/config-files/multiple-configs/subdir-3/terragrunt.hcl",
@@ -1257,7 +1281,7 @@ func TestFindConfigFilesIgnoresDownloadDir(t *testing.T) {
 
 	terragruntOptions.DownloadDir = "../test/fixtures/config-files/multiple-configs/subdir-2"
 
-	actual, err := config.FindConfigFilesInPath("../test/fixtures/config-files/multiple-configs", terragruntOptions)
+	actual, err := config.FindConfigFilesInPath(l, "../test/fixtures/config-files/multiple-configs", terragruntOptions)
 
 	require.NoError(t, err, "Unexpected error: %v", err)
 	assert.ElementsMatch(t, expected, actual)

config/dependency.go

@@ -858,6 +858,9 @@ func terragruntAlreadyInit(l log.Logger, opts *options.TerragruntOptions, config
 		}
 	} else {
 		walkWithSymlinks := opts.Experiments.Evaluate(experiment.Symlinks)
+		if walkWithSymlinks {
+			l.Info("Symlinks experiment enabled. Checking if module is already init-ed with symlinks.")
+		}
 
 		terraformSource, err := tf.NewSource(l, sourceURL, opts.DownloadDir, opts.WorkingDir, walkWithSymlinks)
 		if err != nil {

config/stack.go

@@ -1089,6 +1089,10 @@ func processLocals(l log.Logger, parser *ParsingContext, opts *options.Terragrun
 // provided Terragrunt options.
 func listStackFiles(l log.Logger, opts *options.TerragruntOptions, dir string) ([]string, error) {
 	walkWithSymlinks := opts.Experiments.Evaluate(experiment.Symlinks)
+	if walkWithSymlinks {
+		l.Info("Symlinks experiment enabled. Listing stack files with symlinks.")
+	}
+
 	walkFunc := filepath.Walk
 
 	if walkWithSymlinks {

config/variable.go

@@ -28,6 +28,9 @@ type ParsedVariable struct {
 // ParseVariables - parse variables from tf files.
 func ParseVariables(l log.Logger, opts *options.TerragruntOptions, directoryPath string) ([]*ParsedVariable, error) {
 	walkWithSymlinks := opts.Experiments.Evaluate(experiment.Symlinks)
+	if walkWithSymlinks {
+		l.Info("Symlinks experiment enabled. Parsing variables with symlinks.")
+	}
 
 	// list all tf files
 	tfFiles, err := util.ListTfFiles(directoryPath, walkWithSymlinks)

internal/discovery/discovery.go

@@ -623,6 +623,8 @@ func (d *Discovery) walkDirectoryConcurrently(
 ) error {
 	walkFn := filepath.WalkDir
 	if opts.Experiments.Evaluate(experiment.Symlinks) {
+		l.Info("Symlinks experiment enabled. Walking directory concurrently with symlinks.")
+
 		walkFn = util.WalkDirWithSymlinks
 	}
 

internal/services/catalog/catalog.go

@@ -119,6 +119,10 @@ func (s *catalogServiceImpl) Load(ctx context.Context, l log.Logger) error {
 
 	// Evaluate experimental features for symlinks and content-addressable storage.
 	walkWithSymlinks := s.opts.Experiments.Evaluate(experiment.Symlinks)
+	if walkWithSymlinks {
+		l.Info("Symlinks experiment enabled. Loading catalog repo with symlinks.")
+	}
+
 	allowCAS := s.opts.Experiments.Evaluate(experiment.CAS)
 
 	var errs []error