ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/jsr166/jsr166/src/test/tck/JSR166TestCase.java
Revision: 1.30
Committed: Thu Apr 20 20:35:00 2006 UTC (18 years ago) by dl
Branch: MAIN
Changes since 1.29: +1 -0 lines
Log Message:
Simplify Navigable method names

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