test/tck/JSR166TestCase.java

/*
 * 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.*;
import java.util.concurrent.*;
import static java.util.concurrent.TimeUnit.MILLISECONDS;
import java.io.*;
import java.security.*;

/**
 * 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:
 *
 * <ol>
 *
 * <li> All assertions in code running in generated threads must use
 * the forms {@link #threadFail}, {@link #threadAssertTrue}, {@link
 * #threadAssertEquals}, or {@link #threadAssertNull}, (not
 * <tt>fail</tt>, <tt>assertTrue</tt>, 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.</li>
 *
 * <li> If you override {@link #setUp} or {@link #tearDown}, make sure
 * to invoke <tt>super.setUp</tt> and <tt>super.tearDown</tt> within
 * them. These methods are used to clear and check for thread
 * assertion failures.</li>
 *
 * <li>All delays and timeouts must use one of the constants <tt>
 * SHORT_DELAY_MS</tt>, <tt> SMALL_DELAY_MS</tt>, <tt> MEDIUM_DELAY_MS</tt>,
 * <tt> LONG_DELAY_MS</tt>. 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.</li>
 *
 * <li> All threads generated must be joined inside each test case
 * method (or <tt>fail</tt> to do so) before returning from the
 * method. The <tt> joinPool</tt> method can be used to do this when
 * using Executors.</li>
 *
 * </ol>
 *
 * <p> <b>Other notes</b>
 * <ul>
 *
 * <li> 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.</li>
 *
 * <li> 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.</li>
 *
 * <li> 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.</li>
 *
 * <li>The test classes currently do not declare inclusion in
 * any particular package to simplify things for people integrating
 * them in TCK test suites.</li>
 *
 * <li> As a convenience, the <tt>main</tt> of this class (JSR166TestCase)
 * runs all JSR166 unit tests.</li>
 *
 * </ul>
 */
