[CI] Fix inaccurate Codecov reports due to gotestsum retries

[amenasria]

What does this PR do?

This PR modifies the command gotestsum uses to run the unit tests retries leveraging the --raw-command flag (see doc) following the workaround proposed in gotestyourself/gotestsum#274.

Currently when unit tests are rerun, the coverage file coverage.out gets overwritten. The new one is created from only running a flaky unit tests subset making the coverage way smaller than it really is.

The --raw-command flag is used to run go test as well as before but targeting a different coverage.out.rerun file for each rerun.

Motivation

Inaccurate reports in Codecov.

Additional Notes

Reproduce the error

Add a failing test in pkg/collector/check/stats/stats_test.go:

import (
    ...
  	"time"
    ...
)
...
func TestCodecovFail(t *testing.T) {
	time.Sleep(2 * time.Second)
	t.Log("Failing after 2 seconds sleep !")
	assert.True(t, false)
}

Run the tests for the ./pkg/collector/check/stats module without reruns:

inv test --rerun-fails=0 --targets=./pkg/collector/check/stats --coverage

Your coverage file coverage.out should show a pretty filled coverage (scroll to the right to get the coverage percentages):

➜  go tool cover -func=coverage.out
github.com/DataDog/datadog-agent/pkg/collector/check/stats/stats.go:64:         NewSenderStats                          0.0%
github.com/DataDog/datadog-agent/pkg/collector/check/stats/stats.go:71:         Copy                                    0.0%
github.com/DataDog/datadog-agent/pkg/collector/check/stats/stats.go:122:        NewStats                                100.0%
github.com/DataDog/datadog-agent/pkg/collector/check/stats/stats.go:144:        Add                                     0.0%
github.com/DataDog/datadog-agent/pkg/collector/check/stats/stats.go:234:        translateEventTypes                     88.9%
github.com/DataDog/datadog-agent/pkg/collector/check/stats/stats.go:251:        TranslateEventPlatformEventTypes        90.0%
total:                                                                          (statements)                            25.3%

Now if you run the same tests with reruns:

inv test --rerun-fails=2 --targets=./pkg/collector/check/stats --coverage

Your coverage file coverage.out now shows an empty coverage:

➜  go tool cover -func=coverage.out                                                   
github.com/DataDog/datadog-agent/pkg/collector/check/stats/stats.go:64:         NewSenderStats                          0.0%
github.com/DataDog/datadog-agent/pkg/collector/check/stats/stats.go:71:         Copy                                    0.0%
github.com/DataDog/datadog-agent/pkg/collector/check/stats/stats.go:122:        NewStats                                0.0%
github.com/DataDog/datadog-agent/pkg/collector/check/stats/stats.go:144:        Add                                     0.0%
github.com/DataDog/datadog-agent/pkg/collector/check/stats/stats.go:234:        translateEventTypes                     0.0%
github.com/DataDog/datadog-agent/pkg/collector/check/stats/stats.go:251:        TranslateEventPlatformEventTypes        0.0%
total:                                                                          (statements)                            0.0%

Possible Drawbacks / Trade-offs

Describe how to test/QA your changes

• Checkout the branch.
• Add a failing test in pkg/collector/check/stats/stats_test.go like the Reproduce the error section.
• Now with or without reruns the coverage.out file should be the same:

inv test --rerun-fails=2 --targets=./pkg/collector/check/stats --coverage

inv test --rerun-fails=0 --targets=./pkg/collector/check/stats --coverage

➜  go tool cover -func=coverage.out                                         
github.com/DataDog/datadog-agent/pkg/collector/check/stats/stats.go:70:         NewSenderStats                          0.0%
github.com/DataDog/datadog-agent/pkg/collector/check/stats/stats.go:77:         Copy                                    0.0%
github.com/DataDog/datadog-agent/pkg/collector/check/stats/stats.go:133:        NewStats                                100.0%
github.com/DataDog/datadog-agent/pkg/collector/check/stats/stats.go:156:        Add                                     0.0%
github.com/DataDog/datadog-agent/pkg/collector/check/stats/stats.go:251:        translateEventTypes                     88.9%
github.com/DataDog/datadog-agent/pkg/collector/check/stats/stats.go:268:        TranslateEventPlatformEventTypes        90.0%
github.com/DataDog/datadog-agent/pkg/collector/check/stats/util.go:10:          calculateCheckDelay                     100.0%
total:                                                                          (statements)                            30.6%

Reviewer's Checklist

