/*
* Written by Doug Lea with assistance from members of JCP JSR-166
* Expert Group and released to the public domain, as explained at
* http://creativecommons.org/licenses/publicdomain
* Other contributors include Andrew Wright, Jeffrey Hayes,
* Pat Fisher, Mike Judd.
*/
import junit.framework.*;
import java.util.PropertyPermission;
import java.util.concurrent.*;
import java.util.concurrent.atomic.AtomicReference;
import static java.util.concurrent.TimeUnit.MILLISECONDS;
import java.security.CodeSource;
import java.security.Permission;
import java.security.PermissionCollection;
import java.security.Permissions;
import java.security.Policy;
import java.security.ProtectionDomain;
import java.security.SecurityPermission;
/**
* Base class for JSR166 Junit TCK tests. Defines some constants,
* utility methods and classes, as well as a simple framework for
* helping to make sure that assertions failing in generated threads
* cause the associated test that generated them to itself fail (which
* JUnit does not otherwise arrange). The rules for creating such
* tests are:
*
*
*
* - All assertions in code running in generated threads must use
* the forms {@link #threadFail}, {@link #threadAssertTrue}, {@link
* #threadAssertEquals}, or {@link #threadAssertNull}, (not
* {@code fail}, {@code assertTrue}, etc.) It is OK (but not
* particularly recommended) for other code to use these forms too.
* Only the most typically used JUnit assertion methods are defined
* this way, but enough to live with.
*
* - If you override {@link #setUp} or {@link #tearDown}, make sure
* to invoke {@code super.setUp} and {@code super.tearDown} within
* them. These methods are used to clear and check for thread
* assertion failures.
*
* - All delays and timeouts must use one of the constants {@code
* SHORT_DELAY_MS}, {@code SMALL_DELAY_MS}, {@code MEDIUM_DELAY_MS},
* {@code LONG_DELAY_MS}. The idea here is that a SHORT is always
* discriminable from zero time, and always allows enough time for the
* small amounts of computation (creating a thread, calling a few
* methods, etc) needed to reach a timeout point. Similarly, a SMALL
* is always discriminable as larger than SHORT and smaller than
* MEDIUM. And so on. These constants are set to conservative values,
* but even so, if there is ever any doubt, they can all be increased
* in one spot to rerun tests on slower platforms.
*
* - All threads generated must be joined inside each test case
* method (or {@code fail} to do so) before returning from the
* method. The {@code joinPool} method can be used to do this when
* using Executors.
*
*
*
* Other notes
*
*
* - Usually, there is one testcase method per JSR166 method
* covering "normal" operation, and then as many exception-testing
* methods as there are exceptions the method can throw. Sometimes
* there are multiple tests per JSR166 method when the different
* "normal" behaviors differ significantly. And sometimes testcases
* cover multiple methods when they cannot be tested in
* isolation.
*
* - The documentation style for testcases is to provide as javadoc
* a simple sentence or two describing the property that the testcase
* method purports to test. The javadocs do not say anything about how
* the property is tested. To find out, read the code.
*
* - These tests are "conformance tests", and do not attempt to
* test throughput, latency, scalability or other performance factors
* (see the separate "jtreg" tests for a set intended to check these
* for the most central aspects of functionality.) So, most tests use
* the smallest sensible numbers of threads, collection sizes, etc
* needed to check basic conformance.
*
* - The test classes currently do not declare inclusion in
* any particular package to simplify things for people integrating
* them in TCK test suites.
*
* - As a convenience, the {@code main} of this class (JSR166TestCase)
* runs all JSR166 unit tests.
*
*
*/
public class JSR166TestCase extends TestCase {
private static final boolean useSecurityManager =
Boolean.getBoolean("jsr166.useSecurityManager");
/**
* Runs all JSR166 unit tests using junit.textui.TestRunner
*/
public static void main(String[] args) {
if (useSecurityManager) {
System.err.println("Setting a permissive security manager");
Policy.setPolicy(permissivePolicy());
System.setSecurityManager(new SecurityManager());
}
int iters = 1;
if (args.length > 0)
iters = Integer.parseInt(args[0]);
Test s = suite();
for (int i = 0; i < iters; ++i) {
junit.textui.TestRunner.run(s);
System.gc();
System.runFinalization();
}
System.exit(0);
}
/**
* Collects all JSR166 unit tests as one suite
*/
public static Test suite() {
TestSuite suite = new TestSuite("JSR166 Unit Tests");
suite.addTest(new TestSuite(ForkJoinPoolTest.class));
suite.addTest(new TestSuite(ForkJoinTaskTest.class));
suite.addTest(new TestSuite(RecursiveActionTest.class));
suite.addTest(new TestSuite(RecursiveTaskTest.class));
suite.addTest(new TestSuite(LinkedTransferQueueTest.class));
suite.addTest(new TestSuite(PhaserTest.class));
suite.addTest(new TestSuite(ThreadLocalRandomTest.class));
suite.addTest(new TestSuite(AbstractExecutorServiceTest.class));
suite.addTest(new TestSuite(AbstractQueueTest.class));
suite.addTest(new TestSuite(AbstractQueuedSynchronizerTest.class));
suite.addTest(new TestSuite(AbstractQueuedLongSynchronizerTest.class));
suite.addTest(new TestSuite(ArrayBlockingQueueTest.class));
suite.addTest(new TestSuite(ArrayDequeTest.class));
suite.addTest(new TestSuite(AtomicBooleanTest.class));
suite.addTest(new TestSuite(AtomicIntegerArrayTest.class));
suite.addTest(new TestSuite(AtomicIntegerFieldUpdaterTest.class));
suite.addTest(new TestSuite(AtomicIntegerTest.class));
suite.addTest(new TestSuite(AtomicLongArrayTest.class));
suite.addTest(new TestSuite(AtomicLongFieldUpdaterTest.class));
suite.addTest(new TestSuite(AtomicLongTest.class));
suite.addTest(new TestSuite(AtomicMarkableReferenceTest.class));
suite.addTest(new TestSuite(AtomicReferenceArrayTest.class));
suite.addTest(new TestSuite(AtomicReferenceFieldUpdaterTest.class));
suite.addTest(new TestSuite(AtomicReferenceTest.class));
suite.addTest(new TestSuite(AtomicStampedReferenceTest.class));
suite.addTest(new TestSuite(ConcurrentHashMapTest.class));
suite.addTest(new TestSuite(ConcurrentLinkedDequeTest.class));
suite.addTest(new TestSuite(ConcurrentLinkedQueueTest.class));
suite.addTest(new TestSuite(ConcurrentSkipListMapTest.class));
suite.addTest(new TestSuite(ConcurrentSkipListSubMapTest.class));
suite.addTest(new TestSuite(ConcurrentSkipListSetTest.class));
suite.addTest(new TestSuite(ConcurrentSkipListSubSetTest.class));
suite.addTest(new TestSuite(CopyOnWriteArrayListTest.class));
suite.addTest(new TestSuite(CopyOnWriteArraySetTest.class));
suite.addTest(new TestSuite(CountDownLatchTest.class));
suite.addTest(new TestSuite(CyclicBarrierTest.class));
suite.addTest(new TestSuite(DelayQueueTest.class));
suite.addTest(new TestSuite(EntryTest.class));
suite.addTest(new TestSuite(ExchangerTest.class));
suite.addTest(new TestSuite(ExecutorsTest.class));
suite.addTest(new TestSuite(ExecutorCompletionServiceTest.class));
suite.addTest(new TestSuite(FutureTaskTest.class));
suite.addTest(new TestSuite(LinkedBlockingDequeTest.class));
suite.addTest(new TestSuite(LinkedBlockingQueueTest.class));
suite.addTest(new TestSuite(LinkedListTest.class));
suite.addTest(new TestSuite(LockSupportTest.class));
suite.addTest(new TestSuite(PriorityBlockingQueueTest.class));
suite.addTest(new TestSuite(PriorityQueueTest.class));
suite.addTest(new TestSuite(ReentrantLockTest.class));
suite.addTest(new TestSuite(ReentrantReadWriteLockTest.class));
suite.addTest(new TestSuite(ScheduledExecutorTest.class));
suite.addTest(new TestSuite(ScheduledExecutorSubclassTest.class));
suite.addTest(new TestSuite(SemaphoreTest.class));
suite.addTest(new TestSuite(SynchronousQueueTest.class));
suite.addTest(new TestSuite(SystemTest.class));
suite.addTest(new TestSuite(ThreadLocalTest.class));
suite.addTest(new TestSuite(ThreadPoolExecutorTest.class));
suite.addTest(new TestSuite(ThreadPoolExecutorSubclassTest.class));
suite.addTest(new TestSuite(ThreadTest.class));
suite.addTest(new TestSuite(TimeUnitTest.class));
suite.addTest(new TestSuite(TreeMapTest.class));
suite.addTest(new TestSuite(TreeSetTest.class));
suite.addTest(new TestSuite(TreeSubMapTest.class));
suite.addTest(new TestSuite(TreeSubSetTest.class));
return suite;
}
public static long SHORT_DELAY_MS;
public static long SMALL_DELAY_MS;
public static long MEDIUM_DELAY_MS;
public static long LONG_DELAY_MS;
/**
* Returns the shortest timed delay. This could
* be reimplemented to use for example a Property.
*/
protected long getShortDelay() {
return 50;
}
/**
* Sets delays as multiples of SHORT_DELAY.
*/
protected void setDelays() {
SHORT_DELAY_MS = getShortDelay();
SMALL_DELAY_MS = SHORT_DELAY_MS * 5;
MEDIUM_DELAY_MS = SHORT_DELAY_MS * 10;
LONG_DELAY_MS = SHORT_DELAY_MS * 50;
}
/**
* The first exception encountered if any threadAssertXXX method fails.
*/
private final AtomicReference threadFailure
= new AtomicReference(null);
/**
* Records an exception so that it can be rethrown later in the test
* harness thread, triggering a test case failure. Only the first
* failure is recorded; subsequent calls to this method from within
* the same test have no effect.
*/
public void threadRecordFailure(Throwable t) {
threadFailure.compareAndSet(null, t);
}
public void setUp() {
setDelays();
}
/**
* Triggers test case failure if any thread assertions have failed,
* by rethrowing, in the test harness thread, any exception recorded
* earlier by threadRecordFailure.
*/
public void tearDown() throws Exception {
Throwable t = threadFailure.get();
if (t != null) {
if (t instanceof Error)
throw (Error) t;
else if (t instanceof RuntimeException)
throw (RuntimeException) t;
else if (t instanceof Exception)
throw (Exception) t;
else
throw new AssertionError(t);
}
}
/**
* Just like fail(reason), but additionally recording (using
* threadRecordFailure) any AssertionError thrown, so that the current
* testcase will fail.
*/
public void threadFail(String reason) {
try {
fail(reason);
} catch (Throwable t) {
threadRecordFailure(t);
fail(reason);
}
}
/**
* Just like assertTrue(b), but additionally recording (using
* threadRecordFailure) any AssertionError thrown, so that the current
* testcase will fail.
*/
public void threadAssertTrue(boolean b) {
try {
assertTrue(b);
} catch (AssertionError t) {
threadRecordFailure(t);
throw t;
}
}
/**
* Just like assertFalse(b), but additionally recording (using
* threadRecordFailure) any AssertionError thrown, so that the
* current testcase will fail.
*/
public void threadAssertFalse(boolean b) {
try {
assertFalse(b);
} catch (AssertionError t) {
threadRecordFailure(t);
throw t;
}
}
/**
* Just like assertNull(x), but additionally recording (using
* threadRecordFailure) any AssertionError thrown, so that the
* current testcase will fail.
*/
public void threadAssertNull(Object x) {
try {
assertNull(x);
} catch (AssertionError t) {
threadRecordFailure(t);
throw t;
}
}
/**
* Just like assertEquals(x, y), but additionally recording (using
* threadRecordFailure) any AssertionError thrown, so that the
* current testcase will fail.
*/
public void threadAssertEquals(long x, long y) {
try {
assertEquals(x, y);
} catch (AssertionError t) {
threadRecordFailure(t);
throw t;
}
}
/**
* Just like assertEquals(x, y), but additionally recording (using
* threadRecordFailure) any AssertionError thrown, so that the
* current testcase will fail.
*/
public void threadAssertEquals(Object x, Object y) {
try {
assertEquals(x, y);
} catch (AssertionError t) {
threadRecordFailure(t);
throw t;
}
}
/**
* Just like assertSame(x, y), but additionally recording (using
* threadRecordFailure) any AssertionError thrown, so that the
* current testcase will fail.
*/
public void threadAssertSame(Object x, Object y) {
try {
assertSame(x, y);
} catch (AssertionError t) {
threadRecordFailure(t);
throw t;
}
}
/**
* Calls threadFail with message "should throw exception".
*/
public void threadShouldThrow() {
threadFail("should throw exception");
}
/**
* Calls threadFail with message "should throw" + exceptionName.
*/
public void threadShouldThrow(String exceptionName) {
threadFail("should throw " + exceptionName);
}
/**
* Calls threadFail with message "Unexpected exception" + ex.
*/
public void threadUnexpectedException(Throwable t) {
threadRecordFailure(t);
t.printStackTrace();
// Rethrow, wrapping in an AssertionError if necessary
if (t instanceof RuntimeException)
throw (RuntimeException) t;
else if (t instanceof Error)
throw (Error) t;
else {
AssertionError ae = new AssertionError("unexpected exception: " + t);
t.initCause(t);
throw ae;
}
}
/**
* Waits out termination of a thread pool or fails doing so.
*/
public void joinPool(ExecutorService exec) {
try {
exec.shutdown();
assertTrue(exec.awaitTermination(LONG_DELAY_MS, MILLISECONDS));
} catch (SecurityException ok) {
// Allowed in case test doesn't have privs
} catch (InterruptedException ie) {
fail("Unexpected InterruptedException");
}
}
/**
* Fails with message "should throw exception".
*/
public void shouldThrow() {
fail("Should throw exception");
}
/**
* Fails with message "should throw " + exceptionName.
*/
public void shouldThrow(String exceptionName) {
fail("Should throw " + exceptionName);
}
/**
* Fails with message "Unexpected exception: " + ex.
*/
public void unexpectedException(Throwable ex) {
ex.printStackTrace();
fail("Unexpected exception: " + ex);
}
/**
* The number of elements to place in collections, arrays, etc.
*/
public static final int SIZE = 20;
// Some convenient Integer constants
public static final Integer zero = new Integer(0);
public static final Integer one = new Integer(1);
public static final Integer two = new Integer(2);
public static final Integer three = new Integer(3);
public static final Integer four = new Integer(4);
public static final Integer five = new Integer(5);
public static final Integer six = new Integer(6);
public static final Integer seven = new Integer(7);
public static final Integer eight = new Integer(8);
public static final Integer nine = new Integer(9);
public static final Integer m1 = new Integer(-1);
public static final Integer m2 = new Integer(-2);
public static final Integer m3 = new Integer(-3);
public static final Integer m4 = new Integer(-4);
public static final Integer m5 = new Integer(-5);
public static final Integer m6 = new Integer(-6);
public static final Integer m10 = new Integer(-10);
/**
* Runs Runnable r with a security policy that permits precisely
* the specified permissions. If there is no current security
* manager, the runnable is run twice, both with and without a
* security manager. We require that any security manager permit
* getPolicy/setPolicy.
*/
public void runWithPermissions(Runnable r, Permission... permissions) {
SecurityManager sm = System.getSecurityManager();
if (sm == null) {
r.run();
Policy savedPolicy = Policy.getPolicy();
try {
Policy.setPolicy(permissivePolicy());
System.setSecurityManager(new SecurityManager());
runWithPermissions(r, permissions);
} finally {
System.setSecurityManager(null);
Policy.setPolicy(savedPolicy);
}
} else {
Policy savedPolicy = Policy.getPolicy();
AdjustablePolicy policy = new AdjustablePolicy(permissions);
Policy.setPolicy(policy);
try {
r.run();
} finally {
policy.addPermission(new SecurityPermission("setPolicy"));
Policy.setPolicy(savedPolicy);
}
}
}
/**
* Runs a runnable without any permissions.
*/
public void runWithoutPermissions(Runnable r) {
runWithPermissions(r);
}
/**
* A security policy where new permissions can be dynamically added
* or all cleared.
*/
public static class AdjustablePolicy extends java.security.Policy {
Permissions perms = new Permissions();
AdjustablePolicy(Permission... permissions) {
for (Permission permission : permissions)
perms.add(permission);
}
void addPermission(Permission perm) { perms.add(perm); }
void clearPermissions() { perms = new Permissions(); }
public PermissionCollection getPermissions(CodeSource cs) {
return perms;
}
public PermissionCollection getPermissions(ProtectionDomain pd) {
return perms;
}
public boolean implies(ProtectionDomain pd, Permission p) {
return perms.implies(p);
}
public void refresh() {}
}
/**
* Returns a policy containing all the permissions we ever need.
*/
public static Policy permissivePolicy() {
return new AdjustablePolicy
// Permissions j.u.c. needs directly
(new RuntimePermission("modifyThread"),
new RuntimePermission("getClassLoader"),
new RuntimePermission("setContextClassLoader"),
// Permissions needed to change permissions!
new SecurityPermission("getPolicy"),
new SecurityPermission("setPolicy"),
new RuntimePermission("setSecurityManager"),
// Permissions needed by the junit test harness
new RuntimePermission("accessDeclaredMembers"),
new PropertyPermission("*", "read"),
new java.io.FilePermission("<>", "read"));
}
/**
* Sleep until the timeout has elapsed, or interrupted.
* Does NOT throw InterruptedException.
*/
void sleepTillInterrupted(long timeoutMillis) {
try {
Thread.sleep(timeoutMillis);
} catch (InterruptedException wakeup) {}
}
/**
* Returns a new started Thread running the given runnable.
*/
Thread newStartedThread(Runnable runnable) {
Thread t = new Thread(runnable);
t.start();
return t;
}
// Some convenient Runnable classes
public abstract class CheckedRunnable implements Runnable {
protected abstract void realRun() throws Throwable;
public final void run() {
try {
realRun();
} catch (Throwable t) {
threadUnexpectedException(t);
}
}
}
public abstract class RunnableShouldThrow implements Runnable {
protected abstract void realRun() throws Throwable;
final Class> exceptionClass;
RunnableShouldThrow(Class exceptionClass) {
this.exceptionClass = exceptionClass;
}
public final void run() {
try {
realRun();
threadShouldThrow(exceptionClass.getSimpleName());
} catch (Throwable t) {
if (! exceptionClass.isInstance(t))
threadUnexpectedException(t);
}
}
}
public abstract class ThreadShouldThrow extends Thread {
protected abstract void realRun() throws Throwable;
final Class> exceptionClass;
ThreadShouldThrow(Class exceptionClass) {
this.exceptionClass = exceptionClass;
}
public final void run() {
try {
realRun();
threadShouldThrow(exceptionClass.getSimpleName());
} catch (Throwable t) {
if (! exceptionClass.isInstance(t))
threadUnexpectedException(t);
}
}
}
public abstract class CheckedInterruptedRunnable implements Runnable {
protected abstract void realRun() throws Throwable;
public final void run() {
try {
realRun();
threadShouldThrow("InterruptedException");
} catch (InterruptedException success) {
} catch (Throwable t) {
threadUnexpectedException(t);
}
}
}
public abstract class CheckedCallable implements Callable {
protected abstract T realCall() throws Throwable;
public final T call() {
try {
return realCall();
} catch (Throwable t) {
threadUnexpectedException(t);
return null;
}
}
}
public abstract class CheckedInterruptedCallable
implements Callable {
protected abstract T realCall() throws Throwable;
public final T call() {
try {
T result = realCall();
threadShouldThrow("InterruptedException");
return result;
} catch (InterruptedException success) {
} catch (Throwable t) {
threadUnexpectedException(t);
}
return null;
}
}
public static class NoOpRunnable implements Runnable {
public void run() {}
}
public static class NoOpCallable implements Callable {
public Object call() { return Boolean.TRUE; }
}
public static final String TEST_STRING = "a test string";
public static class StringTask implements Callable {
public String call() { return TEST_STRING; }
}
public Callable latchAwaitingStringTask(final CountDownLatch latch) {
return new CheckedCallable() {
public String realCall() {
try {
latch.await();
} catch (InterruptedException quittingTime) {}
return TEST_STRING;
}};
}
public static class NPETask implements Callable {
public String call() { throw new NullPointerException(); }
}
public static class CallableOne implements Callable {
public Integer call() { return one; }
}
public class ShortRunnable extends CheckedRunnable {
protected void realRun() throws Throwable {
Thread.sleep(SHORT_DELAY_MS);
}
}
public class ShortInterruptedRunnable extends CheckedInterruptedRunnable {
protected void realRun() throws InterruptedException {
Thread.sleep(SHORT_DELAY_MS);
}
}
public class SmallRunnable extends CheckedRunnable {
protected void realRun() throws Throwable {
Thread.sleep(SMALL_DELAY_MS);
}
}
public class SmallPossiblyInterruptedRunnable extends CheckedRunnable {
protected void realRun() {
try {
Thread.sleep(SMALL_DELAY_MS);
} catch (InterruptedException ok) {}
}
}
public class SmallCallable extends CheckedCallable {
protected Object realCall() throws InterruptedException {
Thread.sleep(SMALL_DELAY_MS);
return Boolean.TRUE;
}
}
public class SmallInterruptedRunnable extends CheckedInterruptedRunnable {
protected void realRun() throws InterruptedException {
Thread.sleep(SMALL_DELAY_MS);
}
}
public class MediumRunnable extends CheckedRunnable {
protected void realRun() throws Throwable {
Thread.sleep(MEDIUM_DELAY_MS);
}
}
public class MediumInterruptedRunnable extends CheckedInterruptedRunnable {
protected void realRun() throws InterruptedException {
Thread.sleep(MEDIUM_DELAY_MS);
}
}
public class MediumPossiblyInterruptedRunnable extends CheckedRunnable {
protected void realRun() {
try {
Thread.sleep(MEDIUM_DELAY_MS);
} catch (InterruptedException ok) {}
}
}
public class LongPossiblyInterruptedRunnable extends CheckedRunnable {
protected void realRun() {
try {
Thread.sleep(LONG_DELAY_MS);
} catch (InterruptedException ok) {}
}
}
/**
* For use as ThreadFactory in constructors
*/
public static class SimpleThreadFactory implements ThreadFactory {
public Thread newThread(Runnable r) {
return new Thread(r);
}
}
public static class TrackedShortRunnable implements Runnable {
public volatile boolean done = false;
public void run() {
try {
Thread.sleep(SMALL_DELAY_MS);
done = true;
} catch (InterruptedException ok) {}
}
}
public static class TrackedMediumRunnable implements Runnable {
public volatile boolean done = false;
public void run() {
try {
Thread.sleep(MEDIUM_DELAY_MS);
done = true;
} catch (InterruptedException ok) {}
}
}
public static class TrackedLongRunnable implements Runnable {
public volatile boolean done = false;
public void run() {
try {
Thread.sleep(LONG_DELAY_MS);
done = true;
} catch (InterruptedException ok) {}
}
}
public static class TrackedNoOpRunnable implements Runnable {
public volatile boolean done = false;
public void run() {
done = true;
}
}
public static class TrackedCallable implements Callable {
public volatile boolean done = false;
public Object call() {
try {
Thread.sleep(SMALL_DELAY_MS);
done = true;
} catch (InterruptedException ok) {}
return Boolean.TRUE;
}
}
/**
* Analog of CheckedRunnable for RecursiveAction
*/
public abstract class CheckedRecursiveAction extends RecursiveAction {
protected abstract void realCompute() throws Throwable;
public final void compute() {
try {
realCompute();
} catch (Throwable t) {
threadUnexpectedException(t);
}
}
}
/**
* Analog of CheckedCallable for RecursiveTask
*/
public abstract class CheckedRecursiveTask extends RecursiveTask {
protected abstract T realCompute() throws Throwable;
public final T compute() {
try {
return realCompute();
} catch (Throwable t) {
threadUnexpectedException(t);
return null;
}
}
}
/**
* For use as RejectedExecutionHandler in constructors
*/
public static class NoOpREHandler implements RejectedExecutionHandler {
public void rejectedExecution(Runnable r,
ThreadPoolExecutor executor) {}
}
}