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 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(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() {
       try {
           threadFailed = true;
           fail("should throw exception");
       } catch (AssertionFailedError e) {
           e.printStackTrace();
           throw e;
       }
    }

    /**
     * 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, TimeUnit.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");
    }


    /**
     * 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() {}
    }


    // Some convenient Runnable classes

    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 implements Runnable {
        public void run() {
            try {
                Thread.sleep(SHORT_DELAY_MS);
            }
            catch(Exception e) {
                threadUnexpectedException(e);
            }
        }
    }

    class ShortInterruptedRunnable implements Runnable {
        public void run() {
            try {
                Thread.sleep(SHORT_DELAY_MS);
                threadShouldThrow();
            }
            catch(InterruptedException success) {
            }
        }
    }

    class SmallRunnable implements Runnable {
        public void run() {
            try {
                Thread.sleep(SMALL_DELAY_MS);
            }
            catch(Exception e) {
                threadUnexpectedException(e);
            }
        }
    }

    class SmallPossiblyInterruptedRunnable implements Runnable {
        public void run() {
            try {
                Thread.sleep(SMALL_DELAY_MS);
            }
            catch(Exception e) {
            }
        }
    }

    class SmallCallable implements Callable {
        public Object call() {
            try {
                Thread.sleep(SMALL_DELAY_MS);
            }
            catch(Exception e) {
                threadUnexpectedException(e);
            }
            return Boolean.TRUE;
        }
    }

    class SmallInterruptedRunnable implements Runnable {
        public void run() {
            try {
                Thread.sleep(SMALL_DELAY_MS);
                threadShouldThrow();
            }
            catch(InterruptedException success) {
            }
        }
    }


    class MediumRunnable implements Runnable {
        public void run() {
            try {
                Thread.sleep(MEDIUM_DELAY_MS);
            }
            catch(Exception e) {
                threadUnexpectedException(e);
            }
        }
    }

    class MediumInterruptedRunnable implements Runnable {
        public void run() {
            try {
                Thread.sleep(MEDIUM_DELAY_MS);
                threadShouldThrow();
            }
            catch(InterruptedException success) {
            }
        }
    }

    class MediumPossiblyInterruptedRunnable implements Runnable {
        public void run() {
            try {
                Thread.sleep(MEDIUM_DELAY_MS);
            }
            catch(InterruptedException success) {
            }
        }
    }

    class LongPossiblyInterruptedRunnable implements Runnable {
        public void run() {
            try {
                Thread.sleep(LONG_DELAY_MS);
            }
            catch(InterruptedException success) {
            }
        }
    }

    /**
     * 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(Exception e){
            }
        }
    }

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

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

    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(Exception e){
            }
            return Boolean.TRUE;
        }
    }


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


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