Class RandomizedContext

java.lang.Object

com.carrotsearch.randomizedtesting.RandomizedContext

public final class RandomizedContext
extends Object

Context variables for an execution of a test suite (hooks and tests) running under a RandomizedRunner.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	RandomizedContext.PerThreadResources	Per thread assigned resources.

Field Summary

Fields

Modifier and Type	Field	Description
private final Object	_contextLock	Coordination at context level.
private static final Object	_globalLock	Coordination at global level.
(package private) static final IdentityHashMap<ThreadGroup, RandomizedContext>	contexts	All thread groups we're currently tracking contexts for.
private Method	currentMethod
private EnumMap<LifecycleScope, List<CloseableResourceInfo>>	disposableResources	Disposable resources.
private boolean	disposed	The context and all of its resources are no longer usable.
(package private) final WeakHashMap<Thread, RandomizedContext.PerThreadResources>	perThreadResources	Per thread resources for each context.
private final RandomizedRunner	runner	The runner to which we're bound.
private final Class<?>	suiteClass
private final ThreadGroup	threadGroup	A thread group that shares this context.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	RandomizedContext(ThreadGroup tg, Class<?> suiteClass, RandomizedRunner runner)

Method Summary

Modifier and Type	Method	Description
private void	checkDisposed()	Throw an exception if disposed.
(package private) static void	cloneFor(Thread t)	Clone context information between the current thread and another thread.
<T extends Closeable> T	closeAtEnd(T resource, LifecycleScope scope)	Dispose the given resource at the end of a given lifecycle scope.
(package private) void	closeResources(ObjectProcedure<CloseableResourceInfo> consumer, LifecycleScope scope)	Dispose of any resources registered in the given scope.
(package private) static RandomizedContext	context(Thread thread)
(package private) static RandomizedContext	create(ThreadGroup tg, Class<?> suiteClass, RandomizedRunner runner)	Create a new context bound to a thread group.
static RandomizedContext	current()
(package private) void	dispose()	Dispose of the context.
GroupEvaluator	getGroupEvaluator()	Provide access to GroupEvaluator.
private RandomizedContext.PerThreadResources	getPerThread()	Return per-thread resources associated with the current thread.
Random	getRandom()	A shorthand for calling getRandomness() and then Randomness.getRandom().
Randomness	getRandomness()	Source of randomness for the context's thread.
(package private) Randomness[]	getRandomnesses()	Return all Randomness on the stack for the current thread.
RandomizedRunner	getRunner()	Access to the runner governing this context.
(package private) long	getRunnerSeed()	Runner's seed.
String	getRunnerSeedAsString()	Returns the runner's master seed, formatted.
Class<?>	getTargetClass()	The class (suite) being tested.
Method	getTargetMethod()
boolean	isNightly()	Return true if Nightly test group is explicitly enabled.
(package private) void	popAndDestroy()	Pop a randomness off the stack and dispose it.
(package private) void	push(Randomness rnd)	Push a new randomness on top of the stack.
<T> T	runWithPrivateRandomness(long seed, Callable<T> callable)	Pushes the given randomness to the top of the stack, runs the Callable and disposes the randomness before the this method returns.
<T> T	runWithPrivateRandomness(Randomness randomness, Callable<T> callable)	Pushes the given randomness to the top of the stack, runs the Callable and disposes the randomness before the this method returns.
(package private) void	setTargetMethod(Method method)

Methods inherited from class Object

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

Field Details

_globalLock

private static final Object _globalLock

Coordination at global level.

_contextLock

private final Object _contextLock

Coordination at context level.

contexts

static final IdentityHashMap<ThreadGroup, RandomizedContext> contexts

All thread groups we're currently tracking contexts for.

perThreadResources

final WeakHashMap<Thread, RandomizedContext.PerThreadResources> perThreadResources

Per thread resources for each context. Allow GCing of threads.

threadGroup

private final ThreadGroup threadGroup

A thread group that shares this context.

suiteClass

private final Class<?> suiteClass

See Also:

• getTargetClass()

runner

private final RandomizedRunner runner

The runner to which we're bound.

disposed

private volatile boolean disposed

The context and all of its resources are no longer usable.

disposableResources