public class JSR166TestCase extends TestCase {
    /**
     * Runs all JSR166 unit tests using junit.textui.TestRunner
     */
    public static void main(String[] args) {
        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(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;
    }

    /**
     * Flag set true if any threadAssert methods fail
     */
    volatile boolean threadFailed;

    /**
     * Initializes test to indicate that no thread assertions have failed
     */
    public void setUp() {
        setDelays();
        threadFailed = false;
    }

    /**
     * Triggers test case failure if any thread assertions have failed
     */
    public void tearDown() {
        assertFalse(threadFailed);
    }

    /**
     * Fail, also setting status to indicate current testcase should fail
     */
    public void threadFail(String reason) {
        threadFailed = true;
        fail(reason);
    }

    /**
     * If expression not true, set status to indicate current testcase
     * should fail
     */
    public void threadAssertTrue(boolean b) {
        if (!b) {
            threadFailed = true;
            assertTrue(b);
        }
    }

    /**
     * If expression not false, set status to indicate current testcase
     * should fail
     */
    public void threadAssertFalse(boolean b) {
        if (b) {
            threadFailed = true;
            assertFalse(b);
        }
    }

    /**
     * If argument not null, set status to indicate current testcase
     * should fail
     */
    public void threadAssertNull(Object x) {
        if (x != null) {
            threadFailed = true;
            assertNull(x);
        }
    }

    /**
     * If arguments not equal, set status to indicate current testcase
     * should fail
     */
    public void threadAssertEquals(long x, long y) {
        if (x != y) {
            threadFailed = true;
            assertEquals(x, y);
        }
    }

    /**
     * If arguments not equal, set status to indicate current testcase
     * should fail
     */
    public void threadAssertEquals(Object x, Object y) {
        if (x != y && (x == null || !x.equals(y))) {
            threadFailed = true;
            assertEquals(x, y);
        }
    }

    /**
     * threadFail with message "should throw exception"
     */
    public void threadShouldThrow() {
        threadFailed = true;
        fail("should throw exception");
    }

    /**
     * threadFail with message "should throw" + exceptionName
     */
    public void threadShouldThrow(String exceptionName) {
        threadFailed = true;
        fail("should throw " + exceptionName);
    }

    /**
     * threadFail with message "Unexpected exception"
     */
    public void threadUnexpectedException() {
        threadFailed = true;
        fail("Unexpected exception");
    }

    /**
     * threadFail with message "Unexpected exception", with argument
     */
    public void threadUnexpectedException(Throwable ex) {
        threadFailed = true;
        ex.printStackTrace();
        fail("Unexpected exception: " + ex);
    }

    /**
     * Wait out termination of a thread pool or fail 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 exception");
        }
    }


    /**
     * fail with message "should throw exception"
     */
    public void shouldThrow() {
        fail("Should throw exception");
    }

    /**
     * fail with message "should throw " + exceptionName
     */
    public void shouldThrow(String exceptionName) {
        fail("Should throw " + exceptionName);
    }

    /**
     * fail with message "Unexpected exception"
     */
    public void unexpectedException() {
        fail("Unexpected exception");
    }

    /**
     * fail with message "Unexpected exception", with argument
     */
    public void unexpectedException(Throwable ex) {
        ex.printStackTrace();
        fail("Unexpected exception: " + ex);
    }


    /**
     * The number of elements to place in collections, arrays, etc.
     */
    static final int SIZE = 20;

    // Some convenient Integer constants

    static final Integer zero = new Integer(0);
    static final Integer one = new Integer(1);
    static final Integer two = new Integer(2);
    static final Integer three  = new Integer(3);
    static final Integer four  = new Integer(4);
    static final Integer five  = new Integer(5);
    static final Integer six = new Integer(6);
    static final Integer seven = new Integer(7);
    static final Integer eight = new Integer(8);
    static final Integer nine = new Integer(9);
    static final Integer m1  = new Integer(-1);
    static final Integer m2  = new Integer(-2);
    static final Integer m3  = new Integer(-3);
    static final Integer m4 = new Integer(-4);
    static final Integer m5 = new Integer(-5);
    static final Integer m6 = new Integer(-6);
    static final Integer m10 = new Integer(-10);


    /**
     * A security policy where new permissions can be dynamically added
     * or all cleared.
     */
    static class AdjustablePolicy extends java.security.Policy {
        Permissions perms = new Permissions();
        AdjustablePolicy() { }
        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() {}
    }

    /**
     * Sleep until the timeout has elapsed, or interrupted.
     * Does <em>NOT</em> 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

    abstract class CheckedRunnable implements Runnable {
        abstract void realRun() throws Throwable;

        public final void run() {
            try {
                realRun();
            } catch (Throwable t) {
                threadUnexpectedException(t);
            }
        }
    }

    abstract class RunnableShouldThrow implements Runnable {
        abstract void realRun() throws Throwable;

        final Class<?> exceptionClass;

        <T extends Throwable> RunnableShouldThrow(Class<T> exceptionClass) {
            this.exceptionClass = exceptionClass;
        }

        public final void run() {
            try {
                realRun();
                threadShouldThrow(exceptionClass.getSimpleName());
            } catch (InterruptedException success) {
            } catch (Throwable t) {
                if (! exceptionClass.isInstance(t))
                    threadUnexpectedException(t);
            }
        }
    }

    abstract class ThreadShouldThrow extends Thread {
        abstract void realRun() throws Throwable;

        final Class<?> exceptionClass;

        <T extends Throwable> ThreadShouldThrow(Class<T> exceptionClass) {
            this.exceptionClass = exceptionClass;
        }

        public final void run() {
            try {
                realRun();
                threadShouldThrow(exceptionClass.getSimpleName());
            } catch (InterruptedException success) {
            } catch (Throwable t) {
                if (! exceptionClass.isInstance(t))
                    threadUnexpectedException(t);
            }
        }
    }

    abstract class CheckedInterruptedRunnable implements Runnable {
        abstract void realRun() throws Throwable;

        public final void run() {
            try {
                realRun();
                threadShouldThrow("InterruptedException");
            } catch (InterruptedException success) {
            } catch (Throwable t) {
                threadUnexpectedException(t);
            }
        }
    }

    abstract class CheckedCallable<T> implements Callable<T> {
        abstract T realCall() throws Throwable;

        public final T call() {
            try {
                return realCall();
            } catch (Throwable t) {
                threadUnexpectedException(t);
            }
            return null;
        }
    }

    abstract class CheckedInterruptedCallable<T> implements Callable<T> {
        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;
        }
    }

    static class NoOpRunnable implements Runnable {
        public void run() {}
    }

    static class NoOpCallable implements Callable {
        public Object call() { return Boolean.TRUE; }
    }

    static final String TEST_STRING = "a test string";

    static class StringTask implements Callable<String> {
        public String call() { return TEST_STRING; }
    }

    static class NPETask implements Callable<String> {
        public String call() { throw new NullPointerException(); }
    }

    static class CallableOne implements Callable<Integer> {
        public Integer call() { return one; }
    }

    class ShortRunnable extends CheckedRunnable {
        void realRun() throws Throwable {
            Thread.sleep(SHORT_DELAY_MS);
        }
    }

    class ShortInterruptedRunnable extends CheckedInterruptedRunnable {
        void realRun() throws InterruptedException {
            Thread.sleep(SHORT_DELAY_MS);
        }
    }

    class SmallRunnable extends CheckedRunnable {
        void realRun() throws Throwable {
            Thread.sleep(SMALL_DELAY_MS);
        }
    }

    class SmallPossiblyInterruptedRunnable extends CheckedRunnable {
        void realRun() {
            try {
                Thread.sleep(SMALL_DELAY_MS);
            }
            catch (InterruptedException ok) {
            }
        }
    }

    class SmallCallable extends CheckedCallable {
        Object realCall() throws Throwable {
            Thread.sleep(SMALL_DELAY_MS);
            return Boolean.TRUE;
        }
    }

    class SmallInterruptedRunnable extends CheckedInterruptedRunnable {
        void realRun() throws InterruptedException {
            Thread.sleep(SMALL_DELAY_MS);
        }
    }

    class MediumRunnable extends CheckedRunnable {
        void realRun() throws Throwable {
            Thread.sleep(MEDIUM_DELAY_MS);
        }
    }

    class MediumInterruptedRunnable extends CheckedInterruptedRunnable {
        void realRun() throws InterruptedException {
            Thread.sleep(MEDIUM_DELAY_MS);
        }
    }

    class MediumPossiblyInterruptedRunnable extends CheckedRunnable {
        void realRun() {
            try {
                Thread.sleep(MEDIUM_DELAY_MS);
            }
            catch (InterruptedException ok) {
            }
        }
    }

    class LongPossiblyInterruptedRunnable extends CheckedRunnable {
        void realRun() {
            try {
                Thread.sleep(LONG_DELAY_MS);
            }
            catch (InterruptedException ok) {
            }
        }
    }

    /**
     * For use as ThreadFactory in constructors
     */
    static class SimpleThreadFactory implements ThreadFactory {
        public Thread newThread(Runnable r) {
            return new Thread(r);
        }
    }

    static class TrackedShortRunnable implements Runnable {
        volatile boolean done = false;
        public void run() {
            try {
                Thread.sleep(SMALL_DELAY_MS);
                done = true;
            } catch (InterruptedException ok) {
            }
        }
    }

    static class TrackedMediumRunnable implements Runnable {
        volatile boolean done = false;
        public void run() {
            try {
                Thread.sleep(MEDIUM_DELAY_MS);
                done = true;
            } catch (InterruptedException ok) {
            }
        }
    }

    static class TrackedLongRunnable implements Runnable {
        volatile boolean done = false;
        public void run() {
            try {
                Thread.sleep(LONG_DELAY_MS);
                done = true;
            } catch (InterruptedException ok) {
            }
        }
    }

    static class TrackedNoOpRunnable implements Runnable {
        volatile boolean done = false;
        public void run() {
            done = true;
        }
    }

    static class TrackedCallable implements Callable {
        volatile boolean done = false;
        public Object call() {
            try {
                Thread.sleep(SMALL_DELAY_MS);
                done = true;
            } catch (InterruptedException ok) {
            }
            return Boolean.TRUE;
        }
    }


    /**
     * For use as RejectedExecutionHandler in constructors
     */
    static class NoOpREHandler implements RejectedExecutionHandler {
        public void rejectedExecution(Runnable r,
                                      ThreadPoolExecutor executor) {}
    }

}
Revision:	1.42
Committed:	Sat Nov 21 02:07:26 2009 UTC (14 years, 5 months ago) by jsr166
Branch:	MAIN
Changes since 1.41:	+10 -10 lines
Log Message:	untabify
#	Content
1	/*
2	* Written by Doug Lea with assistance from members of JCP JSR-166
3	* Expert Group and released to the public domain, as explained at
4	* http://creativecommons.org/licenses/publicdomain
5	* Other contributors include Andrew Wright, Jeffrey Hayes,
6	* Pat Fisher, Mike Judd.
7	*/
8
9	import junit.framework.*;
10	import java.util.*;
11	import java.util.concurrent.*;
12	import static java.util.concurrent.TimeUnit.MILLISECONDS;
13	import java.io.*;
14	import java.security.*;
15
16	/**
17	* Base class for JSR166 Junit TCK tests. Defines some constants,
18	* utility methods and classes, as well as a simple framework for
19	* helping to make sure that assertions failing in generated threads
20	* cause the associated test that generated them to itself fail (which
21	* JUnit does not otherwise arrange). The rules for creating such
22	* tests are:
23	*
24	* <ol>
25	*
26	* <li> All assertions in code running in generated threads must use
27	* the forms {@link #threadFail}, {@link #threadAssertTrue}, {@link
28	* #threadAssertEquals}, or {@link #threadAssertNull}, (not
29	* <tt>fail</tt>, <tt>assertTrue</tt>, etc.) It is OK (but not
30	* particularly recommended) for other code to use these forms too.
31	* Only the most typically used JUnit assertion methods are defined
32	* this way, but enough to live with.</li>
33	*
34	* <li> If you override {@link #setUp} or {@link #tearDown}, make sure
35	* to invoke <tt>super.setUp</tt> and <tt>super.tearDown</tt> within
36	* them. These methods are used to clear and check for thread
37	* assertion failures.</li>
38	*
39	* <li>All delays and timeouts must use one of the constants <tt>
40	* SHORT_DELAY_MS</tt>, <tt> SMALL_DELAY_MS</tt>, <tt> MEDIUM_DELAY_MS</tt>,
41	* <tt> LONG_DELAY_MS</tt>. The idea here is that a SHORT is always
42	* discriminable from zero time, and always allows enough time for the
43	* small amounts of computation (creating a thread, calling a few
44	* methods, etc) needed to reach a timeout point. Similarly, a SMALL
45	* is always discriminable as larger than SHORT and smaller than
46	* MEDIUM. And so on. These constants are set to conservative values,
47	* but even so, if there is ever any doubt, they can all be increased
48	* in one spot to rerun tests on slower platforms.</li>
49	*
50	* <li> All threads generated must be joined inside each test case
51	* method (or <tt>fail</tt> to do so) before returning from the
52	* method. The <tt> joinPool</tt> method can be used to do this when
53	* using Executors.</li>
54	*
55	* </ol>
56	*
57	* <p> <b>Other notes</b>
58	* <ul>
59	*
60	* <li> Usually, there is one testcase method per JSR166 method
61	* covering "normal" operation, and then as many exception-testing
62	* methods as there are exceptions the method can throw. Sometimes
63	* there are multiple tests per JSR166 method when the different
64	* "normal" behaviors differ significantly. And sometimes testcases
65	* cover multiple methods when they cannot be tested in
66	* isolation.</li>
67	*
68	* <li> The documentation style for testcases is to provide as javadoc
69	* a simple sentence or two describing the property that the testcase
70	* method purports to test. The javadocs do not say anything about how
71	* the property is tested. To find out, read the code.</li>
72	*
73	* <li> These tests are "conformance tests", and do not attempt to
74	* test throughput, latency, scalability or other performance factors
75	* (see the separate "jtreg" tests for a set intended to check these
76	* for the most central aspects of functionality.) So, most tests use
77	* the smallest sensible numbers of threads, collection sizes, etc
78	* needed to check basic conformance.</li>
79	*
80	* <li>The test classes currently do not declare inclusion in
81	* any particular package to simplify things for people integrating
82	* them in TCK test suites.</li>
83	*
84	* <li> As a convenience, the <tt>main</tt> of this class (JSR166TestCase)
85	* runs all JSR166 unit tests.</li>
86	*
87	* </ul>
88	*/
89	public class JSR166TestCase extends TestCase {
90	/**
91	* Runs all JSR166 unit tests using junit.textui.TestRunner
92	*/
93	public static void main(String[] args) {
94	int iters = 1;
95	if (args.length > 0)
96	iters = Integer.parseInt(args[0]);
97	Test s = suite();
98	for (int i = 0; i < iters; ++i) {
99	junit.textui.TestRunner.run(s);
100	System.gc();
101	System.runFinalization();
102	}
103	System.exit(0);
104	}
105
106	/**
107	* Collects all JSR166 unit tests as one suite
108	*/
109	public static Test suite() {
110	TestSuite suite = new TestSuite("JSR166 Unit Tests");
111
112	suite.addTest(new TestSuite(ForkJoinPoolTest.class));
113	suite.addTest(new TestSuite(ForkJoinTaskTest.class));
114	suite.addTest(new TestSuite(RecursiveActionTest.class));
115	suite.addTest(new TestSuite(RecursiveTaskTest.class));
116	suite.addTest(new TestSuite(LinkedTransferQueueTest.class));
117	suite.addTest(new TestSuite(PhaserTest.class));
118	suite.addTest(new TestSuite(ThreadLocalRandomTest.class));
119	suite.addTest(new TestSuite(AbstractExecutorServiceTest.class));
120	suite.addTest(new TestSuite(AbstractQueueTest.class));
121	suite.addTest(new TestSuite(AbstractQueuedSynchronizerTest.class));
122	suite.addTest(new TestSuite(AbstractQueuedLongSynchronizerTest.class));
123	suite.addTest(new TestSuite(ArrayBlockingQueueTest.class));
124	suite.addTest(new TestSuite(ArrayDequeTest.class));
125	suite.addTest(new TestSuite(AtomicBooleanTest.class));
126	suite.addTest(new TestSuite(AtomicIntegerArrayTest.class));
127	suite.addTest(new TestSuite(AtomicIntegerFieldUpdaterTest.class));
128	suite.addTest(new TestSuite(AtomicIntegerTest.class));
129	suite.addTest(new TestSuite(AtomicLongArrayTest.class));
130	suite.addTest(new TestSuite(AtomicLongFieldUpdaterTest.class));
131	suite.addTest(new TestSuite(AtomicLongTest.class));
132	suite.addTest(new TestSuite(AtomicMarkableReferenceTest.class));
133	suite.addTest(new TestSuite(AtomicReferenceArrayTest.class));
134	suite.addTest(new TestSuite(AtomicReferenceFieldUpdaterTest.class));
135	suite.addTest(new TestSuite(AtomicReferenceTest.class));
136	suite.addTest(new TestSuite(AtomicStampedReferenceTest.class));
137	suite.addTest(new TestSuite(ConcurrentHashMapTest.class));
138	suite.addTest(new TestSuite(ConcurrentLinkedQueueTest.class));
139	suite.addTest(new TestSuite(ConcurrentSkipListMapTest.class));
140	suite.addTest(new TestSuite(ConcurrentSkipListSubMapTest.class));
141	suite.addTest(new TestSuite(ConcurrentSkipListSetTest.class));
142	suite.addTest(new TestSuite(ConcurrentSkipListSubSetTest.class));
143	suite.addTest(new TestSuite(CopyOnWriteArrayListTest.class));
144	suite.addTest(new TestSuite(CopyOnWriteArraySetTest.class));
145	suite.addTest(new TestSuite(CountDownLatchTest.class));
146	suite.addTest(new TestSuite(CyclicBarrierTest.class));
147	suite.addTest(new TestSuite(DelayQueueTest.class));
148	suite.addTest(new TestSuite(EntryTest.class));
149	suite.addTest(new TestSuite(ExchangerTest.class));
150	suite.addTest(new TestSuite(ExecutorsTest.class));
151	suite.addTest(new TestSuite(ExecutorCompletionServiceTest.class));
152	suite.addTest(new TestSuite(FutureTaskTest.class));
153	suite.addTest(new TestSuite(LinkedBlockingDequeTest.class));
154	suite.addTest(new TestSuite(LinkedBlockingQueueTest.class));
155	suite.addTest(new TestSuite(LinkedListTest.class));
156	suite.addTest(new TestSuite(LockSupportTest.class));
157	suite.addTest(new TestSuite(PriorityBlockingQueueTest.class));
158	suite.addTest(new TestSuite(PriorityQueueTest.class));
159	suite.addTest(new TestSuite(ReentrantLockTest.class));
160	suite.addTest(new TestSuite(ReentrantReadWriteLockTest.class));
161	suite.addTest(new TestSuite(ScheduledExecutorTest.class));
162	suite.addTest(new TestSuite(ScheduledExecutorSubclassTest.class));
163	suite.addTest(new TestSuite(SemaphoreTest.class));
164	suite.addTest(new TestSuite(SynchronousQueueTest.class));
165	suite.addTest(new TestSuite(SystemTest.class));
166	suite.addTest(new TestSuite(ThreadLocalTest.class));
167	suite.addTest(new TestSuite(ThreadPoolExecutorTest.class));
168	suite.addTest(new TestSuite(ThreadPoolExecutorSubclassTest.class));
169	suite.addTest(new TestSuite(ThreadTest.class));
170	suite.addTest(new TestSuite(TimeUnitTest.class));
171	suite.addTest(new TestSuite(TreeMapTest.class));
172	suite.addTest(new TestSuite(TreeSetTest.class));
173	suite.addTest(new TestSuite(TreeSubMapTest.class));
174	suite.addTest(new TestSuite(TreeSubSetTest.class));
175
176	return suite;
177	}
178
179
180	public static long SHORT_DELAY_MS;
181	public static long SMALL_DELAY_MS;
182	public static long MEDIUM_DELAY_MS;
183	public static long LONG_DELAY_MS;
184
185
186	/**
187	* Returns the shortest timed delay. This could
188	* be reimplemented to use for example a Property.
189	*/
190	protected long getShortDelay() {
191	return 50;
192	}
193
194
195	/**
196	* Sets delays as multiples of SHORT_DELAY.
197	*/
198	protected void setDelays() {
199	SHORT_DELAY_MS = getShortDelay();
200	SMALL_DELAY_MS = SHORT_DELAY_MS * 5;
201	MEDIUM_DELAY_MS = SHORT_DELAY_MS * 10;
202	LONG_DELAY_MS = SHORT_DELAY_MS * 50;
203	}
204
205	/**
206	* Flag set true if any threadAssert methods fail
207	*/
208	volatile boolean threadFailed;
209
210	/**
211	* Initializes test to indicate that no thread assertions have failed
212	*/
213	public void setUp() {
214	setDelays();
215	threadFailed = false;
216	}
217
218	/**
219	* Triggers test case failure if any thread assertions have failed
220	*/
221	public void tearDown() {
222	assertFalse(threadFailed);
223	}
224
225	/**
226	* Fail, also setting status to indicate current testcase should fail
227	*/
228	public void threadFail(String reason) {
229	threadFailed = true;
230	fail(reason);
231	}
232
233	/**
234	* If expression not true, set status to indicate current testcase
235	* should fail
236	*/
237	public void threadAssertTrue(boolean b) {
238	if (!b) {
239	threadFailed = true;
240	assertTrue(b);
241	}
242	}
243
244	/**
245	* If expression not false, set status to indicate current testcase
246	* should fail
247	*/
248	public void threadAssertFalse(boolean b) {
249	if (b) {
250	threadFailed = true;
251	assertFalse(b);
252	}
253	}
254
255	/**
256	* If argument not null, set status to indicate current testcase
257	* should fail
258	*/
259	public void threadAssertNull(Object x) {
260	if (x != null) {
261	threadFailed = true;
262	assertNull(x);
263	}
264	}
265
266	/**
267	* If arguments not equal, set status to indicate current testcase
268	* should fail
269	*/
270	public void threadAssertEquals(long x, long y) {
271	if (x != y) {
272	threadFailed = true;
273	assertEquals(x, y);
274	}
275	}
276
277	/**
278	* If arguments not equal, set status to indicate current testcase
279	* should fail
280	*/
281	public void threadAssertEquals(Object x, Object y) {
282	if (x != y && (x == null \|\| !x.equals(y))) {
283	threadFailed = true;
284	assertEquals(x, y);
285	}
286	}
287
288	/**
289	* threadFail with message "should throw exception"
290	*/
291	public void threadShouldThrow() {
292	threadFailed = true;
293	fail("should throw exception");
294	}
295
296	/**
297	* threadFail with message "should throw" + exceptionName
298	*/
299	public void threadShouldThrow(String exceptionName) {
300	threadFailed = true;
301	fail("should throw " + exceptionName);
302	}
303
304	/**
305	* threadFail with message "Unexpected exception"
306	*/
307	public void threadUnexpectedException() {
308	threadFailed = true;
309	fail("Unexpected exception");
310	}
311
312	/**
313	* threadFail with message "Unexpected exception", with argument
314	*/
315	public void threadUnexpectedException(Throwable ex) {
316	threadFailed = true;
317	ex.printStackTrace();
318	fail("Unexpected exception: " + ex);
319	}
320
321	/**
322	* Wait out termination of a thread pool or fail doing so
323	*/
324	public void joinPool(ExecutorService exec) {
325	try {
326	exec.shutdown();
327	assertTrue(exec.awaitTermination(LONG_DELAY_MS, MILLISECONDS));
328	} catch (SecurityException ok) {
329	// Allowed in case test doesn't have privs
330	} catch (InterruptedException ie) {
331	fail("Unexpected exception");
332	}
333	}
334
335
336	/**
337	* fail with message "should throw exception"
338	*/
339	public void shouldThrow() {
340	fail("Should throw exception");
341	}
342
343	/**
344	* fail with message "should throw " + exceptionName
345	*/
346	public void shouldThrow(String exceptionName) {
347	fail("Should throw " + exceptionName);
348	}
349
350	/**
351	* fail with message "Unexpected exception"
352	*/
353	public void unexpectedException() {
354	fail("Unexpected exception");
355	}
356
357	/**
358	* fail with message "Unexpected exception", with argument
359	*/
360	public void unexpectedException(Throwable ex) {
361	ex.printStackTrace();
362	fail("Unexpected exception: " + ex);
363	}
364
365
366	/**
367	* The number of elements to place in collections, arrays, etc.
368	*/
369	static final int SIZE = 20;
370
371	// Some convenient Integer constants
372
373	static final Integer zero = new Integer(0);
374	static final Integer one = new Integer(1);
375	static final Integer two = new Integer(2);
376	static final Integer three = new Integer(3);
377	static final Integer four = new Integer(4);
378	static final Integer five = new Integer(5);
379	static final Integer six = new Integer(6);
380	static final Integer seven = new Integer(7);
381	static final Integer eight = new Integer(8);
382	static final Integer nine = new Integer(9);
383	static final Integer m1 = new Integer(-1);
384	static final Integer m2 = new Integer(-2);
385	static final Integer m3 = new Integer(-3);
386	static final Integer m4 = new Integer(-4);
387	static final Integer m5 = new Integer(-5);
388	static final Integer m6 = new Integer(-6);
389	static final Integer m10 = new Integer(-10);
390
391
392	/**
393	* A security policy where new permissions can be dynamically added
394	* or all cleared.
395	*/
396	static class AdjustablePolicy extends java.security.Policy {
397	Permissions perms = new Permissions();
398	AdjustablePolicy() { }
399	void addPermission(Permission perm) { perms.add(perm); }
400	void clearPermissions() { perms = new Permissions(); }
401	public PermissionCollection getPermissions(CodeSource cs) {
402	return perms;
403	}
404	public PermissionCollection getPermissions(ProtectionDomain pd) {
405	return perms;
406	}
407	public boolean implies(ProtectionDomain pd, Permission p) {
408	return perms.implies(p);
409	}
410	public void refresh() {}
411	}
412
413	/**
414	* Sleep until the timeout has elapsed, or interrupted.
415	* Does <em>NOT</em> throw InterruptedException.
416	*/
417	void sleepTillInterrupted(long timeoutMillis) {
418	try {
419	Thread.sleep(timeoutMillis);
420	} catch (InterruptedException wakeup) {
421	}
422	}
423
424	/**
425	* Returns a new started Thread running the given runnable.
426	*/
427	Thread newStartedThread(Runnable runnable) {
428	Thread t = new Thread(runnable);
429	t.start();
430	return t;
431	}
432
433	// Some convenient Runnable classes
434
435	abstract class CheckedRunnable implements Runnable {
436	abstract void realRun() throws Throwable;
437
438	public final void run() {
439	try {
440	realRun();
441	} catch (Throwable t) {
442	threadUnexpectedException(t);
443	}
444	}
445	}
446
447	abstract class RunnableShouldThrow implements Runnable {
448	abstract void realRun() throws Throwable;
449
450	final Class<?> exceptionClass;
451
452	<T extends Throwable> RunnableShouldThrow(Class<T> exceptionClass) {
453	this.exceptionClass = exceptionClass;
454	}
455
456	public final void run() {
457	try {
458	realRun();
459	threadShouldThrow(exceptionClass.getSimpleName());
460	} catch (InterruptedException success) {
461	} catch (Throwable t) {
462	if (! exceptionClass.isInstance(t))
463	threadUnexpectedException(t);
464	}
465	}
466	}
467
468	abstract class ThreadShouldThrow extends Thread {
469	abstract void realRun() throws Throwable;
470
471	final Class<?> exceptionClass;
472
473	<T extends Throwable> ThreadShouldThrow(Class<T> exceptionClass) {
474	this.exceptionClass = exceptionClass;
475	}
476
477	public final void run() {
478	try {
479	realRun();
480	threadShouldThrow(exceptionClass.getSimpleName());
481	} catch (InterruptedException success) {
482	} catch (Throwable t) {
483	if (! exceptionClass.isInstance(t))
484	threadUnexpectedException(t);
485	}
486	}
487	}
488
489	abstract class CheckedInterruptedRunnable implements Runnable {
490	abstract void realRun() throws Throwable;
491
492	public final void run() {
493	try {
494	realRun();
495	threadShouldThrow("InterruptedException");
496	} catch (InterruptedException success) {
497	} catch (Throwable t) {
498	threadUnexpectedException(t);
499	}
500	}
501	}
502
503	abstract class CheckedCallable<T> implements Callable<T> {
504	abstract T realCall() throws Throwable;
505
506	public final T call() {
507	try {
508	return realCall();
509	} catch (Throwable t) {
510	threadUnexpectedException(t);
511	}
512	return null;
513	}
514	}
515
516	abstract class CheckedInterruptedCallable<T> implements Callable<T> {
517	abstract T realCall() throws Throwable;
518
519	public final T call() {
520	try {
521	T result = realCall();
522	threadShouldThrow("InterruptedException");
523	return result;
524	} catch (InterruptedException success) {
525	} catch (Throwable t) {
526	threadUnexpectedException(t);
527	}
528	return null;
529	}
530	}
531
532	static class NoOpRunnable implements Runnable {
533	public void run() {}
534	}
535
536	static class NoOpCallable implements Callable {
537	public Object call() { return Boolean.TRUE; }
538	}
539
540	static final String TEST_STRING = "a test string";
541
542	static class StringTask implements Callable<String> {
543	public String call() { return TEST_STRING; }
544	}
545
546	static class NPETask implements Callable<String> {
547	public String call() { throw new NullPointerException(); }
548	}
549
550	static class CallableOne implements Callable<Integer> {
551	public Integer call() { return one; }
552	}
553
554	class ShortRunnable extends CheckedRunnable {
555	void realRun() throws Throwable {
556	Thread.sleep(SHORT_DELAY_MS);
557	}
558	}
559
560	class ShortInterruptedRunnable extends CheckedInterruptedRunnable {
561	void realRun() throws InterruptedException {
562	Thread.sleep(SHORT_DELAY_MS);
563	}
564	}
565
566	class SmallRunnable extends CheckedRunnable {
567	void realRun() throws Throwable {
568	Thread.sleep(SMALL_DELAY_MS);
569	}
570	}
571
572	class SmallPossiblyInterruptedRunnable extends CheckedRunnable {
573	void realRun() {
574	try {
575	Thread.sleep(SMALL_DELAY_MS);
576	}
577	catch (InterruptedException ok) {
578	}
579	}
580	}
581
582	class SmallCallable extends CheckedCallable {
583	Object realCall() throws Throwable {
584	Thread.sleep(SMALL_DELAY_MS);
585	return Boolean.TRUE;
586	}
587	}
588
589	class SmallInterruptedRunnable extends CheckedInterruptedRunnable {
590	void realRun() throws InterruptedException {
591	Thread.sleep(SMALL_DELAY_MS);
592	}
593	}
594
595	class MediumRunnable extends CheckedRunnable {
596	void realRun() throws Throwable {
597	Thread.sleep(MEDIUM_DELAY_MS);
598	}
599	}
600
601	class MediumInterruptedRunnable extends CheckedInterruptedRunnable {
602	void realRun() throws InterruptedException {
603	Thread.sleep(MEDIUM_DELAY_MS);
604	}
605	}
606
607	class MediumPossiblyInterruptedRunnable extends CheckedRunnable {
608	void realRun() {
609	try {
610	Thread.sleep(MEDIUM_DELAY_MS);
611	}
612	catch (InterruptedException ok) {
613	}
614	}
615	}
616
617	class LongPossiblyInterruptedRunnable extends CheckedRunnable {
618	void realRun() {
619	try {
620	Thread.sleep(LONG_DELAY_MS);
621	}
622	catch (InterruptedException ok) {
623	}
624	}
625	}
626
627	/**
628	* For use as ThreadFactory in constructors
629	*/
630	static class SimpleThreadFactory implements ThreadFactory {
631	public Thread newThread(Runnable r) {
632	return new Thread(r);
633	}
634	}
635
636	static class TrackedShortRunnable implements Runnable {
637	volatile boolean done = false;
638	public void run() {
639	try {
640	Thread.sleep(SMALL_DELAY_MS);
641	done = true;
642	} catch (InterruptedException ok) {
643	}
644	}
645	}
646
647	static class TrackedMediumRunnable implements Runnable {
648	volatile boolean done = false;
649	public void run() {
650	try {
651	Thread.sleep(MEDIUM_DELAY_MS);
652	done = true;
653	} catch (InterruptedException ok) {
654	}
655	}
656	}
657
658	static class TrackedLongRunnable implements Runnable {
659	volatile boolean done = false;
660	public void run() {
661	try {
662	Thread.sleep(LONG_DELAY_MS);
663	done = true;
664	} catch (InterruptedException ok) {
665	}
666	}
667	}
668
669	static class TrackedNoOpRunnable implements Runnable {
670	volatile boolean done = false;
671	public void run() {
672	done = true;
673	}
674	}
675
676	static class TrackedCallable implements Callable {
677	volatile boolean done = false;
678	public Object call() {
679	try {
680	Thread.sleep(SMALL_DELAY_MS);
681	done = true;
682	} catch (InterruptedException ok) {
683	}
684	return Boolean.TRUE;
685	}
686	}
687
688
689	/**
690	* For use as RejectedExecutionHandler in constructors
691	*/
692	static class NoOpREHandler implements RejectedExecutionHandler {
693	public void rejectedExecution(Runnable r,
694	ThreadPoolExecutor executor) {}
695	}
696
697	}