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.138 by jsr166, Fri Sep 4 19:35:46 2015 UTC vs.
Revision 1.157 by jsr166, Sat Oct 3 22:20:05 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 377 | Line 408 | public class JSR166TestCase extends Test
408                  "LongAdderTest",
409                  "SplittableRandomTest",
410                  "StampedLockTest",
411 +                "SubmissionPublisherTest",
412                  "ThreadLocalRandom8Test",
413              };
414              addNamedTestClasses(suite, java8TestClassNames);
# Line 385 | Line 417 | public class JSR166TestCase extends Test
417          // Java9+ test classes
418          if (atLeastJava9()) {
419              String[] java9TestClassNames = {
420 <                // Currently empty
420 >                // Currently empty, but expecting varhandle tests
421              };
422              addNamedTestClasses(suite, java9TestClassNames);
423          }
# Line 452 | Line 484 | public class JSR166TestCase extends Test
484          } else {
485              return new TestSuite();
486          }
455
487      }
488  
489      // Delays for timing-dependent tests, in milliseconds.
# Line 510 | Line 541 | public class JSR166TestCase extends Test
541       * the same test have no effect.
542       */
543      public void threadRecordFailure(Throwable t) {
544 +        dumpTestThreads();
545          threadFailure.compareAndSet(null, t);
546      }
547  
# Line 517 | Line 549 | public class JSR166TestCase extends Test
549          setDelays();
550      }
551  
552 +    void tearDownFail(String format, Object... args) {
553 +        String msg = toString() + ": " + String.format(format, args);
554 +        System.err.println(msg);
555 +        dumpTestThreads();
556 +        throw new AssertionFailedError(msg);
557 +    }
558 +
559      /**
560       * Extra checks that get done for all test cases.
561       *
# Line 544 | Line 583 | public class JSR166TestCase extends Test
583          }
584  
585          if (Thread.interrupted())
586 <            throw new AssertionFailedError("interrupt status set in main thread");
586 >            tearDownFail("interrupt status set in main thread");
587  
588          checkForkJoinPoolThreadLeaks();
589      }
# Line 553 | Line 592 | public class JSR166TestCase extends Test
592       * Finds missing try { ... } finally { joinPool(e); }
593       */
594      void checkForkJoinPoolThreadLeaks() throws InterruptedException {
595 <        Thread[] survivors = new Thread[5];
595 >        Thread[] survivors = new Thread[7];
596          int count = Thread.enumerate(survivors);
597          for (int i = 0; i < count; i++) {
598              Thread thread = survivors[i];
# Line 561 | Line 600 | public class JSR166TestCase extends Test
600              if (name.startsWith("ForkJoinPool-")) {
601                  // give thread some time to terminate
602                  thread.join(LONG_DELAY_MS);
603 <                if (!thread.isAlive()) continue;
604 <                throw new AssertionFailedError
605 <                    (String.format("Found leaked ForkJoinPool thread test=%s thread=%s%n",
567 <                                   toString(), name));
603 >                if (thread.isAlive())
604 >                    tearDownFail("Found leaked ForkJoinPool thread thread=%s",
605 >                                 thread);
606              }
607          }
608 +
609 +        if (!ForkJoinPool.commonPool()
610 +            .awaitQuiescence(LONG_DELAY_MS, MILLISECONDS))
611 +            tearDownFail("ForkJoin common pool thread stuck");
612      }
613  
614      /**
# Line 579 | Line 621 | public class JSR166TestCase extends Test
621              fail(reason);
622          } catch (AssertionFailedError t) {
623              threadRecordFailure(t);
624 <            fail(reason);
624 >            throw t;
625          }
626      }
627  
# Line 725 | Line 767 | public class JSR166TestCase extends Test
767      }
768  
769      /**
770 +     * Allows use of try-with-resources with per-test thread pools.
771 +     */
772 +    static class PoolCloser<T extends ExecutorService>
773 +            implements AutoCloseable {
774 +        public final T pool;
775 +        public PoolCloser(T pool) { this.pool = pool; }
776 +        public void close() { joinPool(pool); }
777 +    }
778 +
779 +    /**
780       * Waits out termination of a thread pool or fails doing so.
781       */
782 <    void joinPool(ExecutorService exec) {
782 >    static void joinPool(ExecutorService pool) {
783          try {
784 <            exec.shutdown();
785 <            if (!exec.awaitTermination(2 * LONG_DELAY_MS, MILLISECONDS))
786 <                fail("ExecutorService " + exec +
784 >            pool.shutdown();
785 >            if (!pool.awaitTermination(2 * LONG_DELAY_MS, MILLISECONDS))
786 >                fail("ExecutorService " + pool +
787                       " did not terminate in a timely manner");
788          } catch (SecurityException ok) {
789              // Allowed in case test doesn't have privs
# Line 740 | Line 792 | public class JSR166TestCase extends Test
792          }
793      }
794  
795 +    /** Like Runnable, but with the freedom to throw anything */
796 +    interface Action { public void run() throws Throwable; }
797 +
798      /**
799 <     * A debugging tool to print all stack traces, as jstack does.
800 <     */
801 <    static void printAllStackTraces() {
802 <        for (ThreadInfo info :
803 <                 ManagementFactory.getThreadMXBean()
804 <                 .dumpAllThreads(true, true))
799 >     * Runs all the given actions in parallel, failing if any fail.
800 >     * Useful for running multiple variants of tests that are
801 >     * necessarily individually slow because they must block.
802 >     */
803 >    void testInParallel(Action ... actions) {
804 >        try (PoolCloser<ExecutorService> poolCloser
805 >             = new PoolCloser<>(Executors.newCachedThreadPool())) {
806 >            ExecutorService pool = poolCloser.pool;
807 >            ArrayList<Future<?>> futures = new ArrayList<>(actions.length);
808 >            for (final Action action : actions)
809 >                futures.add(pool.submit(new CheckedRunnable() {
810 >                    public void realRun() throws Throwable { action.run();}}));
811 >            for (Future<?> future : futures)
812 >                try {
813 >                    assertNull(future.get(LONG_DELAY_MS, MILLISECONDS));
814 >                } catch (ExecutionException ex) {
815 >                    threadUnexpectedException(ex.getCause());
816 >                } catch (Exception ex) {
817 >                    threadUnexpectedException(ex);
818 >                }
819 >        }
820 >    }
821 >
822 >    /**
823 >     * A debugging tool to print stack traces of most threads, as jstack does.
824 >     * Uninteresting threads are filtered out.
825 >     */
826 >    static void dumpTestThreads() {
827 >        ThreadMXBean threadMXBean = ManagementFactory.getThreadMXBean();
828 >        System.err.println("------ stacktrace dump start ------");
829 >        for (ThreadInfo info : threadMXBean.dumpAllThreads(true, true)) {
830 >            String name = info.getThreadName();
831 >            if ("Signal Dispatcher".equals(name))
832 >                continue;
833 >            if ("Reference Handler".equals(name)
834 >                && info.getLockName().startsWith("java.lang.ref.Reference$Lock"))
835 >                continue;
836 >            if ("Finalizer".equals(name)
837 >                && info.getLockName().startsWith("java.lang.ref.ReferenceQueue$Lock"))
838 >                continue;
839 >            if ("checkForWedgedTest".equals(name))
840 >                continue;
841              System.err.print(info);
842 +        }
843 +        System.err.println("------ stacktrace dump end ------");
844      }
845  
846      /**
# Line 1192 | Line 1285 | public class JSR166TestCase extends Test
1285      public static final String TEST_STRING = "a test string";
1286  
1287      public static class StringTask implements Callable<String> {
1288 <        public String call() { return TEST_STRING; }
1288 >        final String value;
1289 >        public StringTask() { this(TEST_STRING); }
1290 >        public StringTask(String value) { this.value = value; }
1291 >        public String call() { return value; }
1292      }
1293  
1294      public Callable<String> latchAwaitingStringTask(final CountDownLatch latch) {
# Line 1205 | Line 1301 | public class JSR166TestCase extends Test
1301              }};
1302      }
1303  
1304 +    public Runnable countDowner(final CountDownLatch latch) {
1305 +        return new CheckedRunnable() {
1306 +            public void realRun() throws InterruptedException {
1307 +                latch.countDown();
1308 +            }};
1309 +    }
1310 +
1311      public Runnable awaiter(final CountDownLatch latch) {
1312          return new CheckedRunnable() {
1313              public void realRun() throws InterruptedException {

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines