flakeguard: Fix codeowners (#1425)

Author: lukaszcl

tools/flakeguard/cmd/aggregate_results.go

@@ -56,7 +56,7 @@ var AggregateResultsCmd = &cobra.Command{
 
 		// Output results to JSON files
 		if len(resultsToSave) > 0 {
-			return reports.SaveFilteredResultsAndLogs(outputResultsPath, outputLogsPath, allReport)
+			return reports.SaveFilteredResultsAndLogs(outputResultsPath, outputLogsPath, allReport, codeOwnersPath != "")
 		}
 		return nil
 	},
@@ -70,5 +70,4 @@ func init() {
 	AggregateResultsCmd.Flags().BoolVarP(&filterFailed, "filter-failed", "f", false, "If true, filter and output only failed tests based on the max-pass-ratio threshold")
 	AggregateResultsCmd.Flags().StringVarP(&codeOwnersPath, "codeowners-path", "c", "", "Path to the CODEOWNERS file")
 	AggregateResultsCmd.Flags().StringVarP(&projectPath, "project-path", "r", ".", "The path to the Go project. Default is the current directory. Useful for subprojects")
-
 }

tools/flakeguard/cmd/run.go

@@ -71,7 +71,7 @@ var RunTestsCmd = &cobra.Command{
 		// Print all failed tests including flaky tests
 		if printFailedTests {
 			fmt.Printf("PassRatio threshold for flaky tests: %.2f\n", maxPassRatio)
-			reports.PrintTests(os.Stdout, testReport.Results, maxPassRatio)
+			reports.PrintTests(os.Stdout, testReport.Results, maxPassRatio, false)
 		}
 
 		// Save the test results in JSON format

tools/flakeguard/reports/codebase_scanner.go

@@ -1,6 +1,7 @@
 package reports
 
 import (
+	"fmt"
 	"go/ast"
 	"go/parser"
 	"go/token"
@@ -16,33 +17,52 @@ type TestFileMap map[string]string
 func ScanTestFiles(rootDir string) (TestFileMap, error) {
 	testFileMap := make(TestFileMap)
 
-	err := filepath.Walk(rootDir, func(path string, info os.FileInfo, err error) error {
+	// Ensure rootDir is absolute
+	rootDir, err := filepath.Abs(rootDir)
+	if err != nil {
+		return nil, fmt.Errorf("error normalizing rootDir: %v", err)
+	}
+
+	// Walk through the root directory to find test files
+	err = filepath.Walk(rootDir, func(path string, info os.FileInfo, err error) error {
 		if err != nil {
 			return err
 		}
+
+		// Skip files that are not Go test files
 		if !strings.HasSuffix(path, "_test.go") {
 			return nil
 		}
 
-		// Parse the file
+		// Normalize path relative to rootDir
+		relPath, err := filepath.Rel(rootDir, path)
+		if err != nil {
+			return fmt.Errorf("error getting relative path for %s: %v", path, err)
+		}
+		relPath = filepath.ToSlash(relPath) // Ensure Unix-style paths
+
+		// Parse the Go file
 		fset := token.NewFileSet()
 		node, err := parser.ParseFile(fset, path, nil, parser.AllErrors)
 		if err != nil {
-			return err
+			return fmt.Errorf("error parsing file %s: %v", path, err)
 		}
 
-		// Traverse the AST to find test functions
+		// Traverse the AST to find test or fuzz functions
 		ast.Inspect(node, func(n ast.Node) bool {
 			funcDecl, ok := n.(*ast.FuncDecl)
 			if !ok {
 				return true
 			}
-			if strings.HasPrefix(funcDecl.Name.Name, "Test") {
-				// Add both the package and test function to the map
-				testFileMap[funcDecl.Name.Name] = path
+
+			// Match both "Test" and "Fuzz" prefixes
+			if strings.HasPrefix(funcDecl.Name.Name, "Test") || strings.HasPrefix(funcDecl.Name.Name, "Fuzz") {
+				// Add the function to the map with relative path
+				testFileMap[funcDecl.Name.Name] = relPath
 			}
 			return true
 		})
+
 		return nil
 	})
 

tools/flakeguard/reports/path_mapper.go

@@ -1,8 +1,6 @@
 package reports
 
 import (
-	"fmt"
-	"path/filepath"
 	"strings"
 )
 
@@ -30,13 +28,8 @@ func MapTestResultsToPaths(report *TestReport, rootDir string) error {
 			filePath = path
 		}
 
-		// Normalize filePath to be relative to the project root
 		if filePath != "" {
-			relFilePath, err := filepath.Rel(rootDir, filePath)
-			if err != nil {
-				return fmt.Errorf("error getting relative path: %v", err)
-			}
-			report.Results[i].TestPath = relFilePath
+			report.Results[i].TestPath = filePath
 		} else {
 			// Log or mark tests not found in the codebase
 			report.Results[i].TestPath = "NOT FOUND"

tools/flakeguard/reports/reports.go

@@ -193,6 +193,7 @@ func PrintTests(
 	w io.Writer,
 	tests []TestResult,
 	maxPassRatio float64,
+	includeCodeOwners bool, // Include code owners in the output. Set to true if test results have code owners
 ) (runs, passes, fails, skips, panickedTests, racedTests, flakyTests int) {
 	p := message.NewPrinter(language.English) // For formatting numbers
 	sortTestResults(tests)
@@ -210,19 +211,17 @@ func PrintTests(
 		"**Package**",
 		"**Package Panicked?**",
 		"**Avg Duration**",
-		"**Code Owners**",
+	}
+
+	if includeCodeOwners {
+		headers = append(headers, "**Code Owners**")
 	}
 
 	// Build test rows and summary data
 	rows := [][]string{}
 	for _, test := range tests {
 		if test.PassRatio < maxPassRatio {
-			owners := "Unknown"
-			if len(test.CodeOwners) > 0 {
-				owners = strings.Join(test.CodeOwners, ", ")
-			}
-
-			rows = append(rows, []string{
+			row := []string{
 				test.TestName,
 				fmt.Sprintf("%.2f%%", test.PassRatio*100),
 				fmt.Sprintf("%t", test.Panic),
@@ -235,8 +234,17 @@ func PrintTests(
 				test.TestPackage,
 				fmt.Sprintf("%t", test.PackagePanic),
 				avgDuration(test.Durations).String(),
-				owners,
-			})
+			}
+
+			if includeCodeOwners {
+				owners := "Unknown"
+				if len(test.CodeOwners) > 0 {
+					owners = strings.Join(test.CodeOwners, ", ")
+				}
+				row = append(row, owners)
+			}
+
+			rows = append(rows, row)
 		}
 
 		runs += test.Runs
@@ -350,7 +358,7 @@ func PrintTests(
 }
 
 // MarkdownSummary builds a summary of test results in markdown format, handy for reporting in CI and Slack
-func MarkdownSummary(w io.Writer, testReport *TestReport, maxPassRatio float64) {
+func MarkdownSummary(w io.Writer, testReport *TestReport, maxPassRatio float64, includeCodeOwners bool) {
 	var (
 		avgPassRatio = 1.0
 		testsData    = bytes.NewBuffer(nil)
@@ -401,7 +409,7 @@ func MarkdownSummary(w io.Writer, testReport *TestReport, maxPassRatio float64)
 		return
 	}
 
-	allRuns, passes, _, _, _, _, _ := PrintTests(testsData, tests, maxPassRatio)
+	allRuns, passes, _, _, _, _, _ := PrintTests(testsData, tests, maxPassRatio, includeCodeOwners)
 	if allRuns > 0 {
 		avgPassRatio = float64(passes) / float64(allRuns)
 	}
@@ -414,7 +422,7 @@ func MarkdownSummary(w io.Writer, testReport *TestReport, maxPassRatio float64)
 }
 
 // Helper function to save filtered results and logs to specified paths
-func SaveFilteredResultsAndLogs(outputResultsPath, outputLogsPath string, report *TestReport) error {
+func SaveFilteredResultsAndLogs(outputResultsPath, outputLogsPath string, report *TestReport, includeCodeOwners bool) error {
 	if outputResultsPath != "" {
 		if err := os.MkdirAll(filepath.Dir(outputResultsPath), 0755); err != nil { //nolint:gosec
 			return fmt.Errorf("error creating output directory: %w", err)
@@ -430,7 +438,7 @@ func SaveFilteredResultsAndLogs(outputResultsPath, outputLogsPath string, report
 			return fmt.Errorf("error creating markdown file: %w", err)
 		}
 		defer summaryFile.Close()
-		MarkdownSummary(summaryFile, report, 1.0)
+		MarkdownSummary(summaryFile, report, 1.0, includeCodeOwners)
 		fmt.Printf("Test results saved to %s and summary to %s\n", jsonFileName, mdFileName)
 	} else {
 		fmt.Println("No failed tests found based on the specified threshold and min pass ratio.")