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.245 by jsr166, Sun Jul 22 21:19:14 2018 UTC vs.
Revision 1.266 by jsr166, Sat Sep 7 17:40:05 2019 UTC

# Line 117 | Line 117 | import junit.framework.TestSuite;
117   *
118   * <ol>
119   *
120 < * <li>All assertions in code running in generated threads must use
121 < * the forms {@link #threadFail}, {@link #threadAssertTrue}, {@link
122 < * #threadAssertEquals}, or {@link #threadAssertNull}, (not
123 < * {@code fail}, {@code assertTrue}, etc.) It is OK (but not
124 < * particularly recommended) for other code to use these forms too.
125 < * Only the most typically used JUnit assertion methods are defined
126 < * this way, but enough to live with.
120 > * <li>All code not running in the main test thread (manually spawned threads
121 > * or the common fork join pool) must be checked for failure (and completion!).
122 > * Mechanisms that can be used to ensure this are:
123 > *   <ol>
124 > *   <li>Signalling via a synchronizer like AtomicInteger or CountDownLatch
125 > *    that the task completed normally, which is checked before returning from
126 > *    the test method in the main thread.
127 > *   <li>Using the forms {@link #threadFail}, {@link #threadAssertTrue},
128 > *    or {@link #threadAssertNull}, (not {@code fail}, {@code assertTrue}, etc.)
129 > *    Only the most typically used JUnit assertion methods are defined
130 > *    this way, but enough to live with.
131 > *   <li>Recording failure explicitly using {@link #threadUnexpectedException}
132 > *    or {@link #threadRecordFailure}.
133 > *   <li>Using a wrapper like CheckedRunnable that uses one the mechanisms above.
134 > *   </ol>
135   *
136   * <li>If you override {@link #setUp} or {@link #tearDown}, make sure
137   * to invoke {@code super.setUp} and {@code super.tearDown} within
# Line 276 | Line 284 | public class JSR166TestCase extends Test
284      static volatile TestCase currentTestCase;
285      // static volatile int currentRun = 0;
286      static {
287 <        Runnable checkForWedgedTest = new Runnable() { public void run() {
287 >        Runnable wedgedTestDetector = new Runnable() { public void run() {
288              // Avoid spurious reports with enormous runsPerTest.
289              // A single test case run should never take more than 1 second.
290              // But let's cap it at the high end too ...
291 <            final int timeoutMinutes =
292 <                Math.min(15, Math.max(runsPerTest / 60, 1));
291 >            final int timeoutMinutesMin = Math.max(runsPerTest / 60, 1)
292 >                * Math.max((int) delayFactor, 1);
293 >            final int timeoutMinutes = Math.min(15, timeoutMinutesMin);
294              for (TestCase lastTestCase = currentTestCase;;) {
295                  try { MINUTES.sleep(timeoutMinutes); }
296                  catch (InterruptedException unexpected) { break; }
# Line 301 | Line 310 | public class JSR166TestCase extends Test
310                  }
311                  lastTestCase = currentTestCase;
312              }}};
313 <        Thread thread = new Thread(checkForWedgedTest, "checkForWedgedTest");
313 >        Thread thread = new Thread(wedgedTestDetector, "WedgedTestDetector");
314          thread.setDaemon(true);
315          thread.start();
316      }
# Line 452 | Line 461 | public class JSR166TestCase extends Test
461      public static boolean atLeastJava9()  { return JAVA_CLASS_VERSION >= 53.0; }
462      public static boolean atLeastJava10() { return JAVA_CLASS_VERSION >= 54.0; }
463      public static boolean atLeastJava11() { return JAVA_CLASS_VERSION >= 55.0; }
464 +    public static boolean atLeastJava12() { return JAVA_CLASS_VERSION >= 56.0; }
465 +    public static boolean atLeastJava13() { return JAVA_CLASS_VERSION >= 57.0; }
466 +    public static boolean atLeastJava14() { return JAVA_CLASS_VERSION >= 58.0; }
467 +    public static boolean atLeastJava15() { return JAVA_CLASS_VERSION >= 59.0; }
468 +    public static boolean atLeastJava16() { return JAVA_CLASS_VERSION >= 60.0; }
469 +    public static boolean atLeastJava17() { return JAVA_CLASS_VERSION >= 61.0; }
470  
471      /**
472       * Collects all JSR166 unit tests as one suite.
# Line 503 | Line 518 | public class JSR166TestCase extends Test
518              ExecutorsTest.suite(),
519              ExecutorCompletionServiceTest.suite(),
520              FutureTaskTest.suite(),
521 +            HashtableTest.suite(),
522              LinkedBlockingDequeTest.suite(),
523              LinkedBlockingQueueTest.suite(),
524              LinkedListTest.suite(),
# Line 542 | Line 558 | public class JSR166TestCase extends Test
558                  "HashMapTest",
559                  "LinkedBlockingDeque8Test",
560                  "LinkedBlockingQueue8Test",
561 +                "LinkedHashMapTest",
562                  "LongAccumulatorTest",
563                  "LongAdderTest",
564                  "SplittableRandomTest",
# Line 640 | Line 657 | public class JSR166TestCase extends Test
657      public static long MEDIUM_DELAY_MS;
658      public static long LONG_DELAY_MS;
659  
660 +    /**
661 +     * A delay significantly longer than LONG_DELAY_MS.
662 +     * Use this in a thread that is waited for via awaitTermination(Thread).
663 +     */
664 +    public static long LONGER_DELAY_MS;
665 +
666      private static final long RANDOM_TIMEOUT;
667      private static final long RANDOM_EXPIRED_TIMEOUT;
668      private static final TimeUnit RANDOM_TIMEUNIT;
# Line 668 | Line 691 | public class JSR166TestCase extends Test
691      static TimeUnit randomTimeUnit() { return RANDOM_TIMEUNIT; }
692  
693      /**
694 +     * Returns a random boolean; a "coin flip".
695 +     */
696 +    static boolean randomBoolean() {
697 +        return ThreadLocalRandom.current().nextBoolean();
698 +    }
699 +
700 +    /**
701 +     * Returns a random element from given choices.
702 +     */
703 +    <T> T chooseRandomly(T... choices) {
704 +        return choices[ThreadLocalRandom.current().nextInt(choices.length)];
705 +    }
706 +
707 +    /**
708       * Returns the shortest timed delay. This can be scaled up for
709       * slow machines using the jsr166.delay.factor system property,
710       * or via jtreg's -timeoutFactor: flag.
# Line 685 | Line 722 | public class JSR166TestCase extends Test
722          SMALL_DELAY_MS  = SHORT_DELAY_MS * 5;
723          MEDIUM_DELAY_MS = SHORT_DELAY_MS * 10;
724          LONG_DELAY_MS   = SHORT_DELAY_MS * 200;
725 +        LONGER_DELAY_MS = 2 * LONG_DELAY_MS;
726      }
727  
728      private static final long TIMEOUT_DELAY_MS
# Line 723 | Line 761 | public class JSR166TestCase extends Test
761       */
762      public void threadRecordFailure(Throwable t) {
763          System.err.println(t);
764 <        dumpTestThreads();
765 <        threadFailure.compareAndSet(null, t);
764 >        if (threadFailure.compareAndSet(null, t))
765 >            dumpTestThreads();
766      }
767  
768      public void setUp() {
# Line 1045 | Line 1083 | public class JSR166TestCase extends Test
1083          }
1084      }
1085  
1086 +    /** Returns true if thread info might be useful in a thread dump. */
1087 +    static boolean threadOfInterest(ThreadInfo info) {
1088 +        final String name = info.getThreadName();
1089 +        String lockName;
1090 +        if (name == null)
1091 +            return true;
1092 +        if (name.equals("Signal Dispatcher")
1093 +            || name.equals("WedgedTestDetector"))
1094 +            return false;
1095 +        if (name.equals("Reference Handler")) {
1096 +            // Reference Handler stacktrace changed in JDK-8156500
1097 +            StackTraceElement[] stackTrace; String methodName;
1098 +            if ((stackTrace = info.getStackTrace()) != null
1099 +                && stackTrace.length > 0
1100 +                && (methodName = stackTrace[0].getMethodName()) != null
1101 +                && methodName.equals("waitForReferencePendingList"))
1102 +                return false;
1103 +            // jdk8 Reference Handler stacktrace
1104 +            if ((lockName = info.getLockName()) != null
1105 +                && lockName.startsWith("java.lang.ref"))
1106 +                return false;
1107 +        }
1108 +        if ((name.equals("Finalizer") || name.equals("Common-Cleaner"))
1109 +            && (lockName = info.getLockName()) != null
1110 +            && lockName.startsWith("java.lang.ref"))
1111 +            return false;
1112 +        if (name.startsWith("ForkJoinPool.commonPool-worker")
1113 +            && (lockName = info.getLockName()) != null
1114 +            && lockName.startsWith("java.util.concurrent.ForkJoinPool"))
1115 +            return false;
1116 +        return true;
1117 +    }
1118 +
1119      /**
1120       * A debugging tool to print stack traces of most threads, as jstack does.
1121       * Uninteresting threads are filtered out.
# Line 1061 | Line 1132 | public class JSR166TestCase extends Test
1132  
1133          ThreadMXBean threadMXBean = ManagementFactory.getThreadMXBean();
1134          System.err.println("------ stacktrace dump start ------");
1135 <        for (ThreadInfo info : threadMXBean.dumpAllThreads(true, true)) {
1136 <            final String name = info.getThreadName();
1137 <            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 <        }
1135 >        for (ThreadInfo info : threadMXBean.dumpAllThreads(true, true))
1136 >            if (threadOfInterest(info))
1137 >                System.err.print(info);
1138          System.err.println("------ stacktrace dump end ------");
1139  
1140          if (sm != null) System.setSecurityManager(sm);
# Line 1291 | Line 1348 | public class JSR166TestCase extends Test
1348      /**
1349       * Spin-waits up to the specified number of milliseconds for the given
1350       * thread to enter a wait state: BLOCKED, WAITING, or TIMED_WAITING.
1351 +     * @param waitingForGodot if non-null, an additional condition to satisfy
1352       */
1353 <    void waitForThreadToEnterWaitState(Thread thread, long timeoutMillis) {
1354 <        long startTime = 0L;
1355 <        for (;;) {
1356 <            Thread.State s = thread.getState();
1357 <            if (s == Thread.State.BLOCKED ||
1358 <                s == Thread.State.WAITING ||
1359 <                s == Thread.State.TIMED_WAITING)
1360 <                return;
1361 <            else if (s == Thread.State.TERMINATED)
1353 >    void waitForThreadToEnterWaitState(Thread thread, long timeoutMillis,
1354 >                                       Callable<Boolean> waitingForGodot) {
1355 >        for (long startTime = 0L;;) {
1356 >            switch (thread.getState()) {
1357 >            default: break;
1358 >            case BLOCKED: case WAITING: case TIMED_WAITING:
1359 >                try {
1360 >                    if (waitingForGodot == null || waitingForGodot.call())
1361 >                        return;
1362 >                } catch (Throwable fail) { threadUnexpectedException(fail); }
1363 >                break;
1364 >            case TERMINATED:
1365                  fail("Unexpected thread termination");
1366 <            else if (startTime == 0L)
1366 >            }
1367 >
1368 >            if (startTime == 0L)
1369                  startTime = System.nanoTime();
1370              else if (millisElapsedSince(startTime) > timeoutMillis) {
1371 <                threadAssertTrue(thread.isAlive());
1372 <                fail("timed out waiting for thread to enter wait state");
1371 >                assertTrue(thread.isAlive());
1372 >                if (waitingForGodot == null
1373 >                    || thread.getState() == Thread.State.RUNNABLE)
1374 >                    fail("timed out waiting for thread to enter wait state");
1375 >                else
1376 >                    fail("timed out waiting for condition, thread state="
1377 >                         + thread.getState());
1378              }
1379              Thread.yield();
1380          }
# Line 1314 | Line 1382 | public class JSR166TestCase extends Test
1382  
1383      /**
1384       * Spin-waits up to the specified number of milliseconds for the given
1385 <     * thread to enter a wait state: BLOCKED, WAITING, or TIMED_WAITING,
1318 <     * and additionally satisfy the given condition.
1385 >     * thread to enter a wait state: BLOCKED, WAITING, or TIMED_WAITING.
1386       */
1387 <    void waitForThreadToEnterWaitState(
1388 <        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 <        }
1387 >    void waitForThreadToEnterWaitState(Thread thread, long timeoutMillis) {
1388 >        waitForThreadToEnterWaitState(thread, timeoutMillis, null);
1389      }
1390  
1391      /**
# Line 1347 | Line 1393 | public class JSR166TestCase extends Test
1393       * enter a wait state: BLOCKED, WAITING, or TIMED_WAITING.
1394       */
1395      void waitForThreadToEnterWaitState(Thread thread) {
1396 <        waitForThreadToEnterWaitState(thread, LONG_DELAY_MS);
1396 >        waitForThreadToEnterWaitState(thread, LONG_DELAY_MS, null);
1397      }
1398  
1399      /**
# Line 1355 | Line 1401 | public class JSR166TestCase extends Test
1401       * enter a wait state: BLOCKED, WAITING, or TIMED_WAITING,
1402       * and additionally satisfy the given condition.
1403       */
1404 <    void waitForThreadToEnterWaitState(
1405 <        Thread thread, Callable<Boolean> waitingForGodot) {
1404 >    void waitForThreadToEnterWaitState(Thread thread,
1405 >                                       Callable<Boolean> waitingForGodot) {
1406          waitForThreadToEnterWaitState(thread, LONG_DELAY_MS, waitingForGodot);
1407      }
1408  
1409      /**
1410 +     * Spin-waits up to LONG_DELAY_MS milliseconds for the current thread to
1411 +     * be interrupted.  Clears the interrupt status before returning.
1412 +     */
1413 +    void awaitInterrupted() {
1414 +        for (long startTime = 0L; !Thread.interrupted(); ) {
1415 +            if (startTime == 0L)
1416 +                startTime = System.nanoTime();
1417 +            else if (millisElapsedSince(startTime) > LONG_DELAY_MS)
1418 +                fail("timed out waiting for thread interrupt");
1419 +            Thread.yield();
1420 +        }
1421 +    }
1422 +
1423 +    /**
1424       * Returns the number of milliseconds since time given by
1425       * startNanoTime, which must have been previously returned from a
1426       * call to {@link System#nanoTime()}.
# Line 1369 | Line 1429 | public class JSR166TestCase extends Test
1429          return NANOSECONDS.toMillis(System.nanoTime() - startNanoTime);
1430      }
1431  
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
1432      /**
1433       * Checks that timed f.get() returns the expected value, and does not
1434       * wait for the timeout to elapse before returning.
# Line 1416 | Line 1463 | public class JSR166TestCase extends Test
1463       * to terminate (using {@link Thread#join(long)}), else interrupts
1464       * the thread (in the hope that it may terminate later) and fails.
1465       */
1466 <    void awaitTermination(Thread t, long timeoutMillis) {
1466 >    void awaitTermination(Thread thread, long timeoutMillis) {
1467          try {
1468 <            t.join(timeoutMillis);
1468 >            thread.join(timeoutMillis);
1469          } catch (InterruptedException fail) {
1470              threadUnexpectedException(fail);
1471 <        } finally {
1472 <            if (t.getState() != Thread.State.TERMINATED) {
1473 <                t.interrupt();
1474 <                threadFail("timed out waiting for thread to terminate");
1471 >        }
1472 >        if (thread.getState() != Thread.State.TERMINATED) {
1473 >            String detail = String.format(
1474 >                    "timed out waiting for thread to terminate, thread=%s, state=%s" ,
1475 >                    thread, thread.getState());
1476 >            try {
1477 >                threadFail(detail);
1478 >            } finally {
1479 >                // Interrupt thread __after__ having reported its stack trace
1480 >                thread.interrupt();
1481              }
1482          }
1483      }
# Line 1464 | Line 1517 | public class JSR166TestCase extends Test
1517          public final void run() {
1518              try {
1519                  realRun();
1467                threadShouldThrow(exceptionClass.getSimpleName());
1520              } catch (Throwable t) {
1521                  if (! exceptionClass.isInstance(t))
1522                      threadUnexpectedException(t);
1523 +                return;
1524              }
1525 +            threadShouldThrow(exceptionClass.getSimpleName());
1526          }
1527      }
1528  
# Line 1478 | Line 1532 | public class JSR166TestCase extends Test
1532          public final void run() {
1533              try {
1534                  realRun();
1481                threadShouldThrow("InterruptedException");
1535              } catch (InterruptedException success) {
1536                  threadAssertFalse(Thread.interrupted());
1537 +                return;
1538              } catch (Throwable fail) {
1539                  threadUnexpectedException(fail);
1540              }
1541 +            threadShouldThrow("InterruptedException");
1542          }
1543      }
1544  
# Line 1495 | Line 1550 | public class JSR166TestCase extends Test
1550                  return realCall();
1551              } catch (Throwable fail) {
1552                  threadUnexpectedException(fail);
1498                return null;
1553              }
1554 <        }
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);
1516 <            }
1517 <            return null;
1554 >            throw new AssertionError("unreached");
1555          }
1556      }
1557  
# Line 1571 | Line 1608 | public class JSR166TestCase extends Test
1608      }
1609  
1610      public void await(CountDownLatch latch, long timeoutMillis) {
1611 +        boolean timedOut = false;
1612          try {
1613 <            if (!latch.await(timeoutMillis, MILLISECONDS))
1576 <                fail("timed out waiting for CountDownLatch for "
1577 <                     + (timeoutMillis/1000) + " sec");
1613 >            timedOut = !latch.await(timeoutMillis, MILLISECONDS);
1614          } catch (Throwable fail) {
1615              threadUnexpectedException(fail);
1616          }
1617 +        if (timedOut)
1618 +            fail("timed out waiting for CountDownLatch for "
1619 +                 + (timeoutMillis/1000) + " sec");
1620      }
1621  
1622      public void await(CountDownLatch latch) {
# Line 1585 | Line 1624 | public class JSR166TestCase extends Test
1624      }
1625  
1626      public void await(Semaphore semaphore) {
1627 +        boolean timedOut = false;
1628          try {
1629 <            if (!semaphore.tryAcquire(LONG_DELAY_MS, MILLISECONDS))
1590 <                fail("timed out waiting for Semaphore for "
1591 <                     + (LONG_DELAY_MS/1000) + " sec");
1629 >            timedOut = !semaphore.tryAcquire(LONG_DELAY_MS, MILLISECONDS);
1630          } catch (Throwable fail) {
1631              threadUnexpectedException(fail);
1632          }
1633 +        if (timedOut)
1634 +            fail("timed out waiting for Semaphore for "
1635 +                 + (LONG_DELAY_MS/1000) + " sec");
1636      }
1637  
1638      public void await(CyclicBarrier barrier) {
# Line 1625 | Line 1666 | public class JSR166TestCase extends Test
1666          public String call() { throw new NullPointerException(); }
1667      }
1668  
1628    public class SmallPossiblyInterruptedRunnable extends CheckedRunnable {
1629        protected void realRun() {
1630            try {
1631                delay(SMALL_DELAY_MS);
1632            } catch (InterruptedException ok) {}
1633        }
1634    }
1635
1669      public Runnable possiblyInterruptedRunnable(final long timeoutMillis) {
1670          return new CheckedRunnable() {
1671              protected void realRun() {
# Line 1688 | Line 1721 | public class JSR166TestCase extends Test
1721                  return realCompute();
1722              } catch (Throwable fail) {
1723                  threadUnexpectedException(fail);
1691                return null;
1724              }
1725 +            throw new AssertionError("unreached");
1726          }
1727      }
1728  
# Line 1766 | Line 1799 | public class JSR166TestCase extends Test
1799          }
1800      }
1801  
1802 <    void assertImmutable(final Object o) {
1802 >    void assertImmutable(Object o) {
1803          if (o instanceof Collection) {
1804              assertThrows(
1805                  UnsupportedOperationException.class,
1806 <                new Runnable() { public void run() {
1774 <                        ((Collection) o).add(null);}});
1806 >                () -> ((Collection) o).add(null));
1807          }
1808      }
1809  
1810      @SuppressWarnings("unchecked")
1811      <T> T serialClone(T o) {
1812 +        T clone = null;
1813          try {
1814              ObjectInputStream ois = new ObjectInputStream
1815                  (new ByteArrayInputStream(serialBytes(o)));
1816 <            T clone = (T) ois.readObject();
1784 <            if (o == clone) assertImmutable(o);
1785 <            assertSame(o.getClass(), clone.getClass());
1786 <            return clone;
1816 >            clone = (T) ois.readObject();
1817          } catch (Throwable fail) {
1818              threadUnexpectedException(fail);
1789            return null;
1819          }
1820 +        if (o == clone) assertImmutable(o);
1821 +        else assertSame(o.getClass(), clone.getClass());
1822 +        return clone;
1823      }
1824  
1825      /**
# Line 1806 | Line 1838 | public class JSR166TestCase extends Test
1838              (new ByteArrayInputStream(bos.toByteArray()));
1839          T clone = (T) ois.readObject();
1840          if (o == clone) assertImmutable(o);
1841 <        assertSame(o.getClass(), clone.getClass());
1841 >        else assertSame(o.getClass(), clone.getClass());
1842          return clone;
1843      }
1844  
# Line 1831 | Line 1863 | public class JSR166TestCase extends Test
1863      }
1864  
1865      public void assertThrows(Class<? extends Throwable> expectedExceptionClass,
1866 <                             Runnable... throwingActions) {
1867 <        for (Runnable throwingAction : throwingActions) {
1866 >                             Action... throwingActions) {
1867 >        for (Action throwingAction : throwingActions) {
1868              boolean threw = false;
1869              try { throwingAction.run(); }
1870              catch (Throwable t) {

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines