ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/jsr166/jsr166/src/test/tck/JSR166TestCase.java
(Generate patch)

Comparing jsr166/src/test/tck/JSR166TestCase.java (file contents):
Revision 1.247 by jsr166, Sun Jul 22 21:37:31 2018 UTC vs.
Revision 1.268 by jsr166, Sun Sep 22 01:59:57 2019 UTC

# Line 49 | Line 49 | import java.io.ByteArrayOutputStream;
49   import java.io.ObjectInputStream;
50   import java.io.ObjectOutputStream;
51   import java.lang.management.ManagementFactory;
52 + import java.lang.management.LockInfo;
53   import java.lang.management.ThreadInfo;
54   import java.lang.management.ThreadMXBean;
55   import java.lang.reflect.Constructor;
# Line 117 | Line 118 | import junit.framework.TestSuite;
118   *
119   * <ol>
120   *
121 < * <li>All assertions in code running in generated threads must use
122 < * the forms {@link #threadFail}, {@link #threadAssertTrue}, {@link
123 < * #threadAssertEquals}, or {@link #threadAssertNull}, (not
124 < * {@code fail}, {@code assertTrue}, etc.) It is OK (but not
125 < * particularly recommended) for other code to use these forms too.
126 < * Only the most typically used JUnit assertion methods are defined
127 < * this way, but enough to live with.
121 > * <li>All code not running in the main test thread (manually spawned threads
122 > * or the common fork join pool) must be checked for failure (and completion!).
123 > * Mechanisms that can be used to ensure this are:
124 > *   <ol>
125 > *   <li>Signalling via a synchronizer like AtomicInteger or CountDownLatch
126 > *    that the task completed normally, which is checked before returning from
127 > *    the test method in the main thread.
128 > *   <li>Using the forms {@link #threadFail}, {@link #threadAssertTrue},
129 > *    or {@link #threadAssertNull}, (not {@code fail}, {@code assertTrue}, etc.)
130 > *    Only the most typically used JUnit assertion methods are defined
131 > *    this way, but enough to live with.
132 > *   <li>Recording failure explicitly using {@link #threadUnexpectedException}
133 > *    or {@link #threadRecordFailure}.
134 > *   <li>Using a wrapper like CheckedRunnable that uses one the mechanisms above.
135 > *   </ol>
136   *
137   * <li>If you override {@link #setUp} or {@link #tearDown}, make sure
138   * to invoke {@code super.setUp} and {@code super.tearDown} within
# Line 235 | Line 244 | public class JSR166TestCase extends Test
244          }
245      }
246  
247 +    private static final ThreadMXBean THREAD_MXBEAN
248 +        = ManagementFactory.getThreadMXBean();
249 +
250      /**
251       * The scaling factor to apply to standard delays used in tests.
252       * May be initialized from any of:
# Line 276 | Line 288 | public class JSR166TestCase extends Test
288      static volatile TestCase currentTestCase;
289      // static volatile int currentRun = 0;
290      static {
291 <        Runnable checkForWedgedTest = new Runnable() { public void run() {
291 >        Runnable wedgedTestDetector = new Runnable() { public void run() {
292              // Avoid spurious reports with enormous runsPerTest.
293              // A single test case run should never take more than 1 second.
294              // But let's cap it at the high end too ...
295 <            final int timeoutMinutes =
296 <                Math.min(15, Math.max(runsPerTest / 60, 1));
295 >            final int timeoutMinutesMin = Math.max(runsPerTest / 60, 1)
296 >                * Math.max((int) delayFactor, 1);
297 >            final int timeoutMinutes = Math.min(15, timeoutMinutesMin);
298              for (TestCase lastTestCase = currentTestCase;;) {
299                  try { MINUTES.sleep(timeoutMinutes); }
300                  catch (InterruptedException unexpected) { break; }
# Line 301 | Line 314 | public class JSR166TestCase extends Test
314                  }
315                  lastTestCase = currentTestCase;
316              }}};
317 <        Thread thread = new Thread(checkForWedgedTest, "checkForWedgedTest");
317 >        Thread thread = new Thread(wedgedTestDetector, "WedgedTestDetector");
318          thread.setDaemon(true);
319          thread.start();
320      }
# Line 345 | Line 358 | public class JSR166TestCase extends Test
358              // Never report first run of any test; treat it as a
359              // warmup run, notably to trigger all needed classloading,
360              if (i > 0)
361 <                System.out.printf("%n%s: %d%n", toString(), elapsedMillis);
361 >                System.out.printf("%s: %d%n", toString(), elapsedMillis);
362          }
363      }
364  
# Line 452 | Line 465 | public class JSR166TestCase extends Test
465      public static boolean atLeastJava9()  { return JAVA_CLASS_VERSION >= 53.0; }
466      public static boolean atLeastJava10() { return JAVA_CLASS_VERSION >= 54.0; }
467      public static boolean atLeastJava11() { return JAVA_CLASS_VERSION >= 55.0; }
468 +    public static boolean atLeastJava12() { return JAVA_CLASS_VERSION >= 56.0; }
469 +    public static boolean atLeastJava13() { return JAVA_CLASS_VERSION >= 57.0; }
470 +    public static boolean atLeastJava14() { return JAVA_CLASS_VERSION >= 58.0; }
471 +    public static boolean atLeastJava15() { return JAVA_CLASS_VERSION >= 59.0; }
472 +    public static boolean atLeastJava16() { return JAVA_CLASS_VERSION >= 60.0; }
473 +    public static boolean atLeastJava17() { return JAVA_CLASS_VERSION >= 61.0; }
474  
475      /**
476       * Collects all JSR166 unit tests as one suite.
# Line 503 | Line 522 | public class JSR166TestCase extends Test
522              ExecutorsTest.suite(),
523              ExecutorCompletionServiceTest.suite(),
524              FutureTaskTest.suite(),
525 +            HashtableTest.suite(),
526              LinkedBlockingDequeTest.suite(),
527              LinkedBlockingQueueTest.suite(),
528              LinkedListTest.suite(),
# Line 542 | Line 562 | public class JSR166TestCase extends Test
562                  "HashMapTest",
563                  "LinkedBlockingDeque8Test",
564                  "LinkedBlockingQueue8Test",
565 +                "LinkedHashMapTest",
566                  "LongAccumulatorTest",
567                  "LongAdderTest",
568                  "SplittableRandomTest",
# Line 640 | Line 661 | public class JSR166TestCase extends Test
661      public static long MEDIUM_DELAY_MS;
662      public static long LONG_DELAY_MS;
663  
664 +    /**
665 +     * A delay significantly longer than LONG_DELAY_MS.
666 +     * Use this in a thread that is waited for via awaitTermination(Thread).
667 +     */
668 +    public static long LONGER_DELAY_MS;
669 +
670      private static final long RANDOM_TIMEOUT;
671      private static final long RANDOM_EXPIRED_TIMEOUT;
672      private static final TimeUnit RANDOM_TIMEUNIT;
# Line 668 | Line 695 | public class JSR166TestCase extends Test
695      static TimeUnit randomTimeUnit() { return RANDOM_TIMEUNIT; }
696  
697      /**
698 +     * Returns a random boolean; a "coin flip".
699 +     */
700 +    static boolean randomBoolean() {
701 +        return ThreadLocalRandom.current().nextBoolean();
702 +    }
703 +
704 +    /**
705 +     * Returns a random element from given choices.
706 +     */
707 +    <T> T chooseRandomly(T... choices) {
708 +        return choices[ThreadLocalRandom.current().nextInt(choices.length)];
709 +    }
710 +
711 +    /**
712       * Returns the shortest timed delay. This can be scaled up for
713       * slow machines using the jsr166.delay.factor system property,
714       * or via jtreg's -timeoutFactor: flag.
# Line 685 | Line 726 | public class JSR166TestCase extends Test
726          SMALL_DELAY_MS  = SHORT_DELAY_MS * 5;
727          MEDIUM_DELAY_MS = SHORT_DELAY_MS * 10;
728          LONG_DELAY_MS   = SHORT_DELAY_MS * 200;
729 +        LONGER_DELAY_MS = 2 * LONG_DELAY_MS;
730      }
731  
732      private static final long TIMEOUT_DELAY_MS
# Line 723 | Line 765 | public class JSR166TestCase extends Test
765       */
766      public void threadRecordFailure(Throwable t) {
767          System.err.println(t);
768 <        dumpTestThreads();
769 <        threadFailure.compareAndSet(null, t);
768 >        if (threadFailure.compareAndSet(null, t))
769 >            dumpTestThreads();
770      }
771  
772      public void setUp() {
# Line 1045 | Line 1087 | public class JSR166TestCase extends Test
1087          }
1088      }
1089  
1090 +    /** Returns true if thread info might be useful in a thread dump. */
1091 +    static boolean threadOfInterest(ThreadInfo info) {
1092 +        final String name = info.getThreadName();
1093 +        String lockName;
1094 +        if (name == null)
1095 +            return true;
1096 +        if (name.equals("Signal Dispatcher")
1097 +            || name.equals("WedgedTestDetector"))
1098 +            return false;
1099 +        if (name.equals("Reference Handler")) {
1100 +            // Reference Handler stacktrace changed in JDK-8156500
1101 +            StackTraceElement[] stackTrace; String methodName;
1102 +            if ((stackTrace = info.getStackTrace()) != null
1103 +                && stackTrace.length > 0
1104 +                && (methodName = stackTrace[0].getMethodName()) != null
1105 +                && methodName.equals("waitForReferencePendingList"))
1106 +                return false;
1107 +            // jdk8 Reference Handler stacktrace
1108 +            if ((lockName = info.getLockName()) != null
1109 +                && lockName.startsWith("java.lang.ref"))
1110 +                return false;
1111 +        }
1112 +        if ((name.equals("Finalizer") || name.equals("Common-Cleaner"))
1113 +            && (lockName = info.getLockName()) != null
1114 +            && lockName.startsWith("java.lang.ref"))
1115 +            return false;
1116 +        if (name.startsWith("ForkJoinPool.commonPool-worker")
1117 +            && (lockName = info.getLockName()) != null
1118 +            && lockName.startsWith("java.util.concurrent.ForkJoinPool"))
1119 +            return false;
1120 +        return true;
1121 +    }
1122 +
1123      /**
1124       * A debugging tool to print stack traces of most threads, as jstack does.
1125       * Uninteresting threads are filtered out.
# Line 1059 | Line 1134 | public class JSR166TestCase extends Test
1134              }
1135          }
1136  
1062        ThreadMXBean threadMXBean = ManagementFactory.getThreadMXBean();
1137          System.err.println("------ stacktrace dump start ------");
1138 <        for (ThreadInfo info : threadMXBean.dumpAllThreads(true, true)) {
1139 <            final String name = info.getThreadName();
1140 <            String lockName;
1067 <            if ("Signal Dispatcher".equals(name))
1068 <                continue;
1069 <            if ("Reference Handler".equals(name)
1070 <                && (lockName = info.getLockName()) != null
1071 <                && lockName.startsWith("java.lang.ref.Reference$Lock"))
1072 <                continue;
1073 <            if ("Finalizer".equals(name)
1074 <                && (lockName = info.getLockName()) != null
1075 <                && lockName.startsWith("java.lang.ref.ReferenceQueue$Lock"))
1076 <                continue;
1077 <            if ("checkForWedgedTest".equals(name))
1078 <                continue;
1079 <            System.err.print(info);
1080 <        }
1138 >        for (ThreadInfo info : THREAD_MXBEAN.dumpAllThreads(true, true))
1139 >            if (threadOfInterest(info))
1140 >                System.err.print(info);
1141          System.err.println("------ stacktrace dump end ------");
1142  
1143          if (sm != null) System.setSecurityManager(sm);
# Line 1104 | Line 1164 | public class JSR166TestCase extends Test
1164      }
1165  
1166      /**
1167 +     * Returns the thread's blocker's class name, if any, else null.
1168 +     */
1169 +    String blockerClassName(Thread thread) {
1170 +        ThreadInfo threadInfo; LockInfo lockInfo;
1171 +        if ((threadInfo = THREAD_MXBEAN.getThreadInfo(thread.getId(), 0)) != null
1172 +            && (lockInfo = threadInfo.getLockInfo()) != null)
1173 +            return lockInfo.getClassName();
1174 +        return null;
1175 +    }
1176 +
1177 +    /**
1178       * Checks that future.get times out, with the default timeout of
1179       * {@code timeoutMillis()}.
1180       */
# Line 1291 | Line 1362 | public class JSR166TestCase extends Test
1362      /**
1363       * Spin-waits up to the specified number of milliseconds for the given
1364       * thread to enter a wait state: BLOCKED, WAITING, or TIMED_WAITING.
1365 +     * @param waitingForGodot if non-null, an additional condition to satisfy
1366       */
1367 <    void waitForThreadToEnterWaitState(Thread thread, long timeoutMillis) {
1368 <        long startTime = 0L;
1369 <        for (;;) {
1370 <            Thread.State s = thread.getState();
1371 <            if (s == Thread.State.BLOCKED ||
1372 <                s == Thread.State.WAITING ||
1373 <                s == Thread.State.TIMED_WAITING)
1374 <                return;
1375 <            else if (s == Thread.State.TERMINATED)
1367 >    void waitForThreadToEnterWaitState(Thread thread, long timeoutMillis,
1368 >                                       Callable<Boolean> waitingForGodot) {
1369 >        for (long startTime = 0L;;) {
1370 >            switch (thread.getState()) {
1371 >            default: break;
1372 >            case BLOCKED: case WAITING: case TIMED_WAITING:
1373 >                try {
1374 >                    if (waitingForGodot == null || waitingForGodot.call())
1375 >                        return;
1376 >                } catch (Throwable fail) { threadUnexpectedException(fail); }
1377 >                break;
1378 >            case TERMINATED:
1379                  fail("Unexpected thread termination");
1380 <            else if (startTime == 0L)
1380 >            }
1381 >
1382 >            if (startTime == 0L)
1383                  startTime = System.nanoTime();
1384              else if (millisElapsedSince(startTime) > timeoutMillis) {
1385 <                threadAssertTrue(thread.isAlive());
1386 <                fail("timed out waiting for thread to enter wait state");
1385 >                assertTrue(thread.isAlive());
1386 >                if (waitingForGodot == null
1387 >                    || thread.getState() == Thread.State.RUNNABLE)
1388 >                    fail("timed out waiting for thread to enter wait state");
1389 >                else
1390 >                    fail("timed out waiting for condition, thread state="
1391 >                         + thread.getState());
1392              }
1393              Thread.yield();
1394          }
# Line 1314 | Line 1396 | public class JSR166TestCase extends Test
1396  
1397      /**
1398       * Spin-waits up to the specified number of milliseconds for the given
1399 <     * thread to enter a wait state: BLOCKED, WAITING, or TIMED_WAITING,
1318 <     * and additionally satisfy the given condition.
1399 >     * thread to enter a wait state: BLOCKED, WAITING, or TIMED_WAITING.
1400       */
1401 <    void waitForThreadToEnterWaitState(
1402 <        Thread thread, long timeoutMillis, Callable<Boolean> waitingForGodot) {
1322 <        long startTime = 0L;
1323 <        for (;;) {
1324 <            Thread.State s = thread.getState();
1325 <            if (s == Thread.State.BLOCKED ||
1326 <                s == Thread.State.WAITING ||
1327 <                s == Thread.State.TIMED_WAITING) {
1328 <                try {
1329 <                    if (waitingForGodot.call())
1330 <                        return;
1331 <                } catch (Throwable fail) { threadUnexpectedException(fail); }
1332 <            }
1333 <            else if (s == Thread.State.TERMINATED)
1334 <                fail("Unexpected thread termination");
1335 <            else if (startTime == 0L)
1336 <                startTime = System.nanoTime();
1337 <            else if (millisElapsedSince(startTime) > timeoutMillis) {
1338 <                threadAssertTrue(thread.isAlive());
1339 <                fail("timed out waiting for thread to enter wait state");
1340 <            }
1341 <            Thread.yield();
1342 <        }
1401 >    void waitForThreadToEnterWaitState(Thread thread, long timeoutMillis) {
1402 >        waitForThreadToEnterWaitState(thread, timeoutMillis, null);
1403      }
1404  
1405      /**
# Line 1347 | Line 1407 | public class JSR166TestCase extends Test
1407       * enter a wait state: BLOCKED, WAITING, or TIMED_WAITING.
1408       */
1409      void waitForThreadToEnterWaitState(Thread thread) {
1410 <        waitForThreadToEnterWaitState(thread, LONG_DELAY_MS);
1410 >        waitForThreadToEnterWaitState(thread, LONG_DELAY_MS, null);
1411      }
1412  
1413      /**
# Line 1355 | Line 1415 | public class JSR166TestCase extends Test
1415       * enter a wait state: BLOCKED, WAITING, or TIMED_WAITING,
1416       * and additionally satisfy the given condition.
1417       */
1418 <    void waitForThreadToEnterWaitState(
1419 <        Thread thread, Callable<Boolean> waitingForGodot) {
1418 >    void waitForThreadToEnterWaitState(Thread thread,
1419 >                                       Callable<Boolean> waitingForGodot) {
1420          waitForThreadToEnterWaitState(thread, LONG_DELAY_MS, waitingForGodot);
1421      }
1422  
1423      /**
1424 +     * Spin-waits up to LONG_DELAY_MS milliseconds for the current thread to
1425 +     * be interrupted.  Clears the interrupt status before returning.
1426 +     */
1427 +    void awaitInterrupted() {
1428 +        for (long startTime = 0L; !Thread.interrupted(); ) {
1429 +            if (startTime == 0L)
1430 +                startTime = System.nanoTime();
1431 +            else if (millisElapsedSince(startTime) > LONG_DELAY_MS)
1432 +                fail("timed out waiting for thread interrupt");
1433 +            Thread.yield();
1434 +        }
1435 +    }
1436 +
1437 +    /**
1438       * Returns the number of milliseconds since time given by
1439       * startNanoTime, which must have been previously returned from a
1440       * call to {@link System#nanoTime()}.
# Line 1369 | Line 1443 | public class JSR166TestCase extends Test
1443          return NANOSECONDS.toMillis(System.nanoTime() - startNanoTime);
1444      }
1445  
1372 //     void assertTerminatesPromptly(long timeoutMillis, Runnable r) {
1373 //         long startTime = System.nanoTime();
1374 //         try {
1375 //             r.run();
1376 //         } catch (Throwable fail) { threadUnexpectedException(fail); }
1377 //         if (millisElapsedSince(startTime) > timeoutMillis/2)
1378 //             throw new AssertionError("did not return promptly");
1379 //     }
1380
1381 //     void assertTerminatesPromptly(Runnable r) {
1382 //         assertTerminatesPromptly(LONG_DELAY_MS/2, r);
1383 //     }
1384
1446      /**
1447       * Checks that timed f.get() returns the expected value, and does not
1448       * wait for the timeout to elapse before returning.
# Line 1412 | Line 1473 | public class JSR166TestCase extends Test
1473      }
1474  
1475      /**
1476 +     * Returns a new started daemon Thread running the given action,
1477 +     * wrapped in a CheckedRunnable.
1478 +     */
1479 +    Thread newStartedThread(Action action) {
1480 +        return newStartedThread(checkedRunnable(action));
1481 +    }
1482 +
1483 +    /**
1484       * Waits for the specified time (in milliseconds) for the thread
1485       * to terminate (using {@link Thread#join(long)}), else interrupts
1486       * the thread (in the hope that it may terminate later) and fails.
1487       */
1488 <    void awaitTermination(Thread t, long timeoutMillis) {
1488 >    void awaitTermination(Thread thread, long timeoutMillis) {
1489          try {
1490 <            t.join(timeoutMillis);
1490 >            thread.join(timeoutMillis);
1491          } catch (InterruptedException fail) {
1492              threadUnexpectedException(fail);
1493 <        } finally {
1494 <            if (t.getState() != Thread.State.TERMINATED) {
1495 <                t.interrupt();
1496 <                threadFail("timed out waiting for thread to terminate");
1493 >        }
1494 >        if (thread.getState() != Thread.State.TERMINATED) {
1495 >            String detail = String.format(
1496 >                    "timed out waiting for thread to terminate, thread=%s, state=%s" ,
1497 >                    thread, thread.getState());
1498 >            try {
1499 >                threadFail(detail);
1500 >            } finally {
1501 >                // Interrupt thread __after__ having reported its stack trace
1502 >                thread.interrupt();
1503              }
1504          }
1505      }
# Line 1452 | Line 1527 | public class JSR166TestCase extends Test
1527          }
1528      }
1529  
1530 +    Runnable checkedRunnable(Action action) {
1531 +        return new CheckedRunnable() {
1532 +            public void realRun() throws Throwable {
1533 +                action.run();
1534 +            }};
1535 +    }
1536 +
1537      public abstract class ThreadShouldThrow extends Thread {
1538          protected abstract void realRun() throws Throwable;
1539  
# Line 1464 | Line 1546 | public class JSR166TestCase extends Test
1546          public final void run() {
1547              try {
1548                  realRun();
1467                threadShouldThrow(exceptionClass.getSimpleName());
1549              } catch (Throwable t) {
1550                  if (! exceptionClass.isInstance(t))
1551                      threadUnexpectedException(t);
1552 +                return;
1553              }
1554 +            threadShouldThrow(exceptionClass.getSimpleName());
1555          }
1556      }
1557  
# Line 1478 | Line 1561 | public class JSR166TestCase extends Test
1561          public final void run() {
1562              try {
1563                  realRun();
1481                threadShouldThrow("InterruptedException");
1564              } catch (InterruptedException success) {
1565                  threadAssertFalse(Thread.interrupted());
1566 +                return;
1567              } catch (Throwable fail) {
1568                  threadUnexpectedException(fail);
1569              }
1570 +            threadShouldThrow("InterruptedException");
1571          }
1572      }
1573  
# Line 1495 | Line 1579 | public class JSR166TestCase extends Test
1579                  return realCall();
1580              } catch (Throwable fail) {
1581                  threadUnexpectedException(fail);
1498                return null;
1499            }
1500        }
1501    }
1502
1503    public abstract class CheckedInterruptedCallable<T>
1504        implements Callable<T> {
1505        protected abstract T realCall() throws Throwable;
1506
1507        public final T call() {
1508            try {
1509                T result = realCall();
1510                threadShouldThrow("InterruptedException");
1511                return result;
1512            } catch (InterruptedException success) {
1513                threadAssertFalse(Thread.interrupted());
1514            } catch (Throwable fail) {
1515                threadUnexpectedException(fail);
1582              }
1583 <            return null;
1583 >            throw new AssertionError("unreached");
1584          }
1585      }
1586  
# Line 1629 | Line 1695 | public class JSR166TestCase extends Test
1695          public String call() { throw new NullPointerException(); }
1696      }
1697  
1632    public class SmallPossiblyInterruptedRunnable extends CheckedRunnable {
1633        protected void realRun() {
1634            try {
1635                delay(SMALL_DELAY_MS);
1636            } catch (InterruptedException ok) {}
1637        }
1638    }
1639
1698      public Runnable possiblyInterruptedRunnable(final long timeoutMillis) {
1699          return new CheckedRunnable() {
1700              protected void realRun() {
# Line 1692 | Line 1750 | public class JSR166TestCase extends Test
1750                  return realCompute();
1751              } catch (Throwable fail) {
1752                  threadUnexpectedException(fail);
1695                return null;
1753              }
1754 +            throw new AssertionError("unreached");
1755          }
1756      }
1757  
# Line 1770 | Line 1828 | public class JSR166TestCase extends Test
1828          }
1829      }
1830  
1831 <    void assertImmutable(final Object o) {
1831 >    void assertImmutable(Object o) {
1832          if (o instanceof Collection) {
1833              assertThrows(
1834                  UnsupportedOperationException.class,
1835 <                new Runnable() { public void run() {
1778 <                        ((Collection) o).add(null);}});
1835 >                () -> ((Collection) o).add(null));
1836          }
1837      }
1838  
# Line 1835 | Line 1892 | public class JSR166TestCase extends Test
1892      }
1893  
1894      public void assertThrows(Class<? extends Throwable> expectedExceptionClass,
1895 <                             Runnable... throwingActions) {
1896 <        for (Runnable throwingAction : throwingActions) {
1895 >                             Action... throwingActions) {
1896 >        for (Action throwingAction : throwingActions) {
1897              boolean threw = false;
1898              try { throwingAction.run(); }
1899              catch (Throwable t) {

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines