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.188 by jsr166, Mon Feb 22 23:16:06 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 + */
16 +
17   import static java.util.concurrent.TimeUnit.MILLISECONDS;
18 + import static java.util.concurrent.TimeUnit.MINUTES;
19   import static java.util.concurrent.TimeUnit.NANOSECONDS;
20  
21   import java.io.ByteArrayInputStream;
# Line 15 | Line 24 | import java.io.ObjectInputStream;
24   import java.io.ObjectOutputStream;
25   import java.lang.management.ManagementFactory;
26   import java.lang.management.ThreadInfo;
27 + import java.lang.management.ThreadMXBean;
28 + import java.lang.reflect.Constructor;
29   import java.lang.reflect.Method;
30 + import java.lang.reflect.Modifier;
31 + import java.nio.file.Files;
32 + import java.nio.file.Paths;
33   import java.security.CodeSource;
34   import java.security.Permission;
35   import java.security.PermissionCollection;
# Line 27 | Line 41 | import java.util.ArrayList;
41   import java.util.Arrays;
42   import java.util.Date;
43   import java.util.Enumeration;
44 + import java.util.Iterator;
45   import java.util.List;
46   import java.util.NoSuchElementException;
47   import java.util.PropertyPermission;
# Line 34 | Line 49 | import java.util.concurrent.BlockingQueu
49   import java.util.concurrent.Callable;
50   import java.util.concurrent.CountDownLatch;
51   import java.util.concurrent.CyclicBarrier;
52 + import java.util.concurrent.ExecutionException;
53 + import java.util.concurrent.Executors;
54   import java.util.concurrent.ExecutorService;
55 + import java.util.concurrent.ForkJoinPool;
56   import java.util.concurrent.Future;
57   import java.util.concurrent.RecursiveAction;
58   import java.util.concurrent.RecursiveTask;
# Line 43 | Line 61 | import java.util.concurrent.Semaphore;
61   import java.util.concurrent.ThreadFactory;
62   import java.util.concurrent.ThreadPoolExecutor;
63   import java.util.concurrent.TimeoutException;
64 + import java.util.concurrent.atomic.AtomicBoolean;
65   import java.util.concurrent.atomic.AtomicReference;
66 + import java.util.regex.Matcher;
67   import java.util.regex.Pattern;
68  
69   import junit.framework.AssertionFailedError;
70   import junit.framework.Test;
71   import junit.framework.TestCase;
72 + import junit.framework.TestResult;
73   import junit.framework.TestSuite;
74  
75   /**
# Line 61 | Line 82 | import junit.framework.TestSuite;
82   *
83   * <ol>
84   *
85 < * <li> All assertions in code running in generated threads must use
85 > * <li>All assertions in code running in generated threads must use
86   * the forms {@link #threadFail}, {@link #threadAssertTrue}, {@link
87   * #threadAssertEquals}, or {@link #threadAssertNull}, (not
88   * {@code fail}, {@code assertTrue}, etc.) It is OK (but not
89   * particularly recommended) for other code to use these forms too.
90   * Only the most typically used JUnit assertion methods are defined
91 < * this way, but enough to live with.</li>
91 > * this way, but enough to live with.
92   *
93 < * <li> If you override {@link #setUp} or {@link #tearDown}, make sure
93 > * <li>If you override {@link #setUp} or {@link #tearDown}, make sure
94   * to invoke {@code super.setUp} and {@code super.tearDown} within
95   * them. These methods are used to clear and check for thread
96 < * assertion failures.</li>
96 > * assertion failures.
97   *
98   * <li>All delays and timeouts must use one of the constants {@code
99   * SHORT_DELAY_MS}, {@code SMALL_DELAY_MS}, {@code MEDIUM_DELAY_MS},
# Line 83 | Line 104 | import junit.framework.TestSuite;
104   * is always discriminable as larger than SHORT and smaller than
105   * MEDIUM.  And so on. These constants are set to conservative values,
106   * but even so, if there is ever any doubt, they can all be increased
107 < * in one spot to rerun tests on slower platforms.</li>
107 > * in one spot to rerun tests on slower platforms.
108   *
109 < * <li> All threads generated must be joined inside each test case
109 > * <li>All threads generated must be joined inside each test case
110   * method (or {@code fail} to do so) before returning from the
111   * method. The {@code joinPool} method can be used to do this when
112 < * using Executors.</li>
112 > * using Executors.
113   *
114   * </ol>
115   *
116   * <p><b>Other notes</b>
117   * <ul>
118   *
119 < * <li> Usually, there is one testcase method per JSR166 method
119 > * <li>Usually, there is one testcase method per JSR166 method
120   * covering "normal" operation, and then as many exception-testing
121   * methods as there are exceptions the method can throw. Sometimes
122   * there are multiple tests per JSR166 method when the different
123   * "normal" behaviors differ significantly. And sometimes testcases
124 < * cover multiple methods when they cannot be tested in
104 < * isolation.</li>
124 > * cover multiple methods when they cannot be tested in isolation.
125   *
126 < * <li> The documentation style for testcases is to provide as javadoc
126 > * <li>The documentation style for testcases is to provide as javadoc
127   * a simple sentence or two describing the property that the testcase
128   * method purports to test. The javadocs do not say anything about how
129 < * the property is tested. To find out, read the code.</li>
129 > * the property is tested. To find out, read the code.
130   *
131 < * <li> These tests are "conformance tests", and do not attempt to
131 > * <li>These tests are "conformance tests", and do not attempt to
132   * test throughput, latency, scalability or other performance factors
133   * (see the separate "jtreg" tests for a set intended to check these
134   * for the most central aspects of functionality.) So, most tests use
135   * the smallest sensible numbers of threads, collection sizes, etc
136 < * needed to check basic conformance.</li>
136 > * needed to check basic conformance.
137   *
138   * <li>The test classes currently do not declare inclusion in
139   * any particular package to simplify things for people integrating
140 < * them in TCK test suites.</li>
140 > * them in TCK test suites.
141   *
142 < * <li> As a convenience, the {@code main} of this class (JSR166TestCase)
143 < * runs all JSR166 unit tests.</li>
142 > * <li>As a convenience, the {@code main} of this class (JSR166TestCase)
143 > * runs all JSR166 unit tests.
144   *
145   * </ul>
146   */
# Line 159 | Line 179 | public class JSR166TestCase extends Test
179          Integer.getInteger("jsr166.runsPerTest", 1);
180  
181      /**
182 +     * The number of repetitions of the test suite (for finding leaks?).
183 +     */
184 +    private static final int suiteRuns =
185 +        Integer.getInteger("jsr166.suiteRuns", 1);
186 +
187 +    private static float systemPropertyValue(String name, float defaultValue) {
188 +        String floatString = System.getProperty(name);
189 +        if (floatString == null)
190 +            return defaultValue;
191 +        try {
192 +            return Float.parseFloat(floatString);
193 +        } catch (NumberFormatException ex) {
194 +            throw new IllegalArgumentException(
195 +                String.format("Bad float value in system property %s=%s",
196 +                              name, floatString));
197 +        }
198 +    }
199 +
200 +    /**
201 +     * The scaling factor to apply to standard delays used in tests.
202 +     */
203 +    private static final float delayFactor =
204 +        systemPropertyValue("jsr166.delay.factor", 1.0f);
205 +
206 +    /**
207 +     * The timeout factor as used in the jtreg test harness.
208 +     * See: http://openjdk.java.net/jtreg/tag-spec.html
209 +     */
210 +    private static final float jtregTestTimeoutFactor
211 +        = systemPropertyValue("test.timeout.factor", 1.0f);
212 +
213 +    public JSR166TestCase() { super(); }
214 +    public JSR166TestCase(String name) { super(name); }
215 +
216 +    /**
217       * A filter for tests to run, matching strings of the form
218       * methodName(className), e.g. "testInvokeAll5(ForkJoinPoolTest)"
219       * Usefully combined with jsr166.runsPerTest.
# Line 170 | Line 225 | public class JSR166TestCase extends Test
225          return (regex == null) ? null : Pattern.compile(regex);
226      }
227  
228 <    protected void runTest() throws Throwable {
228 >    // Instrumentation to debug very rare, but very annoying hung test runs.
229 >    static volatile TestCase currentTestCase;
230 >    // static volatile int currentRun = 0;
231 >    static {
232 >        Runnable checkForWedgedTest = new Runnable() { public void run() {
233 >            // Avoid spurious reports with enormous runsPerTest.
234 >            // A single test case run should never take more than 1 second.
235 >            // But let's cap it at the high end too ...
236 >            final int timeoutMinutes =
237 >                Math.min(15, Math.max(runsPerTest / 60, 1));
238 >            for (TestCase lastTestCase = currentTestCase;;) {
239 >                try { MINUTES.sleep(timeoutMinutes); }
240 >                catch (InterruptedException unexpected) { break; }
241 >                if (lastTestCase == currentTestCase) {
242 >                    System.err.printf(
243 >                        "Looks like we're stuck running test: %s%n",
244 >                        lastTestCase);
245 > //                     System.err.printf(
246 > //                         "Looks like we're stuck running test: %s (%d/%d)%n",
247 > //                         lastTestCase, currentRun, runsPerTest);
248 > //                     System.err.println("availableProcessors=" +
249 > //                         Runtime.getRuntime().availableProcessors());
250 > //                     System.err.printf("cpu model = %s%n", cpuModel());
251 >                    dumpTestThreads();
252 >                    // one stack dump is probably enough; more would be spam
253 >                    break;
254 >                }
255 >                lastTestCase = currentTestCase;
256 >            }}};
257 >        Thread thread = new Thread(checkForWedgedTest, "checkForWedgedTest");
258 >        thread.setDaemon(true);
259 >        thread.start();
260 >    }
261 >
262 > //     public static String cpuModel() {
263 > //         try {
264 > //             Matcher matcher = Pattern.compile("model name\\s*: (.*)")
265 > //                 .matcher(new String(
266 > //                      Files.readAllBytes(Paths.get("/proc/cpuinfo")), "UTF-8"));
267 > //             matcher.find();
268 > //             return matcher.group(1);
269 > //         } catch (Exception ex) { return null; }
270 > //     }
271 >
272 >    public void runBare() throws Throwable {
273 >        currentTestCase = this;
274          if (methodFilter == null
275 <            || methodFilter.matcher(toString()).find()) {
276 <            for (int i = 0; i < runsPerTest; i++) {
277 <                if (profileTests)
278 <                    runTestProfiled();
279 <                else
280 <                    super.runTest();
281 <            }
275 >            || methodFilter.matcher(toString()).find())
276 >            super.runBare();
277 >    }
278 >
279 >    protected void runTest() throws Throwable {
280 >        for (int i = 0; i < runsPerTest; i++) {
281 >            // currentRun = i;
282 >            if (profileTests)
283 >                runTestProfiled();
284 >            else
285 >                super.runTest();
286          }
287      }
288  
289      protected void runTestProfiled() throws Throwable {
290 <        // Warmup run, notably to trigger all needed classloading.
291 <        super.runTest();
188 <        long t0 = System.nanoTime();
189 <        try {
290 >        for (int i = 0; i < 2; i++) {
291 >            long startTime = System.nanoTime();
292              super.runTest();
293 <        } finally {
294 <            long elapsedMillis = millisElapsedSince(t0);
295 <            if (elapsedMillis >= profileThreshold)
293 >            long elapsedMillis = millisElapsedSince(startTime);
294 >            if (elapsedMillis < profileThreshold)
295 >                break;
296 >            // Never report first run of any test; treat it as a
297 >            // warmup run, notably to trigger all needed classloading,
298 >            if (i > 0)
299                  System.out.printf("%n%s: %d%n", toString(), elapsedMillis);
300          }
301      }
302  
303      /**
304       * 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.
305       */
306      public static void main(String[] args) {
307 +        main(suite(), args);
308 +    }
309 +
310 +    static class PithyResultPrinter extends junit.textui.ResultPrinter {
311 +        PithyResultPrinter(java.io.PrintStream writer) { super(writer); }
312 +        long runTime;
313 +        public void startTest(Test test) {}
314 +        protected void printHeader(long runTime) {
315 +            this.runTime = runTime; // defer printing for later
316 +        }
317 +        protected void printFooter(TestResult result) {
318 +            if (result.wasSuccessful()) {
319 +                getWriter().println("OK (" + result.runCount() + " tests)"
320 +                    + "  Time: " + elapsedTimeAsString(runTime));
321 +            } else {
322 +                getWriter().println("Time: " + elapsedTimeAsString(runTime));
323 +                super.printFooter(result);
324 +            }
325 +        }
326 +    }
327 +
328 +    /**
329 +     * Returns a TestRunner that doesn't bother with unnecessary
330 +     * fluff, like printing a "." for each test case.
331 +     */
332 +    static junit.textui.TestRunner newPithyTestRunner() {
333 +        junit.textui.TestRunner runner = new junit.textui.TestRunner();
334 +        runner.setPrinter(new PithyResultPrinter(System.out));
335 +        return runner;
336 +    }
337 +
338 +    /**
339 +     * Runs all unit tests in the given test suite.
340 +     * Actual behavior influenced by jsr166.* system properties.
341 +     */
342 +    static void main(Test suite, String[] args) {
343          if (useSecurityManager) {
344              System.err.println("Setting a permissive security manager");
345              Policy.setPolicy(permissivePolicy());
346              System.setSecurityManager(new SecurityManager());
347          }
348 <        int iters = (args.length == 0) ? 1 : Integer.parseInt(args[0]);
349 <
350 <        Test s = suite();
351 <        for (int i = 0; i < iters; ++i) {
213 <            junit.textui.TestRunner.run(s);
348 >        for (int i = 0; i < suiteRuns; i++) {
349 >            TestResult result = newPithyTestRunner().doRun(suite);
350 >            if (!result.wasSuccessful())
351 >                System.exit(1);
352              System.gc();
353              System.runFinalization();
354          }
217        System.exit(0);
355      }
356  
357      public static TestSuite newTestSuite(Object... suiteOrClasses) {
# Line 265 | Line 402 | public class JSR166TestCase extends Test
402      public static boolean atLeastJava7() { return JAVA_CLASS_VERSION >= 51.0; }
403      public static boolean atLeastJava8() { return JAVA_CLASS_VERSION >= 52.0; }
404      public static boolean atLeastJava9() {
405 <        // As of 2014-05, java9 still uses 52.0 class file version
406 <        return JAVA_SPECIFICATION_VERSION.startsWith("1.9");
405 >        return JAVA_CLASS_VERSION >= 53.0
406 >            // As of 2015-09, java9 still uses 52.0 class file version
407 >            || JAVA_SPECIFICATION_VERSION.matches("^(1\\.)?(9|[0-9][0-9])$");
408 >    }
409 >    public static boolean atLeastJava10() {
410 >        return JAVA_CLASS_VERSION >= 54.0
411 >            || JAVA_SPECIFICATION_VERSION.matches("^(1\\.)?[0-9][0-9]$");
412      }
413  
414      /**
# Line 355 | Line 497 | public class JSR166TestCase extends Test
497                  "LongAdderTest",
498                  "SplittableRandomTest",
499                  "StampedLockTest",
500 +                "SubmissionPublisherTest",
501                  "ThreadLocalRandom8Test",
502              };
503              addNamedTestClasses(suite, java8TestClassNames);
# Line 363 | Line 506 | public class JSR166TestCase extends Test
506          // Java9+ test classes
507          if (atLeastJava9()) {
508              String[] java9TestClassNames = {
509 <                "ThreadPoolExecutor9Test",
509 >                // Currently empty, but expecting varhandle tests
510              };
511              addNamedTestClasses(suite, java9TestClassNames);
512          }
# Line 371 | Line 514 | public class JSR166TestCase extends Test
514          return suite;
515      }
516  
517 +    /** Returns list of junit-style test method names in given class. */
518 +    public static ArrayList<String> testMethodNames(Class<?> testClass) {
519 +        Method[] methods = testClass.getDeclaredMethods();
520 +        ArrayList<String> names = new ArrayList<String>(methods.length);
521 +        for (Method method : methods) {
522 +            if (method.getName().startsWith("test")
523 +                && Modifier.isPublic(method.getModifiers())
524 +                // method.getParameterCount() requires jdk8+
525 +                && method.getParameterTypes().length == 0) {
526 +                names.add(method.getName());
527 +            }
528 +        }
529 +        return names;
530 +    }
531 +
532 +    /**
533 +     * Returns junit-style testSuite for the given test class, but
534 +     * parameterized by passing extra data to each test.
535 +     */
536 +    public static <ExtraData> Test parameterizedTestSuite
537 +        (Class<? extends JSR166TestCase> testClass,
538 +         Class<ExtraData> dataClass,
539 +         ExtraData data) {
540 +        try {
541 +            TestSuite suite = new TestSuite();
542 +            Constructor c =
543 +                testClass.getDeclaredConstructor(dataClass, String.class);
544 +            for (String methodName : testMethodNames(testClass))
545 +                suite.addTest((Test) c.newInstance(data, methodName));
546 +            return suite;
547 +        } catch (Exception e) {
548 +            throw new Error(e);
549 +        }
550 +    }
551 +
552 +    /**
553 +     * Returns junit-style testSuite for the jdk8 extension of the
554 +     * given test class, but parameterized by passing extra data to
555 +     * each test.  Uses reflection to allow compilation in jdk7.
556 +     */
557 +    public static <ExtraData> Test jdk8ParameterizedTestSuite
558 +        (Class<? extends JSR166TestCase> testClass,
559 +         Class<ExtraData> dataClass,
560 +         ExtraData data) {
561 +        if (atLeastJava8()) {
562 +            String name = testClass.getName();
563 +            String name8 = name.replaceAll("Test$", "8Test");
564 +            if (name.equals(name8)) throw new Error(name);
565 +            try {
566 +                return (Test)
567 +                    Class.forName(name8)
568 +                    .getMethod("testSuite", new Class[] { dataClass })
569 +                    .invoke(null, data);
570 +            } catch (Exception e) {
571 +                throw new Error(e);
572 +            }
573 +        } else {
574 +            return new TestSuite();
575 +        }
576 +    }
577 +
578      // Delays for timing-dependent tests, in milliseconds.
579  
580      public static long SHORT_DELAY_MS;
# Line 379 | Line 583 | public class JSR166TestCase extends Test
583      public static long LONG_DELAY_MS;
584  
585      /**
586 <     * Returns the shortest timed delay. This could
587 <     * be reimplemented to use for example a Property.
586 >     * Returns the shortest timed delay. This can be scaled up for
587 >     * slow machines using the jsr166.delay.factor system property,
588 >     * or via jtreg's -timeoutFactor: flag.
589 >     * http://openjdk.java.net/jtreg/command-help.html
590       */
591      protected long getShortDelay() {
592 <        return 50;
592 >        return (long) (50 * delayFactor * jtregTestTimeoutFactor);
593      }
594  
595      /**
# Line 405 | Line 611 | public class JSR166TestCase extends Test
611      }
612  
613      /**
614 <     * Returns a new Date instance representing a time delayMillis
615 <     * milliseconds in the future.
614 >     * Returns a new Date instance representing a time at least
615 >     * delayMillis milliseconds in the future.
616       */
617      Date delayedDate(long delayMillis) {
618 <        return new Date(System.currentTimeMillis() + delayMillis);
618 >        // Add 1 because currentTimeMillis is known to round into the past.
619 >        return new Date(System.currentTimeMillis() + delayMillis + 1);
620      }
621  
622      /**
# Line 425 | Line 632 | public class JSR166TestCase extends Test
632       * the same test have no effect.
633       */
634      public void threadRecordFailure(Throwable t) {
635 +        System.err.println(t);
636 +        dumpTestThreads();
637          threadFailure.compareAndSet(null, t);
638      }
639  
# Line 432 | Line 641 | public class JSR166TestCase extends Test
641          setDelays();
642      }
643  
644 +    void tearDownFail(String format, Object... args) {
645 +        String msg = toString() + ": " + String.format(format, args);
646 +        System.err.println(msg);
647 +        dumpTestThreads();
648 +        throw new AssertionFailedError(msg);
649 +    }
650 +
651      /**
652       * Extra checks that get done for all test cases.
653       *
# Line 459 | Line 675 | public class JSR166TestCase extends Test
675          }
676  
677          if (Thread.interrupted())
678 <            throw new AssertionFailedError("interrupt status set in main thread");
678 >            tearDownFail("interrupt status set in main thread");
679  
680          checkForkJoinPoolThreadLeaks();
681      }
682  
683      /**
684 <     * Finds missing try { ... } finally { joinPool(e); }
684 >     * Finds missing PoolCleaners
685       */
686      void checkForkJoinPoolThreadLeaks() throws InterruptedException {
687 <        Thread[] survivors = new Thread[5];
687 >        Thread[] survivors = new Thread[7];
688          int count = Thread.enumerate(survivors);
689          for (int i = 0; i < count; i++) {
690              Thread thread = survivors[i];
# Line 476 | Line 692 | public class JSR166TestCase extends Test
692              if (name.startsWith("ForkJoinPool-")) {
693                  // give thread some time to terminate
694                  thread.join(LONG_DELAY_MS);
695 <                if (!thread.isAlive()) continue;
696 <                thread.stop();
697 <                throw new AssertionFailedError
482 <                    (String.format("Found leaked ForkJoinPool thread test=%s thread=%s%n",
483 <                                   toString(), name));
695 >                if (thread.isAlive())
696 >                    tearDownFail("Found leaked ForkJoinPool thread thread=%s",
697 >                                 thread);
698              }
699          }
700 +
701 +        if (!ForkJoinPool.commonPool()
702 +            .awaitQuiescence(LONG_DELAY_MS, MILLISECONDS))
703 +            tearDownFail("ForkJoin common pool thread stuck");
704      }
705  
706      /**
# Line 495 | Line 713 | public class JSR166TestCase extends Test
713              fail(reason);
714          } catch (AssertionFailedError t) {
715              threadRecordFailure(t);
716 <            fail(reason);
716 >            throw t;
717          }
718      }
719  
# Line 563 | Line 781 | public class JSR166TestCase extends Test
781      public void threadAssertEquals(Object x, Object y) {
782          try {
783              assertEquals(x, y);
784 <        } catch (AssertionFailedError t) {
785 <            threadRecordFailure(t);
786 <            throw t;
787 <        } catch (Throwable t) {
788 <            threadUnexpectedException(t);
784 >        } catch (AssertionFailedError fail) {
785 >            threadRecordFailure(fail);
786 >            throw fail;
787 >        } catch (Throwable fail) {
788 >            threadUnexpectedException(fail);
789          }
790      }
791  
# Line 579 | Line 797 | public class JSR166TestCase extends Test
797      public void threadAssertSame(Object x, Object y) {
798          try {
799              assertSame(x, y);
800 <        } catch (AssertionFailedError t) {
801 <            threadRecordFailure(t);
802 <            throw t;
800 >        } catch (AssertionFailedError fail) {
801 >            threadRecordFailure(fail);
802 >            throw fail;
803          }
804      }
805  
# Line 622 | Line 840 | public class JSR166TestCase extends Test
840      /**
841       * Delays, via Thread.sleep, for the given millisecond delay, but
842       * if the sleep is shorter than specified, may re-sleep or yield
843 <     * until time elapses.
843 >     * until time elapses.  Ensures that the given time, as measured
844 >     * by System.nanoTime(), has elapsed.
845       */
846      static void delay(long millis) throws InterruptedException {
847 <        long startTime = System.nanoTime();
848 <        long ns = millis * 1000 * 1000;
849 <        for (;;) {
847 >        long nanos = millis * (1000 * 1000);
848 >        final long wakeupTime = System.nanoTime() + nanos;
849 >        do {
850              if (millis > 0L)
851                  Thread.sleep(millis);
852              else // too short to sleep
853                  Thread.yield();
854 <            long d = ns - (System.nanoTime() - startTime);
855 <            if (d > 0L)
856 <                millis = d / (1000 * 1000);
857 <            else
858 <                break;
854 >            nanos = wakeupTime - System.nanoTime();
855 >            millis = nanos / (1000 * 1000);
856 >        } while (nanos >= 0L);
857 >    }
858 >
859 >    /**
860 >     * Allows use of try-with-resources with per-test thread pools.
861 >     */
862 >    class PoolCleaner implements AutoCloseable {
863 >        private final ExecutorService pool;
864 >        public PoolCleaner(ExecutorService pool) { this.pool = pool; }
865 >        public void close() { joinPool(pool); }
866 >    }
867 >
868 >    /**
869 >     * An extension of PoolCleaner that has an action to release the pool.
870 >     */
871 >    class PoolCleanerWithReleaser extends PoolCleaner {
872 >        private final Runnable releaser;
873 >        public PoolCleanerWithReleaser(ExecutorService pool, Runnable releaser) {
874 >            super(pool);
875 >            this.releaser = releaser;
876          }
877 +        public void close() {
878 +            try {
879 +                releaser.run();
880 +            } finally {
881 +                super.close();
882 +            }
883 +        }
884 +    }
885 +
886 +    PoolCleaner cleaner(ExecutorService pool) {
887 +        return new PoolCleaner(pool);
888 +    }
889 +
890 +    PoolCleaner cleaner(ExecutorService pool, Runnable releaser) {
891 +        return new PoolCleanerWithReleaser(pool, releaser);
892 +    }
893 +
894 +    PoolCleaner cleaner(ExecutorService pool, CountDownLatch latch) {
895 +        return new PoolCleanerWithReleaser(pool, releaser(latch));
896 +    }
897 +
898 +    Runnable releaser(final CountDownLatch latch) {
899 +        return new Runnable() { public void run() {
900 +            do { latch.countDown(); }
901 +            while (latch.getCount() > 0);
902 +        }};
903 +    }
904 +
905 +    PoolCleaner cleaner(ExecutorService pool, AtomicBoolean flag) {
906 +        return new PoolCleanerWithReleaser(pool, releaser(flag));
907 +    }
908 +
909 +    Runnable releaser(final AtomicBoolean flag) {
910 +        return new Runnable() { public void run() { flag.set(true); }};
911      }
912  
913      /**
914       * Waits out termination of a thread pool or fails doing so.
915       */
916 <    void joinPool(ExecutorService exec) {
916 >    void joinPool(ExecutorService pool) {
917          try {
918 <            exec.shutdown();
919 <            if (!exec.awaitTermination(2 * LONG_DELAY_MS, MILLISECONDS))
920 <                fail("ExecutorService " + exec +
921 <                     " did not terminate in a timely manner");
918 >            pool.shutdown();
919 >            if (!pool.awaitTermination(2 * LONG_DELAY_MS, MILLISECONDS)) {
920 >                try {
921 >                    threadFail("ExecutorService " + pool +
922 >                               " did not terminate in a timely manner");
923 >                } finally {
924 >                    // last resort, for the benefit of subsequent tests
925 >                    pool.shutdownNow();
926 >                    pool.awaitTermination(MEDIUM_DELAY_MS, MILLISECONDS);
927 >                }
928 >            }
929          } catch (SecurityException ok) {
930              // Allowed in case test doesn't have privs
931 <        } catch (InterruptedException ie) {
932 <            fail("Unexpected InterruptedException");
931 >        } catch (InterruptedException fail) {
932 >            threadFail("Unexpected InterruptedException");
933 >        }
934 >    }
935 >
936 >    /** Like Runnable, but with the freedom to throw anything */
937 >    interface Action { public void run() throws Throwable; }
938 >
939 >    /**
940 >     * Runs all the given actions in parallel, failing if any fail.
941 >     * Useful for running multiple variants of tests that are
942 >     * necessarily individually slow because they must block.
943 >     */
944 >    void testInParallel(Action ... actions) {
945 >        ExecutorService pool = Executors.newCachedThreadPool();
946 >        try (PoolCleaner cleaner = cleaner(pool)) {
947 >            ArrayList<Future<?>> futures = new ArrayList<>(actions.length);
948 >            for (final Action action : actions)
949 >                futures.add(pool.submit(new CheckedRunnable() {
950 >                    public void realRun() throws Throwable { action.run();}}));
951 >            for (Future<?> future : futures)
952 >                try {
953 >                    assertNull(future.get(LONG_DELAY_MS, MILLISECONDS));
954 >                } catch (ExecutionException ex) {
955 >                    threadUnexpectedException(ex.getCause());
956 >                } catch (Exception ex) {
957 >                    threadUnexpectedException(ex);
958 >                }
959          }
960      }
961  
962      /**
963 <     * A debugging tool to print all stack traces, as jstack does.
963 >     * A debugging tool to print stack traces of most threads, as jstack does.
964 >     * Uninteresting threads are filtered out.
965       */
966 <    static void printAllStackTraces() {
967 <        for (ThreadInfo info :
968 <                 ManagementFactory.getThreadMXBean()
969 <                 .dumpAllThreads(true, true))
966 >    static void dumpTestThreads() {
967 >        ThreadMXBean threadMXBean = ManagementFactory.getThreadMXBean();
968 >        System.err.println("------ stacktrace dump start ------");
969 >        for (ThreadInfo info : threadMXBean.dumpAllThreads(true, true)) {
970 >            String name = info.getThreadName();
971 >            if ("Signal Dispatcher".equals(name))
972 >                continue;
973 >            if ("Reference Handler".equals(name)
974 >                && info.getLockName().startsWith("java.lang.ref.Reference$Lock"))
975 >                continue;
976 >            if ("Finalizer".equals(name)
977 >                && info.getLockName().startsWith("java.lang.ref.ReferenceQueue$Lock"))
978 >                continue;
979 >            if ("checkForWedgedTest".equals(name))
980 >                continue;
981              System.err.print(info);
982 +        }
983 +        System.err.println("------ stacktrace dump end ------");
984      }
985  
986      /**
# Line 682 | Line 999 | public class JSR166TestCase extends Test
999              // No need to optimize the failing case via Thread.join.
1000              delay(millis);
1001              assertTrue(thread.isAlive());
1002 <        } catch (InterruptedException ie) {
1003 <            fail("Unexpected InterruptedException");
1002 >        } catch (InterruptedException fail) {
1003 >            threadFail("Unexpected InterruptedException");
1004          }
1005      }
1006  
# Line 704 | Line 1021 | public class JSR166TestCase extends Test
1021              delay(millis);
1022              for (Thread thread : threads)
1023                  assertTrue(thread.isAlive());
1024 <        } catch (InterruptedException ie) {
1025 <            fail("Unexpected InterruptedException");
1024 >        } catch (InterruptedException fail) {
1025 >            threadFail("Unexpected InterruptedException");
1026          }
1027      }
1028  
# Line 726 | Line 1043 | public class JSR166TestCase extends Test
1043              future.get(timeoutMillis, MILLISECONDS);
1044              shouldThrow();
1045          } catch (TimeoutException success) {
1046 <        } catch (Exception e) {
1047 <            threadUnexpectedException(e);
1046 >        } catch (Exception fail) {
1047 >            threadUnexpectedException(fail);
1048          } finally { future.cancel(true); }
1049          assertTrue(millisElapsedSince(startTime) >= timeoutMillis);
1050      }
# Line 883 | Line 1200 | public class JSR166TestCase extends Test
1200      void sleep(long millis) {
1201          try {
1202              delay(millis);
1203 <        } catch (InterruptedException ie) {
1203 >        } catch (InterruptedException fail) {
1204              AssertionFailedError afe =
1205                  new AssertionFailedError("Unexpected InterruptedException");
1206 <            afe.initCause(ie);
1206 >            afe.initCause(fail);
1207              throw afe;
1208          }
1209      }
# Line 978 | Line 1295 | public class JSR166TestCase extends Test
1295      void awaitTermination(Thread t, long timeoutMillis) {
1296          try {
1297              t.join(timeoutMillis);
1298 <        } catch (InterruptedException ie) {
1299 <            threadUnexpectedException(ie);
1298 >        } catch (InterruptedException fail) {
1299 >            threadUnexpectedException(fail);
1300          } finally {
1301              if (t.getState() != Thread.State.TERMINATED) {
1302                  t.interrupt();
1303 <                fail("Test timed out");
1303 >                threadFail("timed out waiting for thread to terminate");
1304              }
1305          }
1306      }
# Line 1005 | Line 1322 | public class JSR166TestCase extends Test
1322          public final void run() {
1323              try {
1324                  realRun();
1325 <            } catch (Throwable t) {
1326 <                threadUnexpectedException(t);
1325 >            } catch (Throwable fail) {
1326 >                threadUnexpectedException(fail);
1327              }
1328          }
1329      }
# Line 1060 | Line 1377 | public class JSR166TestCase extends Test
1377                  threadShouldThrow("InterruptedException");
1378              } catch (InterruptedException success) {
1379                  threadAssertFalse(Thread.interrupted());
1380 <            } catch (Throwable t) {
1381 <                threadUnexpectedException(t);
1380 >            } catch (Throwable fail) {
1381 >                threadUnexpectedException(fail);
1382              }
1383          }
1384      }
# Line 1072 | Line 1389 | public class JSR166TestCase extends Test
1389          public final T call() {
1390              try {
1391                  return realCall();
1392 <            } catch (Throwable t) {
1393 <                threadUnexpectedException(t);
1392 >            } catch (Throwable fail) {
1393 >                threadUnexpectedException(fail);
1394                  return null;
1395              }
1396          }
# Line 1090 | Line 1407 | public class JSR166TestCase extends Test
1407                  return result;
1408              } catch (InterruptedException success) {
1409                  threadAssertFalse(Thread.interrupted());
1410 <            } catch (Throwable t) {
1411 <                threadUnexpectedException(t);
1410 >            } catch (Throwable fail) {
1411 >                threadUnexpectedException(fail);
1412              }
1413              return null;
1414          }
# Line 1108 | Line 1425 | public class JSR166TestCase extends Test
1425      public static final String TEST_STRING = "a test string";
1426  
1427      public static class StringTask implements Callable<String> {
1428 <        public String call() { return TEST_STRING; }
1428 >        final String value;
1429 >        public StringTask() { this(TEST_STRING); }
1430 >        public StringTask(String value) { this.value = value; }
1431 >        public String call() { return value; }
1432      }
1433  
1434      public Callable<String> latchAwaitingStringTask(final CountDownLatch latch) {
# Line 1121 | Line 1441 | public class JSR166TestCase extends Test
1441              }};
1442      }
1443  
1444 <    public Runnable awaiter(final CountDownLatch latch) {
1444 >    public Runnable countDowner(final CountDownLatch latch) {
1445          return new CheckedRunnable() {
1446              public void realRun() throws InterruptedException {
1447 <                await(latch);
1447 >                latch.countDown();
1448              }};
1449      }
1450  
1451 <    public void await(CountDownLatch latch) {
1452 <        try {
1453 <            assertTrue(latch.await(LONG_DELAY_MS, MILLISECONDS));
1454 <        } catch (Throwable t) {
1455 <            threadUnexpectedException(t);
1451 >    class LatchAwaiter extends CheckedRunnable {
1452 >        static final int NEW = 0;
1453 >        static final int RUNNING = 1;
1454 >        static final int DONE = 2;
1455 >        final CountDownLatch latch;
1456 >        int state = NEW;
1457 >        LatchAwaiter(CountDownLatch latch) { this.latch = latch; }
1458 >        public void realRun() throws InterruptedException {
1459 >            state = 1;
1460 >            await(latch);
1461 >            state = 2;
1462          }
1463      }
1464  
1465 +    public LatchAwaiter awaiter(CountDownLatch latch) {
1466 +        return new LatchAwaiter(latch);
1467 +    }
1468 +
1469 +    public void await(CountDownLatch latch, long timeoutMillis) {
1470 +        try {
1471 +            if (!latch.await(timeoutMillis, MILLISECONDS))
1472 +                fail("timed out waiting for CountDownLatch for "
1473 +                     + (timeoutMillis/1000) + " sec");
1474 +        } catch (Throwable fail) {
1475 +            threadUnexpectedException(fail);
1476 +        }
1477 +    }
1478 +
1479 +    public void await(CountDownLatch latch) {
1480 +        await(latch, LONG_DELAY_MS);
1481 +    }
1482 +
1483      public void await(Semaphore semaphore) {
1484          try {
1485 <            assertTrue(semaphore.tryAcquire(LONG_DELAY_MS, MILLISECONDS));
1486 <        } catch (Throwable t) {
1487 <            threadUnexpectedException(t);
1485 >            if (!semaphore.tryAcquire(LONG_DELAY_MS, MILLISECONDS))
1486 >                fail("timed out waiting for Semaphore for "
1487 >                     + (LONG_DELAY_MS/1000) + " sec");
1488 >        } catch (Throwable fail) {
1489 >            threadUnexpectedException(fail);
1490          }
1491      }
1492  
# Line 1334 | Line 1680 | public class JSR166TestCase extends Test
1680          @Override protected final void compute() {
1681              try {
1682                  realCompute();
1683 <            } catch (Throwable t) {
1684 <                threadUnexpectedException(t);
1683 >            } catch (Throwable fail) {
1684 >                threadUnexpectedException(fail);
1685              }
1686          }
1687      }
# Line 1349 | Line 1695 | public class JSR166TestCase extends Test
1695          @Override protected final T compute() {
1696              try {
1697                  return realCompute();
1698 <            } catch (Throwable t) {
1699 <                threadUnexpectedException(t);
1698 >            } catch (Throwable fail) {
1699 >                threadUnexpectedException(fail);
1700                  return null;
1701              }
1702          }
# Line 1374 | Line 1720 | public class JSR166TestCase extends Test
1720          public int await() {
1721              try {
1722                  return super.await(2 * LONG_DELAY_MS, MILLISECONDS);
1723 <            } catch (TimeoutException e) {
1723 >            } catch (TimeoutException timedOut) {
1724                  throw new AssertionFailedError("timed out");
1725 <            } catch (Exception e) {
1725 >            } catch (Exception fail) {
1726                  AssertionFailedError afe =
1727 <                    new AssertionFailedError("Unexpected exception: " + e);
1728 <                afe.initCause(e);
1727 >                    new AssertionFailedError("Unexpected exception: " + fail);
1728 >                afe.initCause(fail);
1729                  throw afe;
1730              }
1731          }
# Line 1407 | Line 1753 | public class JSR166TestCase extends Test
1753                  q.remove();
1754                  shouldThrow();
1755              } catch (NoSuchElementException success) {}
1756 <        } catch (InterruptedException ie) {
1411 <            threadUnexpectedException(ie);
1412 <        }
1756 >        } catch (InterruptedException fail) { threadUnexpectedException(fail); }
1757      }
1758  
1759      void assertSerialEquals(Object x, Object y) {
# Line 1428 | Line 1772 | public class JSR166TestCase extends Test
1772              oos.flush();
1773              oos.close();
1774              return bos.toByteArray();
1775 <        } catch (Throwable t) {
1776 <            threadUnexpectedException(t);
1775 >        } catch (Throwable fail) {
1776 >            threadUnexpectedException(fail);
1777              return new byte[0];
1778          }
1779      }
# Line 1442 | Line 1786 | public class JSR166TestCase extends Test
1786              T clone = (T) ois.readObject();
1787              assertSame(o.getClass(), clone.getClass());
1788              return clone;
1789 <        } catch (Throwable t) {
1790 <            threadUnexpectedException(t);
1789 >        } catch (Throwable fail) {
1790 >            threadUnexpectedException(fail);
1791              return null;
1792          }
1793      }
# Line 1468 | Line 1812 | public class JSR166TestCase extends Test
1812                  shouldThrow(expectedExceptionClass.getName());
1813          }
1814      }
1815 +
1816 +    public void assertIteratorExhausted(Iterator<?> it) {
1817 +        try {
1818 +            it.next();
1819 +            shouldThrow();
1820 +        } catch (NoSuchElementException success) {}
1821 +        assertFalse(it.hasNext());
1822 +    }
1823   }

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines