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.143 by jsr166, Sun Sep 13 16:28:14 2015 UTC vs.
Revision 1.229 by jsr166, Sun May 14 03:15:37 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 106 | Line 148 | import junit.framework.TestSuite;
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.
151 > * cover multiple methods when they cannot be tested in isolation.
152   *
153   * <li>The documentation style for testcases is to provide as javadoc
154   * a simple sentence or two describing the property that the testcase
# 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, but expecting varhandle tests
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 483 | Line 658 | public class JSR166TestCase extends Test
658          LONG_DELAY_MS   = SHORT_DELAY_MS * 200;
659      }
660  
661 +    private static final long TIMEOUT_DELAY_MS
662 +        = (long) (12.0 * Math.cbrt(delayFactor));
663 +
664      /**
665 <     * Returns a timeout in milliseconds to be used in tests that
666 <     * verify that operations block or time out.
665 >     * Returns a timeout in milliseconds to be used in tests that verify
666 >     * that operations block or time out.  We want this to be longer
667 >     * than the OS scheduling quantum, but not too long, so don't scale
668 >     * linearly with delayFactor; we use "crazy" cube root instead.
669       */
670 <    long timeoutMillis() {
671 <        return SHORT_DELAY_MS / 4;
670 >    static long timeoutMillis() {
671 >        return TIMEOUT_DELAY_MS;
672      }
673  
674      /**
# Line 504 | Line 684 | public class JSR166TestCase extends Test
684       * The first exception encountered if any threadAssertXXX method fails.
685       */
686      private final AtomicReference<Throwable> threadFailure
687 <        = new AtomicReference<Throwable>(null);
687 >        = new AtomicReference<>(null);
688  
689      /**
690       * Records an exception so that it can be rethrown later in the test
# Line 513 | Line 693 | public class JSR166TestCase extends Test
693       * the same test have no effect.
694       */
695      public void threadRecordFailure(Throwable t) {
696 +        System.err.println(t);
697 +        dumpTestThreads();
698          threadFailure.compareAndSet(null, t);
699      }
700  
# Line 520 | Line 702 | public class JSR166TestCase extends Test
702          setDelays();
703      }
704  
705 +    void tearDownFail(String format, Object... args) {
706 +        String msg = toString() + ": " + String.format(format, args);
707 +        System.err.println(msg);
708 +        dumpTestThreads();
709 +        throw new AssertionFailedError(msg);
710 +    }
711 +
712      /**
713       * Extra checks that get done for all test cases.
714       *
# Line 547 | Line 736 | public class JSR166TestCase extends Test
736          }
737  
738          if (Thread.interrupted())
739 <            throw new AssertionFailedError("interrupt status set in main thread");
739 >            tearDownFail("interrupt status set in main thread");
740  
741          checkForkJoinPoolThreadLeaks();
742      }
743  
744      /**
745 <     * Finds missing try { ... } finally { joinPool(e); }
745 >     * Finds missing PoolCleaners
746       */
747      void checkForkJoinPoolThreadLeaks() throws InterruptedException {
748 <        Thread[] survivors = new Thread[5];
748 >        Thread[] survivors = new Thread[7];
749          int count = Thread.enumerate(survivors);
750          for (int i = 0; i < count; i++) {
751              Thread thread = survivors[i];
# Line 564 | Line 753 | public class JSR166TestCase extends Test
753              if (name.startsWith("ForkJoinPool-")) {
754                  // give thread some time to terminate
755                  thread.join(LONG_DELAY_MS);
756 <                if (!thread.isAlive()) continue;
757 <                throw new AssertionFailedError
758 <                    (String.format("Found leaked ForkJoinPool thread test=%s thread=%s%n",
570 <                                   toString(), name));
756 >                if (thread.isAlive())
757 >                    tearDownFail("Found leaked ForkJoinPool thread thread=%s",
758 >                                 thread);
759              }
760          }
761 +
762 +        if (!ForkJoinPool.commonPool()
763 +            .awaitQuiescence(LONG_DELAY_MS, MILLISECONDS))
764 +            tearDownFail("ForkJoin common pool thread stuck");
765      }
766  
767      /**
# Line 582 | Line 774 | public class JSR166TestCase extends Test
774              fail(reason);
775          } catch (AssertionFailedError t) {
776              threadRecordFailure(t);
777 <            fail(reason);
777 >            throw t;
778          }
779      }
780  
# Line 709 | Line 901 | public class JSR166TestCase extends Test
901      /**
902       * Delays, via Thread.sleep, for the given millisecond delay, but
903       * if the sleep is shorter than specified, may re-sleep or yield
904 <     * until time elapses.
904 >     * until time elapses.  Ensures that the given time, as measured
905 >     * by System.nanoTime(), has elapsed.
906       */
907      static void delay(long millis) throws InterruptedException {
908 <        long startTime = System.nanoTime();
909 <        long ns = millis * 1000 * 1000;
910 <        for (;;) {
908 >        long nanos = millis * (1000 * 1000);
909 >        final long wakeupTime = System.nanoTime() + nanos;
910 >        do {
911              if (millis > 0L)
912                  Thread.sleep(millis);
913              else // too short to sleep
914                  Thread.yield();
915 <            long d = ns - (System.nanoTime() - startTime);
916 <            if (d > 0L)
917 <                millis = d / (1000 * 1000);
918 <            else
919 <                break;
915 >            nanos = wakeupTime - System.nanoTime();
916 >            millis = nanos / (1000 * 1000);
917 >        } while (nanos >= 0L);
918 >    }
919 >
920 >    /**
921 >     * Allows use of try-with-resources with per-test thread pools.
922 >     */
923 >    class PoolCleaner implements AutoCloseable {
924 >        private final ExecutorService pool;
925 >        public PoolCleaner(ExecutorService pool) { this.pool = pool; }
926 >        public void close() { joinPool(pool); }
927 >    }
928 >
929 >    /**
930 >     * An extension of PoolCleaner that has an action to release the pool.
931 >     */
932 >    class PoolCleanerWithReleaser extends PoolCleaner {
933 >        private final Runnable releaser;
934 >        public PoolCleanerWithReleaser(ExecutorService pool, Runnable releaser) {
935 >            super(pool);
936 >            this.releaser = releaser;
937          }
938 +        public void close() {
939 +            try {
940 +                releaser.run();
941 +            } finally {
942 +                super.close();
943 +            }
944 +        }
945 +    }
946 +
947 +    PoolCleaner cleaner(ExecutorService pool) {
948 +        return new PoolCleaner(pool);
949 +    }
950 +
951 +    PoolCleaner cleaner(ExecutorService pool, Runnable releaser) {
952 +        return new PoolCleanerWithReleaser(pool, releaser);
953 +    }
954 +
955 +    PoolCleaner cleaner(ExecutorService pool, CountDownLatch latch) {
956 +        return new PoolCleanerWithReleaser(pool, releaser(latch));
957 +    }
958 +
959 +    Runnable releaser(final CountDownLatch latch) {
960 +        return new Runnable() { public void run() {
961 +            do { latch.countDown(); }
962 +            while (latch.getCount() > 0);
963 +        }};
964 +    }
965 +
966 +    PoolCleaner cleaner(ExecutorService pool, AtomicBoolean flag) {
967 +        return new PoolCleanerWithReleaser(pool, releaser(flag));
968 +    }
969 +
970 +    Runnable releaser(final AtomicBoolean flag) {
971 +        return new Runnable() { public void run() { flag.set(true); }};
972      }
973  
974      /**
# Line 733 | Line 977 | public class JSR166TestCase extends Test
977      void joinPool(ExecutorService pool) {
978          try {
979              pool.shutdown();
980 <            if (!pool.awaitTermination(2 * LONG_DELAY_MS, MILLISECONDS))
981 <                fail("ExecutorService " + pool +
982 <                     " did not terminate in a timely manner");
980 >            if (!pool.awaitTermination(2 * LONG_DELAY_MS, MILLISECONDS)) {
981 >                try {
982 >                    threadFail("ExecutorService " + pool +
983 >                               " did not terminate in a timely manner");
984 >                } finally {
985 >                    // last resort, for the benefit of subsequent tests
986 >                    pool.shutdownNow();
987 >                    pool.awaitTermination(MEDIUM_DELAY_MS, MILLISECONDS);
988 >                }
989 >            }
990          } catch (SecurityException ok) {
991              // Allowed in case test doesn't have privs
992          } catch (InterruptedException fail) {
993 <            fail("Unexpected InterruptedException");
993 >            threadFail("Unexpected InterruptedException");
994          }
995      }
996  
997 <    /** Like Runnable, but with the freedom to throw anything */
997 >    /**
998 >     * Like Runnable, but with the freedom to throw anything.
999 >     * junit folks had the same idea:
1000 >     * http://junit.org/junit5/docs/snapshot/api/org/junit/gen5/api/Executable.html
1001 >     */
1002      interface Action { public void run() throws Throwable; }
1003  
1004      /**
# Line 753 | Line 1008 | public class JSR166TestCase extends Test
1008       */
1009      void testInParallel(Action ... actions) {
1010          ExecutorService pool = Executors.newCachedThreadPool();
1011 <        try {
1011 >        try (PoolCleaner cleaner = cleaner(pool)) {
1012              ArrayList<Future<?>> futures = new ArrayList<>(actions.length);
1013              for (final Action action : actions)
1014                  futures.add(pool.submit(new CheckedRunnable() {
# Line 766 | Line 1021 | public class JSR166TestCase extends Test
1021                  } catch (Exception ex) {
1022                      threadUnexpectedException(ex);
1023                  }
769        } finally {
770            joinPool(pool);
1024          }
1025      }
1026  
1027      /**
1028 <     * A debugging tool to print all stack traces, as jstack does.
1029 <     */
777 <    static void printAllStackTraces() {
778 <        for (ThreadInfo info :
779 <                 ManagementFactory.getThreadMXBean()
780 <                 .dumpAllThreads(true, true))
781 <            System.err.print(info);
782 <    }
783 <
784 <    /**
785 <     * Checks that thread does not terminate within the default
786 <     * millisecond delay of {@code timeoutMillis()}.
1028 >     * A debugging tool to print stack traces of most threads, as jstack does.
1029 >     * Uninteresting threads are filtered out.
1030       */
1031 <    void assertThreadStaysAlive(Thread thread) {
1032 <        assertThreadStaysAlive(thread, timeoutMillis());
1033 <    }
1031 >    static void dumpTestThreads() {
1032 >        SecurityManager sm = System.getSecurityManager();
1033 >        if (sm != null) {
1034 >            try {
1035 >                System.setSecurityManager(null);
1036 >            } catch (SecurityException giveUp) {
1037 >                return;
1038 >            }
1039 >        }
1040  
1041 <    /**
1042 <     * Checks that thread does not terminate within the given millisecond delay.
1043 <     */
1044 <    void assertThreadStaysAlive(Thread thread, long millis) {
1045 <        try {
1046 <            // No need to optimize the failing case via Thread.join.
1047 <            delay(millis);
1048 <            assertTrue(thread.isAlive());
1049 <        } catch (InterruptedException fail) {
1050 <            fail("Unexpected InterruptedException");
1041 >        ThreadMXBean threadMXBean = ManagementFactory.getThreadMXBean();
1042 >        System.err.println("------ stacktrace dump start ------");
1043 >        for (ThreadInfo info : threadMXBean.dumpAllThreads(true, true)) {
1044 >            final String name = info.getThreadName();
1045 >            String lockName;
1046 >            if ("Signal Dispatcher".equals(name))
1047 >                continue;
1048 >            if ("Reference Handler".equals(name)
1049 >                && (lockName = info.getLockName()) != null
1050 >                && lockName.startsWith("java.lang.ref.Reference$Lock"))
1051 >                continue;
1052 >            if ("Finalizer".equals(name)
1053 >                && (lockName = info.getLockName()) != null
1054 >                && lockName.startsWith("java.lang.ref.ReferenceQueue$Lock"))
1055 >                continue;
1056 >            if ("checkForWedgedTest".equals(name))
1057 >                continue;
1058 >            System.err.print(info);
1059          }
1060 <    }
1060 >        System.err.println("------ stacktrace dump end ------");
1061  
1062 <    /**
806 <     * Checks that the threads do not terminate within the default
807 <     * millisecond delay of {@code timeoutMillis()}.
808 <     */
809 <    void assertThreadsStayAlive(Thread... threads) {
810 <        assertThreadsStayAlive(timeoutMillis(), threads);
1062 >        if (sm != null) System.setSecurityManager(sm);
1063      }
1064  
1065      /**
1066 <     * Checks that the threads do not terminate within the given millisecond delay.
1066 >     * Checks that thread eventually enters the expected blocked thread state.
1067       */
1068 <    void assertThreadsStayAlive(long millis, Thread... threads) {
1069 <        try {
1070 <            // No need to optimize the failing case via Thread.join.
1071 <            delay(millis);
1072 <            for (Thread thread : threads)
1073 <                assertTrue(thread.isAlive());
1074 <        } catch (InterruptedException fail) {
1075 <            fail("Unexpected InterruptedException");
1068 >    void assertThreadBlocks(Thread thread, Thread.State expected) {
1069 >        // always sleep at least 1 ms, with high probability avoiding
1070 >        // transitory states
1071 >        for (long retries = LONG_DELAY_MS * 3 / 4; retries-->0; ) {
1072 >            try { delay(1); }
1073 >            catch (InterruptedException fail) {
1074 >                fail("Unexpected InterruptedException");
1075 >            }
1076 >            Thread.State s = thread.getState();
1077 >            if (s == expected)
1078 >                return;
1079 >            else if (s == Thread.State.TERMINATED)
1080 >                fail("Unexpected thread termination");
1081          }
1082 +        fail("timed out waiting for thread to enter thread state " + expected);
1083      }
1084  
1085      /**
# Line 862 | Line 1120 | public class JSR166TestCase extends Test
1120      }
1121  
1122      /**
1123 +     * The maximum number of consecutive spurious wakeups we should
1124 +     * tolerate (from APIs like LockSupport.park) before failing a test.
1125 +     */
1126 +    static final int MAX_SPURIOUS_WAKEUPS = 10;
1127 +
1128 +    /**
1129       * The number of elements to place in collections, arrays, etc.
1130       */
1131      public static final int SIZE = 20;
# Line 965 | Line 1229 | public class JSR166TestCase extends Test
1229          }
1230          public void refresh() {}
1231          public String toString() {
1232 <            List<Permission> ps = new ArrayList<Permission>();
1232 >            List<Permission> ps = new ArrayList<>();
1233              for (Enumeration<Permission> e = perms.elements(); e.hasMoreElements();)
1234                  ps.add(e.nextElement());
1235              return "AdjustablePolicy with permissions " + ps;
# Line 995 | Line 1259 | public class JSR166TestCase extends Test
1259       * Sleeps until the given time has elapsed.
1260       * Throws AssertionFailedError if interrupted.
1261       */
1262 <    void sleep(long millis) {
1262 >    static void sleep(long millis) {
1263          try {
1264              delay(millis);
1265          } catch (InterruptedException fail) {
# Line 1011 | Line 1275 | public class JSR166TestCase extends Test
1275       * thread to enter a wait state: BLOCKED, WAITING, or TIMED_WAITING.
1276       */
1277      void waitForThreadToEnterWaitState(Thread thread, long timeoutMillis) {
1278 <        long startTime = System.nanoTime();
1278 >        long startTime = 0L;
1279          for (;;) {
1280              Thread.State s = thread.getState();
1281              if (s == Thread.State.BLOCKED ||
# Line 1020 | Line 1284 | public class JSR166TestCase extends Test
1284                  return;
1285              else if (s == Thread.State.TERMINATED)
1286                  fail("Unexpected thread termination");
1287 +            else if (startTime == 0L)
1288 +                startTime = System.nanoTime();
1289              else if (millisElapsedSince(startTime) > timeoutMillis) {
1290                  threadAssertTrue(thread.isAlive());
1291 <                return;
1291 >                fail("timed out waiting for thread to enter wait state");
1292              }
1293              Thread.yield();
1294          }
1295      }
1296  
1297      /**
1298 <     * Waits up to LONG_DELAY_MS for the given thread to enter a wait
1299 <     * state: BLOCKED, WAITING, or TIMED_WAITING.
1298 >     * Spin-waits up to the specified number of milliseconds for the given
1299 >     * thread to enter a wait state: BLOCKED, WAITING, or TIMED_WAITING,
1300 >     * and additionally satisfy the given condition.
1301 >     */
1302 >    void waitForThreadToEnterWaitState(
1303 >        Thread thread, long timeoutMillis, Callable<Boolean> waitingForGodot) {
1304 >        long startTime = 0L;
1305 >        for (;;) {
1306 >            Thread.State s = thread.getState();
1307 >            if (s == Thread.State.BLOCKED ||
1308 >                s == Thread.State.WAITING ||
1309 >                s == Thread.State.TIMED_WAITING) {
1310 >                try {
1311 >                    if (waitingForGodot.call())
1312 >                        return;
1313 >                } catch (Throwable fail) { threadUnexpectedException(fail); }
1314 >            }
1315 >            else if (s == Thread.State.TERMINATED)
1316 >                fail("Unexpected thread termination");
1317 >            else if (startTime == 0L)
1318 >                startTime = System.nanoTime();
1319 >            else if (millisElapsedSince(startTime) > timeoutMillis) {
1320 >                threadAssertTrue(thread.isAlive());
1321 >                fail("timed out waiting for thread to enter wait state");
1322 >            }
1323 >            Thread.yield();
1324 >        }
1325 >    }
1326 >
1327 >    /**
1328 >     * Spin-waits up to LONG_DELAY_MS milliseconds for the given thread to
1329 >     * enter a wait state: BLOCKED, WAITING, or TIMED_WAITING.
1330       */
1331      void waitForThreadToEnterWaitState(Thread thread) {
1332          waitForThreadToEnterWaitState(thread, LONG_DELAY_MS);
1333      }
1334  
1335      /**
1336 +     * Spin-waits up to LONG_DELAY_MS milliseconds for the given thread to
1337 +     * enter a wait state: BLOCKED, WAITING, or TIMED_WAITING,
1338 +     * and additionally satisfy the given condition.
1339 +     */
1340 +    void waitForThreadToEnterWaitState(
1341 +        Thread thread, Callable<Boolean> waitingForGodot) {
1342 +        waitForThreadToEnterWaitState(thread, LONG_DELAY_MS, waitingForGodot);
1343 +    }
1344 +
1345 +    /**
1346       * Returns the number of milliseconds since time given by
1347       * startNanoTime, which must have been previously returned from a
1348       * call to {@link System#nanoTime()}.
# Line 1098 | Line 1404 | public class JSR166TestCase extends Test
1404          } finally {
1405              if (t.getState() != Thread.State.TERMINATED) {
1406                  t.interrupt();
1407 <                fail("Test timed out");
1407 >                threadFail("timed out waiting for thread to terminate");
1408              }
1409          }
1410      }
# Line 1223 | Line 1529 | public class JSR166TestCase extends Test
1529      public static final String TEST_STRING = "a test string";
1530  
1531      public static class StringTask implements Callable<String> {
1532 <        public String call() { return TEST_STRING; }
1532 >        final String value;
1533 >        public StringTask() { this(TEST_STRING); }
1534 >        public StringTask(String value) { this.value = value; }
1535 >        public String call() { return value; }
1536      }
1537  
1538      public Callable<String> latchAwaitingStringTask(final CountDownLatch latch) {
# Line 1236 | Line 1545 | public class JSR166TestCase extends Test
1545              }};
1546      }
1547  
1548 <    public Runnable awaiter(final CountDownLatch latch) {
1548 >    public Runnable countDowner(final CountDownLatch latch) {
1549          return new CheckedRunnable() {
1550              public void realRun() throws InterruptedException {
1551 <                await(latch);
1551 >                latch.countDown();
1552              }};
1553      }
1554  
1555 <    public void await(CountDownLatch latch) {
1555 >    class LatchAwaiter extends CheckedRunnable {
1556 >        static final int NEW = 0;
1557 >        static final int RUNNING = 1;
1558 >        static final int DONE = 2;
1559 >        final CountDownLatch latch;
1560 >        int state = NEW;
1561 >        LatchAwaiter(CountDownLatch latch) { this.latch = latch; }
1562 >        public void realRun() throws InterruptedException {
1563 >            state = 1;
1564 >            await(latch);
1565 >            state = 2;
1566 >        }
1567 >    }
1568 >
1569 >    public LatchAwaiter awaiter(CountDownLatch latch) {
1570 >        return new LatchAwaiter(latch);
1571 >    }
1572 >
1573 >    public void await(CountDownLatch latch, long timeoutMillis) {
1574          try {
1575 <            assertTrue(latch.await(LONG_DELAY_MS, MILLISECONDS));
1575 >            if (!latch.await(timeoutMillis, MILLISECONDS))
1576 >                fail("timed out waiting for CountDownLatch for "
1577 >                     + (timeoutMillis/1000) + " sec");
1578          } catch (Throwable fail) {
1579              threadUnexpectedException(fail);
1580          }
1581      }
1582  
1583 +    public void await(CountDownLatch latch) {
1584 +        await(latch, LONG_DELAY_MS);
1585 +    }
1586 +
1587      public void await(Semaphore semaphore) {
1588          try {
1589 <            assertTrue(semaphore.tryAcquire(LONG_DELAY_MS, MILLISECONDS));
1589 >            if (!semaphore.tryAcquire(LONG_DELAY_MS, MILLISECONDS))
1590 >                fail("timed out waiting for Semaphore for "
1591 >                     + (LONG_DELAY_MS/1000) + " sec");
1592 >        } catch (Throwable fail) {
1593 >            threadUnexpectedException(fail);
1594 >        }
1595 >    }
1596 >
1597 >    public void await(CyclicBarrier barrier) {
1598 >        try {
1599 >            barrier.await(LONG_DELAY_MS, MILLISECONDS);
1600          } catch (Throwable fail) {
1601              threadUnexpectedException(fail);
1602          }
# Line 1483 | Line 1826 | public class JSR166TestCase extends Test
1826       * A CyclicBarrier that uses timed await and fails with
1827       * AssertionFailedErrors instead of throwing checked exceptions.
1828       */
1829 <    public class CheckedBarrier extends CyclicBarrier {
1829 >    public static class CheckedBarrier extends CyclicBarrier {
1830          public CheckedBarrier(int parties) { super(parties); }
1831  
1832          public int await() {
# Line 1547 | Line 1890 | public class JSR166TestCase extends Test
1890          }
1891      }
1892  
1893 +    void assertImmutable(final Object o) {
1894 +        if (o instanceof Collection) {
1895 +            assertThrows(
1896 +                UnsupportedOperationException.class,
1897 +                new Runnable() { public void run() {
1898 +                        ((Collection) o).add(null);}});
1899 +        }
1900 +    }
1901 +
1902      @SuppressWarnings("unchecked")
1903      <T> T serialClone(T o) {
1904          try {
1905              ObjectInputStream ois = new ObjectInputStream
1906                  (new ByteArrayInputStream(serialBytes(o)));
1907              T clone = (T) ois.readObject();
1908 +            if (o == clone) assertImmutable(o);
1909              assertSame(o.getClass(), clone.getClass());
1910              return clone;
1911          } catch (Throwable fail) {
# Line 1561 | Line 1914 | public class JSR166TestCase extends Test
1914          }
1915      }
1916  
1917 +    /**
1918 +     * A version of serialClone that leaves error handling (for
1919 +     * e.g. NotSerializableException) up to the caller.
1920 +     */
1921 +    @SuppressWarnings("unchecked")
1922 +    <T> T serialClonePossiblyFailing(T o)
1923 +        throws ReflectiveOperationException, java.io.IOException {
1924 +        ByteArrayOutputStream bos = new ByteArrayOutputStream();
1925 +        ObjectOutputStream oos = new ObjectOutputStream(bos);
1926 +        oos.writeObject(o);
1927 +        oos.flush();
1928 +        oos.close();
1929 +        ObjectInputStream ois = new ObjectInputStream
1930 +            (new ByteArrayInputStream(bos.toByteArray()));
1931 +        T clone = (T) ois.readObject();
1932 +        if (o == clone) assertImmutable(o);
1933 +        assertSame(o.getClass(), clone.getClass());
1934 +        return clone;
1935 +    }
1936 +
1937 +    /**
1938 +     * If o implements Cloneable and has a public clone method,
1939 +     * returns a clone of o, else null.
1940 +     */
1941 +    @SuppressWarnings("unchecked")
1942 +    <T> T cloneableClone(T o) {
1943 +        if (!(o instanceof Cloneable)) return null;
1944 +        final T clone;
1945 +        try {
1946 +            clone = (T) o.getClass().getMethod("clone").invoke(o);
1947 +        } catch (NoSuchMethodException ok) {
1948 +            return null;
1949 +        } catch (ReflectiveOperationException unexpected) {
1950 +            throw new Error(unexpected);
1951 +        }
1952 +        assertNotSame(o, clone); // not 100% guaranteed by spec
1953 +        assertSame(o.getClass(), clone.getClass());
1954 +        return clone;
1955 +    }
1956 +
1957      public void assertThrows(Class<? extends Throwable> expectedExceptionClass,
1958                               Runnable... throwingActions) {
1959          for (Runnable throwingAction : throwingActions) {
# Line 1589 | Line 1982 | public class JSR166TestCase extends Test
1982          } catch (NoSuchElementException success) {}
1983          assertFalse(it.hasNext());
1984      }
1985 +
1986 +    public <T> Callable<T> callableThrowing(final Exception ex) {
1987 +        return new Callable<T>() { public T call() throws Exception { throw ex; }};
1988 +    }
1989 +
1990 +    public Runnable runnableThrowing(final RuntimeException ex) {
1991 +        return new Runnable() { public void run() { throw ex; }};
1992 +    }
1993 +
1994 +    /** A reusable thread pool to be shared by tests. */
1995 +    static final ExecutorService cachedThreadPool =
1996 +        new ThreadPoolExecutor(0, Integer.MAX_VALUE,
1997 +                               1000L, MILLISECONDS,
1998 +                               new SynchronousQueue<Runnable>());
1999 +
2000 +    static <T> void shuffle(T[] array) {
2001 +        Collections.shuffle(Arrays.asList(array), ThreadLocalRandom.current());
2002 +    }
2003   }

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines