package com.carrotsearch.randomizedtesting;
import static com.carrotsearch.randomizedtesting.MethodCollector.allDeclaredMethods;
import static com.carrotsearch.randomizedtesting.MethodCollector.annotatedWith;
import static com.carrotsearch.randomizedtesting.MethodCollector.flatten;
import static com.carrotsearch.randomizedtesting.MethodCollector.immutableCopy;
import static com.carrotsearch.randomizedtesting.MethodCollector.mutableCopy2;
import static com.carrotsearch.randomizedtesting.MethodCollector.removeOverrides;
import static com.carrotsearch.randomizedtesting.MethodCollector.removeShadowed;
import static com.carrotsearch.randomizedtesting.MethodCollector.sort;
import static com.carrotsearch.randomizedtesting.SysGlobals.SYSPROP_APPEND_SEED;
import static com.carrotsearch.randomizedtesting.SysGlobals.SYSPROP_ITERATIONS;
import static com.carrotsearch.randomizedtesting.SysGlobals.SYSPROP_KILLATTEMPTS;
import static com.carrotsearch.randomizedtesting.SysGlobals.SYSPROP_KILLWAIT;
import static com.carrotsearch.randomizedtesting.SysGlobals.SYSPROP_RANDOM_SEED;
import static com.carrotsearch.randomizedtesting.SysGlobals.SYSPROP_STACKFILTERING;
import static com.carrotsearch.randomizedtesting.SysGlobals.SYSPROP_TESTCLASS;
import static com.carrotsearch.randomizedtesting.SysGlobals.SYSPROP_TESTMETHOD;
import static com.carrotsearch.randomizedtesting.SysGlobals.SYSPROP_TIMEOUT;
import java.lang.Thread.State;
import java.lang.Thread.UncaughtExceptionHandler;
import java.lang.annotation.Annotation;
import java.lang.annotation.Inherited;
import java.lang.reflect.AnnotatedElement;
import java.lang.reflect.Constructor;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashMap;
import java.util.HashSet;
import java.util.IdentityHashMap;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Random;
import java.util.Set;
import java.util.TreeSet;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.atomic.AtomicLong;
import java.util.logging.Level;
import java.util.logging.Logger;
import junit.framework.Assert;
import org.junit.After;
import org.junit.AfterClass;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.ClassRule;
import org.junit.Ignore;
import org.junit.Rule;
import org.junit.Test;
import org.junit.internal.AssumptionViolatedException;
import org.junit.rules.TestRule;
import org.junit.runner.Description;
import org.junit.runner.Result;
import org.junit.runner.Runner;
import org.junit.runner.manipulation.Filter;
import org.junit.runner.manipulation.Filterable;
import org.junit.runner.manipulation.NoTestsRemainException;
import org.junit.runner.notification.Failure;
import org.junit.runner.notification.RunListener;
import org.junit.runner.notification.RunNotifier;
import org.junit.runners.model.FrameworkField;
import org.junit.runners.model.FrameworkMethod;
import org.junit.runners.model.InitializationError;
import org.junit.runners.model.MultipleFailureException;
import org.junit.runners.model.Statement;
import org.junit.runners.model.TestClass;
import com.carrotsearch.randomizedtesting.annotations.Listeners;
import com.carrotsearch.randomizedtesting.annotations.Name;
import com.carrotsearch.randomizedtesting.annotations.Nightly;
import com.carrotsearch.randomizedtesting.annotations.ParametersFactory;
import com.carrotsearch.randomizedtesting.annotations.Repeat;
import com.carrotsearch.randomizedtesting.annotations.Seed;
import com.carrotsearch.randomizedtesting.annotations.Seeds;
import com.carrotsearch.randomizedtesting.annotations.TestGroup;
import com.carrotsearch.randomizedtesting.annotations.TestMethodProviders;
import com.carrotsearch.randomizedtesting.annotations.ThreadLeaks;
import com.carrotsearch.randomizedtesting.annotations.Timeout;
import com.carrotsearch.randomizedtesting.annotations.Validators;
import com.carrotsearch.randomizedtesting.generators.RandomInts;
/**
* A {@link Runner} implementation for running randomized test cases with
* predictable and repeatable randomness.
*
* <p>Supports the following JUnit4 features:
* <ul>
* <li>{@link BeforeClass}-annotated methods (before all tests of a class/superclass),</li>
* <li>{@link Before}-annotated methods (before each test),</li>
* <li>{@link Test}-annotated methods,</li>
* <li>{@link After}-annotated methods (after each test),</li>
* <li>{@link AfterClass}-annotated methods (after all tests of a class/superclass),</li>
* <li>{@link Rule}-annotated fields implementing {@link org.junit.rules.MethodRule}
* and {@link TestRule}.</li>
* </ul>
*
* <p>Contracts:
* <ul>
* <li>{@link BeforeClass}, {@link Before}
* methods declared in superclasses are called before methods declared in subclasses,</li>
* <li>{@link AfterClass}, {@link After}
* methods declared in superclasses are called after methods declared in subclasses,</li>
* <li>{@link BeforeClass}, {@link Before}, {@link AfterClass}, {@link After}
* methods declared within the same class are called in <b>randomized</b> order
* derived from the master seed (repeatable with the same seed),</li>
* </ul>
*
* <p>Deviations from "standard" JUnit:
* <ul>
* <li>test methods are allowed to return values (the return value is ignored),</li>
* <li>hook methods need not be public; in fact, it is encouraged to make them private to
* avoid accidental shadowing which silently drops parent hooks from executing
* (applies to class hooks mostly, but also to instance hooks).</li>
* <li>all exceptions raised during hooks or test case execution are reported to the notifier,
* there is no suppression or chaining of exceptions,</li>
* <li>a test method must not leave behind any active threads; this is detected
* using {@link ThreadGroup} active counts and is sometimes problematic (many classes
* in the standard library leave active threads behind without waiting for them to terminate).
* One can use the {@link ThreadLeaks} annotation to control how aggressive the detection
* strategy is and if it fails the test or not.</li>
* <li>uncaught exceptions from any of children threads will cause the test to fail.</li>
* </ul>
*
* @see RandomizedTest
* @see ThreadLeaks
* @see Validators
* @see Listeners
* @see RandomizedContext
* @see TestMethodProviders
*/
@SuppressWarnings("javadoc")
public final class RandomizedRunner extends Runner implements Filterable {
/** A dummy class serving as the source of defaults for annotations. */
@ThreadLeaks @Nightly
private static class Dummy {}
/**
* Default instance of {@link ThreadLeaks} annotation.
*/
private static final ThreadLeaks defaultThreadLeaks = Dummy.class.getAnnotation(ThreadLeaks.class);
/**
* Default instance of {@link Nightly} annotation.
*/
private static final Nightly defaultNightly = Dummy.class.getAnnotation(Nightly.class);
/**
* Fake package of a stack trace entry inserted into exceptions thrown by
* test methods. These stack entries contain additional information about
* seeds used during execution.
*/
public static final String AUGMENTED_SEED_PACKAGE = "__randomizedtesting";
/**
* Default timeout for a single test case. By default
* the timeout is <b>disabled</b>. Use global system property
* {@link SysGlobals#SYSPROP_TIMEOUT} or an annotation {@link Timeout} if you need to set
* timeouts or expect some test cases may hang. This will slightly slow down
* the tests because each test case is executed in a forked thread.
*
* @see SysGlobals#SYSPROP_TIMEOUT()
*/
public static final int DEFAULT_TIMEOUT = 0;
/**
* The default number of first interrupts, then Thread.stop attempts.
*/
public static final int DEFAULT_KILLATTEMPTS = 5;
/**
* Time in between interrupt retries or stop retries.
*/
public static final int DEFAULT_KILLWAIT = 500;
/**
* The default number of iterations.
*/
public static final int DEFAULT_ITERATIONS = 1;
/**
* Test candidate (model).
*/
private static class TestCandidate {
public final long seed;
public final Description description;
public final Method method;
public final InstanceProvider instanceProvider;
public TestCandidate(Method method, long seed, Description description, InstanceProvider provider) {
this.seed = seed;
this.description = description;
this.method = method;
this.instanceProvider = provider;
}
/**
* TODO: can this be anything else, really? I mean: even with factory methods we're
* still creating instances of suiteClass.
*/
public Class<?> getTestClass() {
return instanceProvider.getTestClass();
}
}
/**
* Package scope logger.
*/
final static Logger logger = Logger.getLogger(RandomizedRunner.class.getSimpleName());
/**
* A sequencer for affecting the initial seed in case of rapid succession of this class
* instance creations. Not likely, but can happen two could get the same seed.
*/
private final static AtomicLong sequencer = new AtomicLong();
private static final List<String> DEFAULT_STACK_FILTERS = Arrays.asList(new String [] {
"org.junit.",
"junit.framework.",
"sun.",
"java.lang.reflect.",
"com.carrotsearch.randomizedtesting.",
});
/** The class with test methods (suite). */
private final Class<?> suiteClass;
/**
* All methods of the {@link #suiteClass} class, unfiltered (including overrides and shadowed
* methods). Sorted at class level to the order: class..super, and at method level (within
* each class) alphabetically.
*/
private List<List<Method>> allTargetMethods;
/** The runner's seed (master). */
final Randomness runnerRandomness;
/**
* If {@link #SYSPROP_RANDOM_SEED} property is used with two arguments (master:method)
* then this field contains method-level override.
*/
private Randomness testCaseRandomnessOverride;
/**
* The number of each test's randomized iterations.
*
* @see #SYSPROP_ITERATIONS
*/
private final Integer iterationsOverride;
/**
* Default test case timeout in millis.
*
* @see #SYSPROP_TIMEOUT
*/
private final int timeoutOverride;
/**
* Should {@link #timeoutOverride} take precedence over annotations?
*/
private boolean globalTimeoutFirst;
/** All test candidates, processed (seeds assigned) and flattened. */
private List<TestCandidate> testCandidates;
/** All test groups. */
HashMap<Class<? extends Annotation>, RuntimeTestGroup> testGroups;
/** Class suite description. */
private Description suiteDescription;
/** Applies filters to suite classes. */
private List<Filter> suiteFilters = new ArrayList<Filter>();
/** Applies filters to test cases. */
private List<Filter> testFilters = new ArrayList<Filter>();
/**
* How many attempts to interrupt and then kill a runaway thread before giving up?
*/
private final int killAttempts;
/**
* How long to wait between attempts to kill a runaway thread (millis).
*/
private final int killWait;
/**
* A set of threads which we could not terminate or kill no matter how hard we tried. Even by
* driving sharpened silver pencils through their binary cyberhearts.
*/
private final Set<Thread> bulletProofZombies = new HashSet<Thread>();
/**
* All tests are executed under a specified thread group so that we can have some control
* over how many threads have been started/ stopped. System daemons shouldn't be under
* this group.
*/
private RunnerThreadGroup runnerThreadGroup;
/**
* @see #subscribeListeners(RunNotifier)
*/
private final List<RunListener> autoListeners = new ArrayList<RunListener>();
/**
* @see #SYSPROP_APPEND_SEED
*/
private boolean appendSeedParameter;
/**
* We simply report to syserr. There should be no threads out of runner's control.
* This can also be validated with aspects.
*/
private UncaughtExceptionHandler defaultExceptionHandler = new UncaughtExceptionHandler() {
public void uncaughtException(Thread t, Throwable e) {
logger.severe("A non-test thread threw an uncaught exception. This" +
" should never happen in normal circumstances: report to " +
RandomizedRunner.class.getName() + " developers. Thread: " +
t + ", exception: " + traces.formatThrowable(e));
}
};
/**
* Stack trace filtering/ dumping.
*/
private final TraceFormatting traces;
/**
* Resource disposal snippet.
*/
private static class ResourceDisposal implements ObjectProcedure<CloseableResourceInfo> {
private RunNotifier notifier;
private Description description;
public ResourceDisposal(RunNotifier notifier, Description description) {
this.notifier = notifier;
this.description = description;
}
public void apply(CloseableResourceInfo info) {
try {
info.getResource().close();
} catch (Throwable t) {
ResourceDisposalError e = new ResourceDisposalError(
info.getScope().name() + " scope resource could not be closed properly. Resource's"
+ " registered from thread " + info.getThread().getName()
+ ", registration stack trace below.", t);
e.setStackTrace(info.getAllocationStack());
notifier.fireTestFailure(new Failure(description, e));
}
}
};
/** Creates a new runner for the given class. */
public RandomizedRunner(Class<?> testClass) throws InitializationError {
appendSeedParameter = RandomizedTest.systemPropertyAsBoolean(SYSPROP_APPEND_SEED(), false);
if (RandomizedTest.systemPropertyAsBoolean(SYSPROP_STACKFILTERING(), true)) {
this.traces = new TraceFormatting(DEFAULT_STACK_FILTERS);
} else {
this.traces = new TraceFormatting();
}
this.suiteClass = testClass;
this.allTargetMethods = immutableCopy(sort(allDeclaredMethods(suiteClass)));
// Initialize the runner's master seed/ randomness source.
final long randomSeed = MurmurHash3.hash(sequencer.getAndIncrement() + System.nanoTime());
final String globalSeed = emptyToNull(System.getProperty(SYSPROP_RANDOM_SEED()));
if (globalSeed != null) {
final long[] seedChain = SeedUtils.parseSeedChain(globalSeed);
if (seedChain.length == 0 || seedChain.length > 2) {
throw new IllegalArgumentException("Invalid system property "
+ SYSPROP_RANDOM_SEED() + " specification: " + globalSeed);
}
if (seedChain.length > 1) {
testCaseRandomnessOverride = new Randomness(seedChain[1]);
}
runnerRandomness = new Randomness(seedChain[0]);
} else if (suiteClass.isAnnotationPresent(Seed.class)) {
runnerRandomness = new Randomness(seedFromAnnot(suiteClass, randomSeed)[0]);
} else {
runnerRandomness = new Randomness(randomSeed);
}
// Iterations property is primary wrt to annotations, so we leave an "undefined" value as null.
if (emptyToNull(System.getProperty(SYSPROP_ITERATIONS())) != null) {
this.iterationsOverride = RandomizedTest.systemPropertyAsInt(SYSPROP_ITERATIONS(), 0);
if (iterationsOverride < 1)
throw new IllegalArgumentException(
"System property " + SYSPROP_ITERATIONS() + " must be >= 1: " + iterationsOverride);
} else {
this.iterationsOverride = null;
}
this.killAttempts = RandomizedTest.systemPropertyAsInt(SYSPROP_KILLATTEMPTS(), DEFAULT_KILLATTEMPTS);
this.killWait = RandomizedTest.systemPropertyAsInt(SYSPROP_KILLWAIT(), DEFAULT_KILLWAIT);
// Determine default timeout value.
String timeoutValue = System.getProperty(SYSPROP_TIMEOUT());
if (timeoutValue == null || timeoutValue.trim().length() == 0) {
timeoutValue = null;
}
if (timeoutValue != null) {
// Check for timeout precedence.
globalTimeoutFirst = timeoutValue.matches("[0-9]+\\!");
timeoutValue = timeoutValue.replaceAll("\\!", "");
} else {
timeoutValue = Integer.toString(DEFAULT_TIMEOUT);
}
this.timeoutOverride = Integer.parseInt(timeoutValue);
// Fail fast if suiteClass is inconsistent or selected "standard" JUnit rules are somehow broken.
try {
validateTarget();
// Collect all test candidates, regardless if they will be executed or not.
suiteDescription = Description.createSuiteDescription(suiteClass);
testCandidates = collectTestCandidates(suiteDescription);
testGroups = collectGroups(testCandidates);
} catch (Throwable t) {
throw new InitializationError(t);
}
}
/**
* Return the current tree of test descriptions (filtered).
*/
@Override
public Description getDescription() {
return suiteDescription;
}
/**
* Implement {@link Filterable} because GUIs depend on it to run tests selectively.
*/
@Override
public void filter(Filter filter) throws NoTestsRemainException {
this.testFilters.add(filter);
}
/**
* Runs all tests and hooks.
*/
@Override
public void run(RunNotifier notifier) {
if (emptyToNull(System.getProperty(SYSPROP_TESTCLASS())) != null) {
suiteFilters.add(new ClassGlobFilter(System.getProperty(SYSPROP_TESTCLASS())));
}
if (emptyToNull(System.getProperty(SYSPROP_TESTMETHOD())) != null) {
testFilters.add(new MethodGlobFilter(System.getProperty(SYSPROP_TESTMETHOD())));
}
runSuite(notifier);
}
/**
* Test execution logic for the entire suite.
*/
private void runSuite(final RunNotifier notifier) {
if (Thread.getDefaultUncaughtExceptionHandler() == null) {
Thread.setDefaultUncaughtExceptionHandler(defaultExceptionHandler);
}
this.runnerThreadGroup = new RunnerThreadGroup(
RandomizedRunner.class.getSimpleName() +
"-SuiteThreadGroup-" + suiteClass.getName());
final Thread runner = new Thread(runnerThreadGroup,
RandomizedRunner.class.getSimpleName() +
"-SuiteThread-" + suiteClass.getName() +
"-seed#" + SeedUtils.formatSeedChain(runnerRandomness)) {
public void run() {
try {
// Make sure static initializers are invoked and that they are invoked outside of
// the randomized context scope. This is for consistency so that we're not relying
// on the class NOT being initialized before.
try {
Class.forName(suiteClass.getName(), true, suiteClass.getClassLoader());
} catch (ExceptionInInitializerError e) {
throw e.getCause();
}
RandomizedContext context = createContext(runnerThreadGroup);
runSuite(context, notifier);
context.dispose();
} catch (Throwable t) {
notifier.fireTestFailure(new Failure(suiteDescription, t));
}
}
};
runner.start();
try {
runner.join();
} catch (InterruptedException e) {
notifier.fireTestFailure(new Failure(suiteDescription,
new RuntimeException("Interrupted while waiting for the suite runner? Weird.", e)));
}
runnerThreadGroup = null;
}
/**
* Test execution logic for the entire suite, executing under designated
* {@link RunnerThreadGroup}.
*/
private void runSuite(final RandomizedContext context, final RunNotifier notifier) {
final Result result = new Result();
final RunListener accounting = result.createListener();
notifier.addListener(accounting);
final Randomness classRandomness = new Randomness(runnerRandomness.seed);
context.push(classRandomness);
try {
// Check for automatically hookable listeners.
subscribeListeners(notifier);
// Fire a synthetic "suite started" event.
for (RunListener r : autoListeners) {
try {
r.testRunStarted(suiteDescription);
} catch (Throwable e) {
logger.log(Level.SEVERE, "Panic: RunListener hook shouldn't throw exceptions.", e);
}
}
// Validate suiteClass with custom validators.
if (runCustomValidators(notifier)) {
// Filter out test candidates to see if there's anything left. If not,
// don't bother running class hooks.
final List<TestCandidate> filtered = getFilteredTestCandidates();
if (!filtered.isEmpty()) {
Statement s = runTestsStatement(notifier, filtered);
s = withClassBefores(notifier, s);
s = withClassAfters(notifier, s);
s = withClassRules(notifier, s);
try {
s.evaluate();
} catch (Throwable t) {
if (t instanceof AssumptionViolatedException) {
// Class level assumptions cause all tests to be ignored.
// see Rants#RANT_3
for (final TestCandidate c : filtered) {
notifier.fireTestIgnored(c.description);
}
notifier.fireTestAssumptionFailed(new Failure(suiteDescription, t));
} else {
fireTestFailure(notifier, suiteDescription, t);
}
} finally {
// Dispose of resources at suite scope.
RandomizedContext.current().closeResources(
new ResourceDisposal(notifier, suiteDescription), LifecycleScope.SUITE);
}
}
}
} catch (Throwable t) {
notifier.fireTestFailure(new Failure(suiteDescription, t));
} finally {
// Clean up any threads left by hooks methods, but don't try to kill the zombies.
ThreadLeaks tl = onElement(ThreadLeaks.class, defaultThreadLeaks, suiteClass);
checkLeftOverThreads(notifier, LifecycleScope.SUITE, tl, suiteDescription, bulletProofZombies);
// Fire a synthetic "suite ended" event and unsubscribe listeners.
for (RunListener r : autoListeners) {
try {
r.testRunFinished(result);
} catch (Throwable e) {
logger.log(Level.SEVERE, "Panic: RunListener hook shouldn't throw exceptions.", e);
}
}
// Final cleanup.
notifier.removeListener(accounting);
unsubscribeListeners(notifier);
context.popAndDestroy();
}
}
private Statement runTestsStatement(final RunNotifier notifier, final List<TestCandidate> filtered) {
Statement s = new Statement() {
public void evaluate() throws Throwable {
for (final TestCandidate c : filtered) {
final Runnable testRunner = new Runnable() {
public void run() {
// This has a side effect of setting up a nested context for the test thread.
// Do not remove.
RandomizedContext current = RandomizedContext.current();
try {
current.push(new Randomness(c.seed));
runSingleTest(notifier, c);
} catch (Throwable t) {
Rethrow.rethrow(augmentStackTrace(t));
} finally {
current.popAndDestroy();
}
}
};
// If the timeout is zero we'll need to wait for the test to terminate
// anyway, so we just run it from the current thread. Otherwise we spawn
// a child so that we can either kill it or abandon it. This is a bit harsh
// on jvm resources, but will do for now.
// This is also the place where we, theoretically at least, could spawn
// multi-threaded tests. Simply by using executor service to run testRunners
final int timeout = determineTimeout(c);
if (timeout == 0) {
testRunner.run();
} else {
runAndWait(notifier, c, testRunner, timeout);
}
notifier.fireTestFinished(c.description);
}
}
};
return s;
}
private void fireTestFailure(RunNotifier notifier, Description description, Throwable t) {
if (t instanceof MultipleFailureException) {
for (Throwable nested : ((MultipleFailureException) t).getFailures()) {
fireTestFailure(notifier, description, nested);
}
} else {
notifier.fireTestFailure(new Failure(description, t));
}
}
/**
* Decorate a {@link Statement} with {@link BeforeClass} hooks.
*/
private Statement withClassBefores(RunNotifier notifier, final Statement s) {
return new Statement() {
@Override
public void evaluate() throws Throwable {
try {
for (Method method : getTargetMethods(BeforeClass.class)) {
invoke(method, null);
}
} catch (Throwable t) {
throw augmentStackTraceNoContext(t, runnerRandomness);
}
s.evaluate();
}
};
}
private Statement withClassAfters(final RunNotifier notifier, final Statement s) {
return new Statement() {
@Override
public void evaluate() throws Throwable {
List<Throwable> errors = new ArrayList<Throwable>();
try {
s.evaluate();
} catch (Throwable t) {
errors.add(augmentStackTraceNoContext(t, runnerRandomness));
}
for (Method method : getTargetMethods(AfterClass.class)) {
try {
invoke(method, null);
} catch (Throwable t) {
errors.add(augmentStackTraceNoContext(t, runnerRandomness));
}
}
MultipleFailureException.assertEmpty(errors);
}
};
}
/**
* Wrap with {@link ClassRule}s.
*/
private Statement withClassRules(RunNotifier notifier, Statement s) {
List<TestRule> classRules =
getAnnotatedFieldValues(null, ClassRule.class, TestRule.class);
for (TestRule rule : classRules) {
s = rule.apply(s, suiteDescription);
}
return s;
}
/**
* Run the provided <code>runnable</code> in a separate spawned
* thread and wait for it to either complete execution or terminate
* it prematurely if timeout expires, logging an exception.
*/
private void runAndWait(RunNotifier notifier, TestCandidate c, Runnable runnable, int timeout) {
Thread t = new Thread(runnable,
RandomizedRunner.class.getSimpleName() +
"-TestThread-" + suiteClass.getName() +
"-seed#" + SeedUtils.formatSeedChain(runnerRandomness));
try {
t.start();
t.join(timeout);
if (t.isAlive()) {
ThreadLeaks tl = onElement(ThreadLeaks.class, defaultThreadLeaks, c.method, suiteClass);
terminateAndFireFailure(t, notifier, c.description, tl.stackSamples(), "Test case thread timed out ");
if (t.isAlive()) {
bulletProofZombies.add(t);
}
}
} catch (InterruptedException e) {
throw new RuntimeException("Interrupted while waiting for worker? Weird.", e);
}
}
/**
* Runs a single test.
*/
private void runSingleTest(final RunNotifier notifier, final TestCandidate c) {
notifier.fireTestStarted(c.description);
if (isIgnored(c)) {
notifier.fireTestIgnored(c.description);
return;
}
Set<Thread> beforeTestSnapshot = threadsSnapshot();
final Object instance;
try {
// Get the test instance.
instance = c.instanceProvider.newInstance();
// Collect rules and execute wrapped method.
Statement s = new Statement() {
public void evaluate() throws Throwable {
invoke(c.method, instance);
}
};
s = wrapExpectedExceptions(s, c, instance);
s = wrapBeforeAndAfters(s, c, instance, notifier);
s = wrapMethodRules(s, c, instance);
s.evaluate();
} catch (Throwable e) {
boolean isKilled = runnerThreadGroup.isKilled(Thread.currentThread());
// Check if it's the runner trying to kill the thread. If so,
// there is no point in reporting such an exception back. Also,
// if the thread's been killed, we will not run any hooks (this is
// pretty much a situation in which the world ends).
if (isKilled && e instanceof ThreadDeath) {
// TODO: System.exit() wouldn't run any post-cleanup on hooks. A better
// way to resolve this would be to mark a global condition to ignore
// all the remaining tests (fail with an assumption exception saying
// there's a boogieman around or something).
return;
}
if (!isKilled) {
// Augment stack trace and inject a fake stack entry with seed information.
e = augmentStackTrace(e);
if (e instanceof AssumptionViolatedException) {
notifier.fireTestAssumptionFailed(new Failure(c.description, e));
} else {
fireTestFailure(notifier, c.description, e);
}
}
}
// Dispose of resources at test scope.
RandomizedContext.current().closeResources(
new ResourceDisposal(notifier, c.description), LifecycleScope.TEST);
// Check for run-away threads at the test level.
ThreadLeaks tl = onElement(ThreadLeaks.class, defaultThreadLeaks, c.method, suiteClass);
checkLeftOverThreads(notifier, LifecycleScope.TEST, tl, c.description, beforeTestSnapshot);
// Process uncaught exceptions, if any.
runnerThreadGroup.processUncaught(notifier, c.description);
}
/**
* Wrap before and after hooks.
* @param notifier
*/
private Statement wrapBeforeAndAfters(Statement s, final TestCandidate c, final Object instance, final RunNotifier notifier) {
// Process @Before hooks. The first @Before to fail will immediately stop processing any other @Befores.
final List<Method> befores = getTargetMethods(Before.class);
if (!befores.isEmpty()) {
final Statement afterBefores = s;
s = new Statement() {
@Override
public void evaluate() throws Throwable {
for (Method m : befores) {
invoke(m, instance);
}
afterBefores.evaluate();
}
};
}
// Process @After hooks. All @After hooks are processed, regardless of their own exceptions.
final List<Method> afters = getTargetMethods(After.class);
if (!afters.isEmpty()) {
final Statement afterAfters = s;
s = new Statement() {
@Override
public void evaluate() throws Throwable {
List<Throwable> cumulative = new ArrayList<Throwable>();
try {
afterAfters.evaluate();
} catch (Throwable t) {
cumulative.add(t);
}
// All @Afters must be called.
for (Method m : afters) {
try {
invoke(m, instance);
} catch (Throwable t) {
cumulative.add(t);
}
}
// At end, throw the exception or cumulate.
//
// TODO: this is unfortunate, but we need to propagate exceptions up the stack because
// certain rules may choose to... ignore exceptions that happened on the @After hooks.
// it really should be a requirement that hook methods do _not_ throw any excepions
// and if they do (unchecked), these should be propagated to the notifier and not up
// the stack (where they can be ignored or obscured).
if (cumulative.size() == 1) {
throw cumulative.get(0);
}
if (cumulative.size() > 1) {
throw new MultipleFailureException(cumulative);
}
}
};
}
return s;
}
/**
* Wrap the given statement into another catching the expected exception, if declared.
*/
private Statement wrapExpectedExceptions(final Statement s, TestCandidate c, Object instance) {
Test ann = c.method.getAnnotation(Test.class);
if (ann == null) {
return s;
}
// If there's no expected class, don't wrap. Eh, None is package-private...
final Class<? extends Throwable> expectedClass = ann.expected();
if (expectedClass.getName().equals("org.junit.Test$None")) {
return s;
}
return new Statement() {
@Override
public void evaluate() throws Throwable {
try {
s.evaluate();
} catch (Throwable t) {
if (!expectedClass.isInstance(t)) {
throw t;
}
// We caught something that was expected. No worries then.
return;
}
// If we're here this means we passed the test that expected a failure.
Assert.fail("Expected an exception but the test passed: "
+ expectedClass.getName());
}
};
}
/**
* Wrap the given statement in any declared MethodRules (old style rules).
*/
@SuppressWarnings("deprecation")
private Statement wrapMethodRules(Statement s, TestCandidate c, Object instance) {
FrameworkMethod fm = new FrameworkMethod(c.method);
// Old-style MethodRules first.
List<org.junit.rules.MethodRule> methodRules =
getAnnotatedFieldValues(instance, Rule.class, org.junit.rules.MethodRule.class);
for (org.junit.rules.MethodRule rule : methodRules) {
s = rule.apply(s, fm, instance);
}
// New-style TestRule next.
List<TestRule> testRules =
getAnnotatedFieldValues(instance, Rule.class, TestRule.class);
for (TestRule rule : testRules) {
s = rule.apply(s, c.description);
}
return s;
}
/*
* We're using JUnit infrastructure here, but provide constant
* ordering of the result. The returned list has class...super order.
*/
private <T> List<T> getAnnotatedFieldValues(Object test,
Class<? extends Annotation> annotationClass, Class<T> valueClass) {
TestClass info = new TestClass(suiteClass);
List<T> results = new ArrayList<T>();
List<FrameworkField> annotatedFields =
new ArrayList<FrameworkField>(info.getAnnotatedFields(annotationClass));
// Split fields by class
final HashMap<Class<?>, List<FrameworkField>> byClass =
new HashMap<Class<?>, List<FrameworkField>>();
for (FrameworkField field : annotatedFields) {
Class<?> clz = field.getField().getDeclaringClass();
if (!byClass.containsKey(clz)) {
byClass.put(clz, new ArrayList<FrameworkField>());
}
byClass.get(clz).add(field);
}
// Consistent order at class level.
for (List<FrameworkField> fields : byClass.values()) {
Collections.sort(fields, new Comparator<FrameworkField>() {
@Override
public int compare(FrameworkField o1, FrameworkField o2) {
return o1.getField().getName().compareTo(
o2.getField().getName());
}
});
Collections.shuffle(fields, new Random(runnerRandomness.seed));
}
annotatedFields.clear();
for (Class<?> clz = suiteClass; clz != null; clz = clz.getSuperclass()) {
List<FrameworkField> clzFields = byClass.get(clz);
if (clzFields != null) {
annotatedFields.addAll(clzFields);
}
}
for (FrameworkField each : annotatedFields) {
try {
Object fieldValue = each.get(test);
if (valueClass.isInstance(fieldValue))
results.add(valueClass.cast(fieldValue));
} catch (IllegalAccessException e) {
throw new RuntimeException(e);
}
}
return results;
}
/**
* Create randomized context for the run. The context is shared by all
* threads in a given thread group (but the source of {@link Randomness}
* is assigned per-thread).
*/
private RandomizedContext createContext(ThreadGroup tg) {
return RandomizedContext.create(tg, suiteClass, this);
}
/**
* Attempt to terminate a given thread and log appropriate messages.
*/
private void terminateAndFireFailure(Thread t, RunNotifier notifier, Description d, int stackSamples, String msg) {
// The initial early probe.
StackTraceElement[] stackTrace = t.getStackTrace();
RandomizedContext ctx = null;
try {
ctx = RandomizedContext.context(t);
} catch (IllegalStateException e) {
if (t.getThreadGroup() != null)
logger.severe("No context information for this thread?: " + t + ", " + e.getMessage());
}
// Collect stack probes, if requested.
List<StackTraceElement[]> stackProbes = new ArrayList<StackTraceElement[]>();
Random r = new Random(ctx != null ? ctx.getRunnerSeed() : 0xDEADBEEF);
for (int i = Math.max(0, stackSamples); i > 0 && t.isAlive(); i--) {
try {
Thread.sleep(RandomInts.randomIntBetween(r, 10, 100));
} catch (InterruptedException e) {
break;
}
StackTraceElement[] sample = t.getStackTrace();
if (sample.length > 0)
stackProbes.add(sample);
}
if (stackProbes.size() > 0) {
reportStackProbes(stackProbes);
}
// Finally, try to terminate the thread.
tryToTerminate(t);
State s = t.getState();
String message =
msg +
(s != State.TERMINATED ? " (and NOT TERMINATED, left in state " + s + ")": " (and terminated)") +
": " + t.toString() +
" (stack trace is a snapshot location of the thread at the moment of killing, " +
"see the system logger for probes and more information).";
ThreadingError ex = new ThreadingError(message);
ex.setStackTrace(stackTrace);
if (ctx != null) {
ex = augmentStackTrace(ex);
}
notifier.fireTestFailure(new Failure(d, ex));
}
/**
* Analyze the given stacks and try to find the "divergence point" (common root) at which
* the thread was all the time during probing.
*/
private void reportStackProbes(List<StackTraceElement[]> stackProbes) {
if (stackProbes.size() == 0)
return;
Iterator<StackTraceElement[]> i = stackProbes.iterator();
List<StackTraceElement> commonRoot = new ArrayList<StackTraceElement>();
commonRoot.addAll(Arrays.asList(i.next()));
Collections.reverse(commonRoot);
while (i.hasNext()) {
List<StackTraceElement> sample = new ArrayList<StackTraceElement>(Arrays.asList(i.next()));
Collections.reverse(sample);
int k = 0;
for (; k < Math.min(commonRoot.size(), sample.size()); k++) {
if (!commonRoot.get(k).equals(sample.get(k)))
break;
}
commonRoot.subList(k, commonRoot.size()).clear();
}
Collections.reverse(commonRoot);
StringBuilder b = new StringBuilder();
b.append(stackProbes.size())
.append(" stack trace probe(s) taken and the constant root was:\n ...\n");
traces.formatStackTrace(b, commonRoot);
b.append("\nDiverging stack paths from individual probes (if different than the common root):\n");
int reported = 0;
for (int j = 0; j < stackProbes.size(); j++) {
StackTraceElement[] sample = stackProbes.get(j);
List<StackTraceElement> divergent =
Arrays.asList(sample).subList(0, sample.length - commonRoot.size());
if (divergent.size() > 0) {
b.append("Probe #" + (j + 1) + "\n");
traces.formatStackTrace(b, divergent);
b.append(" ...\n");
reported++;
}
}
if (reported == 0) {
b.append("(all stacks constant.)\n");
}
logger.warning(b.toString());
}
/**
* Try to terminate a given thread.
*/
@SuppressWarnings("deprecation")
private void tryToTerminate(Thread t) {
if (!t.isAlive()) return;
String tname = t.getName() + "(#" + System.identityHashCode(t) + ")";
// We mark the thread as being killed because once we start calling
// interrupt or stop weird things can happen. Any logged exceptions should
// make it clear the thread is being killed.
runnerThreadGroup.markAsBeingTerminated(t);
logger.warning("Attempting to terminate thread: " + tname + ", currently at:\n"
+ traces.formatStackTrace(t.getStackTrace()));
// Try to interrupt first.
int interruptAttempts = this.killAttempts;
int interruptWait = this.killWait;
do {
try {
t.interrupt();
t.join(interruptWait);
} catch (InterruptedException e) { /* ignore */ }
if (!t.isAlive()) break;
logger.fine("Trying to interrupt thread: " + tname
+ ", retries: " + interruptAttempts + ", currently at: "
+ traces.formatStackTrace(t.getStackTrace()));
} while (--interruptAttempts >= 0);
if (!t.isAlive()) {
logger.warning("Interrupted a runaway thread: " + tname);
}
if (t.isAlive()) {
logger.warning("Does not respond to interrupt(), trying to stop(): " + tname);
// Try to sent ThreadDeath up its stack if interrupt is not working.
int killAttempts = this.killAttempts;
int killWait = this.killWait;
do {
try {
t.stop();
t.join(killWait);
} catch (InterruptedException e) { /* ignore */ }
if (!t.isAlive()) break;
logger.fine("Trying to stop a runaway thread: " + tname
+ ", retries: " + killAttempts + ", currently at: "
+ traces.formatStackTrace(t.getStackTrace()));
} while (--killAttempts >= 0);
if (!t.isAlive()) {
logger.warning("Stopped a runaway thread: " + tname);
}
}
if (t.isAlive()) {
logger.severe("Could not interrupt or stop thread: " + tname);
}
}
/**
* Check for any left-over threads compared to expected state, notify
* the runner about left-over threads and return the difference.
*/
private void checkLeftOverThreads(RunNotifier notifier,
LifecycleScope scope, ThreadLeaks threadLeaks,
Description description, Set<Thread> expectedState) {
int lingerTime = threadLeaks.linger();
Set<Thread> now;
if (lingerTime > 0) {
final long deadline = System.currentTimeMillis() + lingerTime;
try {
do {
now = threadsSnapshot();
now.removeAll(expectedState);
filterJreDaemonThreads(now);
if (now.isEmpty() || System.currentTimeMillis() > deadline)
break;
Thread.sleep(/* off the top of my head */ 100);
} while (true);
} catch (InterruptedException e) {
logger.severe("Panic: lingering interrupted?");
}
}
now = threadsSnapshot();
now.removeAll(expectedState);
filterJreDaemonThreads(now);
if (!now.isEmpty()) {
if (scope == LifecycleScope.TEST && threadLeaks.leakedThreadsBelongToSuite()) {
/*
* Do nothing. Left-over threads will be re-evaluated at suite level again.
*/
} else {
if (threadLeaks.failTestIfLeaking()) {
now = terminateAndFireFailureForAll(now, notifier, description, threadLeaks);
}
bulletProofZombies.addAll(now);
}
}
}
/**
* Attempts to terminate all threads at once.
* @return Returns the set of threads that couldn't be terminated properly.
*/
private Set<Thread> terminateAndFireFailureForAll(Set<Thread> now,
final RunNotifier notifier,
final Description description,
final ThreadLeaks threadLeaks) {
// TODO: this routine could be done from a single thread by it would make the code
// much more complex so we go with the easy (although resource-consuming) way now.
final CountDownLatch latch = new CountDownLatch(1);
List<Thread> rickDeckards = new ArrayList<Thread>(now.size());
for (final Thread t : now) {
rickDeckards.add(new Thread() {
@Override
public void run() {
try {
latch.await();
terminateAndFireFailure(
t, notifier, description,
threadLeaks.stackSamples(),
"Left-over thread detected ");
} catch (Throwable x) {
logger.log(Level.SEVERE, "Rick Deckard exception?", x);
}
}
});
}
for (Thread t : rickDeckards) {
t.setPriority(Thread.MAX_PRIORITY);
t.start();
}
latch.countDown();
for (Thread t : rickDeckards) {
while (true) {
try {
t.join();
break;
} catch (InterruptedException e) {
continue;
}
}
}
Set<Thread> s = new HashSet<Thread>();
for (Thread t : now) {
if (t.isAlive()) {
s.add(t);
}
}
return s;
}
/**
* There are certain threads that are spawned by the standard library and over which
* we have no direct control. Just ignore them.
*/
private void filterJreDaemonThreads(Set<Thread> now) {
Iterator<Thread> i = now.iterator();
while (i.hasNext()) {
if (isJreDaemonThread(i.next()))
i.remove();
}
}
/**
* Check against daemon threads.
*/
private boolean isJreDaemonThread(Thread t) {
List<StackTraceElement> stack = new ArrayList<StackTraceElement>(Arrays.asList(t.getStackTrace()));
Collections.reverse(stack);
// Check for TokenPoller (MessageDigest spawns it).
if (stack.size() > 2 &&
stack.get(1).getClassName().startsWith("sun.security.pkcs11.SunPKCS11$TokenPoller")) {
return true;
}
return false;
}
/**
* Run any {@link Validators} declared on the suite.
*/
private boolean runCustomValidators(RunNotifier notifier) {
for (Validators ann : getAnnotationsFromClassHierarchy(suiteClass, Validators.class)) {
List<ClassValidator> validators = new ArrayList<ClassValidator>();
try {
for (Class<? extends ClassValidator> validatorClass : ann.value()) {
try {
validators.add(validatorClass.newInstance());
} catch (Throwable t) {
throw new RuntimeException("Could not initialize suite class: "
+ suiteClass.getName() + " because its @ClassValidators contains non-instantiable: "
+ validatorClass.getName(), t);
}
}
for (ClassValidator v : validators) {
v.validate(suiteClass);
}
} catch (Throwable t) {
notifier.fireTestFailure(new Failure(suiteDescription, t));
return false;
}
}
return true;
}
/** Subscribe annotation listeners to the notifier. */
private void subscribeListeners(RunNotifier notifier) {
for (Listeners ann : getAnnotationsFromClassHierarchy(suiteClass, Listeners.class)) {
for (Class<? extends RunListener> clazz : ann.value()) {
try {
RunListener listener = clazz.newInstance();
autoListeners.add(listener);
notifier.addListener(listener);
} catch (Throwable t) {
throw new RuntimeException("Could not initialize suite class: "
+ suiteClass.getName() + " because its @Listener is not instantiable: "
+ clazz.getName(), t);
}
}
}
}
/** Unsubscribe listeners. */
private void unsubscribeListeners(RunNotifier notifier) {
for (RunListener r : autoListeners)
notifier.removeListener(r);
}
/**
* Apply filtering to candidates.
*/
private List<TestCandidate> getFilteredTestCandidates() {
// Apply suite filters.
if (!suiteFilters.isEmpty()) {
for (Filter f : suiteFilters) {
if (!f.shouldRun(suiteDescription)) {
return Collections.emptyList();
}
}
}
// Apply method filters.
if (testFilters.isEmpty()) {
return testCandidates;
}
final List<TestCandidate> filtered = new ArrayList<TestCandidate>(testCandidates);
for (Iterator<TestCandidate> i = filtered.iterator(); i.hasNext(); ) {
final TestCandidate candidate = i.next();
for (Filter f : testFilters) {
if (!f.shouldRun(Description.createTestDescription(
candidate.getTestClass(), candidate.method.getName()))) {
i.remove();
break;
}
}
}
return filtered;
}
/**
* Normalize empty strings to nulls.
*/
static String emptyToNull(String value) {
if (value == null || value.trim().isEmpty())
return null;
return value.trim();
}
/**
* Returns true if we should ignore this test candidate.
*/
@SuppressWarnings("all")
private boolean isIgnored(final TestCandidate c) {
if (c.method.getAnnotation(Ignore.class) != null)
return true;
final HashMap<Class<? extends Annotation>,RuntimeTestGroup> testGroups =
RandomizedContext.current().getTestGroups();
// Check if any of the test's annotations is a TestGroup. If so, check if it's disabled
// and ignore test if so.
for (AnnotatedElement element : Arrays.asList(c.method, suiteClass)) {
for (Annotation ann : element.getAnnotations()) {
RuntimeTestGroup g = testGroups.get(ann.annotationType());
if (g != null && !g.isEnabled()) {
// Ignore this test.
return true;
}
}
}
return false;
}
/**
* Construct a list of ordered framework methods. Minor tweaks are done depending
* on the annotation (reversing order, etc.).
*/
private List<Method> getTargetMethods(Class<? extends Annotation> ann) {
List<List<Method>> list = mutableCopy2(
removeShadowed(removeOverrides(annotatedWith(allTargetMethods, ann))));
// Reverse processing order to super...clazz for befores
if (ann == Before.class || ann == BeforeClass.class) {
Collections.reverse(list);
}
// Shuffle at class level.
Random rnd = new Random(runnerRandomness.seed);
for (List<Method> clazzLevel : list) {
Collections.shuffle(clazzLevel, rnd);
}
return flatten(list);
}
/**
* Collect all test candidates, regardless if they will be executed or not. At this point
* individual test methods are also expanded into multiple executions corresponding
* to the number of iterations ({@link #SYSPROP_ITERATIONS}) and the initial method seed
* is preassigned.
*
* <p>The order of test candidates is shuffled based on the runner's random.</p>
*
* @see Rants#RANT_1
*/
private List<TestCandidate> collectTestCandidates(Description classDescription) {
// Get the test instance provider if explicitly stated.
TestMethodProviders providersAnnotation =
suiteClass.getAnnotation(TestMethodProviders.class);
// If nothing, fallback to the default.
final TestMethodProvider [] providers;
if (providersAnnotation != null) {
providers = new TestMethodProvider [providersAnnotation.value().length];
int i = 0;
for (Class<? extends TestMethodProvider> clazz : providersAnnotation.value()) {
try {
providers[i++] = clazz.newInstance();
} catch (Exception e) {
throw new RuntimeException(TestMethodProviders.class.getSimpleName() +
" classes could not be instantiated.", e);
}
}
} else {
providers = new TestMethodProvider [] {
new JUnit4MethodProvider(),
// new JUnit3MethodProvider(),
};
}
// Get test methods from providers.
final Set<Method> allTestMethods = new TreeSet<Method>(new Comparator<Method>() {
@Override
public int compare(Method m1, Method m2) {
return m1.getName().compareTo(m2.getName());
}
});
List<List<Method>> candidates = removeShadowed(removeOverrides(allTargetMethods));
for (TestMethodProvider provider : providers) {
allTestMethods.addAll(provider.getTestMethods(suiteClass, immutableCopy(candidates)));
}
List<Method> testMethods = new ArrayList<Method>(allTestMethods);
// Perform candidate method validation.
validateTestMethods(testMethods);
// Shuffle at real test-case level, don't shuffle iterations or explicit @Seeds order.
Collections.shuffle(testMethods, new Random(runnerRandomness.seed));
final Constructor<?> constructor = suiteClass.getConstructors()[0];
// Collect parameters.
ArrayList<Object[]> parameters = new ArrayList<Object[]>();
if (constructor.getParameterTypes().length == 0) {
parameters.add(new Object[] {});
} else {
try {
parameters = collectFactoryParameters();
} catch (AssumptionViolatedException e) {
return Collections.emptyList();
}
}
// TODO: The loops and conditions below are truly horrible...
List<TestCandidate> allTests = new ArrayList<TestCandidate>();
Map<Method, Description> subNodes = new HashMap<Method, Description>();
if (parameters.size() > 1) {
for (Method method : testMethods) {
Description tmp = Description.createSuiteDescription(method.getName());
subNodes.put(method, tmp);
suiteDescription.addChild(tmp);
}
}
// Collect annotated parameter names. We could use .class file parsing to get at
// the local variables table, but this seems like an overkill.
String [] parameterNames = new String [constructor.getParameterTypes().length];
Annotation [][] anns = constructor.getParameterAnnotations();
for (int i = 0; i < parameterNames.length; i++) {
for (Annotation ann : anns[i]) {
if (ann != null && ann.annotationType().equals(Name.class)) {
parameterNames[i] = ((Name) ann).value() + "=";
break;
}
}
if (parameterNames[i] == null) {
parameterNames[i] = "p" + i + "=";
}
}
for (Object [] params : parameters) {
final LinkedHashMap<String, Object> parameterizedArgs = new LinkedHashMap<String, Object>();
for (int i = 0; i < params.length; i++) {
parameterizedArgs.put(
i < parameterNames.length ? parameterNames[i] : "p" + i + "=", params[i]);
}
for (Method method : testMethods) {
final List<TestCandidate> methodTests =
collectCandidatesForMethod(constructor, params, method, parameterizedArgs);
final Description parent;
Description tmp = subNodes.get(method);
if (tmp == null && methodTests.size() > 1) {
tmp = Description.createSuiteDescription(method.getName());
subNodes.put(method, tmp);
suiteDescription.addChild(tmp);
} else {
if (tmp == null)
tmp = suiteDescription;
}
parent = tmp;
for (TestCandidate c : methodTests) {
parent.addChild(c.description);
allTests.add(c);
}
}
}
return allTests;
}
/**
* Collect test candidates for a single method and the given seed.
*/
private List<TestCandidate> collectCandidatesForMethod(
final Constructor<?> constructor, final Object[] params, Method method,
LinkedHashMap<String, Object> parameterizedArgs) {
final List<TestCandidate> candidates = new ArrayList<TestCandidate>();
final boolean fixedSeed = isConstantSeedForAllIterations(method);
final int methodIterations = determineMethodIterationCount(method);
final long[] seeds = determineMethodSeeds(method);
final boolean hasRepetitions = (methodIterations > 1 || seeds.length > 1);
int repetition = 0;
for (final long testSeed : seeds) {
for (int i = 0; i < methodIterations; i++, repetition++) {
final long thisSeed = (fixedSeed ? testSeed : testSeed ^ MurmurHash3.hash((long) i));
final LinkedHashMap<String, Object> args = new LinkedHashMap<String, Object>();
if (hasRepetitions) {
args.put("#", repetition);
}
args.putAll(parameterizedArgs);
if (hasRepetitions || appendSeedParameter) {
args.put("seed=", SeedUtils.formatSeedChain(runnerRandomness, new Randomness(thisSeed)));
}
Description description = Description.createSuiteDescription(
String.format("%s%s(%s)", method.getName(), formatMethodArgs(args), suiteClass.getName()));
// Create an instance and delay instantiation exception if not possible.
candidates.add(new TestCandidate(method, thisSeed, description, new InstanceProvider() {
@Override
public Object newInstance() throws Throwable {
try {
return constructor.newInstance(params);
} catch (InvocationTargetException e) {
throw ((InvocationTargetException) e).getTargetException();
} catch (IllegalArgumentException e) {
throw new IllegalArgumentException(
"Constructor arguments do not match provider parameters?", e);
}
}
@Override
public Class<?> getTestClass() {
return suiteClass;
}
}));
}
}
return candidates;
}
private String formatMethodArgs(LinkedHashMap<String, Object> args) {
if (args.isEmpty()) return "";
StringBuilder b = new StringBuilder();
b.append(" {");
for (Iterator<Map.Entry<String, Object>> i = args.entrySet().iterator(); i.hasNext();) {
Map.Entry<String, Object> e = i.next();
b.append(e.getKey()).append(toString(e.getValue()));
if (i.hasNext()) b.append(" ");
}
b.append("}");
return b.toString();
}
/**
* Convert value to a stringified form for naming parameterized methods.
*/
private String toString(Object value) {
if (value == null) return "null";
// TODO: handle arrays in a nicer way.
return value.toString();
}
/**
* Collect parameters from factory methods.
*/
@SuppressWarnings("all")
public ArrayList<Object[]> collectFactoryParameters() {
ArrayList<Object[]> parameters = new ArrayList<Object[]>();
for (Method m : flatten(removeShadowed(annotatedWith(allTargetMethods, ParametersFactory.class)))) {
Validation.checkThat(m).isStatic().isPublic();
if (!Iterable.class.isAssignableFrom(m.getReturnType())) {
throw new RuntimeException("@" + ParametersFactory.class.getSimpleName() + " annotated " +
"methods must be public, static and returning Iterable<Object[]>:" + m);
}
List<Object[]> result = new ArrayList<Object[]>();
try {
for (Object [] p : (Iterable<Object[]>) m.invoke(null))
result.add(p);
} catch (InvocationTargetException e) {
Rethrow.rethrow(e.getCause());
} catch (Throwable t) {
throw new RuntimeException("Error collecting parameters from: " + m, t);
}
if (result.isEmpty()) {
throw new AssumptionViolatedException("Parameters set should not be empty. Ignoring tests.");
}
parameters.addAll(result);
}
return parameters;
}
/**
* Collect all test groups.
*/
private HashMap<Class<? extends Annotation>, RuntimeTestGroup> collectGroups(
List<TestCandidate> testCandidates) {
final HashMap<Class<? extends Annotation>, RuntimeTestGroup> groups =
new HashMap<Class<? extends Annotation>, RuntimeTestGroup>();
// Always use @Nightly as a group.
groups.put(Nightly.class, new RuntimeTestGroup(defaultNightly));
// Collect all groups declared on methods and instance classes.
HashSet<Class<?>> clazzes = new HashSet<Class<?>>();
HashSet<Annotation> annotations = new HashSet<Annotation>();
for (TestCandidate c : testCandidates) {
if (!clazzes.contains(c.getTestClass())) {
clazzes.add(c.getTestClass());
annotations.addAll(Arrays.asList(c.getTestClass().getAnnotations()));
}
annotations.addAll(Arrays.asList(c.method.getAnnotations()));
}
// Check all annotations.
for (Annotation ann : annotations) {
if (!groups.containsKey(ann)
&& ann.annotationType().isAnnotationPresent(TestGroup.class)) {
groups.put(ann.annotationType(), new RuntimeTestGroup(ann));
}
}
return groups;
}
/**
* Determine if a given method's iterations should run with a fixed seed or not.
*/
private boolean isConstantSeedForAllIterations(Method method) {
if (testCaseRandomnessOverride != null)
return true;
Repeat repeat;
if ((repeat = method.getAnnotation(Repeat.class)) != null) {
return repeat.useConstantSeed();
}
if ((repeat = suiteClass.getAnnotation(Repeat.class)) != null) {
return repeat.useConstantSeed();
}
return false;
}
/**
* Determine method iteration count based on (first declaration order wins):
* <ul>
* <li>global property {@link #SYSPROP_ITERATIONS}.</li>
* <li>method annotation {@link Repeat}.</li>
* <li>class annotation {@link Repeat}.</li>
* <li>The default (1).</li>
* <ul>
*/
private int determineMethodIterationCount(Method method) {
// Global override.
if (iterationsOverride != null)
return iterationsOverride;
Repeat repeat;
if ((repeat = method.getAnnotation(Repeat.class)) != null) {
return repeat.iterations();
}
if ((repeat = suiteClass.getAnnotation(Repeat.class)) != null) {
return repeat.iterations();
}
return DEFAULT_ITERATIONS;
}
/**
* Determine a given method's initial random seed.
*
* @see Seed
* @see Seeds
*/
private long [] determineMethodSeeds(Method method) {
if (testCaseRandomnessOverride != null) {
return new long [] { testCaseRandomnessOverride.seed };
}
// We assign each method a different starting hash based on the global seed
// and a hash of their name (so that the order of methods does not matter, only
// their names). Take into account global override and method and class level
// {@link Seed} annotations.
final long randomSeed =
runnerRandomness.seed ^ MurmurHash3.hash((long) method.getName().hashCode());
final HashSet<Long> seeds = new HashSet<Long>();
// Check method-level @Seed and @Seeds annotation first.
// They take precedence over anything else.
Seed seed;
if ((seed = method.getAnnotation(Seed.class)) != null) {
for (long s : seedFromAnnot(method, randomSeed)) {
seeds.add(s);
}
}
// Check a number of seeds on a single method.
if (method.isAnnotationPresent(Seeds.class)) {
for (Seed s : method.getAnnotation(Seeds.class).value()) {
if (s.value().equals("random"))
seeds.add(randomSeed);
else {
for (long s2 : SeedUtils.parseSeedChain(s.value())) {
seeds.add(s2);
}
}
}
}
// Check suite-level override.
if (seeds.isEmpty()) {
if ((seed = suiteClass.getAnnotation(Seed.class)) != null) {
if (!seed.value().equals("random")) {
long [] seedChain = SeedUtils.parseSeedChain(suiteClass.getAnnotation(Seed.class).value());
if (seedChain.length > 1)
seeds.add(seedChain[1]);
}
}
}
// If still empty, add the derived random seed.
if (seeds.isEmpty()) {
seeds.add(randomSeed);
}
long [] result = new long [seeds.size()];
int i = 0;
for (Long s : seeds) {
result[i++] = s;
}
return result;
}
/**
* Determine timeout for a given test candidate.
*/
private int determineTimeout(TestCandidate c) {
// initial value
int timeout = this.timeoutOverride;
// GH-75: take into account the need to override timeouts for debugging sessions.
if (globalTimeoutFirst) {
return timeout;
}
// Class-override.
Timeout timeoutAnn = c.method.getDeclaringClass().getAnnotation(Timeout.class);
if (timeoutAnn != null) {
timeout = timeoutAnn.millis();
}
// @Test annotation timeout value.
Test testAnn = c.method.getAnnotation(Test.class);
if (testAnn != null && testAnn.timeout() > 0) {
timeout = (int) Math.min(Integer.MAX_VALUE, testAnn.timeout());
}
// Method-override.
timeoutAnn = c.method.getAnnotation(Timeout.class);
if (timeoutAnn != null) {
timeout = timeoutAnn.millis();
}
return timeout;
}
/**
* Invoke a given method on a suiteClass instance (can be null for static methods).
*/
private void invoke(Method m, Object instance, Object... args) throws Throwable {
if (!Modifier.isPublic(m.getModifiers())) {
try {
if (!m.isAccessible()) {
m.setAccessible(true);
}
} catch (SecurityException e) {
throw new RuntimeException("There is a non-public method that needs to be called. This requires " +
"ReflectPermission('suppressAccessChecks'). Don't run with the security manager or " +
" add this permission to the runner. Offending method: " + m.toGenericString());
}
}
try {
m.invoke(instance, args);
} catch (InvocationTargetException e) {
throw e.getCause();
}
}
/**
* Perform additional checks on methods returned from the providers.
*/
private void validateTestMethods(List<Method> testMethods) {
HashSet<Class<?>> parents = new HashSet<Class<?>>();
for (Class<?> c = suiteClass; c != null; c = c.getSuperclass()) {
parents.add(c);
}
for (Method method : testMethods) {
if (!parents.contains(method.getDeclaringClass())) {
throw new IllegalArgumentException("Test method does not belong to " +
"test suite class hierarchy: " + method.getDeclaringClass() + "#" +
method.getName());
}
// public * method()
Validation.checkThat(method)
.describedAs("Test method " + suiteClass.getName() + "#" + method.getName())
.isPublic()
.isNotStatic()
.hasArgsCount(0);
// No @Test(timeout=...) and @Timeout at the same time.
Test testAnn = method.getAnnotation(Test.class);
if (testAnn != null && testAnn.timeout() > 0 && method.isAnnotationPresent(Timeout.class)) {
throw new IllegalArgumentException("Conflicting @Test(timeout=...) and @Timeout " +
"annotations in: " + suiteClass.getName() + "#" + method.getName());
}
// @Seed annotation on test methods must have at most 1 seed value.
if (method.isAnnotationPresent(Seed.class)) {
try {
String seedChain = method.getAnnotation(Seed.class).value();
if (!seedChain.equals("random")) {
long[] chain = SeedUtils.parseSeedChain(seedChain);
if (chain.length > 1) {
throw new IllegalArgumentException("@Seed on methods must contain one seed only (no runner seed).");
}
}
} catch (IllegalArgumentException e) {
throw new RuntimeException("@Seed annotation invalid on method "
+ method.getName() + ", in class " + suiteClass.getName() + ": "
+ e.getMessage());
}
}
}
}
/**
* Validate methods and hooks in the suiteClass. Follows "standard" JUnit rules,
* with some exceptions on return values and more rigorous checking of shadowed
* methods and fields.
*/
private void validateTarget() {
// Target is accessible (public, concrete, has a parameterless constructor etc).
Validation.checkThat(suiteClass)
.describedAs("Suite class " + suiteClass.getName())
.isPublic()
.isConcreteClass();
// Check constructors.
Constructor<?> [] constructors = suiteClass.getConstructors();
if (constructors.length != 1 || !Modifier.isPublic(constructors[0].getModifiers())) {
throw new RuntimeException("A test class is expected to have one public constructor "
+ " (parameterless or with types matching static @" + ParametersFactory.class
+ "-annotated method's output): " + suiteClass.getName());
}
// If there is a parameterized constructor, look for a static method that privides parameters.
if (constructors[0].getParameterTypes().length > 0) {
List<Method> factories = flatten(removeShadowed(annotatedWith(allTargetMethods, ParametersFactory.class)));
if (factories.isEmpty()) {
throw new RuntimeException("A test class with a parameterized constructor is expected "
+ " to have a static @" + ParametersFactory.class
+ "-annotated method: " + suiteClass.getName());
}
for (Method m : factories) {
Validation.checkThat(m).isStatic().isPublic().hasArgsCount(0)
.hasReturnType(Iterable.class);
}
}
// @BeforeClass
for (Method method : flatten(annotatedWith(allTargetMethods, BeforeClass.class))) {
Validation.checkThat(method)
.describedAs("@BeforeClass method " + suiteClass.getName() + "#" + method.getName())
// .isPublic() // Intentional, you can hide it from subclasses.
.isStatic()
.hasArgsCount(0);
}
// @AfterClass
for (Method method : flatten(annotatedWith(allTargetMethods, AfterClass.class))) {
Validation.checkThat(method)
.describedAs("@AfterClass method " + suiteClass.getName() + "#" + method.getName())
// .isPublic() // Intentional, you can hide it from subclasses.
.isStatic()
.hasArgsCount(0);
}
// @Before
for (Method method : flatten(annotatedWith(allTargetMethods, Before.class))) {
Validation.checkThat(method)
.describedAs("@Before method " + suiteClass.getName() + "#" + method.getName())
// .isPublic() // Intentional, you can hide it from subclasses.
.isNotStatic()
.hasArgsCount(0);
}
// @After
for (Method method : flatten(annotatedWith(allTargetMethods, After.class))) {
Validation.checkThat(method)
.describedAs("@After method " + suiteClass.getName() + "#" + method.getName())
// .isPublic() // Intentional, you can hide it from subclasses.
.isNotStatic()
.hasArgsCount(0);
}
// TODO: Validate @Rule fields (what are the "rules" for these anyway?)
}
/**
* Augment stack trace of the given exception with seed infos.
*/
private static <T extends Throwable> T augmentStackTraceNoContext(T e, Randomness... seeds) {
List<StackTraceElement> stack = new ArrayList<StackTraceElement>(
Arrays.asList(e.getStackTrace()));
stack.add(0, new StackTraceElement(AUGMENTED_SEED_PACKAGE + ".SeedInfo",
"seed", SeedUtils.formatSeedChain(seeds), 0));
e.setStackTrace(stack.toArray(new StackTraceElement [stack.size()]));
return e;
}
/**
* Augment stack trace of the given exception with seed infos from the
* current thread's randomized context.
*/
static <T extends Throwable> T augmentStackTrace(T e) {
RandomizedContext context = RandomizedContext.current();
return augmentStackTraceNoContext(e, context.getRandomnesses());
}
/**
* Return an estimated set of current thread group's
* live threads, excluding the current thread.
*/
private static Set<Thread> threadsSnapshot() {
final Thread current = Thread.currentThread();
final ThreadGroup tg = current.getThreadGroup();
Thread [] list;
do {
list = new Thread [tg.activeCount() + /* padding to detect overflow */ 5];
tg.enumerate(list);
} while (list[list.length - 1] != null);
final HashSet<Thread> result = new HashSet<Thread>();
for (Thread t : list) {
if (t != null && t != current)
result.add(t);
}
return result;
}
/**
* Collect all annotations from a clazz hierarchy. Superclass's annotations come first.
* {@link Inherited} annotations are removed (hopefully, the spec. isn't clear on this whether
* the same object is returned or not for inherited annotations).
*/
private static <T extends Annotation> List<T> getAnnotationsFromClassHierarchy(Class<?> clazz, Class<T> annotation) {
List<T> anns = new ArrayList<T>();
IdentityHashMap<T,T> inherited = new IdentityHashMap<T,T>();
for (Class<?> c = clazz; c != Object.class; c = c.getSuperclass()) {
if (c.isAnnotationPresent(annotation)) {
T ann = c.getAnnotation(annotation);
if (ann.annotationType().isAnnotationPresent(Inherited.class) &&
inherited.containsKey(ann)) {
continue;
}
anns.add(ann);
inherited.put(ann, ann);
}
}
Collections.reverse(anns);
return anns;
}
/**
* Returns an annotation's instance declared on any annotated element (first one wins)
* or the default value if not present on any of them.
*/
private static <T extends Annotation> T onElement(Class<T> clazz, T defaultValue, AnnotatedElement... elements) {
for (AnnotatedElement element : elements) {
T ann = element.getAnnotation(clazz);
if (ann != null) return ann;
}
return defaultValue;
}
/**
* Get an annotated element's {@link Seed} annotation and determine if it's fixed
* or not. If it is fixed, return the seeds. Otherwise return <code>randomSeed</code>.
*/
private long [] seedFromAnnot(AnnotatedElement element, long randomSeed) {
Seed seed = element.getAnnotation(Seed.class);
String seedChain = seed.value();
if (seedChain.equals("random")) {
return new long [] { randomSeed };
}
return SeedUtils.parseSeedChain(seedChain);
}
/**
* Stack trace formatting utilities. These may be initialized to filter out certain packages.
*/
public TraceFormatting getTraceFormatting() {
return traces;
}
/**
* {@link RandomizedRunner} augments stack traces of test methods that ended in an exception
* and inserts a fake entry starting with {@link #AUGMENTED_SEED_PACKAGE}.
*
* @return A string is returned with seeds combined, if any. Null is returned if no augmentation
* can be found.
*/
public static String seedFromThrowable(Throwable t) {
StringBuilder b = new StringBuilder();
while (t != null) {
for (StackTraceElement s : t.getStackTrace()) {
if (s.getClassName().startsWith(AUGMENTED_SEED_PACKAGE)) {
if (b.length() > 0) b.append(", ");
b.append(s.getFileName());
}
}
t = t.getCause();
}
if (b.length() == 0)
return null;
else
return b.toString();
}
/**
* Attempts to extract just the method name from parameterized notation.
*/
public static String methodName(Description description) {
return description.getMethodName().replaceAll("\\s?\\{.+\\}", "");
}
}