Update send-to-splunk cmd

Author: lukaszcl

tools/flakeguard/cmd/send_to_splunk.go

@@ -19,6 +19,16 @@ var SendToSplunkCmd = &cobra.Command{
 		splunkToken, _ := cmd.Flags().GetString("splunk-token")
 		splunkEvent, _ := cmd.Flags().GetString("splunk-event")
 		failLogsURL, _ := cmd.Flags().GetString("failed-logs-url")
+		repoURL, _ := cmd.Flags().GetString("repo-url")
+		branchName, _ := cmd.Flags().GetString("branch-name")
+		headSHA, _ := cmd.Flags().GetString("head-sha")
+		baseSHA, _ := cmd.Flags().GetString("base-sha")
+		githubWorkflowName, _ := cmd.Flags().GetString("github-workflow-name")
+		githubWorkflowRunURL, _ := cmd.Flags().GetString("github-workflow-run-url")
+		reportID, _ := cmd.Flags().GetString("report-id")
+		genReportID, _ := cmd.Flags().GetBool("gen-report-id")
+		repoPath, _ := cmd.Flags().GetString("repo-path")
+		codeownersPath, _ := cmd.Flags().GetString("codeowners-path")
 
 		// Read the report file.
 		data, err := os.ReadFile(reportPath)
@@ -33,12 +43,49 @@ var SendToSplunkCmd = &cobra.Command{
 			log.Error().Err(err).Msg("Error unmarshalling report JSON")
 			os.Exit(1)
 		}
+		testReport.GenerateSummaryData()
 
+		// Override report fields with flags if provided.
+		if repoURL != "" {
+			testReport.RepoURL = repoURL
+		}
+		if branchName != "" {
+			testReport.BranchName = branchName
+		}
+		if headSHA != "" {
+			testReport.HeadSHA = headSHA
+		}
+		if baseSHA != "" {
+			testReport.BaseSHA = baseSHA
+		}
+		if githubWorkflowName != "" {
+			testReport.GitHubWorkflowName = githubWorkflowName
+		}
+		if githubWorkflowRunURL != "" {
+			testReport.GitHubWorkflowRunURL = githubWorkflowRunURL
+		}
+		if reportID != "" {
+			testReport.SetReportID(reportID)
+		}
+		if genReportID {
+			testReport.SetRandomReportID()
+		}
+		if repoPath != "" {
+			err = reports.MapTestResultsToPaths(&testReport, repoPath)
+			if err != nil {
+				log.Error().Err(err).Msg("Error mapping test results to paths")
+				os.Exit(1)
+			}
+		}
+		if codeownersPath != "" && repoPath != "" {
+			reports.MapTestResultsToOwners(&testReport, codeownersPath)
+		}
 		if failLogsURL != "" {
 			testReport.FailedLogsURL = failLogsURL
 		}
 
-		err = reports.SendReportToSplunk(splunkURL, splunkToken, splunkEvent, testReport)
+		// Send the test report to Splunk.
+		err = reports.SendTestReportToSplunk(splunkURL, splunkToken, splunkEvent, testReport)
 		if err != nil {
 			log.Error().Err(err).Msg("Error sending test report to Splunk")
 			os.Exit(1)
@@ -55,6 +102,16 @@ func init() {
 	SendToSplunkCmd.Flags().String("splunk-url", "", "Optional URL to send the test results to Splunk")
 	SendToSplunkCmd.Flags().String("splunk-token", "", "Optional Splunk HEC token to send the test results")
 	SendToSplunkCmd.Flags().String("splunk-event", "", "Optional Splunk event to send as the triggering event for the test results")
+	SendToSplunkCmd.Flags().String("repo-url", "", "The repository URL")
+	SendToSplunkCmd.Flags().String("branch-name", "", "Branch name for the test report")
+	SendToSplunkCmd.Flags().String("head-sha", "", "Head commit SHA for the test report")
+	SendToSplunkCmd.Flags().String("base-sha", "", "Base commit SHA for the test report")
+	SendToSplunkCmd.Flags().String("github-workflow-name", "", "GitHub workflow name for the test report")
+	SendToSplunkCmd.Flags().String("github-workflow-run-url", "", "GitHub workflow run URL for the test report")
+	SendToSplunkCmd.Flags().String("report-id", "", "Optional identifier for the test report. Will be generated if not provided")
+	SendToSplunkCmd.Flags().StringP("repo-path", "", ".", "The path to the root of the repository/project")
+	SendToSplunkCmd.Flags().StringP("codeowners-path", "", "", "Path to the CODEOWNERS file")
+	SendToSplunkCmd.Flags().Bool("gen-report-id", false, "Generate a random report ID")
 
 	// Mark required flags.
 	if err := SendToSplunkCmd.MarkFlagRequired("report-path"); err != nil {

tools/flakeguard/reports/data.go

@@ -10,6 +10,8 @@ import (
 	"sort"
 	"strings"
 	"time"
+
+	"github.com/google/uuid"
 )
 
 // TestReport reports on the parameters and results of one to many test runs
@@ -33,6 +35,22 @@ type TestReport struct {
 	MaxPassRatio float64 `json:"max_pass_ratio,omitempty"`
 }
 
+func (r *TestReport) SetRandomReportID() {
+	uuid, err := uuid.NewRandom()
+	if err != nil {
+		panic(fmt.Errorf("error generating random report id: %w", err))
+	}
+	r.SetReportID(uuid.String())
+}
+
+func (r *TestReport) SetReportID(reportID string) {
+	r.ID = reportID
+	// Set the report ID in all test results
+	for i := range r.Results {
+		r.Results[i].ReportID = r.ID
+	}
+}
+
 // SaveToFile saves the test report to a JSON file at the given path.
 // It returns an error if there's any issue with marshaling the report or writing to the file.
 func (testReport *TestReport) SaveToFile(outputPath string) error {

tools/flakeguard/reports/io.go

@@ -8,7 +8,6 @@ import (
 	"os"
 	"path/filepath"
 
-	"github.com/google/uuid"
 	"github.com/rs/zerolog/log"
 )
 
@@ -157,19 +156,14 @@ func LoadAndAggregate(resultsPath string, options ...AggregateOption) (*TestRepo
 		}
 	}()
 
-	if opts.reportID == "" {
-		uuid, err := uuid.NewRandom()
-		if err != nil {
-			return nil, fmt.Errorf("error generating UUID: %w", err)
-		}
-		opts.reportID = uuid.String()
-	}
-
 	// Aggregate results as they are being loaded
 	aggregatedReport, err := aggregate(reportChan, errChan, &opts)
 	if err != nil {
 		return nil, fmt.Errorf("error aggregating reports: %w", err)
 	}
+	if opts.reportID == "" {
+		aggregatedReport.SetRandomReportID()
+	}
 
 	// Map test results to test paths
 	err = MapTestResultsToPaths(aggregatedReport, opts.repoPath)

tools/flakeguard/reports/io_test.go

@@ -69,7 +69,7 @@ func TestAggregateResultFilesSplunk(t *testing.T) {
 	report, err := LoadAndAggregate("./testdata", WithReportID(reportID))
 	require.NoError(t, err, "LoadAndAggregate failed")
 
-	err = SendReportToSplunk(srv.URL, splunkToken, splunkEvent, *report)
+	err = SendTestReportToSplunk(srv.URL, splunkToken, splunkEvent, *report)
 	require.NoError(t, err, "SendReportToSplunk failed")
 	verifyAggregatedReport(t, report)
 	assert.Equal(t, 1, reportRequestsReceived, "unexpected number of report requests")

tools/flakeguard/reports/splunk.go

@@ -16,8 +16,8 @@ import (
 	"github.com/rs/zerolog/log"
 )
 
-// SendReportToSplunk sends a truncated TestReport and each individual TestResults to Splunk as events
-func SendReportToSplunk(splunkURL, splunkToken, splunkEvent string, report TestReport) error {
+// SendTestReportToSplunk sends a truncated TestReport and each individual TestResults to Splunk as events
+func SendTestReportToSplunk(splunkURL, splunkToken, splunkEvent string, report TestReport) error {
 	start := time.Now()
 	results := report.Results
 	report.Results = nil // Don't send results to Splunk, doing that individually
@@ -117,6 +117,9 @@ func SendReportToSplunk(splunkURL, splunkToken, splunkEvent string, report TestR
 		log.Info().Msg("Example Run. See 'example_results/splunk_results' for the results that would be sent to splunk")
 	}
 
+	// Sanitize report fields
+	report.BranchName = strings.TrimSpace(report.BranchName)
+
 	reportData := SplunkTestReport{
 		Event: SplunkTestReportEvent{
 			Event:      splunkEvent,