net.openhft.chronicle.testframework

Interface FlakyTestRunner.Builder<X extends Throwable>

Type Parameters:

X - Type of exception that can be thrown by the runnable object

Enclosing class:

FlakyTestRunner

public static interface FlakyTestRunner.Builder<X extends Throwable>

Defines the interface for constructing and configuring a flaky test runner.

A flaky test runner is used to handle test cases that might fail intermittently. The builder allows for configuring various aspects of the runner such as the maximum number of iterations before failure, the delay between iterations, garbage collection between iterations, and custom loggers for informational and error messages.

Example usage:

 Builder<Exception> builder = FlakyTestRunner.builder(action);
 builder.withMaxIterations(3)
        .withIterationDelay(1000)
        .withInfoLogger(myInfoLogger)
        .withErrorLogger(myErrorLogger)
        .build()
        .runOrThrow();
 

See Also:

FlakyTestRunner, FlakyTestRunner.RunnableThrows

Method Summary

Modifier and Type	Method and Description
FlakyTestRunner.RunnableThrows<X>	build() Constructs a runnable object that encapsulates the configured flaky test behavior.
FlakyTestRunner.Builder<X>	withErrorLogger(Consumer<? super String> errorLogger) Sets the error logger to use for error messages.
FlakyTestRunner.Builder<X>	withFlakyOnThisArchitecture(boolean flakyOnThisArchitecture) Configures whether the runner is considered flaky on the current architecture.
FlakyTestRunner.Builder<X>	withInfoLogger(Consumer<? super String> infoLogger) Sets the info logger to use for informational messages.
FlakyTestRunner.Builder<X>	withInterIterationGc(boolean interIterationGc) Sets if a garbage collection should be requested between each iteration.
FlakyTestRunner.Builder<X>	withIterationDelay(long delayMs) Sets the delay between each iteration in milliseconds.
FlakyTestRunner.Builder<X>	withMaxIterations(int maxIterations) Sets the maximum number of iterations before the runner fails.

Method Detail

withFlakyOnThisArchitecture

FlakyTestRunner.Builder<X> withFlakyOnThisArchitecture(boolean flakyOnThisArchitecture)

Configures whether the runner is considered flaky on the current architecture.

Default value: true

Parameters:

flakyOnThisArchitecture - Flag indicating flakiness

Returns:

This builder, allowing method chaining

withMaxIterations

FlakyTestRunner.Builder<X> withMaxIterations(int maxIterations)

Sets the maximum number of iterations before the runner fails.

This setting allows configuring how many times the runner will attempt the test before failing.

Default value: 2

Parameters:

maxIterations - non-negative value to use

Returns:

this Builder, allowing method chaining

withIterationDelay

FlakyTestRunner.Builder<X> withIterationDelay(long delayMs)

Sets the delay between each iteration in milliseconds.

This sets the time delay between retries if the test is failing.

Default value: 500 ms

Parameters:

delayMs - non-negative value to use

Returns:

this Builder, allowing method chaining

withInterIterationGc

FlakyTestRunner.Builder<X> withInterIterationGc(boolean interIterationGc)

Sets if a garbage collection should be requested between each iteration.

Enabling this setting can help to clean up resources between test attempts.

Default value: true

Parameters:

interIterationGc - flag to enable or disable garbage collection between iterations

Returns:

this Builder, allowing method chaining

withInfoLogger

FlakyTestRunner.Builder<X> withInfoLogger(Consumer<? super String> infoLogger)

Sets the info logger to use for informational messages.

Default value: System.out::println

Parameters:

infoLogger - Logger to use for informational messages

Returns:

this Builder, allowing method chaining

withErrorLogger

FlakyTestRunner.Builder<X> withErrorLogger(Consumer<? super String> errorLogger)

Sets the error logger to use for error messages.

Default value: System.err::println

Parameters:

errorLogger - Logger to use for error messages

Returns:

this Builder, allowing method chaining

build

FlakyTestRunner.RunnableThrows<X> build()

Constructs a runnable object that encapsulates the configured flaky test behavior.

This method finalizes the builder and constructs a new runnable object to handle the flaky test behavior based on the configured settings.

This method can only be called once per builder instance.

Returns:

A new RunnableThrows object that encapsulates the flaky test behavior