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.156 by jsr166, Sat Oct 3 21:09:42 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 >            for (TestCase lastTestCase = currentTestCase;;) {
195 >                try { MINUTES.sleep(10); }
196 >                catch (InterruptedException unexpected) { break; }
197 >                if (lastTestCase == currentTestCase) {
198 >                    System.err.println
199 >                        ("Looks like we're stuck running test: "
200 >                         + lastTestCase);
201 >                    dumpTestThreads();
202 >                }
203 >                lastTestCase = currentTestCase;
204 >            }}};
205 >        Thread thread = new Thread(checkForWedgedTest, "checkForWedgedTest");
206 >        thread.setDaemon(true);
207 >        thread.start();
208 >    }
209 >
210 >    public void runBare() throws Throwable {
211 >        currentTestCase = this;
212          if (methodFilter == null
213 <            || methodFilter.matcher(toString()).find()) {
214 <            for (int i = 0; i < runsPerTest; i++) {
215 <                if (profileTests)
216 <                    runTestProfiled();
217 <                else
218 <                    super.runTest();
219 <            }
213 >            || methodFilter.matcher(toString()).find())
214 >            super.runBare();
215 >    }
216 >
217 >    protected void runTest() throws Throwable {
218 >        for (int i = 0; i < runsPerTest; i++) {
219 >            if (profileTests)
220 >                runTestProfiled();
221 >            else
222 >                super.runTest();
223          }
224      }
225  
226      protected void runTestProfiled() throws Throwable {
227 <        // Warmup run, notably to trigger all needed classloading.
228 <        super.runTest();
201 <        long t0 = System.nanoTime();
202 <        try {
227 >        for (int i = 0; i < 2; i++) {
228 >            long startTime = System.nanoTime();
229              super.runTest();
230 <        } finally {
231 <            long elapsedMillis = millisElapsedSince(t0);
232 <            if (elapsedMillis >= profileThreshold)
230 >            long elapsedMillis = millisElapsedSince(startTime);
231 >            if (elapsedMillis < profileThreshold)
232 >                break;
233 >            // Never report first run of any test; treat it as a
234 >            // warmup run, notably to trigger all needed classloading,
235 >            if (i > 0)
236                  System.out.printf("%n%s: %d%n", toString(), elapsedMillis);
237          }
238      }
# Line 377 | Line 406 | public class JSR166TestCase extends Test
406                  "LongAdderTest",
407                  "SplittableRandomTest",
408                  "StampedLockTest",
409 +                "SubmissionPublisherTest",
410                  "ThreadLocalRandom8Test",
411              };
412              addNamedTestClasses(suite, java8TestClassNames);
# Line 385 | Line 415 | public class JSR166TestCase extends Test
415          // Java9+ test classes
416          if (atLeastJava9()) {
417              String[] java9TestClassNames = {
418 <                // Currently empty
418 >                // Currently empty, but expecting varhandle tests
419              };
420              addNamedTestClasses(suite, java9TestClassNames);
421          }
# Line 452 | Line 482 | public class JSR166TestCase extends Test
482          } else {
483              return new TestSuite();
484          }
455
485      }
486  
487      // Delays for timing-dependent tests, in milliseconds.
# Line 510 | Line 539 | public class JSR166TestCase extends Test
539       * the same test have no effect.
540       */
541      public void threadRecordFailure(Throwable t) {
542 +        dumpTestThreads();
543          threadFailure.compareAndSet(null, t);
544      }
545  
# Line 517 | Line 547 | public class JSR166TestCase extends Test
547          setDelays();
548      }
549  
550 +    void tearDownFail(String format, Object... args) {
551 +        String msg = toString() + ": " + String.format(format, args);
552 +        System.err.println(msg);
553 +        dumpTestThreads();
554 +        throw new AssertionFailedError(msg);
555 +    }
556 +
557      /**
558       * Extra checks that get done for all test cases.
559       *
# Line 544 | Line 581 | public class JSR166TestCase extends Test
581          }
582  
583          if (Thread.interrupted())
584 <            throw new AssertionFailedError("interrupt status set in main thread");
584 >            tearDownFail("interrupt status set in main thread");
585  
586          checkForkJoinPoolThreadLeaks();
587      }
# Line 553 | Line 590 | public class JSR166TestCase extends Test
590       * Finds missing try { ... } finally { joinPool(e); }
591       */
592      void checkForkJoinPoolThreadLeaks() throws InterruptedException {
593 <        Thread[] survivors = new Thread[5];
593 >        Thread[] survivors = new Thread[7];
594          int count = Thread.enumerate(survivors);
595          for (int i = 0; i < count; i++) {
596              Thread thread = survivors[i];
# Line 561 | Line 598 | public class JSR166TestCase extends Test
598              if (name.startsWith("ForkJoinPool-")) {
599                  // give thread some time to terminate
600                  thread.join(LONG_DELAY_MS);
601 <                if (!thread.isAlive()) continue;
602 <                throw new AssertionFailedError
603 <                    (String.format("Found leaked ForkJoinPool thread test=%s thread=%s%n",
567 <                                   toString(), name));
601 >                if (thread.isAlive())
602 >                    tearDownFail("Found leaked ForkJoinPool thread thread=%s",
603 >                                 thread);
604              }
605          }
606 +
607 +        if (!ForkJoinPool.commonPool()
608 +            .awaitQuiescence(LONG_DELAY_MS, MILLISECONDS))
609 +            tearDownFail("ForkJoin common pool thread stuck");
610      }
611  
612      /**
# Line 579 | Line 619 | public class JSR166TestCase extends Test
619              fail(reason);
620          } catch (AssertionFailedError t) {
621              threadRecordFailure(t);
622 <            fail(reason);
622 >            throw t;
623          }
624      }
625  
# Line 725 | Line 765 | public class JSR166TestCase extends Test
765      }
766  
767      /**
768 +     * Allows use of try-with-resources with per-test thread pools.
769 +     */
770 +    static class PoolCloser<T extends ExecutorService>
771 +            implements AutoCloseable {
772 +        public final T pool;
773 +        public PoolCloser(T pool) { this.pool = pool; }
774 +        public void close() { joinPool(pool); }
775 +    }
776 +
777 +    /**
778       * Waits out termination of a thread pool or fails doing so.
779       */
780 <    void joinPool(ExecutorService exec) {
780 >    static void joinPool(ExecutorService pool) {
781          try {
782 <            exec.shutdown();
783 <            if (!exec.awaitTermination(2 * LONG_DELAY_MS, MILLISECONDS))
784 <                fail("ExecutorService " + exec +
782 >            pool.shutdown();
783 >            if (!pool.awaitTermination(2 * LONG_DELAY_MS, MILLISECONDS))
784 >                fail("ExecutorService " + pool +
785                       " did not terminate in a timely manner");
786          } catch (SecurityException ok) {
787              // Allowed in case test doesn't have privs
# Line 740 | Line 790 | public class JSR166TestCase extends Test
790          }
791      }
792  
793 +    /** Like Runnable, but with the freedom to throw anything */
794 +    interface Action { public void run() throws Throwable; }
795 +
796      /**
797 <     * A debugging tool to print all stack traces, as jstack does.
798 <     */
799 <    static void printAllStackTraces() {
800 <        for (ThreadInfo info :
801 <                 ManagementFactory.getThreadMXBean()
802 <                 .dumpAllThreads(true, true))
797 >     * Runs all the given actions in parallel, failing if any fail.
798 >     * Useful for running multiple variants of tests that are
799 >     * necessarily individually slow because they must block.
800 >     */
801 >    void testInParallel(Action ... actions) {
802 >        try (PoolCloser<ExecutorService> poolCloser
803 >             = new PoolCloser<>(Executors.newCachedThreadPool())) {
804 >            ExecutorService pool = poolCloser.pool;
805 >            ArrayList<Future<?>> futures = new ArrayList<>(actions.length);
806 >            for (final Action action : actions)
807 >                futures.add(pool.submit(new CheckedRunnable() {
808 >                    public void realRun() throws Throwable { action.run();}}));
809 >            for (Future<?> future : futures)
810 >                try {
811 >                    assertNull(future.get(LONG_DELAY_MS, MILLISECONDS));
812 >                } catch (ExecutionException ex) {
813 >                    threadUnexpectedException(ex.getCause());
814 >                } catch (Exception ex) {
815 >                    threadUnexpectedException(ex);
816 >                }
817 >        }
818 >    }
819 >
820 >    /**
821 >     * A debugging tool to print stack traces of most threads, as jstack does.
822 >     * Uninteresting threads are filtered out.
823 >     */
824 >    static void dumpTestThreads() {
825 >        ThreadMXBean threadMXBean = ManagementFactory.getThreadMXBean();
826 >        System.err.println("------ stacktrace dump start ------");
827 >        for (ThreadInfo info : threadMXBean.dumpAllThreads(true, true)) {
828 >            String name = info.getThreadName();
829 >            if ("Signal Dispatcher".equals(name))
830 >                continue;
831 >            if ("Reference Handler".equals(name)
832 >                && info.getLockName().startsWith("java.lang.ref.Reference$Lock"))
833 >                continue;
834 >            if ("Finalizer".equals(name)
835 >                && info.getLockName().startsWith("java.lang.ref.ReferenceQueue$Lock"))
836 >                continue;
837 >            if ("checkForWedgedTest".equals(name))
838 >                continue;
839              System.err.print(info);
840 +        }
841 +        System.err.println("------ stacktrace dump end ------");
842      }
843  
844      /**
# Line 1192 | Line 1283 | public class JSR166TestCase extends Test
1283      public static final String TEST_STRING = "a test string";
1284  
1285      public static class StringTask implements Callable<String> {
1286 <        public String call() { return TEST_STRING; }
1286 >        final String value;
1287 >        public StringTask() { this(TEST_STRING); }
1288 >        public StringTask(String value) { this.value = value; }
1289 >        public String call() { return value; }
1290      }
1291  
1292      public Callable<String> latchAwaitingStringTask(final CountDownLatch latch) {
# Line 1205 | Line 1299 | public class JSR166TestCase extends Test
1299              }};
1300      }
1301  
1302 +    public Runnable countDowner(final CountDownLatch latch) {
1303 +        return new CheckedRunnable() {
1304 +            public void realRun() throws InterruptedException {
1305 +                latch.countDown();
1306 +            }};
1307 +    }
1308 +
1309      public Runnable awaiter(final CountDownLatch latch) {
1310          return new CheckedRunnable() {
1311              public void realRun() throws InterruptedException {

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines