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.135 by jsr166, Fri Jul 3 05:48:30 2015 UTC vs.
Revision 1.164 by jsr166, Sun Oct 4 18:40:57 2015 UTC

# Line 7 | Line 7
7   */
8  
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;
# Line 15 | Line 16 | import java.io.ObjectInputStream;
16   import java.io.ObjectOutputStream;
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;
# Line 37 | Line 39 | import java.util.concurrent.BlockingQueu
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;
# Line 65 | Line 70 | import junit.framework.TestSuite;
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 87 | Line 92 | import junit.framework.TestSuite;
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>
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 183 | Line 188 | public class JSR166TestCase extends Test
188          return (regex == null) ? null : Pattern.compile(regex);
189      }
190  
191 <    protected void runTest() throws Throwable {
191 >    static volatile TestCase currentTestCase;
192 >    static {
193 >        Runnable checkForWedgedTest = new Runnable() { public void run() {
194 >            // avoid spurious reports with enormous runsPerTest
195 >            final int timeoutMinutes = Math.max(runsPerTest / 10, 1);
196 >            for (TestCase lastTestCase = currentTestCase;;) {
197 >                try { MINUTES.sleep(timeoutMinutes); }
198 >                catch (InterruptedException unexpected) { break; }
199 >                if (lastTestCase == currentTestCase) {
200 >                    System.err.println
201 >                        ("Looks like we're stuck running test: "
202 >                         + lastTestCase);
203 >                    dumpTestThreads();
204 >                }
205 >                lastTestCase = currentTestCase;
206 >            }}};
207 >        Thread thread = new Thread(checkForWedgedTest, "checkForWedgedTest");
208 >        thread.setDaemon(true);
209 >        thread.start();
210 >    }
211 >
212 >    public void runBare() throws Throwable {
213 >        currentTestCase = this;
214          if (methodFilter == null
215 <            || methodFilter.matcher(toString()).find()) {
216 <            for (int i = 0; i < runsPerTest; i++) {
217 <                if (profileTests)
218 <                    runTestProfiled();
219 <                else
220 <                    super.runTest();
221 <            }
215 >            || methodFilter.matcher(toString()).find())
216 >            super.runBare();
217 >    }
218 >
219 >    protected void runTest() throws Throwable {
220 >        for (int i = 0; i < runsPerTest; i++) {
221 >            if (profileTests)
222 >                runTestProfiled();
223 >            else
224 >                super.runTest();
225          }
226      }
227  
228      protected void runTestProfiled() throws Throwable {
229 <        // Warmup run, notably to trigger all needed classloading.
230 <        super.runTest();
201 <        long t0 = System.nanoTime();
202 <        try {
229 >        for (int i = 0; i < 2; i++) {
230 >            long startTime = System.nanoTime();
231              super.runTest();
232 <        } finally {
233 <            long elapsedMillis = millisElapsedSince(t0);
234 <            if (elapsedMillis >= profileThreshold)
232 >            long elapsedMillis = millisElapsedSince(startTime);
233 >            if (elapsedMillis < profileThreshold)
234 >                break;
235 >            // Never report first run of any test; treat it as a
236 >            // warmup run, notably to trigger all needed classloading,
237 >            if (i > 0)
238                  System.out.printf("%n%s: %d%n", toString(), elapsedMillis);
239          }
240      }
# Line 281 | Line 312 | public class JSR166TestCase extends Test
312      public static boolean atLeastJava6() { return JAVA_CLASS_VERSION >= 50.0; }
313      public static boolean atLeastJava7() { return JAVA_CLASS_VERSION >= 51.0; }
314      public static boolean atLeastJava8() { return JAVA_CLASS_VERSION >= 52.0; }
315 <    public static boolean atLeastJava9() { return JAVA_CLASS_VERSION >= 53.0; }
315 >    public static boolean atLeastJava9() {
316 >        return JAVA_CLASS_VERSION >= 53.0
317 >            // As of 2015-09, java9 still uses 52.0 class file version
318 >            || JAVA_SPECIFICATION_VERSION.matches("^(1\\.)?(9|[0-9][0-9])$");
319 >    }
320 >    public static boolean atLeastJava10() {
321 >        return JAVA_CLASS_VERSION >= 54.0
322 >            || JAVA_SPECIFICATION_VERSION.matches("^(1\\.)?[0-9][0-9]$");
323 >    }
324  
325      /**
326       * Collects all JSR166 unit tests as one suite.
# Line 369 | Line 408 | public class JSR166TestCase extends Test
408                  "LongAdderTest",
409                  "SplittableRandomTest",
410                  "StampedLockTest",
411 +                "SubmissionPublisherTest",
412                  "ThreadLocalRandom8Test",
413              };
414              addNamedTestClasses(suite, java8TestClassNames);
# Line 377 | Line 417 | public class JSR166TestCase extends Test
417          // Java9+ test classes
418          if (atLeastJava9()) {
419              String[] java9TestClassNames = {
420 <                "ThreadPoolExecutor9Test",
420 >                // Currently empty, but expecting varhandle tests
421              };
422              addNamedTestClasses(suite, java9TestClassNames);
423          }
# Line 444 | Line 484 | public class JSR166TestCase extends Test
484          } else {
485              return new TestSuite();
486          }
447
487      }
488  
489      // Delays for timing-dependent tests, in milliseconds.
# Line 502 | Line 541 | public class JSR166TestCase extends Test
541       * the same test have no effect.
542       */
543      public void threadRecordFailure(Throwable t) {
544 +        System.err.println(t);
545 +        dumpTestThreads();
546          threadFailure.compareAndSet(null, t);
547      }
548  
# Line 509 | Line 550 | public class JSR166TestCase extends Test
550          setDelays();
551      }
552  
553 +    void tearDownFail(String format, Object... args) {
554 +        String msg = toString() + ": " + String.format(format, args);
555 +        System.err.println(msg);
556 +        dumpTestThreads();
557 +        throw new AssertionFailedError(msg);
558 +    }
559 +
560      /**
561       * Extra checks that get done for all test cases.
562       *
# Line 536 | Line 584 | public class JSR166TestCase extends Test
584          }
585  
586          if (Thread.interrupted())
587 <            throw new AssertionFailedError("interrupt status set in main thread");
587 >            tearDownFail("interrupt status set in main thread");
588  
589          checkForkJoinPoolThreadLeaks();
590      }
591  
592      /**
593 <     * Finds missing try { ... } finally { joinPool(e); }
593 >     * Finds missing PoolCleaners
594       */
595      void checkForkJoinPoolThreadLeaks() throws InterruptedException {
596 <        Thread[] survivors = new Thread[5];
596 >        Thread[] survivors = new Thread[7];
597          int count = Thread.enumerate(survivors);
598          for (int i = 0; i < count; i++) {
599              Thread thread = survivors[i];
# Line 553 | Line 601 | public class JSR166TestCase extends Test
601              if (name.startsWith("ForkJoinPool-")) {
602                  // give thread some time to terminate
603                  thread.join(LONG_DELAY_MS);
604 <                if (!thread.isAlive()) continue;
605 <                throw new AssertionFailedError
606 <                    (String.format("Found leaked ForkJoinPool thread test=%s thread=%s%n",
559 <                                   toString(), name));
604 >                if (thread.isAlive())
605 >                    tearDownFail("Found leaked ForkJoinPool thread thread=%s",
606 >                                 thread);
607              }
608          }
609 +
610 +        if (!ForkJoinPool.commonPool()
611 +            .awaitQuiescence(LONG_DELAY_MS, MILLISECONDS))
612 +            tearDownFail("ForkJoin common pool thread stuck");
613      }
614  
615      /**
# Line 571 | Line 622 | public class JSR166TestCase extends Test
622              fail(reason);
623          } catch (AssertionFailedError t) {
624              threadRecordFailure(t);
625 <            fail(reason);
625 >            throw t;
626          }
627      }
628  
# Line 698 | Line 749 | public class JSR166TestCase extends Test
749      /**
750       * Delays, via Thread.sleep, for the given millisecond delay, but
751       * if the sleep is shorter than specified, may re-sleep or yield
752 <     * until time elapses.
752 >     * until time elapses.  Ensures that the given time, as measured
753 >     * by System.nanoTime(), has elapsed.
754       */
755      static void delay(long millis) throws InterruptedException {
756 <        long startTime = System.nanoTime();
757 <        long ns = millis * 1000 * 1000;
758 <        for (;;) {
756 >        long nanos = millis * (1000 * 1000);
757 >        final long wakeupTime = System.nanoTime() + nanos;
758 >        do {
759              if (millis > 0L)
760                  Thread.sleep(millis);
761              else // too short to sleep
762                  Thread.yield();
763 <            long d = ns - (System.nanoTime() - startTime);
764 <            if (d > 0L)
765 <                millis = d / (1000 * 1000);
766 <            else
767 <                break;
768 <        }
763 >            nanos = wakeupTime - System.nanoTime();
764 >            millis = nanos / (1000 * 1000);
765 >        } while (nanos >= 0L);
766 >    }
767 >
768 >    /**
769 >     * Allows use of try-with-resources with per-test thread pools.
770 >     */
771 >    class PoolCleaner implements AutoCloseable {
772 >        private final ExecutorService pool;
773 >        public PoolCleaner(ExecutorService pool) { this.pool = pool; }
774 >        public void close() { joinPool(pool); }
775 >    }
776 >
777 >    PoolCleaner cleaner(ExecutorService pool) {
778 >        return new PoolCleaner(pool);
779      }
780  
781      /**
782       * Waits out termination of a thread pool or fails doing so.
783       */
784 <    void joinPool(ExecutorService exec) {
784 >    void joinPool(ExecutorService pool) {
785          try {
786 <            exec.shutdown();
787 <            if (!exec.awaitTermination(2 * LONG_DELAY_MS, MILLISECONDS))
788 <                fail("ExecutorService " + exec +
789 <                     " did not terminate in a timely manner");
786 >            pool.shutdown();
787 >            if (!pool.awaitTermination(2 * LONG_DELAY_MS, MILLISECONDS)) {
788 >                try {
789 >                    threadFail("ExecutorService " + pool +
790 >                               " did not terminate in a timely manner");
791 >                } finally {
792 >                    // last resort, for the benefit of subsequent tests
793 >                    pool.shutdownNow();
794 >                    pool.awaitTermination(SMALL_DELAY_MS, MILLISECONDS);
795 >                }
796 >            }
797          } catch (SecurityException ok) {
798              // Allowed in case test doesn't have privs
799          } catch (InterruptedException fail) {
800 <            fail("Unexpected InterruptedException");
800 >            threadFail("Unexpected InterruptedException");
801          }
802      }
803  
804 +    /** Like Runnable, but with the freedom to throw anything */
805 +    interface Action { public void run() throws Throwable; }
806 +
807      /**
808 <     * A debugging tool to print all stack traces, as jstack does.
808 >     * Runs all the given actions in parallel, failing if any fail.
809 >     * Useful for running multiple variants of tests that are
810 >     * necessarily individually slow because they must block.
811       */
812 <    static void printAllStackTraces() {
813 <        for (ThreadInfo info :
814 <                 ManagementFactory.getThreadMXBean()
815 <                 .dumpAllThreads(true, true))
812 >    void testInParallel(Action ... actions) {
813 >        ExecutorService pool = Executors.newCachedThreadPool();
814 >        try (PoolCleaner cleaner = cleaner(pool)) {
815 >            ArrayList<Future<?>> futures = new ArrayList<>(actions.length);
816 >            for (final Action action : actions)
817 >                futures.add(pool.submit(new CheckedRunnable() {
818 >                    public void realRun() throws Throwable { action.run();}}));
819 >            for (Future<?> future : futures)
820 >                try {
821 >                    assertNull(future.get(LONG_DELAY_MS, MILLISECONDS));
822 >                } catch (ExecutionException ex) {
823 >                    threadUnexpectedException(ex.getCause());
824 >                } catch (Exception ex) {
825 >                    threadUnexpectedException(ex);
826 >                }
827 >        }
828 >    }
829 >
830 >    /**
831 >     * A debugging tool to print stack traces of most threads, as jstack does.
832 >     * Uninteresting threads are filtered out.
833 >     */
834 >    static void dumpTestThreads() {
835 >        ThreadMXBean threadMXBean = ManagementFactory.getThreadMXBean();
836 >        System.err.println("------ stacktrace dump start ------");
837 >        for (ThreadInfo info : threadMXBean.dumpAllThreads(true, true)) {
838 >            String name = info.getThreadName();
839 >            if ("Signal Dispatcher".equals(name))
840 >                continue;
841 >            if ("Reference Handler".equals(name)
842 >                && info.getLockName().startsWith("java.lang.ref.Reference$Lock"))
843 >                continue;
844 >            if ("Finalizer".equals(name)
845 >                && info.getLockName().startsWith("java.lang.ref.ReferenceQueue$Lock"))
846 >                continue;
847 >            if ("checkForWedgedTest".equals(name))
848 >                continue;
849              System.err.print(info);
850 +        }
851 +        System.err.println("------ stacktrace dump end ------");
852      }
853  
854      /**
# Line 759 | Line 868 | public class JSR166TestCase extends Test
868              delay(millis);
869              assertTrue(thread.isAlive());
870          } catch (InterruptedException fail) {
871 <            fail("Unexpected InterruptedException");
871 >            threadFail("Unexpected InterruptedException");
872          }
873      }
874  
# Line 781 | Line 890 | public class JSR166TestCase extends Test
890              for (Thread thread : threads)
891                  assertTrue(thread.isAlive());
892          } catch (InterruptedException fail) {
893 <            fail("Unexpected InterruptedException");
893 >            threadFail("Unexpected InterruptedException");
894          }
895      }
896  
# Line 1184 | Line 1293 | public class JSR166TestCase extends Test
1293      public static final String TEST_STRING = "a test string";
1294  
1295      public static class StringTask implements Callable<String> {
1296 <        public String call() { return TEST_STRING; }
1296 >        final String value;
1297 >        public StringTask() { this(TEST_STRING); }
1298 >        public StringTask(String value) { this.value = value; }
1299 >        public String call() { return value; }
1300      }
1301  
1302      public Callable<String> latchAwaitingStringTask(final CountDownLatch latch) {
# Line 1197 | Line 1309 | public class JSR166TestCase extends Test
1309              }};
1310      }
1311  
1312 <    public Runnable awaiter(final CountDownLatch latch) {
1312 >    public Runnable countDowner(final CountDownLatch latch) {
1313          return new CheckedRunnable() {
1314              public void realRun() throws InterruptedException {
1315 <                await(latch);
1315 >                latch.countDown();
1316              }};
1317      }
1318  
1319 +    class LatchAwaiter extends CheckedRunnable {
1320 +        static final int NEW = 0;
1321 +        static final int RUNNING = 1;
1322 +        static final int DONE = 2;
1323 +        final CountDownLatch latch;
1324 +        int state = NEW;
1325 +        LatchAwaiter(CountDownLatch latch) { this.latch = latch; }
1326 +        public void realRun() throws InterruptedException {
1327 +            state = 1;
1328 +            await(latch);
1329 +            state = 2;
1330 +        }
1331 +    }
1332 +
1333 +    public LatchAwaiter awaiter(CountDownLatch latch) {
1334 +        return new LatchAwaiter(latch);
1335 +    }
1336 +
1337      public void await(CountDownLatch latch) {
1338          try {
1339              assertTrue(latch.await(LONG_DELAY_MS, MILLISECONDS));

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines