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/publicdomain/zero/1.0/ |
5 |
* Other contributors include Andrew Wright, Jeffrey Hayes, |
6 |
* Pat Fisher, Mike Judd. |
7 |
*/ |
8 |
|
9 |
import static java.util.concurrent.TimeUnit.MILLISECONDS; |
10 |
import static java.util.concurrent.TimeUnit.NANOSECONDS; |
11 |
|
12 |
import java.io.ByteArrayInputStream; |
13 |
import java.io.ByteArrayOutputStream; |
14 |
import java.io.ObjectInputStream; |
15 |
import java.io.ObjectOutputStream; |
16 |
import java.lang.management.ManagementFactory; |
17 |
import java.lang.management.ThreadInfo; |
18 |
import java.lang.reflect.Constructor; |
19 |
import java.lang.reflect.Method; |
20 |
import java.lang.reflect.Modifier; |
21 |
import java.security.CodeSource; |
22 |
import java.security.Permission; |
23 |
import java.security.PermissionCollection; |
24 |
import java.security.Permissions; |
25 |
import java.security.Policy; |
26 |
import java.security.ProtectionDomain; |
27 |
import java.security.SecurityPermission; |
28 |
import java.util.ArrayList; |
29 |
import java.util.Arrays; |
30 |
import java.util.Date; |
31 |
import java.util.Enumeration; |
32 |
import java.util.Iterator; |
33 |
import java.util.List; |
34 |
import java.util.NoSuchElementException; |
35 |
import java.util.PropertyPermission; |
36 |
import java.util.concurrent.BlockingQueue; |
37 |
import java.util.concurrent.Callable; |
38 |
import java.util.concurrent.CountDownLatch; |
39 |
import java.util.concurrent.CyclicBarrier; |
40 |
import java.util.concurrent.ExecutionException; |
41 |
import java.util.concurrent.Executors; |
42 |
import java.util.concurrent.ExecutorService; |
43 |
import java.util.concurrent.ForkJoinPool; |
44 |
import java.util.concurrent.Future; |
45 |
import java.util.concurrent.RecursiveAction; |
46 |
import java.util.concurrent.RecursiveTask; |
47 |
import java.util.concurrent.RejectedExecutionHandler; |
48 |
import java.util.concurrent.Semaphore; |
49 |
import java.util.concurrent.ThreadFactory; |
50 |
import java.util.concurrent.ThreadPoolExecutor; |
51 |
import java.util.concurrent.TimeoutException; |
52 |
import java.util.concurrent.atomic.AtomicReference; |
53 |
import java.util.regex.Pattern; |
54 |
|
55 |
import junit.framework.AssertionFailedError; |
56 |
import junit.framework.Test; |
57 |
import junit.framework.TestCase; |
58 |
import junit.framework.TestResult; |
59 |
import junit.framework.TestSuite; |
60 |
|
61 |
/** |
62 |
* Base class for JSR166 Junit TCK tests. Defines some constants, |
63 |
* utility methods and classes, as well as a simple framework for |
64 |
* helping to make sure that assertions failing in generated threads |
65 |
* cause the associated test that generated them to itself fail (which |
66 |
* JUnit does not otherwise arrange). The rules for creating such |
67 |
* tests are: |
68 |
* |
69 |
* <ol> |
70 |
* |
71 |
* <li>All assertions in code running in generated threads must use |
72 |
* the forms {@link #threadFail}, {@link #threadAssertTrue}, {@link |
73 |
* #threadAssertEquals}, or {@link #threadAssertNull}, (not |
74 |
* {@code fail}, {@code assertTrue}, etc.) It is OK (but not |
75 |
* particularly recommended) for other code to use these forms too. |
76 |
* Only the most typically used JUnit assertion methods are defined |
77 |
* this way, but enough to live with. |
78 |
* |
79 |
* <li>If you override {@link #setUp} or {@link #tearDown}, make sure |
80 |
* to invoke {@code super.setUp} and {@code super.tearDown} within |
81 |
* them. These methods are used to clear and check for thread |
82 |
* assertion failures. |
83 |
* |
84 |
* <li>All delays and timeouts must use one of the constants {@code |
85 |
* SHORT_DELAY_MS}, {@code SMALL_DELAY_MS}, {@code MEDIUM_DELAY_MS}, |
86 |
* {@code LONG_DELAY_MS}. The idea here is that a SHORT is always |
87 |
* discriminable from zero time, and always allows enough time for the |
88 |
* small amounts of computation (creating a thread, calling a few |
89 |
* methods, etc) needed to reach a timeout point. Similarly, a SMALL |
90 |
* is always discriminable as larger than SHORT and smaller than |
91 |
* MEDIUM. And so on. These constants are set to conservative values, |
92 |
* but even so, if there is ever any doubt, they can all be increased |
93 |
* in one spot to rerun tests on slower platforms. |
94 |
* |
95 |
* <li>All threads generated must be joined inside each test case |
96 |
* method (or {@code fail} to do so) before returning from the |
97 |
* method. The {@code joinPool} method can be used to do this when |
98 |
* using Executors. |
99 |
* |
100 |
* </ol> |
101 |
* |
102 |
* <p><b>Other notes</b> |
103 |
* <ul> |
104 |
* |
105 |
* <li>Usually, there is one testcase method per JSR166 method |
106 |
* covering "normal" operation, and then as many exception-testing |
107 |
* methods as there are exceptions the method can throw. Sometimes |
108 |
* there are multiple tests per JSR166 method when the different |
109 |
* "normal" behaviors differ significantly. And sometimes testcases |
110 |
* cover multiple methods when they cannot be tested in |
111 |
* isolation. |
112 |
* |
113 |
* <li>The documentation style for testcases is to provide as javadoc |
114 |
* a simple sentence or two describing the property that the testcase |
115 |
* method purports to test. The javadocs do not say anything about how |
116 |
* the property is tested. To find out, read the code. |
117 |
* |
118 |
* <li>These tests are "conformance tests", and do not attempt to |
119 |
* test throughput, latency, scalability or other performance factors |
120 |
* (see the separate "jtreg" tests for a set intended to check these |
121 |
* for the most central aspects of functionality.) So, most tests use |
122 |
* the smallest sensible numbers of threads, collection sizes, etc |
123 |
* needed to check basic conformance. |
124 |
* |
125 |
* <li>The test classes currently do not declare inclusion in |
126 |
* any particular package to simplify things for people integrating |
127 |
* them in TCK test suites. |
128 |
* |
129 |
* <li>As a convenience, the {@code main} of this class (JSR166TestCase) |
130 |
* runs all JSR166 unit tests. |
131 |
* |
132 |
* </ul> |
133 |
*/ |
134 |
public class JSR166TestCase extends TestCase { |
135 |
private static final boolean useSecurityManager = |
136 |
Boolean.getBoolean("jsr166.useSecurityManager"); |
137 |
|
138 |
protected static final boolean expensiveTests = |
139 |
Boolean.getBoolean("jsr166.expensiveTests"); |
140 |
|
141 |
/** |
142 |
* If true, also run tests that are not part of the official tck |
143 |
* because they test unspecified implementation details. |
144 |
*/ |
145 |
protected static final boolean testImplementationDetails = |
146 |
Boolean.getBoolean("jsr166.testImplementationDetails"); |
147 |
|
148 |
/** |
149 |
* If true, report on stdout all "slow" tests, that is, ones that |
150 |
* take more than profileThreshold milliseconds to execute. |
151 |
*/ |
152 |
private static final boolean profileTests = |
153 |
Boolean.getBoolean("jsr166.profileTests"); |
154 |
|
155 |
/** |
156 |
* The number of milliseconds that tests are permitted for |
157 |
* execution without being reported, when profileTests is set. |
158 |
*/ |
159 |
private static final long profileThreshold = |
160 |
Long.getLong("jsr166.profileThreshold", 100); |
161 |
|
162 |
/** |
163 |
* The number of repetitions per test (for tickling rare bugs). |
164 |
*/ |
165 |
private static final int runsPerTest = |
166 |
Integer.getInteger("jsr166.runsPerTest", 1); |
167 |
|
168 |
/** |
169 |
* The number of repetitions of the test suite (for finding leaks?). |
170 |
*/ |
171 |
private static final int suiteRuns = |
172 |
Integer.getInteger("jsr166.suiteRuns", 1); |
173 |
|
174 |
public JSR166TestCase() { super(); } |
175 |
public JSR166TestCase(String name) { super(name); } |
176 |
|
177 |
/** |
178 |
* A filter for tests to run, matching strings of the form |
179 |
* methodName(className), e.g. "testInvokeAll5(ForkJoinPoolTest)" |
180 |
* Usefully combined with jsr166.runsPerTest. |
181 |
*/ |
182 |
private static final Pattern methodFilter = methodFilter(); |
183 |
|
184 |
private static Pattern methodFilter() { |
185 |
String regex = System.getProperty("jsr166.methodFilter"); |
186 |
return (regex == null) ? null : Pattern.compile(regex); |
187 |
} |
188 |
|
189 |
public void runBare() throws Throwable { |
190 |
if (methodFilter == null |
191 |
|| methodFilter.matcher(toString()).find()) |
192 |
super.runBare(); |
193 |
} |
194 |
|
195 |
protected void runTest() throws Throwable { |
196 |
for (int i = 0; i < runsPerTest; i++) { |
197 |
if (profileTests) |
198 |
runTestProfiled(); |
199 |
else |
200 |
super.runTest(); |
201 |
} |
202 |
} |
203 |
|
204 |
protected void runTestProfiled() throws Throwable { |
205 |
for (int i = 0; i < 2; i++) { |
206 |
long startTime = System.nanoTime(); |
207 |
super.runTest(); |
208 |
long elapsedMillis = millisElapsedSince(startTime); |
209 |
if (elapsedMillis < profileThreshold) |
210 |
break; |
211 |
// Never report first run of any test; treat it as a |
212 |
// warmup run, notably to trigger all needed classloading, |
213 |
if (i > 0) |
214 |
System.out.printf("%n%s: %d%n", toString(), elapsedMillis); |
215 |
} |
216 |
} |
217 |
|
218 |
/** |
219 |
* Runs all JSR166 unit tests using junit.textui.TestRunner. |
220 |
*/ |
221 |
public static void main(String[] args) { |
222 |
main(suite(), args); |
223 |
} |
224 |
|
225 |
/** |
226 |
* Runs all unit tests in the given test suite. |
227 |
* Actual behavior influenced by jsr166.* system properties. |
228 |
*/ |
229 |
static void main(Test suite, String[] args) { |
230 |
if (useSecurityManager) { |
231 |
System.err.println("Setting a permissive security manager"); |
232 |
Policy.setPolicy(permissivePolicy()); |
233 |
System.setSecurityManager(new SecurityManager()); |
234 |
} |
235 |
for (int i = 0; i < suiteRuns; i++) { |
236 |
TestResult result = junit.textui.TestRunner.run(suite); |
237 |
if (!result.wasSuccessful()) |
238 |
System.exit(1); |
239 |
System.gc(); |
240 |
System.runFinalization(); |
241 |
} |
242 |
} |
243 |
|
244 |
public static TestSuite newTestSuite(Object... suiteOrClasses) { |
245 |
TestSuite suite = new TestSuite(); |
246 |
for (Object suiteOrClass : suiteOrClasses) { |
247 |
if (suiteOrClass instanceof TestSuite) |
248 |
suite.addTest((TestSuite) suiteOrClass); |
249 |
else if (suiteOrClass instanceof Class) |
250 |
suite.addTest(new TestSuite((Class<?>) suiteOrClass)); |
251 |
else |
252 |
throw new ClassCastException("not a test suite or class"); |
253 |
} |
254 |
return suite; |
255 |
} |
256 |
|
257 |
public static void addNamedTestClasses(TestSuite suite, |
258 |
String... testClassNames) { |
259 |
for (String testClassName : testClassNames) { |
260 |
try { |
261 |
Class<?> testClass = Class.forName(testClassName); |
262 |
Method m = testClass.getDeclaredMethod("suite", |
263 |
new Class<?>[0]); |
264 |
suite.addTest(newTestSuite((Test)m.invoke(null))); |
265 |
} catch (Exception e) { |
266 |
throw new Error("Missing test class", e); |
267 |
} |
268 |
} |
269 |
} |
270 |
|
271 |
public static final double JAVA_CLASS_VERSION; |
272 |
public static final String JAVA_SPECIFICATION_VERSION; |
273 |
static { |
274 |
try { |
275 |
JAVA_CLASS_VERSION = java.security.AccessController.doPrivileged( |
276 |
new java.security.PrivilegedAction<Double>() { |
277 |
public Double run() { |
278 |
return Double.valueOf(System.getProperty("java.class.version"));}}); |
279 |
JAVA_SPECIFICATION_VERSION = java.security.AccessController.doPrivileged( |
280 |
new java.security.PrivilegedAction<String>() { |
281 |
public String run() { |
282 |
return System.getProperty("java.specification.version");}}); |
283 |
} catch (Throwable t) { |
284 |
throw new Error(t); |
285 |
} |
286 |
} |
287 |
|
288 |
public static boolean atLeastJava6() { return JAVA_CLASS_VERSION >= 50.0; } |
289 |
public static boolean atLeastJava7() { return JAVA_CLASS_VERSION >= 51.0; } |
290 |
public static boolean atLeastJava8() { return JAVA_CLASS_VERSION >= 52.0; } |
291 |
public static boolean atLeastJava9() { |
292 |
return JAVA_CLASS_VERSION >= 53.0 |
293 |
// As of 2015-09, java9 still uses 52.0 class file version |
294 |
|| JAVA_SPECIFICATION_VERSION.matches("^(1\\.)?(9|[0-9][0-9])$"); |
295 |
} |
296 |
public static boolean atLeastJava10() { |
297 |
return JAVA_CLASS_VERSION >= 54.0 |
298 |
|| JAVA_SPECIFICATION_VERSION.matches("^(1\\.)?[0-9][0-9]$"); |
299 |
} |
300 |
|
301 |
/** |
302 |
* Collects all JSR166 unit tests as one suite. |
303 |
*/ |
304 |
public static Test suite() { |
305 |
// Java7+ test classes |
306 |
TestSuite suite = newTestSuite( |
307 |
ForkJoinPoolTest.suite(), |
308 |
ForkJoinTaskTest.suite(), |
309 |
RecursiveActionTest.suite(), |
310 |
RecursiveTaskTest.suite(), |
311 |
LinkedTransferQueueTest.suite(), |
312 |
PhaserTest.suite(), |
313 |
ThreadLocalRandomTest.suite(), |
314 |
AbstractExecutorServiceTest.suite(), |
315 |
AbstractQueueTest.suite(), |
316 |
AbstractQueuedSynchronizerTest.suite(), |
317 |
AbstractQueuedLongSynchronizerTest.suite(), |
318 |
ArrayBlockingQueueTest.suite(), |
319 |
ArrayDequeTest.suite(), |
320 |
AtomicBooleanTest.suite(), |
321 |
AtomicIntegerArrayTest.suite(), |
322 |
AtomicIntegerFieldUpdaterTest.suite(), |
323 |
AtomicIntegerTest.suite(), |
324 |
AtomicLongArrayTest.suite(), |
325 |
AtomicLongFieldUpdaterTest.suite(), |
326 |
AtomicLongTest.suite(), |
327 |
AtomicMarkableReferenceTest.suite(), |
328 |
AtomicReferenceArrayTest.suite(), |
329 |
AtomicReferenceFieldUpdaterTest.suite(), |
330 |
AtomicReferenceTest.suite(), |
331 |
AtomicStampedReferenceTest.suite(), |
332 |
ConcurrentHashMapTest.suite(), |
333 |
ConcurrentLinkedDequeTest.suite(), |
334 |
ConcurrentLinkedQueueTest.suite(), |
335 |
ConcurrentSkipListMapTest.suite(), |
336 |
ConcurrentSkipListSubMapTest.suite(), |
337 |
ConcurrentSkipListSetTest.suite(), |
338 |
ConcurrentSkipListSubSetTest.suite(), |
339 |
CopyOnWriteArrayListTest.suite(), |
340 |
CopyOnWriteArraySetTest.suite(), |
341 |
CountDownLatchTest.suite(), |
342 |
CyclicBarrierTest.suite(), |
343 |
DelayQueueTest.suite(), |
344 |
EntryTest.suite(), |
345 |
ExchangerTest.suite(), |
346 |
ExecutorsTest.suite(), |
347 |
ExecutorCompletionServiceTest.suite(), |
348 |
FutureTaskTest.suite(), |
349 |
LinkedBlockingDequeTest.suite(), |
350 |
LinkedBlockingQueueTest.suite(), |
351 |
LinkedListTest.suite(), |
352 |
LockSupportTest.suite(), |
353 |
PriorityBlockingQueueTest.suite(), |
354 |
PriorityQueueTest.suite(), |
355 |
ReentrantLockTest.suite(), |
356 |
ReentrantReadWriteLockTest.suite(), |
357 |
ScheduledExecutorTest.suite(), |
358 |
ScheduledExecutorSubclassTest.suite(), |
359 |
SemaphoreTest.suite(), |
360 |
SynchronousQueueTest.suite(), |
361 |
SystemTest.suite(), |
362 |
ThreadLocalTest.suite(), |
363 |
ThreadPoolExecutorTest.suite(), |
364 |
ThreadPoolExecutorSubclassTest.suite(), |
365 |
ThreadTest.suite(), |
366 |
TimeUnitTest.suite(), |
367 |
TreeMapTest.suite(), |
368 |
TreeSetTest.suite(), |
369 |
TreeSubMapTest.suite(), |
370 |
TreeSubSetTest.suite()); |
371 |
|
372 |
// Java8+ test classes |
373 |
if (atLeastJava8()) { |
374 |
String[] java8TestClassNames = { |
375 |
"Atomic8Test", |
376 |
"CompletableFutureTest", |
377 |
"ConcurrentHashMap8Test", |
378 |
"CountedCompleterTest", |
379 |
"DoubleAccumulatorTest", |
380 |
"DoubleAdderTest", |
381 |
"ForkJoinPool8Test", |
382 |
"ForkJoinTask8Test", |
383 |
"LongAccumulatorTest", |
384 |
"LongAdderTest", |
385 |
"SplittableRandomTest", |
386 |
"StampedLockTest", |
387 |
"SubmissionPublisherTest", |
388 |
"ThreadLocalRandom8Test", |
389 |
}; |
390 |
addNamedTestClasses(suite, java8TestClassNames); |
391 |
} |
392 |
|
393 |
// Java9+ test classes |
394 |
if (atLeastJava9()) { |
395 |
String[] java9TestClassNames = { |
396 |
// Currently empty, but expecting varhandle tests |
397 |
}; |
398 |
addNamedTestClasses(suite, java9TestClassNames); |
399 |
} |
400 |
|
401 |
return suite; |
402 |
} |
403 |
|
404 |
/** Returns list of junit-style test method names in given class. */ |
405 |
public static ArrayList<String> testMethodNames(Class<?> testClass) { |
406 |
Method[] methods = testClass.getDeclaredMethods(); |
407 |
ArrayList<String> names = new ArrayList<String>(methods.length); |
408 |
for (Method method : methods) { |
409 |
if (method.getName().startsWith("test") |
410 |
&& Modifier.isPublic(method.getModifiers()) |
411 |
// method.getParameterCount() requires jdk8+ |
412 |
&& method.getParameterTypes().length == 0) { |
413 |
names.add(method.getName()); |
414 |
} |
415 |
} |
416 |
return names; |
417 |
} |
418 |
|
419 |
/** |
420 |
* Returns junit-style testSuite for the given test class, but |
421 |
* parameterized by passing extra data to each test. |
422 |
*/ |
423 |
public static <ExtraData> Test parameterizedTestSuite |
424 |
(Class<? extends JSR166TestCase> testClass, |
425 |
Class<ExtraData> dataClass, |
426 |
ExtraData data) { |
427 |
try { |
428 |
TestSuite suite = new TestSuite(); |
429 |
Constructor c = |
430 |
testClass.getDeclaredConstructor(dataClass, String.class); |
431 |
for (String methodName : testMethodNames(testClass)) |
432 |
suite.addTest((Test) c.newInstance(data, methodName)); |
433 |
return suite; |
434 |
} catch (Exception e) { |
435 |
throw new Error(e); |
436 |
} |
437 |
} |
438 |
|
439 |
/** |
440 |
* Returns junit-style testSuite for the jdk8 extension of the |
441 |
* given test class, but parameterized by passing extra data to |
442 |
* each test. Uses reflection to allow compilation in jdk7. |
443 |
*/ |
444 |
public static <ExtraData> Test jdk8ParameterizedTestSuite |
445 |
(Class<? extends JSR166TestCase> testClass, |
446 |
Class<ExtraData> dataClass, |
447 |
ExtraData data) { |
448 |
if (atLeastJava8()) { |
449 |
String name = testClass.getName(); |
450 |
String name8 = name.replaceAll("Test$", "8Test"); |
451 |
if (name.equals(name8)) throw new Error(name); |
452 |
try { |
453 |
return (Test) |
454 |
Class.forName(name8) |
455 |
.getMethod("testSuite", new Class[] { dataClass }) |
456 |
.invoke(null, data); |
457 |
} catch (Exception e) { |
458 |
throw new Error(e); |
459 |
} |
460 |
} else { |
461 |
return new TestSuite(); |
462 |
} |
463 |
|
464 |
} |
465 |
|
466 |
// Delays for timing-dependent tests, in milliseconds. |
467 |
|
468 |
public static long SHORT_DELAY_MS; |
469 |
public static long SMALL_DELAY_MS; |
470 |
public static long MEDIUM_DELAY_MS; |
471 |
public static long LONG_DELAY_MS; |
472 |
|
473 |
/** |
474 |
* Returns the shortest timed delay. This could |
475 |
* be reimplemented to use for example a Property. |
476 |
*/ |
477 |
protected long getShortDelay() { |
478 |
return 50; |
479 |
} |
480 |
|
481 |
/** |
482 |
* Sets delays as multiples of SHORT_DELAY. |
483 |
*/ |
484 |
protected void setDelays() { |
485 |
SHORT_DELAY_MS = getShortDelay(); |
486 |
SMALL_DELAY_MS = SHORT_DELAY_MS * 5; |
487 |
MEDIUM_DELAY_MS = SHORT_DELAY_MS * 10; |
488 |
LONG_DELAY_MS = SHORT_DELAY_MS * 200; |
489 |
} |
490 |
|
491 |
/** |
492 |
* Returns a timeout in milliseconds to be used in tests that |
493 |
* verify that operations block or time out. |
494 |
*/ |
495 |
long timeoutMillis() { |
496 |
return SHORT_DELAY_MS / 4; |
497 |
} |
498 |
|
499 |
/** |
500 |
* Returns a new Date instance representing a time at least |
501 |
* delayMillis milliseconds in the future. |
502 |
*/ |
503 |
Date delayedDate(long delayMillis) { |
504 |
// Add 1 because currentTimeMillis is known to round into the past. |
505 |
return new Date(System.currentTimeMillis() + delayMillis + 1); |
506 |
} |
507 |
|
508 |
/** |
509 |
* The first exception encountered if any threadAssertXXX method fails. |
510 |
*/ |
511 |
private final AtomicReference<Throwable> threadFailure |
512 |
= new AtomicReference<Throwable>(null); |
513 |
|
514 |
/** |
515 |
* Records an exception so that it can be rethrown later in the test |
516 |
* harness thread, triggering a test case failure. Only the first |
517 |
* failure is recorded; subsequent calls to this method from within |
518 |
* the same test have no effect. |
519 |
*/ |
520 |
public void threadRecordFailure(Throwable t) { |
521 |
threadFailure.compareAndSet(null, t); |
522 |
} |
523 |
|
524 |
public void setUp() { |
525 |
setDelays(); |
526 |
} |
527 |
|
528 |
void tearDownFail(String format, Object... args) { |
529 |
String msg = toString() + ": " + String.format(format, args); |
530 |
System.err.println(msg); |
531 |
printAllStackTraces(); |
532 |
throw new AssertionFailedError(msg); |
533 |
} |
534 |
|
535 |
/** |
536 |
* Extra checks that get done for all test cases. |
537 |
* |
538 |
* Triggers test case failure if any thread assertions have failed, |
539 |
* by rethrowing, in the test harness thread, any exception recorded |
540 |
* earlier by threadRecordFailure. |
541 |
* |
542 |
* Triggers test case failure if interrupt status is set in the main thread. |
543 |
*/ |
544 |
public void tearDown() throws Exception { |
545 |
Throwable t = threadFailure.getAndSet(null); |
546 |
if (t != null) { |
547 |
if (t instanceof Error) |
548 |
throw (Error) t; |
549 |
else if (t instanceof RuntimeException) |
550 |
throw (RuntimeException) t; |
551 |
else if (t instanceof Exception) |
552 |
throw (Exception) t; |
553 |
else { |
554 |
AssertionFailedError afe = |
555 |
new AssertionFailedError(t.toString()); |
556 |
afe.initCause(t); |
557 |
throw afe; |
558 |
} |
559 |
} |
560 |
|
561 |
if (Thread.interrupted()) |
562 |
tearDownFail("interrupt status set in main thread"); |
563 |
|
564 |
checkForkJoinPoolThreadLeaks(); |
565 |
} |
566 |
|
567 |
/** |
568 |
* Finds missing try { ... } finally { joinPool(e); } |
569 |
*/ |
570 |
void checkForkJoinPoolThreadLeaks() throws InterruptedException { |
571 |
Thread[] survivors = new Thread[7]; |
572 |
int count = Thread.enumerate(survivors); |
573 |
for (int i = 0; i < count; i++) { |
574 |
Thread thread = survivors[i]; |
575 |
String name = thread.getName(); |
576 |
if (name.startsWith("ForkJoinPool-")) { |
577 |
// give thread some time to terminate |
578 |
thread.join(LONG_DELAY_MS); |
579 |
if (thread.isAlive()) |
580 |
tearDownFail("Found leaked ForkJoinPool thread thread=%s", |
581 |
thread); |
582 |
} |
583 |
} |
584 |
|
585 |
if (!ForkJoinPool.commonPool() |
586 |
.awaitQuiescence(LONG_DELAY_MS, MILLISECONDS)) |
587 |
tearDownFail("ForkJoin common pool thread stuck"); |
588 |
} |
589 |
|
590 |
/** |
591 |
* Just like fail(reason), but additionally recording (using |
592 |
* threadRecordFailure) any AssertionFailedError thrown, so that |
593 |
* the current testcase will fail. |
594 |
*/ |
595 |
public void threadFail(String reason) { |
596 |
try { |
597 |
fail(reason); |
598 |
} catch (AssertionFailedError t) { |
599 |
threadRecordFailure(t); |
600 |
fail(reason); |
601 |
} |
602 |
} |
603 |
|
604 |
/** |
605 |
* Just like assertTrue(b), but additionally recording (using |
606 |
* threadRecordFailure) any AssertionFailedError thrown, so that |
607 |
* the current testcase will fail. |
608 |
*/ |
609 |
public void threadAssertTrue(boolean b) { |
610 |
try { |
611 |
assertTrue(b); |
612 |
} catch (AssertionFailedError t) { |
613 |
threadRecordFailure(t); |
614 |
throw t; |
615 |
} |
616 |
} |
617 |
|
618 |
/** |
619 |
* Just like assertFalse(b), but additionally recording (using |
620 |
* threadRecordFailure) any AssertionFailedError thrown, so that |
621 |
* the current testcase will fail. |
622 |
*/ |
623 |
public void threadAssertFalse(boolean b) { |
624 |
try { |
625 |
assertFalse(b); |
626 |
} catch (AssertionFailedError t) { |
627 |
threadRecordFailure(t); |
628 |
throw t; |
629 |
} |
630 |
} |
631 |
|
632 |
/** |
633 |
* Just like assertNull(x), but additionally recording (using |
634 |
* threadRecordFailure) any AssertionFailedError thrown, so that |
635 |
* the current testcase will fail. |
636 |
*/ |
637 |
public void threadAssertNull(Object x) { |
638 |
try { |
639 |
assertNull(x); |
640 |
} catch (AssertionFailedError t) { |
641 |
threadRecordFailure(t); |
642 |
throw t; |
643 |
} |
644 |
} |
645 |
|
646 |
/** |
647 |
* Just like assertEquals(x, y), but additionally recording (using |
648 |
* threadRecordFailure) any AssertionFailedError thrown, so that |
649 |
* the current testcase will fail. |
650 |
*/ |
651 |
public void threadAssertEquals(long x, long y) { |
652 |
try { |
653 |
assertEquals(x, y); |
654 |
} catch (AssertionFailedError t) { |
655 |
threadRecordFailure(t); |
656 |
throw t; |
657 |
} |
658 |
} |
659 |
|
660 |
/** |
661 |
* Just like assertEquals(x, y), but additionally recording (using |
662 |
* threadRecordFailure) any AssertionFailedError thrown, so that |
663 |
* the current testcase will fail. |
664 |
*/ |
665 |
public void threadAssertEquals(Object x, Object y) { |
666 |
try { |
667 |
assertEquals(x, y); |
668 |
} catch (AssertionFailedError fail) { |
669 |
threadRecordFailure(fail); |
670 |
throw fail; |
671 |
} catch (Throwable fail) { |
672 |
threadUnexpectedException(fail); |
673 |
} |
674 |
} |
675 |
|
676 |
/** |
677 |
* Just like assertSame(x, y), but additionally recording (using |
678 |
* threadRecordFailure) any AssertionFailedError thrown, so that |
679 |
* the current testcase will fail. |
680 |
*/ |
681 |
public void threadAssertSame(Object x, Object y) { |
682 |
try { |
683 |
assertSame(x, y); |
684 |
} catch (AssertionFailedError fail) { |
685 |
threadRecordFailure(fail); |
686 |
throw fail; |
687 |
} |
688 |
} |
689 |
|
690 |
/** |
691 |
* Calls threadFail with message "should throw exception". |
692 |
*/ |
693 |
public void threadShouldThrow() { |
694 |
threadFail("should throw exception"); |
695 |
} |
696 |
|
697 |
/** |
698 |
* Calls threadFail with message "should throw" + exceptionName. |
699 |
*/ |
700 |
public void threadShouldThrow(String exceptionName) { |
701 |
threadFail("should throw " + exceptionName); |
702 |
} |
703 |
|
704 |
/** |
705 |
* Records the given exception using {@link #threadRecordFailure}, |
706 |
* then rethrows the exception, wrapping it in an |
707 |
* AssertionFailedError if necessary. |
708 |
*/ |
709 |
public void threadUnexpectedException(Throwable t) { |
710 |
threadRecordFailure(t); |
711 |
t.printStackTrace(); |
712 |
if (t instanceof RuntimeException) |
713 |
throw (RuntimeException) t; |
714 |
else if (t instanceof Error) |
715 |
throw (Error) t; |
716 |
else { |
717 |
AssertionFailedError afe = |
718 |
new AssertionFailedError("unexpected exception: " + t); |
719 |
afe.initCause(t); |
720 |
throw afe; |
721 |
} |
722 |
} |
723 |
|
724 |
/** |
725 |
* Delays, via Thread.sleep, for the given millisecond delay, but |
726 |
* if the sleep is shorter than specified, may re-sleep or yield |
727 |
* until time elapses. |
728 |
*/ |
729 |
static void delay(long millis) throws InterruptedException { |
730 |
long startTime = System.nanoTime(); |
731 |
long ns = millis * 1000 * 1000; |
732 |
for (;;) { |
733 |
if (millis > 0L) |
734 |
Thread.sleep(millis); |
735 |
else // too short to sleep |
736 |
Thread.yield(); |
737 |
long d = ns - (System.nanoTime() - startTime); |
738 |
if (d > 0L) |
739 |
millis = d / (1000 * 1000); |
740 |
else |
741 |
break; |
742 |
} |
743 |
} |
744 |
|
745 |
/** |
746 |
* Waits out termination of a thread pool or fails doing so. |
747 |
*/ |
748 |
void joinPool(ExecutorService pool) { |
749 |
try { |
750 |
pool.shutdown(); |
751 |
if (!pool.awaitTermination(2 * LONG_DELAY_MS, MILLISECONDS)) |
752 |
fail("ExecutorService " + pool + |
753 |
" did not terminate in a timely manner"); |
754 |
} catch (SecurityException ok) { |
755 |
// Allowed in case test doesn't have privs |
756 |
} catch (InterruptedException fail) { |
757 |
fail("Unexpected InterruptedException"); |
758 |
} |
759 |
} |
760 |
|
761 |
/** Like Runnable, but with the freedom to throw anything */ |
762 |
interface Action { public void run() throws Throwable; } |
763 |
|
764 |
/** |
765 |
* Runs all the given actions in parallel, failing if any fail. |
766 |
* Useful for running multiple variants of tests that are |
767 |
* necessarily individually slow because they must block. |
768 |
*/ |
769 |
void testInParallel(Action ... actions) { |
770 |
ExecutorService pool = Executors.newCachedThreadPool(); |
771 |
try { |
772 |
ArrayList<Future<?>> futures = new ArrayList<>(actions.length); |
773 |
for (final Action action : actions) |
774 |
futures.add(pool.submit(new CheckedRunnable() { |
775 |
public void realRun() throws Throwable { action.run();}})); |
776 |
for (Future<?> future : futures) |
777 |
try { |
778 |
assertNull(future.get(LONG_DELAY_MS, MILLISECONDS)); |
779 |
} catch (ExecutionException ex) { |
780 |
threadUnexpectedException(ex.getCause()); |
781 |
} catch (Exception ex) { |
782 |
threadUnexpectedException(ex); |
783 |
} |
784 |
} finally { |
785 |
joinPool(pool); |
786 |
} |
787 |
} |
788 |
|
789 |
/** |
790 |
* A debugging tool to print all stack traces, as jstack does. |
791 |
*/ |
792 |
static void printAllStackTraces() { |
793 |
for (ThreadInfo info : |
794 |
ManagementFactory.getThreadMXBean() |
795 |
.dumpAllThreads(true, true)) |
796 |
System.err.print(info); |
797 |
} |
798 |
|
799 |
/** |
800 |
* Checks that thread does not terminate within the default |
801 |
* millisecond delay of {@code timeoutMillis()}. |
802 |
*/ |
803 |
void assertThreadStaysAlive(Thread thread) { |
804 |
assertThreadStaysAlive(thread, timeoutMillis()); |
805 |
} |
806 |
|
807 |
/** |
808 |
* Checks that thread does not terminate within the given millisecond delay. |
809 |
*/ |
810 |
void assertThreadStaysAlive(Thread thread, long millis) { |
811 |
try { |
812 |
// No need to optimize the failing case via Thread.join. |
813 |
delay(millis); |
814 |
assertTrue(thread.isAlive()); |
815 |
} catch (InterruptedException fail) { |
816 |
fail("Unexpected InterruptedException"); |
817 |
} |
818 |
} |
819 |
|
820 |
/** |
821 |
* Checks that the threads do not terminate within the default |
822 |
* millisecond delay of {@code timeoutMillis()}. |
823 |
*/ |
824 |
void assertThreadsStayAlive(Thread... threads) { |
825 |
assertThreadsStayAlive(timeoutMillis(), threads); |
826 |
} |
827 |
|
828 |
/** |
829 |
* Checks that the threads do not terminate within the given millisecond delay. |
830 |
*/ |
831 |
void assertThreadsStayAlive(long millis, Thread... threads) { |
832 |
try { |
833 |
// No need to optimize the failing case via Thread.join. |
834 |
delay(millis); |
835 |
for (Thread thread : threads) |
836 |
assertTrue(thread.isAlive()); |
837 |
} catch (InterruptedException fail) { |
838 |
fail("Unexpected InterruptedException"); |
839 |
} |
840 |
} |
841 |
|
842 |
/** |
843 |
* Checks that future.get times out, with the default timeout of |
844 |
* {@code timeoutMillis()}. |
845 |
*/ |
846 |
void assertFutureTimesOut(Future future) { |
847 |
assertFutureTimesOut(future, timeoutMillis()); |
848 |
} |
849 |
|
850 |
/** |
851 |
* Checks that future.get times out, with the given millisecond timeout. |
852 |
*/ |
853 |
void assertFutureTimesOut(Future future, long timeoutMillis) { |
854 |
long startTime = System.nanoTime(); |
855 |
try { |
856 |
future.get(timeoutMillis, MILLISECONDS); |
857 |
shouldThrow(); |
858 |
} catch (TimeoutException success) { |
859 |
} catch (Exception fail) { |
860 |
threadUnexpectedException(fail); |
861 |
} finally { future.cancel(true); } |
862 |
assertTrue(millisElapsedSince(startTime) >= timeoutMillis); |
863 |
} |
864 |
|
865 |
/** |
866 |
* Fails with message "should throw exception". |
867 |
*/ |
868 |
public void shouldThrow() { |
869 |
fail("Should throw exception"); |
870 |
} |
871 |
|
872 |
/** |
873 |
* Fails with message "should throw " + exceptionName. |
874 |
*/ |
875 |
public void shouldThrow(String exceptionName) { |
876 |
fail("Should throw " + exceptionName); |
877 |
} |
878 |
|
879 |
/** |
880 |
* The number of elements to place in collections, arrays, etc. |
881 |
*/ |
882 |
public static final int SIZE = 20; |
883 |
|
884 |
// Some convenient Integer constants |
885 |
|
886 |
public static final Integer zero = new Integer(0); |
887 |
public static final Integer one = new Integer(1); |
888 |
public static final Integer two = new Integer(2); |
889 |
public static final Integer three = new Integer(3); |
890 |
public static final Integer four = new Integer(4); |
891 |
public static final Integer five = new Integer(5); |
892 |
public static final Integer six = new Integer(6); |
893 |
public static final Integer seven = new Integer(7); |
894 |
public static final Integer eight = new Integer(8); |
895 |
public static final Integer nine = new Integer(9); |
896 |
public static final Integer m1 = new Integer(-1); |
897 |
public static final Integer m2 = new Integer(-2); |
898 |
public static final Integer m3 = new Integer(-3); |
899 |
public static final Integer m4 = new Integer(-4); |
900 |
public static final Integer m5 = new Integer(-5); |
901 |
public static final Integer m6 = new Integer(-6); |
902 |
public static final Integer m10 = new Integer(-10); |
903 |
|
904 |
/** |
905 |
* Runs Runnable r with a security policy that permits precisely |
906 |
* the specified permissions. If there is no current security |
907 |
* manager, the runnable is run twice, both with and without a |
908 |
* security manager. We require that any security manager permit |
909 |
* getPolicy/setPolicy. |
910 |
*/ |
911 |
public void runWithPermissions(Runnable r, Permission... permissions) { |
912 |
SecurityManager sm = System.getSecurityManager(); |
913 |
if (sm == null) { |
914 |
r.run(); |
915 |
} |
916 |
runWithSecurityManagerWithPermissions(r, permissions); |
917 |
} |
918 |
|
919 |
/** |
920 |
* Runs Runnable r with a security policy that permits precisely |
921 |
* the specified permissions. If there is no current security |
922 |
* manager, a temporary one is set for the duration of the |
923 |
* Runnable. We require that any security manager permit |
924 |
* getPolicy/setPolicy. |
925 |
*/ |
926 |
public void runWithSecurityManagerWithPermissions(Runnable r, |
927 |
Permission... permissions) { |
928 |
SecurityManager sm = System.getSecurityManager(); |
929 |
if (sm == null) { |
930 |
Policy savedPolicy = Policy.getPolicy(); |
931 |
try { |
932 |
Policy.setPolicy(permissivePolicy()); |
933 |
System.setSecurityManager(new SecurityManager()); |
934 |
runWithSecurityManagerWithPermissions(r, permissions); |
935 |
} finally { |
936 |
System.setSecurityManager(null); |
937 |
Policy.setPolicy(savedPolicy); |
938 |
} |
939 |
} else { |
940 |
Policy savedPolicy = Policy.getPolicy(); |
941 |
AdjustablePolicy policy = new AdjustablePolicy(permissions); |
942 |
Policy.setPolicy(policy); |
943 |
|
944 |
try { |
945 |
r.run(); |
946 |
} finally { |
947 |
policy.addPermission(new SecurityPermission("setPolicy")); |
948 |
Policy.setPolicy(savedPolicy); |
949 |
} |
950 |
} |
951 |
} |
952 |
|
953 |
/** |
954 |
* Runs a runnable without any permissions. |
955 |
*/ |
956 |
public void runWithoutPermissions(Runnable r) { |
957 |
runWithPermissions(r); |
958 |
} |
959 |
|
960 |
/** |
961 |
* A security policy where new permissions can be dynamically added |
962 |
* or all cleared. |
963 |
*/ |
964 |
public static class AdjustablePolicy extends java.security.Policy { |
965 |
Permissions perms = new Permissions(); |
966 |
AdjustablePolicy(Permission... permissions) { |
967 |
for (Permission permission : permissions) |
968 |
perms.add(permission); |
969 |
} |
970 |
void addPermission(Permission perm) { perms.add(perm); } |
971 |
void clearPermissions() { perms = new Permissions(); } |
972 |
public PermissionCollection getPermissions(CodeSource cs) { |
973 |
return perms; |
974 |
} |
975 |
public PermissionCollection getPermissions(ProtectionDomain pd) { |
976 |
return perms; |
977 |
} |
978 |
public boolean implies(ProtectionDomain pd, Permission p) { |
979 |
return perms.implies(p); |
980 |
} |
981 |
public void refresh() {} |
982 |
public String toString() { |
983 |
List<Permission> ps = new ArrayList<Permission>(); |
984 |
for (Enumeration<Permission> e = perms.elements(); e.hasMoreElements();) |
985 |
ps.add(e.nextElement()); |
986 |
return "AdjustablePolicy with permissions " + ps; |
987 |
} |
988 |
} |
989 |
|
990 |
/** |
991 |
* Returns a policy containing all the permissions we ever need. |
992 |
*/ |
993 |
public static Policy permissivePolicy() { |
994 |
return new AdjustablePolicy |
995 |
// Permissions j.u.c. needs directly |
996 |
(new RuntimePermission("modifyThread"), |
997 |
new RuntimePermission("getClassLoader"), |
998 |
new RuntimePermission("setContextClassLoader"), |
999 |
// Permissions needed to change permissions! |
1000 |
new SecurityPermission("getPolicy"), |
1001 |
new SecurityPermission("setPolicy"), |
1002 |
new RuntimePermission("setSecurityManager"), |
1003 |
// Permissions needed by the junit test harness |
1004 |
new RuntimePermission("accessDeclaredMembers"), |
1005 |
new PropertyPermission("*", "read"), |
1006 |
new java.io.FilePermission("<<ALL FILES>>", "read")); |
1007 |
} |
1008 |
|
1009 |
/** |
1010 |
* Sleeps until the given time has elapsed. |
1011 |
* Throws AssertionFailedError if interrupted. |
1012 |
*/ |
1013 |
void sleep(long millis) { |
1014 |
try { |
1015 |
delay(millis); |
1016 |
} catch (InterruptedException fail) { |
1017 |
AssertionFailedError afe = |
1018 |
new AssertionFailedError("Unexpected InterruptedException"); |
1019 |
afe.initCause(fail); |
1020 |
throw afe; |
1021 |
} |
1022 |
} |
1023 |
|
1024 |
/** |
1025 |
* Spin-waits up to the specified number of milliseconds for the given |
1026 |
* thread to enter a wait state: BLOCKED, WAITING, or TIMED_WAITING. |
1027 |
*/ |
1028 |
void waitForThreadToEnterWaitState(Thread thread, long timeoutMillis) { |
1029 |
long startTime = System.nanoTime(); |
1030 |
for (;;) { |
1031 |
Thread.State s = thread.getState(); |
1032 |
if (s == Thread.State.BLOCKED || |
1033 |
s == Thread.State.WAITING || |
1034 |
s == Thread.State.TIMED_WAITING) |
1035 |
return; |
1036 |
else if (s == Thread.State.TERMINATED) |
1037 |
fail("Unexpected thread termination"); |
1038 |
else if (millisElapsedSince(startTime) > timeoutMillis) { |
1039 |
threadAssertTrue(thread.isAlive()); |
1040 |
return; |
1041 |
} |
1042 |
Thread.yield(); |
1043 |
} |
1044 |
} |
1045 |
|
1046 |
/** |
1047 |
* Waits up to LONG_DELAY_MS for the given thread to enter a wait |
1048 |
* state: BLOCKED, WAITING, or TIMED_WAITING. |
1049 |
*/ |
1050 |
void waitForThreadToEnterWaitState(Thread thread) { |
1051 |
waitForThreadToEnterWaitState(thread, LONG_DELAY_MS); |
1052 |
} |
1053 |
|
1054 |
/** |
1055 |
* Returns the number of milliseconds since time given by |
1056 |
* startNanoTime, which must have been previously returned from a |
1057 |
* call to {@link System#nanoTime()}. |
1058 |
*/ |
1059 |
static long millisElapsedSince(long startNanoTime) { |
1060 |
return NANOSECONDS.toMillis(System.nanoTime() - startNanoTime); |
1061 |
} |
1062 |
|
1063 |
// void assertTerminatesPromptly(long timeoutMillis, Runnable r) { |
1064 |
// long startTime = System.nanoTime(); |
1065 |
// try { |
1066 |
// r.run(); |
1067 |
// } catch (Throwable fail) { threadUnexpectedException(fail); } |
1068 |
// if (millisElapsedSince(startTime) > timeoutMillis/2) |
1069 |
// throw new AssertionFailedError("did not return promptly"); |
1070 |
// } |
1071 |
|
1072 |
// void assertTerminatesPromptly(Runnable r) { |
1073 |
// assertTerminatesPromptly(LONG_DELAY_MS/2, r); |
1074 |
// } |
1075 |
|
1076 |
/** |
1077 |
* Checks that timed f.get() returns the expected value, and does not |
1078 |
* wait for the timeout to elapse before returning. |
1079 |
*/ |
1080 |
<T> void checkTimedGet(Future<T> f, T expectedValue, long timeoutMillis) { |
1081 |
long startTime = System.nanoTime(); |
1082 |
try { |
1083 |
assertEquals(expectedValue, f.get(timeoutMillis, MILLISECONDS)); |
1084 |
} catch (Throwable fail) { threadUnexpectedException(fail); } |
1085 |
if (millisElapsedSince(startTime) > timeoutMillis/2) |
1086 |
throw new AssertionFailedError("timed get did not return promptly"); |
1087 |
} |
1088 |
|
1089 |
<T> void checkTimedGet(Future<T> f, T expectedValue) { |
1090 |
checkTimedGet(f, expectedValue, LONG_DELAY_MS); |
1091 |
} |
1092 |
|
1093 |
/** |
1094 |
* Returns a new started daemon Thread running the given runnable. |
1095 |
*/ |
1096 |
Thread newStartedThread(Runnable runnable) { |
1097 |
Thread t = new Thread(runnable); |
1098 |
t.setDaemon(true); |
1099 |
t.start(); |
1100 |
return t; |
1101 |
} |
1102 |
|
1103 |
/** |
1104 |
* Waits for the specified time (in milliseconds) for the thread |
1105 |
* to terminate (using {@link Thread#join(long)}), else interrupts |
1106 |
* the thread (in the hope that it may terminate later) and fails. |
1107 |
*/ |
1108 |
void awaitTermination(Thread t, long timeoutMillis) { |
1109 |
try { |
1110 |
t.join(timeoutMillis); |
1111 |
} catch (InterruptedException fail) { |
1112 |
threadUnexpectedException(fail); |
1113 |
} finally { |
1114 |
if (t.getState() != Thread.State.TERMINATED) { |
1115 |
t.interrupt(); |
1116 |
fail("Test timed out"); |
1117 |
} |
1118 |
} |
1119 |
} |
1120 |
|
1121 |
/** |
1122 |
* Waits for LONG_DELAY_MS milliseconds for the thread to |
1123 |
* terminate (using {@link Thread#join(long)}), else interrupts |
1124 |
* the thread (in the hope that it may terminate later) and fails. |
1125 |
*/ |
1126 |
void awaitTermination(Thread t) { |
1127 |
awaitTermination(t, LONG_DELAY_MS); |
1128 |
} |
1129 |
|
1130 |
// Some convenient Runnable classes |
1131 |
|
1132 |
public abstract class CheckedRunnable implements Runnable { |
1133 |
protected abstract void realRun() throws Throwable; |
1134 |
|
1135 |
public final void run() { |
1136 |
try { |
1137 |
realRun(); |
1138 |
} catch (Throwable fail) { |
1139 |
threadUnexpectedException(fail); |
1140 |
} |
1141 |
} |
1142 |
} |
1143 |
|
1144 |
public abstract class RunnableShouldThrow implements Runnable { |
1145 |
protected abstract void realRun() throws Throwable; |
1146 |
|
1147 |
final Class<?> exceptionClass; |
1148 |
|
1149 |
<T extends Throwable> RunnableShouldThrow(Class<T> exceptionClass) { |
1150 |
this.exceptionClass = exceptionClass; |
1151 |
} |
1152 |
|
1153 |
public final void run() { |
1154 |
try { |
1155 |
realRun(); |
1156 |
threadShouldThrow(exceptionClass.getSimpleName()); |
1157 |
} catch (Throwable t) { |
1158 |
if (! exceptionClass.isInstance(t)) |
1159 |
threadUnexpectedException(t); |
1160 |
} |
1161 |
} |
1162 |
} |
1163 |
|
1164 |
public abstract class ThreadShouldThrow extends Thread { |
1165 |
protected abstract void realRun() throws Throwable; |
1166 |
|
1167 |
final Class<?> exceptionClass; |
1168 |
|
1169 |
<T extends Throwable> ThreadShouldThrow(Class<T> exceptionClass) { |
1170 |
this.exceptionClass = exceptionClass; |
1171 |
} |
1172 |
|
1173 |
public final void run() { |
1174 |
try { |
1175 |
realRun(); |
1176 |
threadShouldThrow(exceptionClass.getSimpleName()); |
1177 |
} catch (Throwable t) { |
1178 |
if (! exceptionClass.isInstance(t)) |
1179 |
threadUnexpectedException(t); |
1180 |
} |
1181 |
} |
1182 |
} |
1183 |
|
1184 |
public abstract class CheckedInterruptedRunnable implements Runnable { |
1185 |
protected abstract void realRun() throws Throwable; |
1186 |
|
1187 |
public final void run() { |
1188 |
try { |
1189 |
realRun(); |
1190 |
threadShouldThrow("InterruptedException"); |
1191 |
} catch (InterruptedException success) { |
1192 |
threadAssertFalse(Thread.interrupted()); |
1193 |
} catch (Throwable fail) { |
1194 |
threadUnexpectedException(fail); |
1195 |
} |
1196 |
} |
1197 |
} |
1198 |
|
1199 |
public abstract class CheckedCallable<T> implements Callable<T> { |
1200 |
protected abstract T realCall() throws Throwable; |
1201 |
|
1202 |
public final T call() { |
1203 |
try { |
1204 |
return realCall(); |
1205 |
} catch (Throwable fail) { |
1206 |
threadUnexpectedException(fail); |
1207 |
return null; |
1208 |
} |
1209 |
} |
1210 |
} |
1211 |
|
1212 |
public abstract class CheckedInterruptedCallable<T> |
1213 |
implements Callable<T> { |
1214 |
protected abstract T realCall() throws Throwable; |
1215 |
|
1216 |
public final T call() { |
1217 |
try { |
1218 |
T result = realCall(); |
1219 |
threadShouldThrow("InterruptedException"); |
1220 |
return result; |
1221 |
} catch (InterruptedException success) { |
1222 |
threadAssertFalse(Thread.interrupted()); |
1223 |
} catch (Throwable fail) { |
1224 |
threadUnexpectedException(fail); |
1225 |
} |
1226 |
return null; |
1227 |
} |
1228 |
} |
1229 |
|
1230 |
public static class NoOpRunnable implements Runnable { |
1231 |
public void run() {} |
1232 |
} |
1233 |
|
1234 |
public static class NoOpCallable implements Callable { |
1235 |
public Object call() { return Boolean.TRUE; } |
1236 |
} |
1237 |
|
1238 |
public static final String TEST_STRING = "a test string"; |
1239 |
|
1240 |
public static class StringTask implements Callable<String> { |
1241 |
final String value; |
1242 |
public StringTask() { this(TEST_STRING); } |
1243 |
public StringTask(String value) { this.value = value; } |
1244 |
public String call() { return value; } |
1245 |
} |
1246 |
|
1247 |
public Callable<String> latchAwaitingStringTask(final CountDownLatch latch) { |
1248 |
return new CheckedCallable<String>() { |
1249 |
protected String realCall() { |
1250 |
try { |
1251 |
latch.await(); |
1252 |
} catch (InterruptedException quittingTime) {} |
1253 |
return TEST_STRING; |
1254 |
}}; |
1255 |
} |
1256 |
|
1257 |
public Runnable countDowner(final CountDownLatch latch) { |
1258 |
return new CheckedRunnable() { |
1259 |
public void realRun() throws InterruptedException { |
1260 |
latch.countDown(); |
1261 |
}}; |
1262 |
} |
1263 |
|
1264 |
public Runnable awaiter(final CountDownLatch latch) { |
1265 |
return new CheckedRunnable() { |
1266 |
public void realRun() throws InterruptedException { |
1267 |
await(latch); |
1268 |
}}; |
1269 |
} |
1270 |
|
1271 |
public void await(CountDownLatch latch) { |
1272 |
try { |
1273 |
assertTrue(latch.await(LONG_DELAY_MS, MILLISECONDS)); |
1274 |
} catch (Throwable fail) { |
1275 |
threadUnexpectedException(fail); |
1276 |
} |
1277 |
} |
1278 |
|
1279 |
public void await(Semaphore semaphore) { |
1280 |
try { |
1281 |
assertTrue(semaphore.tryAcquire(LONG_DELAY_MS, MILLISECONDS)); |
1282 |
} catch (Throwable fail) { |
1283 |
threadUnexpectedException(fail); |
1284 |
} |
1285 |
} |
1286 |
|
1287 |
// /** |
1288 |
// * Spin-waits up to LONG_DELAY_MS until flag becomes true. |
1289 |
// */ |
1290 |
// public void await(AtomicBoolean flag) { |
1291 |
// await(flag, LONG_DELAY_MS); |
1292 |
// } |
1293 |
|
1294 |
// /** |
1295 |
// * Spin-waits up to the specified timeout until flag becomes true. |
1296 |
// */ |
1297 |
// public void await(AtomicBoolean flag, long timeoutMillis) { |
1298 |
// long startTime = System.nanoTime(); |
1299 |
// while (!flag.get()) { |
1300 |
// if (millisElapsedSince(startTime) > timeoutMillis) |
1301 |
// throw new AssertionFailedError("timed out"); |
1302 |
// Thread.yield(); |
1303 |
// } |
1304 |
// } |
1305 |
|
1306 |
public static class NPETask implements Callable<String> { |
1307 |
public String call() { throw new NullPointerException(); } |
1308 |
} |
1309 |
|
1310 |
public static class CallableOne implements Callable<Integer> { |
1311 |
public Integer call() { return one; } |
1312 |
} |
1313 |
|
1314 |
public class ShortRunnable extends CheckedRunnable { |
1315 |
protected void realRun() throws Throwable { |
1316 |
delay(SHORT_DELAY_MS); |
1317 |
} |
1318 |
} |
1319 |
|
1320 |
public class ShortInterruptedRunnable extends CheckedInterruptedRunnable { |
1321 |
protected void realRun() throws InterruptedException { |
1322 |
delay(SHORT_DELAY_MS); |
1323 |
} |
1324 |
} |
1325 |
|
1326 |
public class SmallRunnable extends CheckedRunnable { |
1327 |
protected void realRun() throws Throwable { |
1328 |
delay(SMALL_DELAY_MS); |
1329 |
} |
1330 |
} |
1331 |
|
1332 |
public class SmallPossiblyInterruptedRunnable extends CheckedRunnable { |
1333 |
protected void realRun() { |
1334 |
try { |
1335 |
delay(SMALL_DELAY_MS); |
1336 |
} catch (InterruptedException ok) {} |
1337 |
} |
1338 |
} |
1339 |
|
1340 |
public class SmallCallable extends CheckedCallable { |
1341 |
protected Object realCall() throws InterruptedException { |
1342 |
delay(SMALL_DELAY_MS); |
1343 |
return Boolean.TRUE; |
1344 |
} |
1345 |
} |
1346 |
|
1347 |
public class MediumRunnable extends CheckedRunnable { |
1348 |
protected void realRun() throws Throwable { |
1349 |
delay(MEDIUM_DELAY_MS); |
1350 |
} |
1351 |
} |
1352 |
|
1353 |
public class MediumInterruptedRunnable extends CheckedInterruptedRunnable { |
1354 |
protected void realRun() throws InterruptedException { |
1355 |
delay(MEDIUM_DELAY_MS); |
1356 |
} |
1357 |
} |
1358 |
|
1359 |
public Runnable possiblyInterruptedRunnable(final long timeoutMillis) { |
1360 |
return new CheckedRunnable() { |
1361 |
protected void realRun() { |
1362 |
try { |
1363 |
delay(timeoutMillis); |
1364 |
} catch (InterruptedException ok) {} |
1365 |
}}; |
1366 |
} |
1367 |
|
1368 |
public class MediumPossiblyInterruptedRunnable extends CheckedRunnable { |
1369 |
protected void realRun() { |
1370 |
try { |
1371 |
delay(MEDIUM_DELAY_MS); |
1372 |
} catch (InterruptedException ok) {} |
1373 |
} |
1374 |
} |
1375 |
|
1376 |
public class LongPossiblyInterruptedRunnable extends CheckedRunnable { |
1377 |
protected void realRun() { |
1378 |
try { |
1379 |
delay(LONG_DELAY_MS); |
1380 |
} catch (InterruptedException ok) {} |
1381 |
} |
1382 |
} |
1383 |
|
1384 |
/** |
1385 |
* For use as ThreadFactory in constructors |
1386 |
*/ |
1387 |
public static class SimpleThreadFactory implements ThreadFactory { |
1388 |
public Thread newThread(Runnable r) { |
1389 |
return new Thread(r); |
1390 |
} |
1391 |
} |
1392 |
|
1393 |
public interface TrackedRunnable extends Runnable { |
1394 |
boolean isDone(); |
1395 |
} |
1396 |
|
1397 |
public static TrackedRunnable trackedRunnable(final long timeoutMillis) { |
1398 |
return new TrackedRunnable() { |
1399 |
private volatile boolean done = false; |
1400 |
public boolean isDone() { return done; } |
1401 |
public void run() { |
1402 |
try { |
1403 |
delay(timeoutMillis); |
1404 |
done = true; |
1405 |
} catch (InterruptedException ok) {} |
1406 |
} |
1407 |
}; |
1408 |
} |
1409 |
|
1410 |
public static class TrackedShortRunnable implements Runnable { |
1411 |
public volatile boolean done = false; |
1412 |
public void run() { |
1413 |
try { |
1414 |
delay(SHORT_DELAY_MS); |
1415 |
done = true; |
1416 |
} catch (InterruptedException ok) {} |
1417 |
} |
1418 |
} |
1419 |
|
1420 |
public static class TrackedSmallRunnable implements Runnable { |
1421 |
public volatile boolean done = false; |
1422 |
public void run() { |
1423 |
try { |
1424 |
delay(SMALL_DELAY_MS); |
1425 |
done = true; |
1426 |
} catch (InterruptedException ok) {} |
1427 |
} |
1428 |
} |
1429 |
|
1430 |
public static class TrackedMediumRunnable implements Runnable { |
1431 |
public volatile boolean done = false; |
1432 |
public void run() { |
1433 |
try { |
1434 |
delay(MEDIUM_DELAY_MS); |
1435 |
done = true; |
1436 |
} catch (InterruptedException ok) {} |
1437 |
} |
1438 |
} |
1439 |
|
1440 |
public static class TrackedLongRunnable implements Runnable { |
1441 |
public volatile boolean done = false; |
1442 |
public void run() { |
1443 |
try { |
1444 |
delay(LONG_DELAY_MS); |
1445 |
done = true; |
1446 |
} catch (InterruptedException ok) {} |
1447 |
} |
1448 |
} |
1449 |
|
1450 |
public static class TrackedNoOpRunnable implements Runnable { |
1451 |
public volatile boolean done = false; |
1452 |
public void run() { |
1453 |
done = true; |
1454 |
} |
1455 |
} |
1456 |
|
1457 |
public static class TrackedCallable implements Callable { |
1458 |
public volatile boolean done = false; |
1459 |
public Object call() { |
1460 |
try { |
1461 |
delay(SMALL_DELAY_MS); |
1462 |
done = true; |
1463 |
} catch (InterruptedException ok) {} |
1464 |
return Boolean.TRUE; |
1465 |
} |
1466 |
} |
1467 |
|
1468 |
/** |
1469 |
* Analog of CheckedRunnable for RecursiveAction |
1470 |
*/ |
1471 |
public abstract class CheckedRecursiveAction extends RecursiveAction { |
1472 |
protected abstract void realCompute() throws Throwable; |
1473 |
|
1474 |
@Override protected final void compute() { |
1475 |
try { |
1476 |
realCompute(); |
1477 |
} catch (Throwable fail) { |
1478 |
threadUnexpectedException(fail); |
1479 |
} |
1480 |
} |
1481 |
} |
1482 |
|
1483 |
/** |
1484 |
* Analog of CheckedCallable for RecursiveTask |
1485 |
*/ |
1486 |
public abstract class CheckedRecursiveTask<T> extends RecursiveTask<T> { |
1487 |
protected abstract T realCompute() throws Throwable; |
1488 |
|
1489 |
@Override protected final T compute() { |
1490 |
try { |
1491 |
return realCompute(); |
1492 |
} catch (Throwable fail) { |
1493 |
threadUnexpectedException(fail); |
1494 |
return null; |
1495 |
} |
1496 |
} |
1497 |
} |
1498 |
|
1499 |
/** |
1500 |
* For use as RejectedExecutionHandler in constructors |
1501 |
*/ |
1502 |
public static class NoOpREHandler implements RejectedExecutionHandler { |
1503 |
public void rejectedExecution(Runnable r, |
1504 |
ThreadPoolExecutor executor) {} |
1505 |
} |
1506 |
|
1507 |
/** |
1508 |
* A CyclicBarrier that uses timed await and fails with |
1509 |
* AssertionFailedErrors instead of throwing checked exceptions. |
1510 |
*/ |
1511 |
public class CheckedBarrier extends CyclicBarrier { |
1512 |
public CheckedBarrier(int parties) { super(parties); } |
1513 |
|
1514 |
public int await() { |
1515 |
try { |
1516 |
return super.await(2 * LONG_DELAY_MS, MILLISECONDS); |
1517 |
} catch (TimeoutException timedOut) { |
1518 |
throw new AssertionFailedError("timed out"); |
1519 |
} catch (Exception fail) { |
1520 |
AssertionFailedError afe = |
1521 |
new AssertionFailedError("Unexpected exception: " + fail); |
1522 |
afe.initCause(fail); |
1523 |
throw afe; |
1524 |
} |
1525 |
} |
1526 |
} |
1527 |
|
1528 |
void checkEmpty(BlockingQueue q) { |
1529 |
try { |
1530 |
assertTrue(q.isEmpty()); |
1531 |
assertEquals(0, q.size()); |
1532 |
assertNull(q.peek()); |
1533 |
assertNull(q.poll()); |
1534 |
assertNull(q.poll(0, MILLISECONDS)); |
1535 |
assertEquals(q.toString(), "[]"); |
1536 |
assertTrue(Arrays.equals(q.toArray(), new Object[0])); |
1537 |
assertFalse(q.iterator().hasNext()); |
1538 |
try { |
1539 |
q.element(); |
1540 |
shouldThrow(); |
1541 |
} catch (NoSuchElementException success) {} |
1542 |
try { |
1543 |
q.iterator().next(); |
1544 |
shouldThrow(); |
1545 |
} catch (NoSuchElementException success) {} |
1546 |
try { |
1547 |
q.remove(); |
1548 |
shouldThrow(); |
1549 |
} catch (NoSuchElementException success) {} |
1550 |
} catch (InterruptedException fail) { threadUnexpectedException(fail); } |
1551 |
} |
1552 |
|
1553 |
void assertSerialEquals(Object x, Object y) { |
1554 |
assertTrue(Arrays.equals(serialBytes(x), serialBytes(y))); |
1555 |
} |
1556 |
|
1557 |
void assertNotSerialEquals(Object x, Object y) { |
1558 |
assertFalse(Arrays.equals(serialBytes(x), serialBytes(y))); |
1559 |
} |
1560 |
|
1561 |
byte[] serialBytes(Object o) { |
1562 |
try { |
1563 |
ByteArrayOutputStream bos = new ByteArrayOutputStream(); |
1564 |
ObjectOutputStream oos = new ObjectOutputStream(bos); |
1565 |
oos.writeObject(o); |
1566 |
oos.flush(); |
1567 |
oos.close(); |
1568 |
return bos.toByteArray(); |
1569 |
} catch (Throwable fail) { |
1570 |
threadUnexpectedException(fail); |
1571 |
return new byte[0]; |
1572 |
} |
1573 |
} |
1574 |
|
1575 |
@SuppressWarnings("unchecked") |
1576 |
<T> T serialClone(T o) { |
1577 |
try { |
1578 |
ObjectInputStream ois = new ObjectInputStream |
1579 |
(new ByteArrayInputStream(serialBytes(o))); |
1580 |
T clone = (T) ois.readObject(); |
1581 |
assertSame(o.getClass(), clone.getClass()); |
1582 |
return clone; |
1583 |
} catch (Throwable fail) { |
1584 |
threadUnexpectedException(fail); |
1585 |
return null; |
1586 |
} |
1587 |
} |
1588 |
|
1589 |
public void assertThrows(Class<? extends Throwable> expectedExceptionClass, |
1590 |
Runnable... throwingActions) { |
1591 |
for (Runnable throwingAction : throwingActions) { |
1592 |
boolean threw = false; |
1593 |
try { throwingAction.run(); } |
1594 |
catch (Throwable t) { |
1595 |
threw = true; |
1596 |
if (!expectedExceptionClass.isInstance(t)) { |
1597 |
AssertionFailedError afe = |
1598 |
new AssertionFailedError |
1599 |
("Expected " + expectedExceptionClass.getName() + |
1600 |
", got " + t.getClass().getName()); |
1601 |
afe.initCause(t); |
1602 |
threadUnexpectedException(afe); |
1603 |
} |
1604 |
} |
1605 |
if (!threw) |
1606 |
shouldThrow(expectedExceptionClass.getName()); |
1607 |
} |
1608 |
} |
1609 |
|
1610 |
public void assertIteratorExhausted(Iterator<?> it) { |
1611 |
try { |
1612 |
it.next(); |
1613 |
shouldThrow(); |
1614 |
} catch (NoSuchElementException success) {} |
1615 |
assertFalse(it.hasNext()); |
1616 |
} |
1617 |
} |