org.apache.gobblin.testing

Class AssertWithBackoff

java.lang.Object

org.apache.gobblin.testing.AssertWithBackoff

public class AssertWithBackoff
extends Object

A helper class to perform a check for a condition with a back-off. Primary use of this is when a tests needs for something asynchronous to happen, say a service to start.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AssertWithBackoff.EqualsCheck<T>

Constructor Summary

Constructors

Constructor and Description
AssertWithBackoff()

Method Summary

Modifier and Type	Method and Description
<T> void	assertEquals(com.google.common.base.Function<Void,T> actual, T expected, String message) A convenience method for assertTrue(Predicate, String) to keep checking until a certain value until it becomes equal to an expected value.
static void	assertTrue(com.google.common.base.Predicate<Void> condition, long assertTimeoutMs, String message, org.slf4j.Logger log, double backoffFactor, long maxSleepMs) Performs a check for a condition with a back-off.
void	assertTrue(com.google.common.base.Predicate<Void> condition, String message) Performs a check for a condition with a back-off.
AssertWithBackoff	backoffFactor(double backoffFactor) Set the number to multiple the sleep after condition failure
static long	computeRetrySleep(long currentSleepMs, double backoffFactor, long maxSleepMs, long endTimeMs) Computes a new sleep for a retry of a condition check.
static AssertWithBackoff	create() Creates a new instance
double	getBackoffFactor() The number to multiple the sleep after condition failure
org.slf4j.Logger	getLogger() The logger to use for logging waiting, results, etc.
long	getMaxSleepMs() The max time to sleep between condition failures
long	getTimeoutMs() the max time in milliseconds to wait for the condition to become true
AssertWithBackoff	logger(org.slf4j.Logger log) Set the logger to use for logging waiting, results, etc.
AssertWithBackoff	maxSleepMs(long maxSleepMs) Set the max time to sleep between condition failures
AssertWithBackoff	timeoutMs(long assertTimeoutMs) Set the max time in milliseconds to wait for the condition to become true

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AssertWithBackoff

public AssertWithBackoff()

Method Detail

create

public static AssertWithBackoff create()

Creates a new instance

timeoutMs

public AssertWithBackoff timeoutMs(long assertTimeoutMs)

Set the max time in milliseconds to wait for the condition to become true

getTimeoutMs

public long getTimeoutMs()

the max time in milliseconds to wait for the condition to become true

maxSleepMs

public AssertWithBackoff maxSleepMs(long maxSleepMs)

Set the max time to sleep between condition failures

getMaxSleepMs

public long getMaxSleepMs()

The max time to sleep between condition failures

backoffFactor

public AssertWithBackoff backoffFactor(double backoffFactor)

Set the number to multiple the sleep after condition failure

getBackoffFactor

public double getBackoffFactor()

The number to multiple the sleep after condition failure

logger

public AssertWithBackoff logger(org.slf4j.Logger log)

Set the logger to use for logging waiting, results, etc.

getLogger

public org.slf4j.Logger getLogger()

The logger to use for logging waiting, results, etc.

assertTrue

public void assertTrue(com.google.common.base.Predicate<Void> condition,
                       String message)
                throws TimeoutException,
                       InterruptedException

Performs a check for a condition with a back-off. Primary use of this is when a tests needs for something asynchronous to happen, say a service to start.

Parameters:

condition - the condition to wait for

assertTimeoutMs - the max time in milliseconds to wait for the condition to become true

message - a message to print while waiting for the condition

log - a logger to use for logging waiting, results

Throws:

TimeoutException - if the condition did not become true in the specified time budget

InterruptedException

assertEquals

public <T> void assertEquals(com.google.common.base.Function<Void,T> actual,
                             T expected,
                             String message)
                      throws TimeoutException,
                             InterruptedException

A convenience method for assertTrue(Predicate, String) to keep checking until a certain value until it becomes equal to an expected value.

Parameters:

actual - a function that checks the actual value

expected - the expected value

message - a debugging message

Throws:

TimeoutException

InterruptedException

assertTrue

public static void assertTrue(com.google.common.base.Predicate<Void> condition,
                              long assertTimeoutMs,
                              String message,
                              org.slf4j.Logger log,
                              double backoffFactor,
                              long maxSleepMs)
                       throws TimeoutException,
                              InterruptedException

Performs a check for a condition with a back-off. Primary use of this is when a tests needs for something asynchronous to happen, say a service to start.

Parameters:

condition - the condition to wait for

assertTimeoutMs - the max time in milliseconds to wait for the condition to become true

message - the message to print while waiting for the condition

log - the logger to use for logging waiting, results

backoffFactor - the number to multiple the sleep after condition failure;

maxSleepMs - the max time to sleep between condition failures; default is

Throws:

TimeoutException - if the condition did not become true in the specified time budget

InterrupedException - if the assert gets interrupted while waiting for the condition to become true.

InterruptedException

computeRetrySleep

public static long computeRetrySleep(long currentSleepMs,
                                     double backoffFactor,
                                     long maxSleepMs,
                                     long endTimeMs)

Computes a new sleep for a retry of a condition check.

Parameters:

currentSleepMs - the last sleep duration in milliseconds

backoffFactor - the factor to multiple currentSleepMs

maxSleepMs - the maximum allowed sleep in milliseconds

endTimeMs - the end time based on timeout for the condition to become true

Returns:

the new sleep time which will not exceed maxSleepMs and will also not cause to overshoot endTimeMs