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.91 by jsr166, Thu Dec 8 18:54:46 2011 UTC vs.
Revision 1.170 by jsr166, Thu Oct 8 22:39:57 2015 UTC

# Line 6 | Line 6
6   * Pat Fisher, Mike Judd.
7   */
8  
9 < import junit.framework.*;
9 > import static java.util.concurrent.TimeUnit.MILLISECONDS;
10 > import static java.util.concurrent.TimeUnit.MINUTES;
11 > import static java.util.concurrent.TimeUnit.NANOSECONDS;
12 >
13   import java.io.ByteArrayInputStream;
14   import java.io.ByteArrayOutputStream;
15   import java.io.ObjectInputStream;
16   import java.io.ObjectOutputStream;
17 < import java.util.Arrays;
18 < import java.util.Date;
19 < import java.util.NoSuchElementException;
20 < import java.util.PropertyPermission;
21 < import java.util.concurrent.*;
22 < import java.util.concurrent.atomic.AtomicBoolean;
20 < import java.util.concurrent.atomic.AtomicReference;
21 < import static java.util.concurrent.TimeUnit.MILLISECONDS;
22 < import static java.util.concurrent.TimeUnit.NANOSECONDS;
17 > import java.lang.management.ManagementFactory;
18 > import java.lang.management.ThreadInfo;
19 > import java.lang.management.ThreadMXBean;
20 > import java.lang.reflect.Constructor;
21 > import java.lang.reflect.Method;
22 > import java.lang.reflect.Modifier;
23   import java.security.CodeSource;
24   import java.security.Permission;
25   import java.security.PermissionCollection;
# Line 27 | Line 27 | import java.security.Permissions;
27   import java.security.Policy;
28   import java.security.ProtectionDomain;
29   import java.security.SecurityPermission;
30 + import java.util.ArrayList;
31 + import java.util.Arrays;
32 + import java.util.Date;
33 + import java.util.Enumeration;
34 + import java.util.Iterator;
35 + import java.util.List;
36 + import java.util.NoSuchElementException;
37 + import java.util.PropertyPermission;
38 + import java.util.concurrent.BlockingQueue;
39 + import java.util.concurrent.Callable;
40 + import java.util.concurrent.CountDownLatch;
41 + import java.util.concurrent.CyclicBarrier;
42 + import java.util.concurrent.ExecutionException;
43 + import java.util.concurrent.Executors;
44 + import java.util.concurrent.ExecutorService;
45 + import java.util.concurrent.ForkJoinPool;
46 + import java.util.concurrent.Future;
47 + import java.util.concurrent.RecursiveAction;
48 + import java.util.concurrent.RecursiveTask;
49 + import java.util.concurrent.RejectedExecutionHandler;
50 + import java.util.concurrent.Semaphore;
51 + import java.util.concurrent.ThreadFactory;
52 + import java.util.concurrent.ThreadPoolExecutor;
53 + import java.util.concurrent.TimeoutException;
54 + import java.util.concurrent.atomic.AtomicReference;
55 + import java.util.regex.Pattern;
56 +
57 + import junit.framework.AssertionFailedError;
58 + import junit.framework.Test;
59 + import junit.framework.TestCase;
60 + import junit.framework.TestResult;
61 + import junit.framework.TestSuite;
62  
63   /**
64   * Base class for JSR166 Junit TCK tests.  Defines some constants,
# Line 38 | Line 70 | import java.security.SecurityPermission;
70   *
71   * <ol>
72   *
73 < * <li> All assertions in code running in generated threads must use
73 > * <li>All assertions in code running in generated threads must use
74   * the forms {@link #threadFail}, {@link #threadAssertTrue}, {@link
75   * #threadAssertEquals}, or {@link #threadAssertNull}, (not
76   * {@code fail}, {@code assertTrue}, etc.) It is OK (but not
77   * particularly recommended) for other code to use these forms too.
78   * Only the most typically used JUnit assertion methods are defined
79 < * this way, but enough to live with.</li>
79 > * this way, but enough to live with.
80   *
81 < * <li> If you override {@link #setUp} or {@link #tearDown}, make sure
81 > * <li>If you override {@link #setUp} or {@link #tearDown}, make sure
82   * to invoke {@code super.setUp} and {@code super.tearDown} within
83   * them. These methods are used to clear and check for thread
84 < * assertion failures.</li>
84 > * assertion failures.
85   *
86   * <li>All delays and timeouts must use one of the constants {@code
87   * SHORT_DELAY_MS}, {@code SMALL_DELAY_MS}, {@code MEDIUM_DELAY_MS},
# Line 60 | Line 92 | import java.security.SecurityPermission;
92   * is always discriminable as larger than SHORT and smaller than
93   * MEDIUM.  And so on. These constants are set to conservative values,
94   * but even so, if there is ever any doubt, they can all be increased
95 < * in one spot to rerun tests on slower platforms.</li>
95 > * in one spot to rerun tests on slower platforms.
96   *
97 < * <li> All threads generated must be joined inside each test case
97 > * <li>All threads generated must be joined inside each test case
98   * method (or {@code fail} to do so) before returning from the
99   * method. The {@code joinPool} method can be used to do this when
100 < * using Executors.</li>
100 > * using Executors.
101   *
102   * </ol>
103   *
104 < * <p> <b>Other notes</b>
104 > * <p><b>Other notes</b>
105   * <ul>
106   *
107 < * <li> Usually, there is one testcase method per JSR166 method
107 > * <li>Usually, there is one testcase method per JSR166 method
108   * covering "normal" operation, and then as many exception-testing
109   * methods as there are exceptions the method can throw. Sometimes
110   * there are multiple tests per JSR166 method when the different
111   * "normal" behaviors differ significantly. And sometimes testcases
112   * cover multiple methods when they cannot be tested in
113 < * isolation.</li>
113 > * isolation.
114   *
115 < * <li> The documentation style for testcases is to provide as javadoc
115 > * <li>The documentation style for testcases is to provide as javadoc
116   * a simple sentence or two describing the property that the testcase
117   * method purports to test. The javadocs do not say anything about how
118 < * the property is tested. To find out, read the code.</li>
118 > * the property is tested. To find out, read the code.
119   *
120 < * <li> These tests are "conformance tests", and do not attempt to
120 > * <li>These tests are "conformance tests", and do not attempt to
121   * test throughput, latency, scalability or other performance factors
122   * (see the separate "jtreg" tests for a set intended to check these
123   * for the most central aspects of functionality.) So, most tests use
124   * the smallest sensible numbers of threads, collection sizes, etc
125 < * needed to check basic conformance.</li>
125 > * needed to check basic conformance.
126   *
127   * <li>The test classes currently do not declare inclusion in
128   * any particular package to simplify things for people integrating
129 < * them in TCK test suites.</li>
129 > * them in TCK test suites.
130   *
131 < * <li> As a convenience, the {@code main} of this class (JSR166TestCase)
132 < * runs all JSR166 unit tests.</li>
131 > * <li>As a convenience, the {@code main} of this class (JSR166TestCase)
132 > * runs all JSR166 unit tests.
133   *
134   * </ul>
135   */
# Line 109 | Line 141 | public class JSR166TestCase extends Test
141          Boolean.getBoolean("jsr166.expensiveTests");
142  
143      /**
144 +     * If true, also run tests that are not part of the official tck
145 +     * because they test unspecified implementation details.
146 +     */
147 +    protected static final boolean testImplementationDetails =
148 +        Boolean.getBoolean("jsr166.testImplementationDetails");
149 +
150 +    /**
151       * If true, report on stdout all "slow" tests, that is, ones that
152       * take more than profileThreshold milliseconds to execute.
153       */
# Line 122 | Line 161 | public class JSR166TestCase extends Test
161      private static final long profileThreshold =
162          Long.getLong("jsr166.profileThreshold", 100);
163  
164 +    /**
165 +     * The number of repetitions per test (for tickling rare bugs).
166 +     */
167 +    private static final int runsPerTest =
168 +        Integer.getInteger("jsr166.runsPerTest", 1);
169 +
170 +    /**
171 +     * The number of repetitions of the test suite (for finding leaks?).
172 +     */
173 +    private static final int suiteRuns =
174 +        Integer.getInteger("jsr166.suiteRuns", 1);
175 +
176 +    public JSR166TestCase() { super(); }
177 +    public JSR166TestCase(String name) { super(name); }
178 +
179 +    /**
180 +     * A filter for tests to run, matching strings of the form
181 +     * methodName(className), e.g. "testInvokeAll5(ForkJoinPoolTest)"
182 +     * Usefully combined with jsr166.runsPerTest.
183 +     */
184 +    private static final Pattern methodFilter = methodFilter();
185 +
186 +    private static Pattern methodFilter() {
187 +        String regex = System.getProperty("jsr166.methodFilter");
188 +        return (regex == null) ? null : Pattern.compile(regex);
189 +    }
190 +
191 +    // Instrumentation to debug very rare, but very annoying hung test runs.
192 +    static volatile TestCase currentTestCase;
193 +    static volatile int currentRun = 0;
194 +    static {
195 +        Runnable checkForWedgedTest = new Runnable() { public void run() {
196 +            // avoid spurious reports with enormous runsPerTest
197 +            final int timeoutMinutes = Math.max(runsPerTest / 10, 1);
198 +            for (TestCase lastTestCase = currentTestCase;;) {
199 +                try { MINUTES.sleep(timeoutMinutes); }
200 +                catch (InterruptedException unexpected) { break; }
201 +                if (lastTestCase == currentTestCase) {
202 +                    System.err.printf(
203 +                        "Looks like we're stuck running test: %s (%d/%d)%n",
204 +                        lastTestCase, currentRun, runsPerTest);
205 +                    System.err.println
206 +                        ("Looks like we're stuck running test: "
207 +                         + lastTestCase + " (" + currentRun + "/" + runsPerTest + ")");
208 +                    System.err.println("availableProcessors=" +
209 +                        Runtime.getRuntime().availableProcessors());
210 +                    dumpTestThreads();
211 +                    // one stack dump is probably enough; more would be spam
212 +                    break;
213 +                }
214 +                lastTestCase = currentTestCase;
215 +            }}};
216 +        Thread thread = new Thread(checkForWedgedTest, "checkForWedgedTest");
217 +        thread.setDaemon(true);
218 +        thread.start();
219 +    }
220 +
221 +    public void runBare() throws Throwable {
222 +        currentTestCase = this;
223 +        if (methodFilter == null
224 +            || methodFilter.matcher(toString()).find())
225 +            super.runBare();
226 +    }
227 +
228      protected void runTest() throws Throwable {
229 <        if (profileTests)
230 <            runTestProfiled();
231 <        else
232 <            super.runTest();
229 >        for (int i = 0; i < runsPerTest; i++) {
230 >            currentRun = i;
231 >            if (profileTests)
232 >                runTestProfiled();
233 >            else
234 >                super.runTest();
235 >        }
236      }
237  
238      protected void runTestProfiled() throws Throwable {
239 <        long t0 = System.nanoTime();
240 <        try {
239 >        for (int i = 0; i < 2; i++) {
240 >            long startTime = System.nanoTime();
241              super.runTest();
242 <        } finally {
243 <            long elapsedMillis =
244 <                (System.nanoTime() - t0) / (1000L * 1000L);
245 <            if (elapsedMillis >= profileThreshold)
242 >            long elapsedMillis = millisElapsedSince(startTime);
243 >            if (elapsedMillis < profileThreshold)
244 >                break;
245 >            // Never report first run of any test; treat it as a
246 >            // warmup run, notably to trigger all needed classloading,
247 >            if (i > 0)
248                  System.out.printf("%n%s: %d%n", toString(), elapsedMillis);
249          }
250      }
251  
252      /**
253 <     * Runs all JSR166 unit tests using junit.textui.TestRunner
253 >     * Runs all JSR166 unit tests using junit.textui.TestRunner.
254       */
255      public static void main(String[] args) {
256 +        main(suite(), args);
257 +    }
258 +
259 +    /**
260 +     * Runs all unit tests in the given test suite.
261 +     * Actual behavior influenced by jsr166.* system properties.
262 +     */
263 +    static void main(Test suite, String[] args) {
264          if (useSecurityManager) {
265              System.err.println("Setting a permissive security manager");
266              Policy.setPolicy(permissivePolicy());
267              System.setSecurityManager(new SecurityManager());
268          }
269 <        int iters = (args.length == 0) ? 1 : Integer.parseInt(args[0]);
270 <
271 <        Test s = suite();
272 <        for (int i = 0; i < iters; ++i) {
157 <            junit.textui.TestRunner.run(s);
269 >        for (int i = 0; i < suiteRuns; i++) {
270 >            TestResult result = junit.textui.TestRunner.run(suite);
271 >            if (!result.wasSuccessful())
272 >                System.exit(1);
273              System.gc();
274              System.runFinalization();
275          }
161        System.exit(0);
276      }
277  
278      public static TestSuite newTestSuite(Object... suiteOrClasses) {
# Line 174 | Line 288 | public class JSR166TestCase extends Test
288          return suite;
289      }
290  
291 +    public static void addNamedTestClasses(TestSuite suite,
292 +                                           String... testClassNames) {
293 +        for (String testClassName : testClassNames) {
294 +            try {
295 +                Class<?> testClass = Class.forName(testClassName);
296 +                Method m = testClass.getDeclaredMethod("suite",
297 +                                                       new Class<?>[0]);
298 +                suite.addTest(newTestSuite((Test)m.invoke(null)));
299 +            } catch (Exception e) {
300 +                throw new Error("Missing test class", e);
301 +            }
302 +        }
303 +    }
304 +
305 +    public static final double JAVA_CLASS_VERSION;
306 +    public static final String JAVA_SPECIFICATION_VERSION;
307 +    static {
308 +        try {
309 +            JAVA_CLASS_VERSION = java.security.AccessController.doPrivileged(
310 +                new java.security.PrivilegedAction<Double>() {
311 +                public Double run() {
312 +                    return Double.valueOf(System.getProperty("java.class.version"));}});
313 +            JAVA_SPECIFICATION_VERSION = java.security.AccessController.doPrivileged(
314 +                new java.security.PrivilegedAction<String>() {
315 +                public String run() {
316 +                    return System.getProperty("java.specification.version");}});
317 +        } catch (Throwable t) {
318 +            throw new Error(t);
319 +        }
320 +    }
321 +
322 +    public static boolean atLeastJava6() { return JAVA_CLASS_VERSION >= 50.0; }
323 +    public static boolean atLeastJava7() { return JAVA_CLASS_VERSION >= 51.0; }
324 +    public static boolean atLeastJava8() { return JAVA_CLASS_VERSION >= 52.0; }
325 +    public static boolean atLeastJava9() {
326 +        return JAVA_CLASS_VERSION >= 53.0
327 +            // As of 2015-09, java9 still uses 52.0 class file version
328 +            || JAVA_SPECIFICATION_VERSION.matches("^(1\\.)?(9|[0-9][0-9])$");
329 +    }
330 +    public static boolean atLeastJava10() {
331 +        return JAVA_CLASS_VERSION >= 54.0
332 +            || JAVA_SPECIFICATION_VERSION.matches("^(1\\.)?[0-9][0-9]$");
333 +    }
334 +
335      /**
336       * Collects all JSR166 unit tests as one suite.
337       */
338      public static Test suite() {
339 <        return newTestSuite(
339 >        // Java7+ test classes
340 >        TestSuite suite = newTestSuite(
341              ForkJoinPoolTest.suite(),
342              ForkJoinTaskTest.suite(),
343              RecursiveActionTest.suite(),
# Line 243 | Line 402 | public class JSR166TestCase extends Test
402              TreeSetTest.suite(),
403              TreeSubMapTest.suite(),
404              TreeSubSetTest.suite());
405 +
406 +        // Java8+ test classes
407 +        if (atLeastJava8()) {
408 +            String[] java8TestClassNames = {
409 +                "Atomic8Test",
410 +                "CompletableFutureTest",
411 +                "ConcurrentHashMap8Test",
412 +                "CountedCompleterTest",
413 +                "DoubleAccumulatorTest",
414 +                "DoubleAdderTest",
415 +                "ForkJoinPool8Test",
416 +                "ForkJoinTask8Test",
417 +                "LongAccumulatorTest",
418 +                "LongAdderTest",
419 +                "SplittableRandomTest",
420 +                "StampedLockTest",
421 +                "SubmissionPublisherTest",
422 +                "ThreadLocalRandom8Test",
423 +            };
424 +            addNamedTestClasses(suite, java8TestClassNames);
425 +        }
426 +
427 +        // Java9+ test classes
428 +        if (atLeastJava9()) {
429 +            String[] java9TestClassNames = {
430 +                // Currently empty, but expecting varhandle tests
431 +            };
432 +            addNamedTestClasses(suite, java9TestClassNames);
433 +        }
434 +
435 +        return suite;
436 +    }
437 +
438 +    /** Returns list of junit-style test method names in given class. */
439 +    public static ArrayList<String> testMethodNames(Class<?> testClass) {
440 +        Method[] methods = testClass.getDeclaredMethods();
441 +        ArrayList<String> names = new ArrayList<String>(methods.length);
442 +        for (Method method : methods) {
443 +            if (method.getName().startsWith("test")
444 +                && Modifier.isPublic(method.getModifiers())
445 +                // method.getParameterCount() requires jdk8+
446 +                && method.getParameterTypes().length == 0) {
447 +                names.add(method.getName());
448 +            }
449 +        }
450 +        return names;
451 +    }
452 +
453 +    /**
454 +     * Returns junit-style testSuite for the given test class, but
455 +     * parameterized by passing extra data to each test.
456 +     */
457 +    public static <ExtraData> Test parameterizedTestSuite
458 +        (Class<? extends JSR166TestCase> testClass,
459 +         Class<ExtraData> dataClass,
460 +         ExtraData data) {
461 +        try {
462 +            TestSuite suite = new TestSuite();
463 +            Constructor c =
464 +                testClass.getDeclaredConstructor(dataClass, String.class);
465 +            for (String methodName : testMethodNames(testClass))
466 +                suite.addTest((Test) c.newInstance(data, methodName));
467 +            return suite;
468 +        } catch (Exception e) {
469 +            throw new Error(e);
470 +        }
471 +    }
472 +
473 +    /**
474 +     * Returns junit-style testSuite for the jdk8 extension of the
475 +     * given test class, but parameterized by passing extra data to
476 +     * each test.  Uses reflection to allow compilation in jdk7.
477 +     */
478 +    public static <ExtraData> Test jdk8ParameterizedTestSuite
479 +        (Class<? extends JSR166TestCase> testClass,
480 +         Class<ExtraData> dataClass,
481 +         ExtraData data) {
482 +        if (atLeastJava8()) {
483 +            String name = testClass.getName();
484 +            String name8 = name.replaceAll("Test$", "8Test");
485 +            if (name.equals(name8)) throw new Error(name);
486 +            try {
487 +                return (Test)
488 +                    Class.forName(name8)
489 +                    .getMethod("testSuite", new Class[] { dataClass })
490 +                    .invoke(null, data);
491 +            } catch (Exception e) {
492 +                throw new Error(e);
493 +            }
494 +        } else {
495 +            return new TestSuite();
496 +        }
497      }
498  
499 +    // Delays for timing-dependent tests, in milliseconds.
500  
501      public static long SHORT_DELAY_MS;
502      public static long SMALL_DELAY_MS;
503      public static long MEDIUM_DELAY_MS;
504      public static long LONG_DELAY_MS;
505  
254
506      /**
507       * Returns the shortest timed delay. This could
508       * be reimplemented to use for example a Property.
# Line 279 | Line 530 | public class JSR166TestCase extends Test
530      }
531  
532      /**
533 <     * Returns a new Date instance representing a time delayMillis
534 <     * milliseconds in the future.
533 >     * Returns a new Date instance representing a time at least
534 >     * delayMillis milliseconds in the future.
535       */
536      Date delayedDate(long delayMillis) {
537 <        return new Date(System.currentTimeMillis() + delayMillis);
537 >        // Add 1 because currentTimeMillis is known to round into the past.
538 >        return new Date(System.currentTimeMillis() + delayMillis + 1);
539      }
540  
541      /**
# Line 299 | Line 551 | public class JSR166TestCase extends Test
551       * the same test have no effect.
552       */
553      public void threadRecordFailure(Throwable t) {
554 +        System.err.println(t);
555 +        dumpTestThreads();
556          threadFailure.compareAndSet(null, t);
557      }
558  
# Line 306 | Line 560 | public class JSR166TestCase extends Test
560          setDelays();
561      }
562  
563 +    void tearDownFail(String format, Object... args) {
564 +        String msg = toString() + ": " + String.format(format, args);
565 +        System.err.println(msg);
566 +        dumpTestThreads();
567 +        throw new AssertionFailedError(msg);
568 +    }
569 +
570      /**
571       * Extra checks that get done for all test cases.
572       *
# Line 333 | Line 594 | public class JSR166TestCase extends Test
594          }
595  
596          if (Thread.interrupted())
597 <            throw new AssertionFailedError("interrupt status set in main thread");
597 >            tearDownFail("interrupt status set in main thread");
598 >
599 >        checkForkJoinPoolThreadLeaks();
600 >    }
601 >
602 >    /**
603 >     * Finds missing PoolCleaners
604 >     */
605 >    void checkForkJoinPoolThreadLeaks() throws InterruptedException {
606 >        Thread[] survivors = new Thread[7];
607 >        int count = Thread.enumerate(survivors);
608 >        for (int i = 0; i < count; i++) {
609 >            Thread thread = survivors[i];
610 >            String name = thread.getName();
611 >            if (name.startsWith("ForkJoinPool-")) {
612 >                // give thread some time to terminate
613 >                thread.join(LONG_DELAY_MS);
614 >                if (thread.isAlive())
615 >                    tearDownFail("Found leaked ForkJoinPool thread thread=%s",
616 >                                 thread);
617 >            }
618 >        }
619 >
620 >        if (!ForkJoinPool.commonPool()
621 >            .awaitQuiescence(LONG_DELAY_MS, MILLISECONDS))
622 >            tearDownFail("ForkJoin common pool thread stuck");
623      }
624  
625      /**
# Line 346 | Line 632 | public class JSR166TestCase extends Test
632              fail(reason);
633          } catch (AssertionFailedError t) {
634              threadRecordFailure(t);
635 <            fail(reason);
635 >            throw t;
636          }
637      }
638  
# Line 414 | Line 700 | public class JSR166TestCase extends Test
700      public void threadAssertEquals(Object x, Object y) {
701          try {
702              assertEquals(x, y);
703 <        } catch (AssertionFailedError t) {
704 <            threadRecordFailure(t);
705 <            throw t;
706 <        } catch (Throwable t) {
707 <            threadUnexpectedException(t);
703 >        } catch (AssertionFailedError fail) {
704 >            threadRecordFailure(fail);
705 >            throw fail;
706 >        } catch (Throwable fail) {
707 >            threadUnexpectedException(fail);
708          }
709      }
710  
# Line 430 | Line 716 | public class JSR166TestCase extends Test
716      public void threadAssertSame(Object x, Object y) {
717          try {
718              assertSame(x, y);
719 <        } catch (AssertionFailedError t) {
720 <            threadRecordFailure(t);
721 <            throw t;
719 >        } catch (AssertionFailedError fail) {
720 >            threadRecordFailure(fail);
721 >            throw fail;
722          }
723      }
724  
# Line 473 | Line 759 | public class JSR166TestCase extends Test
759      /**
760       * Delays, via Thread.sleep, for the given millisecond delay, but
761       * if the sleep is shorter than specified, may re-sleep or yield
762 <     * until time elapses.
762 >     * until time elapses.  Ensures that the given time, as measured
763 >     * by System.nanoTime(), has elapsed.
764       */
765      static void delay(long millis) throws InterruptedException {
766 <        long startTime = System.nanoTime();
767 <        long ns = millis * 1000 * 1000;
768 <        for (;;) {
766 >        long nanos = millis * (1000 * 1000);
767 >        final long wakeupTime = System.nanoTime() + nanos;
768 >        do {
769              if (millis > 0L)
770                  Thread.sleep(millis);
771              else // too short to sleep
772                  Thread.yield();
773 <            long d = ns - (System.nanoTime() - startTime);
774 <            if (d > 0L)
775 <                millis = d / (1000 * 1000);
776 <            else
777 <                break;
773 >            nanos = wakeupTime - System.nanoTime();
774 >            millis = nanos / (1000 * 1000);
775 >        } while (nanos >= 0L);
776 >    }
777 >
778 >    /**
779 >     * Allows use of try-with-resources with per-test thread pools.
780 >     */
781 >    class PoolCleaner implements AutoCloseable {
782 >        private final ExecutorService pool;
783 >        public PoolCleaner(ExecutorService pool) { this.pool = pool; }
784 >        public void close() { joinPool(pool); }
785 >    }
786 >
787 >    /**
788 >     * An extension of PoolCleaner that has an action to release the pool.
789 >     */
790 >    class PoolCleanerWithReleaser extends PoolCleaner {
791 >        private final Runnable releaser;
792 >        public PoolCleanerWithReleaser(ExecutorService pool, Runnable releaser) {
793 >            super(pool);
794 >            this.releaser = releaser;
795 >        }
796 >        public void close() {
797 >            try {
798 >                releaser.run();
799 >            } finally {
800 >                super.close();
801 >            }
802          }
803      }
804  
805 +    PoolCleaner cleaner(ExecutorService pool) {
806 +        return new PoolCleaner(pool);
807 +    }
808 +
809 +    PoolCleaner cleaner(ExecutorService pool, Runnable releaser) {
810 +        return new PoolCleanerWithReleaser(pool, releaser);
811 +    }
812 +
813 +    PoolCleaner cleaner(ExecutorService pool, CountDownLatch latch) {
814 +        return new PoolCleanerWithReleaser(pool, releaser(latch));
815 +    }
816 +
817 +    Runnable releaser(final CountDownLatch latch) {
818 +        return new Runnable() { public void run() {
819 +            do { latch.countDown(); }
820 +            while (latch.getCount() > 0);
821 +        }};
822 +    }
823 +
824      /**
825       * Waits out termination of a thread pool or fails doing so.
826       */
827 <    void joinPool(ExecutorService exec) {
827 >    void joinPool(ExecutorService pool) {
828          try {
829 <            exec.shutdown();
830 <            assertTrue("ExecutorService did not terminate in a timely manner",
831 <                       exec.awaitTermination(2 * LONG_DELAY_MS, MILLISECONDS));
829 >            pool.shutdown();
830 >            if (!pool.awaitTermination(2 * LONG_DELAY_MS, MILLISECONDS)) {
831 >                try {
832 >                    threadFail("ExecutorService " + pool +
833 >                               " did not terminate in a timely manner");
834 >                } finally {
835 >                    // last resort, for the benefit of subsequent tests
836 >                    pool.shutdownNow();
837 >                    pool.awaitTermination(MEDIUM_DELAY_MS, MILLISECONDS);
838 >                }
839 >            }
840          } catch (SecurityException ok) {
841              // Allowed in case test doesn't have privs
842 <        } catch (InterruptedException ie) {
843 <            fail("Unexpected InterruptedException");
842 >        } catch (InterruptedException fail) {
843 >            threadFail("Unexpected InterruptedException");
844 >        }
845 >    }
846 >
847 >    /** Like Runnable, but with the freedom to throw anything */
848 >    interface Action { public void run() throws Throwable; }
849 >
850 >    /**
851 >     * Runs all the given actions in parallel, failing if any fail.
852 >     * Useful for running multiple variants of tests that are
853 >     * necessarily individually slow because they must block.
854 >     */
855 >    void testInParallel(Action ... actions) {
856 >        ExecutorService pool = Executors.newCachedThreadPool();
857 >        try (PoolCleaner cleaner = cleaner(pool)) {
858 >            ArrayList<Future<?>> futures = new ArrayList<>(actions.length);
859 >            for (final Action action : actions)
860 >                futures.add(pool.submit(new CheckedRunnable() {
861 >                    public void realRun() throws Throwable { action.run();}}));
862 >            for (Future<?> future : futures)
863 >                try {
864 >                    assertNull(future.get(LONG_DELAY_MS, MILLISECONDS));
865 >                } catch (ExecutionException ex) {
866 >                    threadUnexpectedException(ex.getCause());
867 >                } catch (Exception ex) {
868 >                    threadUnexpectedException(ex);
869 >                }
870 >        }
871 >    }
872 >
873 >    /**
874 >     * A debugging tool to print stack traces of most threads, as jstack does.
875 >     * Uninteresting threads are filtered out.
876 >     */
877 >    static void dumpTestThreads() {
878 >        ThreadMXBean threadMXBean = ManagementFactory.getThreadMXBean();
879 >        System.err.println("------ stacktrace dump start ------");
880 >        for (ThreadInfo info : threadMXBean.dumpAllThreads(true, true)) {
881 >            String name = info.getThreadName();
882 >            if ("Signal Dispatcher".equals(name))
883 >                continue;
884 >            if ("Reference Handler".equals(name)
885 >                && info.getLockName().startsWith("java.lang.ref.Reference$Lock"))
886 >                continue;
887 >            if ("Finalizer".equals(name)
888 >                && info.getLockName().startsWith("java.lang.ref.ReferenceQueue$Lock"))
889 >                continue;
890 >            if ("checkForWedgedTest".equals(name))
891 >                continue;
892 >            System.err.print(info);
893          }
894 +        System.err.println("------ stacktrace dump end ------");
895      }
896  
897      /**
# Line 522 | Line 910 | public class JSR166TestCase extends Test
910              // No need to optimize the failing case via Thread.join.
911              delay(millis);
912              assertTrue(thread.isAlive());
913 <        } catch (InterruptedException ie) {
914 <            fail("Unexpected InterruptedException");
913 >        } catch (InterruptedException fail) {
914 >            threadFail("Unexpected InterruptedException");
915          }
916      }
917  
# Line 544 | Line 932 | public class JSR166TestCase extends Test
932              delay(millis);
933              for (Thread thread : threads)
934                  assertTrue(thread.isAlive());
935 <        } catch (InterruptedException ie) {
936 <            fail("Unexpected InterruptedException");
935 >        } catch (InterruptedException fail) {
936 >            threadFail("Unexpected InterruptedException");
937          }
938      }
939  
# Line 566 | Line 954 | public class JSR166TestCase extends Test
954              future.get(timeoutMillis, MILLISECONDS);
955              shouldThrow();
956          } catch (TimeoutException success) {
957 <        } catch (Exception e) {
958 <            threadUnexpectedException(e);
957 >        } catch (Exception fail) {
958 >            threadUnexpectedException(fail);
959          } finally { future.cancel(true); }
960          assertTrue(millisElapsedSince(startTime) >= timeoutMillis);
961      }
# Line 611 | Line 999 | public class JSR166TestCase extends Test
999      public static final Integer m6  = new Integer(-6);
1000      public static final Integer m10 = new Integer(-10);
1001  
614
1002      /**
1003       * Runs Runnable r with a security policy that permits precisely
1004       * the specified permissions.  If there is no current security
# Line 623 | Line 1010 | public class JSR166TestCase extends Test
1010          SecurityManager sm = System.getSecurityManager();
1011          if (sm == null) {
1012              r.run();
1013 +        }
1014 +        runWithSecurityManagerWithPermissions(r, permissions);
1015 +    }
1016 +
1017 +    /**
1018 +     * Runs Runnable r with a security policy that permits precisely
1019 +     * the specified permissions.  If there is no current security
1020 +     * manager, a temporary one is set for the duration of the
1021 +     * Runnable.  We require that any security manager permit
1022 +     * getPolicy/setPolicy.
1023 +     */
1024 +    public void runWithSecurityManagerWithPermissions(Runnable r,
1025 +                                                      Permission... permissions) {
1026 +        SecurityManager sm = System.getSecurityManager();
1027 +        if (sm == null) {
1028              Policy savedPolicy = Policy.getPolicy();
1029              try {
1030                  Policy.setPolicy(permissivePolicy());
1031                  System.setSecurityManager(new SecurityManager());
1032 <                runWithPermissions(r, permissions);
1032 >                runWithSecurityManagerWithPermissions(r, permissions);
1033              } finally {
1034                  System.setSecurityManager(null);
1035                  Policy.setPolicy(savedPolicy);
# Line 675 | Line 1077 | public class JSR166TestCase extends Test
1077              return perms.implies(p);
1078          }
1079          public void refresh() {}
1080 +        public String toString() {
1081 +            List<Permission> ps = new ArrayList<Permission>();
1082 +            for (Enumeration<Permission> e = perms.elements(); e.hasMoreElements();)
1083 +                ps.add(e.nextElement());
1084 +            return "AdjustablePolicy with permissions " + ps;
1085 +        }
1086      }
1087  
1088      /**
# Line 703 | Line 1111 | public class JSR166TestCase extends Test
1111      void sleep(long millis) {
1112          try {
1113              delay(millis);
1114 <        } catch (InterruptedException ie) {
1114 >        } catch (InterruptedException fail) {
1115              AssertionFailedError afe =
1116                  new AssertionFailedError("Unexpected InterruptedException");
1117 <            afe.initCause(ie);
1117 >            afe.initCause(fail);
1118              throw afe;
1119          }
1120      }
# Line 744 | Line 1152 | public class JSR166TestCase extends Test
1152      /**
1153       * Returns the number of milliseconds since time given by
1154       * startNanoTime, which must have been previously returned from a
1155 <     * call to {@link System.nanoTime()}.
1155 >     * call to {@link System#nanoTime()}.
1156       */
1157 <    long millisElapsedSince(long startNanoTime) {
1157 >    static long millisElapsedSince(long startNanoTime) {
1158          return NANOSECONDS.toMillis(System.nanoTime() - startNanoTime);
1159      }
1160  
1161 + //     void assertTerminatesPromptly(long timeoutMillis, Runnable r) {
1162 + //         long startTime = System.nanoTime();
1163 + //         try {
1164 + //             r.run();
1165 + //         } catch (Throwable fail) { threadUnexpectedException(fail); }
1166 + //         if (millisElapsedSince(startTime) > timeoutMillis/2)
1167 + //             throw new AssertionFailedError("did not return promptly");
1168 + //     }
1169 +
1170 + //     void assertTerminatesPromptly(Runnable r) {
1171 + //         assertTerminatesPromptly(LONG_DELAY_MS/2, r);
1172 + //     }
1173 +
1174 +    /**
1175 +     * Checks that timed f.get() returns the expected value, and does not
1176 +     * wait for the timeout to elapse before returning.
1177 +     */
1178 +    <T> void checkTimedGet(Future<T> f, T expectedValue, long timeoutMillis) {
1179 +        long startTime = System.nanoTime();
1180 +        try {
1181 +            assertEquals(expectedValue, f.get(timeoutMillis, MILLISECONDS));
1182 +        } catch (Throwable fail) { threadUnexpectedException(fail); }
1183 +        if (millisElapsedSince(startTime) > timeoutMillis/2)
1184 +            throw new AssertionFailedError("timed get did not return promptly");
1185 +    }
1186 +
1187 +    <T> void checkTimedGet(Future<T> f, T expectedValue) {
1188 +        checkTimedGet(f, expectedValue, LONG_DELAY_MS);
1189 +    }
1190 +
1191      /**
1192       * Returns a new started daemon Thread running the given runnable.
1193       */
# Line 768 | Line 1206 | public class JSR166TestCase extends Test
1206      void awaitTermination(Thread t, long timeoutMillis) {
1207          try {
1208              t.join(timeoutMillis);
1209 <        } catch (InterruptedException ie) {
1210 <            threadUnexpectedException(ie);
1209 >        } catch (InterruptedException fail) {
1210 >            threadUnexpectedException(fail);
1211          } finally {
1212              if (t.getState() != Thread.State.TERMINATED) {
1213                  t.interrupt();
1214 <                fail("Test timed out");
1214 >                threadFail("Test timed out");
1215              }
1216          }
1217      }
# Line 795 | Line 1233 | public class JSR166TestCase extends Test
1233          public final void run() {
1234              try {
1235                  realRun();
1236 <            } catch (Throwable t) {
1237 <                threadUnexpectedException(t);
1236 >            } catch (Throwable fail) {
1237 >                threadUnexpectedException(fail);
1238              }
1239          }
1240      }
# Line 850 | Line 1288 | public class JSR166TestCase extends Test
1288                  threadShouldThrow("InterruptedException");
1289              } catch (InterruptedException success) {
1290                  threadAssertFalse(Thread.interrupted());
1291 <            } catch (Throwable t) {
1292 <                threadUnexpectedException(t);
1291 >            } catch (Throwable fail) {
1292 >                threadUnexpectedException(fail);
1293              }
1294          }
1295      }
# Line 862 | Line 1300 | public class JSR166TestCase extends Test
1300          public final T call() {
1301              try {
1302                  return realCall();
1303 <            } catch (Throwable t) {
1304 <                threadUnexpectedException(t);
1303 >            } catch (Throwable fail) {
1304 >                threadUnexpectedException(fail);
1305                  return null;
1306              }
1307          }
# Line 880 | Line 1318 | public class JSR166TestCase extends Test
1318                  return result;
1319              } catch (InterruptedException success) {
1320                  threadAssertFalse(Thread.interrupted());
1321 <            } catch (Throwable t) {
1322 <                threadUnexpectedException(t);
1321 >            } catch (Throwable fail) {
1322 >                threadUnexpectedException(fail);
1323              }
1324              return null;
1325          }
# Line 898 | Line 1336 | public class JSR166TestCase extends Test
1336      public static final String TEST_STRING = "a test string";
1337  
1338      public static class StringTask implements Callable<String> {
1339 <        public String call() { return TEST_STRING; }
1339 >        final String value;
1340 >        public StringTask() { this(TEST_STRING); }
1341 >        public StringTask(String value) { this.value = value; }
1342 >        public String call() { return value; }
1343      }
1344  
1345      public Callable<String> latchAwaitingStringTask(final CountDownLatch latch) {
# Line 911 | Line 1352 | public class JSR166TestCase extends Test
1352              }};
1353      }
1354  
1355 <    public Runnable awaiter(final CountDownLatch latch) {
1355 >    public Runnable countDowner(final CountDownLatch latch) {
1356          return new CheckedRunnable() {
1357              public void realRun() throws InterruptedException {
1358 <                await(latch);
1358 >                latch.countDown();
1359              }};
1360      }
1361  
1362 +    class LatchAwaiter extends CheckedRunnable {
1363 +        static final int NEW = 0;
1364 +        static final int RUNNING = 1;
1365 +        static final int DONE = 2;
1366 +        final CountDownLatch latch;
1367 +        int state = NEW;
1368 +        LatchAwaiter(CountDownLatch latch) { this.latch = latch; }
1369 +        public void realRun() throws InterruptedException {
1370 +            state = 1;
1371 +            await(latch);
1372 +            state = 2;
1373 +        }
1374 +    }
1375 +
1376 +    public LatchAwaiter awaiter(CountDownLatch latch) {
1377 +        return new LatchAwaiter(latch);
1378 +    }
1379 +
1380      public void await(CountDownLatch latch) {
1381          try {
1382              assertTrue(latch.await(LONG_DELAY_MS, MILLISECONDS));
1383 <        } catch (Throwable t) {
1384 <            threadUnexpectedException(t);
1383 >        } catch (Throwable fail) {
1384 >            threadUnexpectedException(fail);
1385          }
1386      }
1387  
1388      public void await(Semaphore semaphore) {
1389          try {
1390              assertTrue(semaphore.tryAcquire(LONG_DELAY_MS, MILLISECONDS));
1391 <        } catch (Throwable t) {
1392 <            threadUnexpectedException(t);
1391 >        } catch (Throwable fail) {
1392 >            threadUnexpectedException(fail);
1393          }
1394      }
1395  
# Line 1121 | Line 1580 | public class JSR166TestCase extends Test
1580      public abstract class CheckedRecursiveAction extends RecursiveAction {
1581          protected abstract void realCompute() throws Throwable;
1582  
1583 <        public final void compute() {
1583 >        @Override protected final void compute() {
1584              try {
1585                  realCompute();
1586 <            } catch (Throwable t) {
1587 <                threadUnexpectedException(t);
1586 >            } catch (Throwable fail) {
1587 >                threadUnexpectedException(fail);
1588              }
1589          }
1590      }
# Line 1136 | Line 1595 | public class JSR166TestCase extends Test
1595      public abstract class CheckedRecursiveTask<T> extends RecursiveTask<T> {
1596          protected abstract T realCompute() throws Throwable;
1597  
1598 <        public final T compute() {
1598 >        @Override protected final T compute() {
1599              try {
1600                  return realCompute();
1601 <            } catch (Throwable t) {
1602 <                threadUnexpectedException(t);
1601 >            } catch (Throwable fail) {
1602 >                threadUnexpectedException(fail);
1603                  return null;
1604              }
1605          }
# Line 1164 | Line 1623 | public class JSR166TestCase extends Test
1623          public int await() {
1624              try {
1625                  return super.await(2 * LONG_DELAY_MS, MILLISECONDS);
1626 <            } catch (TimeoutException e) {
1626 >            } catch (TimeoutException timedOut) {
1627                  throw new AssertionFailedError("timed out");
1628 <            } catch (Exception e) {
1628 >            } catch (Exception fail) {
1629                  AssertionFailedError afe =
1630 <                    new AssertionFailedError("Unexpected exception: " + e);
1631 <                afe.initCause(e);
1630 >                    new AssertionFailedError("Unexpected exception: " + fail);
1631 >                afe.initCause(fail);
1632                  throw afe;
1633              }
1634          }
# Line 1197 | Line 1656 | public class JSR166TestCase extends Test
1656                  q.remove();
1657                  shouldThrow();
1658              } catch (NoSuchElementException success) {}
1659 <        } catch (InterruptedException ie) {
1201 <            threadUnexpectedException(ie);
1202 <        }
1659 >        } catch (InterruptedException fail) { threadUnexpectedException(fail); }
1660      }
1661  
1662      void assertSerialEquals(Object x, Object y) {
# Line 1218 | Line 1675 | public class JSR166TestCase extends Test
1675              oos.flush();
1676              oos.close();
1677              return bos.toByteArray();
1678 <        } catch (Throwable t) {
1679 <            threadUnexpectedException(t);
1678 >        } catch (Throwable fail) {
1679 >            threadUnexpectedException(fail);
1680              return new byte[0];
1681          }
1682      }
# Line 1232 | Line 1689 | public class JSR166TestCase extends Test
1689              T clone = (T) ois.readObject();
1690              assertSame(o.getClass(), clone.getClass());
1691              return clone;
1692 <        } catch (Throwable t) {
1693 <            threadUnexpectedException(t);
1692 >        } catch (Throwable fail) {
1693 >            threadUnexpectedException(fail);
1694              return null;
1695          }
1696      }
1697 +
1698 +    public void assertThrows(Class<? extends Throwable> expectedExceptionClass,
1699 +                             Runnable... throwingActions) {
1700 +        for (Runnable throwingAction : throwingActions) {
1701 +            boolean threw = false;
1702 +            try { throwingAction.run(); }
1703 +            catch (Throwable t) {
1704 +                threw = true;
1705 +                if (!expectedExceptionClass.isInstance(t)) {
1706 +                    AssertionFailedError afe =
1707 +                        new AssertionFailedError
1708 +                        ("Expected " + expectedExceptionClass.getName() +
1709 +                         ", got " + t.getClass().getName());
1710 +                    afe.initCause(t);
1711 +                    threadUnexpectedException(afe);
1712 +                }
1713 +            }
1714 +            if (!threw)
1715 +                shouldThrow(expectedExceptionClass.getName());
1716 +        }
1717 +    }
1718 +
1719 +    public void assertIteratorExhausted(Iterator<?> it) {
1720 +        try {
1721 +            it.next();
1722 +            shouldThrow();
1723 +        } catch (NoSuchElementException success) {}
1724 +        assertFalse(it.hasNext());
1725 +    }
1726   }

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines