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.189 by jsr166, Fri Mar 4 21:00:45 2016 UTC

# Line 6 | Line 6
6   * Pat Fisher, Mike Judd.
7   */
8  
9 < import junit.framework.*;
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;
22   import java.io.ByteArrayOutputStream;
23   import java.io.ObjectInputStream;
24   import java.io.ObjectOutputStream;
25 < import java.util.Arrays;
26 < import java.util.Date;
27 < import java.util.NoSuchElementException;
28 < import java.util.PropertyPermission;
29 < import java.util.concurrent.*;
30 < import java.util.concurrent.atomic.AtomicBoolean;
31 < import java.util.concurrent.atomic.AtomicReference;
32 < import static java.util.concurrent.TimeUnit.MILLISECONDS;
22 < import static java.util.concurrent.TimeUnit.NANOSECONDS;
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 37 | import java.security.Permissions;
37   import java.security.Policy;
38   import java.security.ProtectionDomain;
39   import java.security.SecurityPermission;
40 + 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;
48 + import java.util.concurrent.BlockingQueue;
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;
59 + import java.util.concurrent.RejectedExecutionHandler;
60 + 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   /**
76   * Base class for JSR166 Junit TCK tests.  Defines some constants,
# Line 38 | Line 82 | import java.security.SecurityPermission;
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 60 | Line 104 | import java.security.SecurityPermission;
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>
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
81 < * 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 109 | Line 152 | public class JSR166TestCase extends Test
152          Boolean.getBoolean("jsr166.expensiveTests");
153  
154      /**
155 +     * If true, also run tests that are not part of the official tck
156 +     * because they test unspecified implementation details.
157 +     */
158 +    protected static final boolean testImplementationDetails =
159 +        Boolean.getBoolean("jsr166.testImplementationDetails");
160 +
161 +    /**
162       * If true, report on stdout all "slow" tests, that is, ones that
163       * take more than profileThreshold milliseconds to execute.
164       */
# Line 122 | Line 172 | public class JSR166TestCase extends Test
172      private static final long profileThreshold =
173          Long.getLong("jsr166.profileThreshold", 100);
174  
175 +    /**
176 +     * The number of repetitions per test (for tickling rare bugs).
177 +     */
178 +    private static final int runsPerTest =
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 +    /**
188 +     * Returns the value of the system property, or NaN if not defined.
189 +     */
190 +    private static float systemPropertyValue(String name) {
191 +        String floatString = System.getProperty(name);
192 +        if (floatString == null)
193 +            return Float.NaN;
194 +        try {
195 +            return Float.parseFloat(floatString);
196 +        } catch (NumberFormatException ex) {
197 +            throw new IllegalArgumentException(
198 +                String.format("Bad float value in system property %s=%s",
199 +                              name, floatString));
200 +        }
201 +    }
202 +
203 +    /**
204 +     * The scaling factor to apply to standard delays used in tests.
205 +     * May be initialized from any of:
206 +     * - the "jsr166.delay.factor" system property
207 +     * - the "test.timeout.factor" system property (as used by jtreg)
208 +     *   See: http://openjdk.java.net/jtreg/tag-spec.html
209 +     * - hard-coded fuzz factor when using a known slowpoke VM
210 +     */
211 +    private static final float delayFactor = delayFactor();
212 +
213 +    private static float delayFactor() {
214 +        float x;
215 +        if (!Float.isNaN(x = systemPropertyValue("jsr166.delay.factor")))
216 +            return x;
217 +        if (!Float.isNaN(x = systemPropertyValue("test.timeout.factor")))
218 +            return x;
219 +        String prop = System.getProperty("java.vm.version");
220 +        if (prop != null && prop.matches(".*debug.*"))
221 +            return 4.0f; // How much slower is fastdebug than product?!
222 +        return 1.0f;
223 +    }
224 +
225 +    public JSR166TestCase() { super(); }
226 +    public JSR166TestCase(String name) { super(name); }
227 +
228 +    /**
229 +     * A filter for tests to run, matching strings of the form
230 +     * methodName(className), e.g. "testInvokeAll5(ForkJoinPoolTest)"
231 +     * Usefully combined with jsr166.runsPerTest.
232 +     */
233 +    private static final Pattern methodFilter = methodFilter();
234 +
235 +    private static Pattern methodFilter() {
236 +        String regex = System.getProperty("jsr166.methodFilter");
237 +        return (regex == null) ? null : Pattern.compile(regex);
238 +    }
239 +
240 +    // Instrumentation to debug very rare, but very annoying hung test runs.
241 +    static volatile TestCase currentTestCase;
242 +    // static volatile int currentRun = 0;
243 +    static {
244 +        Runnable checkForWedgedTest = new Runnable() { public void run() {
245 +            // Avoid spurious reports with enormous runsPerTest.
246 +            // A single test case run should never take more than 1 second.
247 +            // But let's cap it at the high end too ...
248 +            final int timeoutMinutes =
249 +                Math.min(15, Math.max(runsPerTest / 60, 1));
250 +            for (TestCase lastTestCase = currentTestCase;;) {
251 +                try { MINUTES.sleep(timeoutMinutes); }
252 +                catch (InterruptedException unexpected) { break; }
253 +                if (lastTestCase == currentTestCase) {
254 +                    System.err.printf(
255 +                        "Looks like we're stuck running test: %s%n",
256 +                        lastTestCase);
257 + //                     System.err.printf(
258 + //                         "Looks like we're stuck running test: %s (%d/%d)%n",
259 + //                         lastTestCase, currentRun, runsPerTest);
260 + //                     System.err.println("availableProcessors=" +
261 + //                         Runtime.getRuntime().availableProcessors());
262 + //                     System.err.printf("cpu model = %s%n", cpuModel());
263 +                    dumpTestThreads();
264 +                    // one stack dump is probably enough; more would be spam
265 +                    break;
266 +                }
267 +                lastTestCase = currentTestCase;
268 +            }}};
269 +        Thread thread = new Thread(checkForWedgedTest, "checkForWedgedTest");
270 +        thread.setDaemon(true);
271 +        thread.start();
272 +    }
273 +
274 + //     public static String cpuModel() {
275 + //         try {
276 + //             Matcher matcher = Pattern.compile("model name\\s*: (.*)")
277 + //                 .matcher(new String(
278 + //                      Files.readAllBytes(Paths.get("/proc/cpuinfo")), "UTF-8"));
279 + //             matcher.find();
280 + //             return matcher.group(1);
281 + //         } catch (Exception ex) { return null; }
282 + //     }
283 +
284 +    public void runBare() throws Throwable {
285 +        currentTestCase = this;
286 +        if (methodFilter == null
287 +            || methodFilter.matcher(toString()).find())
288 +            super.runBare();
289 +    }
290 +
291      protected void runTest() throws Throwable {
292 <        if (profileTests)
293 <            runTestProfiled();
294 <        else
295 <            super.runTest();
292 >        for (int i = 0; i < runsPerTest; i++) {
293 >            // currentRun = i;
294 >            if (profileTests)
295 >                runTestProfiled();
296 >            else
297 >                super.runTest();
298 >        }
299      }
300  
301      protected void runTestProfiled() throws Throwable {
302 <        long t0 = System.nanoTime();
303 <        try {
302 >        for (int i = 0; i < 2; i++) {
303 >            long startTime = System.nanoTime();
304              super.runTest();
305 <        } finally {
306 <            long elapsedMillis =
307 <                (System.nanoTime() - t0) / (1000L * 1000L);
308 <            if (elapsedMillis >= profileThreshold)
305 >            long elapsedMillis = millisElapsedSince(startTime);
306 >            if (elapsedMillis < profileThreshold)
307 >                break;
308 >            // Never report first run of any test; treat it as a
309 >            // warmup run, notably to trigger all needed classloading,
310 >            if (i > 0)
311                  System.out.printf("%n%s: %d%n", toString(), elapsedMillis);
312          }
313      }
314  
315      /**
316 <     * Runs all JSR166 unit tests using junit.textui.TestRunner
316 >     * Runs all JSR166 unit tests using junit.textui.TestRunner.
317       */
318      public static void main(String[] args) {
319 +        main(suite(), args);
320 +    }
321 +
322 +    static class PithyResultPrinter extends junit.textui.ResultPrinter {
323 +        PithyResultPrinter(java.io.PrintStream writer) { super(writer); }
324 +        long runTime;
325 +        public void startTest(Test test) {}
326 +        protected void printHeader(long runTime) {
327 +            this.runTime = runTime; // defer printing for later
328 +        }
329 +        protected void printFooter(TestResult result) {
330 +            if (result.wasSuccessful()) {
331 +                getWriter().println("OK (" + result.runCount() + " tests)"
332 +                    + "  Time: " + elapsedTimeAsString(runTime));
333 +            } else {
334 +                getWriter().println("Time: " + elapsedTimeAsString(runTime));
335 +                super.printFooter(result);
336 +            }
337 +        }
338 +    }
339 +
340 +    /**
341 +     * Returns a TestRunner that doesn't bother with unnecessary
342 +     * fluff, like printing a "." for each test case.
343 +     */
344 +    static junit.textui.TestRunner newPithyTestRunner() {
345 +        junit.textui.TestRunner runner = new junit.textui.TestRunner();
346 +        runner.setPrinter(new PithyResultPrinter(System.out));
347 +        return runner;
348 +    }
349 +
350 +    /**
351 +     * Runs all unit tests in the given test suite.
352 +     * Actual behavior influenced by jsr166.* system properties.
353 +     */
354 +    static void main(Test suite, String[] args) {
355          if (useSecurityManager) {
356              System.err.println("Setting a permissive security manager");
357              Policy.setPolicy(permissivePolicy());
358              System.setSecurityManager(new SecurityManager());
359          }
360 <        int iters = (args.length == 0) ? 1 : Integer.parseInt(args[0]);
361 <
362 <        Test s = suite();
363 <        for (int i = 0; i < iters; ++i) {
157 <            junit.textui.TestRunner.run(s);
360 >        for (int i = 0; i < suiteRuns; i++) {
361 >            TestResult result = newPithyTestRunner().doRun(suite);
362 >            if (!result.wasSuccessful())
363 >                System.exit(1);
364              System.gc();
365              System.runFinalization();
366          }
161        System.exit(0);
367      }
368  
369      public static TestSuite newTestSuite(Object... suiteOrClasses) {
# Line 174 | Line 379 | public class JSR166TestCase extends Test
379          return suite;
380      }
381  
382 +    public static void addNamedTestClasses(TestSuite suite,
383 +                                           String... testClassNames) {
384 +        for (String testClassName : testClassNames) {
385 +            try {
386 +                Class<?> testClass = Class.forName(testClassName);
387 +                Method m = testClass.getDeclaredMethod("suite",
388 +                                                       new Class<?>[0]);
389 +                suite.addTest(newTestSuite((Test)m.invoke(null)));
390 +            } catch (Exception e) {
391 +                throw new Error("Missing test class", e);
392 +            }
393 +        }
394 +    }
395 +
396 +    public static final double JAVA_CLASS_VERSION;
397 +    public static final String JAVA_SPECIFICATION_VERSION;
398 +    static {
399 +        try {
400 +            JAVA_CLASS_VERSION = java.security.AccessController.doPrivileged(
401 +                new java.security.PrivilegedAction<Double>() {
402 +                public Double run() {
403 +                    return Double.valueOf(System.getProperty("java.class.version"));}});
404 +            JAVA_SPECIFICATION_VERSION = java.security.AccessController.doPrivileged(
405 +                new java.security.PrivilegedAction<String>() {
406 +                public String run() {
407 +                    return System.getProperty("java.specification.version");}});
408 +        } catch (Throwable t) {
409 +            throw new Error(t);
410 +        }
411 +    }
412 +
413 +    public static boolean atLeastJava6() { return JAVA_CLASS_VERSION >= 50.0; }
414 +    public static boolean atLeastJava7() { return JAVA_CLASS_VERSION >= 51.0; }
415 +    public static boolean atLeastJava8() { return JAVA_CLASS_VERSION >= 52.0; }
416 +    public static boolean atLeastJava9() {
417 +        return JAVA_CLASS_VERSION >= 53.0
418 +            // As of 2015-09, java9 still uses 52.0 class file version
419 +            || JAVA_SPECIFICATION_VERSION.matches("^(1\\.)?(9|[0-9][0-9])$");
420 +    }
421 +    public static boolean atLeastJava10() {
422 +        return JAVA_CLASS_VERSION >= 54.0
423 +            || JAVA_SPECIFICATION_VERSION.matches("^(1\\.)?[0-9][0-9]$");
424 +    }
425 +
426      /**
427       * Collects all JSR166 unit tests as one suite.
428       */
429      public static Test suite() {
430 <        return newTestSuite(
430 >        // Java7+ test classes
431 >        TestSuite suite = newTestSuite(
432              ForkJoinPoolTest.suite(),
433              ForkJoinTaskTest.suite(),
434              RecursiveActionTest.suite(),
# Line 243 | Line 493 | public class JSR166TestCase extends Test
493              TreeSetTest.suite(),
494              TreeSubMapTest.suite(),
495              TreeSubSetTest.suite());
496 +
497 +        // Java8+ test classes
498 +        if (atLeastJava8()) {
499 +            String[] java8TestClassNames = {
500 +                "Atomic8Test",
501 +                "CompletableFutureTest",
502 +                "ConcurrentHashMap8Test",
503 +                "CountedCompleterTest",
504 +                "DoubleAccumulatorTest",
505 +                "DoubleAdderTest",
506 +                "ForkJoinPool8Test",
507 +                "ForkJoinTask8Test",
508 +                "LongAccumulatorTest",
509 +                "LongAdderTest",
510 +                "SplittableRandomTest",
511 +                "StampedLockTest",
512 +                "SubmissionPublisherTest",
513 +                "ThreadLocalRandom8Test",
514 +            };
515 +            addNamedTestClasses(suite, java8TestClassNames);
516 +        }
517 +
518 +        // Java9+ test classes
519 +        if (atLeastJava9()) {
520 +            String[] java9TestClassNames = {
521 +                // Currently empty, but expecting varhandle tests
522 +            };
523 +            addNamedTestClasses(suite, java9TestClassNames);
524 +        }
525 +
526 +        return suite;
527      }
528  
529 +    /** Returns list of junit-style test method names in given class. */
530 +    public static ArrayList<String> testMethodNames(Class<?> testClass) {
531 +        Method[] methods = testClass.getDeclaredMethods();
532 +        ArrayList<String> names = new ArrayList<String>(methods.length);
533 +        for (Method method : methods) {
534 +            if (method.getName().startsWith("test")
535 +                && Modifier.isPublic(method.getModifiers())
536 +                // method.getParameterCount() requires jdk8+
537 +                && method.getParameterTypes().length == 0) {
538 +                names.add(method.getName());
539 +            }
540 +        }
541 +        return names;
542 +    }
543 +
544 +    /**
545 +     * Returns junit-style testSuite for the given test class, but
546 +     * parameterized by passing extra data to each test.
547 +     */
548 +    public static <ExtraData> Test parameterizedTestSuite
549 +        (Class<? extends JSR166TestCase> testClass,
550 +         Class<ExtraData> dataClass,
551 +         ExtraData data) {
552 +        try {
553 +            TestSuite suite = new TestSuite();
554 +            Constructor c =
555 +                testClass.getDeclaredConstructor(dataClass, String.class);
556 +            for (String methodName : testMethodNames(testClass))
557 +                suite.addTest((Test) c.newInstance(data, methodName));
558 +            return suite;
559 +        } catch (Exception e) {
560 +            throw new Error(e);
561 +        }
562 +    }
563 +
564 +    /**
565 +     * Returns junit-style testSuite for the jdk8 extension of the
566 +     * given test class, but parameterized by passing extra data to
567 +     * each test.  Uses reflection to allow compilation in jdk7.
568 +     */
569 +    public static <ExtraData> Test jdk8ParameterizedTestSuite
570 +        (Class<? extends JSR166TestCase> testClass,
571 +         Class<ExtraData> dataClass,
572 +         ExtraData data) {
573 +        if (atLeastJava8()) {
574 +            String name = testClass.getName();
575 +            String name8 = name.replaceAll("Test$", "8Test");
576 +            if (name.equals(name8)) throw new Error(name);
577 +            try {
578 +                return (Test)
579 +                    Class.forName(name8)
580 +                    .getMethod("testSuite", new Class[] { dataClass })
581 +                    .invoke(null, data);
582 +            } catch (Exception e) {
583 +                throw new Error(e);
584 +            }
585 +        } else {
586 +            return new TestSuite();
587 +        }
588 +    }
589 +
590 +    // Delays for timing-dependent tests, in milliseconds.
591  
592      public static long SHORT_DELAY_MS;
593      public static long SMALL_DELAY_MS;
594      public static long MEDIUM_DELAY_MS;
595      public static long LONG_DELAY_MS;
596  
254
597      /**
598 <     * Returns the shortest timed delay. This could
599 <     * be reimplemented to use for example a Property.
598 >     * Returns the shortest timed delay. This can be scaled up for
599 >     * slow machines using the jsr166.delay.factor system property,
600 >     * or via jtreg's -timeoutFactor: flag.
601 >     * http://openjdk.java.net/jtreg/command-help.html
602       */
603      protected long getShortDelay() {
604 <        return 50;
604 >        return (long) (50 * delayFactor);
605      }
606  
607      /**
# Line 279 | Line 623 | public class JSR166TestCase extends Test
623      }
624  
625      /**
626 <     * Returns a new Date instance representing a time delayMillis
627 <     * milliseconds in the future.
626 >     * Returns a new Date instance representing a time at least
627 >     * delayMillis milliseconds in the future.
628       */
629      Date delayedDate(long delayMillis) {
630 <        return new Date(System.currentTimeMillis() + delayMillis);
630 >        // Add 1 because currentTimeMillis is known to round into the past.
631 >        return new Date(System.currentTimeMillis() + delayMillis + 1);
632      }
633  
634      /**
# Line 299 | Line 644 | public class JSR166TestCase extends Test
644       * the same test have no effect.
645       */
646      public void threadRecordFailure(Throwable t) {
647 +        System.err.println(t);
648 +        dumpTestThreads();
649          threadFailure.compareAndSet(null, t);
650      }
651  
# Line 306 | Line 653 | public class JSR166TestCase extends Test
653          setDelays();
654      }
655  
656 +    void tearDownFail(String format, Object... args) {
657 +        String msg = toString() + ": " + String.format(format, args);
658 +        System.err.println(msg);
659 +        dumpTestThreads();
660 +        throw new AssertionFailedError(msg);
661 +    }
662 +
663      /**
664       * Extra checks that get done for all test cases.
665       *
# Line 333 | Line 687 | public class JSR166TestCase extends Test
687          }
688  
689          if (Thread.interrupted())
690 <            throw new AssertionFailedError("interrupt status set in main thread");
690 >            tearDownFail("interrupt status set in main thread");
691 >
692 >        checkForkJoinPoolThreadLeaks();
693 >    }
694 >
695 >    /**
696 >     * Finds missing PoolCleaners
697 >     */
698 >    void checkForkJoinPoolThreadLeaks() throws InterruptedException {
699 >        Thread[] survivors = new Thread[7];
700 >        int count = Thread.enumerate(survivors);
701 >        for (int i = 0; i < count; i++) {
702 >            Thread thread = survivors[i];
703 >            String name = thread.getName();
704 >            if (name.startsWith("ForkJoinPool-")) {
705 >                // give thread some time to terminate
706 >                thread.join(LONG_DELAY_MS);
707 >                if (thread.isAlive())
708 >                    tearDownFail("Found leaked ForkJoinPool thread thread=%s",
709 >                                 thread);
710 >            }
711 >        }
712 >
713 >        if (!ForkJoinPool.commonPool()
714 >            .awaitQuiescence(LONG_DELAY_MS, MILLISECONDS))
715 >            tearDownFail("ForkJoin common pool thread stuck");
716      }
717  
718      /**
# Line 346 | Line 725 | public class JSR166TestCase extends Test
725              fail(reason);
726          } catch (AssertionFailedError t) {
727              threadRecordFailure(t);
728 <            fail(reason);
728 >            throw t;
729          }
730      }
731  
# Line 414 | Line 793 | public class JSR166TestCase extends Test
793      public void threadAssertEquals(Object x, Object y) {
794          try {
795              assertEquals(x, y);
796 <        } catch (AssertionFailedError t) {
797 <            threadRecordFailure(t);
798 <            throw t;
799 <        } catch (Throwable t) {
800 <            threadUnexpectedException(t);
796 >        } catch (AssertionFailedError fail) {
797 >            threadRecordFailure(fail);
798 >            throw fail;
799 >        } catch (Throwable fail) {
800 >            threadUnexpectedException(fail);
801          }
802      }
803  
# Line 430 | Line 809 | public class JSR166TestCase extends Test
809      public void threadAssertSame(Object x, Object y) {
810          try {
811              assertSame(x, y);
812 <        } catch (AssertionFailedError t) {
813 <            threadRecordFailure(t);
814 <            throw t;
812 >        } catch (AssertionFailedError fail) {
813 >            threadRecordFailure(fail);
814 >            throw fail;
815          }
816      }
817  
# Line 473 | Line 852 | public class JSR166TestCase extends Test
852      /**
853       * Delays, via Thread.sleep, for the given millisecond delay, but
854       * if the sleep is shorter than specified, may re-sleep or yield
855 <     * until time elapses.
855 >     * until time elapses.  Ensures that the given time, as measured
856 >     * by System.nanoTime(), has elapsed.
857       */
858      static void delay(long millis) throws InterruptedException {
859 <        long startTime = System.nanoTime();
860 <        long ns = millis * 1000 * 1000;
861 <        for (;;) {
859 >        long nanos = millis * (1000 * 1000);
860 >        final long wakeupTime = System.nanoTime() + nanos;
861 >        do {
862              if (millis > 0L)
863                  Thread.sleep(millis);
864              else // too short to sleep
865                  Thread.yield();
866 <            long d = ns - (System.nanoTime() - startTime);
867 <            if (d > 0L)
868 <                millis = d / (1000 * 1000);
869 <            else
870 <                break;
866 >            nanos = wakeupTime - System.nanoTime();
867 >            millis = nanos / (1000 * 1000);
868 >        } while (nanos >= 0L);
869 >    }
870 >
871 >    /**
872 >     * Allows use of try-with-resources with per-test thread pools.
873 >     */
874 >    class PoolCleaner implements AutoCloseable {
875 >        private final ExecutorService pool;
876 >        public PoolCleaner(ExecutorService pool) { this.pool = pool; }
877 >        public void close() { joinPool(pool); }
878 >    }
879 >
880 >    /**
881 >     * An extension of PoolCleaner that has an action to release the pool.
882 >     */
883 >    class PoolCleanerWithReleaser extends PoolCleaner {
884 >        private final Runnable releaser;
885 >        public PoolCleanerWithReleaser(ExecutorService pool, Runnable releaser) {
886 >            super(pool);
887 >            this.releaser = releaser;
888 >        }
889 >        public void close() {
890 >            try {
891 >                releaser.run();
892 >            } finally {
893 >                super.close();
894 >            }
895          }
896      }
897  
898 +    PoolCleaner cleaner(ExecutorService pool) {
899 +        return new PoolCleaner(pool);
900 +    }
901 +
902 +    PoolCleaner cleaner(ExecutorService pool, Runnable releaser) {
903 +        return new PoolCleanerWithReleaser(pool, releaser);
904 +    }
905 +
906 +    PoolCleaner cleaner(ExecutorService pool, CountDownLatch latch) {
907 +        return new PoolCleanerWithReleaser(pool, releaser(latch));
908 +    }
909 +
910 +    Runnable releaser(final CountDownLatch latch) {
911 +        return new Runnable() { public void run() {
912 +            do { latch.countDown(); }
913 +            while (latch.getCount() > 0);
914 +        }};
915 +    }
916 +
917 +    PoolCleaner cleaner(ExecutorService pool, AtomicBoolean flag) {
918 +        return new PoolCleanerWithReleaser(pool, releaser(flag));
919 +    }
920 +
921 +    Runnable releaser(final AtomicBoolean flag) {
922 +        return new Runnable() { public void run() { flag.set(true); }};
923 +    }
924 +
925      /**
926       * Waits out termination of a thread pool or fails doing so.
927       */
928 <    void joinPool(ExecutorService exec) {
928 >    void joinPool(ExecutorService pool) {
929          try {
930 <            exec.shutdown();
931 <            assertTrue("ExecutorService did not terminate in a timely manner",
932 <                       exec.awaitTermination(2 * LONG_DELAY_MS, MILLISECONDS));
930 >            pool.shutdown();
931 >            if (!pool.awaitTermination(2 * LONG_DELAY_MS, MILLISECONDS)) {
932 >                try {
933 >                    threadFail("ExecutorService " + pool +
934 >                               " did not terminate in a timely manner");
935 >                } finally {
936 >                    // last resort, for the benefit of subsequent tests
937 >                    pool.shutdownNow();
938 >                    pool.awaitTermination(MEDIUM_DELAY_MS, MILLISECONDS);
939 >                }
940 >            }
941          } catch (SecurityException ok) {
942              // Allowed in case test doesn't have privs
943 <        } catch (InterruptedException ie) {
944 <            fail("Unexpected InterruptedException");
943 >        } catch (InterruptedException fail) {
944 >            threadFail("Unexpected InterruptedException");
945          }
946      }
947  
948 +    /** Like Runnable, but with the freedom to throw anything */
949 +    interface Action { public void run() throws Throwable; }
950 +
951 +    /**
952 +     * Runs all the given actions in parallel, failing if any fail.
953 +     * Useful for running multiple variants of tests that are
954 +     * necessarily individually slow because they must block.
955 +     */
956 +    void testInParallel(Action ... actions) {
957 +        ExecutorService pool = Executors.newCachedThreadPool();
958 +        try (PoolCleaner cleaner = cleaner(pool)) {
959 +            ArrayList<Future<?>> futures = new ArrayList<>(actions.length);
960 +            for (final Action action : actions)
961 +                futures.add(pool.submit(new CheckedRunnable() {
962 +                    public void realRun() throws Throwable { action.run();}}));
963 +            for (Future<?> future : futures)
964 +                try {
965 +                    assertNull(future.get(LONG_DELAY_MS, MILLISECONDS));
966 +                } catch (ExecutionException ex) {
967 +                    threadUnexpectedException(ex.getCause());
968 +                } catch (Exception ex) {
969 +                    threadUnexpectedException(ex);
970 +                }
971 +        }
972 +    }
973 +
974 +    /**
975 +     * A debugging tool to print stack traces of most threads, as jstack does.
976 +     * Uninteresting threads are filtered out.
977 +     */
978 +    static void dumpTestThreads() {
979 +        ThreadMXBean threadMXBean = ManagementFactory.getThreadMXBean();
980 +        System.err.println("------ stacktrace dump start ------");
981 +        for (ThreadInfo info : threadMXBean.dumpAllThreads(true, true)) {
982 +            String name = info.getThreadName();
983 +            if ("Signal Dispatcher".equals(name))
984 +                continue;
985 +            if ("Reference Handler".equals(name)
986 +                && info.getLockName().startsWith("java.lang.ref.Reference$Lock"))
987 +                continue;
988 +            if ("Finalizer".equals(name)
989 +                && info.getLockName().startsWith("java.lang.ref.ReferenceQueue$Lock"))
990 +                continue;
991 +            if ("checkForWedgedTest".equals(name))
992 +                continue;
993 +            System.err.print(info);
994 +        }
995 +        System.err.println("------ stacktrace dump end ------");
996 +    }
997 +
998      /**
999       * Checks that thread does not terminate within the default
1000       * millisecond delay of {@code timeoutMillis()}.
# Line 522 | Line 1011 | public class JSR166TestCase extends Test
1011              // No need to optimize the failing case via Thread.join.
1012              delay(millis);
1013              assertTrue(thread.isAlive());
1014 <        } catch (InterruptedException ie) {
1015 <            fail("Unexpected InterruptedException");
1014 >        } catch (InterruptedException fail) {
1015 >            threadFail("Unexpected InterruptedException");
1016          }
1017      }
1018  
# Line 544 | Line 1033 | public class JSR166TestCase extends Test
1033              delay(millis);
1034              for (Thread thread : threads)
1035                  assertTrue(thread.isAlive());
1036 <        } catch (InterruptedException ie) {
1037 <            fail("Unexpected InterruptedException");
1036 >        } catch (InterruptedException fail) {
1037 >            threadFail("Unexpected InterruptedException");
1038          }
1039      }
1040  
# Line 566 | Line 1055 | public class JSR166TestCase extends Test
1055              future.get(timeoutMillis, MILLISECONDS);
1056              shouldThrow();
1057          } catch (TimeoutException success) {
1058 <        } catch (Exception e) {
1059 <            threadUnexpectedException(e);
1058 >        } catch (Exception fail) {
1059 >            threadUnexpectedException(fail);
1060          } finally { future.cancel(true); }
1061          assertTrue(millisElapsedSince(startTime) >= timeoutMillis);
1062      }
# Line 611 | Line 1100 | public class JSR166TestCase extends Test
1100      public static final Integer m6  = new Integer(-6);
1101      public static final Integer m10 = new Integer(-10);
1102  
614
1103      /**
1104       * Runs Runnable r with a security policy that permits precisely
1105       * the specified permissions.  If there is no current security
# Line 623 | Line 1111 | public class JSR166TestCase extends Test
1111          SecurityManager sm = System.getSecurityManager();
1112          if (sm == null) {
1113              r.run();
1114 +        }
1115 +        runWithSecurityManagerWithPermissions(r, permissions);
1116 +    }
1117 +
1118 +    /**
1119 +     * Runs Runnable r with a security policy that permits precisely
1120 +     * the specified permissions.  If there is no current security
1121 +     * manager, a temporary one is set for the duration of the
1122 +     * Runnable.  We require that any security manager permit
1123 +     * getPolicy/setPolicy.
1124 +     */
1125 +    public void runWithSecurityManagerWithPermissions(Runnable r,
1126 +                                                      Permission... permissions) {
1127 +        SecurityManager sm = System.getSecurityManager();
1128 +        if (sm == null) {
1129              Policy savedPolicy = Policy.getPolicy();
1130              try {
1131                  Policy.setPolicy(permissivePolicy());
1132                  System.setSecurityManager(new SecurityManager());
1133 <                runWithPermissions(r, permissions);
1133 >                runWithSecurityManagerWithPermissions(r, permissions);
1134              } finally {
1135                  System.setSecurityManager(null);
1136                  Policy.setPolicy(savedPolicy);
# Line 675 | Line 1178 | public class JSR166TestCase extends Test
1178              return perms.implies(p);
1179          }
1180          public void refresh() {}
1181 +        public String toString() {
1182 +            List<Permission> ps = new ArrayList<Permission>();
1183 +            for (Enumeration<Permission> e = perms.elements(); e.hasMoreElements();)
1184 +                ps.add(e.nextElement());
1185 +            return "AdjustablePolicy with permissions " + ps;
1186 +        }
1187      }
1188  
1189      /**
# Line 703 | Line 1212 | public class JSR166TestCase extends Test
1212      void sleep(long millis) {
1213          try {
1214              delay(millis);
1215 <        } catch (InterruptedException ie) {
1215 >        } catch (InterruptedException fail) {
1216              AssertionFailedError afe =
1217                  new AssertionFailedError("Unexpected InterruptedException");
1218 <            afe.initCause(ie);
1218 >            afe.initCause(fail);
1219              throw afe;
1220          }
1221      }
# Line 744 | Line 1253 | public class JSR166TestCase extends Test
1253      /**
1254       * Returns the number of milliseconds since time given by
1255       * startNanoTime, which must have been previously returned from a
1256 <     * call to {@link System.nanoTime()}.
1256 >     * call to {@link System#nanoTime()}.
1257       */
1258 <    long millisElapsedSince(long startNanoTime) {
1258 >    static long millisElapsedSince(long startNanoTime) {
1259          return NANOSECONDS.toMillis(System.nanoTime() - startNanoTime);
1260      }
1261  
1262 + //     void assertTerminatesPromptly(long timeoutMillis, Runnable r) {
1263 + //         long startTime = System.nanoTime();
1264 + //         try {
1265 + //             r.run();
1266 + //         } catch (Throwable fail) { threadUnexpectedException(fail); }
1267 + //         if (millisElapsedSince(startTime) > timeoutMillis/2)
1268 + //             throw new AssertionFailedError("did not return promptly");
1269 + //     }
1270 +
1271 + //     void assertTerminatesPromptly(Runnable r) {
1272 + //         assertTerminatesPromptly(LONG_DELAY_MS/2, r);
1273 + //     }
1274 +
1275 +    /**
1276 +     * Checks that timed f.get() returns the expected value, and does not
1277 +     * wait for the timeout to elapse before returning.
1278 +     */
1279 +    <T> void checkTimedGet(Future<T> f, T expectedValue, long timeoutMillis) {
1280 +        long startTime = System.nanoTime();
1281 +        try {
1282 +            assertEquals(expectedValue, f.get(timeoutMillis, MILLISECONDS));
1283 +        } catch (Throwable fail) { threadUnexpectedException(fail); }
1284 +        if (millisElapsedSince(startTime) > timeoutMillis/2)
1285 +            throw new AssertionFailedError("timed get did not return promptly");
1286 +    }
1287 +
1288 +    <T> void checkTimedGet(Future<T> f, T expectedValue) {
1289 +        checkTimedGet(f, expectedValue, LONG_DELAY_MS);
1290 +    }
1291 +
1292      /**
1293       * Returns a new started daemon Thread running the given runnable.
1294       */
# Line 768 | Line 1307 | public class JSR166TestCase extends Test
1307      void awaitTermination(Thread t, long timeoutMillis) {
1308          try {
1309              t.join(timeoutMillis);
1310 <        } catch (InterruptedException ie) {
1311 <            threadUnexpectedException(ie);
1310 >        } catch (InterruptedException fail) {
1311 >            threadUnexpectedException(fail);
1312          } finally {
1313              if (t.getState() != Thread.State.TERMINATED) {
1314                  t.interrupt();
1315 <                fail("Test timed out");
1315 >                threadFail("timed out waiting for thread to terminate");
1316              }
1317          }
1318      }
# Line 795 | Line 1334 | public class JSR166TestCase extends Test
1334          public final void run() {
1335              try {
1336                  realRun();
1337 <            } catch (Throwable t) {
1338 <                threadUnexpectedException(t);
1337 >            } catch (Throwable fail) {
1338 >                threadUnexpectedException(fail);
1339              }
1340          }
1341      }
# Line 850 | Line 1389 | public class JSR166TestCase extends Test
1389                  threadShouldThrow("InterruptedException");
1390              } catch (InterruptedException success) {
1391                  threadAssertFalse(Thread.interrupted());
1392 <            } catch (Throwable t) {
1393 <                threadUnexpectedException(t);
1392 >            } catch (Throwable fail) {
1393 >                threadUnexpectedException(fail);
1394              }
1395          }
1396      }
# Line 862 | Line 1401 | public class JSR166TestCase extends Test
1401          public final T call() {
1402              try {
1403                  return realCall();
1404 <            } catch (Throwable t) {
1405 <                threadUnexpectedException(t);
1404 >            } catch (Throwable fail) {
1405 >                threadUnexpectedException(fail);
1406                  return null;
1407              }
1408          }
# Line 880 | Line 1419 | public class JSR166TestCase extends Test
1419                  return result;
1420              } catch (InterruptedException success) {
1421                  threadAssertFalse(Thread.interrupted());
1422 <            } catch (Throwable t) {
1423 <                threadUnexpectedException(t);
1422 >            } catch (Throwable fail) {
1423 >                threadUnexpectedException(fail);
1424              }
1425              return null;
1426          }
# Line 898 | Line 1437 | public class JSR166TestCase extends Test
1437      public static final String TEST_STRING = "a test string";
1438  
1439      public static class StringTask implements Callable<String> {
1440 <        public String call() { return TEST_STRING; }
1440 >        final String value;
1441 >        public StringTask() { this(TEST_STRING); }
1442 >        public StringTask(String value) { this.value = value; }
1443 >        public String call() { return value; }
1444      }
1445  
1446      public Callable<String> latchAwaitingStringTask(final CountDownLatch latch) {
# Line 911 | Line 1453 | public class JSR166TestCase extends Test
1453              }};
1454      }
1455  
1456 <    public Runnable awaiter(final CountDownLatch latch) {
1456 >    public Runnable countDowner(final CountDownLatch latch) {
1457          return new CheckedRunnable() {
1458              public void realRun() throws InterruptedException {
1459 <                await(latch);
1459 >                latch.countDown();
1460              }};
1461      }
1462  
1463 <    public void await(CountDownLatch latch) {
1463 >    class LatchAwaiter extends CheckedRunnable {
1464 >        static final int NEW = 0;
1465 >        static final int RUNNING = 1;
1466 >        static final int DONE = 2;
1467 >        final CountDownLatch latch;
1468 >        int state = NEW;
1469 >        LatchAwaiter(CountDownLatch latch) { this.latch = latch; }
1470 >        public void realRun() throws InterruptedException {
1471 >            state = 1;
1472 >            await(latch);
1473 >            state = 2;
1474 >        }
1475 >    }
1476 >
1477 >    public LatchAwaiter awaiter(CountDownLatch latch) {
1478 >        return new LatchAwaiter(latch);
1479 >    }
1480 >
1481 >    public void await(CountDownLatch latch, long timeoutMillis) {
1482          try {
1483 <            assertTrue(latch.await(LONG_DELAY_MS, MILLISECONDS));
1484 <        } catch (Throwable t) {
1485 <            threadUnexpectedException(t);
1483 >            if (!latch.await(timeoutMillis, MILLISECONDS))
1484 >                fail("timed out waiting for CountDownLatch for "
1485 >                     + (timeoutMillis/1000) + " sec");
1486 >        } catch (Throwable fail) {
1487 >            threadUnexpectedException(fail);
1488          }
1489      }
1490  
1491 +    public void await(CountDownLatch latch) {
1492 +        await(latch, LONG_DELAY_MS);
1493 +    }
1494 +
1495      public void await(Semaphore semaphore) {
1496          try {
1497 <            assertTrue(semaphore.tryAcquire(LONG_DELAY_MS, MILLISECONDS));
1498 <        } catch (Throwable t) {
1499 <            threadUnexpectedException(t);
1497 >            if (!semaphore.tryAcquire(LONG_DELAY_MS, MILLISECONDS))
1498 >                fail("timed out waiting for Semaphore for "
1499 >                     + (LONG_DELAY_MS/1000) + " sec");
1500 >        } catch (Throwable fail) {
1501 >            threadUnexpectedException(fail);
1502          }
1503      }
1504  
# Line 1121 | Line 1689 | public class JSR166TestCase extends Test
1689      public abstract class CheckedRecursiveAction extends RecursiveAction {
1690          protected abstract void realCompute() throws Throwable;
1691  
1692 <        public final void compute() {
1692 >        @Override protected final void compute() {
1693              try {
1694                  realCompute();
1695 <            } catch (Throwable t) {
1696 <                threadUnexpectedException(t);
1695 >            } catch (Throwable fail) {
1696 >                threadUnexpectedException(fail);
1697              }
1698          }
1699      }
# Line 1136 | Line 1704 | public class JSR166TestCase extends Test
1704      public abstract class CheckedRecursiveTask<T> extends RecursiveTask<T> {
1705          protected abstract T realCompute() throws Throwable;
1706  
1707 <        public final T compute() {
1707 >        @Override protected final T compute() {
1708              try {
1709                  return realCompute();
1710 <            } catch (Throwable t) {
1711 <                threadUnexpectedException(t);
1710 >            } catch (Throwable fail) {
1711 >                threadUnexpectedException(fail);
1712                  return null;
1713              }
1714          }
# Line 1164 | Line 1732 | public class JSR166TestCase extends Test
1732          public int await() {
1733              try {
1734                  return super.await(2 * LONG_DELAY_MS, MILLISECONDS);
1735 <            } catch (TimeoutException e) {
1735 >            } catch (TimeoutException timedOut) {
1736                  throw new AssertionFailedError("timed out");
1737 <            } catch (Exception e) {
1737 >            } catch (Exception fail) {
1738                  AssertionFailedError afe =
1739 <                    new AssertionFailedError("Unexpected exception: " + e);
1740 <                afe.initCause(e);
1739 >                    new AssertionFailedError("Unexpected exception: " + fail);
1740 >                afe.initCause(fail);
1741                  throw afe;
1742              }
1743          }
# Line 1197 | Line 1765 | public class JSR166TestCase extends Test
1765                  q.remove();
1766                  shouldThrow();
1767              } catch (NoSuchElementException success) {}
1768 <        } catch (InterruptedException ie) {
1201 <            threadUnexpectedException(ie);
1202 <        }
1768 >        } catch (InterruptedException fail) { threadUnexpectedException(fail); }
1769      }
1770  
1771      void assertSerialEquals(Object x, Object y) {
# Line 1218 | Line 1784 | public class JSR166TestCase extends Test
1784              oos.flush();
1785              oos.close();
1786              return bos.toByteArray();
1787 <        } catch (Throwable t) {
1788 <            threadUnexpectedException(t);
1787 >        } catch (Throwable fail) {
1788 >            threadUnexpectedException(fail);
1789              return new byte[0];
1790          }
1791      }
# Line 1232 | Line 1798 | public class JSR166TestCase extends Test
1798              T clone = (T) ois.readObject();
1799              assertSame(o.getClass(), clone.getClass());
1800              return clone;
1801 <        } catch (Throwable t) {
1802 <            threadUnexpectedException(t);
1801 >        } catch (Throwable fail) {
1802 >            threadUnexpectedException(fail);
1803              return null;
1804          }
1805      }
1806 +
1807 +    public void assertThrows(Class<? extends Throwable> expectedExceptionClass,
1808 +                             Runnable... throwingActions) {
1809 +        for (Runnable throwingAction : throwingActions) {
1810 +            boolean threw = false;
1811 +            try { throwingAction.run(); }
1812 +            catch (Throwable t) {
1813 +                threw = true;
1814 +                if (!expectedExceptionClass.isInstance(t)) {
1815 +                    AssertionFailedError afe =
1816 +                        new AssertionFailedError
1817 +                        ("Expected " + expectedExceptionClass.getName() +
1818 +                         ", got " + t.getClass().getName());
1819 +                    afe.initCause(t);
1820 +                    threadUnexpectedException(afe);
1821 +                }
1822 +            }
1823 +            if (!threw)
1824 +                shouldThrow(expectedExceptionClass.getName());
1825 +        }
1826 +    }
1827 +
1828 +    public void assertIteratorExhausted(Iterator<?> it) {
1829 +        try {
1830 +            it.next();
1831 +            shouldThrow();
1832 +        } catch (NoSuchElementException success) {}
1833 +        assertFalse(it.hasNext());
1834 +    }
1835   }

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines