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.123 by jsr166, Wed Dec 31 19:05:42 2014 UTC vs.
Revision 1.203 by jsr166, Thu Sep 15 03:46:19 2016 UTC

# Line 6 | Line 6
6   * Pat Fisher, Mike Judd.
7   */
8  
9 + /*
10 + * @test
11 + * @summary JSR-166 tck tests
12 + * @modules java.management
13 + * @build *
14 + * @run junit/othervm/timeout=1000 -Djsr166.testImplementationDetails=true JSR166TestCase
15 + * @run junit/othervm/timeout=1000 -Djava.util.concurrent.ForkJoinPool.common.parallelism=0 -Djsr166.testImplementationDetails=true JSR166TestCase
16 + * @run junit/othervm/timeout=1000 -Djava.util.concurrent.ForkJoinPool.common.parallelism=1 -Djava.util.secureRandomSeed=true JSR166TestCase
17 + */
18 +
19   import static java.util.concurrent.TimeUnit.MILLISECONDS;
20 + import static java.util.concurrent.TimeUnit.MINUTES;
21   import static java.util.concurrent.TimeUnit.NANOSECONDS;
22  
23   import java.io.ByteArrayInputStream;
# Line 15 | Line 26 | import java.io.ObjectInputStream;
26   import java.io.ObjectOutputStream;
27   import java.lang.management.ManagementFactory;
28   import java.lang.management.ThreadInfo;
29 + import java.lang.management.ThreadMXBean;
30 + import java.lang.reflect.Constructor;
31   import java.lang.reflect.Method;
32 + import java.lang.reflect.Modifier;
33 + import java.nio.file.Files;
34 + import java.nio.file.Paths;
35   import java.security.CodeSource;
36   import java.security.Permission;
37   import java.security.PermissionCollection;
# Line 25 | Line 41 | import java.security.ProtectionDomain;
41   import java.security.SecurityPermission;
42   import java.util.ArrayList;
43   import java.util.Arrays;
44 + import java.util.Collections;
45   import java.util.Date;
46   import java.util.Enumeration;
47 + import java.util.Iterator;
48   import java.util.List;
49   import java.util.NoSuchElementException;
50   import java.util.PropertyPermission;
# Line 34 | Line 52 | import java.util.concurrent.BlockingQueu
52   import java.util.concurrent.Callable;
53   import java.util.concurrent.CountDownLatch;
54   import java.util.concurrent.CyclicBarrier;
55 + import java.util.concurrent.ExecutionException;
56 + import java.util.concurrent.Executors;
57   import java.util.concurrent.ExecutorService;
58 + import java.util.concurrent.ForkJoinPool;
59   import java.util.concurrent.Future;
60   import java.util.concurrent.RecursiveAction;
61   import java.util.concurrent.RecursiveTask;
62   import java.util.concurrent.RejectedExecutionHandler;
63   import java.util.concurrent.Semaphore;
64 + import java.util.concurrent.SynchronousQueue;
65   import java.util.concurrent.ThreadFactory;
66 + import java.util.concurrent.ThreadLocalRandom;
67   import java.util.concurrent.ThreadPoolExecutor;
68   import java.util.concurrent.TimeoutException;
69 + import java.util.concurrent.atomic.AtomicBoolean;
70   import java.util.concurrent.atomic.AtomicReference;
71 + import java.util.regex.Matcher;
72   import java.util.regex.Pattern;
73  
74   import junit.framework.AssertionFailedError;
75   import junit.framework.Test;
76   import junit.framework.TestCase;
77 + import junit.framework.TestResult;
78   import junit.framework.TestSuite;
79  
80   /**
# Line 61 | Line 87 | import junit.framework.TestSuite;
87   *
88   * <ol>
89   *
90 < * <li> All assertions in code running in generated threads must use
90 > * <li>All assertions in code running in generated threads must use
91   * the forms {@link #threadFail}, {@link #threadAssertTrue}, {@link
92   * #threadAssertEquals}, or {@link #threadAssertNull}, (not
93   * {@code fail}, {@code assertTrue}, etc.) It is OK (but not
94   * particularly recommended) for other code to use these forms too.
95   * Only the most typically used JUnit assertion methods are defined
96 < * this way, but enough to live with.</li>
96 > * this way, but enough to live with.
97   *
98 < * <li> If you override {@link #setUp} or {@link #tearDown}, make sure
98 > * <li>If you override {@link #setUp} or {@link #tearDown}, make sure
99   * to invoke {@code super.setUp} and {@code super.tearDown} within
100   * them. These methods are used to clear and check for thread
101 < * assertion failures.</li>
101 > * assertion failures.
102   *
103   * <li>All delays and timeouts must use one of the constants {@code
104   * SHORT_DELAY_MS}, {@code SMALL_DELAY_MS}, {@code MEDIUM_DELAY_MS},
# Line 83 | Line 109 | import junit.framework.TestSuite;
109   * is always discriminable as larger than SHORT and smaller than
110   * MEDIUM.  And so on. These constants are set to conservative values,
111   * but even so, if there is ever any doubt, they can all be increased
112 < * in one spot to rerun tests on slower platforms.</li>
112 > * in one spot to rerun tests on slower platforms.
113   *
114 < * <li> All threads generated must be joined inside each test case
114 > * <li>All threads generated must be joined inside each test case
115   * method (or {@code fail} to do so) before returning from the
116   * method. The {@code joinPool} method can be used to do this when
117 < * using Executors.</li>
117 > * using Executors.
118   *
119   * </ol>
120   *
121   * <p><b>Other notes</b>
122   * <ul>
123   *
124 < * <li> Usually, there is one testcase method per JSR166 method
124 > * <li>Usually, there is one testcase method per JSR166 method
125   * covering "normal" operation, and then as many exception-testing
126   * methods as there are exceptions the method can throw. Sometimes
127   * there are multiple tests per JSR166 method when the different
128   * "normal" behaviors differ significantly. And sometimes testcases
129 < * cover multiple methods when they cannot be tested in
104 < * isolation.</li>
129 > * cover multiple methods when they cannot be tested in isolation.
130   *
131 < * <li> The documentation style for testcases is to provide as javadoc
131 > * <li>The documentation style for testcases is to provide as javadoc
132   * a simple sentence or two describing the property that the testcase
133   * method purports to test. The javadocs do not say anything about how
134 < * the property is tested. To find out, read the code.</li>
134 > * the property is tested. To find out, read the code.
135   *
136 < * <li> These tests are "conformance tests", and do not attempt to
136 > * <li>These tests are "conformance tests", and do not attempt to
137   * test throughput, latency, scalability or other performance factors
138   * (see the separate "jtreg" tests for a set intended to check these
139   * for the most central aspects of functionality.) So, most tests use
140   * the smallest sensible numbers of threads, collection sizes, etc
141 < * needed to check basic conformance.</li>
141 > * needed to check basic conformance.
142   *
143   * <li>The test classes currently do not declare inclusion in
144   * any particular package to simplify things for people integrating
145 < * them in TCK test suites.</li>
145 > * them in TCK test suites.
146   *
147 < * <li> As a convenience, the {@code main} of this class (JSR166TestCase)
148 < * runs all JSR166 unit tests.</li>
147 > * <li>As a convenience, the {@code main} of this class (JSR166TestCase)
148 > * runs all JSR166 unit tests.
149   *
150   * </ul>
151   */
# Line 159 | Line 184 | public class JSR166TestCase extends Test
184          Integer.getInteger("jsr166.runsPerTest", 1);
185  
186      /**
187 +     * The number of repetitions of the test suite (for finding leaks?).
188 +     */
189 +    private static final int suiteRuns =
190 +        Integer.getInteger("jsr166.suiteRuns", 1);
191 +
192 +    /**
193 +     * Returns the value of the system property, or NaN if not defined.
194 +     */
195 +    private static float systemPropertyValue(String name) {
196 +        String floatString = System.getProperty(name);
197 +        if (floatString == null)
198 +            return Float.NaN;
199 +        try {
200 +            return Float.parseFloat(floatString);
201 +        } catch (NumberFormatException ex) {
202 +            throw new IllegalArgumentException(
203 +                String.format("Bad float value in system property %s=%s",
204 +                              name, floatString));
205 +        }
206 +    }
207 +
208 +    /**
209 +     * The scaling factor to apply to standard delays used in tests.
210 +     * May be initialized from any of:
211 +     * - the "jsr166.delay.factor" system property
212 +     * - the "test.timeout.factor" system property (as used by jtreg)
213 +     *   See: http://openjdk.java.net/jtreg/tag-spec.html
214 +     * - hard-coded fuzz factor when using a known slowpoke VM
215 +     */
216 +    private static final float delayFactor = delayFactor();
217 +
218 +    private static float delayFactor() {
219 +        float x;
220 +        if (!Float.isNaN(x = systemPropertyValue("jsr166.delay.factor")))
221 +            return x;
222 +        if (!Float.isNaN(x = systemPropertyValue("test.timeout.factor")))
223 +            return x;
224 +        String prop = System.getProperty("java.vm.version");
225 +        if (prop != null && prop.matches(".*debug.*"))
226 +            return 4.0f; // How much slower is fastdebug than product?!
227 +        return 1.0f;
228 +    }
229 +
230 +    public JSR166TestCase() { super(); }
231 +    public JSR166TestCase(String name) { super(name); }
232 +
233 +    /**
234       * A filter for tests to run, matching strings of the form
235       * methodName(className), e.g. "testInvokeAll5(ForkJoinPoolTest)"
236       * Usefully combined with jsr166.runsPerTest.
# Line 170 | Line 242 | public class JSR166TestCase extends Test
242          return (regex == null) ? null : Pattern.compile(regex);
243      }
244  
245 <    protected void runTest() throws Throwable {
245 >    // Instrumentation to debug very rare, but very annoying hung test runs.
246 >    static volatile TestCase currentTestCase;
247 >    // static volatile int currentRun = 0;
248 >    static {
249 >        Runnable checkForWedgedTest = new Runnable() { public void run() {
250 >            // Avoid spurious reports with enormous runsPerTest.
251 >            // A single test case run should never take more than 1 second.
252 >            // But let's cap it at the high end too ...
253 >            final int timeoutMinutes =
254 >                Math.min(15, Math.max(runsPerTest / 60, 1));
255 >            for (TestCase lastTestCase = currentTestCase;;) {
256 >                try { MINUTES.sleep(timeoutMinutes); }
257 >                catch (InterruptedException unexpected) { break; }
258 >                if (lastTestCase == currentTestCase) {
259 >                    System.err.printf(
260 >                        "Looks like we're stuck running test: %s%n",
261 >                        lastTestCase);
262 > //                     System.err.printf(
263 > //                         "Looks like we're stuck running test: %s (%d/%d)%n",
264 > //                         lastTestCase, currentRun, runsPerTest);
265 > //                     System.err.println("availableProcessors=" +
266 > //                         Runtime.getRuntime().availableProcessors());
267 > //                     System.err.printf("cpu model = %s%n", cpuModel());
268 >                    dumpTestThreads();
269 >                    // one stack dump is probably enough; more would be spam
270 >                    break;
271 >                }
272 >                lastTestCase = currentTestCase;
273 >            }}};
274 >        Thread thread = new Thread(checkForWedgedTest, "checkForWedgedTest");
275 >        thread.setDaemon(true);
276 >        thread.start();
277 >    }
278 >
279 > //     public static String cpuModel() {
280 > //         try {
281 > //             Matcher matcher = Pattern.compile("model name\\s*: (.*)")
282 > //                 .matcher(new String(
283 > //                      Files.readAllBytes(Paths.get("/proc/cpuinfo")), "UTF-8"));
284 > //             matcher.find();
285 > //             return matcher.group(1);
286 > //         } catch (Exception ex) { return null; }
287 > //     }
288 >
289 >    public void runBare() throws Throwable {
290 >        currentTestCase = this;
291          if (methodFilter == null
292 <            || methodFilter.matcher(toString()).find()) {
293 <            for (int i = 0; i < runsPerTest; i++) {
294 <                if (profileTests)
295 <                    runTestProfiled();
296 <                else
297 <                    super.runTest();
298 <            }
292 >            || methodFilter.matcher(toString()).find())
293 >            super.runBare();
294 >    }
295 >
296 >    protected void runTest() throws Throwable {
297 >        for (int i = 0; i < runsPerTest; i++) {
298 >            // currentRun = i;
299 >            if (profileTests)
300 >                runTestProfiled();
301 >            else
302 >                super.runTest();
303          }
304      }
305  
306      protected void runTestProfiled() throws Throwable {
307 <        // Warmup run, notably to trigger all needed classloading.
308 <        super.runTest();
188 <        long t0 = System.nanoTime();
189 <        try {
307 >        for (int i = 0; i < 2; i++) {
308 >            long startTime = System.nanoTime();
309              super.runTest();
310 <        } finally {
311 <            long elapsedMillis = millisElapsedSince(t0);
312 <            if (elapsedMillis >= profileThreshold)
310 >            long elapsedMillis = millisElapsedSince(startTime);
311 >            if (elapsedMillis < profileThreshold)
312 >                break;
313 >            // Never report first run of any test; treat it as a
314 >            // warmup run, notably to trigger all needed classloading,
315 >            if (i > 0)
316                  System.out.printf("%n%s: %d%n", toString(), elapsedMillis);
317          }
318      }
319  
320      /**
321       * Runs all JSR166 unit tests using junit.textui.TestRunner.
200     * Optional command line arg provides the number of iterations to
201     * repeat running the tests.
322       */
323      public static void main(String[] args) {
324 +        main(suite(), args);
325 +    }
326 +
327 +    static class PithyResultPrinter extends junit.textui.ResultPrinter {
328 +        PithyResultPrinter(java.io.PrintStream writer) { super(writer); }
329 +        long runTime;
330 +        public void startTest(Test test) {}
331 +        protected void printHeader(long runTime) {
332 +            this.runTime = runTime; // defer printing for later
333 +        }
334 +        protected void printFooter(TestResult result) {
335 +            if (result.wasSuccessful()) {
336 +                getWriter().println("OK (" + result.runCount() + " tests)"
337 +                    + "  Time: " + elapsedTimeAsString(runTime));
338 +            } else {
339 +                getWriter().println("Time: " + elapsedTimeAsString(runTime));
340 +                super.printFooter(result);
341 +            }
342 +        }
343 +    }
344 +
345 +    /**
346 +     * Returns a TestRunner that doesn't bother with unnecessary
347 +     * fluff, like printing a "." for each test case.
348 +     */
349 +    static junit.textui.TestRunner newPithyTestRunner() {
350 +        junit.textui.TestRunner runner = new junit.textui.TestRunner();
351 +        runner.setPrinter(new PithyResultPrinter(System.out));
352 +        return runner;
353 +    }
354 +
355 +    /**
356 +     * Runs all unit tests in the given test suite.
357 +     * Actual behavior influenced by jsr166.* system properties.
358 +     */
359 +    static void main(Test suite, String[] args) {
360          if (useSecurityManager) {
361              System.err.println("Setting a permissive security manager");
362              Policy.setPolicy(permissivePolicy());
363              System.setSecurityManager(new SecurityManager());
364          }
365 <        int iters = (args.length == 0) ? 1 : Integer.parseInt(args[0]);
366 <
367 <        Test s = suite();
368 <        for (int i = 0; i < iters; ++i) {
213 <            junit.textui.TestRunner.run(s);
365 >        for (int i = 0; i < suiteRuns; i++) {
366 >            TestResult result = newPithyTestRunner().doRun(suite);
367 >            if (!result.wasSuccessful())
368 >                System.exit(1);
369              System.gc();
370              System.runFinalization();
371          }
217        System.exit(0);
372      }
373  
374      public static TestSuite newTestSuite(Object... suiteOrClasses) {
# Line 265 | Line 419 | public class JSR166TestCase extends Test
419      public static boolean atLeastJava7() { return JAVA_CLASS_VERSION >= 51.0; }
420      public static boolean atLeastJava8() { return JAVA_CLASS_VERSION >= 52.0; }
421      public static boolean atLeastJava9() {
422 <        // As of 2014-05, java9 still uses 52.0 class file version
423 <        return JAVA_SPECIFICATION_VERSION.startsWith("1.9");
422 >        return JAVA_CLASS_VERSION >= 53.0
423 >            // As of 2015-09, java9 still uses 52.0 class file version
424 >            || JAVA_SPECIFICATION_VERSION.matches("^(1\\.)?(9|[0-9][0-9])$");
425 >    }
426 >    public static boolean atLeastJava10() {
427 >        return JAVA_CLASS_VERSION >= 54.0
428 >            || JAVA_SPECIFICATION_VERSION.matches("^(1\\.)?[0-9][0-9]$");
429      }
430  
431      /**
# Line 355 | Line 514 | public class JSR166TestCase extends Test
514                  "LongAdderTest",
515                  "SplittableRandomTest",
516                  "StampedLockTest",
517 +                "SubmissionPublisherTest",
518                  "ThreadLocalRandom8Test",
519 +                "TimeUnit8Test",
520              };
521              addNamedTestClasses(suite, java8TestClassNames);
522          }
# Line 363 | Line 524 | public class JSR166TestCase extends Test
524          // Java9+ test classes
525          if (atLeastJava9()) {
526              String[] java9TestClassNames = {
527 <                "ThreadPoolExecutor9Test",
527 >                "AtomicBoolean9Test",
528 >                "AtomicInteger9Test",
529 >                "AtomicIntegerArray9Test",
530 >                "AtomicLong9Test",
531 >                "AtomicLongArray9Test",
532 >                "AtomicReference9Test",
533 >                "AtomicReferenceArray9Test",
534 >                "ExecutorCompletionService9Test",
535              };
536              addNamedTestClasses(suite, java9TestClassNames);
537          }
# Line 371 | Line 539 | public class JSR166TestCase extends Test
539          return suite;
540      }
541  
542 +    /** Returns list of junit-style test method names in given class. */
543 +    public static ArrayList<String> testMethodNames(Class<?> testClass) {
544 +        Method[] methods = testClass.getDeclaredMethods();
545 +        ArrayList<String> names = new ArrayList<String>(methods.length);
546 +        for (Method method : methods) {
547 +            if (method.getName().startsWith("test")
548 +                && Modifier.isPublic(method.getModifiers())
549 +                // method.getParameterCount() requires jdk8+
550 +                && method.getParameterTypes().length == 0) {
551 +                names.add(method.getName());
552 +            }
553 +        }
554 +        return names;
555 +    }
556 +
557 +    /**
558 +     * Returns junit-style testSuite for the given test class, but
559 +     * parameterized by passing extra data to each test.
560 +     */
561 +    public static <ExtraData> Test parameterizedTestSuite
562 +        (Class<? extends JSR166TestCase> testClass,
563 +         Class<ExtraData> dataClass,
564 +         ExtraData data) {
565 +        try {
566 +            TestSuite suite = new TestSuite();
567 +            Constructor c =
568 +                testClass.getDeclaredConstructor(dataClass, String.class);
569 +            for (String methodName : testMethodNames(testClass))
570 +                suite.addTest((Test) c.newInstance(data, methodName));
571 +            return suite;
572 +        } catch (Exception e) {
573 +            throw new Error(e);
574 +        }
575 +    }
576 +
577 +    /**
578 +     * Returns junit-style testSuite for the jdk8 extension of the
579 +     * given test class, but parameterized by passing extra data to
580 +     * each test.  Uses reflection to allow compilation in jdk7.
581 +     */
582 +    public static <ExtraData> Test jdk8ParameterizedTestSuite
583 +        (Class<? extends JSR166TestCase> testClass,
584 +         Class<ExtraData> dataClass,
585 +         ExtraData data) {
586 +        if (atLeastJava8()) {
587 +            String name = testClass.getName();
588 +            String name8 = name.replaceAll("Test$", "8Test");
589 +            if (name.equals(name8)) throw new Error(name);
590 +            try {
591 +                return (Test)
592 +                    Class.forName(name8)
593 +                    .getMethod("testSuite", new Class[] { dataClass })
594 +                    .invoke(null, data);
595 +            } catch (Exception e) {
596 +                throw new Error(e);
597 +            }
598 +        } else {
599 +            return new TestSuite();
600 +        }
601 +    }
602 +
603      // Delays for timing-dependent tests, in milliseconds.
604  
605      public static long SHORT_DELAY_MS;
# Line 379 | Line 608 | public class JSR166TestCase extends Test
608      public static long LONG_DELAY_MS;
609  
610      /**
611 <     * Returns the shortest timed delay. This could
612 <     * be reimplemented to use for example a Property.
611 >     * Returns the shortest timed delay. This can be scaled up for
612 >     * slow machines using the jsr166.delay.factor system property,
613 >     * or via jtreg's -timeoutFactor: flag.
614 >     * http://openjdk.java.net/jtreg/command-help.html
615       */
616      protected long getShortDelay() {
617 <        return 50;
617 >        return (long) (50 * delayFactor);
618      }
619  
620      /**
# Line 405 | Line 636 | public class JSR166TestCase extends Test
636      }
637  
638      /**
639 <     * Returns a new Date instance representing a time delayMillis
640 <     * milliseconds in the future.
639 >     * Returns a new Date instance representing a time at least
640 >     * delayMillis milliseconds in the future.
641       */
642      Date delayedDate(long delayMillis) {
643 <        return new Date(System.currentTimeMillis() + delayMillis);
643 >        // Add 1 because currentTimeMillis is known to round into the past.
644 >        return new Date(System.currentTimeMillis() + delayMillis + 1);
645      }
646  
647      /**
# Line 425 | Line 657 | public class JSR166TestCase extends Test
657       * the same test have no effect.
658       */
659      public void threadRecordFailure(Throwable t) {
660 +        System.err.println(t);
661 +        dumpTestThreads();
662          threadFailure.compareAndSet(null, t);
663      }
664  
# Line 432 | Line 666 | public class JSR166TestCase extends Test
666          setDelays();
667      }
668  
669 +    void tearDownFail(String format, Object... args) {
670 +        String msg = toString() + ": " + String.format(format, args);
671 +        System.err.println(msg);
672 +        dumpTestThreads();
673 +        throw new AssertionFailedError(msg);
674 +    }
675 +
676      /**
677       * Extra checks that get done for all test cases.
678       *
# Line 459 | Line 700 | public class JSR166TestCase extends Test
700          }
701  
702          if (Thread.interrupted())
703 <            throw new AssertionFailedError("interrupt status set in main thread");
703 >            tearDownFail("interrupt status set in main thread");
704  
705          checkForkJoinPoolThreadLeaks();
706      }
707  
708      /**
709 <     * Find missing try { ... } finally { joinPool(e); }
709 >     * Finds missing PoolCleaners
710       */
711      void checkForkJoinPoolThreadLeaks() throws InterruptedException {
712 <        Thread[] survivors = new Thread[5];
712 >        Thread[] survivors = new Thread[7];
713          int count = Thread.enumerate(survivors);
714          for (int i = 0; i < count; i++) {
715              Thread thread = survivors[i];
# Line 476 | Line 717 | public class JSR166TestCase extends Test
717              if (name.startsWith("ForkJoinPool-")) {
718                  // give thread some time to terminate
719                  thread.join(LONG_DELAY_MS);
720 <                if (!thread.isAlive()) continue;
721 <                thread.stop();
722 <                throw new AssertionFailedError
482 <                    (String.format("Found leaked ForkJoinPool thread test=%s thread=%s%n",
483 <                                   toString(), name));
720 >                if (thread.isAlive())
721 >                    tearDownFail("Found leaked ForkJoinPool thread thread=%s",
722 >                                 thread);
723              }
724          }
725 +
726 +        if (!ForkJoinPool.commonPool()
727 +            .awaitQuiescence(LONG_DELAY_MS, MILLISECONDS))
728 +            tearDownFail("ForkJoin common pool thread stuck");
729      }
730  
731      /**
# Line 495 | Line 738 | public class JSR166TestCase extends Test
738              fail(reason);
739          } catch (AssertionFailedError t) {
740              threadRecordFailure(t);
741 <            fail(reason);
741 >            throw t;
742          }
743      }
744  
# Line 563 | Line 806 | public class JSR166TestCase extends Test
806      public void threadAssertEquals(Object x, Object y) {
807          try {
808              assertEquals(x, y);
809 <        } catch (AssertionFailedError t) {
810 <            threadRecordFailure(t);
811 <            throw t;
812 <        } catch (Throwable t) {
813 <            threadUnexpectedException(t);
809 >        } catch (AssertionFailedError fail) {
810 >            threadRecordFailure(fail);
811 >            throw fail;
812 >        } catch (Throwable fail) {
813 >            threadUnexpectedException(fail);
814          }
815      }
816  
# Line 579 | Line 822 | public class JSR166TestCase extends Test
822      public void threadAssertSame(Object x, Object y) {
823          try {
824              assertSame(x, y);
825 <        } catch (AssertionFailedError t) {
826 <            threadRecordFailure(t);
827 <            throw t;
825 >        } catch (AssertionFailedError fail) {
826 >            threadRecordFailure(fail);
827 >            throw fail;
828          }
829      }
830  
# Line 622 | Line 865 | public class JSR166TestCase extends Test
865      /**
866       * Delays, via Thread.sleep, for the given millisecond delay, but
867       * if the sleep is shorter than specified, may re-sleep or yield
868 <     * until time elapses.
868 >     * until time elapses.  Ensures that the given time, as measured
869 >     * by System.nanoTime(), has elapsed.
870       */
871      static void delay(long millis) throws InterruptedException {
872 <        long startTime = System.nanoTime();
873 <        long ns = millis * 1000 * 1000;
874 <        for (;;) {
872 >        long nanos = millis * (1000 * 1000);
873 >        final long wakeupTime = System.nanoTime() + nanos;
874 >        do {
875              if (millis > 0L)
876                  Thread.sleep(millis);
877              else // too short to sleep
878                  Thread.yield();
879 <            long d = ns - (System.nanoTime() - startTime);
880 <            if (d > 0L)
881 <                millis = d / (1000 * 1000);
882 <            else
883 <                break;
879 >            nanos = wakeupTime - System.nanoTime();
880 >            millis = nanos / (1000 * 1000);
881 >        } while (nanos >= 0L);
882 >    }
883 >
884 >    /**
885 >     * Allows use of try-with-resources with per-test thread pools.
886 >     */
887 >    class PoolCleaner implements AutoCloseable {
888 >        private final ExecutorService pool;
889 >        public PoolCleaner(ExecutorService pool) { this.pool = pool; }
890 >        public void close() { joinPool(pool); }
891 >    }
892 >
893 >    /**
894 >     * An extension of PoolCleaner that has an action to release the pool.
895 >     */
896 >    class PoolCleanerWithReleaser extends PoolCleaner {
897 >        private final Runnable releaser;
898 >        public PoolCleanerWithReleaser(ExecutorService pool, Runnable releaser) {
899 >            super(pool);
900 >            this.releaser = releaser;
901 >        }
902 >        public void close() {
903 >            try {
904 >                releaser.run();
905 >            } finally {
906 >                super.close();
907 >            }
908          }
909      }
910  
911 +    PoolCleaner cleaner(ExecutorService pool) {
912 +        return new PoolCleaner(pool);
913 +    }
914 +
915 +    PoolCleaner cleaner(ExecutorService pool, Runnable releaser) {
916 +        return new PoolCleanerWithReleaser(pool, releaser);
917 +    }
918 +
919 +    PoolCleaner cleaner(ExecutorService pool, CountDownLatch latch) {
920 +        return new PoolCleanerWithReleaser(pool, releaser(latch));
921 +    }
922 +
923 +    Runnable releaser(final CountDownLatch latch) {
924 +        return new Runnable() { public void run() {
925 +            do { latch.countDown(); }
926 +            while (latch.getCount() > 0);
927 +        }};
928 +    }
929 +
930 +    PoolCleaner cleaner(ExecutorService pool, AtomicBoolean flag) {
931 +        return new PoolCleanerWithReleaser(pool, releaser(flag));
932 +    }
933 +
934 +    Runnable releaser(final AtomicBoolean flag) {
935 +        return new Runnable() { public void run() { flag.set(true); }};
936 +    }
937 +
938      /**
939       * Waits out termination of a thread pool or fails doing so.
940       */
941 <    void joinPool(ExecutorService exec) {
941 >    void joinPool(ExecutorService pool) {
942          try {
943 <            exec.shutdown();
944 <            if (!exec.awaitTermination(2 * LONG_DELAY_MS, MILLISECONDS))
945 <                fail("ExecutorService " + exec +
946 <                     " did not terminate in a timely manner");
943 >            pool.shutdown();
944 >            if (!pool.awaitTermination(2 * LONG_DELAY_MS, MILLISECONDS)) {
945 >                try {
946 >                    threadFail("ExecutorService " + pool +
947 >                               " did not terminate in a timely manner");
948 >                } finally {
949 >                    // last resort, for the benefit of subsequent tests
950 >                    pool.shutdownNow();
951 >                    pool.awaitTermination(MEDIUM_DELAY_MS, MILLISECONDS);
952 >                }
953 >            }
954          } catch (SecurityException ok) {
955              // Allowed in case test doesn't have privs
956 <        } catch (InterruptedException ie) {
957 <            fail("Unexpected InterruptedException");
956 >        } catch (InterruptedException fail) {
957 >            threadFail("Unexpected InterruptedException");
958 >        }
959 >    }
960 >
961 >    /**
962 >     * Like Runnable, but with the freedom to throw anything.
963 >     * junit folks had the same idea:
964 >     * http://junit.org/junit5/docs/snapshot/api/org/junit/gen5/api/Executable.html
965 >     */
966 >    interface Action { public void run() throws Throwable; }
967 >
968 >    /**
969 >     * Runs all the given actions in parallel, failing if any fail.
970 >     * Useful for running multiple variants of tests that are
971 >     * necessarily individually slow because they must block.
972 >     */
973 >    void testInParallel(Action ... actions) {
974 >        ExecutorService pool = Executors.newCachedThreadPool();
975 >        try (PoolCleaner cleaner = cleaner(pool)) {
976 >            ArrayList<Future<?>> futures = new ArrayList<>(actions.length);
977 >            for (final Action action : actions)
978 >                futures.add(pool.submit(new CheckedRunnable() {
979 >                    public void realRun() throws Throwable { action.run();}}));
980 >            for (Future<?> future : futures)
981 >                try {
982 >                    assertNull(future.get(LONG_DELAY_MS, MILLISECONDS));
983 >                } catch (ExecutionException ex) {
984 >                    threadUnexpectedException(ex.getCause());
985 >                } catch (Exception ex) {
986 >                    threadUnexpectedException(ex);
987 >                }
988          }
989      }
990  
991      /**
992 <     * A debugging tool to print all stack traces, as jstack does.
992 >     * A debugging tool to print stack traces of most threads, as jstack does.
993 >     * Uninteresting threads are filtered out.
994       */
995 <    static void printAllStackTraces() {
996 <        for (ThreadInfo info :
997 <                 ManagementFactory.getThreadMXBean()
998 <                 .dumpAllThreads(true, true))
995 >    static void dumpTestThreads() {
996 >        SecurityManager sm = System.getSecurityManager();
997 >        if (sm != null) {
998 >            try {
999 >                System.setSecurityManager(null);
1000 >            } catch (SecurityException giveUp) {
1001 >                return;
1002 >            }
1003 >        }
1004 >
1005 >        ThreadMXBean threadMXBean = ManagementFactory.getThreadMXBean();
1006 >        System.err.println("------ stacktrace dump start ------");
1007 >        for (ThreadInfo info : threadMXBean.dumpAllThreads(true, true)) {
1008 >            final String name = info.getThreadName();
1009 >            String lockName;
1010 >            if ("Signal Dispatcher".equals(name))
1011 >                continue;
1012 >            if ("Reference Handler".equals(name)
1013 >                && (lockName = info.getLockName()) != null
1014 >                && lockName.startsWith("java.lang.ref.Reference$Lock"))
1015 >                continue;
1016 >            if ("Finalizer".equals(name)
1017 >                && (lockName = info.getLockName()) != null
1018 >                && lockName.startsWith("java.lang.ref.ReferenceQueue$Lock"))
1019 >                continue;
1020 >            if ("checkForWedgedTest".equals(name))
1021 >                continue;
1022              System.err.print(info);
1023 +        }
1024 +        System.err.println("------ stacktrace dump end ------");
1025 +
1026 +        if (sm != null) System.setSecurityManager(sm);
1027      }
1028  
1029      /**
# Line 682 | Line 1042 | public class JSR166TestCase extends Test
1042              // No need to optimize the failing case via Thread.join.
1043              delay(millis);
1044              assertTrue(thread.isAlive());
1045 <        } catch (InterruptedException ie) {
1046 <            fail("Unexpected InterruptedException");
1045 >        } catch (InterruptedException fail) {
1046 >            threadFail("Unexpected InterruptedException");
1047          }
1048      }
1049  
# Line 704 | Line 1064 | public class JSR166TestCase extends Test
1064              delay(millis);
1065              for (Thread thread : threads)
1066                  assertTrue(thread.isAlive());
1067 <        } catch (InterruptedException ie) {
1068 <            fail("Unexpected InterruptedException");
1067 >        } catch (InterruptedException fail) {
1068 >            threadFail("Unexpected InterruptedException");
1069          }
1070      }
1071  
# Line 726 | Line 1086 | public class JSR166TestCase extends Test
1086              future.get(timeoutMillis, MILLISECONDS);
1087              shouldThrow();
1088          } catch (TimeoutException success) {
1089 <        } catch (Exception e) {
1090 <            threadUnexpectedException(e);
1089 >        } catch (Exception fail) {
1090 >            threadUnexpectedException(fail);
1091          } finally { future.cancel(true); }
1092          assertTrue(millisElapsedSince(startTime) >= timeoutMillis);
1093      }
# Line 880 | Line 1240 | public class JSR166TestCase extends Test
1240       * Sleeps until the given time has elapsed.
1241       * Throws AssertionFailedError if interrupted.
1242       */
1243 <    void sleep(long millis) {
1243 >    static void sleep(long millis) {
1244          try {
1245              delay(millis);
1246 <        } catch (InterruptedException ie) {
1246 >        } catch (InterruptedException fail) {
1247              AssertionFailedError afe =
1248                  new AssertionFailedError("Unexpected InterruptedException");
1249 <            afe.initCause(ie);
1249 >            afe.initCause(fail);
1250              throw afe;
1251          }
1252      }
# Line 896 | Line 1256 | public class JSR166TestCase extends Test
1256       * thread to enter a wait state: BLOCKED, WAITING, or TIMED_WAITING.
1257       */
1258      void waitForThreadToEnterWaitState(Thread thread, long timeoutMillis) {
1259 <        long startTime = System.nanoTime();
1259 >        long startTime = 0L;
1260          for (;;) {
1261              Thread.State s = thread.getState();
1262              if (s == Thread.State.BLOCKED ||
# Line 905 | Line 1265 | public class JSR166TestCase extends Test
1265                  return;
1266              else if (s == Thread.State.TERMINATED)
1267                  fail("Unexpected thread termination");
1268 +            else if (startTime == 0L)
1269 +                startTime = System.nanoTime();
1270              else if (millisElapsedSince(startTime) > timeoutMillis) {
1271                  threadAssertTrue(thread.isAlive());
1272                  return;
# Line 924 | Line 1286 | public class JSR166TestCase extends Test
1286      /**
1287       * Returns the number of milliseconds since time given by
1288       * startNanoTime, which must have been previously returned from a
1289 <     * call to {@link System.nanoTime()}.
1289 >     * call to {@link System#nanoTime()}.
1290       */
1291      static long millisElapsedSince(long startNanoTime) {
1292          return NANOSECONDS.toMillis(System.nanoTime() - startNanoTime);
# Line 978 | Line 1340 | public class JSR166TestCase extends Test
1340      void awaitTermination(Thread t, long timeoutMillis) {
1341          try {
1342              t.join(timeoutMillis);
1343 <        } catch (InterruptedException ie) {
1344 <            threadUnexpectedException(ie);
1343 >        } catch (InterruptedException fail) {
1344 >            threadUnexpectedException(fail);
1345          } finally {
1346              if (t.getState() != Thread.State.TERMINATED) {
1347                  t.interrupt();
1348 <                fail("Test timed out");
1348 >                threadFail("timed out waiting for thread to terminate");
1349              }
1350          }
1351      }
# Line 1005 | Line 1367 | public class JSR166TestCase extends Test
1367          public final void run() {
1368              try {
1369                  realRun();
1370 <            } catch (Throwable t) {
1371 <                threadUnexpectedException(t);
1370 >            } catch (Throwable fail) {
1371 >                threadUnexpectedException(fail);
1372              }
1373          }
1374      }
# Line 1060 | Line 1422 | public class JSR166TestCase extends Test
1422                  threadShouldThrow("InterruptedException");
1423              } catch (InterruptedException success) {
1424                  threadAssertFalse(Thread.interrupted());
1425 <            } catch (Throwable t) {
1426 <                threadUnexpectedException(t);
1425 >            } catch (Throwable fail) {
1426 >                threadUnexpectedException(fail);
1427              }
1428          }
1429      }
# Line 1072 | Line 1434 | public class JSR166TestCase extends Test
1434          public final T call() {
1435              try {
1436                  return realCall();
1437 <            } catch (Throwable t) {
1438 <                threadUnexpectedException(t);
1437 >            } catch (Throwable fail) {
1438 >                threadUnexpectedException(fail);
1439                  return null;
1440              }
1441          }
# Line 1090 | Line 1452 | public class JSR166TestCase extends Test
1452                  return result;
1453              } catch (InterruptedException success) {
1454                  threadAssertFalse(Thread.interrupted());
1455 <            } catch (Throwable t) {
1456 <                threadUnexpectedException(t);
1455 >            } catch (Throwable fail) {
1456 >                threadUnexpectedException(fail);
1457              }
1458              return null;
1459          }
# Line 1108 | Line 1470 | public class JSR166TestCase extends Test
1470      public static final String TEST_STRING = "a test string";
1471  
1472      public static class StringTask implements Callable<String> {
1473 <        public String call() { return TEST_STRING; }
1473 >        final String value;
1474 >        public StringTask() { this(TEST_STRING); }
1475 >        public StringTask(String value) { this.value = value; }
1476 >        public String call() { return value; }
1477      }
1478  
1479      public Callable<String> latchAwaitingStringTask(final CountDownLatch latch) {
# Line 1121 | Line 1486 | public class JSR166TestCase extends Test
1486              }};
1487      }
1488  
1489 <    public Runnable awaiter(final CountDownLatch latch) {
1489 >    public Runnable countDowner(final CountDownLatch latch) {
1490          return new CheckedRunnable() {
1491              public void realRun() throws InterruptedException {
1492 <                await(latch);
1492 >                latch.countDown();
1493              }};
1494      }
1495  
1496 <    public void await(CountDownLatch latch) {
1497 <        try {
1498 <            assertTrue(latch.await(LONG_DELAY_MS, MILLISECONDS));
1499 <        } catch (Throwable t) {
1500 <            threadUnexpectedException(t);
1496 >    class LatchAwaiter extends CheckedRunnable {
1497 >        static final int NEW = 0;
1498 >        static final int RUNNING = 1;
1499 >        static final int DONE = 2;
1500 >        final CountDownLatch latch;
1501 >        int state = NEW;
1502 >        LatchAwaiter(CountDownLatch latch) { this.latch = latch; }
1503 >        public void realRun() throws InterruptedException {
1504 >            state = 1;
1505 >            await(latch);
1506 >            state = 2;
1507          }
1508      }
1509  
1510 +    public LatchAwaiter awaiter(CountDownLatch latch) {
1511 +        return new LatchAwaiter(latch);
1512 +    }
1513 +
1514 +    public void await(CountDownLatch latch, long timeoutMillis) {
1515 +        try {
1516 +            if (!latch.await(timeoutMillis, MILLISECONDS))
1517 +                fail("timed out waiting for CountDownLatch for "
1518 +                     + (timeoutMillis/1000) + " sec");
1519 +        } catch (Throwable fail) {
1520 +            threadUnexpectedException(fail);
1521 +        }
1522 +    }
1523 +
1524 +    public void await(CountDownLatch latch) {
1525 +        await(latch, LONG_DELAY_MS);
1526 +    }
1527 +
1528      public void await(Semaphore semaphore) {
1529          try {
1530 <            assertTrue(semaphore.tryAcquire(LONG_DELAY_MS, MILLISECONDS));
1531 <        } catch (Throwable t) {
1532 <            threadUnexpectedException(t);
1530 >            if (!semaphore.tryAcquire(LONG_DELAY_MS, MILLISECONDS))
1531 >                fail("timed out waiting for Semaphore for "
1532 >                     + (LONG_DELAY_MS/1000) + " sec");
1533 >        } catch (Throwable fail) {
1534 >            threadUnexpectedException(fail);
1535          }
1536      }
1537  
# Line 1334 | Line 1725 | public class JSR166TestCase extends Test
1725          @Override protected final void compute() {
1726              try {
1727                  realCompute();
1728 <            } catch (Throwable t) {
1729 <                threadUnexpectedException(t);
1728 >            } catch (Throwable fail) {
1729 >                threadUnexpectedException(fail);
1730              }
1731          }
1732      }
# Line 1349 | Line 1740 | public class JSR166TestCase extends Test
1740          @Override protected final T compute() {
1741              try {
1742                  return realCompute();
1743 <            } catch (Throwable t) {
1744 <                threadUnexpectedException(t);
1743 >            } catch (Throwable fail) {
1744 >                threadUnexpectedException(fail);
1745                  return null;
1746              }
1747          }
# Line 1368 | Line 1759 | public class JSR166TestCase extends Test
1759       * A CyclicBarrier that uses timed await and fails with
1760       * AssertionFailedErrors instead of throwing checked exceptions.
1761       */
1762 <    public class CheckedBarrier extends CyclicBarrier {
1762 >    public static class CheckedBarrier extends CyclicBarrier {
1763          public CheckedBarrier(int parties) { super(parties); }
1764  
1765          public int await() {
1766              try {
1767                  return super.await(2 * LONG_DELAY_MS, MILLISECONDS);
1768 <            } catch (TimeoutException e) {
1768 >            } catch (TimeoutException timedOut) {
1769                  throw new AssertionFailedError("timed out");
1770 <            } catch (Exception e) {
1770 >            } catch (Exception fail) {
1771                  AssertionFailedError afe =
1772 <                    new AssertionFailedError("Unexpected exception: " + e);
1773 <                afe.initCause(e);
1772 >                    new AssertionFailedError("Unexpected exception: " + fail);
1773 >                afe.initCause(fail);
1774                  throw afe;
1775              }
1776          }
# Line 1407 | Line 1798 | public class JSR166TestCase extends Test
1798                  q.remove();
1799                  shouldThrow();
1800              } catch (NoSuchElementException success) {}
1801 <        } catch (InterruptedException ie) {
1411 <            threadUnexpectedException(ie);
1412 <        }
1801 >        } catch (InterruptedException fail) { threadUnexpectedException(fail); }
1802      }
1803  
1804      void assertSerialEquals(Object x, Object y) {
# Line 1428 | Line 1817 | public class JSR166TestCase extends Test
1817              oos.flush();
1818              oos.close();
1819              return bos.toByteArray();
1820 <        } catch (Throwable t) {
1821 <            threadUnexpectedException(t);
1820 >        } catch (Throwable fail) {
1821 >            threadUnexpectedException(fail);
1822              return new byte[0];
1823          }
1824      }
# Line 1442 | Line 1831 | public class JSR166TestCase extends Test
1831              T clone = (T) ois.readObject();
1832              assertSame(o.getClass(), clone.getClass());
1833              return clone;
1834 <        } catch (Throwable t) {
1835 <            threadUnexpectedException(t);
1834 >        } catch (Throwable fail) {
1835 >            threadUnexpectedException(fail);
1836              return null;
1837          }
1838      }
# Line 1468 | Line 1857 | public class JSR166TestCase extends Test
1857                  shouldThrow(expectedExceptionClass.getName());
1858          }
1859      }
1860 +
1861 +    public void assertIteratorExhausted(Iterator<?> it) {
1862 +        try {
1863 +            it.next();
1864 +            shouldThrow();
1865 +        } catch (NoSuchElementException success) {}
1866 +        assertFalse(it.hasNext());
1867 +    }
1868 +
1869 +    public <T> Callable<T> callableThrowing(final Exception ex) {
1870 +        return new Callable<T>() { public T call() throws Exception { throw ex; }};
1871 +    }
1872 +
1873 +    public Runnable runnableThrowing(final RuntimeException ex) {
1874 +        return new Runnable() { public void run() { throw ex; }};
1875 +    }
1876 +
1877 +    /** A reusable thread pool to be shared by tests. */
1878 +    static final ExecutorService cachedThreadPool =
1879 +        new ThreadPoolExecutor(0, Integer.MAX_VALUE,
1880 +                               1000L, MILLISECONDS,
1881 +                               new SynchronousQueue<Runnable>());
1882 +
1883 +    static <T> void shuffle(T[] array) {
1884 +        Collections.shuffle(Arrays.asList(array), ThreadLocalRandom.current());
1885 +    }
1886   }

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines