chore: Expanding lll coverage to discovery

Author: yhakbar

.golangci.yml

@@ -121,7 +121,7 @@ linters:
       # trying to get this merged in.
       - linters:
           - lll
-        path-except: '^(internal/awshelper/|internal/cas/|internal/cli/commands/(backend/(delete|migrate)|catalog/tui/command|dag/graph|exec|find|help|list|scaffold|stack)/|internal/cloner/|internal/codegen/|internal/configbridge/|internal/engine/|internal/errorconfig/|internal/errors/|internal/experiment/|internal/gcphelper/|internal/git/|internal/os/exec/|internal/prepare/|internal/queue/|internal/report/|internal/retry/|internal/runner/(common|graph|run/creds|runall|runcfg)/|internal/stacks/(generate|output)/|internal/telemetry/|internal/tf/cache/(controllers|middleware)/|internal/tflint/|internal/tips/|internal/vfs/|internal/worktrees/|pkg/log/(format/(options|placeholders)|writer)/|pkg/options/)'
+        path-except: '^(internal/awshelper/|internal/cas/|internal/cli/commands/(backend/(delete|migrate)|catalog/tui/command|dag/graph|exec|find|help|list|scaffold|stack)/|internal/cloner/|internal/codegen/|internal/configbridge/|internal/discovery/|internal/engine/|internal/errorconfig/|internal/errors/|internal/experiment/|internal/gcphelper/|internal/git/|internal/os/exec/|internal/prepare/|internal/queue/|internal/report/|internal/retry/|internal/runner/(common|graph|run/creds|runall|runcfg)/|internal/stacks/(generate|output)/|internal/telemetry/|internal/tf/cache/(controllers|middleware)/|internal/tflint/|internal/tips/|internal/vfs/|internal/worktrees/|pkg/log/(format/(options|placeholders)|writer)/|pkg/options/)'
     paths:
       - docs
       - _ci

internal/discovery/discovery.go

@@ -78,24 +78,26 @@ func (d *Discovery) Discover(
 		components = filtered
 	}
 
