Auto Test Retries

Documentos > Optimización de tests en Datadog > Working with Flaky Tests > Auto Test Retries

This page is not yet available in Spanish. We are working on its translation.
If you have any questions or feedback about our current translation project, feel free to reach out to us!

Overview

Test Optimization’s Auto Test Retries feature allows retrying failing tests up to N times to avoid failing your build due to flaky tests: a failing test case is retried either until it passes successfully or until there are no more retry attempts left (in which case the build fails).

Setup

Ensure Test Optimization is configured for your test runs.

Compatibility

dd-trace-java >= 1.34.0

The test framework compatibility is the same as Test Optimization Compatibility, with the exception of Scala Weaver.

Configuration

After you have set up Test Optimization, you can configure Auto Test Retries from the Test Service Settings page.

Auto Test Retries in Test Service Settings.

The default behavior of the feature is to retry any failing test case up to 5 times. This behavior can be fine-tuned with the following environment variables:

DD_CIVISIBILITY_FLAKY_RETRY_ONLY_KNOWN_FLAKES - if this environment variable is set to true, only the test cases that Test Optimization considers flaky are retried.
DD_CIVISIBILITY_FLAKY_RETRY_COUNT - can be set to any non-negative number to change the maximum number of retries per test case.

Compatibility

dd-trace-js >= v5.19.0 and dd-trace-js >= v4.43.0

Configuration

After you have set up Test Optimization, you can configure Auto Test Retries from the Test Service Settings page.

The default behavior of the feature is to retry any failing test case up to 5 times. This behavior can be fine-tuned with the following environment variables:

DD_CIVISIBILITY_FLAKY_RETRY_ENABLED - set to 0 or false to explicitly disable retries even if the remote setting is enabled (default: true).
DD_CIVISIBILITY_FLAKY_RETRY_COUNT - a non-negative number to change the maximum number of retries per test case (default: 5).

Failed Test Replay

In addition to automatically retrying failed tests, Failed Test Replay allows you to see local variable data in the topmost frame of the test error’s stack trace. Enable this feature with the Failed Test Replay toggle.

Create a logs index

Failed Test Replay creates logs that are sent to Datadog and appear alongside your regular application logs.

If you use Exclusion filters, ensure Failed Test Replay logs are not filtered:

Create a logs index and configure it to the desired retention with no sampling.
Set the filter to match on the source:dd_debugger tag. All Failed Test Replay logs have this source.
Ensure that the new index takes precedence over any other index with filters that match that tag, because the first match wins.

After you enable this feature, you can see local variable data in failed tests:

Known limitations

jest-image-snapshot is incompatible with jest.retryTimes unless customSnapshotIdentifier is passed (see jest-image-snapshot docs) to toMatchImageSnapshot. Therefore, auto test retries do not work unless customSnapshotIdentifier is used.

Compatibility

datadog-ci-rb >= 1.4.0

Configuration

After you have set up Test Optimization, you can configure Auto Test Retries from the Test Service Settings page.

The default behavior of the feature is to retry any failing test case up to 5 times. This behavior can be fine-tuned with the following environment variables:

DD_CIVISIBILITY_FLAKY_RETRY_ENABLED - set to 0 or false to explicitly disable retries even if the remote setting is enabled (default: true)
DD_CIVISIBILITY_FLAKY_RETRY_COUNT - a non-negative number to change the maximum number of retries per test case (default: 5).
DD_CIVISIBILITY_TOTAL_FLAKY_RETRY_COUNT - a non-negative number to set the maximum total number of failed tests to retry (default: 1000)

Compatibility

dd-trace-dotnet >= 3.4.0

Configuration

After you set up Test Visibility, you can configure Auto Test Retries from the Test Service Settings page.

Auto Test Retries enabled in Test Service Settings.

By default, the feature retries any failing test case up to 5 times. Customize the Auto Test Retries with the following environment variables:

DD_CIVISIBILITY_FLAKY_RETRY_ENABLED - set to 0 or false to explicitly disable retries even if the remote setting is enabled (default: true)
DD_CIVISIBILITY_FLAKY_RETRY_COUNT - a non-negative number to change the maximum number of retries per test case (default: 5).
DD_CIVISIBILITY_TOTAL_FLAKY_RETRY_COUNT - a non-negative number to set the maximum total number of failed tests to retry (default: 1000)

Compatibility

orchestrion >= 0.9.4 + dd-trace-go >= 1.69.1

Configuration

After you set up Test Visibility, you can configure Auto Test Retries from the Test Service Settings page.

By default, the feature retries each failing test case up to 5 times. Customize the Auto Test Retries with the following environment variables:

DD_CIVISIBILITY_FLAKY_RETRY_ENABLED - set to 0 or false to explicitly disable retries even if the remote setting is enabled (default: true)
DD_CIVISIBILITY_FLAKY_RETRY_COUNT - a non-negative number to change the maximum number of retries per test case (default: 5).
DD_CIVISIBILITY_TOTAL_FLAKY_RETRY_COUNT - a non-negative number to set the maximum total number of failed tests to retry (default: 1000)

Compatibility

dd-trace-py >= 3.0.0 (pytest >= 7.2.0)

Configuration

After you have set up Test Optimization, you can configure Auto Test Retries from the Test Service Settings page.

The default behavior of the feature is to retry any failing test case up to five times. Tests that originally fail either the original setup, teardown, or fixtures in Pytest, are not retried.

You can fine tune this behavior with the following environment variables:

DD_CIVISIBILITY_FLAKY_RETRY_ENABLED - set to 0 or false to explicitly disable retries even if the remote setting is enabled (default: true)
DD_CIVISIBILITY_FLAKY_RETRY_COUNT - a non-negative number to change the maximum number of retries per test case (default: 5).
DD_CIVISIBILITY_TOTAL_FLAKY_RETRY_COUNT - a non-negative number to set the maximum total number of failed tests to retry (default: 1000)

Compatibility

dd-sdk-swift-testing >= 2.5.2

Configuration

After you have set up Test Optimization, you can configure Auto Test Retries from the Test Service Settings page.

The default behavior of the feature is to retry any failing test case up to 5 times. This behavior can be fine-tuned with the following environment variables:

DD_CIVISIBILITY_FLAKY_RETRY_ENABLED - set to 0 or false to explicitly disable retries even if the remote setting is enabled (default: true)
DD_CIVISIBILITY_FLAKY_RETRY_COUNT - a non-negative number to change the maximum number of retries per test case (default: 5).
DD_CIVISIBILITY_TOTAL_FLAKY_RETRY_COUNT - a non-negative number to set the maximum total number of failed tests to retry (default: 1000)

Explore results in the Test Optimization Explorer

You can query the retried tests in the Test Optimization Explorer: they have the @test.is_retry tag set to true (some of them may also have the @test.is_new set to true, which indicates they have been retried by the Early Flakiness Detection feature).

Troubleshooting

If you suspect there are any issues with Auto Test Retries, navigate to the Test Service Settings page, look for your test service, and click Configure. Disable Auto Test Retries by clicking on the toggle.