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.241 by jsr166, Sun Jan 28 16:20:42 2018 UTC vs.
Revision 1.262 by jsr166, Thu Sep 5 21:26:24 2019 UTC

# Line 66 | Line 66 | import java.util.Arrays;
66   import java.util.Collection;
67   import java.util.Collections;
68   import java.util.Date;
69 + import java.util.Deque;
70   import java.util.Enumeration;
71 + import java.util.HashSet;
72   import java.util.Iterator;
73   import java.util.List;
74   import java.util.NoSuchElementException;
75   import java.util.PropertyPermission;
76 + import java.util.Set;
77   import java.util.concurrent.BlockingQueue;
78   import java.util.concurrent.Callable;
79   import java.util.concurrent.CountDownLatch;
# Line 114 | 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 277 | Line 288 | public class JSR166TestCase extends Test
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 448 | Line 460 | public class JSR166TestCase extends Test
460      public static boolean atLeastJava8()  { return JAVA_CLASS_VERSION >= 52.0; }
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 499 | 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 538 | Line 558 | public class JSR166TestCase extends Test
558                  "HashMapTest",
559                  "LinkedBlockingDeque8Test",
560                  "LinkedBlockingQueue8Test",
561 +                "LinkedHashMapTest",
562                  "LongAccumulatorTest",
563                  "LongAdderTest",
564                  "SplittableRandomTest",
# Line 636 | 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 664 | 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 681 | 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 719 | 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 1287 | Line 1329 | public class JSR166TestCase extends Test
1329      /**
1330       * Spin-waits up to the specified number of milliseconds for the given
1331       * thread to enter a wait state: BLOCKED, WAITING, or TIMED_WAITING.
1332 +     * @param waitingForGodot if non-null, an additional condition to satisfy
1333       */
1334 <    void waitForThreadToEnterWaitState(Thread thread, long timeoutMillis) {
1335 <        long startTime = 0L;
1336 <        for (;;) {
1337 <            Thread.State s = thread.getState();
1338 <            if (s == Thread.State.BLOCKED ||
1339 <                s == Thread.State.WAITING ||
1340 <                s == Thread.State.TIMED_WAITING)
1341 <                return;
1342 <            else if (s == Thread.State.TERMINATED)
1334 >    void waitForThreadToEnterWaitState(Thread thread, long timeoutMillis,
1335 >                                       Callable<Boolean> waitingForGodot) {
1336 >        for (long startTime = 0L;;) {
1337 >            switch (thread.getState()) {
1338 >            default: break;
1339 >            case BLOCKED: case WAITING: case TIMED_WAITING:
1340 >                try {
1341 >                    if (waitingForGodot == null || waitingForGodot.call())
1342 >                        return;
1343 >                } catch (Throwable fail) { threadUnexpectedException(fail); }
1344 >                break;
1345 >            case TERMINATED:
1346                  fail("Unexpected thread termination");
1347 <            else if (startTime == 0L)
1347 >            }
1348 >
1349 >            if (startTime == 0L)
1350                  startTime = System.nanoTime();
1351              else if (millisElapsedSince(startTime) > timeoutMillis) {
1352 <                threadAssertTrue(thread.isAlive());
1353 <                fail("timed out waiting for thread to enter wait state");
1352 >                assertTrue(thread.isAlive());
1353 >                if (waitingForGodot == null
1354 >                    || thread.getState() == Thread.State.RUNNABLE)
1355 >                    fail("timed out waiting for thread to enter wait state");
1356 >                else
1357 >                    fail("timed out waiting for condition, thread state="
1358 >                         + thread.getState());
1359              }
1360              Thread.yield();
1361          }
# Line 1310 | Line 1363 | public class JSR166TestCase extends Test
1363  
1364      /**
1365       * Spin-waits up to the specified number of milliseconds for the given
1366 <     * thread to enter a wait state: BLOCKED, WAITING, or TIMED_WAITING,
1314 <     * and additionally satisfy the given condition.
1366 >     * thread to enter a wait state: BLOCKED, WAITING, or TIMED_WAITING.
1367       */
1368 <    void waitForThreadToEnterWaitState(
1369 <        Thread thread, long timeoutMillis, Callable<Boolean> waitingForGodot) {
1318 <        long startTime = 0L;
1319 <        for (;;) {
1320 <            Thread.State s = thread.getState();
1321 <            if (s == Thread.State.BLOCKED ||
1322 <                s == Thread.State.WAITING ||
1323 <                s == Thread.State.TIMED_WAITING) {
1324 <                try {
1325 <                    if (waitingForGodot.call())
1326 <                        return;
1327 <                } catch (Throwable fail) { threadUnexpectedException(fail); }
1328 <            }
1329 <            else if (s == Thread.State.TERMINATED)
1330 <                fail("Unexpected thread termination");
1331 <            else if (startTime == 0L)
1332 <                startTime = System.nanoTime();
1333 <            else if (millisElapsedSince(startTime) > timeoutMillis) {
1334 <                threadAssertTrue(thread.isAlive());
1335 <                fail("timed out waiting for thread to enter wait state");
1336 <            }
1337 <            Thread.yield();
1338 <        }
1368 >    void waitForThreadToEnterWaitState(Thread thread, long timeoutMillis) {
1369 >        waitForThreadToEnterWaitState(thread, timeoutMillis, null);
1370      }
1371  
1372      /**
# Line 1343 | Line 1374 | public class JSR166TestCase extends Test
1374       * enter a wait state: BLOCKED, WAITING, or TIMED_WAITING.
1375       */
1376      void waitForThreadToEnterWaitState(Thread thread) {
1377 <        waitForThreadToEnterWaitState(thread, LONG_DELAY_MS);
1377 >        waitForThreadToEnterWaitState(thread, LONG_DELAY_MS, null);
1378      }
1379  
1380      /**
# Line 1351 | Line 1382 | public class JSR166TestCase extends Test
1382       * enter a wait state: BLOCKED, WAITING, or TIMED_WAITING,
1383       * and additionally satisfy the given condition.
1384       */
1385 <    void waitForThreadToEnterWaitState(
1386 <        Thread thread, Callable<Boolean> waitingForGodot) {
1385 >    void waitForThreadToEnterWaitState(Thread thread,
1386 >                                       Callable<Boolean> waitingForGodot) {
1387          waitForThreadToEnterWaitState(thread, LONG_DELAY_MS, waitingForGodot);
1388      }
1389  
1390      /**
1391 +     * Spin-waits up to LONG_DELAY_MS milliseconds for the current thread to
1392 +     * be interrupted.  Clears the interrupt status before returning.
1393 +     */
1394 +    void awaitInterrupted() {
1395 +        for (long startTime = 0L; !Thread.interrupted(); ) {
1396 +            if (startTime == 0L)
1397 +                startTime = System.nanoTime();
1398 +            else if (millisElapsedSince(startTime) > LONG_DELAY_MS)
1399 +                fail("timed out waiting for thread interrupt");
1400 +            Thread.yield();
1401 +        }
1402 +    }
1403 +
1404 +    /**
1405       * Returns the number of milliseconds since time given by
1406       * startNanoTime, which must have been previously returned from a
1407       * call to {@link System#nanoTime()}.
# Line 1384 | Line 1429 | public class JSR166TestCase extends Test
1429       */
1430      <T> void checkTimedGet(Future<T> f, T expectedValue, long timeoutMillis) {
1431          long startTime = System.nanoTime();
1432 +        T actual = null;
1433          try {
1434 <            assertEquals(expectedValue, f.get(timeoutMillis, MILLISECONDS));
1434 >            actual = f.get(timeoutMillis, MILLISECONDS);
1435          } catch (Throwable fail) { threadUnexpectedException(fail); }
1436 +        assertEquals(expectedValue, actual);
1437          if (millisElapsedSince(startTime) > timeoutMillis/2)
1438              throw new AssertionError("timed get did not return promptly");
1439      }
# Line 1410 | Line 1457 | public class JSR166TestCase extends Test
1457       * to terminate (using {@link Thread#join(long)}), else interrupts
1458       * the thread (in the hope that it may terminate later) and fails.
1459       */
1460 <    void awaitTermination(Thread t, long timeoutMillis) {
1460 >    void awaitTermination(Thread thread, long timeoutMillis) {
1461          try {
1462 <            t.join(timeoutMillis);
1462 >            thread.join(timeoutMillis);
1463          } catch (InterruptedException fail) {
1464              threadUnexpectedException(fail);
1465 <        } finally {
1466 <            if (t.getState() != Thread.State.TERMINATED) {
1467 <                t.interrupt();
1468 <                threadFail("timed out waiting for thread to terminate");
1465 >        }
1466 >        if (thread.getState() != Thread.State.TERMINATED) {
1467 >            String detail = String.format(
1468 >                    "timed out waiting for thread to terminate, thread=%s, state=%s" ,
1469 >                    thread, thread.getState());
1470 >            try {
1471 >                threadFail(detail);
1472 >            } finally {
1473 >                // Interrupt thread __after__ having reported its stack trace
1474 >                thread.interrupt();
1475              }
1476          }
1477      }
# Line 1446 | Line 1499 | public class JSR166TestCase extends Test
1499          }
1500      }
1501  
1449    public abstract class RunnableShouldThrow implements Runnable {
1450        protected abstract void realRun() throws Throwable;
1451
1452        final Class<?> exceptionClass;
1453
1454        <T extends Throwable> RunnableShouldThrow(Class<T> exceptionClass) {
1455            this.exceptionClass = exceptionClass;
1456        }
1457
1458        public final void run() {
1459            try {
1460                realRun();
1461                threadShouldThrow(exceptionClass.getSimpleName());
1462            } catch (Throwable t) {
1463                if (! exceptionClass.isInstance(t))
1464                    threadUnexpectedException(t);
1465            }
1466        }
1467    }
1468
1502      public abstract class ThreadShouldThrow extends Thread {
1503          protected abstract void realRun() throws Throwable;
1504  
# Line 1478 | Line 1511 | public class JSR166TestCase extends Test
1511          public final void run() {
1512              try {
1513                  realRun();
1481                threadShouldThrow(exceptionClass.getSimpleName());
1514              } catch (Throwable t) {
1515                  if (! exceptionClass.isInstance(t))
1516                      threadUnexpectedException(t);
1517 +                return;
1518              }
1519 +            threadShouldThrow(exceptionClass.getSimpleName());
1520          }
1521      }
1522  
# Line 1492 | Line 1526 | public class JSR166TestCase extends Test
1526          public final void run() {
1527              try {
1528                  realRun();
1495                threadShouldThrow("InterruptedException");
1529              } catch (InterruptedException success) {
1530                  threadAssertFalse(Thread.interrupted());
1531 +                return;
1532              } catch (Throwable fail) {
1533                  threadUnexpectedException(fail);
1534              }
1535 +            threadShouldThrow("InterruptedException");
1536          }
1537      }
1538  
# Line 1509 | Line 1544 | public class JSR166TestCase extends Test
1544                  return realCall();
1545              } catch (Throwable fail) {
1546                  threadUnexpectedException(fail);
1512                return null;
1547              }
1548 <        }
1515 <    }
1516 <
1517 <    public abstract class CheckedInterruptedCallable<T>
1518 <        implements Callable<T> {
1519 <        protected abstract T realCall() throws Throwable;
1520 <
1521 <        public final T call() {
1522 <            try {
1523 <                T result = realCall();
1524 <                threadShouldThrow("InterruptedException");
1525 <                return result;
1526 <            } catch (InterruptedException success) {
1527 <                threadAssertFalse(Thread.interrupted());
1528 <            } catch (Throwable fail) {
1529 <                threadUnexpectedException(fail);
1530 <            }
1531 <            return null;
1548 >            throw new AssertionError("unreached");
1549          }
1550      }
1551  
# Line 1585 | Line 1602 | public class JSR166TestCase extends Test
1602      }
1603  
1604      public void await(CountDownLatch latch, long timeoutMillis) {
1605 +        boolean timedOut = false;
1606          try {
1607 <            if (!latch.await(timeoutMillis, MILLISECONDS))
1590 <                fail("timed out waiting for CountDownLatch for "
1591 <                     + (timeoutMillis/1000) + " sec");
1607 >            timedOut = !latch.await(timeoutMillis, MILLISECONDS);
1608          } catch (Throwable fail) {
1609              threadUnexpectedException(fail);
1610          }
1611 +        if (timedOut)
1612 +            fail("timed out waiting for CountDownLatch for "
1613 +                 + (timeoutMillis/1000) + " sec");
1614      }
1615  
1616      public void await(CountDownLatch latch) {
# Line 1599 | Line 1618 | public class JSR166TestCase extends Test
1618      }
1619  
1620      public void await(Semaphore semaphore) {
1621 +        boolean timedOut = false;
1622          try {
1623 <            if (!semaphore.tryAcquire(LONG_DELAY_MS, MILLISECONDS))
1604 <                fail("timed out waiting for Semaphore for "
1605 <                     + (LONG_DELAY_MS/1000) + " sec");
1623 >            timedOut = !semaphore.tryAcquire(LONG_DELAY_MS, MILLISECONDS);
1624          } catch (Throwable fail) {
1625              threadUnexpectedException(fail);
1626          }
1627 +        if (timedOut)
1628 +            fail("timed out waiting for Semaphore for "
1629 +                 + (LONG_DELAY_MS/1000) + " sec");
1630      }
1631  
1632      public void await(CyclicBarrier barrier) {
# Line 1639 | Line 1660 | public class JSR166TestCase extends Test
1660          public String call() { throw new NullPointerException(); }
1661      }
1662  
1642    public class SmallPossiblyInterruptedRunnable extends CheckedRunnable {
1643        protected void realRun() {
1644            try {
1645                delay(SMALL_DELAY_MS);
1646            } catch (InterruptedException ok) {}
1647        }
1648    }
1649
1663      public Runnable possiblyInterruptedRunnable(final long timeoutMillis) {
1664          return new CheckedRunnable() {
1665              protected void realRun() {
# Line 1702 | Line 1715 | public class JSR166TestCase extends Test
1715                  return realCompute();
1716              } catch (Throwable fail) {
1717                  threadUnexpectedException(fail);
1705                return null;
1718              }
1719 +            throw new AssertionError("unreached");
1720          }
1721      }
1722  
# Line 1780 | Line 1793 | public class JSR166TestCase extends Test
1793          }
1794      }
1795  
1796 <    void assertImmutable(final Object o) {
1796 >    void assertImmutable(Object o) {
1797          if (o instanceof Collection) {
1798              assertThrows(
1799                  UnsupportedOperationException.class,
1800 <                new Runnable() { public void run() {
1788 <                        ((Collection) o).add(null);}});
1800 >                () -> ((Collection) o).add(null));
1801          }
1802      }
1803  
1804      @SuppressWarnings("unchecked")
1805      <T> T serialClone(T o) {
1806 +        T clone = null;
1807          try {
1808              ObjectInputStream ois = new ObjectInputStream
1809                  (new ByteArrayInputStream(serialBytes(o)));
1810 <            T clone = (T) ois.readObject();
1798 <            if (o == clone) assertImmutable(o);
1799 <            assertSame(o.getClass(), clone.getClass());
1800 <            return clone;
1810 >            clone = (T) ois.readObject();
1811          } catch (Throwable fail) {
1812              threadUnexpectedException(fail);
1803            return null;
1813          }
1814 +        if (o == clone) assertImmutable(o);
1815 +        else assertSame(o.getClass(), clone.getClass());
1816 +        return clone;
1817      }
1818  
1819      /**
# Line 1820 | Line 1832 | public class JSR166TestCase extends Test
1832              (new ByteArrayInputStream(bos.toByteArray()));
1833          T clone = (T) ois.readObject();
1834          if (o == clone) assertImmutable(o);
1835 <        assertSame(o.getClass(), clone.getClass());
1835 >        else assertSame(o.getClass(), clone.getClass());
1836          return clone;
1837      }
1838  
# Line 1845 | Line 1857 | public class JSR166TestCase extends Test
1857      }
1858  
1859      public void assertThrows(Class<? extends Throwable> expectedExceptionClass,
1860 <                             Runnable... throwingActions) {
1861 <        for (Runnable throwingAction : throwingActions) {
1860 >                             Action... throwingActions) {
1861 >        for (Action throwingAction : throwingActions) {
1862              boolean threw = false;
1863              try { throwingAction.run(); }
1864              catch (Throwable t) {
# Line 2071 | Line 2083 | public class JSR166TestCase extends Test
2083          assertEquals(savedCompletedTaskCount, p.getCompletedTaskCount());
2084          assertEquals(savedQueueSize, p.getQueue().size());
2085      }
2086 +
2087 +    void assertCollectionsEquals(Collection<?> x, Collection<?> y) {
2088 +        assertEquals(x, y);
2089 +        assertEquals(y, x);
2090 +        assertEquals(x.isEmpty(), y.isEmpty());
2091 +        assertEquals(x.size(), y.size());
2092 +        if (x instanceof List) {
2093 +            assertEquals(x.toString(), y.toString());
2094 +        }
2095 +        if (x instanceof List || x instanceof Set) {
2096 +            assertEquals(x.hashCode(), y.hashCode());
2097 +        }
2098 +        if (x instanceof List || x instanceof Deque) {
2099 +            assertTrue(Arrays.equals(x.toArray(), y.toArray()));
2100 +            assertTrue(Arrays.equals(x.toArray(new Object[0]),
2101 +                                     y.toArray(new Object[0])));
2102 +        }
2103 +    }
2104 +
2105 +    /**
2106 +     * A weaker form of assertCollectionsEquals which does not insist
2107 +     * that the two collections satisfy Object#equals(Object), since
2108 +     * they may use identity semantics as Deques do.
2109 +     */
2110 +    void assertCollectionsEquivalent(Collection<?> x, Collection<?> y) {
2111 +        if (x instanceof List || x instanceof Set)
2112 +            assertCollectionsEquals(x, y);
2113 +        else {
2114 +            assertEquals(x.isEmpty(), y.isEmpty());
2115 +            assertEquals(x.size(), y.size());
2116 +            assertEquals(new HashSet(x), new HashSet(y));
2117 +            if (x instanceof Deque) {
2118 +                assertTrue(Arrays.equals(x.toArray(), y.toArray()));
2119 +                assertTrue(Arrays.equals(x.toArray(new Object[0]),
2120 +                                         y.toArray(new Object[0])));
2121 +            }
2122 +        }
2123 +    }
2124   }

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines