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