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.125 by jsr166, Thu Jan 15 18:58:07 2015 UTC vs.
Revision 1.197 by jsr166, Wed Jun 22 14:40:36 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 + */
17 +
18   import static java.util.concurrent.TimeUnit.MILLISECONDS;
19 + import static java.util.concurrent.TimeUnit.MINUTES;
20   import static java.util.concurrent.TimeUnit.NANOSECONDS;
21  
22   import java.io.ByteArrayInputStream;
# Line 15 | Line 25 | import java.io.ObjectInputStream;
25   import java.io.ObjectOutputStream;
26   import java.lang.management.ManagementFactory;
27   import java.lang.management.ThreadInfo;
28 + import java.lang.management.ThreadMXBean;
29 + import java.lang.reflect.Constructor;
30   import java.lang.reflect.Method;
31 + import java.lang.reflect.Modifier;
32 + import java.nio.file.Files;
33 + import java.nio.file.Paths;
34   import java.security.CodeSource;
35   import java.security.Permission;
36   import java.security.PermissionCollection;
# Line 27 | Line 42 | import java.util.ArrayList;
42   import java.util.Arrays;
43   import java.util.Date;
44   import java.util.Enumeration;
45 + import java.util.Iterator;
46   import java.util.List;
47   import java.util.NoSuchElementException;
48   import java.util.PropertyPermission;
# Line 34 | Line 50 | import java.util.concurrent.BlockingQueu
50   import java.util.concurrent.Callable;
51   import java.util.concurrent.CountDownLatch;
52   import java.util.concurrent.CyclicBarrier;
53 + import java.util.concurrent.ExecutionException;
54 + import java.util.concurrent.Executors;
55   import java.util.concurrent.ExecutorService;
56 + import java.util.concurrent.ForkJoinPool;
57   import java.util.concurrent.Future;
58   import java.util.concurrent.RecursiveAction;
59   import java.util.concurrent.RecursiveTask;
60   import java.util.concurrent.RejectedExecutionHandler;
61   import java.util.concurrent.Semaphore;
62 + import java.util.concurrent.SynchronousQueue;
63   import java.util.concurrent.ThreadFactory;
64   import java.util.concurrent.ThreadPoolExecutor;
65   import java.util.concurrent.TimeoutException;
66 + import java.util.concurrent.atomic.AtomicBoolean;
67   import java.util.concurrent.atomic.AtomicReference;
68 + import java.util.regex.Matcher;
69   import java.util.regex.Pattern;
70  
71   import junit.framework.AssertionFailedError;
72   import junit.framework.Test;
73   import junit.framework.TestCase;
74 + import junit.framework.TestResult;
75   import junit.framework.TestSuite;
76  
77   /**
# Line 61 | Line 84 | import junit.framework.TestSuite;
84   *
85   * <ol>
86   *
87 < * <li> All assertions in code running in generated threads must use
87 > * <li>All assertions in code running in generated threads must use
88   * the forms {@link #threadFail}, {@link #threadAssertTrue}, {@link
89   * #threadAssertEquals}, or {@link #threadAssertNull}, (not
90   * {@code fail}, {@code assertTrue}, etc.) It is OK (but not
91   * particularly recommended) for other code to use these forms too.
92   * Only the most typically used JUnit assertion methods are defined
93 < * this way, but enough to live with.</li>
93 > * this way, but enough to live with.
94   *
95 < * <li> If you override {@link #setUp} or {@link #tearDown}, make sure
95 > * <li>If you override {@link #setUp} or {@link #tearDown}, make sure
96   * to invoke {@code super.setUp} and {@code super.tearDown} within
97   * them. These methods are used to clear and check for thread
98 < * assertion failures.</li>
98 > * assertion failures.
99   *
100   * <li>All delays and timeouts must use one of the constants {@code
101   * SHORT_DELAY_MS}, {@code SMALL_DELAY_MS}, {@code MEDIUM_DELAY_MS},
# Line 83 | Line 106 | import junit.framework.TestSuite;
106   * is always discriminable as larger than SHORT and smaller than
107   * MEDIUM.  And so on. These constants are set to conservative values,
108   * but even so, if there is ever any doubt, they can all be increased
109 < * in one spot to rerun tests on slower platforms.</li>
109 > * in one spot to rerun tests on slower platforms.
110   *
111 < * <li> All threads generated must be joined inside each test case
111 > * <li>All threads generated must be joined inside each test case
112   * method (or {@code fail} to do so) before returning from the
113   * method. The {@code joinPool} method can be used to do this when
114 < * using Executors.</li>
114 > * using Executors.
115   *
116   * </ol>
117   *
118   * <p><b>Other notes</b>
119   * <ul>
120   *
121 < * <li> Usually, there is one testcase method per JSR166 method
121 > * <li>Usually, there is one testcase method per JSR166 method
122   * covering "normal" operation, and then as many exception-testing
123   * methods as there are exceptions the method can throw. Sometimes
124   * there are multiple tests per JSR166 method when the different
125   * "normal" behaviors differ significantly. And sometimes testcases
126 < * cover multiple methods when they cannot be tested in
104 < * isolation.</li>
126 > * cover multiple methods when they cannot be tested in isolation.
127   *
128 < * <li> The documentation style for testcases is to provide as javadoc
128 > * <li>The documentation style for testcases is to provide as javadoc
129   * a simple sentence or two describing the property that the testcase
130   * method purports to test. The javadocs do not say anything about how
131 < * the property is tested. To find out, read the code.</li>
131 > * the property is tested. To find out, read the code.
132   *
133 < * <li> These tests are "conformance tests", and do not attempt to
133 > * <li>These tests are "conformance tests", and do not attempt to
134   * test throughput, latency, scalability or other performance factors
135   * (see the separate "jtreg" tests for a set intended to check these
136   * for the most central aspects of functionality.) So, most tests use
137   * the smallest sensible numbers of threads, collection sizes, etc
138 < * needed to check basic conformance.</li>
138 > * needed to check basic conformance.
139   *
140   * <li>The test classes currently do not declare inclusion in
141   * any particular package to simplify things for people integrating
142 < * them in TCK test suites.</li>
142 > * them in TCK test suites.
143   *
144 < * <li> As a convenience, the {@code main} of this class (JSR166TestCase)
145 < * runs all JSR166 unit tests.</li>
144 > * <li>As a convenience, the {@code main} of this class (JSR166TestCase)
145 > * runs all JSR166 unit tests.
146   *
147   * </ul>
148   */
# Line 159 | Line 181 | public class JSR166TestCase extends Test
181          Integer.getInteger("jsr166.runsPerTest", 1);
182  
183      /**
184 +     * The number of repetitions of the test suite (for finding leaks?).
185 +     */
186 +    private static final int suiteRuns =
187 +        Integer.getInteger("jsr166.suiteRuns", 1);
188 +
189 +    /**
190 +     * Returns the value of the system property, or NaN if not defined.
191 +     */
192 +    private static float systemPropertyValue(String name) {
193 +        String floatString = System.getProperty(name);
194 +        if (floatString == null)
195 +            return Float.NaN;
196 +        try {
197 +            return Float.parseFloat(floatString);
198 +        } catch (NumberFormatException ex) {
199 +            throw new IllegalArgumentException(
200 +                String.format("Bad float value in system property %s=%s",
201 +                              name, floatString));
202 +        }
203 +    }
204 +
205 +    /**
206 +     * The scaling factor to apply to standard delays used in tests.
207 +     * May be initialized from any of:
208 +     * - the "jsr166.delay.factor" system property
209 +     * - the "test.timeout.factor" system property (as used by jtreg)
210 +     *   See: http://openjdk.java.net/jtreg/tag-spec.html
211 +     * - hard-coded fuzz factor when using a known slowpoke VM
212 +     */
213 +    private static final float delayFactor = delayFactor();
214 +
215 +    private static float delayFactor() {
216 +        float x;
217 +        if (!Float.isNaN(x = systemPropertyValue("jsr166.delay.factor")))
218 +            return x;
219 +        if (!Float.isNaN(x = systemPropertyValue("test.timeout.factor")))
220 +            return x;
221 +        String prop = System.getProperty("java.vm.version");
222 +        if (prop != null && prop.matches(".*debug.*"))
223 +            return 4.0f; // How much slower is fastdebug than product?!
224 +        return 1.0f;
225 +    }
226 +
227 +    public JSR166TestCase() { super(); }
228 +    public JSR166TestCase(String name) { super(name); }
229 +
230 +    /**
231       * A filter for tests to run, matching strings of the form
232       * methodName(className), e.g. "testInvokeAll5(ForkJoinPoolTest)"
233       * Usefully combined with jsr166.runsPerTest.
# Line 170 | Line 239 | public class JSR166TestCase extends Test
239          return (regex == null) ? null : Pattern.compile(regex);
240      }
241  
242 <    protected void runTest() throws Throwable {
242 >    // Instrumentation to debug very rare, but very annoying hung test runs.
243 >    static volatile TestCase currentTestCase;
244 >    // static volatile int currentRun = 0;
245 >    static {
246 >        Runnable checkForWedgedTest = new Runnable() { public void run() {
247 >            // Avoid spurious reports with enormous runsPerTest.
248 >            // A single test case run should never take more than 1 second.
249 >            // But let's cap it at the high end too ...
250 >            final int timeoutMinutes =
251 >                Math.min(15, Math.max(runsPerTest / 60, 1));
252 >            for (TestCase lastTestCase = currentTestCase;;) {
253 >                try { MINUTES.sleep(timeoutMinutes); }
254 >                catch (InterruptedException unexpected) { break; }
255 >                if (lastTestCase == currentTestCase) {
256 >                    System.err.printf(
257 >                        "Looks like we're stuck running test: %s%n",
258 >                        lastTestCase);
259 > //                     System.err.printf(
260 > //                         "Looks like we're stuck running test: %s (%d/%d)%n",
261 > //                         lastTestCase, currentRun, runsPerTest);
262 > //                     System.err.println("availableProcessors=" +
263 > //                         Runtime.getRuntime().availableProcessors());
264 > //                     System.err.printf("cpu model = %s%n", cpuModel());
265 >                    dumpTestThreads();
266 >                    // one stack dump is probably enough; more would be spam
267 >                    break;
268 >                }
269 >                lastTestCase = currentTestCase;
270 >            }}};
271 >        Thread thread = new Thread(checkForWedgedTest, "checkForWedgedTest");
272 >        thread.setDaemon(true);
273 >        thread.start();
274 >    }
275 >
276 > //     public static String cpuModel() {
277 > //         try {
278 > //             Matcher matcher = Pattern.compile("model name\\s*: (.*)")
279 > //                 .matcher(new String(
280 > //                      Files.readAllBytes(Paths.get("/proc/cpuinfo")), "UTF-8"));
281 > //             matcher.find();
282 > //             return matcher.group(1);
283 > //         } catch (Exception ex) { return null; }
284 > //     }
285 >
286 >    public void runBare() throws Throwable {
287 >        currentTestCase = this;
288          if (methodFilter == null
289 <            || methodFilter.matcher(toString()).find()) {
290 <            for (int i = 0; i < runsPerTest; i++) {
291 <                if (profileTests)
292 <                    runTestProfiled();
293 <                else
294 <                    super.runTest();
295 <            }
289 >            || methodFilter.matcher(toString()).find())
290 >            super.runBare();
291 >    }
292 >
293 >    protected void runTest() throws Throwable {
294 >        for (int i = 0; i < runsPerTest; i++) {
295 >            // currentRun = i;
296 >            if (profileTests)
297 >                runTestProfiled();
298 >            else
299 >                super.runTest();
300          }
301      }
302  
303      protected void runTestProfiled() throws Throwable {
304 <        // Warmup run, notably to trigger all needed classloading.
305 <        super.runTest();
188 <        long t0 = System.nanoTime();
189 <        try {
304 >        for (int i = 0; i < 2; i++) {
305 >            long startTime = System.nanoTime();
306              super.runTest();
307 <        } finally {
308 <            long elapsedMillis = millisElapsedSince(t0);
309 <            if (elapsedMillis >= profileThreshold)
307 >            long elapsedMillis = millisElapsedSince(startTime);
308 >            if (elapsedMillis < profileThreshold)
309 >                break;
310 >            // Never report first run of any test; treat it as a
311 >            // warmup run, notably to trigger all needed classloading,
312 >            if (i > 0)
313                  System.out.printf("%n%s: %d%n", toString(), elapsedMillis);
314          }
315      }
316  
317      /**
318       * 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.
319       */
320      public static void main(String[] args) {
321 +        main(suite(), args);
322 +    }
323 +
324 +    static class PithyResultPrinter extends junit.textui.ResultPrinter {
325 +        PithyResultPrinter(java.io.PrintStream writer) { super(writer); }
326 +        long runTime;
327 +        public void startTest(Test test) {}
328 +        protected void printHeader(long runTime) {
329 +            this.runTime = runTime; // defer printing for later
330 +        }
331 +        protected void printFooter(TestResult result) {
332 +            if (result.wasSuccessful()) {
333 +                getWriter().println("OK (" + result.runCount() + " tests)"
334 +                    + "  Time: " + elapsedTimeAsString(runTime));
335 +            } else {
336 +                getWriter().println("Time: " + elapsedTimeAsString(runTime));
337 +                super.printFooter(result);
338 +            }
339 +        }
340 +    }
341 +
342 +    /**
343 +     * Returns a TestRunner that doesn't bother with unnecessary
344 +     * fluff, like printing a "." for each test case.
345 +     */
346 +    static junit.textui.TestRunner newPithyTestRunner() {
347 +        junit.textui.TestRunner runner = new junit.textui.TestRunner();
348 +        runner.setPrinter(new PithyResultPrinter(System.out));
349 +        return runner;
350 +    }
351 +
352 +    /**
353 +     * Runs all unit tests in the given test suite.
354 +     * Actual behavior influenced by jsr166.* system properties.
355 +     */
356 +    static void main(Test suite, String[] args) {
357          if (useSecurityManager) {
358              System.err.println("Setting a permissive security manager");
359              Policy.setPolicy(permissivePolicy());
360              System.setSecurityManager(new SecurityManager());
361          }
362 <        int iters = (args.length == 0) ? 1 : Integer.parseInt(args[0]);
363 <
364 <        Test s = suite();
365 <        for (int i = 0; i < iters; ++i) {
213 <            junit.textui.TestRunner.run(s);
362 >        for (int i = 0; i < suiteRuns; i++) {
363 >            TestResult result = newPithyTestRunner().doRun(suite);
364 >            if (!result.wasSuccessful())
365 >                System.exit(1);
366              System.gc();
367              System.runFinalization();
368          }
217        System.exit(0);
369      }
370  
371      public static TestSuite newTestSuite(Object... suiteOrClasses) {
# Line 265 | Line 416 | public class JSR166TestCase extends Test
416      public static boolean atLeastJava7() { return JAVA_CLASS_VERSION >= 51.0; }
417      public static boolean atLeastJava8() { return JAVA_CLASS_VERSION >= 52.0; }
418      public static boolean atLeastJava9() {
419 <        // As of 2014-05, java9 still uses 52.0 class file version
420 <        return JAVA_SPECIFICATION_VERSION.startsWith("1.9");
419 >        return JAVA_CLASS_VERSION >= 53.0
420 >            // As of 2015-09, java9 still uses 52.0 class file version
421 >            || JAVA_SPECIFICATION_VERSION.matches("^(1\\.)?(9|[0-9][0-9])$");
422 >    }
423 >    public static boolean atLeastJava10() {
424 >        return JAVA_CLASS_VERSION >= 54.0
425 >            || JAVA_SPECIFICATION_VERSION.matches("^(1\\.)?[0-9][0-9]$");
426      }
427  
428      /**
# Line 355 | Line 511 | public class JSR166TestCase extends Test
511                  "LongAdderTest",
512                  "SplittableRandomTest",
513                  "StampedLockTest",
514 +                "SubmissionPublisherTest",
515                  "ThreadLocalRandom8Test",
516 +                "TimeUnit8Test",
517              };
518              addNamedTestClasses(suite, java8TestClassNames);
519          }
# Line 363 | Line 521 | public class JSR166TestCase extends Test
521          // Java9+ test classes
522          if (atLeastJava9()) {
523              String[] java9TestClassNames = {
524 <                "ThreadPoolExecutor9Test",
524 >                "AtomicBoolean9Test",
525 >                "AtomicInteger9Test",
526 >                "AtomicIntegerArray9Test",
527 >                "AtomicLong9Test",
528 >                "AtomicLongArray9Test",
529 >                "AtomicReference9Test",
530 >                "AtomicReferenceArray9Test",
531 >                "ExecutorCompletionService9Test",
532              };
533              addNamedTestClasses(suite, java9TestClassNames);
534          }
# Line 371 | Line 536 | public class JSR166TestCase extends Test
536          return suite;
537      }
538  
539 +    /** Returns list of junit-style test method names in given class. */
540 +    public static ArrayList<String> testMethodNames(Class<?> testClass) {
541 +        Method[] methods = testClass.getDeclaredMethods();
542 +        ArrayList<String> names = new ArrayList<String>(methods.length);
543 +        for (Method method : methods) {
544 +            if (method.getName().startsWith("test")
545 +                && Modifier.isPublic(method.getModifiers())
546 +                // method.getParameterCount() requires jdk8+
547 +                && method.getParameterTypes().length == 0) {
548 +                names.add(method.getName());
549 +            }
550 +        }
551 +        return names;
552 +    }
553 +
554 +    /**
555 +     * Returns junit-style testSuite for the given test class, but
556 +     * parameterized by passing extra data to each test.
557 +     */
558 +    public static <ExtraData> Test parameterizedTestSuite
559 +        (Class<? extends JSR166TestCase> testClass,
560 +         Class<ExtraData> dataClass,
561 +         ExtraData data) {
562 +        try {
563 +            TestSuite suite = new TestSuite();
564 +            Constructor c =
565 +                testClass.getDeclaredConstructor(dataClass, String.class);
566 +            for (String methodName : testMethodNames(testClass))
567 +                suite.addTest((Test) c.newInstance(data, methodName));
568 +            return suite;
569 +        } catch (Exception e) {
570 +            throw new Error(e);
571 +        }
572 +    }
573 +
574 +    /**
575 +     * Returns junit-style testSuite for the jdk8 extension of the
576 +     * given test class, but parameterized by passing extra data to
577 +     * each test.  Uses reflection to allow compilation in jdk7.
578 +     */
579 +    public static <ExtraData> Test jdk8ParameterizedTestSuite
580 +        (Class<? extends JSR166TestCase> testClass,
581 +         Class<ExtraData> dataClass,
582 +         ExtraData data) {
583 +        if (atLeastJava8()) {
584 +            String name = testClass.getName();
585 +            String name8 = name.replaceAll("Test$", "8Test");
586 +            if (name.equals(name8)) throw new Error(name);
587 +            try {
588 +                return (Test)
589 +                    Class.forName(name8)
590 +                    .getMethod("testSuite", new Class[] { dataClass })
591 +                    .invoke(null, data);
592 +            } catch (Exception e) {
593 +                throw new Error(e);
594 +            }
595 +        } else {
596 +            return new TestSuite();
597 +        }
598 +    }
599 +
600      // Delays for timing-dependent tests, in milliseconds.
601  
602      public static long SHORT_DELAY_MS;
# Line 379 | Line 605 | public class JSR166TestCase extends Test
605      public static long LONG_DELAY_MS;
606  
607      /**
608 <     * Returns the shortest timed delay. This could
609 <     * be reimplemented to use for example a Property.
608 >     * Returns the shortest timed delay. This can be scaled up for
609 >     * slow machines using the jsr166.delay.factor system property,
610 >     * or via jtreg's -timeoutFactor: flag.
611 >     * http://openjdk.java.net/jtreg/command-help.html
612       */
613      protected long getShortDelay() {
614 <        return 50;
614 >        return (long) (50 * delayFactor);
615      }
616  
617      /**
# Line 405 | Line 633 | public class JSR166TestCase extends Test
633      }
634  
635      /**
636 <     * Returns a new Date instance representing a time delayMillis
637 <     * milliseconds in the future.
636 >     * Returns a new Date instance representing a time at least
637 >     * delayMillis milliseconds in the future.
638       */
639      Date delayedDate(long delayMillis) {
640 <        return new Date(System.currentTimeMillis() + delayMillis);
640 >        // Add 1 because currentTimeMillis is known to round into the past.
641 >        return new Date(System.currentTimeMillis() + delayMillis + 1);
642      }
643  
644      /**
# Line 425 | Line 654 | public class JSR166TestCase extends Test
654       * the same test have no effect.
655       */
656      public void threadRecordFailure(Throwable t) {
657 +        System.err.println(t);
658 +        dumpTestThreads();
659          threadFailure.compareAndSet(null, t);
660      }
661  
# Line 432 | Line 663 | public class JSR166TestCase extends Test
663          setDelays();
664      }
665  
666 +    void tearDownFail(String format, Object... args) {
667 +        String msg = toString() + ": " + String.format(format, args);
668 +        System.err.println(msg);
669 +        dumpTestThreads();
670 +        throw new AssertionFailedError(msg);
671 +    }
672 +
673      /**
674       * Extra checks that get done for all test cases.
675       *
# Line 459 | Line 697 | public class JSR166TestCase extends Test
697          }
698  
699          if (Thread.interrupted())
700 <            throw new AssertionFailedError("interrupt status set in main thread");
700 >            tearDownFail("interrupt status set in main thread");
701  
702          checkForkJoinPoolThreadLeaks();
703      }
704  
705      /**
706 <     * Finds missing try { ... } finally { joinPool(e); }
706 >     * Finds missing PoolCleaners
707       */
708      void checkForkJoinPoolThreadLeaks() throws InterruptedException {
709 <        Thread[] survivors = new Thread[5];
709 >        Thread[] survivors = new Thread[7];
710          int count = Thread.enumerate(survivors);
711          for (int i = 0; i < count; i++) {
712              Thread thread = survivors[i];
# Line 476 | Line 714 | public class JSR166TestCase extends Test
714              if (name.startsWith("ForkJoinPool-")) {
715                  // give thread some time to terminate
716                  thread.join(LONG_DELAY_MS);
717 <                if (!thread.isAlive()) continue;
718 <                thread.stop();
719 <                throw new AssertionFailedError
482 <                    (String.format("Found leaked ForkJoinPool thread test=%s thread=%s%n",
483 <                                   toString(), name));
717 >                if (thread.isAlive())
718 >                    tearDownFail("Found leaked ForkJoinPool thread thread=%s",
719 >                                 thread);
720              }
721          }
722 +
723 +        if (!ForkJoinPool.commonPool()
724 +            .awaitQuiescence(LONG_DELAY_MS, MILLISECONDS))
725 +            tearDownFail("ForkJoin common pool thread stuck");
726      }
727  
728      /**
# Line 495 | Line 735 | public class JSR166TestCase extends Test
735              fail(reason);
736          } catch (AssertionFailedError t) {
737              threadRecordFailure(t);
738 <            fail(reason);
738 >            throw t;
739          }
740      }
741  
# Line 563 | Line 803 | public class JSR166TestCase extends Test
803      public void threadAssertEquals(Object x, Object y) {
804          try {
805              assertEquals(x, y);
806 <        } catch (AssertionFailedError t) {
807 <            threadRecordFailure(t);
808 <            throw t;
809 <        } catch (Throwable t) {
810 <            threadUnexpectedException(t);
806 >        } catch (AssertionFailedError fail) {
807 >            threadRecordFailure(fail);
808 >            throw fail;
809 >        } catch (Throwable fail) {
810 >            threadUnexpectedException(fail);
811          }
812      }
813  
# Line 579 | Line 819 | public class JSR166TestCase extends Test
819      public void threadAssertSame(Object x, Object y) {
820          try {
821              assertSame(x, y);
822 <        } catch (AssertionFailedError t) {
823 <            threadRecordFailure(t);
824 <            throw t;
822 >        } catch (AssertionFailedError fail) {
823 >            threadRecordFailure(fail);
824 >            throw fail;
825          }
826      }
827  
# Line 622 | Line 862 | public class JSR166TestCase extends Test
862      /**
863       * Delays, via Thread.sleep, for the given millisecond delay, but
864       * if the sleep is shorter than specified, may re-sleep or yield
865 <     * until time elapses.
865 >     * until time elapses.  Ensures that the given time, as measured
866 >     * by System.nanoTime(), has elapsed.
867       */
868      static void delay(long millis) throws InterruptedException {
869 <        long startTime = System.nanoTime();
870 <        long ns = millis * 1000 * 1000;
871 <        for (;;) {
869 >        long nanos = millis * (1000 * 1000);
870 >        final long wakeupTime = System.nanoTime() + nanos;
871 >        do {
872              if (millis > 0L)
873                  Thread.sleep(millis);
874              else // too short to sleep
875                  Thread.yield();
876 <            long d = ns - (System.nanoTime() - startTime);
877 <            if (d > 0L)
878 <                millis = d / (1000 * 1000);
879 <            else
880 <                break;
876 >            nanos = wakeupTime - System.nanoTime();
877 >            millis = nanos / (1000 * 1000);
878 >        } while (nanos >= 0L);
879 >    }
880 >
881 >    /**
882 >     * Allows use of try-with-resources with per-test thread pools.
883 >     */
884 >    class PoolCleaner implements AutoCloseable {
885 >        private final ExecutorService pool;
886 >        public PoolCleaner(ExecutorService pool) { this.pool = pool; }
887 >        public void close() { joinPool(pool); }
888 >    }
889 >
890 >    /**
891 >     * An extension of PoolCleaner that has an action to release the pool.
892 >     */
893 >    class PoolCleanerWithReleaser extends PoolCleaner {
894 >        private final Runnable releaser;
895 >        public PoolCleanerWithReleaser(ExecutorService pool, Runnable releaser) {
896 >            super(pool);
897 >            this.releaser = releaser;
898          }
899 +        public void close() {
900 +            try {
901 +                releaser.run();
902 +            } finally {
903 +                super.close();
904 +            }
905 +        }
906 +    }
907 +
908 +    PoolCleaner cleaner(ExecutorService pool) {
909 +        return new PoolCleaner(pool);
910 +    }
911 +
912 +    PoolCleaner cleaner(ExecutorService pool, Runnable releaser) {
913 +        return new PoolCleanerWithReleaser(pool, releaser);
914 +    }
915 +
916 +    PoolCleaner cleaner(ExecutorService pool, CountDownLatch latch) {
917 +        return new PoolCleanerWithReleaser(pool, releaser(latch));
918 +    }
919 +
920 +    Runnable releaser(final CountDownLatch latch) {
921 +        return new Runnable() { public void run() {
922 +            do { latch.countDown(); }
923 +            while (latch.getCount() > 0);
924 +        }};
925 +    }
926 +
927 +    PoolCleaner cleaner(ExecutorService pool, AtomicBoolean flag) {
928 +        return new PoolCleanerWithReleaser(pool, releaser(flag));
929 +    }
930 +
931 +    Runnable releaser(final AtomicBoolean flag) {
932 +        return new Runnable() { public void run() { flag.set(true); }};
933      }
934  
935      /**
936       * Waits out termination of a thread pool or fails doing so.
937       */
938 <    void joinPool(ExecutorService exec) {
938 >    void joinPool(ExecutorService pool) {
939          try {
940 <            exec.shutdown();
941 <            if (!exec.awaitTermination(2 * LONG_DELAY_MS, MILLISECONDS))
942 <                fail("ExecutorService " + exec +
943 <                     " did not terminate in a timely manner");
940 >            pool.shutdown();
941 >            if (!pool.awaitTermination(2 * LONG_DELAY_MS, MILLISECONDS)) {
942 >                try {
943 >                    threadFail("ExecutorService " + pool +
944 >                               " did not terminate in a timely manner");
945 >                } finally {
946 >                    // last resort, for the benefit of subsequent tests
947 >                    pool.shutdownNow();
948 >                    pool.awaitTermination(MEDIUM_DELAY_MS, MILLISECONDS);
949 >                }
950 >            }
951          } catch (SecurityException ok) {
952              // Allowed in case test doesn't have privs
953 <        } catch (InterruptedException ie) {
954 <            fail("Unexpected InterruptedException");
953 >        } catch (InterruptedException fail) {
954 >            threadFail("Unexpected InterruptedException");
955 >        }
956 >    }
957 >
958 >    /**
959 >     * Like Runnable, but with the freedom to throw anything.
960 >     * junit folks had the same idea:
961 >     * http://junit.org/junit5/docs/snapshot/api/org/junit/gen5/api/Executable.html
962 >     */
963 >    interface Action { public void run() throws Throwable; }
964 >
965 >    /**
966 >     * Runs all the given actions in parallel, failing if any fail.
967 >     * Useful for running multiple variants of tests that are
968 >     * necessarily individually slow because they must block.
969 >     */
970 >    void testInParallel(Action ... actions) {
971 >        ExecutorService pool = Executors.newCachedThreadPool();
972 >        try (PoolCleaner cleaner = cleaner(pool)) {
973 >            ArrayList<Future<?>> futures = new ArrayList<>(actions.length);
974 >            for (final Action action : actions)
975 >                futures.add(pool.submit(new CheckedRunnable() {
976 >                    public void realRun() throws Throwable { action.run();}}));
977 >            for (Future<?> future : futures)
978 >                try {
979 >                    assertNull(future.get(LONG_DELAY_MS, MILLISECONDS));
980 >                } catch (ExecutionException ex) {
981 >                    threadUnexpectedException(ex.getCause());
982 >                } catch (Exception ex) {
983 >                    threadUnexpectedException(ex);
984 >                }
985          }
986      }
987  
988      /**
989 <     * A debugging tool to print all stack traces, as jstack does.
989 >     * A debugging tool to print stack traces of most threads, as jstack does.
990 >     * Uninteresting threads are filtered out.
991       */
992 <    static void printAllStackTraces() {
993 <        for (ThreadInfo info :
994 <                 ManagementFactory.getThreadMXBean()
995 <                 .dumpAllThreads(true, true))
992 >    static void dumpTestThreads() {
993 >        SecurityManager sm = System.getSecurityManager();
994 >        if (sm != null) {
995 >            try {
996 >                System.setSecurityManager(null);
997 >            } catch (SecurityException giveUp) {
998 >                return;
999 >            }
1000 >        }
1001 >
1002 >        ThreadMXBean threadMXBean = ManagementFactory.getThreadMXBean();
1003 >        System.err.println("------ stacktrace dump start ------");
1004 >        for (ThreadInfo info : threadMXBean.dumpAllThreads(true, true)) {
1005 >            String name = info.getThreadName();
1006 >            if ("Signal Dispatcher".equals(name))
1007 >                continue;
1008 >            if ("Reference Handler".equals(name)
1009 >                && info.getLockName().startsWith("java.lang.ref.Reference$Lock"))
1010 >                continue;
1011 >            if ("Finalizer".equals(name)
1012 >                && info.getLockName().startsWith("java.lang.ref.ReferenceQueue$Lock"))
1013 >                continue;
1014 >            if ("checkForWedgedTest".equals(name))
1015 >                continue;
1016              System.err.print(info);
1017 +        }
1018 +        System.err.println("------ stacktrace dump end ------");
1019 +
1020 +        if (sm != null) System.setSecurityManager(sm);
1021      }
1022  
1023      /**
# Line 682 | Line 1036 | public class JSR166TestCase extends Test
1036              // No need to optimize the failing case via Thread.join.
1037              delay(millis);
1038              assertTrue(thread.isAlive());
1039 <        } catch (InterruptedException ie) {
1040 <            fail("Unexpected InterruptedException");
1039 >        } catch (InterruptedException fail) {
1040 >            threadFail("Unexpected InterruptedException");
1041          }
1042      }
1043  
# Line 704 | Line 1058 | public class JSR166TestCase extends Test
1058              delay(millis);
1059              for (Thread thread : threads)
1060                  assertTrue(thread.isAlive());
1061 <        } catch (InterruptedException ie) {
1062 <            fail("Unexpected InterruptedException");
1061 >        } catch (InterruptedException fail) {
1062 >            threadFail("Unexpected InterruptedException");
1063          }
1064      }
1065  
# Line 726 | Line 1080 | public class JSR166TestCase extends Test
1080              future.get(timeoutMillis, MILLISECONDS);
1081              shouldThrow();
1082          } catch (TimeoutException success) {
1083 <        } catch (Exception e) {
1084 <            threadUnexpectedException(e);
1083 >        } catch (Exception fail) {
1084 >            threadUnexpectedException(fail);
1085          } finally { future.cancel(true); }
1086          assertTrue(millisElapsedSince(startTime) >= timeoutMillis);
1087      }
# Line 883 | Line 1237 | public class JSR166TestCase extends Test
1237      void sleep(long millis) {
1238          try {
1239              delay(millis);
1240 <        } catch (InterruptedException ie) {
1240 >        } catch (InterruptedException fail) {
1241              AssertionFailedError afe =
1242                  new AssertionFailedError("Unexpected InterruptedException");
1243 <            afe.initCause(ie);
1243 >            afe.initCause(fail);
1244              throw afe;
1245          }
1246      }
# Line 978 | Line 1332 | public class JSR166TestCase extends Test
1332      void awaitTermination(Thread t, long timeoutMillis) {
1333          try {
1334              t.join(timeoutMillis);
1335 <        } catch (InterruptedException ie) {
1336 <            threadUnexpectedException(ie);
1335 >        } catch (InterruptedException fail) {
1336 >            threadUnexpectedException(fail);
1337          } finally {
1338              if (t.getState() != Thread.State.TERMINATED) {
1339                  t.interrupt();
1340 <                fail("Test timed out");
1340 >                threadFail("timed out waiting for thread to terminate");
1341              }
1342          }
1343      }
# Line 1005 | Line 1359 | public class JSR166TestCase extends Test
1359          public final void run() {
1360              try {
1361                  realRun();
1362 <            } catch (Throwable t) {
1363 <                threadUnexpectedException(t);
1362 >            } catch (Throwable fail) {
1363 >                threadUnexpectedException(fail);
1364              }
1365          }
1366      }
# Line 1060 | Line 1414 | public class JSR166TestCase extends Test
1414                  threadShouldThrow("InterruptedException");
1415              } catch (InterruptedException success) {
1416                  threadAssertFalse(Thread.interrupted());
1417 <            } catch (Throwable t) {
1418 <                threadUnexpectedException(t);
1417 >            } catch (Throwable fail) {
1418 >                threadUnexpectedException(fail);
1419              }
1420          }
1421      }
# Line 1072 | Line 1426 | public class JSR166TestCase extends Test
1426          public final T call() {
1427              try {
1428                  return realCall();
1429 <            } catch (Throwable t) {
1430 <                threadUnexpectedException(t);
1429 >            } catch (Throwable fail) {
1430 >                threadUnexpectedException(fail);
1431                  return null;
1432              }
1433          }
# Line 1090 | Line 1444 | public class JSR166TestCase extends Test
1444                  return result;
1445              } catch (InterruptedException success) {
1446                  threadAssertFalse(Thread.interrupted());
1447 <            } catch (Throwable t) {
1448 <                threadUnexpectedException(t);
1447 >            } catch (Throwable fail) {
1448 >                threadUnexpectedException(fail);
1449              }
1450              return null;
1451          }
# Line 1108 | Line 1462 | public class JSR166TestCase extends Test
1462      public static final String TEST_STRING = "a test string";
1463  
1464      public static class StringTask implements Callable<String> {
1465 <        public String call() { return TEST_STRING; }
1465 >        final String value;
1466 >        public StringTask() { this(TEST_STRING); }
1467 >        public StringTask(String value) { this.value = value; }
1468 >        public String call() { return value; }
1469      }
1470  
1471      public Callable<String> latchAwaitingStringTask(final CountDownLatch latch) {
# Line 1121 | Line 1478 | public class JSR166TestCase extends Test
1478              }};
1479      }
1480  
1481 <    public Runnable awaiter(final CountDownLatch latch) {
1481 >    public Runnable countDowner(final CountDownLatch latch) {
1482          return new CheckedRunnable() {
1483              public void realRun() throws InterruptedException {
1484 <                await(latch);
1484 >                latch.countDown();
1485              }};
1486      }
1487  
1488 <    public void await(CountDownLatch latch) {
1489 <        try {
1490 <            assertTrue(latch.await(LONG_DELAY_MS, MILLISECONDS));
1491 <        } catch (Throwable t) {
1492 <            threadUnexpectedException(t);
1488 >    class LatchAwaiter extends CheckedRunnable {
1489 >        static final int NEW = 0;
1490 >        static final int RUNNING = 1;
1491 >        static final int DONE = 2;
1492 >        final CountDownLatch latch;
1493 >        int state = NEW;
1494 >        LatchAwaiter(CountDownLatch latch) { this.latch = latch; }
1495 >        public void realRun() throws InterruptedException {
1496 >            state = 1;
1497 >            await(latch);
1498 >            state = 2;
1499          }
1500      }
1501  
1502 +    public LatchAwaiter awaiter(CountDownLatch latch) {
1503 +        return new LatchAwaiter(latch);
1504 +    }
1505 +
1506 +    public void await(CountDownLatch latch, long timeoutMillis) {
1507 +        try {
1508 +            if (!latch.await(timeoutMillis, MILLISECONDS))
1509 +                fail("timed out waiting for CountDownLatch for "
1510 +                     + (timeoutMillis/1000) + " sec");
1511 +        } catch (Throwable fail) {
1512 +            threadUnexpectedException(fail);
1513 +        }
1514 +    }
1515 +
1516 +    public void await(CountDownLatch latch) {
1517 +        await(latch, LONG_DELAY_MS);
1518 +    }
1519 +
1520      public void await(Semaphore semaphore) {
1521          try {
1522 <            assertTrue(semaphore.tryAcquire(LONG_DELAY_MS, MILLISECONDS));
1523 <        } catch (Throwable t) {
1524 <            threadUnexpectedException(t);
1522 >            if (!semaphore.tryAcquire(LONG_DELAY_MS, MILLISECONDS))
1523 >                fail("timed out waiting for Semaphore for "
1524 >                     + (LONG_DELAY_MS/1000) + " sec");
1525 >        } catch (Throwable fail) {
1526 >            threadUnexpectedException(fail);
1527          }
1528      }
1529  
# Line 1334 | Line 1717 | public class JSR166TestCase extends Test
1717          @Override protected final void compute() {
1718              try {
1719                  realCompute();
1720 <            } catch (Throwable t) {
1721 <                threadUnexpectedException(t);
1720 >            } catch (Throwable fail) {
1721 >                threadUnexpectedException(fail);
1722              }
1723          }
1724      }
# Line 1349 | Line 1732 | public class JSR166TestCase extends Test
1732          @Override protected final T compute() {
1733              try {
1734                  return realCompute();
1735 <            } catch (Throwable t) {
1736 <                threadUnexpectedException(t);
1735 >            } catch (Throwable fail) {
1736 >                threadUnexpectedException(fail);
1737                  return null;
1738              }
1739          }
# Line 1374 | Line 1757 | public class JSR166TestCase extends Test
1757          public int await() {
1758              try {
1759                  return super.await(2 * LONG_DELAY_MS, MILLISECONDS);
1760 <            } catch (TimeoutException e) {
1760 >            } catch (TimeoutException timedOut) {
1761                  throw new AssertionFailedError("timed out");
1762 <            } catch (Exception e) {
1762 >            } catch (Exception fail) {
1763                  AssertionFailedError afe =
1764 <                    new AssertionFailedError("Unexpected exception: " + e);
1765 <                afe.initCause(e);
1764 >                    new AssertionFailedError("Unexpected exception: " + fail);
1765 >                afe.initCause(fail);
1766                  throw afe;
1767              }
1768          }
# Line 1407 | Line 1790 | public class JSR166TestCase extends Test
1790                  q.remove();
1791                  shouldThrow();
1792              } catch (NoSuchElementException success) {}
1793 <        } catch (InterruptedException ie) {
1411 <            threadUnexpectedException(ie);
1412 <        }
1793 >        } catch (InterruptedException fail) { threadUnexpectedException(fail); }
1794      }
1795  
1796      void assertSerialEquals(Object x, Object y) {
# Line 1428 | Line 1809 | public class JSR166TestCase extends Test
1809              oos.flush();
1810              oos.close();
1811              return bos.toByteArray();
1812 <        } catch (Throwable t) {
1813 <            threadUnexpectedException(t);
1812 >        } catch (Throwable fail) {
1813 >            threadUnexpectedException(fail);
1814              return new byte[0];
1815          }
1816      }
# Line 1442 | Line 1823 | public class JSR166TestCase extends Test
1823              T clone = (T) ois.readObject();
1824              assertSame(o.getClass(), clone.getClass());
1825              return clone;
1826 <        } catch (Throwable t) {
1827 <            threadUnexpectedException(t);
1826 >        } catch (Throwable fail) {
1827 >            threadUnexpectedException(fail);
1828              return null;
1829          }
1830      }
# Line 1468 | Line 1849 | public class JSR166TestCase extends Test
1849                  shouldThrow(expectedExceptionClass.getName());
1850          }
1851      }
1852 +
1853 +    public void assertIteratorExhausted(Iterator<?> it) {
1854 +        try {
1855 +            it.next();
1856 +            shouldThrow();
1857 +        } catch (NoSuchElementException success) {}
1858 +        assertFalse(it.hasNext());
1859 +    }
1860 +
1861 +    public <T> Callable<T> callableThrowing(final Exception ex) {
1862 +        return new Callable<T>() { public T call() throws Exception { throw ex; }};
1863 +    }
1864 +
1865 +    public Runnable runnableThrowing(final RuntimeException ex) {
1866 +        return new Runnable() { public void run() { throw ex; }};
1867 +    }
1868 +
1869 +    /** A reusable thread pool to be shared by tests. */
1870 +    static final ExecutorService cachedThreadPool =
1871 +        new ThreadPoolExecutor(0, Integer.MAX_VALUE,
1872 +                               1000L, MILLISECONDS,
1873 +                               new SynchronousQueue<Runnable>());
1874 +
1875   }

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines