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.142 by jsr166, Tue Sep 8 16:53:43 2015 UTC vs.
Revision 1.162 by jsr166, Sun Oct 4 04:40:00 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 40 | Line 42 | import java.util.concurrent.CyclicBarrie
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 67 | 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 89 | 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 185 | 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();
203 <        long t0 = System.nanoTime();
204 <        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 455 | Line 484 | public class JSR166TestCase extends Test
484          } else {
485              return new TestSuite();
486          }
458
487      }
488  
489      // Delays for timing-dependent tests, in milliseconds.
# Line 513 | 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 520 | 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 547 | 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      }
# Line 556 | Line 593 | public class JSR166TestCase extends Test
593       * Finds missing try { ... } finally { joinPool(e); }
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 564 | 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",
570 <                                   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 582 | 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 728 | Line 768 | public class JSR166TestCase extends Test
768      }
769  
770      /**
771 +     * Allows use of try-with-resources with per-test thread pools.
772 +     */
773 +    class PoolCleaner implements AutoCloseable {
774 +        private final ExecutorService pool;
775 +        public PoolCleaner(ExecutorService pool) { this.pool = pool; }
776 +        public void close() { joinPool(pool); }
777 +    }
778 +
779 +    PoolCleaner cleaner(ExecutorService pool) {
780 +        return new PoolCleaner(pool);
781 +    }
782 +
783 +    /**
784       * Waits out termination of a thread pool or fails doing so.
785       */
786      void joinPool(ExecutorService pool) {
787          try {
788              pool.shutdown();
789 <            if (!pool.awaitTermination(2 * LONG_DELAY_MS, MILLISECONDS))
790 <                fail("ExecutorService " + pool +
791 <                     " did not terminate in a timely manner");
789 >            if (!pool.awaitTermination(2 * LONG_DELAY_MS, MILLISECONDS)) {
790 >                try {
791 >                    threadFail("ExecutorService " + pool +
792 >                               " did not terminate in a timely manner");
793 >                } finally {
794 >                    // last resort, for the benefit of subsequent tests
795 >                    pool.shutdownNow();
796 >                    pool.awaitTermination(SMALL_DELAY_MS, MILLISECONDS);
797 >                }
798 >            }
799          } catch (SecurityException ok) {
800              // Allowed in case test doesn't have privs
801          } catch (InterruptedException fail) {
802 <            fail("Unexpected InterruptedException");
802 >            threadFail("Unexpected InterruptedException");
803          }
804      }
805  
# Line 753 | Line 813 | public class JSR166TestCase extends Test
813       */
814      void testInParallel(Action ... actions) {
815          ExecutorService pool = Executors.newCachedThreadPool();
816 <        try {
816 >        try (PoolCleaner cleaner = cleaner(pool)) {
817              ArrayList<Future<?>> futures = new ArrayList<>(actions.length);
818              for (final Action action : actions)
819                  futures.add(pool.submit(new CheckedRunnable() {
# Line 766 | Line 826 | public class JSR166TestCase extends Test
826                  } catch (Exception ex) {
827                      threadUnexpectedException(ex);
828                  }
769        } finally {
770            joinPool(pool);
829          }
830      }
831  
832      /**
833 <     * A debugging tool to print all stack traces, as jstack does.
833 >     * A debugging tool to print stack traces of most threads, as jstack does.
834 >     * Uninteresting threads are filtered out.
835       */
836 <    static void printAllStackTraces() {
837 <        for (ThreadInfo info :
838 <                 ManagementFactory.getThreadMXBean()
839 <                 .dumpAllThreads(true, true))
836 >    static void dumpTestThreads() {
837 >        ThreadMXBean threadMXBean = ManagementFactory.getThreadMXBean();
838 >        System.err.println("------ stacktrace dump start ------");
839 >        for (ThreadInfo info : threadMXBean.dumpAllThreads(true, true)) {
840 >            String name = info.getThreadName();
841 >            if ("Signal Dispatcher".equals(name))
842 >                continue;
843 >            if ("Reference Handler".equals(name)
844 >                && info.getLockName().startsWith("java.lang.ref.Reference$Lock"))
845 >                continue;
846 >            if ("Finalizer".equals(name)
847 >                && info.getLockName().startsWith("java.lang.ref.ReferenceQueue$Lock"))
848 >                continue;
849 >            if ("checkForWedgedTest".equals(name))
850 >                continue;
851              System.err.print(info);
852 +        }
853 +        System.err.println("------ stacktrace dump end ------");
854      }
855  
856      /**
# Line 798 | Line 870 | public class JSR166TestCase extends Test
870              delay(millis);
871              assertTrue(thread.isAlive());
872          } catch (InterruptedException fail) {
873 <            fail("Unexpected InterruptedException");
873 >            threadFail("Unexpected InterruptedException");
874          }
875      }
876  
# Line 820 | Line 892 | public class JSR166TestCase extends Test
892              for (Thread thread : threads)
893                  assertTrue(thread.isAlive());
894          } catch (InterruptedException fail) {
895 <            fail("Unexpected InterruptedException");
895 >            threadFail("Unexpected InterruptedException");
896          }
897      }
898  
# Line 1223 | Line 1295 | public class JSR166TestCase extends Test
1295      public static final String TEST_STRING = "a test string";
1296  
1297      public static class StringTask implements Callable<String> {
1298 <        public String call() { return TEST_STRING; }
1298 >        final String value;
1299 >        public StringTask() { this(TEST_STRING); }
1300 >        public StringTask(String value) { this.value = value; }
1301 >        public String call() { return value; }
1302      }
1303  
1304      public Callable<String> latchAwaitingStringTask(final CountDownLatch latch) {
# Line 1236 | Line 1311 | public class JSR166TestCase extends Test
1311              }};
1312      }
1313  
1314 <    public Runnable awaiter(final CountDownLatch latch) {
1314 >    public Runnable countDowner(final CountDownLatch latch) {
1315          return new CheckedRunnable() {
1316              public void realRun() throws InterruptedException {
1317 <                await(latch);
1317 >                latch.countDown();
1318              }};
1319      }
1320  
1321 +    class LatchAwaiter extends CheckedRunnable {
1322 +        static final int NEW = 0;
1323 +        static final int RUNNING = 1;
1324 +        static final int DONE = 2;
1325 +        final CountDownLatch latch;
1326 +        int state = NEW;
1327 +        LatchAwaiter(CountDownLatch latch) { this.latch = latch; }
1328 +        public void realRun() throws InterruptedException {
1329 +            state = 1;
1330 +            await(latch);
1331 +            state = 2;
1332 +        }
1333 +    }
1334 +
1335 +    public LatchAwaiter awaiter(CountDownLatch latch) {
1336 +        return new LatchAwaiter(latch);
1337 +    }
1338 +
1339      public void await(CountDownLatch latch) {
1340          try {
1341              assertTrue(latch.await(LONG_DELAY_MS, MILLISECONDS));

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines