com.carrotsearch.randomizedtesting

Class RandomizedContext

java.lang.Object

com.carrotsearch.randomizedtesting.RandomizedContext

public final class RandomizedContext
extends java.lang.Object

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

Method Summary

Methods

Modifier and Type	Method and Description
<T extends java.io.Closeable> T	closeAtEnd(T resource, LifecycleScope scope) Dispose the given resource at the end of a given lifecycle scope.
static RandomizedContext	current()
GroupEvaluator	getGroupEvaluator() Provide access to GroupEvaluator.
java.util.Random	getRandom() A shorthand for calling getRandomness() and then Randomness.getRandom().
Randomness	getRandomness() Source of randomness for the context's thread.
RandomizedRunner	getRunner() Access to the runner governing this context.
java.lang.String	getRunnerSeedAsString() Returns the runner's master seed, formatted.
java.lang.Class<?>	getTargetClass() The class (suite) being tested.
java.lang.reflect.Method	getTargetMethod()
boolean	isNightly() Return true if Nightly test group is explicitly enabled.
<T> T	runWithPrivateRandomness(long seed, java.util.concurrent.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, java.util.concurrent.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.

Methods inherited from class java.lang.Object

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

Method Detail

getTargetClass

public java.lang.Class<?> getTargetClass()

The class (suite) being tested.

getRunnerSeedAsString

public java.lang.String getRunnerSeedAsString()

Returns the runner's master seed, formatted.

getRandomness

public Randomness getRandomness()

Source of randomness for the context's thread.

getRandom

public java.util.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:

java.lang.IllegalStateException - If context is not available.

getRunner

public RandomizedRunner getRunner()

Access to the runner governing this context.

closeAtEnd

public <T extends java.io.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,
                             java.util.concurrent.Callable<T> callable)
                           throws java.lang.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:

java.lang.Exception - if Callable.call() throws an exception

runWithPrivateRandomness

public <T> T runWithPrivateRandomness(long seed,
                             java.util.concurrent.Callable<T> callable)
                           throws java.lang.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:

java.lang.Exception - if Callable.call() throws an exception

getTargetMethod

public java.lang.reflect.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).