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 "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 "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 CheckedInterruptedRunnable implements Runnable {
        abstract void realRun() throws Throwable;

        public final void run() {
            try {
                realRun();
                threadShouldThrow();
            } 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;
            }
        }
    }

    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.39
Committed:	Tue Nov 17 21:51:45 2009 UTC (14 years, 5 months ago) by jsr166
Branch:	MAIN
Changes since 1.38:	+4 -4 lines
Log Message:	swallow only expected exceptions
#	User	Rev	Content
1	dl	1.1	/*
2	dl	1.13	* 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	jsr166	1.27	* Other contributors include Andrew Wright, Jeffrey Hayes,
6			* Pat Fisher, Mike Judd.
7	dl	1.1	*/
8
9			import junit.framework.*;
10			import java.util.*;
11			import java.util.concurrent.*;
12	jsr166	1.36	import static java.util.concurrent.TimeUnit.MILLISECONDS;
13	dl	1.1	import java.io.*;
14	dl	1.7	import java.security.*;
15	dl	1.1
16			/**
17	dl	1.5	* 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	jsr166	1.27	* JUnit does not otherwise arrange). The rules for creating such
22	dl	1.5	* tests are:
23	dl	1.1	*
24			* <ol>
25			*
26			* <li> All assertions in code running in generated threads must use
27	jsr166	1.27	* the forms {@link #threadFail}, {@link #threadAssertTrue}, {@link
28	dl	1.18	* #threadAssertEquals}, or {@link #threadAssertNull}, (not
29	dl	1.1	* <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	dl	1.18	* <li> If you override {@link #setUp} or {@link #tearDown}, make sure
35	dl	1.1	* 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	dl	1.6	* <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	dl	1.5	* discriminable from zero time, and always allows enough time for the
43			* small amounts of computation (creating a thread, calling a few
44	dl	1.1	* 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	dl	1.2	* but even so, if there is ever any doubt, they can all be increased
48	jsr166	1.27	* in one spot to rerun tests on slower platforms.</li>
49	dl	1.1	*
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	dl	1.6	* method. The <tt> joinPool</tt> method can be used to do this when
53	dl	1.1	* using Executors.</li>
54			*
55			* </ol>
56	dl	1.6	*
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	jsr166	1.27	*
68	dl	1.6	* <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	dl	1.1	*/
89			public class JSR166TestCase extends TestCase {
90	dl	1.6	/**
91			* Runs all JSR166 unit tests using junit.textui.TestRunner
92	jsr166	1.27	*/
93	dl	1.6	public static void main (String[] args) {
94	dl	1.16	int iters = 1;
95	jsr166	1.27	if (args.length > 0)
96	dl	1.16	iters = Integer.parseInt(args[0]);
97			Test s = suite();
98	dl	1.22	for (int i = 0; i < iters; ++i) {
99	dl	1.16	junit.textui.TestRunner.run (s);
100	dl	1.22	System.gc();
101			System.runFinalization();
102			}
103			System.exit(0);
104	dl	1.6	}
105
106			/**
107			* Collects all JSR166 unit tests as one suite
108	jsr166	1.27	*/
109	dl	1.6	public static Test suite ( ) {
110			TestSuite suite = new TestSuite("JSR166 Unit Tests");
111	jsr166	1.27
112	dl	1.32	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	dl	1.10	suite.addTest(new TestSuite(AbstractExecutorServiceTest.class));
120	dl	1.19	suite.addTest(new TestSuite(AbstractQueueTest.class));
121	dl	1.14	suite.addTest(new TestSuite(AbstractQueuedSynchronizerTest.class));
122	dl	1.25	suite.addTest(new TestSuite(AbstractQueuedLongSynchronizerTest.class));
123	dl	1.6	suite.addTest(new TestSuite(ArrayBlockingQueueTest.class));
124	dl	1.23	suite.addTest(new TestSuite(ArrayDequeTest.class));
125	jsr166	1.27	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	dl	1.6	suite.addTest(new TestSuite(ConcurrentHashMapTest.class));
138			suite.addTest(new TestSuite(ConcurrentLinkedQueueTest.class));
139	dl	1.23	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	dl	1.6	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	dl	1.29	suite.addTest(new TestSuite(EntryTest.class));
149	dl	1.6	suite.addTest(new TestSuite(ExchangerTest.class));
150			suite.addTest(new TestSuite(ExecutorsTest.class));
151	dl	1.11	suite.addTest(new TestSuite(ExecutorCompletionServiceTest.class));
152	dl	1.6	suite.addTest(new TestSuite(FutureTaskTest.class));
153	dl	1.23	suite.addTest(new TestSuite(LinkedBlockingDequeTest.class));
154	dl	1.6	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	dl	1.28	suite.addTest(new TestSuite(ScheduledExecutorSubclassTest.class));
163	dl	1.6	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	dl	1.28	suite.addTest(new TestSuite(ThreadPoolExecutorSubclassTest.class));
169	dl	1.6	suite.addTest(new TestSuite(ThreadTest.class));
170	dl	1.24	suite.addTest(new TestSuite(TimeUnitTest.class));
171	dl	1.23	suite.addTest(new TestSuite(TreeMapTest.class));
172			suite.addTest(new TestSuite(TreeSetTest.class));
173	dl	1.26	suite.addTest(new TestSuite(TreeSubMapTest.class));
174			suite.addTest(new TestSuite(TreeSubSetTest.class));
175	jsr166	1.27
176	dl	1.6	return suite;
177			}
178
179	dl	1.1
180	dl	1.2	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	jsr166	1.27	* Returns the shortest timed delay. This could
188	dl	1.15	* be reimplemented to use for example a Property.
189	jsr166	1.27	*/
190	dl	1.2	protected long getShortDelay() {
191	dl	1.21	return 50;
192	dl	1.2	}
193
194
195			/**
196	jsr166	1.27	* Sets delays as multiples of SHORT_DELAY.
197	dl	1.2	*/
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	dl	1.1	/**
206			* Flag set true if any threadAssert methods fail
207			*/
208	dl	1.5	volatile boolean threadFailed;
209	dl	1.1
210			/**
211	jsr166	1.27	* Initializes test to indicate that no thread assertions have failed
212	dl	1.1	*/
213	jsr166	1.27	public void setUp() {
214	dl	1.2	setDelays();
215	jsr166	1.27	threadFailed = false;
216	dl	1.1	}
217
218			/**
219	jsr166	1.27	* Triggers test case failure if any thread assertions have failed
220	dl	1.1	*/
221	jsr166	1.27	public void tearDown() {
222			assertFalse(threadFailed);
223	dl	1.1	}
224
225	dl	1.5	/**
226			* Fail, also setting status to indicate current testcase should fail
227	jsr166	1.27	*/
228	dl	1.1	public void threadFail(String reason) {
229			threadFailed = true;
230			fail(reason);
231			}
232
233	dl	1.5	/**
234			* If expression not true, set status to indicate current testcase
235			* should fail
236	jsr166	1.27	*/
237	dl	1.1	public void threadAssertTrue(boolean b) {
238			if (!b) {
239			threadFailed = true;
240			assertTrue(b);
241			}
242			}
243	dl	1.5
244			/**
245			* If expression not false, set status to indicate current testcase
246			* should fail
247	jsr166	1.27	*/
248	dl	1.1	public void threadAssertFalse(boolean b) {
249			if (b) {
250			threadFailed = true;
251			assertFalse(b);
252			}
253			}
254	dl	1.5
255			/**
256			* If argument not null, set status to indicate current testcase
257			* should fail
258	jsr166	1.27	*/
259	dl	1.1	public void threadAssertNull(Object x) {
260			if (x != null) {
261			threadFailed = true;
262			assertNull(x);
263			}
264			}
265	dl	1.5
266			/**
267			* If arguments not equal, set status to indicate current testcase
268			* should fail
269	jsr166	1.27	*/
270	dl	1.1	public void threadAssertEquals(long x, long y) {
271			if (x != y) {
272			threadFailed = true;
273			assertEquals(x, y);
274			}
275			}
276	dl	1.5
277			/**
278			* If arguments not equal, set status to indicate current testcase
279			* should fail
280	jsr166	1.27	*/
281	dl	1.1	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	dl	1.5	/**
289			* threadFail with message "should throw exception"
290	jsr166	1.33	*/
291	dl	1.3	public void threadShouldThrow() {
292	dl	1.37	threadFailed = true;
293			fail("should throw exception");
294	dl	1.3	}
295
296	dl	1.5	/**
297			* threadFail with message "Unexpected exception"
298			*/
299	dl	1.3	public void threadUnexpectedException() {
300			threadFailed = true;
301			fail("Unexpected exception");
302			}
303
304	dl	1.31	/**
305			* threadFail with message "Unexpected exception", with argument
306			*/
307			public void threadUnexpectedException(Throwable ex) {
308			threadFailed = true;
309			ex.printStackTrace();
310			fail("Unexpected exception: " + ex);
311			}
312	dl	1.3
313	dl	1.1	/**
314			* Wait out termination of a thread pool or fail doing so
315			*/
316			public void joinPool(ExecutorService exec) {
317			try {
318			exec.shutdown();
319	jsr166	1.36	assertTrue(exec.awaitTermination(LONG_DELAY_MS, MILLISECONDS));
320	jsr166	1.33	} catch (SecurityException ok) {
321	dl	1.22	// Allowed in case test doesn't have privs
322	jsr166	1.33	} catch (InterruptedException ie) {
323	dl	1.3	fail("Unexpected exception");
324	dl	1.1	}
325			}
326
327	dl	1.5
328			/**
329			* fail with message "should throw exception"
330	jsr166	1.27	*/
331	dl	1.3	public void shouldThrow() {
332			fail("Should throw exception");
333			}
334
335	dl	1.5	/**
336			* fail with message "Unexpected exception"
337			*/
338	dl	1.3	public void unexpectedException() {
339			fail("Unexpected exception");
340			}
341	dl	1.1
342	jsr166	1.36	/**
343			* fail with message "Unexpected exception", with argument
344			*/
345			public void unexpectedException(Throwable ex) {
346			ex.printStackTrace();
347			fail("Unexpected exception: " + ex);
348			}
349
350	dl	1.1
351			/**
352			* The number of elements to place in collections, arrays, etc.
353			*/
354	dl	1.5	static final int SIZE = 20;
355	dl	1.1
356			// Some convenient Integer constants
357
358	dl	1.5	static final Integer zero = new Integer(0);
359			static final Integer one = new Integer(1);
360			static final Integer two = new Integer(2);
361			static final Integer three = new Integer(3);
362			static final Integer four = new Integer(4);
363			static final Integer five = new Integer(5);
364			static final Integer six = new Integer(6);
365			static final Integer seven = new Integer(7);
366			static final Integer eight = new Integer(8);
367			static final Integer nine = new Integer(9);
368			static final Integer m1 = new Integer(-1);
369			static final Integer m2 = new Integer(-2);
370			static final Integer m3 = new Integer(-3);
371			static final Integer m4 = new Integer(-4);
372			static final Integer m5 = new Integer(-5);
373	dl	1.30	static final Integer m6 = new Integer(-6);
374	dl	1.5	static final Integer m10 = new Integer(-10);
375	dl	1.7
376
377			/**
378			* A security policy where new permissions can be dynamically added
379			* or all cleared.
380			*/
381			static class AdjustablePolicy extends java.security.Policy {
382			Permissions perms = new Permissions();
383			AdjustablePolicy() { }
384			void addPermission(Permission perm) { perms.add(perm); }
385			void clearPermissions() { perms = new Permissions(); }
386			public PermissionCollection getPermissions(CodeSource cs) {
387			return perms;
388			}
389			public PermissionCollection getPermissions(ProtectionDomain pd) {
390			return perms;
391			}
392			public boolean implies(ProtectionDomain pd, Permission p) {
393			return perms.implies(p);
394			}
395			public void refresh() {}
396			}
397	dl	1.1
398	jsr166	1.38	/**
399			* Sleep until the timeout has elapsed, or interrupted.
400			* Does <em>NOT</em> throw InterruptedException.
401			*/
402			void sleepTillInterrupted(long timeoutMillis) {
403			try {
404			Thread.sleep(timeoutMillis);
405			} catch (InterruptedException wakeup) {
406			}
407			}
408
409			/**
410			* Returns a new started Thread running the given runnable.
411			*/
412			Thread newStartedThread(Runnable runnable) {
413			Thread t = new Thread(runnable);
414			t.start();
415			return t;
416			}
417	dl	1.1
418			// Some convenient Runnable classes
419
420	jsr166	1.35	abstract class CheckedRunnable implements Runnable {
421			abstract void realRun() throws Throwable;
422
423			public final void run() {
424			try {
425			realRun();
426			} catch (Throwable t) {
427			threadUnexpectedException(t);
428			}
429			}
430			}
431
432			abstract class CheckedInterruptedRunnable implements Runnable {
433			abstract void realRun() throws Throwable;
434
435			public final void run() {
436			try {
437			realRun();
438			threadShouldThrow();
439			} catch (InterruptedException success) {
440			} catch (Throwable t) {
441			threadUnexpectedException(t);
442			}
443			}
444			}
445
446			abstract class CheckedCallable<T> implements Callable<T> {
447			abstract T realCall() throws Throwable;
448
449			public final T call() {
450			try {
451			return realCall();
452			} catch (Throwable t) {
453			threadUnexpectedException(t);
454			return null;
455			}
456			}
457			}
458
459	dl	1.5	static class NoOpRunnable implements Runnable {
460	dl	1.1	public void run() {}
461			}
462
463	dl	1.5	static class NoOpCallable implements Callable {
464	dl	1.1	public Object call() { return Boolean.TRUE; }
465	dl	1.10	}
466
467			static final String TEST_STRING = "a test string";
468
469			static class StringTask implements Callable<String> {
470			public String call() { return TEST_STRING; }
471			}
472
473			static class NPETask implements Callable<String> {
474			public String call() { throw new NullPointerException(); }
475			}
476
477			static class CallableOne implements Callable<Integer> {
478			public Integer call() { return one; }
479	dl	1.1	}
480
481	jsr166	1.35	class ShortRunnable extends CheckedRunnable {
482			void realRun() throws Throwable {
483			Thread.sleep(SHORT_DELAY_MS);
484	dl	1.1	}
485			}
486
487	jsr166	1.35	class ShortInterruptedRunnable extends CheckedInterruptedRunnable {
488			void realRun() throws InterruptedException {
489			Thread.sleep(SHORT_DELAY_MS);
490	dl	1.1	}
491			}
492
493	jsr166	1.35	class SmallRunnable extends CheckedRunnable {
494			void realRun() throws Throwable {
495			Thread.sleep(SMALL_DELAY_MS);
496	dl	1.1	}
497			}
498
499	jsr166	1.35	class SmallPossiblyInterruptedRunnable extends CheckedRunnable {
500			void realRun() {
501	dl	1.6	try {
502			Thread.sleep(SMALL_DELAY_MS);
503			}
504	jsr166	1.35	catch (InterruptedException ok) {
505	dl	1.6	}
506			}
507			}
508
509	jsr166	1.35	class SmallCallable extends CheckedCallable {
510			Object realCall() throws Throwable {
511			Thread.sleep(SMALL_DELAY_MS);
512	dl	1.1	return Boolean.TRUE;
513			}
514			}
515
516	jsr166	1.35	class SmallInterruptedRunnable extends CheckedInterruptedRunnable {
517			void realRun() throws InterruptedException {
518			Thread.sleep(SMALL_DELAY_MS);
519	dl	1.1	}
520			}
521
522	jsr166	1.35	class MediumRunnable extends CheckedRunnable {
523			void realRun() throws Throwable {
524			Thread.sleep(MEDIUM_DELAY_MS);
525	dl	1.1	}
526			}
527
528	jsr166	1.35	class MediumInterruptedRunnable extends CheckedInterruptedRunnable {
529			void realRun() throws InterruptedException {
530			Thread.sleep(MEDIUM_DELAY_MS);
531	dl	1.1	}
532			}
533
534	jsr166	1.35	class MediumPossiblyInterruptedRunnable extends CheckedRunnable {
535			void realRun() {
536	dl	1.1	try {
537			Thread.sleep(MEDIUM_DELAY_MS);
538			}
539	jsr166	1.35	catch (InterruptedException ok) {
540	dl	1.1	}
541			}
542			}
543	dl	1.5
544	jsr166	1.35	class LongPossiblyInterruptedRunnable extends CheckedRunnable {
545			void realRun() {
546	dl	1.12	try {
547			Thread.sleep(LONG_DELAY_MS);
548			}
549	jsr166	1.35	catch (InterruptedException ok) {
550	dl	1.12	}
551			}
552			}
553
554	dl	1.5	/**
555			* For use as ThreadFactory in constructors
556			*/
557	jsr166	1.33	static class SimpleThreadFactory implements ThreadFactory {
558			public Thread newThread(Runnable r) {
559	dl	1.5	return new Thread(r);
560	jsr166	1.27	}
561	dl	1.5	}
562
563	dl	1.6	static class TrackedShortRunnable implements Runnable {
564	dl	1.5	volatile boolean done = false;
565			public void run() {
566			try {
567			Thread.sleep(SMALL_DELAY_MS);
568			done = true;
569	jsr166	1.39	} catch (InterruptedException ok) {
570	dl	1.5	}
571	dl	1.6	}
572			}
573
574			static class TrackedMediumRunnable implements Runnable {
575			volatile boolean done = false;
576			public void run() {
577			try {
578			Thread.sleep(MEDIUM_DELAY_MS);
579			done = true;
580	jsr166	1.39	} catch (InterruptedException ok) {
581	dl	1.6	}
582			}
583			}
584
585			static class TrackedLongRunnable implements Runnable {
586			volatile boolean done = false;
587			public void run() {
588			try {
589			Thread.sleep(LONG_DELAY_MS);
590			done = true;
591	jsr166	1.39	} catch (InterruptedException ok) {
592	dl	1.6	}
593			}
594			}
595
596			static class TrackedNoOpRunnable implements Runnable {
597			volatile boolean done = false;
598			public void run() {
599			done = true;
600	dl	1.5	}
601			}
602
603			static class TrackedCallable implements Callable {
604			volatile boolean done = false;
605			public Object call() {
606			try {
607			Thread.sleep(SMALL_DELAY_MS);
608			done = true;
609	jsr166	1.39	} catch (InterruptedException ok) {
610	dl	1.5	}
611			return Boolean.TRUE;
612			}
613			}
614	dl	1.14
615	dl	1.5
616			/**
617			* For use as RejectedExecutionHandler in constructors
618			*/
619	jsr166	1.33	static class NoOpREHandler implements RejectedExecutionHandler {
620	jsr166	1.35	public void rejectedExecution(Runnable r,
621			ThreadPoolExecutor executor) {}
622	dl	1.5	}
623	jsr166	1.27
624	dl	1.1	}