--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/jdk/test/java/util/concurrent/tck/JSR166TestCase.java Fri Jan 29 11:44:19 2016 -0800
@@ -0,0 +1,1814 @@
+/*
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+/*
+ * This file is available under and governed by the GNU General Public
+ * License version 2 only, as published by the Free Software Foundation.
+ * However, the following notice accompanied the original version of this
+ * file:
+ *
+ * Written by Doug Lea with assistance from members of JCP JSR-166
+ * Expert Group and released to the public domain, as explained at
+ * http://creativecommons.org/publicdomain/zero/1.0/
+ * Other contributors include Andrew Wright, Jeffrey Hayes,
+ * Pat Fisher, Mike Judd.
+ */
+
+/*
+ * @test
+ * @summary JSR-166 tck tests
+ * @build *
+ * @run junit/othervm/timeout=1000 -Djsr166.testImplementationDetails=true JSR166TestCase
+ */
+
+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;
+import java.io.ByteArrayOutputStream;
+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.nio.file.Files;
+import java.nio.file.Paths;
+import java.security.CodeSource;
+import java.security.Permission;
+import java.security.PermissionCollection;
+import java.security.Permissions;
+import java.security.Policy;
+import java.security.ProtectionDomain;
+import java.security.SecurityPermission;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Date;
+import java.util.Enumeration;
+import java.util.Iterator;
+import java.util.List;
+import java.util.NoSuchElementException;
+import java.util.PropertyPermission;
+import java.util.concurrent.BlockingQueue;
+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;
+import java.util.concurrent.RejectedExecutionHandler;
+import java.util.concurrent.Semaphore;
+import java.util.concurrent.ThreadFactory;
+import java.util.concurrent.ThreadPoolExecutor;
+import java.util.concurrent.TimeoutException;
+import java.util.concurrent.atomic.AtomicReference;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+import junit.framework.AssertionFailedError;
+import junit.framework.Test;
+import junit.framework.TestCase;
+import junit.framework.TestResult;
+import junit.framework.TestSuite;
+
+/**
+ * Base class for JSR166 Junit TCK tests. Defines some constants,
+ * utility methods and classes, as well as a simple framework for
+ * helping to make sure that assertions failing in generated threads
+ * cause the associated test that generated them to itself fail (which
+ * JUnit does not otherwise arrange). The rules for creating such
+ * tests are:
+ *
+ * <ol>
+ *
+ * <li>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.
+ *
+ * <li>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.
+ *
+ * <li>All delays and timeouts must use one of the constants {@code
+ * SHORT_DELAY_MS}, {@code SMALL_DELAY_MS}, {@code MEDIUM_DELAY_MS},
+ * {@code LONG_DELAY_MS}. The idea here is that a SHORT is always
+ * discriminable from zero time, and always allows enough time for the
+ * small amounts of computation (creating a thread, calling a few
+ * methods, etc) needed to reach a timeout point. Similarly, a SMALL
+ * 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.
+ *
+ * <li>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.
+ *
+ * </ol>
+ *
+ * <p><b>Other notes</b>
+ * <ul>
+ *
+ * <li>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.
+ *
+ * <li>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.
+ *
+ * <li>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.
+ *
+ * <li>The test classes currently do not declare inclusion in
+ * any particular package to simplify things for people integrating
+ * them in TCK test suites.
+ *
+ * <li>As a convenience, the {@code main} of this class (JSR166TestCase)
+ * runs all JSR166 unit tests.
+ *
+ * </ul>
+ */
+public class JSR166TestCase extends TestCase {
+ private static final boolean useSecurityManager =
+ Boolean.getBoolean("jsr166.useSecurityManager");
+
+ protected static final boolean expensiveTests =
+ Boolean.getBoolean("jsr166.expensiveTests");
+
+ /**
+ * If true, also run tests that are not part of the official tck
+ * because they test unspecified implementation details.
+ */
+ protected static final boolean testImplementationDetails =
+ Boolean.getBoolean("jsr166.testImplementationDetails");
+
+ /**
+ * If true, report on stdout all "slow" tests, that is, ones that
+ * take more than profileThreshold milliseconds to execute.
+ */
+ private static final boolean profileTests =
+ Boolean.getBoolean("jsr166.profileTests");
+
+ /**
+ * The number of milliseconds that tests are permitted for
+ * execution without being reported, when profileTests is set.
+ */
+ private static final long profileThreshold =
+ Long.getLong("jsr166.profileThreshold", 100);
+
+ /**
+ * The number of repetitions per test (for tickling rare bugs).
+ */
+ private static final int runsPerTest =
+ Integer.getInteger("jsr166.runsPerTest", 1);
+
+ /**
+ * The number of repetitions of the test suite (for finding leaks?).
+ */
+ private static final int suiteRuns =
+ Integer.getInteger("jsr166.suiteRuns", 1);
+
+ /**
+ * The scaling factor to apply to standard delays used in tests.
+ */
+ private static final int delayFactor =
+ Integer.getInteger("jsr166.delay.factor", 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)"
+ * Usefully combined with jsr166.runsPerTest.
+ */
+ private static final Pattern methodFilter = methodFilter();
+
+ private static Pattern methodFilter() {
+ String regex = System.getProperty("jsr166.methodFilter");
+ return (regex == null) ? null : Pattern.compile(regex);
+ }
+
+ // 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.
+ // A single test case run should never take more than 1 second.
+ // But let's cap it at the high end too ...
+ final int timeoutMinutes =
+ Math.min(15, Math.max(runsPerTest / 60, 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%n",
+ lastTestCase);
+// System.err.printf(
+// "Looks like we're stuck running test: %s (%d/%d)%n",
+// lastTestCase, currentRun, runsPerTest);
+// System.err.println("availableProcessors=" +
+// Runtime.getRuntime().availableProcessors());
+// System.err.printf("cpu model = %s%n", cpuModel());
+ 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 static String cpuModel() {
+// try {
+// Matcher matcher = Pattern.compile("model name\\s*: (.*)")
+// .matcher(new String(
+// Files.readAllBytes(Paths.get("/proc/cpuinfo")), "UTF-8"));
+// matcher.find();
+// return matcher.group(1);
+// } catch (Exception ex) { return null; }
+// }
+
+ public void runBare() throws Throwable {
+ currentTestCase = this;
+ if (methodFilter == null
+ || 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 {
+ for (int i = 0; i < 2; i++) {
+ long startTime = System.nanoTime();
+ super.runTest();
+ 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);
+ }
+ }
+
+ /**
+ * Runs all JSR166 unit tests using junit.textui.TestRunner.
+ */
+ public static void main(String[] args) {
+ main(suite(), args);
+ }
+
+ static class PithyResultPrinter extends junit.textui.ResultPrinter {
+ PithyResultPrinter(java.io.PrintStream writer) { super(writer); }
+ long runTime;
+ public void startTest(Test test) {}
+ protected void printHeader(long runTime) {
+ this.runTime = runTime; // defer printing for later
+ }
+ protected void printFooter(TestResult result) {
+ if (result.wasSuccessful()) {
+ getWriter().println("OK (" + result.runCount() + " tests)"
+ + " Time: " + elapsedTimeAsString(runTime));
+ } else {
+ getWriter().println("Time: " + elapsedTimeAsString(runTime));
+ super.printFooter(result);
+ }
+ }
+ }
+
+ /**
+ * Returns a TestRunner that doesn't bother with unnecessary
+ * fluff, like printing a "." for each test case.
+ */
+ static junit.textui.TestRunner newPithyTestRunner() {
+ junit.textui.TestRunner runner = new junit.textui.TestRunner();
+ runner.setPrinter(new PithyResultPrinter(System.out));
+ return runner;
+ }
+
+ /**
+ * Runs all unit tests in the given test suite.
+ * Actual behavior influenced by jsr166.* system properties.
+ */
+ static void main(Test suite, String[] args) {
+ if (useSecurityManager) {
+ System.err.println("Setting a permissive security manager");
+ Policy.setPolicy(permissivePolicy());
+ System.setSecurityManager(new SecurityManager());
+ }
+ for (int i = 0; i < suiteRuns; i++) {
+ TestResult result = newPithyTestRunner().doRun(suite);
+ if (!result.wasSuccessful())
+ System.exit(1);
+ System.gc();
+ System.runFinalization();
+ }
+ }
+
+ public static TestSuite newTestSuite(Object... suiteOrClasses) {
+ TestSuite suite = new TestSuite();
+ for (Object suiteOrClass : suiteOrClasses) {
+ if (suiteOrClass instanceof TestSuite)
+ suite.addTest((TestSuite) suiteOrClass);
+ else if (suiteOrClass instanceof Class)
+ suite.addTest(new TestSuite((Class<?>) suiteOrClass));
+ else
+ throw new ClassCastException("not a test suite or class");
+ }
+ return suite;
+ }
+
+ public static void addNamedTestClasses(TestSuite suite,
+ String... testClassNames) {
+ for (String testClassName : testClassNames) {
+ try {
+ Class<?> testClass = Class.forName(testClassName);
+ Method m = testClass.getDeclaredMethod("suite",
+ new Class<?>[0]);
+ suite.addTest(newTestSuite((Test)m.invoke(null)));
+ } catch (Exception e) {
+ throw new Error("Missing test class", e);
+ }
+ }
+ }
+
+ public static final double JAVA_CLASS_VERSION;
+ public static final String JAVA_SPECIFICATION_VERSION;
+ static {
+ try {
+ JAVA_CLASS_VERSION = java.security.AccessController.doPrivileged(
+ new java.security.PrivilegedAction<Double>() {
+ public Double run() {
+ return Double.valueOf(System.getProperty("java.class.version"));}});
+ JAVA_SPECIFICATION_VERSION = java.security.AccessController.doPrivileged(
+ new java.security.PrivilegedAction<String>() {
+ public String run() {
+ return System.getProperty("java.specification.version");}});
+ } catch (Throwable t) {
+ throw new Error(t);
+ }
+ }
+
+ 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
+ // 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.
+ */
+ public static Test suite() {
+ // Java7+ test classes
+ TestSuite suite = newTestSuite(
+ ForkJoinPoolTest.suite(),
+ ForkJoinTaskTest.suite(),
+ RecursiveActionTest.suite(),
+ RecursiveTaskTest.suite(),
+ LinkedTransferQueueTest.suite(),
+ PhaserTest.suite(),
+ ThreadLocalRandomTest.suite(),
+ AbstractExecutorServiceTest.suite(),
+ AbstractQueueTest.suite(),
+ AbstractQueuedSynchronizerTest.suite(),
+ AbstractQueuedLongSynchronizerTest.suite(),
+ ArrayBlockingQueueTest.suite(),
+ ArrayDequeTest.suite(),
+ AtomicBooleanTest.suite(),
+ AtomicIntegerArrayTest.suite(),
+ AtomicIntegerFieldUpdaterTest.suite(),
+ AtomicIntegerTest.suite(),
+ AtomicLongArrayTest.suite(),
+ AtomicLongFieldUpdaterTest.suite(),
+ AtomicLongTest.suite(),
+ AtomicMarkableReferenceTest.suite(),
+ AtomicReferenceArrayTest.suite(),
+ AtomicReferenceFieldUpdaterTest.suite(),
+ AtomicReferenceTest.suite(),
+ AtomicStampedReferenceTest.suite(),
+ ConcurrentHashMapTest.suite(),
+ ConcurrentLinkedDequeTest.suite(),
+ ConcurrentLinkedQueueTest.suite(),
+ ConcurrentSkipListMapTest.suite(),
+ ConcurrentSkipListSubMapTest.suite(),
+ ConcurrentSkipListSetTest.suite(),
+ ConcurrentSkipListSubSetTest.suite(),
+ CopyOnWriteArrayListTest.suite(),
+ CopyOnWriteArraySetTest.suite(),
+ CountDownLatchTest.suite(),
+ CyclicBarrierTest.suite(),
+ DelayQueueTest.suite(),
+ EntryTest.suite(),
+ ExchangerTest.suite(),
+ ExecutorsTest.suite(),
+ ExecutorCompletionServiceTest.suite(),
+ FutureTaskTest.suite(),
+ LinkedBlockingDequeTest.suite(),
+ LinkedBlockingQueueTest.suite(),
+ LinkedListTest.suite(),
+ LockSupportTest.suite(),
+ PriorityBlockingQueueTest.suite(),
+ PriorityQueueTest.suite(),
+ ReentrantLockTest.suite(),
+ ReentrantReadWriteLockTest.suite(),
+ ScheduledExecutorTest.suite(),
+ ScheduledExecutorSubclassTest.suite(),
+ SemaphoreTest.suite(),
+ SynchronousQueueTest.suite(),
+ SystemTest.suite(),
+ ThreadLocalTest.suite(),
+ ThreadPoolExecutorTest.suite(),
+ ThreadPoolExecutorSubclassTest.suite(),
+ ThreadTest.suite(),
+ TimeUnitTest.suite(),
+ TreeMapTest.suite(),
+ TreeSetTest.suite(),
+ TreeSubMapTest.suite(),
+ TreeSubSetTest.suite());
+
+ // Java8+ test classes
+ if (atLeastJava8()) {
+ String[] java8TestClassNames = {
+ "Atomic8Test",
+ "CompletableFutureTest",
+ "ConcurrentHashMap8Test",
+ "CountedCompleterTest",
+ "DoubleAccumulatorTest",
+ "DoubleAdderTest",
+ "ForkJoinPool8Test",
+ "ForkJoinTask8Test",
+ "LongAccumulatorTest",
+ "LongAdderTest",
+ "SplittableRandomTest",
+ "StampedLockTest",
+ "SubmissionPublisherTest",
+ "ThreadLocalRandom8Test",
+ };
+ addNamedTestClasses(suite, java8TestClassNames);
+ }
+
+ // Java9+ test classes
+ if (atLeastJava9()) {
+ String[] java9TestClassNames = {
+ // Currently empty, but expecting varhandle tests
+ };
+ addNamedTestClasses(suite, java9TestClassNames);
+ }
+
+ return suite;
+ }
+
+ /** Returns list of junit-style test method names in given class. */
+ public static ArrayList<String> testMethodNames(Class<?> testClass) {
+ Method[] methods = testClass.getDeclaredMethods();
+ ArrayList<String> names = new ArrayList<String>(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 <ExtraData> Test parameterizedTestSuite
+ (Class<? extends JSR166TestCase> testClass,
+ Class<ExtraData> 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 <ExtraData> Test jdk8ParameterizedTestSuite
+ (Class<? extends JSR166TestCase> testClass,
+ Class<ExtraData> 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;
+ public static long SMALL_DELAY_MS;
+ public static long MEDIUM_DELAY_MS;
+ public static long LONG_DELAY_MS;
+
+ /**
+ * Returns the shortest timed delay. This can be scaled up for
+ * slow machines using the jsr166.delay.factor system property.
+ */
+ protected long getShortDelay() {
+ return 50 * delayFactor;
+ }
+
+ /**
+ * Sets delays as multiples of SHORT_DELAY.
+ */
+ protected void setDelays() {
+ SHORT_DELAY_MS = getShortDelay();
+ SMALL_DELAY_MS = SHORT_DELAY_MS * 5;
+ MEDIUM_DELAY_MS = SHORT_DELAY_MS * 10;
+ LONG_DELAY_MS = SHORT_DELAY_MS * 200;
+ }
+
+ /**
+ * Returns a timeout in milliseconds to be used in tests that
+ * verify that operations block or time out.
+ */
+ long timeoutMillis() {
+ return SHORT_DELAY_MS / 4;
+ }
+
+ /**
+ * Returns a new Date instance representing a time at least
+ * delayMillis milliseconds in the future.
+ */
+ Date delayedDate(long delayMillis) {
+ // Add 1 because currentTimeMillis is known to round into the past.
+ return new Date(System.currentTimeMillis() + delayMillis + 1);
+ }
+
+ /**
+ * The first exception encountered if any threadAssertXXX method fails.
+ */
+ private final AtomicReference<Throwable> threadFailure
+ = new AtomicReference<Throwable>(null);
+
+ /**
+ * Records an exception so that it can be rethrown later in the test
+ * harness thread, triggering a test case failure. Only the first
+ * failure is recorded; subsequent calls to this method from within
+ * the same test have no effect.
+ */
+ public void threadRecordFailure(Throwable t) {
+ System.err.println(t);
+ dumpTestThreads();
+ threadFailure.compareAndSet(null, t);
+ }
+
+ public void setUp() {
+ 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.
+ *
+ * Triggers test case failure if any thread assertions have failed,
+ * by rethrowing, in the test harness thread, any exception recorded
+ * earlier by threadRecordFailure.
+ *
+ * Triggers test case failure if interrupt status is set in the main thread.
+ */
+ public void tearDown() throws Exception {
+ Throwable t = threadFailure.getAndSet(null);
+ if (t != null) {
+ if (t instanceof Error)
+ throw (Error) t;
+ else if (t instanceof RuntimeException)
+ throw (RuntimeException) t;
+ else if (t instanceof Exception)
+ throw (Exception) t;
+ else {
+ AssertionFailedError afe =
+ new AssertionFailedError(t.toString());
+ afe.initCause(t);
+ throw afe;
+ }
+ }
+
+ if (Thread.interrupted())
+ tearDownFail("interrupt status set in main thread");
+
+ checkForkJoinPoolThreadLeaks();
+ }
+
+ /**
+ * Finds missing PoolCleaners
+ */
+ void checkForkJoinPoolThreadLeaks() throws InterruptedException {
+ Thread[] survivors = new Thread[7];
+ int count = Thread.enumerate(survivors);
+ for (int i = 0; i < count; i++) {
+ Thread thread = survivors[i];
+ String name = thread.getName();
+ if (name.startsWith("ForkJoinPool-")) {
+ // give thread some time to terminate
+ thread.join(LONG_DELAY_MS);
+ 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");
+ }
+
+ /**
+ * Just like fail(reason), but additionally recording (using
+ * threadRecordFailure) any AssertionFailedError thrown, so that
+ * the current testcase will fail.
+ */
+ public void threadFail(String reason) {
+ try {
+ fail(reason);
+ } catch (AssertionFailedError t) {
+ threadRecordFailure(t);
+ throw t;
+ }
+ }
+
+ /**
+ * Just like assertTrue(b), but additionally recording (using
+ * threadRecordFailure) any AssertionFailedError thrown, so that
+ * the current testcase will fail.
+ */
+ public void threadAssertTrue(boolean b) {
+ try {
+ assertTrue(b);
+ } catch (AssertionFailedError t) {
+ threadRecordFailure(t);
+ throw t;
+ }
+ }
+
+ /**
+ * Just like assertFalse(b), but additionally recording (using
+ * threadRecordFailure) any AssertionFailedError thrown, so that
+ * the current testcase will fail.
+ */
+ public void threadAssertFalse(boolean b) {
+ try {
+ assertFalse(b);
+ } catch (AssertionFailedError t) {
+ threadRecordFailure(t);
+ throw t;
+ }
+ }
+
+ /**
+ * Just like assertNull(x), but additionally recording (using
+ * threadRecordFailure) any AssertionFailedError thrown, so that
+ * the current testcase will fail.
+ */
+ public void threadAssertNull(Object x) {
+ try {
+ assertNull(x);
+ } catch (AssertionFailedError t) {
+ threadRecordFailure(t);
+ throw t;
+ }
+ }
+
+ /**
+ * Just like assertEquals(x, y), but additionally recording (using
+ * threadRecordFailure) any AssertionFailedError thrown, so that
+ * the current testcase will fail.
+ */
+ public void threadAssertEquals(long x, long y) {
+ try {
+ assertEquals(x, y);
+ } catch (AssertionFailedError t) {
+ threadRecordFailure(t);
+ throw t;
+ }
+ }
+
+ /**
+ * Just like assertEquals(x, y), but additionally recording (using
+ * threadRecordFailure) any AssertionFailedError thrown, so that
+ * the current testcase will fail.
+ */
+ public void threadAssertEquals(Object x, Object y) {
+ try {
+ assertEquals(x, y);
+ } catch (AssertionFailedError fail) {
+ threadRecordFailure(fail);
+ throw fail;
+ } catch (Throwable fail) {
+ threadUnexpectedException(fail);
+ }
+ }
+
+ /**
+ * Just like assertSame(x, y), but additionally recording (using
+ * threadRecordFailure) any AssertionFailedError thrown, so that
+ * the current testcase will fail.
+ */
+ public void threadAssertSame(Object x, Object y) {
+ try {
+ assertSame(x, y);
+ } catch (AssertionFailedError fail) {
+ threadRecordFailure(fail);
+ throw fail;
+ }
+ }
+
+ /**
+ * Calls threadFail with message "should throw exception".
+ */
+ public void threadShouldThrow() {
+ threadFail("should throw exception");
+ }
+
+ /**
+ * Calls threadFail with message "should throw" + exceptionName.
+ */
+ public void threadShouldThrow(String exceptionName) {
+ threadFail("should throw " + exceptionName);
+ }
+
+ /**
+ * Records the given exception using {@link #threadRecordFailure},
+ * then rethrows the exception, wrapping it in an
+ * AssertionFailedError if necessary.
+ */
+ public void threadUnexpectedException(Throwable t) {
+ threadRecordFailure(t);
+ t.printStackTrace();
+ if (t instanceof RuntimeException)
+ throw (RuntimeException) t;
+ else if (t instanceof Error)
+ throw (Error) t;
+ else {
+ AssertionFailedError afe =
+ new AssertionFailedError("unexpected exception: " + t);
+ afe.initCause(t);
+ throw afe;
+ }
+ }
+
+ /**
+ * 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. Ensures that the given time, as measured
+ * by System.nanoTime(), has elapsed.
+ */
+ static void delay(long millis) throws InterruptedException {
+ 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();
+ 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 pool) {
+ try {
+ 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) {
+ threadFail("Unexpected InterruptedException");
+ }
+ }
+
+ /** Like Runnable, but with the freedom to throw anything */
+ interface Action { public void run() throws Throwable; }
+
+ /**
+ * 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.
+ */
+ void testInParallel(Action ... actions) {
+ ExecutorService pool = Executors.newCachedThreadPool();
+ try (PoolCleaner cleaner = cleaner(pool)) {
+ ArrayList<Future<?>> 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 ------");
+ }
+
+ /**
+ * Checks that thread does not terminate within the default
+ * millisecond delay of {@code timeoutMillis()}.
+ */
+ void assertThreadStaysAlive(Thread thread) {
+ assertThreadStaysAlive(thread, timeoutMillis());
+ }
+
+ /**
+ * Checks that thread does not terminate within the given millisecond delay.
+ */
+ void assertThreadStaysAlive(Thread thread, long millis) {
+ try {
+ // No need to optimize the failing case via Thread.join.
+ delay(millis);
+ assertTrue(thread.isAlive());
+ } catch (InterruptedException fail) {
+ threadFail("Unexpected InterruptedException");
+ }
+ }
+
+ /**
+ * Checks that the threads do not terminate within the default
+ * millisecond delay of {@code timeoutMillis()}.
+ */
+ void assertThreadsStayAlive(Thread... threads) {
+ assertThreadsStayAlive(timeoutMillis(), threads);
+ }
+
+ /**
+ * Checks that the threads do not terminate within the given millisecond delay.
+ */
+ void assertThreadsStayAlive(long millis, Thread... threads) {
+ try {
+ // No need to optimize the failing case via Thread.join.
+ delay(millis);
+ for (Thread thread : threads)
+ assertTrue(thread.isAlive());
+ } catch (InterruptedException fail) {
+ threadFail("Unexpected InterruptedException");
+ }
+ }
+
+ /**
+ * Checks that future.get times out, with the default timeout of
+ * {@code timeoutMillis()}.
+ */
+ void assertFutureTimesOut(Future future) {
+ assertFutureTimesOut(future, timeoutMillis());
+ }
+
+ /**
+ * Checks that future.get times out, with the given millisecond timeout.
+ */
+ void assertFutureTimesOut(Future future, long timeoutMillis) {
+ long startTime = System.nanoTime();
+ try {
+ future.get(timeoutMillis, MILLISECONDS);
+ shouldThrow();
+ } catch (TimeoutException success) {
+ } catch (Exception fail) {
+ threadUnexpectedException(fail);
+ } finally { future.cancel(true); }
+ assertTrue(millisElapsedSince(startTime) >= timeoutMillis);
+ }
+
+ /**
+ * Fails with message "should throw exception".
+ */
+ public void shouldThrow() {
+ fail("Should throw exception");
+ }
+
+ /**
+ * Fails with message "should throw " + exceptionName.
+ */
+ public void shouldThrow(String exceptionName) {
+ fail("Should throw " + exceptionName);
+ }
+
+ /**
+ * The number of elements to place in collections, arrays, etc.
+ */
+ public static final int SIZE = 20;
+
+ // Some convenient Integer constants
+
+ public static final Integer zero = new Integer(0);
+ public static final Integer one = new Integer(1);
+ public static final Integer two = new Integer(2);
+ public static final Integer three = new Integer(3);
+ public static final Integer four = new Integer(4);
+ public static final Integer five = new Integer(5);
+ public static final Integer six = new Integer(6);
+ public static final Integer seven = new Integer(7);
+ public static final Integer eight = new Integer(8);
+ public static final Integer nine = new Integer(9);
+ public static final Integer m1 = new Integer(-1);
+ public static final Integer m2 = new Integer(-2);
+ public static final Integer m3 = new Integer(-3);
+ public static final Integer m4 = new Integer(-4);
+ public static final Integer m5 = new Integer(-5);
+ public static final Integer m6 = new Integer(-6);
+ public static final Integer m10 = new Integer(-10);
+
+ /**
+ * Runs Runnable r with a security policy that permits precisely
+ * the specified permissions. If there is no current security
+ * manager, the runnable is run twice, both with and without a
+ * security manager. We require that any security manager permit
+ * getPolicy/setPolicy.
+ */
+ public void runWithPermissions(Runnable r, Permission... permissions) {
+ SecurityManager sm = System.getSecurityManager();
+ if (sm == null) {
+ r.run();
+ }
+ runWithSecurityManagerWithPermissions(r, permissions);
+ }
+
+ /**
+ * Runs Runnable r with a security policy that permits precisely
+ * the specified permissions. If there is no current security
+ * manager, a temporary one is set for the duration of the
+ * Runnable. We require that any security manager permit
+ * getPolicy/setPolicy.
+ */
+ public void runWithSecurityManagerWithPermissions(Runnable r,
+ Permission... permissions) {
+ SecurityManager sm = System.getSecurityManager();
+ if (sm == null) {
+ Policy savedPolicy = Policy.getPolicy();
+ try {
+ Policy.setPolicy(permissivePolicy());
+ System.setSecurityManager(new SecurityManager());
+ runWithSecurityManagerWithPermissions(r, permissions);
+ } finally {
+ System.setSecurityManager(null);
+ Policy.setPolicy(savedPolicy);
+ }
+ } else {
+ Policy savedPolicy = Policy.getPolicy();
+ AdjustablePolicy policy = new AdjustablePolicy(permissions);
+ Policy.setPolicy(policy);
+
+ try {
+ r.run();
+ } finally {
+ policy.addPermission(new SecurityPermission("setPolicy"));
+ Policy.setPolicy(savedPolicy);
+ }
+ }
+ }
+
+ /**
+ * Runs a runnable without any permissions.
+ */
+ public void runWithoutPermissions(Runnable r) {
+ runWithPermissions(r);
+ }
+
+ /**
+ * A security policy where new permissions can be dynamically added
+ * or all cleared.
+ */
+ public static class AdjustablePolicy extends java.security.Policy {
+ Permissions perms = new Permissions();
+ AdjustablePolicy(Permission... permissions) {
+ for (Permission permission : permissions)
+ perms.add(permission);
+ }
+ void addPermission(Permission perm) { perms.add(perm); }
+ void clearPermissions() { perms = new Permissions(); }
+ public PermissionCollection getPermissions(CodeSource cs) {
+ return perms;
+ }
+ public PermissionCollection getPermissions(ProtectionDomain pd) {
+ return perms;
+ }
+ public boolean implies(ProtectionDomain pd, Permission p) {
+ return perms.implies(p);
+ }
+ public void refresh() {}
+ public String toString() {
+ List<Permission> ps = new ArrayList<Permission>();
+ for (Enumeration<Permission> e = perms.elements(); e.hasMoreElements();)
+ ps.add(e.nextElement());
+ return "AdjustablePolicy with permissions " + ps;
+ }
+ }
+
+ /**
+ * Returns a policy containing all the permissions we ever need.
+ */
+ public static Policy permissivePolicy() {
+ return new AdjustablePolicy
+ // Permissions j.u.c. needs directly
+ (new RuntimePermission("modifyThread"),
+ new RuntimePermission("getClassLoader"),
+ new RuntimePermission("setContextClassLoader"),
+ // Permissions needed to change permissions!
+ new SecurityPermission("getPolicy"),
+ new SecurityPermission("setPolicy"),
+ new RuntimePermission("setSecurityManager"),
+ // Permissions needed by the junit test harness
+ new RuntimePermission("accessDeclaredMembers"),
+ new PropertyPermission("*", "read"),
+ new java.io.FilePermission("<<ALL FILES>>", "read"));
+ }
+
+ /**
+ * Sleeps until the given time has elapsed.
+ * Throws AssertionFailedError if interrupted.
+ */
+ void sleep(long millis) {
+ try {
+ delay(millis);
+ } catch (InterruptedException fail) {
+ AssertionFailedError afe =
+ new AssertionFailedError("Unexpected InterruptedException");
+ afe.initCause(fail);
+ throw afe;
+ }
+ }
+
+ /**
+ * Spin-waits up to the specified number of milliseconds for the given
+ * thread to enter a wait state: BLOCKED, WAITING, or TIMED_WAITING.
+ */
+ void waitForThreadToEnterWaitState(Thread thread, long timeoutMillis) {
+ long startTime = System.nanoTime();
+ for (;;) {
+ Thread.State s = thread.getState();
+ if (s == Thread.State.BLOCKED ||
+ s == Thread.State.WAITING ||
+ s == Thread.State.TIMED_WAITING)
+ return;
+ else if (s == Thread.State.TERMINATED)
+ fail("Unexpected thread termination");
+ else if (millisElapsedSince(startTime) > timeoutMillis) {
+ threadAssertTrue(thread.isAlive());
+ return;
+ }
+ Thread.yield();
+ }
+ }
+
+ /**
+ * Waits up to LONG_DELAY_MS for the given thread to enter a wait
+ * state: BLOCKED, WAITING, or TIMED_WAITING.
+ */
+ void waitForThreadToEnterWaitState(Thread thread) {
+ waitForThreadToEnterWaitState(thread, LONG_DELAY_MS);
+ }
+
+ /**
+ * Returns the number of milliseconds since time given by
+ * startNanoTime, which must have been previously returned from a
+ * call to {@link System#nanoTime()}.
+ */
+ static long millisElapsedSince(long startNanoTime) {
+ return NANOSECONDS.toMillis(System.nanoTime() - startNanoTime);
+ }
+
+// void assertTerminatesPromptly(long timeoutMillis, Runnable r) {
+// long startTime = System.nanoTime();
+// try {
+// r.run();
+// } catch (Throwable fail) { threadUnexpectedException(fail); }
+// if (millisElapsedSince(startTime) > timeoutMillis/2)
+// throw new AssertionFailedError("did not return promptly");
+// }
+
+// void assertTerminatesPromptly(Runnable r) {
+// assertTerminatesPromptly(LONG_DELAY_MS/2, r);
+// }
+
+ /**
+ * Checks that timed f.get() returns the expected value, and does not
+ * wait for the timeout to elapse before returning.
+ */
+ <T> void checkTimedGet(Future<T> f, T expectedValue, long timeoutMillis) {
+ long startTime = System.nanoTime();
+ try {
+ assertEquals(expectedValue, f.get(timeoutMillis, MILLISECONDS));
+ } catch (Throwable fail) { threadUnexpectedException(fail); }
+ if (millisElapsedSince(startTime) > timeoutMillis/2)
+ throw new AssertionFailedError("timed get did not return promptly");
+ }
+
+ <T> void checkTimedGet(Future<T> f, T expectedValue) {
+ checkTimedGet(f, expectedValue, LONG_DELAY_MS);
+ }
+
+ /**
+ * Returns a new started daemon Thread running the given runnable.
+ */
+ Thread newStartedThread(Runnable runnable) {
+ Thread t = new Thread(runnable);
+ t.setDaemon(true);
+ t.start();
+ return t;
+ }
+
+ /**
+ * Waits for the specified time (in milliseconds) for the thread
+ * to terminate (using {@link Thread#join(long)}), else interrupts
+ * the thread (in the hope that it may terminate later) and fails.
+ */
+ void awaitTermination(Thread t, long timeoutMillis) {
+ try {
+ t.join(timeoutMillis);
+ } catch (InterruptedException fail) {
+ threadUnexpectedException(fail);
+ } finally {
+ if (t.getState() != Thread.State.TERMINATED) {
+ t.interrupt();
+ threadFail("timed out waiting for thread to terminate");
+ }
+ }
+ }
+
+ /**
+ * Waits for LONG_DELAY_MS milliseconds for the thread to
+ * terminate (using {@link Thread#join(long)}), else interrupts
+ * the thread (in the hope that it may terminate later) and fails.
+ */
+ void awaitTermination(Thread t) {
+ awaitTermination(t, LONG_DELAY_MS);
+ }
+
+ // Some convenient Runnable classes
+
+ public abstract class CheckedRunnable implements Runnable {
+ protected abstract void realRun() throws Throwable;
+
+ public final void run() {
+ try {
+ realRun();
+ } catch (Throwable fail) {
+ threadUnexpectedException(fail);
+ }
+ }
+ }
+
+ public abstract class RunnableShouldThrow implements Runnable {
+ protected abstract void realRun() throws Throwable;
+
+ final Class<?> exceptionClass;
+
+ <T extends Throwable> RunnableShouldThrow(Class<T> exceptionClass) {
+ this.exceptionClass = exceptionClass;
+ }
+
+ public final void run() {
+ try {
+ realRun();
+ threadShouldThrow(exceptionClass.getSimpleName());
+ } catch (Throwable t) {
+ if (! exceptionClass.isInstance(t))
+ threadUnexpectedException(t);
+ }
+ }
+ }
+
+ public abstract class ThreadShouldThrow extends Thread {
+ protected abstract void realRun() throws Throwable;
+
+ final Class<?> exceptionClass;
+
+ <T extends Throwable> ThreadShouldThrow(Class<T> exceptionClass) {
+ this.exceptionClass = exceptionClass;
+ }
+
+ public final void run() {
+ try {
+ realRun();
+ threadShouldThrow(exceptionClass.getSimpleName());
+ } catch (Throwable t) {
+ if (! exceptionClass.isInstance(t))
+ threadUnexpectedException(t);
+ }
+ }
+ }
+
+ public abstract class CheckedInterruptedRunnable implements Runnable {
+ protected abstract void realRun() throws Throwable;
+
+ public final void run() {
+ try {
+ realRun();
+ threadShouldThrow("InterruptedException");
+ } catch (InterruptedException success) {
+ threadAssertFalse(Thread.interrupted());
+ } catch (Throwable fail) {
+ threadUnexpectedException(fail);
+ }
+ }
+ }
+
+ public abstract class CheckedCallable<T> implements Callable<T> {
+ protected abstract T realCall() throws Throwable;
+
+ public final T call() {
+ try {
+ return realCall();
+ } catch (Throwable fail) {
+ threadUnexpectedException(fail);
+ return null;
+ }
+ }
+ }
+
+ public abstract class CheckedInterruptedCallable<T>
+ implements Callable<T> {
+ protected abstract T realCall() throws Throwable;
+
+ public final T call() {
+ try {
+ T result = realCall();
+ threadShouldThrow("InterruptedException");
+ return result;
+ } catch (InterruptedException success) {
+ threadAssertFalse(Thread.interrupted());
+ } catch (Throwable fail) {
+ threadUnexpectedException(fail);
+ }
+ return null;
+ }
+ }
+
+ public static class NoOpRunnable implements Runnable {
+ public void run() {}
+ }
+
+ public static class NoOpCallable implements Callable {
+ public Object call() { return Boolean.TRUE; }
+ }
+
+ public static final String TEST_STRING = "a test string";
+
+ public static class StringTask implements Callable<String> {
+ final String value;
+ public StringTask() { this(TEST_STRING); }
+ public StringTask(String value) { this.value = value; }
+ public String call() { return value; }
+ }
+
+ public Callable<String> latchAwaitingStringTask(final CountDownLatch latch) {
+ return new CheckedCallable<String>() {
+ protected String realCall() {
+ try {
+ latch.await();
+ } catch (InterruptedException quittingTime) {}
+ return TEST_STRING;
+ }};
+ }
+
+ public Runnable countDowner(final CountDownLatch latch) {
+ return new CheckedRunnable() {
+ public void realRun() throws InterruptedException {
+ 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 {
+ if (!latch.await(LONG_DELAY_MS, MILLISECONDS))
+ fail("timed out waiting for CountDownLatch for "
+ + (LONG_DELAY_MS/1000) + " sec");
+ } catch (Throwable fail) {
+ threadUnexpectedException(fail);
+ }
+ }
+
+ public void await(Semaphore semaphore) {
+ try {
+ if (!semaphore.tryAcquire(LONG_DELAY_MS, MILLISECONDS))
+ fail("timed out waiting for Semaphore for "
+ + (LONG_DELAY_MS/1000) + " sec");
+ } catch (Throwable fail) {
+ threadUnexpectedException(fail);
+ }
+ }
+
+// /**
+// * Spin-waits up to LONG_DELAY_MS until flag becomes true.
+// */
+// public void await(AtomicBoolean flag) {
+// await(flag, LONG_DELAY_MS);
+// }
+
+// /**
+// * Spin-waits up to the specified timeout until flag becomes true.
+// */
+// public void await(AtomicBoolean flag, long timeoutMillis) {
+// long startTime = System.nanoTime();
+// while (!flag.get()) {
+// if (millisElapsedSince(startTime) > timeoutMillis)
+// throw new AssertionFailedError("timed out");
+// Thread.yield();
+// }
+// }
+
+ public static class NPETask implements Callable<String> {
+ public String call() { throw new NullPointerException(); }
+ }
+
+ public static class CallableOne implements Callable<Integer> {
+ public Integer call() { return one; }
+ }
+
+ public class ShortRunnable extends CheckedRunnable {
+ protected void realRun() throws Throwable {
+ delay(SHORT_DELAY_MS);
+ }
+ }
+
+ public class ShortInterruptedRunnable extends CheckedInterruptedRunnable {
+ protected void realRun() throws InterruptedException {
+ delay(SHORT_DELAY_MS);
+ }
+ }
+
+ public class SmallRunnable extends CheckedRunnable {
+ protected void realRun() throws Throwable {
+ delay(SMALL_DELAY_MS);
+ }
+ }
+
+ public class SmallPossiblyInterruptedRunnable extends CheckedRunnable {
+ protected void realRun() {
+ try {
+ delay(SMALL_DELAY_MS);
+ } catch (InterruptedException ok) {}
+ }
+ }
+
+ public class SmallCallable extends CheckedCallable {
+ protected Object realCall() throws InterruptedException {
+ delay(SMALL_DELAY_MS);
+ return Boolean.TRUE;
+ }
+ }
+
+ public class MediumRunnable extends CheckedRunnable {
+ protected void realRun() throws Throwable {
+ delay(MEDIUM_DELAY_MS);
+ }
+ }
+
+ public class MediumInterruptedRunnable extends CheckedInterruptedRunnable {
+ protected void realRun() throws InterruptedException {
+ delay(MEDIUM_DELAY_MS);
+ }
+ }
+
+ public Runnable possiblyInterruptedRunnable(final long timeoutMillis) {
+ return new CheckedRunnable() {
+ protected void realRun() {
+ try {
+ delay(timeoutMillis);
+ } catch (InterruptedException ok) {}
+ }};
+ }
+
+ public class MediumPossiblyInterruptedRunnable extends CheckedRunnable {
+ protected void realRun() {
+ try {
+ delay(MEDIUM_DELAY_MS);
+ } catch (InterruptedException ok) {}
+ }
+ }
+
+ public class LongPossiblyInterruptedRunnable extends CheckedRunnable {
+ protected void realRun() {
+ try {
+ delay(LONG_DELAY_MS);
+ } catch (InterruptedException ok) {}
+ }
+ }
+
+ /**
+ * For use as ThreadFactory in constructors
+ */
+ public static class SimpleThreadFactory implements ThreadFactory {
+ public Thread newThread(Runnable r) {
+ return new Thread(r);
+ }
+ }
+
+ public interface TrackedRunnable extends Runnable {
+ boolean isDone();
+ }
+
+ public static TrackedRunnable trackedRunnable(final long timeoutMillis) {
+ return new TrackedRunnable() {
+ private volatile boolean done = false;
+ public boolean isDone() { return done; }
+ public void run() {
+ try {
+ delay(timeoutMillis);
+ done = true;
+ } catch (InterruptedException ok) {}
+ }
+ };
+ }
+
+ public static class TrackedShortRunnable implements Runnable {
+ public volatile boolean done = false;
+ public void run() {
+ try {
+ delay(SHORT_DELAY_MS);
+ done = true;
+ } catch (InterruptedException ok) {}
+ }
+ }
+
+ public static class TrackedSmallRunnable implements Runnable {
+ public volatile boolean done = false;
+ public void run() {
+ try {
+ delay(SMALL_DELAY_MS);
+ done = true;
+ } catch (InterruptedException ok) {}
+ }
+ }
+
+ public static class TrackedMediumRunnable implements Runnable {
+ public volatile boolean done = false;
+ public void run() {
+ try {
+ delay(MEDIUM_DELAY_MS);
+ done = true;
+ } catch (InterruptedException ok) {}
+ }
+ }
+
+ public static class TrackedLongRunnable implements Runnable {
+ public volatile boolean done = false;
+ public void run() {
+ try {
+ delay(LONG_DELAY_MS);
+ done = true;
+ } catch (InterruptedException ok) {}
+ }
+ }
+
+ public static class TrackedNoOpRunnable implements Runnable {
+ public volatile boolean done = false;
+ public void run() {
+ done = true;
+ }
+ }
+
+ public static class TrackedCallable implements Callable {
+ public volatile boolean done = false;
+ public Object call() {
+ try {
+ delay(SMALL_DELAY_MS);
+ done = true;
+ } catch (InterruptedException ok) {}
+ return Boolean.TRUE;
+ }
+ }
+
+ /**
+ * Analog of CheckedRunnable for RecursiveAction
+ */
+ public abstract class CheckedRecursiveAction extends RecursiveAction {
+ protected abstract void realCompute() throws Throwable;
+
+ @Override protected final void compute() {
+ try {
+ realCompute();
+ } catch (Throwable fail) {
+ threadUnexpectedException(fail);
+ }
+ }
+ }
+
+ /**
+ * Analog of CheckedCallable for RecursiveTask
+ */
+ public abstract class CheckedRecursiveTask<T> extends RecursiveTask<T> {
+ protected abstract T realCompute() throws Throwable;
+
+ @Override protected final T compute() {
+ try {
+ return realCompute();
+ } catch (Throwable fail) {
+ threadUnexpectedException(fail);
+ return null;
+ }
+ }
+ }
+
+ /**
+ * For use as RejectedExecutionHandler in constructors
+ */
+ public static class NoOpREHandler implements RejectedExecutionHandler {
+ public void rejectedExecution(Runnable r,
+ ThreadPoolExecutor executor) {}
+ }
+
+ /**
+ * A CyclicBarrier that uses timed await and fails with
+ * AssertionFailedErrors instead of throwing checked exceptions.
+ */
+ public class CheckedBarrier extends CyclicBarrier {
+ public CheckedBarrier(int parties) { super(parties); }
+
+ public int await() {
+ try {
+ return super.await(2 * LONG_DELAY_MS, MILLISECONDS);
+ } catch (TimeoutException timedOut) {
+ throw new AssertionFailedError("timed out");
+ } catch (Exception fail) {
+ AssertionFailedError afe =
+ new AssertionFailedError("Unexpected exception: " + fail);
+ afe.initCause(fail);
+ throw afe;
+ }
+ }
+ }
+
+ void checkEmpty(BlockingQueue q) {
+ try {
+ assertTrue(q.isEmpty());
+ assertEquals(0, q.size());
+ assertNull(q.peek());
+ assertNull(q.poll());
+ assertNull(q.poll(0, MILLISECONDS));
+ assertEquals(q.toString(), "[]");
+ assertTrue(Arrays.equals(q.toArray(), new Object[0]));
+ assertFalse(q.iterator().hasNext());
+ try {
+ q.element();
+ shouldThrow();
+ } catch (NoSuchElementException success) {}
+ try {
+ q.iterator().next();
+ shouldThrow();
+ } catch (NoSuchElementException success) {}
+ try {
+ q.remove();
+ shouldThrow();
+ } catch (NoSuchElementException success) {}
+ } catch (InterruptedException fail) { threadUnexpectedException(fail); }
+ }
+
+ void assertSerialEquals(Object x, Object y) {
+ assertTrue(Arrays.equals(serialBytes(x), serialBytes(y)));
+ }
+
+ void assertNotSerialEquals(Object x, Object y) {
+ assertFalse(Arrays.equals(serialBytes(x), serialBytes(y)));
+ }
+
+ byte[] serialBytes(Object o) {
+ try {
+ ByteArrayOutputStream bos = new ByteArrayOutputStream();
+ ObjectOutputStream oos = new ObjectOutputStream(bos);
+ oos.writeObject(o);
+ oos.flush();
+ oos.close();
+ return bos.toByteArray();
+ } catch (Throwable fail) {
+ threadUnexpectedException(fail);
+ return new byte[0];
+ }
+ }
+
+ @SuppressWarnings("unchecked")
+ <T> T serialClone(T o) {
+ try {
+ ObjectInputStream ois = new ObjectInputStream
+ (new ByteArrayInputStream(serialBytes(o)));
+ T clone = (T) ois.readObject();
+ assertSame(o.getClass(), clone.getClass());
+ return clone;
+ } catch (Throwable fail) {
+ threadUnexpectedException(fail);
+ return null;
+ }
+ }
+
+ public void assertThrows(Class<? extends Throwable> expectedExceptionClass,
+ Runnable... throwingActions) {
+ for (Runnable throwingAction : throwingActions) {
+ boolean threw = false;
+ try { throwingAction.run(); }
+ catch (Throwable t) {
+ threw = true;
+ if (!expectedExceptionClass.isInstance(t)) {
+ AssertionFailedError afe =
+ new AssertionFailedError
+ ("Expected " + expectedExceptionClass.getName() +
+ ", got " + t.getClass().getName());
+ afe.initCause(t);
+ threadUnexpectedException(afe);
+ }
+ }
+ if (!threw)
+ shouldThrow(expectedExceptionClass.getName());
+ }
+ }
+
+ public void assertIteratorExhausted(Iterator<?> it) {
+ try {
+ it.next();
+ shouldThrow();
+ } catch (NoSuchElementException success) {}
+ assertFalse(it.hasNext());
+ }
+}