[TT-1834] Uses Proper JSON Naming for Flakeguard (#1502)

kalverra · web-flow · commit 74a4a66c233d · 2024-12-18T09:27:02.000-05:00
* Uses proper JSON for flakeguard

* Use proper JSON fields in decoding
diff --git a/tools/flakeguard/reports/data.go b/tools/flakeguard/reports/data.go
@@ -8,43 +8,44 @@ import (
 	"time"
 )
 
-// Data Structures
-
+// TestReport reports on the parameters and results of one to many test runs
 type TestReport struct {
-	GoProject          string
-	HeadSHA            string
-	BaseSHA            string
-	RepoURL            string
-	GitHubWorkflowName string
-	TestRunCount       int
-	RaceDetection      bool
-	ExcludedTests      []string
-	SelectedTests      []string
-	Results            []TestResult
+	GoProject          string       `json:"go_project"`
+	HeadSHA            string       `json:"head_sha"`
+	BaseSHA            string       `json:"base_sha"`
+	RepoURL            string       `json:"repo_url"`
+	GitHubWorkflowName string       `json:"github_workflow_name"`
+	TestRunCount       int          `json:"test_run_count"`
+	RaceDetection      bool         `json:"race_detection"`
+	ExcludedTests      []string     `json:"excluded_tests"`
+	SelectedTests      []string     `json:"selected_tests"`
+	Results            []TestResult `json:"results"`
 }
 
+// TestResult contains the results and outputs of a single test
 type TestResult struct {
-	TestName       string
-	TestPackage    string
-	PackagePanic   bool
-	Panic          bool
-	Timeout        bool
-	Race           bool
-	Skipped        bool
-	PassRatio      float64
-	Runs           int
-	Failures       int
-	Successes      int
-	Skips          int
-	Outputs        map[string][]string `json:"-"` // Temporary storage for outputs during test run
-	PassedOutputs  map[string][]string // Outputs for passed runs
-	FailedOutputs  map[string][]string // Outputs for failed runs
-	Durations      []time.Duration
-	PackageOutputs []string
-	TestPath       string
-	CodeOwners     []string
+	TestName       string              `json:"test_name"`
+	TestPackage    string              `json:"test_package"`
+	PackagePanic   bool                `json:"package_panic"`
+	Panic          bool                `json:"panic"`
+	Timeout        bool                `json:"timeout"`
+	Race           bool                `json:"race"`
+	Skipped        bool                `json:"skipped"`
+	PassRatio      float64             `json:"pass_ratio"`
+	Runs           int                 `json:"runs"`
+	Failures       int                 `json:"failures"`
+	Successes      int                 `json:"successes"`
+	Skips          int                 `json:"skips"`
+	Outputs        map[string][]string `json:"-"`              // Temporary storage for outputs during test run
+	PassedOutputs  map[string][]string `json:"passed_outputs"` // Outputs for passed runs
+	FailedOutputs  map[string][]string `json:"failed_outputs"` // Outputs for failed runs
+	Durations      []time.Duration     `json:"durations"`
+	PackageOutputs []string            `json:"package_outputs"`
+	TestPath       string              `json:"test_path"`
+	CodeOwners     []string            `json:"code_owners"`
 }
 
+// SummaryData contains aggregated data from a set of test results
 type SummaryData struct {
 	TotalTests     int     `json:"total_tests"`
 	PanickedTests  int     `json:"panicked_tests"`
diff --git a/tools/flakeguard/reports/io.go b/tools/flakeguard/reports/io.go
@@ -100,52 +100,52 @@ func processLargeFile(filePath string, reportChan chan<- *TestReport, errChan ch
 		}
 
 		switch fieldName {
-		case "GoProject":
+		case "go_project":
 			if err := decoder.Decode(&report.GoProject); err != nil {
 				log.Printf("Error decoding GoProject in file: %s, Error: %v", filePath, err)
 				return
 			}
-		case "HeadSHA":
+		case "head_sha":
 			if err := decoder.Decode(&report.HeadSHA); err != nil {
 				log.Printf("Error decoding HeadSHA in file: %s, Error: %v", filePath, err)
 				return
 			}
-		case "BaseSHA":
+		case "base_sha":
 			if err := decoder.Decode(&report.BaseSHA); err != nil {
 				log.Printf("Error decoding BaseSHA in file: %s, Error: %v", filePath, err)
 				return
 			}
-		case "RepoURL":
+		case "repo_url":
 			if err := decoder.Decode(&report.RepoURL); err != nil {
 				log.Printf("Error decoding RepoURL in file: %s, Error: %v", filePath, err)
 				return
 			}
-		case "GitHubWorkflowName":
+		case "github_workflow_name":
 			if err := decoder.Decode(&report.GitHubWorkflowName); err != nil {
 				log.Printf("Error decoding GitHubWorkflowName in file: %s, Error: %v", filePath, err)
 				return
 			}
-		case "TestRunCount":
+		case "test_run_count":
 			if err := decoder.Decode(&report.TestRunCount); err != nil {
 				log.Printf("Error decoding TestRunCount in file: %s, Error: %v", filePath, err)
 				return
 			}
-		case "RaceDetection":
+		case "race_detection":
 			if err := decoder.Decode(&report.RaceDetection); err != nil {
 				log.Printf("Error decoding RaceDetection in file: %s, Error: %v", filePath, err)
 				return
 			}
-		case "ExcludedTests":
+		case "excluded_tests":
 			if err := decoder.Decode(&report.ExcludedTests); err != nil {
 				log.Printf("Error decoding ExcludedTests in file: %s, Error: %v", filePath, err)
 				return
 			}
-		case "SelectedTests":
+		case "selected_tests":
 			if err := decoder.Decode(&report.SelectedTests); err != nil {
 				log.Printf("Error decoding SelectedTests in file: %s, Error: %v", filePath, err)
 				return
 			}
-		case "Results":
+		case "results":
 			token, err := decoder.Token() // Read opening bracket '['
 			if err != nil || token != json.Delim('[') {
 				log.Printf("Error reading Results array start in file: %s, Error: %v", filePath, err)
@@ -172,7 +172,7 @@ func processLargeFile(filePath string, reportChan chan<- *TestReport, errChan ch
 				log.Printf("Error skipping unknown field: %s in file: %s, Error: %v", fieldName, filePath, err)
 				return
 			}
-			log.Printf("Skipped unknown field: %s in file: %s", fieldName, filePath)
+			log.Printf("Skipped unknown field: '%s' in file: %s", fieldName, filePath)
 		}
 	}
 
diff --git a/tools/flakeguard/reports/presentation.go b/tools/flakeguard/reports/presentation.go
@@ -146,7 +146,7 @@ func GeneratePRCommentMarkdown(w io.Writer, testReport *TestReport, maxPassRatio
 	}
 
 	resultsTable := GenerateFlakyTestsTable(testReport.Results, maxPassRatio, true)
-	renderTestResultsTable(w, resultsTable, true)
+	renderTestResultsTable(w, resultsTable)
 
 	if artifactLink != "" {
 		renderArtifactSection(w, artifactName, artifactLink)
@@ -179,7 +179,7 @@ func RenderResults(
 	resultsTable := GenerateFlakyTestsTable(tests, maxPassRatio, markdown)
 	summary := GenerateSummaryData(tests, maxPassRatio)
 	renderSummaryTable(w, summary, markdown)
-	renderTestResultsTable(w, resultsTable, markdown)
+	renderTestResultsTable(w, resultsTable)
 }
 
 func renderSummaryTable(w io.Writer, summary SummaryData, markdown bool) {
@@ -209,7 +209,7 @@ func renderSummaryTable(w io.Writer, summary SummaryData, markdown bool) {
 	fmt.Fprintln(w)
 }
 
-func renderTestResultsTable(w io.Writer, table [][]string, markdown bool) {
+func renderTestResultsTable(w io.Writer, table [][]string) {
 	if len(table) <= 1 {
 		fmt.Fprintln(w, "No tests found under the specified pass ratio threshold.")
 		return

Original file line number	Diff line number	Diff line change
`@@ -100,52 +100,52 @@ func processLargeFile(filePath string, reportChan chan<- *TestReport, errChan ch`
`100`	`100`	`}`
`101`	`101`
`102`	`102`	`switch fieldName {`
`103`		`- case "GoProject":`
	`103`	`+ case "go_project":`
`104`	`104`	`if err := decoder.Decode(&report.GoProject); err != nil {`
`105`	`105`	`log.Printf("Error decoding GoProject in file: %s, Error: %v", filePath, err)`
`106`	`106`	`return`
`107`	`107`	`}`
`108`		`- case "HeadSHA":`
	`108`	`+ case "head_sha":`
`109`	`109`	`if err := decoder.Decode(&report.HeadSHA); err != nil {`
`110`	`110`	`log.Printf("Error decoding HeadSHA in file: %s, Error: %v", filePath, err)`
`111`	`111`	`return`
`112`	`112`	`}`
`113`		`- case "BaseSHA":`
	`113`	`+ case "base_sha":`
`114`	`114`	`if err := decoder.Decode(&report.BaseSHA); err != nil {`
`115`	`115`	`log.Printf("Error decoding BaseSHA in file: %s, Error: %v", filePath, err)`
`116`	`116`	`return`
`117`	`117`	`}`
`118`		`- case "RepoURL":`
	`118`	`+ case "repo_url":`
`119`	`119`	`if err := decoder.Decode(&report.RepoURL); err != nil {`
`120`	`120`	`log.Printf("Error decoding RepoURL in file: %s, Error: %v", filePath, err)`
`121`	`121`	`return`
`122`	`122`	`}`
`123`		`- case "GitHubWorkflowName":`
	`123`	`+ case "github_workflow_name":`
`124`	`124`	`if err := decoder.Decode(&report.GitHubWorkflowName); err != nil {`
`125`	`125`	`log.Printf("Error decoding GitHubWorkflowName in file: %s, Error: %v", filePath, err)`
`126`	`126`	`return`
`127`	`127`	`}`
`128`		`- case "TestRunCount":`
	`128`	`+ case "test_run_count":`
`129`	`129`	`if err := decoder.Decode(&report.TestRunCount); err != nil {`
`130`	`130`	`log.Printf("Error decoding TestRunCount in file: %s, Error: %v", filePath, err)`
`131`	`131`	`return`
`132`	`132`	`}`
`133`		`- case "RaceDetection":`
	`133`	`+ case "race_detection":`
`134`	`134`	`if err := decoder.Decode(&report.RaceDetection); err != nil {`
`135`	`135`	`log.Printf("Error decoding RaceDetection in file: %s, Error: %v", filePath, err)`
`136`	`136`	`return`
`137`	`137`	`}`
`138`		`- case "ExcludedTests":`
	`138`	`+ case "excluded_tests":`
`139`	`139`	`if err := decoder.Decode(&report.ExcludedTests); err != nil {`
`140`	`140`	`log.Printf("Error decoding ExcludedTests in file: %s, Error: %v", filePath, err)`
`141`	`141`	`return`
`142`	`142`	`}`
`143`		`- case "SelectedTests":`
	`143`	`+ case "selected_tests":`
`144`	`144`	`if err := decoder.Decode(&report.SelectedTests); err != nil {`
`145`	`145`	`log.Printf("Error decoding SelectedTests in file: %s, Error: %v", filePath, err)`
`146`	`146`	`return`
`147`	`147`	`}`
`148`		`- case "Results":`
	`148`	`+ case "results":`
`149`	`149`	`token, err := decoder.Token() // Read opening bracket '['`
`150`	`150`	`if err != nil \|\| token != json.Delim('[') {`
`151`	`151`	`log.Printf("Error reading Results array start in file: %s, Error: %v", filePath, err)`
`@@ -172,7 +172,7 @@ func processLargeFile(filePath string, reportChan chan<- *TestReport, errChan ch`
`172`	`172`	`log.Printf("Error skipping unknown field: %s in file: %s, Error: %v", fieldName, filePath, err)`
`173`	`173`	`return`
`174`	`174`	`}`
`175`		`- log.Printf("Skipped unknown field: %s in file: %s", fieldName, filePath)`
	`175`	`+ log.Printf("Skipped unknown field: '%s' in file: %s", fieldName, filePath)`
`176`	`176`	`}`
`177`	`177`	`}`
`178`	`178`