ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/jsr166/jsr166/src/test/tck/JSR166TestCase.java
Revision: 1.28
Committed: Fri May 20 16:30:17 2005 UTC (18 years, 11 months ago) by dl
Branch: MAIN
Changes since 1.27: +2 -0 lines
Log Message:
Add tests for new protected extenion methods

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