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) {
        junit.textui.TestRunner.run (suite());
    }

    /**
     * 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(ArrayBlockingQueueTest.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(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(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(TimeUnitTest.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 reimplmented to use for example a Property.
     */ 
    protected long getShortDelay() {
        return 100;
    }


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