Package net.officefloor.frame.test

Class ThreadedTestSupport

java.lang.Object

net.officefloor.frame.test.ThreadedTestSupport

All Implemented Interfaces:

TestSupport

public class ThreadedTestSupport
extends Object
implements TestSupport

TestSupport for multiple Thread tests.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ThreadedTestSupport.MultiThreadedExecution<T extends Throwable>	Multi-threaded execution.
static interface	ThreadedTestSupport.MultithreadedTestLogic<T extends Throwable>	Multi-threaded test logic interface.
static interface	ThreadedTestSupport.WaitForTruePredicate<T extends Throwable>	Predicate to check for is true.

Constructor Summary

Constructors

Constructor	Description
ThreadedTestSupport()	Default constructor.

Method Summary

Modifier and Type	Method	Description
<T extends Throwable> void	doMultiThreadedTest(int threadCount, int iterationCount, int timeout, ThreadedTestSupport.MultithreadedTestLogic<T> test)	Undertakes multi-threaded testing of ThreadedTestSupport.MultithreadedTestLogic.
<T extends Throwable> void	doMultiThreadedTest(int threadCount, int iterationCount, ThreadedTestSupport.MultithreadedTestLogic<T> test)	Undertakes multi-threaded testing of ThreadedTestSupport.MultithreadedTestLogic.
void	init(org.junit.jupiter.api.extension.ExtensionContext context)	Intialise.
boolean	isGuiAvailable()	Indicates if the GUI is available.
void	sleep(int time)	Facade helper function for invoking Thread.sleep(long).
void	timeout(long startTime)	Facade method to timeout operations after 3 seconds.
void	timeout(long startTime, int secondsToRun)	Facade method to timeout operations after a second.
void	timeout(long startTime, int secondsToRun, String message)	Facade method to timeout operations after a second.
void	timeout(long startTime, String message)	Facade method to timeout operations after 3 seconds.
<T extends Throwable> ThreadedTestSupport.MultiThreadedExecution<T>	triggerMultiThreadedTest(int threadCount, int iterationCount, int timeout, ThreadedTestSupport.MultithreadedTestLogic<T> test)	Triggers multi-threaded testing of ThreadedTestSupport.MultithreadedTestLogic.
<T extends Throwable> ThreadedTestSupport.MultiThreadedExecution<T>	triggerMultiThreadedTest(int threadCount, int iterationCount, ThreadedTestSupport.MultithreadedTestLogic<T> test)	Triggers multi-threaded testing of ThreadedTestSupport.MultithreadedTestLogic.
<T extends Throwable> ThreadedTestSupport.MultiThreadedExecution<T>	triggerThreadedTest(ThreadedTestSupport.MultithreadedTestLogic<T> test)	Triggers single threaded testing of ThreadedTestSupport.MultithreadedTestLogic.
<T extends Throwable> void	waitForTrue(ThreadedTestSupport.WaitForTruePredicate<T> check)	Waits for the check to be true.
<T extends Throwable> void	waitForTrue(ThreadedTestSupport.WaitForTruePredicate<T> check, int secondsToRun)	Waits for the check to be true.
<T extends Throwable> void	waitForTrue(ThreadedTestSupport.WaitForTruePredicate<T> check, int secondsToRun, String message)	Waits for the check to be true.
<T extends Throwable> void	waitForTrue(ThreadedTestSupport.WaitForTruePredicate<T> check, String message)	Waits for the check to be true.

Methods inherited from class java.lang.Object

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

Constructor Details

ThreadedTestSupport

public ThreadedTestSupport()

Default constructor.

Method Details

init

public void init(org.junit.jupiter.api.extension.ExtensionContext context)
          throws Exception

Description copied from interface: TestSupport

Intialise.

Specified by:

init in interface TestSupport

Parameters:

context - ExtensionContext.

Throws:

Exception - If fails to init.

isGuiAvailable

public boolean isGuiAvailable()

Indicates if the GUI is available.

Returns:

true if the GUI is available.

doMultiThreadedTest

public <T extends Throwable> void doMultiThreadedTest(int threadCount,
 int iterationCount,
 ThreadedTestSupport.MultithreadedTestLogic<T> test)
                                               throws T

Undertakes multi-threaded testing of ThreadedTestSupport.MultithreadedTestLogic.

Type Parameters:

T - Possible Throwable type.

Parameters:

threadCount - Number of Thread instances to run in parallel.

iterationCount - Number of iterations of ThreadedTestSupport.MultithreadedTestLogic per Thread.

test - ThreadedTestSupport.MultithreadedTestLogic.

Throws:

T - Possible failure from failing ThreadedTestSupport.MultithreadedTestLogic.

doMultiThreadedTest

public <T extends Throwable> void doMultiThreadedTest(int threadCount,
 int iterationCount,
 int timeout,
 ThreadedTestSupport.MultithreadedTestLogic<T> test)
                                               throws T

Undertakes multi-threaded testing of ThreadedTestSupport.MultithreadedTestLogic.

Type Parameters:

T - Possible Throwable type.

