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.134 by jsr166, Sun Jun 14 20:58:14 2015 UTC vs.
Revision 1.234 by jsr166, Mon Jul 17 22:27:31 2017 UTC

# Line 1 | Line 1
1   /*
2 < * Written by Doug Lea with assistance from members of JCP JSR-166
3 < * Expert Group and released to the public domain, as explained at
2 > * Written by Doug Lea and Martin Buchholz with assistance from
3 > * members of JCP JSR-166 Expert Group and released to the public
4 > * domain, as explained at
5   * http://creativecommons.org/publicdomain/zero/1.0/
6   * Other contributors include Andrew Wright, Jeffrey Hayes,
7   * Pat Fisher, Mike Judd.
8   */
9  
10 + /*
11 + * @test
12 + * @summary JSR-166 tck tests, in a number of variations.
13 + *          The first is the conformance testing variant,
14 + *          while others also test implementation details.
15 + * @build *
16 + * @modules java.management
17 + * @run junit/othervm/timeout=1000 JSR166TestCase
18 + * @run junit/othervm/timeout=1000
19 + *      --add-opens java.base/java.util.concurrent=ALL-UNNAMED
20 + *      --add-opens java.base/java.lang=ALL-UNNAMED
21 + *      -Djsr166.testImplementationDetails=true
22 + *      JSR166TestCase
23 + * @run junit/othervm/timeout=1000
24 + *      --add-opens java.base/java.util.concurrent=ALL-UNNAMED
25 + *      --add-opens java.base/java.lang=ALL-UNNAMED
26 + *      -Djsr166.testImplementationDetails=true
27 + *      -Djava.util.concurrent.ForkJoinPool.common.parallelism=0
28 + *      JSR166TestCase
29 + * @run junit/othervm/timeout=1000
30 + *      --add-opens java.base/java.util.concurrent=ALL-UNNAMED
31 + *      --add-opens java.base/java.lang=ALL-UNNAMED
32 + *      -Djsr166.testImplementationDetails=true
33 + *      -Djava.util.concurrent.ForkJoinPool.common.parallelism=1
34 + *      -Djava.util.secureRandomSeed=true
35 + *      JSR166TestCase
36 + * @run junit/othervm/timeout=1000/policy=tck.policy
37 + *      --add-opens java.base/java.util.concurrent=ALL-UNNAMED
38 + *      --add-opens java.base/java.lang=ALL-UNNAMED
39 + *      -Djsr166.testImplementationDetails=true
40 + *      JSR166TestCase
41 + */
42 +
43   import static java.util.concurrent.TimeUnit.MILLISECONDS;
44 + import static java.util.concurrent.TimeUnit.MINUTES;
45   import static java.util.concurrent.TimeUnit.NANOSECONDS;
46  
47   import java.io.ByteArrayInputStream;
# Line 15 | Line 50 | import java.io.ObjectInputStream;
50   import java.io.ObjectOutputStream;
51   import java.lang.management.ManagementFactory;
52   import java.lang.management.ThreadInfo;
53 + import java.lang.management.ThreadMXBean;
54   import java.lang.reflect.Constructor;
55   import java.lang.reflect.Method;
56   import java.lang.reflect.Modifier;
# Line 27 | Line 63 | import java.security.ProtectionDomain;
63   import java.security.SecurityPermission;
64   import java.util.ArrayList;
65   import java.util.Arrays;
66 + import java.util.Collection;
67 + import java.util.Collections;
68   import java.util.Date;
69   import java.util.Enumeration;
70   import java.util.Iterator;
# Line 37 | Line 75 | import java.util.concurrent.BlockingQueu
75   import java.util.concurrent.Callable;
76   import java.util.concurrent.CountDownLatch;
77   import java.util.concurrent.CyclicBarrier;
78 + import java.util.concurrent.ExecutionException;
79 + import java.util.concurrent.Executor;
80 + import java.util.concurrent.Executors;
81   import java.util.concurrent.ExecutorService;
82 + import java.util.concurrent.ForkJoinPool;
83   import java.util.concurrent.Future;
84 + import java.util.concurrent.FutureTask;
85   import java.util.concurrent.RecursiveAction;
86   import java.util.concurrent.RecursiveTask;
87 + import java.util.concurrent.RejectedExecutionException;
88   import java.util.concurrent.RejectedExecutionHandler;
89   import java.util.concurrent.Semaphore;
90 + import java.util.concurrent.ScheduledExecutorService;
91 + import java.util.concurrent.ScheduledFuture;
92 + import java.util.concurrent.SynchronousQueue;
93   import java.util.concurrent.ThreadFactory;
94 + import java.util.concurrent.ThreadLocalRandom;
95   import java.util.concurrent.ThreadPoolExecutor;
96 + import java.util.concurrent.TimeUnit;
97   import java.util.concurrent.TimeoutException;
98 + import java.util.concurrent.atomic.AtomicBoolean;
99   import java.util.concurrent.atomic.AtomicReference;
100   import java.util.regex.Pattern;
101  
# Line 65 | Line 115 | import junit.framework.TestSuite;
115   *
116   * <ol>
117   *
118 < * <li> All assertions in code running in generated threads must use
118 > * <li>All assertions in code running in generated threads must use
119   * the forms {@link #threadFail}, {@link #threadAssertTrue}, {@link
120   * #threadAssertEquals}, or {@link #threadAssertNull}, (not
121   * {@code fail}, {@code assertTrue}, etc.) It is OK (but not
122   * particularly recommended) for other code to use these forms too.
123   * Only the most typically used JUnit assertion methods are defined
124 < * this way, but enough to live with.</li>
124 > * this way, but enough to live with.
125   *
126 < * <li> If you override {@link #setUp} or {@link #tearDown}, make sure
126 > * <li>If you override {@link #setUp} or {@link #tearDown}, make sure
127   * to invoke {@code super.setUp} and {@code super.tearDown} within
128   * them. These methods are used to clear and check for thread
129 < * assertion failures.</li>
129 > * assertion failures.
130   *
131   * <li>All delays and timeouts must use one of the constants {@code
132   * SHORT_DELAY_MS}, {@code SMALL_DELAY_MS}, {@code MEDIUM_DELAY_MS},
# Line 87 | Line 137 | import junit.framework.TestSuite;
137   * is always discriminable as larger than SHORT and smaller than
138   * MEDIUM.  And so on. These constants are set to conservative values,
139   * but even so, if there is ever any doubt, they can all be increased
140 < * in one spot to rerun tests on slower platforms.</li>
140 > * in one spot to rerun tests on slower platforms.
141   *
142 < * <li> All threads generated must be joined inside each test case
142 > * <li>All threads generated must be joined inside each test case
143   * method (or {@code fail} to do so) before returning from the
144   * method. The {@code joinPool} method can be used to do this when
145 < * using Executors.</li>
145 > * using Executors.
146   *
147   * </ol>
148   *
149   * <p><b>Other notes</b>
150   * <ul>
151   *
152 < * <li> Usually, there is one testcase method per JSR166 method
152 > * <li>Usually, there is one testcase method per JSR166 method
153   * covering "normal" operation, and then as many exception-testing
154   * methods as there are exceptions the method can throw. Sometimes
155   * there are multiple tests per JSR166 method when the different
156   * "normal" behaviors differ significantly. And sometimes testcases
157 < * cover multiple methods when they cannot be tested in
108 < * isolation.</li>
157 > * cover multiple methods when they cannot be tested in isolation.
158   *
159 < * <li> The documentation style for testcases is to provide as javadoc
159 > * <li>The documentation style for testcases is to provide as javadoc
160   * a simple sentence or two describing the property that the testcase
161   * method purports to test. The javadocs do not say anything about how
162 < * the property is tested. To find out, read the code.</li>
162 > * the property is tested. To find out, read the code.
163   *
164 < * <li> These tests are "conformance tests", and do not attempt to
164 > * <li>These tests are "conformance tests", and do not attempt to
165   * test throughput, latency, scalability or other performance factors
166   * (see the separate "jtreg" tests for a set intended to check these
167   * for the most central aspects of functionality.) So, most tests use
168   * the smallest sensible numbers of threads, collection sizes, etc
169 < * needed to check basic conformance.</li>
169 > * needed to check basic conformance.
170   *
171   * <li>The test classes currently do not declare inclusion in
172   * any particular package to simplify things for people integrating
173 < * them in TCK test suites.</li>
173 > * them in TCK test suites.
174   *
175 < * <li> As a convenience, the {@code main} of this class (JSR166TestCase)
176 < * runs all JSR166 unit tests.</li>
175 > * <li>As a convenience, the {@code main} of this class (JSR166TestCase)
176 > * runs all JSR166 unit tests.
177   *
178   * </ul>
179   */
# Line 168 | Line 217 | public class JSR166TestCase extends Test
217      private static final int suiteRuns =
218          Integer.getInteger("jsr166.suiteRuns", 1);
219  
220 +    /**
221 +     * Returns the value of the system property, or NaN if not defined.
222 +     */
223 +    private static float systemPropertyValue(String name) {
224 +        String floatString = System.getProperty(name);
225 +        if (floatString == null)
226 +            return Float.NaN;
227 +        try {
228 +            return Float.parseFloat(floatString);
229 +        } catch (NumberFormatException ex) {
230 +            throw new IllegalArgumentException(
231 +                String.format("Bad float value in system property %s=%s",
232 +                              name, floatString));
233 +        }
234 +    }
235 +
236 +    /**
237 +     * The scaling factor to apply to standard delays used in tests.
238 +     * May be initialized from any of:
239 +     * - the "jsr166.delay.factor" system property
240 +     * - the "test.timeout.factor" system property (as used by jtreg)
241 +     *   See: http://openjdk.java.net/jtreg/tag-spec.html
242 +     * - hard-coded fuzz factor when using a known slowpoke VM
243 +     */
244 +    private static final float delayFactor = delayFactor();
245 +
246 +    private static float delayFactor() {
247 +        float x;
248 +        if (!Float.isNaN(x = systemPropertyValue("jsr166.delay.factor")))
249 +            return x;
250 +        if (!Float.isNaN(x = systemPropertyValue("test.timeout.factor")))
251 +            return x;
252 +        String prop = System.getProperty("java.vm.version");
253 +        if (prop != null && prop.matches(".*debug.*"))
254 +            return 4.0f; // How much slower is fastdebug than product?!
255 +        return 1.0f;
256 +    }
257 +
258      public JSR166TestCase() { super(); }
259      public JSR166TestCase(String name) { super(name); }
260  
# Line 183 | Line 270 | public class JSR166TestCase extends Test
270          return (regex == null) ? null : Pattern.compile(regex);
271      }
272  
273 <    protected void runTest() throws Throwable {
273 >    // Instrumentation to debug very rare, but very annoying hung test runs.
274 >    static volatile TestCase currentTestCase;
275 >    // static volatile int currentRun = 0;
276 >    static {
277 >        Runnable checkForWedgedTest = new Runnable() { public void run() {
278 >            // Avoid spurious reports with enormous runsPerTest.
279 >            // A single test case run should never take more than 1 second.
280 >            // But let's cap it at the high end too ...
281 >            final int timeoutMinutes =
282 >                Math.min(15, Math.max(runsPerTest / 60, 1));
283 >            for (TestCase lastTestCase = currentTestCase;;) {
284 >                try { MINUTES.sleep(timeoutMinutes); }
285 >                catch (InterruptedException unexpected) { break; }
286 >                if (lastTestCase == currentTestCase) {
287 >                    System.err.printf(
288 >                        "Looks like we're stuck running test: %s%n",
289 >                        lastTestCase);
290 > //                     System.err.printf(
291 > //                         "Looks like we're stuck running test: %s (%d/%d)%n",
292 > //                         lastTestCase, currentRun, runsPerTest);
293 > //                     System.err.println("availableProcessors=" +
294 > //                         Runtime.getRuntime().availableProcessors());
295 > //                     System.err.printf("cpu model = %s%n", cpuModel());
296 >                    dumpTestThreads();
297 >                    // one stack dump is probably enough; more would be spam
298 >                    break;
299 >                }
300 >                lastTestCase = currentTestCase;
301 >            }}};
302 >        Thread thread = new Thread(checkForWedgedTest, "checkForWedgedTest");
303 >        thread.setDaemon(true);
304 >        thread.start();
305 >    }
306 >
307 > //     public static String cpuModel() {
308 > //         try {
309 > //             java.util.regex.Matcher matcher
310 > //               = Pattern.compile("model name\\s*: (.*)")
311 > //                 .matcher(new String(
312 > //                     java.nio.file.Files.readAllBytes(
313 > //                         java.nio.file.Paths.get("/proc/cpuinfo")), "UTF-8"));
314 > //             matcher.find();
315 > //             return matcher.group(1);
316 > //         } catch (Exception ex) { return null; }
317 > //     }
318 >
319 >    public void runBare() throws Throwable {
320 >        currentTestCase = this;
321          if (methodFilter == null
322 <            || methodFilter.matcher(toString()).find()) {
323 <            for (int i = 0; i < runsPerTest; i++) {
324 <                if (profileTests)
325 <                    runTestProfiled();
326 <                else
327 <                    super.runTest();
328 <            }
322 >            || methodFilter.matcher(toString()).find())
323 >            super.runBare();
324 >    }
325 >
326 >    protected void runTest() throws Throwable {
327 >        for (int i = 0; i < runsPerTest; i++) {
328 >            // currentRun = i;
329 >            if (profileTests)
330 >                runTestProfiled();
331 >            else
332 >                super.runTest();
333          }
334      }
335  
336      protected void runTestProfiled() throws Throwable {
337 <        // Warmup run, notably to trigger all needed classloading.
338 <        super.runTest();
201 <        long t0 = System.nanoTime();
202 <        try {
337 >        for (int i = 0; i < 2; i++) {
338 >            long startTime = System.nanoTime();
339              super.runTest();
340 <        } finally {
341 <            long elapsedMillis = millisElapsedSince(t0);
342 <            if (elapsedMillis >= profileThreshold)
340 >            long elapsedMillis = millisElapsedSince(startTime);
341 >            if (elapsedMillis < profileThreshold)
342 >                break;
343 >            // Never report first run of any test; treat it as a
344 >            // warmup run, notably to trigger all needed classloading,
345 >            if (i > 0)
346                  System.out.printf("%n%s: %d%n", toString(), elapsedMillis);
347          }
348      }
# Line 215 | Line 354 | public class JSR166TestCase extends Test
354          main(suite(), args);
355      }
356  
357 +    static class PithyResultPrinter extends junit.textui.ResultPrinter {
358 +        PithyResultPrinter(java.io.PrintStream writer) { super(writer); }
359 +        long runTime;
360 +        public void startTest(Test test) {}
361 +        protected void printHeader(long runTime) {
362 +            this.runTime = runTime; // defer printing for later
363 +        }
364 +        protected void printFooter(TestResult result) {
365 +            if (result.wasSuccessful()) {
366 +                getWriter().println("OK (" + result.runCount() + " tests)"
367 +                    + "  Time: " + elapsedTimeAsString(runTime));
368 +            } else {
369 +                getWriter().println("Time: " + elapsedTimeAsString(runTime));
370 +                super.printFooter(result);
371 +            }
372 +        }
373 +    }
374 +
375 +    /**
376 +     * Returns a TestRunner that doesn't bother with unnecessary
377 +     * fluff, like printing a "." for each test case.
378 +     */
379 +    static junit.textui.TestRunner newPithyTestRunner() {
380 +        junit.textui.TestRunner runner = new junit.textui.TestRunner();
381 +        runner.setPrinter(new PithyResultPrinter(System.out));
382 +        return runner;
383 +    }
384 +
385      /**
386       * Runs all unit tests in the given test suite.
387       * Actual behavior influenced by jsr166.* system properties.
# Line 226 | Line 393 | public class JSR166TestCase extends Test
393              System.setSecurityManager(new SecurityManager());
394          }
395          for (int i = 0; i < suiteRuns; i++) {
396 <            TestResult result = junit.textui.TestRunner.run(suite);
396 >            TestResult result = newPithyTestRunner().doRun(suite);
397              if (!result.wasSuccessful())
398                  System.exit(1);
399              System.gc();
# Line 281 | Line 448 | public class JSR166TestCase extends Test
448      public static boolean atLeastJava6() { return JAVA_CLASS_VERSION >= 50.0; }
449      public static boolean atLeastJava7() { return JAVA_CLASS_VERSION >= 51.0; }
450      public static boolean atLeastJava8() { return JAVA_CLASS_VERSION >= 52.0; }
451 <    public static boolean atLeastJava9() { return JAVA_CLASS_VERSION >= 53.0; }
451 >    public static boolean atLeastJava9() {
452 >        return JAVA_CLASS_VERSION >= 53.0
453 >            // As of 2015-09, java9 still uses 52.0 class file version
454 >            || JAVA_SPECIFICATION_VERSION.matches("^(1\\.)?(9|[0-9][0-9])$");
455 >    }
456 >    public static boolean atLeastJava10() {
457 >        return JAVA_CLASS_VERSION >= 54.0
458 >            || JAVA_SPECIFICATION_VERSION.matches("^(1\\.)?[0-9][0-9]$");
459 >    }
460  
461      /**
462       * Collects all JSR166 unit tests as one suite.
# Line 302 | Line 477 | public class JSR166TestCase extends Test
477              AbstractQueuedLongSynchronizerTest.suite(),
478              ArrayBlockingQueueTest.suite(),
479              ArrayDequeTest.suite(),
480 +            ArrayListTest.suite(),
481              AtomicBooleanTest.suite(),
482              AtomicIntegerArrayTest.suite(),
483              AtomicIntegerFieldUpdaterTest.suite(),
# Line 324 | Line 500 | public class JSR166TestCase extends Test
500              CopyOnWriteArrayListTest.suite(),
501              CopyOnWriteArraySetTest.suite(),
502              CountDownLatchTest.suite(),
503 +            CountedCompleterTest.suite(),
504              CyclicBarrierTest.suite(),
505              DelayQueueTest.suite(),
506              EntryTest.suite(),
# Line 352 | Line 529 | public class JSR166TestCase extends Test
529              TreeMapTest.suite(),
530              TreeSetTest.suite(),
531              TreeSubMapTest.suite(),
532 <            TreeSubSetTest.suite());
532 >            TreeSubSetTest.suite(),
533 >            VectorTest.suite());
534  
535          // Java8+ test classes
536          if (atLeastJava8()) {
537              String[] java8TestClassNames = {
538 +                "ArrayDeque8Test",
539                  "Atomic8Test",
540                  "CompletableFutureTest",
541                  "ConcurrentHashMap8Test",
542 <                "CountedCompleterTest",
542 >                "CountedCompleter8Test",
543                  "DoubleAccumulatorTest",
544                  "DoubleAdderTest",
545                  "ForkJoinPool8Test",
546                  "ForkJoinTask8Test",
547 +                "LinkedBlockingDeque8Test",
548 +                "LinkedBlockingQueue8Test",
549                  "LongAccumulatorTest",
550                  "LongAdderTest",
551                  "SplittableRandomTest",
552                  "StampedLockTest",
553 +                "SubmissionPublisherTest",
554                  "ThreadLocalRandom8Test",
555 +                "TimeUnit8Test",
556              };
557              addNamedTestClasses(suite, java8TestClassNames);
558          }
# Line 377 | Line 560 | public class JSR166TestCase extends Test
560          // Java9+ test classes
561          if (atLeastJava9()) {
562              String[] java9TestClassNames = {
563 <                "ThreadPoolExecutor9Test",
563 >                "AtomicBoolean9Test",
564 >                "AtomicInteger9Test",
565 >                "AtomicIntegerArray9Test",
566 >                "AtomicLong9Test",
567 >                "AtomicLongArray9Test",
568 >                "AtomicReference9Test",
569 >                "AtomicReferenceArray9Test",
570 >                "ExecutorCompletionService9Test",
571 >                "ForkJoinPool9Test",
572              };
573              addNamedTestClasses(suite, java9TestClassNames);
574          }
# Line 388 | Line 579 | public class JSR166TestCase extends Test
579      /** Returns list of junit-style test method names in given class. */
580      public static ArrayList<String> testMethodNames(Class<?> testClass) {
581          Method[] methods = testClass.getDeclaredMethods();
582 <        ArrayList<String> names = new ArrayList<String>(methods.length);
582 >        ArrayList<String> names = new ArrayList<>(methods.length);
583          for (Method method : methods) {
584              if (method.getName().startsWith("test")
585                  && Modifier.isPublic(method.getModifiers())
# Line 444 | Line 635 | public class JSR166TestCase extends Test
635          } else {
636              return new TestSuite();
637          }
447
638      }
639  
640      // Delays for timing-dependent tests, in milliseconds.
# Line 454 | Line 644 | public class JSR166TestCase extends Test
644      public static long MEDIUM_DELAY_MS;
645      public static long LONG_DELAY_MS;
646  
647 +    private static final long RANDOM_TIMEOUT;
648 +    private static final long RANDOM_EXPIRED_TIMEOUT;
649 +    private static final TimeUnit RANDOM_TIMEUNIT;
650 +    static {
651 +        ThreadLocalRandom rnd = ThreadLocalRandom.current();
652 +        long[] timeouts = { Long.MIN_VALUE, -1, 0, 1, Long.MAX_VALUE };
653 +        RANDOM_TIMEOUT = timeouts[rnd.nextInt(timeouts.length)];
654 +        RANDOM_EXPIRED_TIMEOUT = timeouts[rnd.nextInt(3)];
655 +        TimeUnit[] timeUnits = TimeUnit.values();
656 +        RANDOM_TIMEUNIT = timeUnits[rnd.nextInt(timeUnits.length)];
657 +    }
658 +
659 +    /**
660 +     * Returns a timeout for use when any value at all will do.
661 +     */
662 +    static long randomTimeout() { return RANDOM_TIMEOUT; }
663 +
664 +    /**
665 +     * Returns a timeout that means "no waiting", i.e. not positive.
666 +     */
667 +    static long randomExpiredTimeout() { return RANDOM_EXPIRED_TIMEOUT; }
668 +
669      /**
670 <     * Returns the shortest timed delay. This could
671 <     * be reimplemented to use for example a Property.
670 >     * Returns a random non-null TimeUnit.
671 >     */
672 >    static TimeUnit randomTimeUnit() { return RANDOM_TIMEUNIT; }
673 >
674 >    /**
675 >     * Returns the shortest timed delay. This can be scaled up for
676 >     * slow machines using the jsr166.delay.factor system property,
677 >     * or via jtreg's -timeoutFactor: flag.
678 >     * http://openjdk.java.net/jtreg/command-help.html
679       */
680      protected long getShortDelay() {
681 <        return 50;
681 >        return (long) (50 * delayFactor);
682      }
683  
684      /**
# Line 472 | Line 691 | public class JSR166TestCase extends Test
691          LONG_DELAY_MS   = SHORT_DELAY_MS * 200;
692      }
693  
694 +    private static final long TIMEOUT_DELAY_MS
695 +        = (long) (12.0 * Math.cbrt(delayFactor));
696 +
697      /**
698 <     * Returns a timeout in milliseconds to be used in tests that
699 <     * verify that operations block or time out.
698 >     * Returns a timeout in milliseconds to be used in tests that verify
699 >     * that operations block or time out.  We want this to be longer
700 >     * than the OS scheduling quantum, but not too long, so don't scale
701 >     * linearly with delayFactor; we use "crazy" cube root instead.
702       */
703 <    long timeoutMillis() {
704 <        return SHORT_DELAY_MS / 4;
703 >    static long timeoutMillis() {
704 >        return TIMEOUT_DELAY_MS;
705      }
706  
707      /**
708 <     * Returns a new Date instance representing a time delayMillis
709 <     * milliseconds in the future.
708 >     * Returns a new Date instance representing a time at least
709 >     * delayMillis milliseconds in the future.
710       */
711      Date delayedDate(long delayMillis) {
712 <        return new Date(System.currentTimeMillis() + delayMillis);
712 >        // Add 1 because currentTimeMillis is known to round into the past.
713 >        return new Date(System.currentTimeMillis() + delayMillis + 1);
714      }
715  
716      /**
717       * The first exception encountered if any threadAssertXXX method fails.
718       */
719      private final AtomicReference<Throwable> threadFailure
720 <        = new AtomicReference<Throwable>(null);
720 >        = new AtomicReference<>(null);
721  
722      /**
723       * Records an exception so that it can be rethrown later in the test
# Line 501 | Line 726 | public class JSR166TestCase extends Test
726       * the same test have no effect.
727       */
728      public void threadRecordFailure(Throwable t) {
729 +        System.err.println(t);
730 +        dumpTestThreads();
731          threadFailure.compareAndSet(null, t);
732      }
733  
# Line 508 | Line 735 | public class JSR166TestCase extends Test
735          setDelays();
736      }
737  
738 +    void tearDownFail(String format, Object... args) {
739 +        String msg = toString() + ": " + String.format(format, args);
740 +        System.err.println(msg);
741 +        dumpTestThreads();
742 +        throw new AssertionFailedError(msg);
743 +    }
744 +
745      /**
746       * Extra checks that get done for all test cases.
747       *
# Line 535 | Line 769 | public class JSR166TestCase extends Test
769          }
770  
771          if (Thread.interrupted())
772 <            throw new AssertionFailedError("interrupt status set in main thread");
772 >            tearDownFail("interrupt status set in main thread");
773  
774          checkForkJoinPoolThreadLeaks();
775      }
776  
777      /**
778 <     * Finds missing try { ... } finally { joinPool(e); }
778 >     * Finds missing PoolCleaners
779       */
780      void checkForkJoinPoolThreadLeaks() throws InterruptedException {
781 <        Thread[] survivors = new Thread[5];
781 >        Thread[] survivors = new Thread[7];
782          int count = Thread.enumerate(survivors);
783          for (int i = 0; i < count; i++) {
784              Thread thread = survivors[i];
# Line 552 | Line 786 | public class JSR166TestCase extends Test
786              if (name.startsWith("ForkJoinPool-")) {
787                  // give thread some time to terminate
788                  thread.join(LONG_DELAY_MS);
789 <                if (!thread.isAlive()) continue;
790 <                throw new AssertionFailedError
791 <                    (String.format("Found leaked ForkJoinPool thread test=%s thread=%s%n",
558 <                                   toString(), name));
789 >                if (thread.isAlive())
790 >                    tearDownFail("Found leaked ForkJoinPool thread thread=%s",
791 >                                 thread);
792              }
793          }
794 +
795 +        if (!ForkJoinPool.commonPool()
796 +            .awaitQuiescence(LONG_DELAY_MS, MILLISECONDS))
797 +            tearDownFail("ForkJoin common pool thread stuck");
798      }
799  
800      /**
# Line 570 | Line 807 | public class JSR166TestCase extends Test
807              fail(reason);
808          } catch (AssertionFailedError t) {
809              threadRecordFailure(t);
810 <            fail(reason);
810 >            throw t;
811          }
812      }
813  
# Line 697 | Line 934 | public class JSR166TestCase extends Test
934      /**
935       * Delays, via Thread.sleep, for the given millisecond delay, but
936       * if the sleep is shorter than specified, may re-sleep or yield
937 <     * until time elapses.
937 >     * until time elapses.  Ensures that the given time, as measured
938 >     * by System.nanoTime(), has elapsed.
939       */
940      static void delay(long millis) throws InterruptedException {
941 <        long startTime = System.nanoTime();
942 <        long ns = millis * 1000 * 1000;
943 <        for (;;) {
941 >        long nanos = millis * (1000 * 1000);
942 >        final long wakeupTime = System.nanoTime() + nanos;
943 >        do {
944              if (millis > 0L)
945                  Thread.sleep(millis);
946              else // too short to sleep
947                  Thread.yield();
948 <            long d = ns - (System.nanoTime() - startTime);
949 <            if (d > 0L)
950 <                millis = d / (1000 * 1000);
951 <            else
952 <                break;
948 >            nanos = wakeupTime - System.nanoTime();
949 >            millis = nanos / (1000 * 1000);
950 >        } while (nanos >= 0L);
951 >    }
952 >
953 >    /**
954 >     * Allows use of try-with-resources with per-test thread pools.
955 >     */
956 >    class PoolCleaner implements AutoCloseable {
957 >        private final ExecutorService pool;
958 >        public PoolCleaner(ExecutorService pool) { this.pool = pool; }
959 >        public void close() { joinPool(pool); }
960 >    }
961 >
962 >    /**
963 >     * An extension of PoolCleaner that has an action to release the pool.
964 >     */
965 >    class PoolCleanerWithReleaser extends PoolCleaner {
966 >        private final Runnable releaser;
967 >        public PoolCleanerWithReleaser(ExecutorService pool, Runnable releaser) {
968 >            super(pool);
969 >            this.releaser = releaser;
970          }
971 +        public void close() {
972 +            try {
973 +                releaser.run();
974 +            } finally {
975 +                super.close();
976 +            }
977 +        }
978 +    }
979 +
980 +    PoolCleaner cleaner(ExecutorService pool) {
981 +        return new PoolCleaner(pool);
982 +    }
983 +
984 +    PoolCleaner cleaner(ExecutorService pool, Runnable releaser) {
985 +        return new PoolCleanerWithReleaser(pool, releaser);
986 +    }
987 +
988 +    PoolCleaner cleaner(ExecutorService pool, CountDownLatch latch) {
989 +        return new PoolCleanerWithReleaser(pool, releaser(latch));
990 +    }
991 +
992 +    Runnable releaser(final CountDownLatch latch) {
993 +        return new Runnable() { public void run() {
994 +            do { latch.countDown(); }
995 +            while (latch.getCount() > 0);
996 +        }};
997 +    }
998 +
999 +    PoolCleaner cleaner(ExecutorService pool, AtomicBoolean flag) {
1000 +        return new PoolCleanerWithReleaser(pool, releaser(flag));
1001 +    }
1002 +
1003 +    Runnable releaser(final AtomicBoolean flag) {
1004 +        return new Runnable() { public void run() { flag.set(true); }};
1005      }
1006  
1007      /**
1008       * Waits out termination of a thread pool or fails doing so.
1009       */
1010 <    void joinPool(ExecutorService exec) {
1010 >    void joinPool(ExecutorService pool) {
1011          try {
1012 <            exec.shutdown();
1013 <            if (!exec.awaitTermination(2 * LONG_DELAY_MS, MILLISECONDS))
1014 <                fail("ExecutorService " + exec +
1015 <                     " did not terminate in a timely manner");
1012 >            pool.shutdown();
1013 >            if (!pool.awaitTermination(2 * LONG_DELAY_MS, MILLISECONDS)) {
1014 >                try {
1015 >                    threadFail("ExecutorService " + pool +
1016 >                               " did not terminate in a timely manner");
1017 >                } finally {
1018 >                    // last resort, for the benefit of subsequent tests
1019 >                    pool.shutdownNow();
1020 >                    pool.awaitTermination(MEDIUM_DELAY_MS, MILLISECONDS);
1021 >                }
1022 >            }
1023          } catch (SecurityException ok) {
1024              // Allowed in case test doesn't have privs
1025          } catch (InterruptedException fail) {
1026 <            fail("Unexpected InterruptedException");
1026 >            threadFail("Unexpected InterruptedException");
1027 >        }
1028 >    }
1029 >
1030 >    /**
1031 >     * Like Runnable, but with the freedom to throw anything.
1032 >     * junit folks had the same idea:
1033 >     * http://junit.org/junit5/docs/snapshot/api/org/junit/gen5/api/Executable.html
1034 >     */
1035 >    interface Action { public void run() throws Throwable; }
1036 >
1037 >    /**
1038 >     * Runs all the given actions in parallel, failing if any fail.
1039 >     * Useful for running multiple variants of tests that are
1040 >     * necessarily individually slow because they must block.
1041 >     */
1042 >    void testInParallel(Action ... actions) {
1043 >        ExecutorService pool = Executors.newCachedThreadPool();
1044 >        try (PoolCleaner cleaner = cleaner(pool)) {
1045 >            ArrayList<Future<?>> futures = new ArrayList<>(actions.length);
1046 >            for (final Action action : actions)
1047 >                futures.add(pool.submit(new CheckedRunnable() {
1048 >                    public void realRun() throws Throwable { action.run();}}));
1049 >            for (Future<?> future : futures)
1050 >                try {
1051 >                    assertNull(future.get(LONG_DELAY_MS, MILLISECONDS));
1052 >                } catch (ExecutionException ex) {
1053 >                    threadUnexpectedException(ex.getCause());
1054 >                } catch (Exception ex) {
1055 >                    threadUnexpectedException(ex);
1056 >                }
1057          }
1058      }
1059  
1060      /**
1061 <     * A debugging tool to print all stack traces, as jstack does.
1061 >     * A debugging tool to print stack traces of most threads, as jstack does.
1062 >     * Uninteresting threads are filtered out.
1063       */
1064 <    static void printAllStackTraces() {
1065 <        for (ThreadInfo info :
1066 <                 ManagementFactory.getThreadMXBean()
1067 <                 .dumpAllThreads(true, true))
1064 >    static void dumpTestThreads() {
1065 >        SecurityManager sm = System.getSecurityManager();
1066 >        if (sm != null) {
1067 >            try {
1068 >                System.setSecurityManager(null);
1069 >            } catch (SecurityException giveUp) {
1070 >                return;
1071 >            }
1072 >        }
1073 >
1074 >        ThreadMXBean threadMXBean = ManagementFactory.getThreadMXBean();
1075 >        System.err.println("------ stacktrace dump start ------");
1076 >        for (ThreadInfo info : threadMXBean.dumpAllThreads(true, true)) {
1077 >            final String name = info.getThreadName();
1078 >            String lockName;
1079 >            if ("Signal Dispatcher".equals(name))
1080 >                continue;
1081 >            if ("Reference Handler".equals(name)
1082 >                && (lockName = info.getLockName()) != null
1083 >                && lockName.startsWith("java.lang.ref.Reference$Lock"))
1084 >                continue;
1085 >            if ("Finalizer".equals(name)
1086 >                && (lockName = info.getLockName()) != null
1087 >                && lockName.startsWith("java.lang.ref.ReferenceQueue$Lock"))
1088 >                continue;
1089 >            if ("checkForWedgedTest".equals(name))
1090 >                continue;
1091              System.err.print(info);
1092 +        }
1093 +        System.err.println("------ stacktrace dump end ------");
1094 +
1095 +        if (sm != null) System.setSecurityManager(sm);
1096 +    }
1097 +
1098 +    /**
1099 +     * Checks that thread eventually enters the expected blocked thread state.
1100 +     */
1101 +    void assertThreadBlocks(Thread thread, Thread.State expected) {
1102 +        // always sleep at least 1 ms, with high probability avoiding
1103 +        // transitory states
1104 +        for (long retries = LONG_DELAY_MS * 3 / 4; retries-->0; ) {
1105 +            try { delay(1); }
1106 +            catch (InterruptedException fail) {
1107 +                fail("Unexpected InterruptedException");
1108 +            }
1109 +            Thread.State s = thread.getState();
1110 +            if (s == expected)
1111 +                return;
1112 +            else if (s == Thread.State.TERMINATED)
1113 +                fail("Unexpected thread termination");
1114 +        }
1115 +        fail("timed out waiting for thread to enter thread state " + expected);
1116      }
1117  
1118      /**
1119       * Checks that thread does not terminate within the default
1120       * millisecond delay of {@code timeoutMillis()}.
1121 +     * TODO: REMOVEME
1122       */
1123      void assertThreadStaysAlive(Thread thread) {
1124          assertThreadStaysAlive(thread, timeoutMillis());
# Line 751 | Line 1126 | public class JSR166TestCase extends Test
1126  
1127      /**
1128       * Checks that thread does not terminate within the given millisecond delay.
1129 +     * TODO: REMOVEME
1130       */
1131      void assertThreadStaysAlive(Thread thread, long millis) {
1132          try {
# Line 758 | Line 1134 | public class JSR166TestCase extends Test
1134              delay(millis);
1135              assertTrue(thread.isAlive());
1136          } catch (InterruptedException fail) {
1137 <            fail("Unexpected InterruptedException");
1137 >            threadFail("Unexpected InterruptedException");
1138          }
1139      }
1140  
1141      /**
1142       * Checks that the threads do not terminate within the default
1143       * millisecond delay of {@code timeoutMillis()}.
1144 +     * TODO: REMOVEME
1145       */
1146      void assertThreadsStayAlive(Thread... threads) {
1147          assertThreadsStayAlive(timeoutMillis(), threads);
# Line 772 | Line 1149 | public class JSR166TestCase extends Test
1149  
1150      /**
1151       * Checks that the threads do not terminate within the given millisecond delay.
1152 +     * TODO: REMOVEME
1153       */
1154      void assertThreadsStayAlive(long millis, Thread... threads) {
1155          try {
# Line 780 | Line 1158 | public class JSR166TestCase extends Test
1158              for (Thread thread : threads)
1159                  assertTrue(thread.isAlive());
1160          } catch (InterruptedException fail) {
1161 <            fail("Unexpected InterruptedException");
1161 >            threadFail("Unexpected InterruptedException");
1162          }
1163      }
1164  
# Line 822 | Line 1200 | public class JSR166TestCase extends Test
1200      }
1201  
1202      /**
1203 +     * The maximum number of consecutive spurious wakeups we should
1204 +     * tolerate (from APIs like LockSupport.park) before failing a test.
1205 +     */
1206 +    static final int MAX_SPURIOUS_WAKEUPS = 10;
1207 +
1208 +    /**
1209       * The number of elements to place in collections, arrays, etc.
1210       */
1211      public static final int SIZE = 20;
# Line 925 | Line 1309 | public class JSR166TestCase extends Test
1309          }
1310          public void refresh() {}
1311          public String toString() {
1312 <            List<Permission> ps = new ArrayList<Permission>();
1312 >            List<Permission> ps = new ArrayList<>();
1313              for (Enumeration<Permission> e = perms.elements(); e.hasMoreElements();)
1314                  ps.add(e.nextElement());
1315              return "AdjustablePolicy with permissions " + ps;
# Line 955 | Line 1339 | public class JSR166TestCase extends Test
1339       * Sleeps until the given time has elapsed.
1340       * Throws AssertionFailedError if interrupted.
1341       */
1342 <    void sleep(long millis) {
1342 >    static void sleep(long millis) {
1343          try {
1344              delay(millis);
1345          } catch (InterruptedException fail) {
# Line 971 | Line 1355 | public class JSR166TestCase extends Test
1355       * thread to enter a wait state: BLOCKED, WAITING, or TIMED_WAITING.
1356       */
1357      void waitForThreadToEnterWaitState(Thread thread, long timeoutMillis) {
1358 <        long startTime = System.nanoTime();
1358 >        long startTime = 0L;
1359          for (;;) {
1360              Thread.State s = thread.getState();
1361              if (s == Thread.State.BLOCKED ||
# Line 980 | Line 1364 | public class JSR166TestCase extends Test
1364                  return;
1365              else if (s == Thread.State.TERMINATED)
1366                  fail("Unexpected thread termination");
1367 +            else if (startTime == 0L)
1368 +                startTime = System.nanoTime();
1369              else if (millisElapsedSince(startTime) > timeoutMillis) {
1370                  threadAssertTrue(thread.isAlive());
1371 <                return;
1371 >                fail("timed out waiting for thread to enter wait state");
1372 >            }
1373 >            Thread.yield();
1374 >        }
1375 >    }
1376 >
1377 >    /**
1378 >     * Spin-waits up to the specified number of milliseconds for the given
1379 >     * thread to enter a wait state: BLOCKED, WAITING, or TIMED_WAITING,
1380 >     * and additionally satisfy the given condition.
1381 >     */
1382 >    void waitForThreadToEnterWaitState(
1383 >        Thread thread, long timeoutMillis, Callable<Boolean> waitingForGodot) {
1384 >        long startTime = 0L;
1385 >        for (;;) {
1386 >            Thread.State s = thread.getState();
1387 >            if (s == Thread.State.BLOCKED ||
1388 >                s == Thread.State.WAITING ||
1389 >                s == Thread.State.TIMED_WAITING) {
1390 >                try {
1391 >                    if (waitingForGodot.call())
1392 >                        return;
1393 >                } catch (Throwable fail) { threadUnexpectedException(fail); }
1394 >            }
1395 >            else if (s == Thread.State.TERMINATED)
1396 >                fail("Unexpected thread termination");
1397 >            else if (startTime == 0L)
1398 >                startTime = System.nanoTime();
1399 >            else if (millisElapsedSince(startTime) > timeoutMillis) {
1400 >                threadAssertTrue(thread.isAlive());
1401 >                fail("timed out waiting for thread to enter wait state");
1402              }
1403              Thread.yield();
1404          }
1405      }
1406  
1407      /**
1408 <     * Waits up to LONG_DELAY_MS for the given thread to enter a wait
1409 <     * state: BLOCKED, WAITING, or TIMED_WAITING.
1408 >     * Spin-waits up to LONG_DELAY_MS milliseconds for the given thread to
1409 >     * enter a wait state: BLOCKED, WAITING, or TIMED_WAITING.
1410       */
1411      void waitForThreadToEnterWaitState(Thread thread) {
1412          waitForThreadToEnterWaitState(thread, LONG_DELAY_MS);
1413      }
1414  
1415      /**
1416 +     * Spin-waits up to LONG_DELAY_MS milliseconds for the given thread to
1417 +     * enter a wait state: BLOCKED, WAITING, or TIMED_WAITING,
1418 +     * and additionally satisfy the given condition.
1419 +     */
1420 +    void waitForThreadToEnterWaitState(
1421 +        Thread thread, Callable<Boolean> waitingForGodot) {
1422 +        waitForThreadToEnterWaitState(thread, LONG_DELAY_MS, waitingForGodot);
1423 +    }
1424 +
1425 +    /**
1426       * Returns the number of milliseconds since time given by
1427       * startNanoTime, which must have been previously returned from a
1428       * call to {@link System#nanoTime()}.
# Line 1058 | Line 1484 | public class JSR166TestCase extends Test
1484          } finally {
1485              if (t.getState() != Thread.State.TERMINATED) {
1486                  t.interrupt();
1487 <                fail("Test timed out");
1487 >                threadFail("timed out waiting for thread to terminate");
1488              }
1489          }
1490      }
# Line 1183 | Line 1609 | public class JSR166TestCase extends Test
1609      public static final String TEST_STRING = "a test string";
1610  
1611      public static class StringTask implements Callable<String> {
1612 <        public String call() { return TEST_STRING; }
1612 >        final String value;
1613 >        public StringTask() { this(TEST_STRING); }
1614 >        public StringTask(String value) { this.value = value; }
1615 >        public String call() { return value; }
1616      }
1617  
1618      public Callable<String> latchAwaitingStringTask(final CountDownLatch latch) {
# Line 1196 | Line 1625 | public class JSR166TestCase extends Test
1625              }};
1626      }
1627  
1628 <    public Runnable awaiter(final CountDownLatch latch) {
1628 >    public Runnable countDowner(final CountDownLatch latch) {
1629          return new CheckedRunnable() {
1630              public void realRun() throws InterruptedException {
1631 <                await(latch);
1631 >                latch.countDown();
1632              }};
1633      }
1634  
1635 <    public void await(CountDownLatch latch) {
1635 >    class LatchAwaiter extends CheckedRunnable {
1636 >        static final int NEW = 0;
1637 >        static final int RUNNING = 1;
1638 >        static final int DONE = 2;
1639 >        final CountDownLatch latch;
1640 >        int state = NEW;
1641 >        LatchAwaiter(CountDownLatch latch) { this.latch = latch; }
1642 >        public void realRun() throws InterruptedException {
1643 >            state = 1;
1644 >            await(latch);
1645 >            state = 2;
1646 >        }
1647 >    }
1648 >
1649 >    public LatchAwaiter awaiter(CountDownLatch latch) {
1650 >        return new LatchAwaiter(latch);
1651 >    }
1652 >
1653 >    public void await(CountDownLatch latch, long timeoutMillis) {
1654          try {
1655 <            assertTrue(latch.await(LONG_DELAY_MS, MILLISECONDS));
1655 >            if (!latch.await(timeoutMillis, MILLISECONDS))
1656 >                fail("timed out waiting for CountDownLatch for "
1657 >                     + (timeoutMillis/1000) + " sec");
1658          } catch (Throwable fail) {
1659              threadUnexpectedException(fail);
1660          }
1661      }
1662  
1663 +    public void await(CountDownLatch latch) {
1664 +        await(latch, LONG_DELAY_MS);
1665 +    }
1666 +
1667      public void await(Semaphore semaphore) {
1668          try {
1669 <            assertTrue(semaphore.tryAcquire(LONG_DELAY_MS, MILLISECONDS));
1669 >            if (!semaphore.tryAcquire(LONG_DELAY_MS, MILLISECONDS))
1670 >                fail("timed out waiting for Semaphore for "
1671 >                     + (LONG_DELAY_MS/1000) + " sec");
1672 >        } catch (Throwable fail) {
1673 >            threadUnexpectedException(fail);
1674 >        }
1675 >    }
1676 >
1677 >    public void await(CyclicBarrier barrier) {
1678 >        try {
1679 >            barrier.await(LONG_DELAY_MS, MILLISECONDS);
1680          } catch (Throwable fail) {
1681              threadUnexpectedException(fail);
1682          }
# Line 1242 | Line 1705 | public class JSR166TestCase extends Test
1705          public String call() { throw new NullPointerException(); }
1706      }
1707  
1245    public static class CallableOne implements Callable<Integer> {
1246        public Integer call() { return one; }
1247    }
1248
1249    public class ShortRunnable extends CheckedRunnable {
1250        protected void realRun() throws Throwable {
1251            delay(SHORT_DELAY_MS);
1252        }
1253    }
1254
1255    public class ShortInterruptedRunnable extends CheckedInterruptedRunnable {
1256        protected void realRun() throws InterruptedException {
1257            delay(SHORT_DELAY_MS);
1258        }
1259    }
1260
1261    public class SmallRunnable extends CheckedRunnable {
1262        protected void realRun() throws Throwable {
1263            delay(SMALL_DELAY_MS);
1264        }
1265    }
1266
1708      public class SmallPossiblyInterruptedRunnable extends CheckedRunnable {
1709          protected void realRun() {
1710              try {
# Line 1272 | Line 1713 | public class JSR166TestCase extends Test
1713          }
1714      }
1715  
1275    public class SmallCallable extends CheckedCallable {
1276        protected Object realCall() throws InterruptedException {
1277            delay(SMALL_DELAY_MS);
1278            return Boolean.TRUE;
1279        }
1280    }
1281
1282    public class MediumRunnable extends CheckedRunnable {
1283        protected void realRun() throws Throwable {
1284            delay(MEDIUM_DELAY_MS);
1285        }
1286    }
1287
1288    public class MediumInterruptedRunnable extends CheckedInterruptedRunnable {
1289        protected void realRun() throws InterruptedException {
1290            delay(MEDIUM_DELAY_MS);
1291        }
1292    }
1293
1716      public Runnable possiblyInterruptedRunnable(final long timeoutMillis) {
1717          return new CheckedRunnable() {
1718              protected void realRun() {
# Line 1300 | Line 1722 | public class JSR166TestCase extends Test
1722              }};
1723      }
1724  
1303    public class MediumPossiblyInterruptedRunnable extends CheckedRunnable {
1304        protected void realRun() {
1305            try {
1306                delay(MEDIUM_DELAY_MS);
1307            } catch (InterruptedException ok) {}
1308        }
1309    }
1310
1311    public class LongPossiblyInterruptedRunnable extends CheckedRunnable {
1312        protected void realRun() {
1313            try {
1314                delay(LONG_DELAY_MS);
1315            } catch (InterruptedException ok) {}
1316        }
1317    }
1318
1725      /**
1726       * For use as ThreadFactory in constructors
1727       */
# Line 1329 | Line 1735 | public class JSR166TestCase extends Test
1735          boolean isDone();
1736      }
1737  
1332    public static TrackedRunnable trackedRunnable(final long timeoutMillis) {
1333        return new TrackedRunnable() {
1334                private volatile boolean done = false;
1335                public boolean isDone() { return done; }
1336                public void run() {
1337                    try {
1338                        delay(timeoutMillis);
1339                        done = true;
1340                    } catch (InterruptedException ok) {}
1341                }
1342            };
1343    }
1344
1345    public static class TrackedShortRunnable implements Runnable {
1346        public volatile boolean done = false;
1347        public void run() {
1348            try {
1349                delay(SHORT_DELAY_MS);
1350                done = true;
1351            } catch (InterruptedException ok) {}
1352        }
1353    }
1354
1355    public static class TrackedSmallRunnable implements Runnable {
1356        public volatile boolean done = false;
1357        public void run() {
1358            try {
1359                delay(SMALL_DELAY_MS);
1360                done = true;
1361            } catch (InterruptedException ok) {}
1362        }
1363    }
1364
1365    public static class TrackedMediumRunnable implements Runnable {
1366        public volatile boolean done = false;
1367        public void run() {
1368            try {
1369                delay(MEDIUM_DELAY_MS);
1370                done = true;
1371            } catch (InterruptedException ok) {}
1372        }
1373    }
1374
1375    public static class TrackedLongRunnable implements Runnable {
1376        public volatile boolean done = false;
1377        public void run() {
1378            try {
1379                delay(LONG_DELAY_MS);
1380                done = true;
1381            } catch (InterruptedException ok) {}
1382        }
1383    }
1384
1738      public static class TrackedNoOpRunnable implements Runnable {
1739          public volatile boolean done = false;
1740          public void run() {
# Line 1389 | Line 1742 | public class JSR166TestCase extends Test
1742          }
1743      }
1744  
1392    public static class TrackedCallable implements Callable {
1393        public volatile boolean done = false;
1394        public Object call() {
1395            try {
1396                delay(SMALL_DELAY_MS);
1397                done = true;
1398            } catch (InterruptedException ok) {}
1399            return Boolean.TRUE;
1400        }
1401    }
1402
1745      /**
1746       * Analog of CheckedRunnable for RecursiveAction
1747       */
# Line 1443 | Line 1785 | public class JSR166TestCase extends Test
1785       * A CyclicBarrier that uses timed await and fails with
1786       * AssertionFailedErrors instead of throwing checked exceptions.
1787       */
1788 <    public class CheckedBarrier extends CyclicBarrier {
1788 >    public static class CheckedBarrier extends CyclicBarrier {
1789          public CheckedBarrier(int parties) { super(parties); }
1790  
1791          public int await() {
# Line 1466 | Line 1808 | public class JSR166TestCase extends Test
1808              assertEquals(0, q.size());
1809              assertNull(q.peek());
1810              assertNull(q.poll());
1811 <            assertNull(q.poll(0, MILLISECONDS));
1811 >            assertNull(q.poll(randomExpiredTimeout(), randomTimeUnit()));
1812              assertEquals(q.toString(), "[]");
1813              assertTrue(Arrays.equals(q.toArray(), new Object[0]));
1814              assertFalse(q.iterator().hasNext());
# Line 1507 | Line 1849 | public class JSR166TestCase extends Test
1849          }
1850      }
1851  
1852 +    void assertImmutable(final Object o) {
1853 +        if (o instanceof Collection) {
1854 +            assertThrows(
1855 +                UnsupportedOperationException.class,
1856 +                new Runnable() { public void run() {
1857 +                        ((Collection) o).add(null);}});
1858 +        }
1859 +    }
1860 +
1861      @SuppressWarnings("unchecked")
1862      <T> T serialClone(T o) {
1863          try {
1864              ObjectInputStream ois = new ObjectInputStream
1865                  (new ByteArrayInputStream(serialBytes(o)));
1866              T clone = (T) ois.readObject();
1867 +            if (o == clone) assertImmutable(o);
1868              assertSame(o.getClass(), clone.getClass());
1869              return clone;
1870          } catch (Throwable fail) {
# Line 1521 | Line 1873 | public class JSR166TestCase extends Test
1873          }
1874      }
1875  
1876 +    /**
1877 +     * A version of serialClone that leaves error handling (for
1878 +     * e.g. NotSerializableException) up to the caller.
1879 +     */
1880 +    @SuppressWarnings("unchecked")
1881 +    <T> T serialClonePossiblyFailing(T o)
1882 +        throws ReflectiveOperationException, java.io.IOException {
1883 +        ByteArrayOutputStream bos = new ByteArrayOutputStream();
1884 +        ObjectOutputStream oos = new ObjectOutputStream(bos);
1885 +        oos.writeObject(o);
1886 +        oos.flush();
1887 +        oos.close();
1888 +        ObjectInputStream ois = new ObjectInputStream
1889 +            (new ByteArrayInputStream(bos.toByteArray()));
1890 +        T clone = (T) ois.readObject();
1891 +        if (o == clone) assertImmutable(o);
1892 +        assertSame(o.getClass(), clone.getClass());
1893 +        return clone;
1894 +    }
1895 +
1896 +    /**
1897 +     * If o implements Cloneable and has a public clone method,
1898 +     * returns a clone of o, else null.
1899 +     */
1900 +    @SuppressWarnings("unchecked")
1901 +    <T> T cloneableClone(T o) {
1902 +        if (!(o instanceof Cloneable)) return null;
1903 +        final T clone;
1904 +        try {
1905 +            clone = (T) o.getClass().getMethod("clone").invoke(o);
1906 +        } catch (NoSuchMethodException ok) {
1907 +            return null;
1908 +        } catch (ReflectiveOperationException unexpected) {
1909 +            throw new Error(unexpected);
1910 +        }
1911 +        assertNotSame(o, clone); // not 100% guaranteed by spec
1912 +        assertSame(o.getClass(), clone.getClass());
1913 +        return clone;
1914 +    }
1915 +
1916      public void assertThrows(Class<? extends Throwable> expectedExceptionClass,
1917                               Runnable... throwingActions) {
1918          for (Runnable throwingAction : throwingActions) {
# Line 1549 | Line 1941 | public class JSR166TestCase extends Test
1941          } catch (NoSuchElementException success) {}
1942          assertFalse(it.hasNext());
1943      }
1944 +
1945 +    public <T> Callable<T> callableThrowing(final Exception ex) {
1946 +        return new Callable<T>() { public T call() throws Exception { throw ex; }};
1947 +    }
1948 +
1949 +    public Runnable runnableThrowing(final RuntimeException ex) {
1950 +        return new Runnable() { public void run() { throw ex; }};
1951 +    }
1952 +
1953 +    /** A reusable thread pool to be shared by tests. */
1954 +    static final ExecutorService cachedThreadPool =
1955 +        new ThreadPoolExecutor(0, Integer.MAX_VALUE,
1956 +                               1000L, MILLISECONDS,
1957 +                               new SynchronousQueue<Runnable>());
1958 +
1959 +    static <T> void shuffle(T[] array) {
1960 +        Collections.shuffle(Arrays.asList(array), ThreadLocalRandom.current());
1961 +    }
1962 +
1963 +    // --- Shared assertions for Executor tests ---
1964 +
1965 +    /**
1966 +     * Returns maximum number of tasks that can be submitted to given
1967 +     * pool (with bounded queue) before saturation (when submission
1968 +     * throws RejectedExecutionException).
1969 +     */
1970 +    static final int saturatedSize(ThreadPoolExecutor pool) {
1971 +        BlockingQueue<Runnable> q = pool.getQueue();
1972 +        return pool.getMaximumPoolSize() + q.size() + q.remainingCapacity();
1973 +    }
1974 +
1975 +    @SuppressWarnings("FutureReturnValueIgnored")
1976 +    void assertNullTaskSubmissionThrowsNullPointerException(Executor e) {
1977 +        try {
1978 +            e.execute((Runnable) null);
1979 +            shouldThrow();
1980 +        } catch (NullPointerException success) {}
1981 +
1982 +        if (! (e instanceof ExecutorService)) return;
1983 +        ExecutorService es = (ExecutorService) e;
1984 +        try {
1985 +            es.submit((Runnable) null);
1986 +            shouldThrow();
1987 +        } catch (NullPointerException success) {}
1988 +        try {
1989 +            es.submit((Runnable) null, Boolean.TRUE);
1990 +            shouldThrow();
1991 +        } catch (NullPointerException success) {}
1992 +        try {
1993 +            es.submit((Callable) null);
1994 +            shouldThrow();
1995 +        } catch (NullPointerException success) {}
1996 +
1997 +        if (! (e instanceof ScheduledExecutorService)) return;
1998 +        ScheduledExecutorService ses = (ScheduledExecutorService) e;
1999 +        try {
2000 +            ses.schedule((Runnable) null,
2001 +                         randomTimeout(), randomTimeUnit());
2002 +            shouldThrow();
2003 +        } catch (NullPointerException success) {}
2004 +        try {
2005 +            ses.schedule((Callable) null,
2006 +                         randomTimeout(), randomTimeUnit());
2007 +            shouldThrow();
2008 +        } catch (NullPointerException success) {}
2009 +        try {
2010 +            ses.scheduleAtFixedRate((Runnable) null,
2011 +                                    randomTimeout(), LONG_DELAY_MS, MILLISECONDS);
2012 +            shouldThrow();
2013 +        } catch (NullPointerException success) {}
2014 +        try {
2015 +            ses.scheduleWithFixedDelay((Runnable) null,
2016 +                                       randomTimeout(), LONG_DELAY_MS, MILLISECONDS);
2017 +            shouldThrow();
2018 +        } catch (NullPointerException success) {}
2019 +    }
2020 +
2021 +    void setRejectedExecutionHandler(
2022 +        ThreadPoolExecutor p, RejectedExecutionHandler handler) {
2023 +        p.setRejectedExecutionHandler(handler);
2024 +        assertSame(handler, p.getRejectedExecutionHandler());
2025 +    }
2026 +
2027 +    void assertTaskSubmissionsAreRejected(ThreadPoolExecutor p) {
2028 +        final RejectedExecutionHandler savedHandler = p.getRejectedExecutionHandler();
2029 +        final long savedTaskCount = p.getTaskCount();
2030 +        final long savedCompletedTaskCount = p.getCompletedTaskCount();
2031 +        final int savedQueueSize = p.getQueue().size();
2032 +        final boolean stock = (p.getClass().getClassLoader() == null);
2033 +
2034 +        Runnable r = () -> {};
2035 +        Callable<Boolean> c = () -> Boolean.TRUE;
2036 +
2037 +        class Recorder implements RejectedExecutionHandler {
2038 +            public volatile Runnable r = null;
2039 +            public volatile ThreadPoolExecutor p = null;
2040 +            public void reset() { r = null; p = null; }
2041 +            public void rejectedExecution(Runnable r, ThreadPoolExecutor p) {
2042 +                assertNull(this.r);
2043 +                assertNull(this.p);
2044 +                this.r = r;
2045 +                this.p = p;
2046 +            }
2047 +        }
2048 +
2049 +        // check custom handler is invoked exactly once per task
2050 +        Recorder recorder = new Recorder();
2051 +        setRejectedExecutionHandler(p, recorder);
2052 +        for (int i = 2; i--> 0; ) {
2053 +            recorder.reset();
2054 +            p.execute(r);
2055 +            if (stock && p.getClass() == ThreadPoolExecutor.class)
2056 +                assertSame(r, recorder.r);
2057 +            assertSame(p, recorder.p);
2058 +
2059 +            recorder.reset();
2060 +            assertFalse(p.submit(r).isDone());
2061 +            if (stock) assertTrue(!((FutureTask) recorder.r).isDone());
2062 +            assertSame(p, recorder.p);
2063 +
2064 +            recorder.reset();
2065 +            assertFalse(p.submit(r, Boolean.TRUE).isDone());
2066 +            if (stock) assertTrue(!((FutureTask) recorder.r).isDone());
2067 +            assertSame(p, recorder.p);
2068 +
2069 +            recorder.reset();
2070 +            assertFalse(p.submit(c).isDone());
2071 +            if (stock) assertTrue(!((FutureTask) recorder.r).isDone());
2072 +            assertSame(p, recorder.p);
2073 +
2074 +            if (p instanceof ScheduledExecutorService) {
2075 +                ScheduledExecutorService s = (ScheduledExecutorService) p;
2076 +                ScheduledFuture<?> future;
2077 +
2078 +                recorder.reset();
2079 +                future = s.schedule(r, randomTimeout(), randomTimeUnit());
2080 +                assertFalse(future.isDone());
2081 +                if (stock) assertTrue(!((FutureTask) recorder.r).isDone());
2082 +                assertSame(p, recorder.p);
2083 +
2084 +                recorder.reset();
2085 +                future = s.schedule(c, randomTimeout(), randomTimeUnit());
2086 +                assertFalse(future.isDone());
2087 +                if (stock) assertTrue(!((FutureTask) recorder.r).isDone());
2088 +                assertSame(p, recorder.p);
2089 +
2090 +                recorder.reset();
2091 +                future = s.scheduleAtFixedRate(r, randomTimeout(), LONG_DELAY_MS, MILLISECONDS);
2092 +                assertFalse(future.isDone());
2093 +                if (stock) assertTrue(!((FutureTask) recorder.r).isDone());
2094 +                assertSame(p, recorder.p);
2095 +
2096 +                recorder.reset();
2097 +                future = s.scheduleWithFixedDelay(r, randomTimeout(), LONG_DELAY_MS, MILLISECONDS);
2098 +                assertFalse(future.isDone());
2099 +                if (stock) assertTrue(!((FutureTask) recorder.r).isDone());
2100 +                assertSame(p, recorder.p);
2101 +            }
2102 +        }
2103 +
2104 +        // Checking our custom handler above should be sufficient, but
2105 +        // we add some integration tests of standard handlers.
2106 +        final AtomicReference<Thread> thread = new AtomicReference<>();
2107 +        final Runnable setThread = () -> thread.set(Thread.currentThread());
2108 +
2109 +        setRejectedExecutionHandler(p, new ThreadPoolExecutor.AbortPolicy());
2110 +        try {
2111 +            p.execute(setThread);
2112 +            shouldThrow();
2113 +        } catch (RejectedExecutionException success) {}
2114 +        assertNull(thread.get());
2115 +
2116 +        setRejectedExecutionHandler(p, new ThreadPoolExecutor.DiscardPolicy());
2117 +        p.execute(setThread);
2118 +        assertNull(thread.get());
2119 +
2120 +        setRejectedExecutionHandler(p, new ThreadPoolExecutor.CallerRunsPolicy());
2121 +        p.execute(setThread);
2122 +        if (p.isShutdown())
2123 +            assertNull(thread.get());
2124 +        else
2125 +            assertSame(Thread.currentThread(), thread.get());
2126 +
2127 +        setRejectedExecutionHandler(p, savedHandler);
2128 +
2129 +        // check that pool was not perturbed by handlers
2130 +        assertEquals(savedTaskCount, p.getTaskCount());
2131 +        assertEquals(savedCompletedTaskCount, p.getCompletedTaskCount());
2132 +        assertEquals(savedQueueSize, p.getQueue().size());
2133 +    }
2134   }

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines