--- jsr166/src/test/tck/JSR166TestCase.java 2015/04/25 04:55:30 1.131
+++ jsr166/src/test/tck/JSR166TestCase.java 2015/10/08 22:39:57 1.170
@@ -7,6 +7,7 @@
*/
import static java.util.concurrent.TimeUnit.MILLISECONDS;
+import static java.util.concurrent.TimeUnit.MINUTES;
import static java.util.concurrent.TimeUnit.NANOSECONDS;
import java.io.ByteArrayInputStream;
@@ -15,7 +16,10 @@ import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.lang.management.ManagementFactory;
import java.lang.management.ThreadInfo;
+import java.lang.management.ThreadMXBean;
+import java.lang.reflect.Constructor;
import java.lang.reflect.Method;
+import java.lang.reflect.Modifier;
import java.security.CodeSource;
import java.security.Permission;
import java.security.PermissionCollection;
@@ -35,7 +39,10 @@ import java.util.concurrent.BlockingQueu
import java.util.concurrent.Callable;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.CyclicBarrier;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.Executors;
import java.util.concurrent.ExecutorService;
+import java.util.concurrent.ForkJoinPool;
import java.util.concurrent.Future;
import java.util.concurrent.RecursiveAction;
import java.util.concurrent.RecursiveTask;
@@ -63,18 +70,18 @@ import junit.framework.TestSuite;
*
*
*
- * - All assertions in code running in generated threads must use
+ *
- All assertions in code running in generated threads must use
* the forms {@link #threadFail}, {@link #threadAssertTrue}, {@link
* #threadAssertEquals}, or {@link #threadAssertNull}, (not
* {@code fail}, {@code assertTrue}, etc.) It is OK (but not
* particularly recommended) for other code to use these forms too.
* Only the most typically used JUnit assertion methods are defined
- * this way, but enough to live with.
+ * this way, but enough to live with.
*
- * - If you override {@link #setUp} or {@link #tearDown}, make sure
+ *
- If you override {@link #setUp} or {@link #tearDown}, make sure
* to invoke {@code super.setUp} and {@code super.tearDown} within
* them. These methods are used to clear and check for thread
- * assertion failures.
+ * assertion failures.
*
* - All delays and timeouts must use one of the constants {@code
* SHORT_DELAY_MS}, {@code SMALL_DELAY_MS}, {@code MEDIUM_DELAY_MS},
@@ -85,44 +92,44 @@ import junit.framework.TestSuite;
* is always discriminable as larger than SHORT and smaller than
* MEDIUM. And so on. These constants are set to conservative values,
* but even so, if there is ever any doubt, they can all be increased
- * in one spot to rerun tests on slower platforms.
+ * in one spot to rerun tests on slower platforms.
*
- * - All threads generated must be joined inside each test case
+ *
- All threads generated must be joined inside each test case
* method (or {@code fail} to do so) before returning from the
* method. The {@code joinPool} method can be used to do this when
- * using Executors.
+ * using Executors.
*
*
*
* Other notes
*
*
- * - Usually, there is one testcase method per JSR166 method
+ *
- Usually, there is one testcase method per JSR166 method
* covering "normal" operation, and then as many exception-testing
* methods as there are exceptions the method can throw. Sometimes
* there are multiple tests per JSR166 method when the different
* "normal" behaviors differ significantly. And sometimes testcases
* cover multiple methods when they cannot be tested in
- * isolation.
+ * isolation.
*
- * - The documentation style for testcases is to provide as javadoc
+ *
- The documentation style for testcases is to provide as javadoc
* a simple sentence or two describing the property that the testcase
* method purports to test. The javadocs do not say anything about how
- * the property is tested. To find out, read the code.
+ * the property is tested. To find out, read the code.
*
- * - These tests are "conformance tests", and do not attempt to
+ *
- These tests are "conformance tests", and do not attempt to
* test throughput, latency, scalability or other performance factors
* (see the separate "jtreg" tests for a set intended to check these
* for the most central aspects of functionality.) So, most tests use
* the smallest sensible numbers of threads, collection sizes, etc
- * needed to check basic conformance.
+ * needed to check basic conformance.
*
* - The test classes currently do not declare inclusion in
* any particular package to simplify things for people integrating
- * them in TCK test suites.
+ * them in TCK test suites.
*
- * - As a convenience, the {@code main} of this class (JSR166TestCase)
- * runs all JSR166 unit tests.
+ * - As a convenience, the {@code main} of this class (JSR166TestCase)
+ * runs all JSR166 unit tests.
*
*
*/
@@ -166,6 +173,9 @@ public class JSR166TestCase extends Test
private static final int suiteRuns =
Integer.getInteger("jsr166.suiteRuns", 1);
+ public JSR166TestCase() { super(); }
+ public JSR166TestCase(String name) { super(name); }
+
/**
* A filter for tests to run, matching strings of the form
* methodName(className), e.g. "testInvokeAll5(ForkJoinPoolTest)"
@@ -178,27 +188,63 @@ public class JSR166TestCase extends Test
return (regex == null) ? null : Pattern.compile(regex);
}
- protected void runTest() throws Throwable {
+ // Instrumentation to debug very rare, but very annoying hung test runs.
+ static volatile TestCase currentTestCase;
+ static volatile int currentRun = 0;
+ static {
+ Runnable checkForWedgedTest = new Runnable() { public void run() {
+ // avoid spurious reports with enormous runsPerTest
+ final int timeoutMinutes = Math.max(runsPerTest / 10, 1);
+ for (TestCase lastTestCase = currentTestCase;;) {
+ try { MINUTES.sleep(timeoutMinutes); }
+ catch (InterruptedException unexpected) { break; }
+ if (lastTestCase == currentTestCase) {
+ System.err.printf(
+ "Looks like we're stuck running test: %s (%d/%d)%n",
+ lastTestCase, currentRun, runsPerTest);
+ System.err.println
+ ("Looks like we're stuck running test: "
+ + lastTestCase + " (" + currentRun + "/" + runsPerTest + ")");
+ System.err.println("availableProcessors=" +
+ Runtime.getRuntime().availableProcessors());
+ dumpTestThreads();
+ // one stack dump is probably enough; more would be spam
+ break;
+ }
+ lastTestCase = currentTestCase;
+ }}};
+ Thread thread = new Thread(checkForWedgedTest, "checkForWedgedTest");
+ thread.setDaemon(true);
+ thread.start();
+ }
+
+ public void runBare() throws Throwable {
+ currentTestCase = this;
if (methodFilter == null
- || methodFilter.matcher(toString()).find()) {
- for (int i = 0; i < runsPerTest; i++) {
- if (profileTests)
- runTestProfiled();
- else
- super.runTest();
- }
+ || methodFilter.matcher(toString()).find())
+ super.runBare();
+ }
+
+ protected void runTest() throws Throwable {
+ for (int i = 0; i < runsPerTest; i++) {
+ currentRun = i;
+ if (profileTests)
+ runTestProfiled();
+ else
+ super.runTest();
}
}
protected void runTestProfiled() throws Throwable {
- // Warmup run, notably to trigger all needed classloading.
- super.runTest();
- long t0 = System.nanoTime();
- try {
+ for (int i = 0; i < 2; i++) {
+ long startTime = System.nanoTime();
super.runTest();
- } finally {
- long elapsedMillis = millisElapsedSince(t0);
- if (elapsedMillis >= profileThreshold)
+ long elapsedMillis = millisElapsedSince(startTime);
+ if (elapsedMillis < profileThreshold)
+ break;
+ // Never report first run of any test; treat it as a
+ // warmup run, notably to trigger all needed classloading,
+ if (i > 0)
System.out.printf("%n%s: %d%n", toString(), elapsedMillis);
}
}
@@ -212,7 +258,7 @@ public class JSR166TestCase extends Test
/**
* Runs all unit tests in the given test suite.
- * Actual behavior influenced by system properties jsr166.*
+ * Actual behavior influenced by jsr166.* system properties.
*/
static void main(Test suite, String[] args) {
if (useSecurityManager) {
@@ -276,7 +322,15 @@ public class JSR166TestCase extends Test
public static boolean atLeastJava6() { return JAVA_CLASS_VERSION >= 50.0; }
public static boolean atLeastJava7() { return JAVA_CLASS_VERSION >= 51.0; }
public static boolean atLeastJava8() { return JAVA_CLASS_VERSION >= 52.0; }
- public static boolean atLeastJava9() { return JAVA_CLASS_VERSION >= 53.0; }
+ public static boolean atLeastJava9() {
+ return JAVA_CLASS_VERSION >= 53.0
+ // As of 2015-09, java9 still uses 52.0 class file version
+ || JAVA_SPECIFICATION_VERSION.matches("^(1\\.)?(9|[0-9][0-9])$");
+ }
+ public static boolean atLeastJava10() {
+ return JAVA_CLASS_VERSION >= 54.0
+ || JAVA_SPECIFICATION_VERSION.matches("^(1\\.)?[0-9][0-9]$");
+ }
/**
* Collects all JSR166 unit tests as one suite.
@@ -364,6 +418,7 @@ public class JSR166TestCase extends Test
"LongAdderTest",
"SplittableRandomTest",
"StampedLockTest",
+ "SubmissionPublisherTest",
"ThreadLocalRandom8Test",
};
addNamedTestClasses(suite, java8TestClassNames);
@@ -372,7 +427,7 @@ public class JSR166TestCase extends Test
// Java9+ test classes
if (atLeastJava9()) {
String[] java9TestClassNames = {
- "ThreadPoolExecutor9Test",
+ // Currently empty, but expecting varhandle tests
};
addNamedTestClasses(suite, java9TestClassNames);
}
@@ -380,6 +435,67 @@ public class JSR166TestCase extends Test
return suite;
}
+ /** Returns list of junit-style test method names in given class. */
+ public static ArrayList testMethodNames(Class> testClass) {
+ Method[] methods = testClass.getDeclaredMethods();
+ ArrayList names = new ArrayList(methods.length);
+ for (Method method : methods) {
+ if (method.getName().startsWith("test")
+ && Modifier.isPublic(method.getModifiers())
+ // method.getParameterCount() requires jdk8+
+ && method.getParameterTypes().length == 0) {
+ names.add(method.getName());
+ }
+ }
+ return names;
+ }
+
+ /**
+ * Returns junit-style testSuite for the given test class, but
+ * parameterized by passing extra data to each test.
+ */
+ public static Test parameterizedTestSuite
+ (Class extends JSR166TestCase> testClass,
+ Class dataClass,
+ ExtraData data) {
+ try {
+ TestSuite suite = new TestSuite();
+ Constructor c =
+ testClass.getDeclaredConstructor(dataClass, String.class);
+ for (String methodName : testMethodNames(testClass))
+ suite.addTest((Test) c.newInstance(data, methodName));
+ return suite;
+ } catch (Exception e) {
+ throw new Error(e);
+ }
+ }
+
+ /**
+ * Returns junit-style testSuite for the jdk8 extension of the
+ * given test class, but parameterized by passing extra data to
+ * each test. Uses reflection to allow compilation in jdk7.
+ */
+ public static Test jdk8ParameterizedTestSuite
+ (Class extends JSR166TestCase> testClass,
+ Class dataClass,
+ ExtraData data) {
+ if (atLeastJava8()) {
+ String name = testClass.getName();
+ String name8 = name.replaceAll("Test$", "8Test");
+ if (name.equals(name8)) throw new Error(name);
+ try {
+ return (Test)
+ Class.forName(name8)
+ .getMethod("testSuite", new Class[] { dataClass })
+ .invoke(null, data);
+ } catch (Exception e) {
+ throw new Error(e);
+ }
+ } else {
+ return new TestSuite();
+ }
+ }
+
// Delays for timing-dependent tests, in milliseconds.
public static long SHORT_DELAY_MS;
@@ -414,11 +530,12 @@ public class JSR166TestCase extends Test
}
/**
- * Returns a new Date instance representing a time delayMillis
- * milliseconds in the future.
+ * Returns a new Date instance representing a time at least
+ * delayMillis milliseconds in the future.
*/
Date delayedDate(long delayMillis) {
- return new Date(System.currentTimeMillis() + delayMillis);
+ // Add 1 because currentTimeMillis is known to round into the past.
+ return new Date(System.currentTimeMillis() + delayMillis + 1);
}
/**
@@ -434,6 +551,8 @@ public class JSR166TestCase extends Test
* the same test have no effect.
*/
public void threadRecordFailure(Throwable t) {
+ System.err.println(t);
+ dumpTestThreads();
threadFailure.compareAndSet(null, t);
}
@@ -441,6 +560,13 @@ public class JSR166TestCase extends Test
setDelays();
}
+ void tearDownFail(String format, Object... args) {
+ String msg = toString() + ": " + String.format(format, args);
+ System.err.println(msg);
+ dumpTestThreads();
+ throw new AssertionFailedError(msg);
+ }
+
/**
* Extra checks that get done for all test cases.
*
@@ -468,16 +594,16 @@ public class JSR166TestCase extends Test
}
if (Thread.interrupted())
- throw new AssertionFailedError("interrupt status set in main thread");
+ tearDownFail("interrupt status set in main thread");
checkForkJoinPoolThreadLeaks();
}
/**
- * Finds missing try { ... } finally { joinPool(e); }
+ * Finds missing PoolCleaners
*/
void checkForkJoinPoolThreadLeaks() throws InterruptedException {
- Thread[] survivors = new Thread[5];
+ Thread[] survivors = new Thread[7];
int count = Thread.enumerate(survivors);
for (int i = 0; i < count; i++) {
Thread thread = survivors[i];
@@ -485,13 +611,15 @@ public class JSR166TestCase extends Test
if (name.startsWith("ForkJoinPool-")) {
// give thread some time to terminate
thread.join(LONG_DELAY_MS);
- if (!thread.isAlive()) continue;
- thread.stop();
- throw new AssertionFailedError
- (String.format("Found leaked ForkJoinPool thread test=%s thread=%s%n",
- toString(), name));
+ if (thread.isAlive())
+ tearDownFail("Found leaked ForkJoinPool thread thread=%s",
+ thread);
}
}
+
+ if (!ForkJoinPool.commonPool()
+ .awaitQuiescence(LONG_DELAY_MS, MILLISECONDS))
+ tearDownFail("ForkJoin common pool thread stuck");
}
/**
@@ -504,7 +632,7 @@ public class JSR166TestCase extends Test
fail(reason);
} catch (AssertionFailedError t) {
threadRecordFailure(t);
- fail(reason);
+ throw t;
}
}
@@ -631,48 +759,139 @@ public class JSR166TestCase extends Test
/**
* Delays, via Thread.sleep, for the given millisecond delay, but
* if the sleep is shorter than specified, may re-sleep or yield
- * until time elapses.
+ * until time elapses. Ensures that the given time, as measured
+ * by System.nanoTime(), has elapsed.
*/
static void delay(long millis) throws InterruptedException {
- long startTime = System.nanoTime();
- long ns = millis * 1000 * 1000;
- for (;;) {
+ long nanos = millis * (1000 * 1000);
+ final long wakeupTime = System.nanoTime() + nanos;
+ do {
if (millis > 0L)
Thread.sleep(millis);
else // too short to sleep
Thread.yield();
- long d = ns - (System.nanoTime() - startTime);
- if (d > 0L)
- millis = d / (1000 * 1000);
- else
- break;
+ nanos = wakeupTime - System.nanoTime();
+ millis = nanos / (1000 * 1000);
+ } while (nanos >= 0L);
+ }
+
+ /**
+ * Allows use of try-with-resources with per-test thread pools.
+ */
+ class PoolCleaner implements AutoCloseable {
+ private final ExecutorService pool;
+ public PoolCleaner(ExecutorService pool) { this.pool = pool; }
+ public void close() { joinPool(pool); }
+ }
+
+ /**
+ * An extension of PoolCleaner that has an action to release the pool.
+ */
+ class PoolCleanerWithReleaser extends PoolCleaner {
+ private final Runnable releaser;
+ public PoolCleanerWithReleaser(ExecutorService pool, Runnable releaser) {
+ super(pool);
+ this.releaser = releaser;
}
+ public void close() {
+ try {
+ releaser.run();
+ } finally {
+ super.close();
+ }
+ }
+ }
+
+ PoolCleaner cleaner(ExecutorService pool) {
+ return new PoolCleaner(pool);
+ }
+
+ PoolCleaner cleaner(ExecutorService pool, Runnable releaser) {
+ return new PoolCleanerWithReleaser(pool, releaser);
+ }
+
+ PoolCleaner cleaner(ExecutorService pool, CountDownLatch latch) {
+ return new PoolCleanerWithReleaser(pool, releaser(latch));
+ }
+
+ Runnable releaser(final CountDownLatch latch) {
+ return new Runnable() { public void run() {
+ do { latch.countDown(); }
+ while (latch.getCount() > 0);
+ }};
}
/**
* Waits out termination of a thread pool or fails doing so.
*/
- void joinPool(ExecutorService exec) {
+ void joinPool(ExecutorService pool) {
try {
- exec.shutdown();
- if (!exec.awaitTermination(2 * LONG_DELAY_MS, MILLISECONDS))
- fail("ExecutorService " + exec +
- " did not terminate in a timely manner");
+ pool.shutdown();
+ if (!pool.awaitTermination(2 * LONG_DELAY_MS, MILLISECONDS)) {
+ try {
+ threadFail("ExecutorService " + pool +
+ " did not terminate in a timely manner");
+ } finally {
+ // last resort, for the benefit of subsequent tests
+ pool.shutdownNow();
+ pool.awaitTermination(MEDIUM_DELAY_MS, MILLISECONDS);
+ }
+ }
} catch (SecurityException ok) {
// Allowed in case test doesn't have privs
} catch (InterruptedException fail) {
- fail("Unexpected InterruptedException");
+ threadFail("Unexpected InterruptedException");
}
}
+ /** Like Runnable, but with the freedom to throw anything */
+ interface Action { public void run() throws Throwable; }
+
/**
- * A debugging tool to print all stack traces, as jstack does.
+ * Runs all the given actions in parallel, failing if any fail.
+ * Useful for running multiple variants of tests that are
+ * necessarily individually slow because they must block.
*/
- static void printAllStackTraces() {
- for (ThreadInfo info :
- ManagementFactory.getThreadMXBean()
- .dumpAllThreads(true, true))
+ void testInParallel(Action ... actions) {
+ ExecutorService pool = Executors.newCachedThreadPool();
+ try (PoolCleaner cleaner = cleaner(pool)) {
+ ArrayList> futures = new ArrayList<>(actions.length);
+ for (final Action action : actions)
+ futures.add(pool.submit(new CheckedRunnable() {
+ public void realRun() throws Throwable { action.run();}}));
+ for (Future> future : futures)
+ try {
+ assertNull(future.get(LONG_DELAY_MS, MILLISECONDS));
+ } catch (ExecutionException ex) {
+ threadUnexpectedException(ex.getCause());
+ } catch (Exception ex) {
+ threadUnexpectedException(ex);
+ }
+ }
+ }
+
+ /**
+ * A debugging tool to print stack traces of most threads, as jstack does.
+ * Uninteresting threads are filtered out.
+ */
+ static void dumpTestThreads() {
+ ThreadMXBean threadMXBean = ManagementFactory.getThreadMXBean();
+ System.err.println("------ stacktrace dump start ------");
+ for (ThreadInfo info : threadMXBean.dumpAllThreads(true, true)) {
+ String name = info.getThreadName();
+ if ("Signal Dispatcher".equals(name))
+ continue;
+ if ("Reference Handler".equals(name)
+ && info.getLockName().startsWith("java.lang.ref.Reference$Lock"))
+ continue;
+ if ("Finalizer".equals(name)
+ && info.getLockName().startsWith("java.lang.ref.ReferenceQueue$Lock"))
+ continue;
+ if ("checkForWedgedTest".equals(name))
+ continue;
System.err.print(info);
+ }
+ System.err.println("------ stacktrace dump end ------");
}
/**
@@ -692,7 +911,7 @@ public class JSR166TestCase extends Test
delay(millis);
assertTrue(thread.isAlive());
} catch (InterruptedException fail) {
- fail("Unexpected InterruptedException");
+ threadFail("Unexpected InterruptedException");
}
}
@@ -714,7 +933,7 @@ public class JSR166TestCase extends Test
for (Thread thread : threads)
assertTrue(thread.isAlive());
} catch (InterruptedException fail) {
- fail("Unexpected InterruptedException");
+ threadFail("Unexpected InterruptedException");
}
}
@@ -992,7 +1211,7 @@ public class JSR166TestCase extends Test
} finally {
if (t.getState() != Thread.State.TERMINATED) {
t.interrupt();
- fail("Test timed out");
+ threadFail("Test timed out");
}
}
}
@@ -1117,7 +1336,10 @@ public class JSR166TestCase extends Test
public static final String TEST_STRING = "a test string";
public static class StringTask implements Callable {
- public String call() { return TEST_STRING; }
+ final String value;
+ public StringTask() { this(TEST_STRING); }
+ public StringTask(String value) { this.value = value; }
+ public String call() { return value; }
}
public Callable latchAwaitingStringTask(final CountDownLatch latch) {
@@ -1130,13 +1352,31 @@ public class JSR166TestCase extends Test
}};
}
- public Runnable awaiter(final CountDownLatch latch) {
+ public Runnable countDowner(final CountDownLatch latch) {
return new CheckedRunnable() {
public void realRun() throws InterruptedException {
- await(latch);
+ latch.countDown();
}};
}
+ class LatchAwaiter extends CheckedRunnable {
+ static final int NEW = 0;
+ static final int RUNNING = 1;
+ static final int DONE = 2;
+ final CountDownLatch latch;
+ int state = NEW;
+ LatchAwaiter(CountDownLatch latch) { this.latch = latch; }
+ public void realRun() throws InterruptedException {
+ state = 1;
+ await(latch);
+ state = 2;
+ }
+ }
+
+ public LatchAwaiter awaiter(CountDownLatch latch) {
+ return new LatchAwaiter(latch);
+ }
+
public void await(CountDownLatch latch) {
try {
assertTrue(latch.await(LONG_DELAY_MS, MILLISECONDS));