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