Uses proper JSON for flakeguard

Author: kalverra

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"`

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