org.threadly.test.concurrent

Class AsyncVerifier

java.lang.Object

org.threadly.test.concurrent.AsyncVerifier

public class AsyncVerifier
extends java.lang.Object

A simple class for verifying multi-threaded unit tests. If any thread has a failed a failed assert or call to fail() the main threads call to waitForTest() will throw an exception to indicate the test as a failure.

This class also provides a way to control the flow of a unit test by blocking main test thread until signalComplete() is called from the other thread.

Since:

1.0 (since 1.0.0 in threadly artifact)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AsyncVerifier.TestFailure Exception to represent a failure in a test assertion.

Constructor Summary

Constructors

Constructor and Description
AsyncVerifier() Constructs a new AsyncVerifier.

Method Summary

Modifier and Type	Method and Description
void	assertEquals(java.lang.Object o1, java.lang.Object o2) Verifies that the passed in values are equal using the o1.equals(o2) relationship.
void	assertFalse(boolean condition) Verifies that the passed in condition is false.
void	assertNotNull(java.lang.Object o) Verifies that the passed in object is not null.
void	assertNull(java.lang.Object o) Verifies that the passed in object is null.
void	assertTrue(boolean condition) Verifies that the passed in condition is true.
void	fail() Marks a failure with no cause.
void	fail(java.lang.String message) Marks a failure with a specified message.
void	fail(java.lang.Throwable cause) Marks a failure with a specified throwable cause.
void	signalComplete() Call to indicate that this thread has finished, and should notify the waiting main test thread that the test may be complete.
void	waitForTest() Waits for a default of 10 seconds, or until signalComplete has been called once, or until a failure occurs.
void	waitForTest(long timeoutInMs) Waits a specified amount of time, or until signalComplete has been called once, or until a failure occurs.
void	waitForTest(long timeoutInMs, int signalCount) Waits a specified amount of time, or until signalComplete has been called a specified amount of times, or until a failure occurs.

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncVerifier

public AsyncVerifier()

Constructs a new AsyncVerifier.

Method Detail

waitForTest

public void waitForTest()
                 throws java.lang.InterruptedException,
                        java.util.concurrent.TimeoutException

Waits for a default of 10 seconds, or until signalComplete has been called once, or until a failure occurs. If signalComplete has been called before this, this call will never block.

Throws:

java.lang.InterruptedException - Thrown if thread is interrupted while waiting

java.util.concurrent.TimeoutException - Thrown if timeout occurs without signalComplete being called

waitForTest

public void waitForTest(long timeoutInMs)
                 throws java.lang.InterruptedException,
                        java.util.concurrent.TimeoutException

Waits a specified amount of time, or until signalComplete has been called once, or until a failure occurs. If signalComplete has been called before this, this call will never block.

Parameters:

timeoutInMs - Timeout to wait for signalComplete action to occur

Throws:

java.lang.InterruptedException - Thrown if thread is interrupted while waiting

java.util.concurrent.TimeoutException - Thrown if timeout occurs without signalComplete being called

waitForTest

public void waitForTest(long timeoutInMs,
                        int signalCount)
                 throws java.lang.InterruptedException,
                        java.util.concurrent.TimeoutException

Waits a specified amount of time, or until signalComplete has been called a specified amount of times, or until a failure occurs.

If waitForTest() is being called multiple times on the same instance, the signalComplete count is NOT reset. So you must either create new instances, or pass in a larger value for the expected signalComplete count.

Parameters:

timeoutInMs - Timeout to wait for signalComplete action to occur

signalCount - Amount of signalComplete calls to expect before unblocking

Throws:

java.lang.InterruptedException - Thrown if thread is interrupted while waiting

java.util.concurrent.TimeoutException - Thrown if timeout occurs without signalComplete being called

signalComplete

public void signalComplete()

Call to indicate that this thread has finished, and should notify the waiting main test thread that the test may be complete.

assertTrue

public void assertTrue(boolean condition)

Verifies that the passed in condition is true. If it is not an exception is thrown in this thread, as well as possibly any blocking thread waiting at waitForTest().

Parameters:

condition - condition to verify is true

assertFalse

public void assertFalse(boolean condition)

Verifies that the passed in condition is false. If it is not an exception is thrown in this thread, as well as possibly any blocking thread waiting at waitForTest().

Parameters:

condition - condition to verify is false

assertNull

public void assertNull(java.lang.Object o)

Verifies that the passed in object is null. If it is not null an exception is thrown in this thread, as well as possibly any blocking thread waiting at waitForTest().

Parameters:

o - Object to verify is null

assertNotNull

public void assertNotNull(java.lang.Object o)

Verifies that the passed in object is not null. If it is null an exception is thrown in this thread, as well as possibly any blocking thread waiting at waitForTest().

Parameters:

o - Object to verify is not null

assertEquals

public void assertEquals(java.lang.Object o1,
                         java.lang.Object o2)

Verifies that the passed in values are equal using the o1.equals(o2) relationship. If this check fails an exception is thrown in this thread, as well as any blocking thread waiting at waitForTest().

Parameters:

o1 - First object to compare against

o2 - Second object to compare against

fail

public void fail()

Marks a failure with no cause. This causes an exception to be thrown in the calling thread, as well was any blocking thread waiting at waitForTest().

fail

public void fail(java.lang.String message)

Marks a failure with a specified message. This causes an exception to be thrown in the calling thread, as well was any blocking thread waiting at waitForTest().

Parameters:

message - Message to be provided in failure exception

fail

public void fail(java.lang.Throwable cause)

Marks a failure with a specified throwable cause. This causes an exception to be thrown in the calling thread, as well was any blocking thread waiting at waitForTest().

Parameters:

cause - Throwable cause to be provided in failure exception