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.140 by dl, Mon Sep 7 17:14:06 2015 UTC vs.
Revision 1.222 by jsr166, Fri May 12 18:12:51 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 40 | Line 78 | import java.util.concurrent.CyclicBarrie
78   import java.util.concurrent.ExecutionException;
79   import java.util.concurrent.Executors;
80   import java.util.concurrent.ExecutorService;
81 + import java.util.concurrent.ForkJoinPool;
82   import java.util.concurrent.Future;
83   import java.util.concurrent.RecursiveAction;
84   import java.util.concurrent.RecursiveTask;
85   import java.util.concurrent.RejectedExecutionHandler;
86   import java.util.concurrent.Semaphore;
87 + import java.util.concurrent.SynchronousQueue;
88   import java.util.concurrent.ThreadFactory;
89 + import java.util.concurrent.ThreadLocalRandom;
90   import java.util.concurrent.ThreadPoolExecutor;
91   import java.util.concurrent.TimeoutException;
92 + import java.util.concurrent.atomic.AtomicBoolean;
93   import java.util.concurrent.atomic.AtomicReference;
94   import java.util.regex.Pattern;
95  
# Line 67 | Line 109 | import junit.framework.TestSuite;
109   *
110   * <ol>
111   *
112 < * <li> All assertions in code running in generated threads must use
112 > * <li>All assertions in code running in generated threads must use
113   * the forms {@link #threadFail}, {@link #threadAssertTrue}, {@link
114   * #threadAssertEquals}, or {@link #threadAssertNull}, (not
115   * {@code fail}, {@code assertTrue}, etc.) It is OK (but not
116   * particularly recommended) for other code to use these forms too.
117   * Only the most typically used JUnit assertion methods are defined
118 < * this way, but enough to live with.</li>
118 > * this way, but enough to live with.
119   *
120 < * <li> If you override {@link #setUp} or {@link #tearDown}, make sure
120 > * <li>If you override {@link #setUp} or {@link #tearDown}, make sure
121   * to invoke {@code super.setUp} and {@code super.tearDown} within
122   * them. These methods are used to clear and check for thread
123 < * assertion failures.</li>
123 > * assertion failures.
124   *
125   * <li>All delays and timeouts must use one of the constants {@code
126   * SHORT_DELAY_MS}, {@code SMALL_DELAY_MS}, {@code MEDIUM_DELAY_MS},
# Line 89 | Line 131 | import junit.framework.TestSuite;
131   * is always discriminable as larger than SHORT and smaller than
132   * MEDIUM.  And so on. These constants are set to conservative values,
133   * but even so, if there is ever any doubt, they can all be increased
134 < * in one spot to rerun tests on slower platforms.</li>
134 > * in one spot to rerun tests on slower platforms.
135   *
136 < * <li> All threads generated must be joined inside each test case
136 > * <li>All threads generated must be joined inside each test case
137   * method (or {@code fail} to do so) before returning from the
138   * method. The {@code joinPool} method can be used to do this when
139 < * using Executors.</li>
139 > * using Executors.
140   *
141   * </ol>
142   *
143   * <p><b>Other notes</b>
144   * <ul>
145   *
146 < * <li> Usually, there is one testcase method per JSR166 method
146 > * <li>Usually, there is one testcase method per JSR166 method
147   * covering "normal" operation, and then as many exception-testing
148   * methods as there are exceptions the method can throw. Sometimes
149   * there are multiple tests per JSR166 method when the different
150   * "normal" behaviors differ significantly. And sometimes testcases
151 < * cover multiple methods when they cannot be tested in
110 < * isolation.</li>
151 > * cover multiple methods when they cannot be tested in isolation.
152   *
153 < * <li> The documentation style for testcases is to provide as javadoc
153 > * <li>The documentation style for testcases is to provide as javadoc
154   * a simple sentence or two describing the property that the testcase
155   * method purports to test. The javadocs do not say anything about how
156 < * the property is tested. To find out, read the code.</li>
156 > * the property is tested. To find out, read the code.
157   *
158 < * <li> These tests are "conformance tests", and do not attempt to
158 > * <li>These tests are "conformance tests", and do not attempt to
159   * test throughput, latency, scalability or other performance factors
160   * (see the separate "jtreg" tests for a set intended to check these
161   * for the most central aspects of functionality.) So, most tests use
162   * the smallest sensible numbers of threads, collection sizes, etc
163 < * needed to check basic conformance.</li>
163 > * needed to check basic conformance.
164   *
165   * <li>The test classes currently do not declare inclusion in
166   * any particular package to simplify things for people integrating
167 < * them in TCK test suites.</li>
167 > * them in TCK test suites.
168   *
169 < * <li> As a convenience, the {@code main} of this class (JSR166TestCase)
170 < * runs all JSR166 unit tests.</li>
169 > * <li>As a convenience, the {@code main} of this class (JSR166TestCase)
170 > * runs all JSR166 unit tests.
171   *
172   * </ul>
173   */
# Line 170 | Line 211 | public class JSR166TestCase extends Test
211      private static final int suiteRuns =
212          Integer.getInteger("jsr166.suiteRuns", 1);
213  
214 +    /**
215 +     * Returns the value of the system property, or NaN if not defined.
216 +     */
217 +    private static float systemPropertyValue(String name) {
218 +        String floatString = System.getProperty(name);
219 +        if (floatString == null)
220 +            return Float.NaN;
221 +        try {
222 +            return Float.parseFloat(floatString);
223 +        } catch (NumberFormatException ex) {
224 +            throw new IllegalArgumentException(
225 +                String.format("Bad float value in system property %s=%s",
226 +                              name, floatString));
227 +        }
228 +    }
229 +
230 +    /**
231 +     * The scaling factor to apply to standard delays used in tests.
232 +     * May be initialized from any of:
233 +     * - the "jsr166.delay.factor" system property
234 +     * - the "test.timeout.factor" system property (as used by jtreg)
235 +     *   See: http://openjdk.java.net/jtreg/tag-spec.html
236 +     * - hard-coded fuzz factor when using a known slowpoke VM
237 +     */
238 +    private static final float delayFactor = delayFactor();
239 +
240 +    private static float delayFactor() {
241 +        float x;
242 +        if (!Float.isNaN(x = systemPropertyValue("jsr166.delay.factor")))
243 +            return x;
244 +        if (!Float.isNaN(x = systemPropertyValue("test.timeout.factor")))
245 +            return x;
246 +        String prop = System.getProperty("java.vm.version");
247 +        if (prop != null && prop.matches(".*debug.*"))
248 +            return 4.0f; // How much slower is fastdebug than product?!
249 +        return 1.0f;
250 +    }
251 +
252      public JSR166TestCase() { super(); }
253      public JSR166TestCase(String name) { super(name); }
254  
# Line 185 | Line 264 | public class JSR166TestCase extends Test
264          return (regex == null) ? null : Pattern.compile(regex);
265      }
266  
267 <    protected void runTest() throws Throwable {
267 >    // Instrumentation to debug very rare, but very annoying hung test runs.
268 >    static volatile TestCase currentTestCase;
269 >    // static volatile int currentRun = 0;
270 >    static {
271 >        Runnable checkForWedgedTest = new Runnable() { public void run() {
272 >            // Avoid spurious reports with enormous runsPerTest.
273 >            // A single test case run should never take more than 1 second.
274 >            // But let's cap it at the high end too ...
275 >            final int timeoutMinutes =
276 >                Math.min(15, Math.max(runsPerTest / 60, 1));
277 >            for (TestCase lastTestCase = currentTestCase;;) {
278 >                try { MINUTES.sleep(timeoutMinutes); }
279 >                catch (InterruptedException unexpected) { break; }
280 >                if (lastTestCase == currentTestCase) {
281 >                    System.err.printf(
282 >                        "Looks like we're stuck running test: %s%n",
283 >                        lastTestCase);
284 > //                     System.err.printf(
285 > //                         "Looks like we're stuck running test: %s (%d/%d)%n",
286 > //                         lastTestCase, currentRun, runsPerTest);
287 > //                     System.err.println("availableProcessors=" +
288 > //                         Runtime.getRuntime().availableProcessors());
289 > //                     System.err.printf("cpu model = %s%n", cpuModel());
290 >                    dumpTestThreads();
291 >                    // one stack dump is probably enough; more would be spam
292 >                    break;
293 >                }
294 >                lastTestCase = currentTestCase;
295 >            }}};
296 >        Thread thread = new Thread(checkForWedgedTest, "checkForWedgedTest");
297 >        thread.setDaemon(true);
298 >        thread.start();
299 >    }
300 >
301 > //     public static String cpuModel() {
302 > //         try {
303 > //             java.util.regex.Matcher matcher
304 > //               = Pattern.compile("model name\\s*: (.*)")
305 > //                 .matcher(new String(
306 > //                     java.nio.file.Files.readAllBytes(
307 > //                         java.nio.file.Paths.get("/proc/cpuinfo")), "UTF-8"));
308 > //             matcher.find();
309 > //             return matcher.group(1);
310 > //         } catch (Exception ex) { return null; }
311 > //     }
312 >
313 >    public void runBare() throws Throwable {
314 >        currentTestCase = this;
315          if (methodFilter == null
316 <            || methodFilter.matcher(toString()).find()) {
317 <            for (int i = 0; i < runsPerTest; i++) {
318 <                if (profileTests)
319 <                    runTestProfiled();
320 <                else
321 <                    super.runTest();
322 <            }
316 >            || methodFilter.matcher(toString()).find())
317 >            super.runBare();
318 >    }
319 >
320 >    protected void runTest() throws Throwable {
321 >        for (int i = 0; i < runsPerTest; i++) {
322 >            // currentRun = i;
323 >            if (profileTests)
324 >                runTestProfiled();
325 >            else
326 >                super.runTest();
327          }
328      }
329  
330      protected void runTestProfiled() throws Throwable {
331 <        // Warmup run, notably to trigger all needed classloading.
332 <        super.runTest();
203 <        long t0 = System.nanoTime();
204 <        try {
331 >        for (int i = 0; i < 2; i++) {
332 >            long startTime = System.nanoTime();
333              super.runTest();
334 <        } finally {
335 <            long elapsedMillis = millisElapsedSince(t0);
336 <            if (elapsedMillis >= profileThreshold)
334 >            long elapsedMillis = millisElapsedSince(startTime);
335 >            if (elapsedMillis < profileThreshold)
336 >                break;
337 >            // Never report first run of any test; treat it as a
338 >            // warmup run, notably to trigger all needed classloading,
339 >            if (i > 0)
340                  System.out.printf("%n%s: %d%n", toString(), elapsedMillis);
341          }
342      }
# Line 217 | Line 348 | public class JSR166TestCase extends Test
348          main(suite(), args);
349      }
350  
351 +    static class PithyResultPrinter extends junit.textui.ResultPrinter {
352 +        PithyResultPrinter(java.io.PrintStream writer) { super(writer); }
353 +        long runTime;
354 +        public void startTest(Test test) {}
355 +        protected void printHeader(long runTime) {
356 +            this.runTime = runTime; // defer printing for later
357 +        }
358 +        protected void printFooter(TestResult result) {
359 +            if (result.wasSuccessful()) {
360 +                getWriter().println("OK (" + result.runCount() + " tests)"
361 +                    + "  Time: " + elapsedTimeAsString(runTime));
362 +            } else {
363 +                getWriter().println("Time: " + elapsedTimeAsString(runTime));
364 +                super.printFooter(result);
365 +            }
366 +        }
367 +    }
368 +
369 +    /**
370 +     * Returns a TestRunner that doesn't bother with unnecessary
371 +     * fluff, like printing a "." for each test case.
372 +     */
373 +    static junit.textui.TestRunner newPithyTestRunner() {
374 +        junit.textui.TestRunner runner = new junit.textui.TestRunner();
375 +        runner.setPrinter(new PithyResultPrinter(System.out));
376 +        return runner;
377 +    }
378 +
379      /**
380       * Runs all unit tests in the given test suite.
381       * Actual behavior influenced by jsr166.* system properties.
# Line 228 | Line 387 | public class JSR166TestCase extends Test
387              System.setSecurityManager(new SecurityManager());
388          }
389          for (int i = 0; i < suiteRuns; i++) {
390 <            TestResult result = junit.textui.TestRunner.run(suite);
390 >            TestResult result = newPithyTestRunner().doRun(suite);
391              if (!result.wasSuccessful())
392                  System.exit(1);
393              System.gc();
# Line 312 | Line 471 | public class JSR166TestCase extends Test
471              AbstractQueuedLongSynchronizerTest.suite(),
472              ArrayBlockingQueueTest.suite(),
473              ArrayDequeTest.suite(),
474 +            ArrayListTest.suite(),
475              AtomicBooleanTest.suite(),
476              AtomicIntegerArrayTest.suite(),
477              AtomicIntegerFieldUpdaterTest.suite(),
# Line 334 | Line 494 | public class JSR166TestCase extends Test
494              CopyOnWriteArrayListTest.suite(),
495              CopyOnWriteArraySetTest.suite(),
496              CountDownLatchTest.suite(),
497 +            CountedCompleterTest.suite(),
498              CyclicBarrierTest.suite(),
499              DelayQueueTest.suite(),
500              EntryTest.suite(),
# Line 362 | Line 523 | public class JSR166TestCase extends Test
523              TreeMapTest.suite(),
524              TreeSetTest.suite(),
525              TreeSubMapTest.suite(),
526 <            TreeSubSetTest.suite());
526 >            TreeSubSetTest.suite(),
527 >            VectorTest.suite());
528  
529          // Java8+ test classes
530          if (atLeastJava8()) {
531              String[] java8TestClassNames = {
532 +                "ArrayDeque8Test",
533                  "Atomic8Test",
534                  "CompletableFutureTest",
535                  "ConcurrentHashMap8Test",
536 <                "CountedCompleterTest",
536 >                "CountedCompleter8Test",
537                  "DoubleAccumulatorTest",
538                  "DoubleAdderTest",
539                  "ForkJoinPool8Test",
540                  "ForkJoinTask8Test",
541 +                "LinkedBlockingDeque8Test",
542 +                "LinkedBlockingQueue8Test",
543                  "LongAccumulatorTest",
544                  "LongAdderTest",
545                  "SplittableRandomTest",
546                  "StampedLockTest",
547                  "SubmissionPublisherTest",
548                  "ThreadLocalRandom8Test",
549 +                "TimeUnit8Test",
550              };
551              addNamedTestClasses(suite, java8TestClassNames);
552          }
# Line 388 | Line 554 | public class JSR166TestCase extends Test
554          // Java9+ test classes
555          if (atLeastJava9()) {
556              String[] java9TestClassNames = {
557 <                // Currently empty
557 >                "AtomicBoolean9Test",
558 >                "AtomicInteger9Test",
559 >                "AtomicIntegerArray9Test",
560 >                "AtomicLong9Test",
561 >                "AtomicLongArray9Test",
562 >                "AtomicReference9Test",
563 >                "AtomicReferenceArray9Test",
564 >                "ExecutorCompletionService9Test",
565 >                "ForkJoinPool9Test",
566              };
567              addNamedTestClasses(suite, java9TestClassNames);
568          }
# Line 399 | Line 573 | public class JSR166TestCase extends Test
573      /** Returns list of junit-style test method names in given class. */
574      public static ArrayList<String> testMethodNames(Class<?> testClass) {
575          Method[] methods = testClass.getDeclaredMethods();
576 <        ArrayList<String> names = new ArrayList<String>(methods.length);
576 >        ArrayList<String> names = new ArrayList<>(methods.length);
577          for (Method method : methods) {
578              if (method.getName().startsWith("test")
579                  && Modifier.isPublic(method.getModifiers())
# Line 455 | Line 629 | public class JSR166TestCase extends Test
629          } else {
630              return new TestSuite();
631          }
458
632      }
633  
634      // Delays for timing-dependent tests, in milliseconds.
# Line 466 | Line 639 | public class JSR166TestCase extends Test
639      public static long LONG_DELAY_MS;
640  
641      /**
642 <     * Returns the shortest timed delay. This could
643 <     * be reimplemented to use for example a Property.
642 >     * Returns the shortest timed delay. This can be scaled up for
643 >     * slow machines using the jsr166.delay.factor system property,
644 >     * or via jtreg's -timeoutFactor: flag.
645 >     * http://openjdk.java.net/jtreg/command-help.html
646       */
647      protected long getShortDelay() {
648 <        return 50;
648 >        return (long) (50 * delayFactor);
649      }
650  
651      /**
# Line 504 | Line 679 | public class JSR166TestCase extends Test
679       * The first exception encountered if any threadAssertXXX method fails.
680       */
681      private final AtomicReference<Throwable> threadFailure
682 <        = new AtomicReference<Throwable>(null);
682 >        = new AtomicReference<>(null);
683  
684      /**
685       * Records an exception so that it can be rethrown later in the test
# Line 513 | Line 688 | public class JSR166TestCase extends Test
688       * the same test have no effect.
689       */
690      public void threadRecordFailure(Throwable t) {
691 +        System.err.println(t);
692 +        dumpTestThreads();
693          threadFailure.compareAndSet(null, t);
694      }
695  
# Line 520 | Line 697 | public class JSR166TestCase extends Test
697          setDelays();
698      }
699  
700 +    void tearDownFail(String format, Object... args) {
701 +        String msg = toString() + ": " + String.format(format, args);
702 +        System.err.println(msg);
703 +        dumpTestThreads();
704 +        throw new AssertionFailedError(msg);
705 +    }
706 +
707      /**
708       * Extra checks that get done for all test cases.
709       *
# Line 547 | Line 731 | public class JSR166TestCase extends Test
731          }
732  
733          if (Thread.interrupted())
734 <            throw new AssertionFailedError("interrupt status set in main thread");
734 >            tearDownFail("interrupt status set in main thread");
735  
736          checkForkJoinPoolThreadLeaks();
737      }
738  
739      /**
740 <     * Finds missing try { ... } finally { joinPool(e); }
740 >     * Finds missing PoolCleaners
741       */
742      void checkForkJoinPoolThreadLeaks() throws InterruptedException {
743 <        Thread[] survivors = new Thread[5];
743 >        Thread[] survivors = new Thread[7];
744          int count = Thread.enumerate(survivors);
745          for (int i = 0; i < count; i++) {
746              Thread thread = survivors[i];
# Line 564 | Line 748 | public class JSR166TestCase extends Test
748              if (name.startsWith("ForkJoinPool-")) {
749                  // give thread some time to terminate
750                  thread.join(LONG_DELAY_MS);
751 <                if (!thread.isAlive()) continue;
752 <                throw new AssertionFailedError
753 <                    (String.format("Found leaked ForkJoinPool thread test=%s thread=%s%n",
570 <                                   toString(), name));
751 >                if (thread.isAlive())
752 >                    tearDownFail("Found leaked ForkJoinPool thread thread=%s",
753 >                                 thread);
754              }
755          }
756 +
757 +        if (!ForkJoinPool.commonPool()
758 +            .awaitQuiescence(LONG_DELAY_MS, MILLISECONDS))
759 +            tearDownFail("ForkJoin common pool thread stuck");
760      }
761  
762      /**
# Line 582 | Line 769 | public class JSR166TestCase extends Test
769              fail(reason);
770          } catch (AssertionFailedError t) {
771              threadRecordFailure(t);
772 <            fail(reason);
772 >            throw t;
773          }
774      }
775  
# Line 709 | Line 896 | public class JSR166TestCase extends Test
896      /**
897       * Delays, via Thread.sleep, for the given millisecond delay, but
898       * if the sleep is shorter than specified, may re-sleep or yield
899 <     * until time elapses.
899 >     * until time elapses.  Ensures that the given time, as measured
900 >     * by System.nanoTime(), has elapsed.
901       */
902      static void delay(long millis) throws InterruptedException {
903 <        long startTime = System.nanoTime();
904 <        long ns = millis * 1000 * 1000;
905 <        for (;;) {
903 >        long nanos = millis * (1000 * 1000);
904 >        final long wakeupTime = System.nanoTime() + nanos;
905 >        do {
906              if (millis > 0L)
907                  Thread.sleep(millis);
908              else // too short to sleep
909                  Thread.yield();
910 <            long d = ns - (System.nanoTime() - startTime);
911 <            if (d > 0L)
912 <                millis = d / (1000 * 1000);
913 <            else
914 <                break;
910 >            nanos = wakeupTime - System.nanoTime();
911 >            millis = nanos / (1000 * 1000);
912 >        } while (nanos >= 0L);
913 >    }
914 >
915 >    /**
916 >     * Allows use of try-with-resources with per-test thread pools.
917 >     */
918 >    class PoolCleaner implements AutoCloseable {
919 >        private final ExecutorService pool;
920 >        public PoolCleaner(ExecutorService pool) { this.pool = pool; }
921 >        public void close() { joinPool(pool); }
922 >    }
923 >
924 >    /**
925 >     * An extension of PoolCleaner that has an action to release the pool.
926 >     */
927 >    class PoolCleanerWithReleaser extends PoolCleaner {
928 >        private final Runnable releaser;
929 >        public PoolCleanerWithReleaser(ExecutorService pool, Runnable releaser) {
930 >            super(pool);
931 >            this.releaser = releaser;
932 >        }
933 >        public void close() {
934 >            try {
935 >                releaser.run();
936 >            } finally {
937 >                super.close();
938 >            }
939          }
940      }
941  
942 +    PoolCleaner cleaner(ExecutorService pool) {
943 +        return new PoolCleaner(pool);
944 +    }
945 +
946 +    PoolCleaner cleaner(ExecutorService pool, Runnable releaser) {
947 +        return new PoolCleanerWithReleaser(pool, releaser);
948 +    }
949 +
950 +    PoolCleaner cleaner(ExecutorService pool, CountDownLatch latch) {
951 +        return new PoolCleanerWithReleaser(pool, releaser(latch));
952 +    }
953 +
954 +    Runnable releaser(final CountDownLatch latch) {
955 +        return new Runnable() { public void run() {
956 +            do { latch.countDown(); }
957 +            while (latch.getCount() > 0);
958 +        }};
959 +    }
960 +
961 +    PoolCleaner cleaner(ExecutorService pool, AtomicBoolean flag) {
962 +        return new PoolCleanerWithReleaser(pool, releaser(flag));
963 +    }
964 +
965 +    Runnable releaser(final AtomicBoolean flag) {
966 +        return new Runnable() { public void run() { flag.set(true); }};
967 +    }
968 +
969      /**
970       * Waits out termination of a thread pool or fails doing so.
971       */
972      void joinPool(ExecutorService pool) {
973          try {
974              pool.shutdown();
975 <            if (!pool.awaitTermination(2 * LONG_DELAY_MS, MILLISECONDS))
976 <                fail("ExecutorService " + pool +
977 <                     " did not terminate in a timely manner");
975 >            if (!pool.awaitTermination(2 * LONG_DELAY_MS, MILLISECONDS)) {
976 >                try {
977 >                    threadFail("ExecutorService " + pool +
978 >                               " did not terminate in a timely manner");
979 >                } finally {
980 >                    // last resort, for the benefit of subsequent tests
981 >                    pool.shutdownNow();
982 >                    pool.awaitTermination(MEDIUM_DELAY_MS, MILLISECONDS);
983 >                }
984 >            }
985          } catch (SecurityException ok) {
986              // Allowed in case test doesn't have privs
987          } catch (InterruptedException fail) {
988 <            fail("Unexpected InterruptedException");
988 >            threadFail("Unexpected InterruptedException");
989          }
990      }
991  
992 <    /** Like Runnable, but with the freedom to throw anything */
993 <    interface Thunk { public void run() throws Throwable; }
992 >    /**
993 >     * Like Runnable, but with the freedom to throw anything.
994 >     * junit folks had the same idea:
995 >     * http://junit.org/junit5/docs/snapshot/api/org/junit/gen5/api/Executable.html
996 >     */
997 >    interface Action { public void run() throws Throwable; }
998  
999      /**
1000 <     * Runs all the given tasks in parallel, failing if any fail.
1000 >     * Runs all the given actions in parallel, failing if any fail.
1001       * Useful for running multiple variants of tests that are
1002       * necessarily individually slow because they must block.
1003       */
1004 <    void testInParallel(Thunk ... thunks) {
1004 >    void testInParallel(Action ... actions) {
1005          ExecutorService pool = Executors.newCachedThreadPool();
1006 <        try {
1007 <            ArrayList<Future<?>> futures = new ArrayList<>(thunks.length);
1008 <            for (final Thunk thunk : thunks)
1006 >        try (PoolCleaner cleaner = cleaner(pool)) {
1007 >            ArrayList<Future<?>> futures = new ArrayList<>(actions.length);
1008 >            for (final Action action : actions)
1009                  futures.add(pool.submit(new CheckedRunnable() {
1010 <                    public void realRun() throws Throwable { thunk.run();}}));
1010 >                    public void realRun() throws Throwable { action.run();}}));
1011              for (Future<?> future : futures)
1012                  try {
1013                      assertNull(future.get(LONG_DELAY_MS, MILLISECONDS));
# Line 766 | Line 1016 | public class JSR166TestCase extends Test
1016                  } catch (Exception ex) {
1017                      threadUnexpectedException(ex);
1018                  }
769        } finally {
770            joinPool(pool);
1019          }
1020      }
1021  
1022      /**
1023 <     * A debugging tool to print all stack traces, as jstack does.
1023 >     * A debugging tool to print stack traces of most threads, as jstack does.
1024 >     * Uninteresting threads are filtered out.
1025       */
1026 <    static void printAllStackTraces() {
1027 <        for (ThreadInfo info :
1028 <                 ManagementFactory.getThreadMXBean()
1029 <                 .dumpAllThreads(true, true))
1026 >    static void dumpTestThreads() {
1027 >        SecurityManager sm = System.getSecurityManager();
1028 >        if (sm != null) {
1029 >            try {
1030 >                System.setSecurityManager(null);
1031 >            } catch (SecurityException giveUp) {
1032 >                return;
1033 >            }
1034 >        }
1035 >
1036 >        ThreadMXBean threadMXBean = ManagementFactory.getThreadMXBean();
1037 >        System.err.println("------ stacktrace dump start ------");
1038 >        for (ThreadInfo info : threadMXBean.dumpAllThreads(true, true)) {
1039 >            final String name = info.getThreadName();
1040 >            String lockName;
1041 >            if ("Signal Dispatcher".equals(name))
1042 >                continue;
1043 >            if ("Reference Handler".equals(name)
1044 >                && (lockName = info.getLockName()) != null
1045 >                && lockName.startsWith("java.lang.ref.Reference$Lock"))
1046 >                continue;
1047 >            if ("Finalizer".equals(name)
1048 >                && (lockName = info.getLockName()) != null
1049 >                && lockName.startsWith("java.lang.ref.ReferenceQueue$Lock"))
1050 >                continue;
1051 >            if ("checkForWedgedTest".equals(name))
1052 >                continue;
1053              System.err.print(info);
1054 +        }
1055 +        System.err.println("------ stacktrace dump end ------");
1056 +
1057 +        if (sm != null) System.setSecurityManager(sm);
1058      }
1059  
1060      /**
# Line 798 | Line 1074 | public class JSR166TestCase extends Test
1074              delay(millis);
1075              assertTrue(thread.isAlive());
1076          } catch (InterruptedException fail) {
1077 <            fail("Unexpected InterruptedException");
1077 >            threadFail("Unexpected InterruptedException");
1078          }
1079      }
1080  
# Line 820 | Line 1096 | public class JSR166TestCase extends Test
1096              for (Thread thread : threads)
1097                  assertTrue(thread.isAlive());
1098          } catch (InterruptedException fail) {
1099 <            fail("Unexpected InterruptedException");
1099 >            threadFail("Unexpected InterruptedException");
1100          }
1101      }
1102  
# Line 862 | Line 1138 | public class JSR166TestCase extends Test
1138      }
1139  
1140      /**
1141 +     * The maximum number of consecutive spurious wakeups we should
1142 +     * tolerate (from APIs like LockSupport.park) before failing a test.
1143 +     */
1144 +    static final int MAX_SPURIOUS_WAKEUPS = 10;
1145 +
1146 +    /**
1147       * The number of elements to place in collections, arrays, etc.
1148       */
1149      public static final int SIZE = 20;
# Line 965 | Line 1247 | public class JSR166TestCase extends Test
1247          }
1248          public void refresh() {}
1249          public String toString() {
1250 <            List<Permission> ps = new ArrayList<Permission>();
1250 >            List<Permission> ps = new ArrayList<>();
1251              for (Enumeration<Permission> e = perms.elements(); e.hasMoreElements();)
1252                  ps.add(e.nextElement());
1253              return "AdjustablePolicy with permissions " + ps;
# Line 995 | Line 1277 | public class JSR166TestCase extends Test
1277       * Sleeps until the given time has elapsed.
1278       * Throws AssertionFailedError if interrupted.
1279       */
1280 <    void sleep(long millis) {
1280 >    static void sleep(long millis) {
1281          try {
1282              delay(millis);
1283          } catch (InterruptedException fail) {
# Line 1011 | Line 1293 | public class JSR166TestCase extends Test
1293       * thread to enter a wait state: BLOCKED, WAITING, or TIMED_WAITING.
1294       */
1295      void waitForThreadToEnterWaitState(Thread thread, long timeoutMillis) {
1296 <        long startTime = System.nanoTime();
1296 >        long startTime = 0L;
1297          for (;;) {
1298              Thread.State s = thread.getState();
1299              if (s == Thread.State.BLOCKED ||
# Line 1020 | Line 1302 | public class JSR166TestCase extends Test
1302                  return;
1303              else if (s == Thread.State.TERMINATED)
1304                  fail("Unexpected thread termination");
1305 +            else if (startTime == 0L)
1306 +                startTime = System.nanoTime();
1307              else if (millisElapsedSince(startTime) > timeoutMillis) {
1308                  threadAssertTrue(thread.isAlive());
1309 <                return;
1309 >                fail("timed out waiting for thread to enter wait state");
1310 >            }
1311 >            Thread.yield();
1312 >        }
1313 >    }
1314 >
1315 >    /**
1316 >     * Spin-waits up to the specified number of milliseconds for the given
1317 >     * thread to enter a wait state: BLOCKED, WAITING, or TIMED_WAITING,
1318 >     * and additionally satisfy the given condition.
1319 >     */
1320 >    void waitForThreadToEnterWaitState(
1321 >        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          }
1343      }
1344  
1345      /**
1346 <     * Waits up to LONG_DELAY_MS for the given thread to enter a wait
1347 <     * state: BLOCKED, WAITING, or TIMED_WAITING.
1346 >     * Spin-waits up to LONG_DELAY_MS milliseconds for the given thread to
1347 >     * enter a wait state: BLOCKED, WAITING, or TIMED_WAITING.
1348       */
1349      void waitForThreadToEnterWaitState(Thread thread) {
1350          waitForThreadToEnterWaitState(thread, LONG_DELAY_MS);
1351      }
1352  
1353      /**
1354 +     * Spin-waits up to LONG_DELAY_MS milliseconds for the given thread to
1355 +     * enter a wait state: BLOCKED, WAITING, or TIMED_WAITING,
1356 +     * and additionally satisfy the given condition.
1357 +     */
1358 +    void waitForThreadToEnterWaitState(
1359 +        Thread thread, Callable<Boolean> waitingForGodot) {
1360 +        waitForThreadToEnterWaitState(thread, LONG_DELAY_MS, waitingForGodot);
1361 +    }
1362 +
1363 +    /**
1364       * Returns the number of milliseconds since time given by
1365       * startNanoTime, which must have been previously returned from a
1366       * call to {@link System#nanoTime()}.
# Line 1098 | Line 1422 | public class JSR166TestCase extends Test
1422          } finally {
1423              if (t.getState() != Thread.State.TERMINATED) {
1424                  t.interrupt();
1425 <                fail("Test timed out");
1425 >                threadFail("timed out waiting for thread to terminate");
1426              }
1427          }
1428      }
# Line 1223 | Line 1547 | public class JSR166TestCase extends Test
1547      public static final String TEST_STRING = "a test string";
1548  
1549      public static class StringTask implements Callable<String> {
1550 <        public String call() { return TEST_STRING; }
1550 >        final String value;
1551 >        public StringTask() { this(TEST_STRING); }
1552 >        public StringTask(String value) { this.value = value; }
1553 >        public String call() { return value; }
1554      }
1555  
1556      public Callable<String> latchAwaitingStringTask(final CountDownLatch latch) {
# Line 1236 | Line 1563 | public class JSR166TestCase extends Test
1563              }};
1564      }
1565  
1566 <    public Runnable awaiter(final CountDownLatch latch) {
1566 >    public Runnable countDowner(final CountDownLatch latch) {
1567          return new CheckedRunnable() {
1568              public void realRun() throws InterruptedException {
1569 <                await(latch);
1569 >                latch.countDown();
1570              }};
1571      }
1572  
1573 <    public void await(CountDownLatch latch) {
1573 >    class LatchAwaiter extends CheckedRunnable {
1574 >        static final int NEW = 0;
1575 >        static final int RUNNING = 1;
1576 >        static final int DONE = 2;
1577 >        final CountDownLatch latch;
1578 >        int state = NEW;
1579 >        LatchAwaiter(CountDownLatch latch) { this.latch = latch; }
1580 >        public void realRun() throws InterruptedException {
1581 >            state = 1;
1582 >            await(latch);
1583 >            state = 2;
1584 >        }
1585 >    }
1586 >
1587 >    public LatchAwaiter awaiter(CountDownLatch latch) {
1588 >        return new LatchAwaiter(latch);
1589 >    }
1590 >
1591 >    public void await(CountDownLatch latch, long timeoutMillis) {
1592          try {
1593 <            assertTrue(latch.await(LONG_DELAY_MS, MILLISECONDS));
1593 >            if (!latch.await(timeoutMillis, MILLISECONDS))
1594 >                fail("timed out waiting for CountDownLatch for "
1595 >                     + (timeoutMillis/1000) + " sec");
1596          } catch (Throwable fail) {
1597              threadUnexpectedException(fail);
1598          }
1599      }
1600  
1601 +    public void await(CountDownLatch latch) {
1602 +        await(latch, LONG_DELAY_MS);
1603 +    }
1604 +
1605      public void await(Semaphore semaphore) {
1606          try {
1607 <            assertTrue(semaphore.tryAcquire(LONG_DELAY_MS, MILLISECONDS));
1607 >            if (!semaphore.tryAcquire(LONG_DELAY_MS, MILLISECONDS))
1608 >                fail("timed out waiting for Semaphore for "
1609 >                     + (LONG_DELAY_MS/1000) + " sec");
1610          } catch (Throwable fail) {
1611              threadUnexpectedException(fail);
1612          }
# Line 1483 | Line 1836 | public class JSR166TestCase extends Test
1836       * A CyclicBarrier that uses timed await and fails with
1837       * AssertionFailedErrors instead of throwing checked exceptions.
1838       */
1839 <    public class CheckedBarrier extends CyclicBarrier {
1839 >    public static class CheckedBarrier extends CyclicBarrier {
1840          public CheckedBarrier(int parties) { super(parties); }
1841  
1842          public int await() {
# Line 1547 | Line 1900 | public class JSR166TestCase extends Test
1900          }
1901      }
1902  
1903 +    void assertImmutable(final Object o) {
1904 +        if (o instanceof Collection) {
1905 +            assertThrows(
1906 +                UnsupportedOperationException.class,
1907 +                new Runnable() { public void run() {
1908 +                        ((Collection) o).add(null);}});
1909 +        }
1910 +    }
1911 +
1912      @SuppressWarnings("unchecked")
1913      <T> T serialClone(T o) {
1914          try {
1915              ObjectInputStream ois = new ObjectInputStream
1916                  (new ByteArrayInputStream(serialBytes(o)));
1917              T clone = (T) ois.readObject();
1918 +            if (o == clone) assertImmutable(o);
1919              assertSame(o.getClass(), clone.getClass());
1920              return clone;
1921          } catch (Throwable fail) {
# Line 1561 | Line 1924 | public class JSR166TestCase extends Test
1924          }
1925      }
1926  
1927 +    /**
1928 +     * A version of serialClone that leaves error handling (for
1929 +     * e.g. NotSerializableException) up to the caller.
1930 +     */
1931 +    @SuppressWarnings("unchecked")
1932 +    <T> T serialClonePossiblyFailing(T o)
1933 +        throws ReflectiveOperationException, java.io.IOException {
1934 +        ByteArrayOutputStream bos = new ByteArrayOutputStream();
1935 +        ObjectOutputStream oos = new ObjectOutputStream(bos);
1936 +        oos.writeObject(o);
1937 +        oos.flush();
1938 +        oos.close();
1939 +        ObjectInputStream ois = new ObjectInputStream
1940 +            (new ByteArrayInputStream(bos.toByteArray()));
1941 +        T clone = (T) ois.readObject();
1942 +        if (o == clone) assertImmutable(o);
1943 +        assertSame(o.getClass(), clone.getClass());
1944 +        return clone;
1945 +    }
1946 +
1947 +    /**
1948 +     * If o implements Cloneable and has a public clone method,
1949 +     * returns a clone of o, else null.
1950 +     */
1951 +    @SuppressWarnings("unchecked")
1952 +    <T> T cloneableClone(T o) {
1953 +        if (!(o instanceof Cloneable)) return null;
1954 +        final T clone;
1955 +        try {
1956 +            clone = (T) o.getClass().getMethod("clone").invoke(o);
1957 +        } catch (NoSuchMethodException ok) {
1958 +            return null;
1959 +        } catch (ReflectiveOperationException unexpected) {
1960 +            throw new Error(unexpected);
1961 +        }
1962 +        assertNotSame(o, clone); // not 100% guaranteed by spec
1963 +        assertSame(o.getClass(), clone.getClass());
1964 +        return clone;
1965 +    }
1966 +
1967      public void assertThrows(Class<? extends Throwable> expectedExceptionClass,
1968                               Runnable... throwingActions) {
1969          for (Runnable throwingAction : throwingActions) {
# Line 1589 | Line 1992 | public class JSR166TestCase extends Test
1992          } catch (NoSuchElementException success) {}
1993          assertFalse(it.hasNext());
1994      }
1995 +
1996 +    public <T> Callable<T> callableThrowing(final Exception ex) {
1997 +        return new Callable<T>() { public T call() throws Exception { throw ex; }};
1998 +    }
1999 +
2000 +    public Runnable runnableThrowing(final RuntimeException ex) {
2001 +        return new Runnable() { public void run() { throw ex; }};
2002 +    }
2003 +
2004 +    /** A reusable thread pool to be shared by tests. */
2005 +    static final ExecutorService cachedThreadPool =
2006 +        new ThreadPoolExecutor(0, Integer.MAX_VALUE,
2007 +                               1000L, MILLISECONDS,
2008 +                               new SynchronousQueue<Runnable>());
2009 +
2010 +    static <T> void shuffle(T[] array) {
2011 +        Collections.shuffle(Arrays.asList(array), ThreadLocalRandom.current());
2012 +    }
2013   }

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines