Batches Splunk calls

Author: kalverra

tools/flakeguard/Makefile

@@ -8,6 +8,12 @@ test:
 	set -euo pipefail
 	go list ./... | grep -v 'example_test_package' | xargs go test -json -cover -coverprofile unit-test-coverage.out -v 2>&1 | tee /tmp/gotest.log | gotestfmt
 
+.PHONY: test-package
+test-package:
+	go install github.com/gotesttools/gotestfmt/v2/cmd/gotestfmt@latest
+	set -euo pipefail
+	go test -json -cover -coverprofile unit-test-coverage.out -v $(PKG) 2>&1 | tee /tmp/gotest.log | gotestfmt
+
 .PHONY: test-race
 test-race:
 	go list ./... | grep -v 'example_test_package' | xargs go test -count=1 -race

tools/flakeguard/go.mod

@@ -10,7 +10,6 @@ require (
 	github.com/rs/zerolog v1.33.0
 	github.com/spf13/cobra v1.8.1
 	golang.org/x/oauth2 v0.24.0
-	golang.org/x/sync v0.9.0
 	golang.org/x/text v0.20.0
 )
 

tools/flakeguard/go.sum

@@ -42,8 +42,6 @@ golang.org/x/net v0.27.0 h1:5K3Njcw06/l2y9vpGCSdcxWOYHOUk3dVNGDXN+FvAys=
 golang.org/x/net v0.27.0/go.mod h1:dDi0PyhWNoiUOrAS8uXv/vnScO4wnHQO4mj9fn/RytE=
 golang.org/x/oauth2 v0.24.0 h1:KTBBxWqUa0ykRPLtV69rRto9TLXcqYkeswu48x/gvNE=
 golang.org/x/oauth2 v0.24.0/go.mod h1:XYTD2NtWslqkgxebSiOHnXEap4TF09sJSc7H1sXbhtI=
-golang.org/x/sync v0.9.0 h1:fEo0HyrW1GIgZdpbhCRO0PkJajUS5H9IFUztCgEo2jQ=
-golang.org/x/sync v0.9.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
 golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=

tools/flakeguard/reports/data.go

@@ -6,25 +6,22 @@ import (
 	"sort"
 	"strings"
 	"time"
-
-	"github.com/go-resty/resty/v2"
-	"github.com/rs/zerolog/log"
-	"golang.org/x/sync/errgroup"
 )
 
 // TestReport reports on the parameters and results of one to many test runs
 type TestReport struct {
-	ID                 string       `json:"id"`
-	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,omitempty"`
+	ID                   string       `json:"id"`
+	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"`
+	GitHubWorkflowRunURL string       `json:"github_workflow_run_url"`
+	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,omitempty"`
 }
 
 // TestResult contains the results and outputs of a single test
@@ -86,25 +83,31 @@ const (
 
 	// https://docs.splunk.com/Splexicon:Sourcetype
 	SplunkSourceType = "flakeguard_json"
+	// https://docs.splunk.com/Splexicon:Index
+	SplunkIndex = "github_flakeguard_runs"
 )
 
 // SplunkTestReport is the full wrapper structure sent to Splunk for the full test report (sans results)
 type SplunkTestReport struct {
 	Event      SplunkTestReportEvent `json:"event"`      // https://docs.splunk.com/Splexicon:Event
 	SourceType string                `json:"sourcetype"` // https://docs.splunk.com/Splexicon:Sourcetype
+	Index      string                `json:"index"`      // https://docs.splunk.com/Splexicon:Index
 }
 
 // SplunkTestReportEvent contains the actual meat of the Splunk test report event
 type SplunkTestReportEvent struct {
 	Event SplunkEvent `json:"event"`
 	Type  SplunkType  `json:"type"`
 	Data  TestReport  `json:"data"`
+	// Incomplete indicates that there were issues uploading test results and the report is incomplete
+	Incomplete bool `json:"incomplete"`
 }
 
 // SplunkTestResult is the full wrapper structure sent to Splunk for a single test result
 type SplunkTestResult struct {
 	Event      SplunkTestResultEvent `json:"event"`      // https://docs.splunk.com/Splexicon:Event
 	SourceType string                `json:"sourcetype"` // https://docs.splunk.com/Splexicon:Sourcetype
+	Index      string                `json:"index"`      // https://docs.splunk.com/Splexicon:Index
 }
 
 // SplunkTestResultEvent contains the actual meat of the Splunk test result event
@@ -185,158 +188,6 @@ func FilterTests(results []TestResult, predicate func(TestResult) bool) []TestRe
 	return filtered
 }
 