-	cycleCheckErr := telemetry.TelemeterFromContext(ctx).Collect(ctx, "discovery_cycle_check", map[string]any{}, func(childCtx context.Context) error {
-		if _, cycleErr := components.CycleCheck(); cycleErr != nil {
-			l.Debugf("Cycle: %v", cycleErr)
+	cycleCheckErr := telemetry.TelemeterFromContext(ctx).Collect(
+		ctx, "discovery_cycle_check", map[string]any{},
+		func(childCtx context.Context) error {
+			if _, cycleErr := components.CycleCheck(); cycleErr != nil {
+				l.Debugf("Cycle: %v", cycleErr)
 
-			if d.breakCycles {
-				l.Warnf("Cycle detected in dependency graph, attempting removal of cycles.")
+				if d.breakCycles {
+					l.Warnf("Cycle detected in dependency graph, attempting removal of cycles.")
 
-				var removeErr error
+					var removeErr error
 
-				components, removeErr = removeCycles(components)
-				if removeErr != nil {
-					return removeErr
+					components, removeErr = removeCycles(components)
+					if removeErr != nil {
+						return removeErr
+					}
 				}
 			}
-		}
 
-		return nil
-	})
+			return nil
+		})
 
 	if cycleCheckErr != nil && !d.suppressParseErrors {
 		return components, cycleCheckErr
@@ -250,10 +252,12 @@ func (d *Discovery) runGraphPhase(
 
 		var buildErrs []error
 
-		telemetry.TelemeterFromContext(ctx).Collect(ctx, "discover_dependents", map[string]any{}, func(childCtx context.Context) error { //nolint:errcheck
-			buildErrs = d.buildDependencyGraph(childCtx, l, opts, allComponents)
-			return errors.Join(buildErrs...)
-		})
+		telemetry.TelemeterFromContext(ctx).Collect( //nolint:errcheck
+			ctx, "discover_dependents", map[string]any{},
+			func(childCtx context.Context) error {
+				buildErrs = d.buildDependencyGraph(childCtx, l, opts, allComponents)
+				return errors.Join(buildErrs...)
+			})
 
 		if len(buildErrs) > 0 && !d.suppressParseErrors {
 			return &PhaseResults{
@@ -270,17 +274,19 @@ func (d *Discovery) runGraphPhase(
 		err    error
 	)
 
-	telemetry.TelemeterFromContext(ctx).Collect(ctx, "discover_dependencies", map[string]any{}, func(childCtx context.Context) error { //nolint:errcheck
-		result, err = phase.Run(childCtx, l, &PhaseInput{
-			Opts:       opts,
-			Components: resultsToComponents(discovered),
-			Candidates: candidates,
-			Classifier: d.classifier,
-			Discovery:  d,
-		})
+	telemetry.TelemeterFromContext(ctx).Collect( //nolint:errcheck
+		ctx, "discover_dependencies", map[string]any{},
+		func(childCtx context.Context) error {
+			result, err = phase.Run(childCtx, l, &PhaseInput{
+				Opts:       opts,
+				Components: resultsToComponents(discovered),
+				Candidates: candidates,
+				Classifier: d.classifier,
+				Discovery:  d,
+			})
 
-		return err
-	})
+			return err
+		})
 
 	allDiscovered := discovered
 	if result != nil {
@@ -580,14 +586,20 @@ func filterByAllowSet(components component.Components, allowed map[string]struct
 
 // applyQueueFilters marks discovered units as excluded or included based on queue-related CLI flags and config.
 // The runner consumes the exclusion markers instead of re-evaluating the filters.
-func (d *Discovery) applyQueueFilters(opts *options.TerragruntOptions, components component.Components) component.Components {
+func (d *Discovery) applyQueueFilters(
+	opts *options.TerragruntOptions,
+	components component.Components,
+) component.Components {
 	components = d.applyExcludeModules(opts, components)
 
 	return components
 }
 
 // applyExcludeModules marks units (and optionally their dependencies) excluded via terragrunt exclude blocks.
-func (d *Discovery) applyExcludeModules(opts *options.TerragruntOptions, components component.Components) component.Components {
+func (d *Discovery) applyExcludeModules(
+	opts *options.TerragruntOptions,
+	components component.Components,
+) component.Components {
 	for _, c := range components {
 		unit, ok := c.(*component.Unit)
 		if !ok {

internal/discovery/filter_test.go

@@ -1085,7 +1085,9 @@ dependency "vpc" {
 
 	// Should include vpc (target) and db (direct dependent) and app (transitive dependent)
 	units := components.Filter(component.UnitKind).Paths()
-	assert.ElementsMatch(t, []string{vpcDir, dbDir, appDir}, units, "...vpc should find vpc and all its dependents (db, app)")
+	assert.ElementsMatch(t,
+		[]string{vpcDir, dbDir, appDir}, units,
+		"...vpc should find vpc and all its dependents (db, app)")
 }
 
 // TestDiscovery_DependentDiscovery_ExcludeTarget tests dependent discovery with target exclusion (^...vpc).
@@ -1290,7 +1292,9 @@ dependency "vpc" {
 
 	// Should include: app (dependent), db (target), vpc (dependency)
 	units := components.Filter(component.UnitKind).Paths()
-	assert.ElementsMatch(t, []string{appDir, dbDir, vpcDir}, units, "...db... should find dependents, target, and dependencies")
+	assert.ElementsMatch(t,
+		[]string{appDir, dbDir, vpcDir}, units,
+		"...db... should find dependents, target, and dependencies")
 }
 
 // TestDiscovery_DependentDiscovery_OutsideWorkingDir tests that dependent discovery
@@ -1370,7 +1374,9 @@ dependency "vpc" {
 	units := components.Filter(component.UnitKind).Paths()
 	assert.Contains(t, units, vpcDir, "vpc should be discovered as the target")
 	assert.Contains(t, units, consumerDir, "consumer should be discovered even though it's outside working dir")
-	assert.ElementsMatch(t, []string{vpcDir, consumerDir}, units, "...vpc should find vpc and consumer (outside working dir)")
+	assert.ElementsMatch(t,
+		[]string{vpcDir, consumerDir}, units,
+		"...vpc should find vpc and consumer (outside working dir)")
 }
 
 // TestDiscovery_DependentDiscovery_OutsideWorkingDir_MultipleLevels tests that dependent discovery

internal/discovery/helpers.go

@@ -253,7 +253,11 @@ func extractDependencyPaths(cfg *config.TerragruntConfig, c component.Component)
 		}
 
 		if !config.IsValidConfigPath(dependency.ConfigPath) {
-			errs = append(errs, errors.Errorf("skipping dependency %q in %q: config_path could not be resolved", dependency.Name, c.Path()))
+			errs = append(errs, errors.Errorf(
+				"skipping dependency %q in %q: "+
+					"config_path could not be resolved",
+				dependency.Name, c.Path()))
+
 			continue
 		}
 

internal/discovery/phase_graph.go

@@ -440,7 +440,9 @@ func (p *GraphPhase) discoverDependentsUpstream(
 	boundaryRoot string,
 	depthRemaining int,
 ) error {
-	l.Debugf("discoverDependentsUpstream: target=%s currentDir=%s boundary=%s depth=%d", target.Path(), currentDir, boundaryRoot, depthRemaining)
+	l.Debugf("discoverDependentsUpstream: target=%s"+
+		" currentDir=%s boundary=%s depth=%d",
+		target.Path(), currentDir, boundaryRoot, depthRemaining)
 
 	if depthRemaining <= 0 {
 		l.Debugf("discoverDependentsUpstream: depth limit reached")

internal/discovery/phase_parse.go

@@ -230,7 +230,11 @@ func parseComponent(
 	parseOpts.TerragruntConfigPath = filepath.Join(parseOpts.WorkingDir, configFilename)
 	parseOpts.OriginalTerragruntConfigPath = parseOpts.TerragruntConfigPath
 
-	if _, err := creds.ObtainCredsForParsing(ctx, l, parseOpts.AuthProviderCmd, parseOpts.Env, configbridge.ShellRunOptsFromOpts(parseOpts)); err != nil {
+	shellRunOpts := configbridge.ShellRunOptsFromOpts(parseOpts)
+	if _, err := creds.ObtainCredsForParsing(
+		ctx, l, parseOpts.AuthProviderCmd,
+		parseOpts.Env, shellRunOpts,
+	); err != nil {
 		return err
 	}
 

internal/discovery/phase_worktree_integration_test.go

@@ -177,7 +177,11 @@ func TestWorktreePhase_Integration_CommandArgs(t *testing.T) {
 			// Set up discovery
 			l := logger.CreateLogger()
 
-			w, err := worktrees.NewWorktrees(t.Context(), l, worktrees.WorktreeOpts{WorkingDir: tmpDir, GitExpressions: gitExpressions})
+			wtOpts := worktrees.WorktreeOpts{
+				WorkingDir:     tmpDir,
+				GitExpressions: gitExpressions,
+			}
+			w, err := worktrees.NewWorktrees(t.Context(), l, wtOpts)
 			require.NoError(t, err)
 
 			t.Cleanup(func() {
@@ -447,7 +451,11 @@ unit "unit_to_be_untouched" {
 	l := logger.CreateLogger()
 	gitExpressions := filter.GitExpressions{filter.NewGitExpression("HEAD~1", "HEAD")}
 
-	w, err := worktrees.NewWorktrees(t.Context(), l, worktrees.WorktreeOpts{WorkingDir: tmpDir, GitExpressions: gitExpressions})
+	wtOpts := worktrees.WorktreeOpts{
+		WorkingDir:     tmpDir,
+		GitExpressions: gitExpressions,
+	}
+	w, err := worktrees.NewWorktrees(t.Context(), l, wtOpts)
 	require.NoError(t, err)
 
 	t.Cleanup(func() {
@@ -807,7 +815,11 @@ locals {
 			require.NoError(t, err)
 
 			// Create worktrees
-			w, err := worktrees.NewWorktrees(t.Context(), l, worktrees.WorktreeOpts{WorkingDir: tmpDir, GitExpressions: filters.UniqueGitFilters()})
+			wtOpts := worktrees.WorktreeOpts{
+				WorkingDir:     tmpDir,
+				GitExpressions: filters.UniqueGitFilters(),
+			}
+			w, err := worktrees.NewWorktrees(t.Context(), l, wtOpts)
 			require.NoError(t, err)
 
 			t.Cleanup(func() {
@@ -901,7 +913,11 @@ locals {
 	require.NoError(t, err)
 
 	// Create worktrees from the subdirectory
-	w, err := worktrees.NewWorktrees(t.Context(), l, worktrees.WorktreeOpts{WorkingDir: basicDir, GitExpressions: filters.UniqueGitFilters()})
+	wtOpts := worktrees.WorktreeOpts{
+		WorkingDir:     basicDir,
+		GitExpressions: filters.UniqueGitFilters(),
+	}
+	w, err := worktrees.NewWorktrees(t.Context(), l, wtOpts)
 	require.NoError(t, err)
 
 	t.Cleanup(func() {
@@ -1166,7 +1182,11 @@ locals {
 			require.NoError(t, err)
 
 			// Create worktrees
-			w, err := worktrees.NewWorktrees(t.Context(), l, worktrees.WorktreeOpts{WorkingDir: tmpDir, GitExpressions: filters.UniqueGitFilters()})
+			wtOpts := worktrees.WorktreeOpts{
+				WorkingDir:     tmpDir,
+				GitExpressions: filters.UniqueGitFilters(),
+			}
+			w, err := worktrees.NewWorktrees(t.Context(), l, wtOpts)
 			require.NoError(t, err)
 
 			t.Cleanup(func() {
@@ -1263,7 +1283,11 @@ func TestWorktreePhase_Integration_FromSubdirectory_MultipleCommits(t *testing.T
 			require.NoError(t, err)
 
 			// Create worktrees from the subdirectory
-			w, err := worktrees.NewWorktrees(t.Context(), l, worktrees.WorktreeOpts{WorkingDir: basicDir, GitExpressions: filters.UniqueGitFilters()})
+			wtOpts := worktrees.WorktreeOpts{
+				WorkingDir:     basicDir,
+				GitExpressions: filters.UniqueGitFilters(),
+			}
+			w, err := worktrees.NewWorktrees(t.Context(), l, wtOpts)
 			require.NoError(t, err)
 
 			t.Cleanup(func() {
@@ -1441,7 +1465,11 @@ unit "app" {
 	l := logger.CreateLogger()
 	gitExpressions := filter.GitExpressions{filter.NewGitExpression("HEAD~1", "HEAD")}
 
-	w, err := worktrees.NewWorktrees(t.Context(), l, worktrees.WorktreeOpts{WorkingDir: tmpDir, GitExpressions: gitExpressions})
+	wtOpts := worktrees.WorktreeOpts{
+		WorkingDir:     tmpDir,
+		GitExpressions: gitExpressions,
+	}
+	w, err := worktrees.NewWorktrees(t.Context(), l, wtOpts)
 	require.NoError(t, err)
 
 	t.Cleanup(func() {
@@ -1603,7 +1631,11 @@ unit "app" {
 	l := logger.CreateLogger()
 	gitExpressions := filter.GitExpressions{filter.NewGitExpression("HEAD~1", "HEAD")}
 
-	w, err := worktrees.NewWorktrees(t.Context(), l, worktrees.WorktreeOpts{WorkingDir: tmpDir, GitExpressions: gitExpressions})
+	wtOpts := worktrees.WorktreeOpts{
+		WorkingDir:     tmpDir,
+		GitExpressions: gitExpressions,
+	}
+	w, err := worktrees.NewWorktrees(t.Context(), l, wtOpts)
 	require.NoError(t, err)
 
 	t.Cleanup(func() {
@@ -1758,7 +1790,11 @@ unit "app" {
 	l := logger.CreateLogger()
 	gitExpressions := filter.GitExpressions{filter.NewGitExpression("HEAD~1", "HEAD")}
 
-	w, err := worktrees.NewWorktrees(t.Context(), l, worktrees.WorktreeOpts{WorkingDir: tmpDir, GitExpressions: gitExpressions})
+	wtOpts := worktrees.WorktreeOpts{
+		WorkingDir:     tmpDir,
+		GitExpressions: gitExpressions,
+	}
+	w, err := worktrees.NewWorktrees(t.Context(), l, wtOpts)
 	require.NoError(t, err)
 
 	t.Cleanup(func() {
@@ -1831,7 +1867,8 @@ unit "app" {
 	}
 
 	assert.True(t, foundStack,
-		"Stack with nested read_terragrunt_config reference should be discovered when sidecar changes; got: %v", componentPaths)
+		"Stack with nested read_terragrunt_config reference should be discovered"+
+			" when sidecar changes; got: %v", componentPaths)
 
 	// Verify: stack WITHOUT the reference should NOT be discovered
 	stackNoRefRel, err := filepath.Rel(tmpDir, stackNoRefDir)
@@ -2189,7 +2226,11 @@ func runWorktreeDiscovery(
 
 	l := logger.CreateLogger()
 
-	w, err := worktrees.NewWorktrees(t.Context(), l, worktrees.WorktreeOpts{WorkingDir: tmpDir, GitExpressions: gitExpressions})
+	wtOpts := worktrees.WorktreeOpts{
+		WorkingDir:     tmpDir,
+		GitExpressions: gitExpressions,
+	}
+	w, err := worktrees.NewWorktrees(t.Context(), l, wtOpts)
 	require.NoError(t, err)
 
 	t.Cleanup(func() {