feat: Adding --filter source= support (#5075)

Author: yhakbar

internal/component/component.go

@@ -28,6 +28,7 @@ type Component interface {
 	SetExternal()
 	Reading() []string
 	SetReading(...string)
+	Sources() []string
 	DiscoveryContext() *DiscoveryContext
 	SetDiscoveryContext(*DiscoveryContext)
 	AddDependency(Component)

internal/component/stack.go

@@ -87,6 +87,13 @@ func (s *Stack) SetReading(files ...string) {
 	s.reading = files
 }
 
+// Sources returns the list of sources for this component.
+//
+// Stacks don't support leveraging sources right now, so we just return an empty list.
+func (s *Stack) Sources() []string {
+	return []string{}
+}
+
 // DiscoveryContext returns the discovery context for this component.
 func (s *Stack) DiscoveryContext() *DiscoveryContext {
 	return s.discoveryContext

internal/component/unit.go

@@ -92,6 +92,15 @@ func (u *Unit) SetReading(files ...string) {
 	u.reading = files
 }
 
+// Sources returns the list of sources for this component.
+func (u *Unit) Sources() []string {
+	if u.cfg == nil || u.cfg.Terraform == nil || u.cfg.Terraform.Source == nil {
+		return []string{}
+	}
+
+	return []string{*u.cfg.Terraform.Source}
+}
+
 // DiscoveryContext returns the discovery context for this component.
 func (u *Unit) DiscoveryContext() *DiscoveryContext {
 	return u.discoveryContext

internal/filter/ast.go

@@ -103,7 +103,7 @@ func (a *AttributeFilter) CompileGlob() (glob.Glob, error) {
 
 // supportsGlob returns true if the attribute filter supports glob patterns.
 func (a *AttributeFilter) supportsGlob() bool {
-	return a.Key == AttributeReading || a.Key == AttributeName
+	return a.Key == AttributeReading || a.Key == AttributeName || a.Key == AttributeSource
 }
 
 func (a *AttributeFilter) expressionNode()                       {}

internal/filter/evaluator.go

@@ -2,6 +2,7 @@ package filter
 
 import (
 	"path/filepath"
+	"slices"
 
 	"github.com/gruntwork-io/terragrunt/internal/component"
 	"github.com/gruntwork-io/terragrunt/pkg/log"
@@ -12,6 +13,7 @@ const (
 	AttributeType     = "type"
 	AttributeExternal = "external"
 	AttributeReading  = "reading"
+	AttributeSource   = "source"
 
 	AttributeTypeValueUnit  = string(component.UnitKind)
 	AttributeTypeValueStack = string(component.StackKind)
@@ -148,6 +150,17 @@ func evaluateAttributeFilter(filter *AttributeFilter, components []component.Com
 				}
 			}
 		}
+	case AttributeSource:
+		g, err := filter.CompileGlob()
+		if err != nil {
+			return nil, NewEvaluationErrorWithCause("failed to compile glob pattern for source filter: "+filter.Value, err)
+		}
+
+		for _, c := range components {
+			if slices.ContainsFunc(c.Sources(), g.Match) {
+				result = append(result, c)
+			}
+		}
 	default:
 		return nil, NewEvaluationError("unknown attribute key: " + filter.Key)
 	}

internal/filter/evaluator_test.go

@@ -3,9 +3,11 @@ package filter_test
 import (
 	"testing"
 
+	"github.com/gruntwork-io/terragrunt/config"
 	"github.com/gruntwork-io/terragrunt/internal/component"
 	"github.com/gruntwork-io/terragrunt/internal/filter"
 	"github.com/gruntwork-io/terragrunt/pkg/log"
+	"github.com/gruntwork-io/terragrunt/test/helpers"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
@@ -263,6 +265,67 @@ func TestEvaluate_AttributeFilter_Reading(t *testing.T) {
 	}
 }
 
+func TestEvaluate_AttributeFilter_Source(t *testing.T) {
+	t.Parallel()
+
+	components := []component.Component{
+		component.NewUnit("./apps/app1").WithConfig(
+			&config.TerragruntConfig{
+				Terraform: &config.TerraformConfig{
+					Source: helpers.PointerTo("github.com/acme/foo"),
+				},
+			},
+		),
+		component.NewUnit("./apps/app2").WithConfig(
+			&config.TerragruntConfig{
+				Terraform: &config.TerraformConfig{
+					Source: helpers.PointerTo("git::[email protected]:acme/bar?ref=v1.0.0"),
+				},
+			},
+		),
+	}
+
+	tests := []struct {
+		name     string
+		filter   *filter.AttributeFilter
+		expected []component.Component
+	}{
+		{
+			name:   "glob pattern with single wildcard - github.com/acme/*",
+			filter: &filter.AttributeFilter{Key: "source", Value: "github.com/acme/*"},
+			expected: []component.Component{
+				components[0],
+			},
+		},
+		{
+			name:   "glob pattern with double wildcard - git::[email protected]:acme/**",
+			filter: &filter.AttributeFilter{Key: "source", Value: "git::[email protected]:acme/**"},
+			expected: []component.Component{
+				components[1],
+			},
+		},
+		{
+			name:   "glob pattern with double wildcard - **github.com**",
+			filter: &filter.AttributeFilter{Key: "source", Value: "**github.com**"},
+			expected: []component.Component{
+				components[0],
+				components[1],
+			},
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			t.Parallel()
+
+			l := log.New()
+			result, err := filter.Evaluate(l, tt.filter, components)
+			require.NoError(t, err)
+			assert.ElementsMatch(t, tt.expected, result)
+		})
+	}
+}
+
 func TestEvaluate_AttributeFilter_Reading_ComponentAddedOnlyOnce(t *testing.T) {
 	t.Parallel()
 

test/fixtures/filter-source/github-acme-bar/main.tf

@@ -0,0 +1,2 @@
+# Empty module
+

test/fixtures/filter-source/github-acme-bar/terragrunt.hcl

@@ -0,0 +1,4 @@
+terraform {
+  source = "git::[email protected]:acme/bar?ref=v1.0.0"
+}
+

test/fixtures/filter-source/github-acme-foo/main.tf

@@ -0,0 +1,2 @@
+# Empty module
+

test/fixtures/filter-source/github-acme-foo/terragrunt.hcl

@@ -0,0 +1,4 @@
+terraform {
+  source = "github.com/acme/foo"
+}
+