ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/jsr166/jsr166/src/test/tck/JSR166TestCase.java
Revision: 1.36
Committed: Mon Aug 3 22:08:45 2009 UTC (14 years, 9 months ago) by jsr166
Branch: MAIN
Changes since 1.35: +10 -1 lines
Log Message:
add unexpectedException(Throwable)

File Contents

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