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