• If known, an appropriate milestone has been selected; otherwise the Triage milestone is set.
• Use the major_change label if your change either has a major impact on the code base, is impacting multiple teams or is changing important well-established internals of the Agent. This label will be use during QA to make sure each team pay extra attention to the changed behavior. For any customer facing change use a releasenote.
• A release note has been added or the changelog/no-changelog label has been applied.
• Changed code has automated tests for its functionality.
• Adequate QA/testing plan information is provided. Except if the qa/skip-qa label, with required either qa/done or qa/no-code-change labels, are applied.
• At least one team/.. label has been applied, indicating the team(s) that should QA this change.
• If applicable, docs team has been notified or an issue has been opened on the documentation repo.
• If applicable, the need-change/operator and need-change/helm labels have been applied.
• If applicable, the k8s/<min-version> label, indicating the lowest Kubernetes version compatible with this feature.
• If applicable, the config template has been updated.

[pr-commenter]

Bloop Bleep... Dogbot Here

Regression Detector Results

Run ID: bf786cf9-aca6-4ada-ab2c-24beeafc4650
Baseline: 85bcb55
Comparison: ceb1471
Total CPUs: 7

Performance changes are noted in the perf column of each table:

• ✅ = significantly better comparison variant performance
• ❌ = significantly worse comparison variant performance
• ➖ = no significant change in performance

No significant changes in experiment optimization goals

Confidence level: 90.00%
Effect size tolerance: |Δ mean %| ≥ 5.00%

There were no significant changes in experiment optimization goals at this confidence level and effect size tolerance.

Experiments ignored for regressions

Regressions in experiments with settings containing erratic: true are ignored.

perf	experiment	goal	Δ mean %	Δ mean % CI
➖	file_to_blackhole	% cpu utilization	+1.16	[-5.46, +7.79]
➖	file_tree	memory utilization	+0.40	[+0.35, +0.46]
➖	idle	memory utilization	-0.21	[-0.24, -0.18]

Fine details of change detection per experiment

perf	experiment	goal	Δ mean %	Δ mean % CI
➖	file_to_blackhole	% cpu utilization	+1.16	[-5.46, +7.79]
➖	file_tree	memory utilization	+0.40	[+0.35, +0.46]
➖	tcp_syslog_to_blackhole	ingress throughput	+0.14	[+0.09, +0.19]
➖	trace_agent_msgpack	ingress throughput	+0.07	[+0.05, +0.08]
➖	trace_agent_json	ingress throughput	+0.01	[-0.02, +0.04]
➖	uds_dogstatsd_to_api	ingress throughput	+0.00	[-0.03, +0.03]
➖	tcp_dd_logs_filter_exclude	ingress throughput	+0.00	[-0.06, +0.06]
➖	idle	memory utilization	-0.21	[-0.24, -0.18]
➖	process_agent_standard_check_with_stats	memory utilization	-0.22	[-0.26, -0.18]
➖	process_agent_real_time_mode	memory utilization	-0.23	[-0.26, -0.20]
➖	process_agent_standard_check	memory utilization	-0.41	[-0.46, -0.36]
➖	uds_dogstatsd_to_api_cpu	% cpu utilization	-1.47	[-2.88, -0.05]
➖	otel_to_otel_logs	ingress throughput	-1.47	[-2.20, -0.75]

Explanation

A regression test is an A/B test of target performance in a repeatable rig, where "performance" is measured as "comparison variant minus baseline variant" for an optimization goal (e.g., ingress throughput). Due to intrinsic variability in measuring that goal, we can only estimate its mean value for each experiment; we report uncertainty in that value as a 90.00% confidence interval denoted "Δ mean % CI".

For each experiment, we decide whether a change in performance is a "regression" -- a change worth investigating further -- if all of the following criteria are true:

1. Its estimated |Δ mean %| ≥ 5.00%, indicating the change is big enough to merit a closer look.

2. Its 90.00% confidence interval "Δ mean % CI" does not contain zero, indicating that if our statistical model is accurate, there is at least a 90.00% chance there is a difference in performance between baseline and comparison variants.

3. Its configuration does not mark it "erratic".

[amenasria]

/merge

[dd-devflow]

🚂 MergeQueue

Pull request added to the queue.

This build is next! (estimated merge in less than 47m)

Use /merge -c to cancel this operation!

[dd-devflow]

❌ MergeQueue

Tests failed on this commit 3c28d24

You should fix those tests and then re-add your pull request to the queue!

Details

checks are failing:

• windows-unit-tests

If you need support, contact us on Slack #ci-interfaces with those details!

[amenasria]

/merge

[dd-devflow]

🚂 MergeQueue

Pull request added to the queue.

There are 3 builds ahead! (estimated merge in less than 1h)

Use /merge -c to cancel this operation!