Support relative paths in include_patterns and exclude_patterns (#2286)

* Make it possible to resolve relative paths from project directory

Signed-off-by: golemiso <[email protected]>

* update docs about include/exclude patterns

---------

Signed-off-by: golemiso <[email protected]>

Author: golemiso

docs/ce/howto/include-exclude-patterns.mdx

@@ -15,19 +15,35 @@ modules/
 ```
 
 <Note>
-    The path of include / exclude patterns is relative to the digger.yml location - NOT the project location
+    Patterns starting with `.` (e.g., `./modules/**` or `../modules/**`) are resolved relative to the **project directory**. All other patterns are resolved relative to the **digger.yml location**.
 </Note>
 
 If you wanted to trigger plans for all `modules/` folder in both dev and prod projects you would include them in the `include_patterns` key. Similarly you put anything which you want to ignore in the `exclude_patterns` key ( exclude takes precedence over includes).
 
+Example using patterns relative to project directory:
+
+```yml
+projects:
+  - name: dev
+    dir: ./development
+    include_patterns: ["../modules/**"]  # Resolved from ./development/
+    workflow: default_workflow
+  - name: prod
+    dir: ./production
+    include_patterns: ["../modules/**"]  # Resolved from ./production/
+    exclude_patterns: ["../modules/dev_only_module/**"]
+```
+
+Example using patterns relative to digger.yml location:
+
 ```yml
 projects:
   - name: dev
     dir: ./development
-    include_patterns: ["./modules/**"]
+    include_patterns: ["modules/**"]  # Resolved from digger.yml location
     workflow: default_workflow
   - name: prod
     dir: ./production
-    include_patterns: ["./modules/**"]
-    exclude_patterns: ["./modules/dev_only_module/**"]
+    include_patterns: ["modules/**"]
+    exclude_patterns: ["modules/dev_only_module/**"]
 ```

libs/digger_config/digger_config.go

@@ -22,14 +22,11 @@ type DirWalker interface {
 	GetDirs(workingDir string, config DiggerConfigYaml) ([]string, error)
 }
 
-type FileSystemTopLevelTerraformDirWalker struct {
-}
+type FileSystemTopLevelTerraformDirWalker struct{}
 
-type FileSystemTerragruntDirWalker struct {
-}
+type FileSystemTerragruntDirWalker struct{}
 
-type FileSystemModuleDirWalker struct {
-}
+type FileSystemModuleDirWalker struct{}
 
 func ReadDiggerYmlFileContents(dir string) (string, error) {
 	var diggerYmlBytes []byte
@@ -366,11 +363,10 @@ func HandleYamlProjectGeneration(config *DiggerConfigYaml, terraformDir string,
 		}
 		return newConfig, nil
 	} else if config.GenerateProjectsConfig != nil {
-		var dirWalker = &FileSystemTopLevelTerraformDirWalker{}
+		dirWalker := &FileSystemTopLevelTerraformDirWalker{}
 
 		slog.Info("finding terraform directories for project generation", "terraformDir", terraformDir)
 		dirs, err := dirWalker.GetDirs(terraformDir, config)
-
 		if err != nil {
 			slog.Error("error walking through directories", "error", err, "terraformDir", terraformDir)
 			return nil, fmt.Errorf("error while walking through directories: %v", err)
@@ -617,7 +613,6 @@ func ValidateDiggerConfigYaml(configYaml *DiggerConfigYaml, fileName string) err
 }
 
 func checkThatOnlyOneIacSpecifiedPerProject(project *Project) error {
-
 	nOfIac := 0
 	if project.Terragrunt {
 		nOfIac++
@@ -686,7 +681,7 @@ func validateApplyRequirements(applyRequirements []string) error {
 		return fmt.Errorf("found duplicate element: %v", dups)
 	}
 	validValues := []string{ApplyRequirementsApproved, ApplyRequirementsMergeable, ApplyRequirementsUndiverged}
-	var validSet = func() map[string]struct{} {
+	validSet := func() map[string]struct{} {
 		m := make(map[string]struct{}, len(validValues))
 		for _, v := range validValues {
 			m[v] = struct{}{}
@@ -873,7 +868,6 @@ func hydrateDiggerConfigYamlWithTerragrunt(configYaml *DiggerConfigYaml, parsing
 		// normalize paths
 		projectDir := path.Join(pathPrefix, atlantisProject.Dir)
 		atlantisProject.Autoplan.WhenModified, err = GetPatternsRelativeToRepo(projectDir, atlantisProject.Autoplan.WhenModified)
-
 		if err != nil {
 			slog.Error("could not normalize patterns",
 				"error", err,
@@ -957,16 +951,31 @@ func (c *DiggerConfig) GetModifiedProjects(changedFiles []string) ([]Project, ma
 		sourceChangesForProject := make([]string, 0)
 		isProjectAdded := false
 
-		for _, changedFile := range changedFiles {
-			includePatterns := project.IncludePatterns
-			excludePatterns := project.ExcludePatterns
+		var includePatterns, excludePatterns []string
 
-			if !project.Terragrunt {
-				includePatterns = append(includePatterns, filepath.Join(project.Dir, "**", "*"))
+		// resolve relative paths from project dir
+		for _, pattern := range project.IncludePatterns {
+			if strings.HasPrefix(pattern, ".") {
+				includePatterns = append(includePatterns, filepath.Join(project.Dir, pattern))
 			} else {
-				includePatterns = append(includePatterns, filepath.Join(project.Dir, "*"))
+				includePatterns = append(includePatterns, pattern)
 			}
+		}
+		for _, pattern := range project.ExcludePatterns {
+			if strings.HasPrefix(pattern, ".") {
+				excludePatterns = append(excludePatterns, filepath.Join(project.Dir, pattern))
+			} else {
+				excludePatterns = append(excludePatterns, pattern)
+			}
+		}
 
+		if !project.Terragrunt {
+			includePatterns = append(includePatterns, filepath.Join(project.Dir, "**", "*"))
+		} else {
+			includePatterns = append(includePatterns, filepath.Join(project.Dir, "*"))
+		}
+
+		for _, changedFile := range changedFiles {
 			// all our patterns are the globale dir pattern + the include patterns specified by user
 			if MatchIncludeExcludePatternsToFile(changedFile, includePatterns, excludePatterns) {
 				if !isProjectAdded {

libs/digger_config/digger_config_test.go

@@ -68,7 +68,6 @@ func TestDiggerConfigWhenCustomFileName(t *testing.T) {
 	assert.Equal(t, configPath, path.Join(tempDir, "digger-custom.yml"))
 
 	os.Unsetenv("DIGGER_FILENAME")
-
 }
 
 func TestDiggerConfigWhenOnlyYamlExists(t *testing.T) {
@@ -579,7 +578,6 @@ workflows:
 	assert.NotNil(t, workflow)
 	assert.NotNil(t, workflow.Plan)
 	assert.NotNil(t, workflow.Apply)
-
 }
 
 func TestDiggerConfigMissingProjectsWorkflow(t *testing.T) {
@@ -603,7 +601,6 @@ workflows:
 
 	_, _, _, _, err := LoadDiggerConfig(tempDir, true, nil, nil)
 	assert.Equal(t, "failed to find workflow digger_config 'my_custom_workflow' for project 'my-first-app'", err.Error())
-
 }
 
 func TestDiggerConfigWithEmptyInitBlock(t *testing.T) {
@@ -1309,15 +1306,15 @@ projects:
 func TestGetModifiedProjectsReturnsCorrectSourceMappingWithDotFile(t *testing.T) {
 	changedFiles := []string{"prod/main.tf", "dev/test/main.tf"}
 	projects := []Project{
-		Project{
+		{
 			Name: "dev",
 			Dir:  ".",
 		},
 	}
 	c := DiggerConfig{
 		Projects: projects,
 	}
-	//expectedImpactingLocations := map[string]ProjectToSourceMapping{}
+	// expectedImpactingLocations := map[string]ProjectToSourceMapping{}
 	// TODO: this behaviour doesn't make much sense, we should re-evaluate when we make it configurable
 	impactedProjects, _ := c.GetModifiedProjects(changedFiles)
 	assert.Equal(t, 1, len(impactedProjects))
@@ -1326,7 +1323,7 @@ func TestGetModifiedProjectsReturnsCorrectSourceMappingWithDotFile(t *testing.T)
 func TestShouldDetectNestedFilesAsImpacted(t *testing.T) {
 	changedFiles := []string{"services/backend/files/config.json"}
 	projects := []Project{
-		Project{
+		{
 			Name: "services_backend",
 			Dir:  "services/backend",
 		},
@@ -1341,12 +1338,12 @@ func TestShouldDetectNestedFilesAsImpacted(t *testing.T) {
 func TestGetModifiedProjectsReturnsCorrectSourceMapping(t *testing.T) {
 	changedFiles := []string{"modules/bucket/main.tf", "dev/main.tf"}
 	projects := []Project{
-		Project{
+		{
 			Name:            "dev",
 			Dir:             "dev",
 			IncludePatterns: []string{"modules/**"},
 		},
-		Project{
+		{
 			Name:            "prod",
 			Dir:             "prod",
 			IncludePatterns: []string{"modules/**"},
@@ -1367,7 +1364,37 @@ func TestGetModifiedProjectsReturnsCorrectSourceMapping(t *testing.T) {
 	assert.Equal(t, 1, len(projectSourceMapping["prod"].ImpactingLocations))
 	assert.Equal(t, expectedImpactingLocations["dev"].ImpactingLocations, projectSourceMapping["dev"].ImpactingLocations)
 	assert.Equal(t, expectedImpactingLocations["prod"].ImpactingLocations, projectSourceMapping["prod"].ImpactingLocations)
+}
 
+func TestGetModifiedProjectsReturnsCorrectSourceMappingWithRelativePaths(t *testing.T) {
+	changedFiles := []string{"terraform/modules/bucket/main.tf", "terraform/dev/main.tf"}
+	projects := []Project{
+		{
+			Name:            "dev",
+			Dir:             "terraform/dev",
+			IncludePatterns: []string{"../modules/**"},
+		},
+		{
+			Name:            "prod",
+			Dir:             "terraform/prod",
+			IncludePatterns: []string{"../modules/**"},
+		},
+	}
+	c := DiggerConfig{
+		Projects: projects,
+	}
+	expectedImpactingLocations := map[string]ProjectToSourceMapping{
+		"dev":  {ImpactingLocations: []string{"terraform/modules/bucket", "terraform/dev"}},
+		"prod": {ImpactingLocations: []string{"terraform/modules/bucket"}},
+	}
+
+	impactedProjects, projectSourceMapping := c.GetModifiedProjects(changedFiles)
+	assert.Equal(t, 2, len(impactedProjects))
+	assert.Equal(t, 2, len(projectSourceMapping))
+	assert.Equal(t, 2, len(projectSourceMapping["dev"].ImpactingLocations))
+	assert.Equal(t, 1, len(projectSourceMapping["prod"].ImpactingLocations))
+	assert.Equal(t, expectedImpactingLocations["dev"].ImpactingLocations, projectSourceMapping["dev"].ImpactingLocations)
+	assert.Equal(t, expectedImpactingLocations["prod"].ImpactingLocations, projectSourceMapping["prod"].ImpactingLocations)
 }
 
 func TestCognitoTokenSetFromMinConfig(t *testing.T) {