ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/jsr166/jsr166/src/test/tck/JSR166TestCase.java
Revision: 1.17
Committed: Wed Jan 7 20:49:53 2004 UTC (20 years, 4 months ago) by dl
Branch: MAIN
Changes since 1.16: +1 -1 lines
Log Message:
Add tests

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