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 doe 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(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(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(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(ThreadTest.class));
        suite.addTest(new TestSuite(TreeMapTest.class));
        suite.addTest(new TestSuite(TreeSetTest.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;


    /**
     * Return the shortest timed delay. This could
     * be reimplemented to use for example a Property.
     */ 
    protected long getShortDelay() {
        return 50;
    }


    /**
     * Set 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;

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

    /**
     * Trigger 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");
    }


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

    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();
            }
        }
    }

    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();
            }
            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();
            }
        }
    }

    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.23
Committed:	Tue Dec 28 16:15:59 2004 UTC (19 years, 4 months ago) by dl
Branch:	MAIN
Changes since 1.22:	+8 -1 lines
Log Message:	Integrate tests for jsr166x classes
#	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			* 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			import java.io.*;
13	dl	1.7	import java.security.*;
14	dl	1.1
15			/**
16	dl	1.5	* 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 doe not otherwise arrange). The rules for creating such
21			* tests are:
22	dl	1.1	*
23			* <ol>
24			*
25			* <li> All assertions in code running in generated threads must use
26	dl	1.18	* the forms {@link #threadFail} , {@link #threadAssertTrue} {@link
27			* #threadAssertEquals}, or {@link #threadAssertNull}, (not
28	dl	1.1	* <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	dl	1.18	* <li> If you override {@link #setUp} or {@link #tearDown}, make sure
34	dl	1.1	* 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	dl	1.6	* <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	dl	1.5	* discriminable from zero time, and always allows enough time for the
42			* small amounts of computation (creating a thread, calling a few
43	dl	1.1	* 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	dl	1.2	* 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	dl	1.1	*
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	dl	1.6	* method. The <tt> joinPool</tt> method can be used to do this when
52	dl	1.1	* using Executors.</li>
53			*
54			* </ol>
55	dl	1.6	*
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	dl	1.1	*/
88			public class JSR166TestCase extends TestCase {
89	dl	1.6	/**
90			* Runs all JSR166 unit tests using junit.textui.TestRunner
91			*/
92			public static void main (String[] args) {
93	dl	1.16	int iters = 1;
94			if (args.length > 0)
95			iters = Integer.parseInt(args[0]);
96			Test s = suite();
97	dl	1.22	for (int i = 0; i < iters; ++i) {
98	dl	1.16	junit.textui.TestRunner.run (s);
99	dl	1.22	System.gc();
100			System.runFinalization();
101			}
102			System.exit(0);
103	dl	1.6	}
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	dl	1.10	suite.addTest(new TestSuite(AbstractExecutorServiceTest.class));
112	dl	1.19	suite.addTest(new TestSuite(AbstractQueueTest.class));
113	dl	1.14	suite.addTest(new TestSuite(AbstractQueuedSynchronizerTest.class));
114	dl	1.6	suite.addTest(new TestSuite(ArrayBlockingQueueTest.class));
115	dl	1.23	suite.addTest(new TestSuite(ArrayDequeTest.class));
116	dl	1.6	suite.addTest(new TestSuite(AtomicBooleanTest.class));
117			suite.addTest(new TestSuite(AtomicIntegerArrayTest.class));
118			suite.addTest(new TestSuite(AtomicIntegerFieldUpdaterTest.class));
119			suite.addTest(new TestSuite(AtomicIntegerTest.class));
120			suite.addTest(new TestSuite(AtomicLongArrayTest.class));
121			suite.addTest(new TestSuite(AtomicLongFieldUpdaterTest.class));
122			suite.addTest(new TestSuite(AtomicLongTest.class));
123			suite.addTest(new TestSuite(AtomicMarkableReferenceTest.class));
124			suite.addTest(new TestSuite(AtomicReferenceArrayTest.class));
125			suite.addTest(new TestSuite(AtomicReferenceFieldUpdaterTest.class));
126			suite.addTest(new TestSuite(AtomicReferenceTest.class));
127			suite.addTest(new TestSuite(AtomicStampedReferenceTest.class));
128			suite.addTest(new TestSuite(ConcurrentHashMapTest.class));
129			suite.addTest(new TestSuite(ConcurrentLinkedQueueTest.class));
130	dl	1.23	suite.addTest(new TestSuite(ConcurrentSkipListMapTest.class));
131			suite.addTest(new TestSuite(ConcurrentSkipListSubMapTest.class));
132			suite.addTest(new TestSuite(ConcurrentSkipListSetTest.class));
133			suite.addTest(new TestSuite(ConcurrentSkipListSubSetTest.class));
134	dl	1.6	suite.addTest(new TestSuite(CopyOnWriteArrayListTest.class));
135			suite.addTest(new TestSuite(CopyOnWriteArraySetTest.class));
136			suite.addTest(new TestSuite(CountDownLatchTest.class));
137			suite.addTest(new TestSuite(CyclicBarrierTest.class));
138			suite.addTest(new TestSuite(DelayQueueTest.class));
139			suite.addTest(new TestSuite(ExchangerTest.class));
140			suite.addTest(new TestSuite(ExecutorsTest.class));
141	dl	1.11	suite.addTest(new TestSuite(ExecutorCompletionServiceTest.class));
142	dl	1.6	suite.addTest(new TestSuite(FutureTaskTest.class));
143	dl	1.23	suite.addTest(new TestSuite(LinkedBlockingDequeTest.class));
144	dl	1.6	suite.addTest(new TestSuite(LinkedBlockingQueueTest.class));
145			suite.addTest(new TestSuite(LinkedListTest.class));
146			suite.addTest(new TestSuite(LockSupportTest.class));
147			suite.addTest(new TestSuite(PriorityBlockingQueueTest.class));
148			suite.addTest(new TestSuite(PriorityQueueTest.class));
149			suite.addTest(new TestSuite(ReentrantLockTest.class));
150			suite.addTest(new TestSuite(ReentrantReadWriteLockTest.class));
151			suite.addTest(new TestSuite(ScheduledExecutorTest.class));
152			suite.addTest(new TestSuite(SemaphoreTest.class));
153			suite.addTest(new TestSuite(SynchronousQueueTest.class));
154			suite.addTest(new TestSuite(SystemTest.class));
155			suite.addTest(new TestSuite(ThreadLocalTest.class));
156			suite.addTest(new TestSuite(ThreadPoolExecutorTest.class));
157			suite.addTest(new TestSuite(ThreadTest.class));
158	dl	1.23	suite.addTest(new TestSuite(TreeMapTest.class));
159			suite.addTest(new TestSuite(TreeSetTest.class));
160	dl	1.6
161			return suite;
162			}
163
164	dl	1.1
165	dl	1.2	public static long SHORT_DELAY_MS;
166			public static long SMALL_DELAY_MS;
167			public static long MEDIUM_DELAY_MS;
168			public static long LONG_DELAY_MS;
169
170
171			/**
172			* Return the shortest timed delay. This could
173	dl	1.15	* be reimplemented to use for example a Property.
174	dl	1.2	*/
175			protected long getShortDelay() {
176	dl	1.21	return 50;
177	dl	1.2	}
178
179
180			/**
181	dl	1.5	* Set delays as multiples of SHORT_DELAY.
182	dl	1.2	*/
183			protected void setDelays() {
184			SHORT_DELAY_MS = getShortDelay();
185			SMALL_DELAY_MS = SHORT_DELAY_MS * 5;
186			MEDIUM_DELAY_MS = SHORT_DELAY_MS * 10;
187			LONG_DELAY_MS = SHORT_DELAY_MS * 50;
188			}
189
190	dl	1.1	/**
191			* Flag set true if any threadAssert methods fail
192			*/
193	dl	1.5	volatile boolean threadFailed;
194	dl	1.1
195			/**
196	dl	1.4	* Initialize test to indicate that no thread assertions have failed
197	dl	1.1	*/
198			public void setUp() {
199	dl	1.2	setDelays();
200	dl	1.1	threadFailed = false;
201			}
202
203			/**
204			* Trigger test case failure if any thread assertions have failed
205			*/
206			public void tearDown() {
207			assertFalse(threadFailed);
208			}
209
210	dl	1.5	/**
211			* Fail, also setting status to indicate current testcase should fail
212			*/
213	dl	1.1	public void threadFail(String reason) {
214			threadFailed = true;
215			fail(reason);
216			}
217
218	dl	1.5	/**
219			* If expression not true, set status to indicate current testcase
220			* should fail
221			*/
222	dl	1.1	public void threadAssertTrue(boolean b) {
223			if (!b) {
224			threadFailed = true;
225			assertTrue(b);
226			}
227			}
228	dl	1.5
229			/**
230			* If expression not false, set status to indicate current testcase
231			* should fail
232			*/
233	dl	1.1	public void threadAssertFalse(boolean b) {
234			if (b) {
235			threadFailed = true;
236			assertFalse(b);
237			}
238			}
239	dl	1.5
240			/**
241			* If argument not null, set status to indicate current testcase
242			* should fail
243			*/
244	dl	1.1	public void threadAssertNull(Object x) {
245			if (x != null) {
246			threadFailed = true;
247			assertNull(x);
248			}
249			}
250	dl	1.5
251			/**
252			* If arguments not equal, set status to indicate current testcase
253			* should fail
254			*/
255	dl	1.1	public void threadAssertEquals(long x, long y) {
256			if (x != y) {
257			threadFailed = true;
258			assertEquals(x, y);
259			}
260			}
261	dl	1.5
262			/**
263			* If arguments not equal, set status to indicate current testcase
264			* should fail
265			*/
266	dl	1.1	public void threadAssertEquals(Object x, Object y) {
267			if (x != y && (x == null \|\| !x.equals(y))) {
268			threadFailed = true;
269			assertEquals(x, y);
270			}
271			}
272
273	dl	1.5	/**
274			* threadFail with message "should throw exception"
275			*/
276	dl	1.3	public void threadShouldThrow() {
277			threadFailed = true;
278			fail("should throw exception");
279			}
280
281	dl	1.5	/**
282			* threadFail with message "Unexpected exception"
283			*/
284	dl	1.3	public void threadUnexpectedException() {
285			threadFailed = true;
286			fail("Unexpected exception");
287			}
288
289
290	dl	1.1	/**
291			* Wait out termination of a thread pool or fail doing so
292			*/
293			public void joinPool(ExecutorService exec) {
294			try {
295			exec.shutdown();
296			assertTrue(exec.awaitTermination(LONG_DELAY_MS, TimeUnit.MILLISECONDS));
297	dl	1.22	} catch(SecurityException ok) {
298			// Allowed in case test doesn't have privs
299	dl	1.1	} catch(InterruptedException ie) {
300	dl	1.3	fail("Unexpected exception");
301	dl	1.1	}
302			}
303
304	dl	1.5
305			/**
306			* fail with message "should throw exception"
307			*/
308	dl	1.3	public void shouldThrow() {
309			fail("Should throw exception");
310			}
311
312	dl	1.5	/**
313			* fail with message "Unexpected exception"
314			*/
315	dl	1.3	public void unexpectedException() {
316			fail("Unexpected exception");
317			}
318	dl	1.1
319
320			/**
321			* The number of elements to place in collections, arrays, etc.
322			*/
323	dl	1.5	static final int SIZE = 20;
324	dl	1.1
325			// Some convenient Integer constants
326
327	dl	1.5	static final Integer zero = new Integer(0);
328			static final Integer one = new Integer(1);
329			static final Integer two = new Integer(2);
330			static final Integer three = new Integer(3);
331			static final Integer four = new Integer(4);
332			static final Integer five = new Integer(5);
333			static final Integer six = new Integer(6);
334			static final Integer seven = new Integer(7);
335			static final Integer eight = new Integer(8);
336			static final Integer nine = new Integer(9);
337			static final Integer m1 = new Integer(-1);
338			static final Integer m2 = new Integer(-2);
339			static final Integer m3 = new Integer(-3);
340			static final Integer m4 = new Integer(-4);
341			static final Integer m5 = new Integer(-5);
342			static final Integer m10 = new Integer(-10);
343	dl	1.7
344
345			/**
346			* A security policy where new permissions can be dynamically added
347			* or all cleared.
348			*/
349			static class AdjustablePolicy extends java.security.Policy {
350			Permissions perms = new Permissions();
351			AdjustablePolicy() { }
352			void addPermission(Permission perm) { perms.add(perm); }
353			void clearPermissions() { perms = new Permissions(); }
354			public PermissionCollection getPermissions(CodeSource cs) {
355			return perms;
356			}
357			public PermissionCollection getPermissions(ProtectionDomain pd) {
358			return perms;
359			}
360			public boolean implies(ProtectionDomain pd, Permission p) {
361			return perms.implies(p);
362			}
363			public void refresh() {}
364			}
365	dl	1.1
366
367			// Some convenient Runnable classes
368
369	dl	1.5	static class NoOpRunnable implements Runnable {
370	dl	1.1	public void run() {}
371			}
372
373	dl	1.5	static class NoOpCallable implements Callable {
374	dl	1.1	public Object call() { return Boolean.TRUE; }
375	dl	1.10	}
376
377			static final String TEST_STRING = "a test string";
378
379			static class StringTask implements Callable<String> {
380			public String call() { return TEST_STRING; }
381			}
382
383			static class NPETask implements Callable<String> {
384			public String call() { throw new NullPointerException(); }
385			}
386
387			static class CallableOne implements Callable<Integer> {
388			public Integer call() { return one; }
389	dl	1.1	}
390
391	dl	1.5	class ShortRunnable implements Runnable {
392	dl	1.1	public void run() {
393			try {
394			Thread.sleep(SHORT_DELAY_MS);
395			}
396			catch(Exception e) {
397	dl	1.3	threadUnexpectedException();
398	dl	1.1	}
399			}
400			}
401
402	dl	1.5	class ShortInterruptedRunnable implements Runnable {
403	dl	1.1	public void run() {
404			try {
405			Thread.sleep(SHORT_DELAY_MS);
406	dl	1.3	threadShouldThrow();
407	dl	1.1	}
408			catch(InterruptedException success) {
409			}
410			}
411			}
412
413	dl	1.5	class SmallRunnable implements Runnable {
414	dl	1.1	public void run() {
415			try {
416			Thread.sleep(SMALL_DELAY_MS);
417			}
418			catch(Exception e) {
419	dl	1.3	threadUnexpectedException();
420	dl	1.1	}
421			}
422			}
423
424	dl	1.6	class SmallPossiblyInterruptedRunnable implements Runnable {
425			public void run() {
426			try {
427			Thread.sleep(SMALL_DELAY_MS);
428			}
429			catch(Exception e) {
430			}
431			}
432			}
433
434	dl	1.5	class SmallCallable implements Callable {
435	dl	1.1	public Object call() {
436			try {
437			Thread.sleep(SMALL_DELAY_MS);
438			}
439			catch(Exception e) {
440	dl	1.3	threadUnexpectedException();
441	dl	1.1	}
442			return Boolean.TRUE;
443			}
444			}
445
446	dl	1.5	class SmallInterruptedRunnable implements Runnable {
447	dl	1.1	public void run() {
448			try {
449			Thread.sleep(SMALL_DELAY_MS);
450	dl	1.3	threadShouldThrow();
451	dl	1.1	}
452			catch(InterruptedException success) {
453			}
454			}
455			}
456
457
458	dl	1.5	class MediumRunnable implements Runnable {
459	dl	1.1	public void run() {
460			try {
461			Thread.sleep(MEDIUM_DELAY_MS);
462			}
463			catch(Exception e) {
464	dl	1.3	threadUnexpectedException();
465	dl	1.1	}
466			}
467			}
468
469	dl	1.5	class MediumInterruptedRunnable implements Runnable {
470	dl	1.1	public void run() {
471			try {
472			Thread.sleep(MEDIUM_DELAY_MS);
473	dl	1.3	threadShouldThrow();
474	dl	1.1	}
475			catch(InterruptedException success) {
476			}
477			}
478			}
479
480	dl	1.5	class MediumPossiblyInterruptedRunnable implements Runnable {
481	dl	1.1	public void run() {
482			try {
483			Thread.sleep(MEDIUM_DELAY_MS);
484			}
485			catch(InterruptedException success) {
486			}
487			}
488			}
489	dl	1.5
490	dl	1.12	class LongPossiblyInterruptedRunnable implements Runnable {
491			public void run() {
492			try {
493			Thread.sleep(LONG_DELAY_MS);
494			}
495			catch(InterruptedException success) {
496			}
497			}
498			}
499
500	dl	1.5	/**
501			* For use as ThreadFactory in constructors
502			*/
503			static class SimpleThreadFactory implements ThreadFactory{
504			public Thread newThread(Runnable r){
505			return new Thread(r);
506			}
507			}
508
509	dl	1.6	static class TrackedShortRunnable implements Runnable {
510	dl	1.5	volatile boolean done = false;
511			public void run() {
512			try {
513			Thread.sleep(SMALL_DELAY_MS);
514			done = true;
515			} catch(Exception e){
516			}
517	dl	1.6	}
518			}
519
520			static class TrackedMediumRunnable implements Runnable {
521			volatile boolean done = false;
522			public void run() {
523			try {
524			Thread.sleep(MEDIUM_DELAY_MS);
525			done = true;
526			} catch(Exception e){
527			}
528			}
529			}
530
531			static class TrackedLongRunnable implements Runnable {
532			volatile boolean done = false;
533			public void run() {
534			try {
535			Thread.sleep(LONG_DELAY_MS);
536			done = true;
537			} catch(Exception e){
538			}
539			}
540			}
541
542			static class TrackedNoOpRunnable implements Runnable {
543			volatile boolean done = false;
544			public void run() {
545			done = true;
546	dl	1.5	}
547			}
548
549			static class TrackedCallable implements Callable {
550			volatile boolean done = false;
551			public Object call() {
552			try {
553			Thread.sleep(SMALL_DELAY_MS);
554			done = true;
555			} catch(Exception e){
556			}
557			return Boolean.TRUE;
558			}
559			}
560	dl	1.14
561	dl	1.5
562			/**
563			* For use as RejectedExecutionHandler in constructors
564			*/
565			static class NoOpREHandler implements RejectedExecutionHandler{
566			public void rejectedExecution(Runnable r, ThreadPoolExecutor executor){}
567			}
568
569	dl	1.1
570			}