Parameters:

threadCount - Number of Thread instances to run in parallel.

iterationCount - Number of iterations of ThreadedTestSupport.MultithreadedTestLogic per Thread.

timeout - Timeout.

test - ThreadedTestSupport.MultithreadedTestLogic.

Throws:

T - Possible failure from failing ThreadedTestSupport.MultithreadedTestLogic.

triggerThreadedTest

public <T extends Throwable>
ThreadedTestSupport.MultiThreadedExecution<T> triggerThreadedTest(ThreadedTestSupport.MultithreadedTestLogic<T> test)
                                                           throws T

Triggers single threaded testing of ThreadedTestSupport.MultithreadedTestLogic.

Type Parameters:

T - Possible Throwable type.

Parameters:

test - ThreadedTestSupport.MultithreadedTestLogic.

Returns:

ThreadedTestSupport.MultiThreadedExecution.

Throws:

T - Possible failure from failing ThreadedTestSupport.MultithreadedTestLogic.

triggerMultiThreadedTest

public <T extends Throwable>
ThreadedTestSupport.MultiThreadedExecution<T> triggerMultiThreadedTest(int threadCount,
 int iterationCount,
 ThreadedTestSupport.MultithreadedTestLogic<T> test)
                                                                throws T

Triggers multi-threaded testing of ThreadedTestSupport.MultithreadedTestLogic.

Type Parameters:

T - Possible Throwable type.

Parameters:

threadCount - Number of Thread instances to run in parallel.

iterationCount - Number of iterations of ThreadedTestSupport.MultithreadedTestLogic per Thread.

test - ThreadedTestSupport.MultithreadedTestLogic.

Returns:

ThreadedTestSupport.MultiThreadedExecution.

Throws:

T - Possible failure from failing ThreadedTestSupport.MultithreadedTestLogic.

triggerMultiThreadedTest

public <T extends Throwable>
ThreadedTestSupport.MultiThreadedExecution<T> triggerMultiThreadedTest(int threadCount,
 int iterationCount,
 int timeout,
 ThreadedTestSupport.MultithreadedTestLogic<T> test)
                                                                throws T

Triggers multi-threaded testing of ThreadedTestSupport.MultithreadedTestLogic.

Type Parameters:

T - Possible Throwable type.

Parameters:

threadCount - Number of Thread instances to run in parallel.

iterationCount - Number of iterations of ThreadedTestSupport.MultithreadedTestLogic per Thread.

timeout - Timeout.

test - ThreadedTestSupport.MultithreadedTestLogic.

Returns:

ThreadedTestSupport.MultiThreadedExecution.

Throws:

T - Possible failure from failing ThreadedTestSupport.MultithreadedTestLogic.

sleep

public void sleep(int time)

Facade helper function for invoking Thread.sleep(long).

Parameters:

time - Sleep time in seconds.

timeout

public void timeout(long startTime)

Facade method to timeout operations after 3 seconds.

Parameters:

startTime - Start time from System.currentTimeMillis().

timeout

public void timeout(long startTime,
 String message)

Facade method to timeout operations after 3 seconds.

Parameters:

startTime - Start time from System.currentTimeMillis().

message - Message to include in possible failure.

timeout

public void timeout(long startTime,
 int secondsToRun)

Facade method to timeout operations after a second.

Parameters:

startTime - Start time from System.currentTimeMillis().

secondsToRun - Seconds to run before timeout.

timeout

public void timeout(long startTime,
 int secondsToRun,
 String message)

Facade method to timeout operations after a second.

Parameters:

startTime - Start time from System.currentTimeMillis().

secondsToRun - Seconds to run before timeout.

message - Message to include in possible failure.

waitForTrue

public <T extends Throwable> void waitForTrue(ThreadedTestSupport.WaitForTruePredicate<T> check)
                                       throws T

Waits for the check to be true.

Type Parameters:

T - Possible failure type.

Parameters:

check - Check.

Throws:

T - Possible failure.

waitForTrue

public <T extends Throwable> void waitForTrue(ThreadedTestSupport.WaitForTruePredicate<T> check,
 String message)
                                       throws T

Waits for the check to be true.

Type Parameters:

T - Possible failure type.

Parameters:

check - Check.

message - Message to include in possible failure.

Throws:

T - Possible failure.

waitForTrue

public <T extends Throwable> void waitForTrue(ThreadedTestSupport.WaitForTruePredicate<T> check,
 int secondsToRun)
                                       throws T

Waits for the check to be true.

Type Parameters:

T - Possible failure type.

Parameters:

check - Check.

secondsToRun - Seconds to wait before timing out.

Throws:

T - Possible failure.

waitForTrue

public <T extends Throwable> void waitForTrue(ThreadedTestSupport.WaitForTruePredicate<T> check,
 int secondsToRun,
 String message)
                                       throws T

Waits for the check to be true.

Type Parameters:

T - Possible failure type.

Parameters:

check - Check.

secondsToRun - Seconds to wait before timing out.

message - Message to include in possible failure.

Throws:

T - Possible failure.