private EnumMap<LifecycleScope, List<CloseableResourceInfo>> disposableResources

Disposable resources.

currentMethod

private Method currentMethod

Constructor Details

RandomizedContext

private RandomizedContext(ThreadGroup tg,
 Class<?> suiteClass,
 RandomizedRunner runner)

Method Details

getTargetClass

public Class<?> getTargetClass()

The class (suite) being tested.

getRunnerSeed

long getRunnerSeed()

Runner's seed.

getRunnerSeedAsString

public String getRunnerSeedAsString()

Returns the runner's master seed, formatted.

getRandomness

public Randomness getRandomness()

Source of randomness for the context's thread.

getRandomnesses

Randomness[] getRandomnesses()

Return all Randomness on the stack for the current thread. The most recent (currently used) randomness comes last in this array.

getRandom

public Random getRandom()

A shorthand for calling getRandomness() and then Randomness.getRandom().

isNightly

public boolean isNightly()

Return true if Nightly test group is explicitly enabled.

See Also:

• getGroupEvaluator()
• GroupEvaluator.isGroupEnabled(Class)

current

public static RandomizedContext current()

Returns:

Returns the context for the calling thread or throws an IllegalStateException if the thread is out of scope.

Throws:

IllegalStateException - If context is not available.

getRunner

public RandomizedRunner getRunner()

Access to the runner governing this context.

closeAtEnd

public <T extends Closeable> T closeAtEnd(T resource,
 LifecycleScope scope)

Dispose the given resource at the end of a given lifecycle scope. If the Closeable throws an exception, the test case or suite will end in a failure.

Returns:

resource (for call chaining).

getGroupEvaluator

public GroupEvaluator getGroupEvaluator()

Provide access to GroupEvaluator.

runWithPrivateRandomness

public <T> T runWithPrivateRandomness(Randomness randomness,
 Callable<T> callable)
                               throws Exception

Pushes the given randomness to the top of the stack, runs the Callable and disposes the randomness before the this method returns.

This utility method can be used to initialize resources in a reproducible way since all calls to utility methods like RandomizedTest.randomInt() et.al. are forwarded to the current RandomContext which uses the provided randomness from the top of the stack.

Type Parameters:

T - the return type of the callable

Parameters:

randomness - the randomness to push to the top of the stack

callable - the callable to execute

Returns:

the result of the call to Callable.call()

Throws:

Exception - if Callable.call() throws an exception

runWithPrivateRandomness

public <T> T runWithPrivateRandomness(long seed,
 Callable<T> callable)
                               throws Exception

Pushes the given randomness to the top of the stack, runs the Callable and disposes the randomness before the this method returns.

This utility method can be used to initialize resources in a reproducible way since all calls to utility methods like RandomizedTest.randomInt() et.al. are forwarded to the current RandomContext which uses the provided randomness from the top of the stack.

Type Parameters:

T - the return type of the callable

Parameters:

seed - The initial seed for the new, private randomness

callable - the callable to execute

Returns:

the result of the call to Callable.call()

Throws:

Exception - if Callable.call() throws an exception

closeResources

void closeResources(ObjectProcedure<CloseableResourceInfo> consumer,
 LifecycleScope scope)

Dispose of any resources registered in the given scope.

context

static RandomizedContext context(Thread thread)

create

static RandomizedContext create(ThreadGroup tg,
 Class<?> suiteClass,
 RandomizedRunner runner)

Create a new context bound to a thread group.

dispose

void dispose()

Dispose of the context.

push

void push(Randomness rnd)

Push a new randomness on top of the stack.

popAndDestroy

void popAndDestroy()

Pop a randomness off the stack and dispose it.

getPerThread

private RandomizedContext.PerThreadResources getPerThread()

Return per-thread resources associated with the current thread.

checkDisposed

private void checkDisposed()

Throw an exception if disposed.

cloneFor

static void cloneFor(Thread t)

Clone context information between the current thread and another thread. This is for internal use only to propagate context information when forking.

setTargetMethod

void setTargetMethod(Method method)

getTargetMethod

public Method getTargetMethod()

Returns:

Return the currently executing test case method (the thread may still be within test rules and may never actually hit the method). This method may return null if called from the static context (no test case is being executed at the moment).