-func aggregate(reportChan <-chan *TestReport, errChan <-chan error, opts *aggregateOptions) (*TestReport, error) {
-	var (
-		testMap       = make(map[string]TestResult)
-		fullReport    = &TestReport{}
-		excludedTests = map[string]struct{}{}
-		selectedTests = map[string]struct{}{}
-		sendToSplunk  = opts.splunkURL != ""
-	)
-
-	fullReport.ID = opts.reportID
-	for report := range reportChan {
-		if fullReport.GoProject == "" {
-			fullReport.GoProject = report.GoProject
-		} else if fullReport.GoProject != report.GoProject {
-			return nil, fmt.Errorf("reports with different Go projects found, expected %s, got %s", fullReport.GoProject, report.GoProject)
-		}
-		fullReport.TestRunCount += report.TestRunCount
-		fullReport.RaceDetection = report.RaceDetection && fullReport.RaceDetection
-		for _, test := range report.ExcludedTests {
-			excludedTests[test] = struct{}{}
-		}
-		for _, test := range report.SelectedTests {
-			selectedTests[test] = struct{}{}
-		}
-		for _, result := range report.Results {
-			result.ReportID = opts.reportID
-			key := result.TestName + "|" + result.TestPackage
-			if existing, found := testMap[key]; found {
-				existing = mergeTestResults(existing, result)
-				testMap[key] = existing
-			} else {
-				testMap[key] = result
-			}
-		}
-	}
-
-	for err := range errChan {
-		return nil, err
-	}
-
-	// Finalize excluded and selected tests
-	for test := range excludedTests {
-		fullReport.ExcludedTests = append(fullReport.ExcludedTests, test)
-	}
-	for test := range selectedTests {
-		fullReport.SelectedTests = append(fullReport.SelectedTests, test)
-	}
-
-	// Send report to Splunk before adding test results
-	if sendToSplunk {
-		err := sendReportToSplunk(opts.splunkURL, opts.splunkToken, opts.splunkEvent, fullReport)
-		if err != nil {
-			log.Error().Err(err).Msg("Error sending report to Splunk")
-		} else {
-			log.Debug().Str("event", string(opts.splunkEvent)).Msg("Successfully sent report sent to Splunk")
-		}
-	}
-
-	// Prepare final results
-	eg := errgroup.Group{}
-	var aggregatedResults []TestResult
-	for _, r := range testMap {
-		result := r
-		aggregatedResults = append(aggregatedResults, result)
-		if sendToSplunk {
-			eg.Go(func() error {
-				return sendResultsToSplunk(opts.splunkURL, opts.splunkToken, opts.splunkEvent, result)
-			})
-		}
-	}
-
-	sortTestResults(aggregatedResults)
-	fullReport.Results = aggregatedResults
-
-	if sendToSplunk {
-		if splunkErr := eg.Wait(); splunkErr != nil {
-			log.Error().Err(splunkErr).Msg("Error sending results to Splunk")
-		} else {
-			log.Debug().Str("event", string(opts.splunkEvent)).Msg("Successfully sent results to Splunk")
-		}
-	}
-	return fullReport, nil
-}
-
-// sendReportToSplunk sends meta test report data to Splunk
-func sendReportToSplunk(url, token string, event SplunkEvent, report *TestReport) error {
-	client := resty.New()
-	client.AddRetryAfterErrorCondition().SetRetryCount(3).SetRetryWaitTime(5 * time.Second)
-	resp, err := client.R().
-		SetHeader("Authorization", fmt.Sprintf("Splunk %s", token)).
-		SetHeader("Content-Type", "application/json").
-		SetBody(SplunkTestReport{
-			Event: SplunkTestReportEvent{
-				Event: event,
-				Type:  Report,
-				Data:  *report,
-			},
-			SourceType: SplunkSourceType,
-		}).
-		Post(url)
-	if err != nil {
-		return err
-	}
-	if resp.IsError() {
-		return fmt.Errorf("error sending report to Splunk: %s", resp.String())
-	}
-	return nil
-}
-
-func sendResultsToSplunk(url, token string, event SplunkEvent, results ...TestResult) error {
-	client := resty.New()
-	client.AddRetryAfterErrorCondition().SetRetryCount(3).SetRetryWaitTime(5 * time.Second)
-	eg := errgroup.Group{}
-	for _, r := range results {
-		result := r
-		eg.Go(func() error {
-			resp, err := client.R().
-				SetHeader("Authorization", fmt.Sprintf("Splunk %s", token)).
-				SetHeader("Content-Type", "application/json").
-				SetBody(SplunkTestResult{
-					Event: SplunkTestResultEvent{
-						Event: event,
-						Type:  Result,
-						Data:  result,
-					},
-					SourceType: SplunkSourceType,
-				}).
-				Post(url)
-			if err != nil {
-				return err
-			}
-			if resp.IsError() {
-				return fmt.Errorf("error sending result to Splunk: %s", resp.String())
-			}
-			return nil
-		})
-	}
-
-	return eg.Wait()
-}
-
-func aggregateFromReports(opts *aggregateOptions, reports ...*TestReport) (*TestReport, error) {
-	reportChan := make(chan *TestReport, len(reports))
-	errChan := make(chan error, 1)
-	for _, report := range reports {
-		reportChan <- report
-	}
-	close(reportChan)
-	close(errChan)
-	return aggregate(reportChan, errChan, opts)
-}
-
 func mergeTestResults(a, b TestResult) TestResult {
 	a.Runs += b.Runs
 	a.Durations = append(a.Durations, b.Durations...)