org.gradle.testretry

Interface TestRetryTaskExtension

All Known Implementing Classes:

DefaultTestRetryTaskExtension

public interface TestRetryTaskExtension

Allows configuring test retry mechanics.

This extension is added with the name 'retry' to all Test tasks.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	TestRetryTaskExtension.ClassRetryCriteria The set of criteria specifying which test classes must be retried as a whole unit if retries are enabled and the test class passes the configured filter.
static interface	TestRetryTaskExtension.Filter A filter for specifying which tests may be retried.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME The name of the extension added to each test task.

Method Summary

Modifier and Type	Method and Description
void	classRetry(org.gradle.api.Action<? super TestRetryTaskExtension.ClassRetryCriteria> action) The set of criteria specifying which test classes must be retried as a whole unit if retries are enabled and the test class passes the configured filter.
void	filter(org.gradle.api.Action<? super TestRetryTaskExtension.Filter> action) The filter for specifying which tests may be retried.
TestRetryTaskExtension.ClassRetryCriteria	getClassRetry() The set of criteria specifying which test classes must be retried as a whole unit if retries are enabled and the test class passes the configured filter.
org.gradle.api.provider.Property<java.lang.Boolean>	getFailOnPassedAfterRetry() Whether tests that initially fail and then pass on retry should fail the task.
org.gradle.api.provider.Property<java.lang.Boolean>	getFailOnSkippedAfterRetry() Whether tests that initially fail and then are skipped on retry should fail the task.
TestRetryTaskExtension.Filter	getFilter() The filter for specifying which tests may be retried.
org.gradle.api.provider.Property<java.lang.Integer>	getMaxFailures() The maximum number of test failures that are allowed before retrying is disabled.
org.gradle.api.provider.Property<java.lang.Integer>	getMaxRetries() The maximum number of times to retry an individual test.

Field Detail

NAME

static final java.lang.String NAME

The name of the extension added to each test task.

See Also:

Constant Field Values

Method Detail

getFailOnPassedAfterRetry

org.gradle.api.provider.Property<java.lang.Boolean> getFailOnPassedAfterRetry()

Whether tests that initially fail and then pass on retry should fail the task.

This setting defaults to false, which results in the task not failing if all tests pass on retry.

This setting has no effect if AbstractTestTask.getIgnoreFailures() is set to true.

Returns:

whether tests that initially fails and then pass on retry should fail the task

getFailOnSkippedAfterRetry

org.gradle.api.provider.Property<java.lang.Boolean> getFailOnSkippedAfterRetry()

Whether tests that initially fail and then are skipped on retry should fail the task.

This setting defaults to true (for backward compatibility), which results in the task failing if any of tests skip on retry.

This setting has no effect if AbstractTestTask.getIgnoreFailures() is set to true.

Returns:

whether tests that initially fails and then are skipped on retry should fail the task

getMaxRetries

org.gradle.api.provider.Property<java.lang.Integer> getMaxRetries()

The maximum number of times to retry an individual test.

This setting defaults to 0, which results in no retries. Any value less than 1 disables retrying.

Returns:

the maximum number of times to retry an individual test

getMaxFailures

org.gradle.api.provider.Property<java.lang.Integer> getMaxFailures()

The maximum number of test failures that are allowed before retrying is disabled.

The count applies to each round of test execution. For example, if maxFailures is 5 and 4 tests initially fail and then 3 again on retry, this will not be considered too many failures and retrying will continue (if maxRetries > 1). If 5 or more tests were to fail initially then no retry would be attempted.

This setting defaults to 0, which results in no limit. Any value less than 1 results in no limit.

Returns:

the maximum number of test failures that are allowed before retrying is disabled

getFilter

TestRetryTaskExtension.Filter getFilter()

The filter for specifying which tests may be retried.

filter

void filter(org.gradle.api.Action<? super TestRetryTaskExtension.Filter> action)

The filter for specifying which tests may be retried.

getClassRetry

TestRetryTaskExtension.ClassRetryCriteria getClassRetry()

The set of criteria specifying which test classes must be retried as a whole unit if retries are enabled and the test class passes the configured filter.

classRetry

void classRetry(org.gradle.api.Action<? super TestRetryTaskExtension.ClassRetryCriteria> action)

The set of criteria specifying which test classes must be retried as a whole unit if retries are enabled and the test class passes the configured filter.