Fixes

Author: kalverra

tools/flakeguard/cmd/aggregate_results.go

@@ -50,5 +50,5 @@ func init() {
 	AggregateResultsCmd.Flags().StringVarP(&outputResultsPath, "output-results", "o", "./results.json", "Path to output the aggregated or filtered test results in JSON format")
 	AggregateResultsCmd.Flags().StringVarP(&outputLogsPath, "output-logs", "l", "", "Path to output the filtered test logs in JSON format")
 	AggregateResultsCmd.Flags().Float64VarP(&maxPassRatio, "max-pass-ratio", "m", 1.0, "The maximum (non-inclusive) pass ratio threshold for a test to be considered a failure. Any tests below this pass rate will be considered flaky.")
-	AggregateResultsCmd.Flags().BoolVarP(&filterFailed, "filter-failed", "f", false, "If true, filter and output only failed tests based on the min-pass-ratio threshold")
+	AggregateResultsCmd.Flags().BoolVarP(&filterFailed, "filter-failed", "f", false, "If true, filter and output only failed tests based on the max-pass-ratio threshold")
 }

tools/flakeguard/cmd/run.go

@@ -23,10 +23,9 @@ var RunTestsCmd = &cobra.Command{
 		runCount, _ := cmd.Flags().GetInt("run-count")
 		useRace, _ := cmd.Flags().GetBool("race")
 		outputPath, _ := cmd.Flags().GetString("output-json")
-		threshold, _ := cmd.Flags().GetFloat64("threshold")
+		maxPassRatio, _ := cmd.Flags().GetFloat64("max-pass-ratio")
 		skipTests, _ := cmd.Flags().GetStringSlice("skip-tests")
 		printFailedTests, _ := cmd.Flags().GetBool("print-failed-tests")
-		minPassRatio, _ := cmd.Flags().GetFloat64("min-pass-ratio")
 
 		// Check if project dependencies are correctly set up
 		if err := checkDependencies(projectPath); err != nil {
@@ -59,15 +58,15 @@ var RunTestsCmd = &cobra.Command{
 			os.Exit(1)
 		}
 
-		passedTests := reports.FilterPassedTests(testResults, threshold)
-		failedTests := reports.FilterFailedTests(testResults, threshold)
+		passedTests := reports.FilterPassedTests(testResults, maxPassRatio)
+		failedTests := reports.FilterFailedTests(testResults, maxPassRatio)
 		skippedTests := reports.FilterSkippedTests(testResults)
-		flakyTests := reports.FilterFlakyTests(testResults, minPassRatio, threshold)
+		flakyTests := reports.FilterFlakyTests(testResults, maxPassRatio)
 
 		// Print all failed tests including flaky tests
 		if len(failedTests) > 0 && printFailedTests {
-			fmt.Printf("MinPassRatio threshold for flaky tests: %.2f\n", minPassRatio)
-			fmt.Printf("PassRatio threshold for flaky tests: %.2f\n", threshold)
+			fmt.Printf("Maximum threshold for flaky tests: %.2f\n", maxPassRatio)
+			fmt.Printf("PassRatio threshold for flaky tests: %.2f\n", maxPassRatio)
 			fmt.Printf("%d failed tests:\n", len(failedTests))
 			reports.PrintTests(failedTests, os.Stdout)
 		}
@@ -104,10 +103,9 @@ func init() {
 	RunTestsCmd.Flags().Bool("race", false, "Enable the race detector")
 	RunTestsCmd.Flags().Bool("fail-fast", false, "Stop on the first test failure")
 	RunTestsCmd.Flags().String("output-json", "", "Path to output the test results in JSON format")
-	RunTestsCmd.Flags().Float64("threshold", 0.8, "Threshold for considering a test as flaky")
 	RunTestsCmd.Flags().StringSlice("skip-tests", nil, "Comma-separated list of test names to skip from running")
 	RunTestsCmd.Flags().Bool("print-failed-tests", true, "Print failed test results to the console")
-	RunTestsCmd.Flags().Float64("min-pass-ratio", 0.001, "Minimum pass ratio for considering a test as flaky. Used to distinguish between tests that are truly flaky (with inconsistent results) and those that are consistently failing.")
+	RunTestsCmd.Flags().Float64("max-pass-ratio", 1.0, "The maximum (non-inclusive) pass ratio threshold for a test to be considered a failure. Any tests below this pass rate will be considered flaky.")
 }
 
 func checkDependencies(projectPath string) error {

tools/flakeguard/reports/reports.go

@@ -33,32 +33,32 @@ type TestResult struct {
 }
 
 // FilterFailedTests returns a slice of TestResult where the pass ratio is below the specified threshold.
-func FilterFailedTests(results []TestResult, threshold float64) []TestResult {
+func FilterFailedTests(results []TestResult, maxPassRatio float64) []TestResult {
 	var failedTests []TestResult
 	for _, result := range results {
-		if !result.Skipped && result.PassRatio < threshold {
+		if !result.Skipped && result.PassRatio < maxPassRatio {
 			failedTests = append(failedTests, result)
 		}
 	}
 	return failedTests
 }
 
 // FilterFlakyTests returns a slice of TestResult where the pass ratio is between the min pass ratio and the threshold.
-func FilterFlakyTests(testResults []TestResult, minPassRatio, threshold float64) []TestResult {
+func FilterFlakyTests(testResults []TestResult, maxPassRatio float64) []TestResult {
 	var flakyTests []TestResult
 	for _, test := range testResults {
-		if test.PassRatio >= minPassRatio && test.PassRatio < threshold && !test.Skipped {
+		if test.PassRatio < maxPassRatio && !test.Skipped {
 			flakyTests = append(flakyTests, test)
 		}
 	}
 	return flakyTests
 }
 
 // FilterPassedTests returns a slice of TestResult where the tests passed and were not skipped.
-func FilterPassedTests(results []TestResult, threshold float64) []TestResult {
+func FilterPassedTests(results []TestResult, maxPassRatio float64) []TestResult {
 	var passedTests []TestResult
 	for _, result := range results {
-		if !result.Skipped && result.PassRatio >= threshold {
+		if !result.Skipped && result.PassRatio >= maxPassRatio {
 			passedTests = append(passedTests, result)
 		}
 	}
@@ -142,7 +142,6 @@ func AggregateTestResults(folderPath string) ([]TestResult, error) {
 }
 
 // PrintTests prints tests in a pretty format
-// TODO: Update this with new fields
 func PrintTests(tests []TestResult, w io.Writer) {
 	for i, test := range tests {
 		fmt.Fprintf(w, "\n--- Test %d ---\n", i+1)
@@ -184,7 +183,7 @@ func SaveFilteredResultsAndLogs(outputResultsPath, outputLogsPath string, failed
 	}
 }
 
-// Helper function to save results to JSON file
+// Helper function to save results to JSON file without outputs
 func saveResults(filePath string, results []TestResult) error {
 	var filteredResults []TestResult
 	for _, r := range results {