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.141 by jsr166, Tue Sep 8 16:49:16 2015 UTC vs.
Revision 1.178 by jsr166, Fri Oct 23 17:34:47 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;
23 + import java.nio.file.Files;
24 + import java.nio.file.Paths;
25   import java.security.CodeSource;
26   import java.security.Permission;
27   import java.security.PermissionCollection;
# Line 40 | Line 44 | import java.util.concurrent.CyclicBarrie
44   import java.util.concurrent.ExecutionException;
45   import java.util.concurrent.Executors;
46   import java.util.concurrent.ExecutorService;
47 + import java.util.concurrent.ForkJoinPool;
48   import java.util.concurrent.Future;
49   import java.util.concurrent.RecursiveAction;
50   import java.util.concurrent.RecursiveTask;
# Line 49 | Line 54 | import java.util.concurrent.ThreadFactor
54   import java.util.concurrent.ThreadPoolExecutor;
55   import java.util.concurrent.TimeoutException;
56   import java.util.concurrent.atomic.AtomicReference;
57 + import java.util.regex.Matcher;
58   import java.util.regex.Pattern;
59  
60   import junit.framework.AssertionFailedError;
# Line 67 | Line 73 | import junit.framework.TestSuite;
73   *
74   * <ol>
75   *
76 < * <li> All assertions in code running in generated threads must use
76 > * <li>All assertions in code running in generated threads must use
77   * the forms {@link #threadFail}, {@link #threadAssertTrue}, {@link
78   * #threadAssertEquals}, or {@link #threadAssertNull}, (not
79   * {@code fail}, {@code assertTrue}, etc.) It is OK (but not
80   * particularly recommended) for other code to use these forms too.
81   * Only the most typically used JUnit assertion methods are defined
82 < * this way, but enough to live with.</li>
82 > * this way, but enough to live with.
83   *
84 < * <li> If you override {@link #setUp} or {@link #tearDown}, make sure
84 > * <li>If you override {@link #setUp} or {@link #tearDown}, make sure
85   * to invoke {@code super.setUp} and {@code super.tearDown} within
86   * them. These methods are used to clear and check for thread
87 < * assertion failures.</li>
87 > * assertion failures.
88   *
89   * <li>All delays and timeouts must use one of the constants {@code
90   * SHORT_DELAY_MS}, {@code SMALL_DELAY_MS}, {@code MEDIUM_DELAY_MS},
# Line 89 | Line 95 | import junit.framework.TestSuite;
95   * is always discriminable as larger than SHORT and smaller than
96   * MEDIUM.  And so on. These constants are set to conservative values,
97   * but even so, if there is ever any doubt, they can all be increased
98 < * in one spot to rerun tests on slower platforms.</li>
98 > * in one spot to rerun tests on slower platforms.
99   *
100 < * <li> All threads generated must be joined inside each test case
100 > * <li>All threads generated must be joined inside each test case
101   * method (or {@code fail} to do so) before returning from the
102   * method. The {@code joinPool} method can be used to do this when
103 < * using Executors.</li>
103 > * using Executors.
104   *
105   * </ol>
106   *
107   * <p><b>Other notes</b>
108   * <ul>
109   *
110 < * <li> Usually, there is one testcase method per JSR166 method
110 > * <li>Usually, there is one testcase method per JSR166 method
111   * covering "normal" operation, and then as many exception-testing
112   * methods as there are exceptions the method can throw. Sometimes
113   * there are multiple tests per JSR166 method when the different
114   * "normal" behaviors differ significantly. And sometimes testcases
115   * cover multiple methods when they cannot be tested in
116 < * isolation.</li>
116 > * isolation.
117   *
118 < * <li> The documentation style for testcases is to provide as javadoc
118 > * <li>The documentation style for testcases is to provide as javadoc
119   * a simple sentence or two describing the property that the testcase
120   * method purports to test. The javadocs do not say anything about how
121 < * the property is tested. To find out, read the code.</li>
121 > * the property is tested. To find out, read the code.
122   *
123 < * <li> These tests are "conformance tests", and do not attempt to
123 > * <li>These tests are "conformance tests", and do not attempt to
124   * test throughput, latency, scalability or other performance factors
125   * (see the separate "jtreg" tests for a set intended to check these
126   * for the most central aspects of functionality.) So, most tests use
127   * the smallest sensible numbers of threads, collection sizes, etc
128 < * needed to check basic conformance.</li>
128 > * needed to check basic conformance.
129   *
130   * <li>The test classes currently do not declare inclusion in
131   * any particular package to simplify things for people integrating
132 < * them in TCK test suites.</li>
132 > * them in TCK test suites.
133   *
134 < * <li> As a convenience, the {@code main} of this class (JSR166TestCase)
135 < * runs all JSR166 unit tests.</li>
134 > * <li>As a convenience, the {@code main} of this class (JSR166TestCase)
135 > * runs all JSR166 unit tests.
136   *
137   * </ul>
138   */
# Line 185 | Line 191 | public class JSR166TestCase extends Test
191          return (regex == null) ? null : Pattern.compile(regex);
192      }
193  
194 <    protected void runTest() throws Throwable {
194 >    // Instrumentation to debug very rare, but very annoying hung test runs.
195 >    static volatile TestCase currentTestCase;
196 >    // static volatile int currentRun = 0;
197 >    static {
198 >        Runnable checkForWedgedTest = new Runnable() { public void run() {
199 >            // Avoid spurious reports with enormous runsPerTest.
200 >            // A single test case run should never take more than 1 second.
201 >            // But let's cap it at the high end too ...
202 >            final int timeoutMinutes =
203 >                Math.min(15, Math.max(runsPerTest / 60, 1));
204 >            for (TestCase lastTestCase = currentTestCase;;) {
205 >                try { MINUTES.sleep(timeoutMinutes); }
206 >                catch (InterruptedException unexpected) { break; }
207 >                if (lastTestCase == currentTestCase) {
208 >                    System.err.printf(
209 >                        "Looks like we're stuck running test: %s%n",
210 >                        lastTestCase);
211 > //                     System.err.printf(
212 > //                         "Looks like we're stuck running test: %s (%d/%d)%n",
213 > //                         lastTestCase, currentRun, runsPerTest);
214 > //                     System.err.println("availableProcessors=" +
215 > //                         Runtime.getRuntime().availableProcessors());
216 > //                     System.err.printf("cpu model = %s%n", cpuModel());
217 >                    dumpTestThreads();
218 >                    // one stack dump is probably enough; more would be spam
219 >                    break;
220 >                }
221 >                lastTestCase = currentTestCase;
222 >            }}};
223 >        Thread thread = new Thread(checkForWedgedTest, "checkForWedgedTest");
224 >        thread.setDaemon(true);
225 >        thread.start();
226 >    }
227 >
228 > //     public static String cpuModel() {
229 > //         try {
230 > //             Matcher matcher = Pattern.compile("model name\\s*: (.*)")
231 > //                 .matcher(new String(
232 > //                      Files.readAllBytes(Paths.get("/proc/cpuinfo")), "UTF-8"));
233 > //             matcher.find();
234 > //             return matcher.group(1);
235 > //         } catch (Exception ex) { return null; }
236 > //     }
237 >
238 >    public void runBare() throws Throwable {
239 >        currentTestCase = this;
240          if (methodFilter == null
241 <            || methodFilter.matcher(toString()).find()) {
242 <            for (int i = 0; i < runsPerTest; i++) {
243 <                if (profileTests)
244 <                    runTestProfiled();
245 <                else
246 <                    super.runTest();
247 <            }
241 >            || methodFilter.matcher(toString()).find())
242 >            super.runBare();
243 >    }
244 >
245 >    protected void runTest() throws Throwable {
246 >        for (int i = 0; i < runsPerTest; i++) {
247 >            // currentRun = i;
248 >            if (profileTests)
249 >                runTestProfiled();
250 >            else
251 >                super.runTest();
252          }
253      }
254  
255      protected void runTestProfiled() throws Throwable {
256 <        // Warmup run, notably to trigger all needed classloading.
257 <        super.runTest();
203 <        long t0 = System.nanoTime();
204 <        try {
256 >        for (int i = 0; i < 2; i++) {
257 >            long startTime = System.nanoTime();
258              super.runTest();
259 <        } finally {
260 <            long elapsedMillis = millisElapsedSince(t0);
261 <            if (elapsedMillis >= profileThreshold)
259 >            long elapsedMillis = millisElapsedSince(startTime);
260 >            if (elapsedMillis < profileThreshold)
261 >                break;
262 >            // Never report first run of any test; treat it as a
263 >            // warmup run, notably to trigger all needed classloading,
264 >            if (i > 0)
265                  System.out.printf("%n%s: %d%n", toString(), elapsedMillis);
266          }
267      }
# Line 217 | Line 273 | public class JSR166TestCase extends Test
273          main(suite(), args);
274      }
275  
276 +    static class PithyResultPrinter extends junit.textui.ResultPrinter {
277 +        PithyResultPrinter(java.io.PrintStream writer) { super(writer); }
278 +        long runTime;
279 +        public void startTest(Test test) {}
280 +        protected void printHeader(long runTime) {
281 +            this.runTime = runTime; // defer printing for later
282 +        }
283 +        protected void printFooter(TestResult result) {
284 +            if (result.wasSuccessful()) {
285 +                getWriter().println("OK (" + result.runCount() + " tests)"
286 +                    + "  Time: " + elapsedTimeAsString(runTime));
287 +            } else {
288 +                getWriter().println("Time: " + elapsedTimeAsString(runTime));
289 +                super.printFooter(result);
290 +            }
291 +        }
292 +    }
293 +
294 +    /**
295 +     * Returns a TestRunner that doesn't bother with unnecessary
296 +     * fluff, like printing a "." for each test case.
297 +     */
298 +    static junit.textui.TestRunner newPithyTestRunner() {
299 +        junit.textui.TestRunner runner = new junit.textui.TestRunner();
300 +        runner.setPrinter(new PithyResultPrinter(System.out));
301 +        return runner;
302 +    }
303 +
304      /**
305       * Runs all unit tests in the given test suite.
306       * Actual behavior influenced by jsr166.* system properties.
# Line 228 | Line 312 | public class JSR166TestCase extends Test
312              System.setSecurityManager(new SecurityManager());
313          }
314          for (int i = 0; i < suiteRuns; i++) {
315 <            TestResult result = junit.textui.TestRunner.run(suite);
315 >            TestResult result = newPithyTestRunner().doRun(suite);
316              if (!result.wasSuccessful())
317                  System.exit(1);
318              System.gc();
# Line 388 | Line 472 | public class JSR166TestCase extends Test
472          // Java9+ test classes
473          if (atLeastJava9()) {
474              String[] java9TestClassNames = {
475 <                // Currently empty
475 >                // Currently empty, but expecting varhandle tests
476              };
477              addNamedTestClasses(suite, java9TestClassNames);
478          }
# Line 455 | Line 539 | public class JSR166TestCase extends Test
539          } else {
540              return new TestSuite();
541          }
458
542      }
543  
544      // Delays for timing-dependent tests, in milliseconds.
# Line 513 | Line 596 | public class JSR166TestCase extends Test
596       * the same test have no effect.
597       */
598      public void threadRecordFailure(Throwable t) {
599 +        System.err.println(t);
600 +        dumpTestThreads();
601          threadFailure.compareAndSet(null, t);
602      }
603  
# Line 520 | Line 605 | public class JSR166TestCase extends Test
605          setDelays();
606      }
607  
608 +    void tearDownFail(String format, Object... args) {
609 +        String msg = toString() + ": " + String.format(format, args);
610 +        System.err.println(msg);
611 +        dumpTestThreads();
612 +        throw new AssertionFailedError(msg);
613 +    }
614 +
615      /**
616       * Extra checks that get done for all test cases.
617       *
# Line 547 | Line 639 | public class JSR166TestCase extends Test
639          }
640  
641          if (Thread.interrupted())
642 <            throw new AssertionFailedError("interrupt status set in main thread");
642 >            tearDownFail("interrupt status set in main thread");
643  
644          checkForkJoinPoolThreadLeaks();
645      }
646  
647      /**
648 <     * Finds missing try { ... } finally { joinPool(e); }
648 >     * Finds missing PoolCleaners
649       */
650      void checkForkJoinPoolThreadLeaks() throws InterruptedException {
651 <        Thread[] survivors = new Thread[5];
651 >        Thread[] survivors = new Thread[7];
652          int count = Thread.enumerate(survivors);
653          for (int i = 0; i < count; i++) {
654              Thread thread = survivors[i];
# Line 564 | Line 656 | public class JSR166TestCase extends Test
656              if (name.startsWith("ForkJoinPool-")) {
657                  // give thread some time to terminate
658                  thread.join(LONG_DELAY_MS);
659 <                if (!thread.isAlive()) continue;
660 <                throw new AssertionFailedError
661 <                    (String.format("Found leaked ForkJoinPool thread test=%s thread=%s%n",
570 <                                   toString(), name));
659 >                if (thread.isAlive())
660 >                    tearDownFail("Found leaked ForkJoinPool thread thread=%s",
661 >                                 thread);
662              }
663          }
664 +
665 +        if (!ForkJoinPool.commonPool()
666 +            .awaitQuiescence(LONG_DELAY_MS, MILLISECONDS))
667 +            tearDownFail("ForkJoin common pool thread stuck");
668      }
669  
670      /**
# Line 582 | Line 677 | public class JSR166TestCase extends Test
677              fail(reason);
678          } catch (AssertionFailedError t) {
679              threadRecordFailure(t);
680 <            fail(reason);
680 >            throw t;
681          }
682      }
683  
# Line 709 | Line 804 | public class JSR166TestCase extends Test
804      /**
805       * Delays, via Thread.sleep, for the given millisecond delay, but
806       * if the sleep is shorter than specified, may re-sleep or yield
807 <     * until time elapses.
807 >     * until time elapses.  Ensures that the given time, as measured
808 >     * by System.nanoTime(), has elapsed.
809       */
810      static void delay(long millis) throws InterruptedException {
811 <        long startTime = System.nanoTime();
812 <        long ns = millis * 1000 * 1000;
813 <        for (;;) {
811 >        long nanos = millis * (1000 * 1000);
812 >        final long wakeupTime = System.nanoTime() + nanos;
813 >        do {
814              if (millis > 0L)
815                  Thread.sleep(millis);
816              else // too short to sleep
817                  Thread.yield();
818 <            long d = ns - (System.nanoTime() - startTime);
819 <            if (d > 0L)
820 <                millis = d / (1000 * 1000);
821 <            else
822 <                break;
818 >            nanos = wakeupTime - System.nanoTime();
819 >            millis = nanos / (1000 * 1000);
820 >        } while (nanos >= 0L);
821 >    }
822 >
823 >    /**
824 >     * Allows use of try-with-resources with per-test thread pools.
825 >     */
826 >    class PoolCleaner implements AutoCloseable {
827 >        private final ExecutorService pool;
828 >        public PoolCleaner(ExecutorService pool) { this.pool = pool; }
829 >        public void close() { joinPool(pool); }
830 >    }
831 >
832 >    /**
833 >     * An extension of PoolCleaner that has an action to release the pool.
834 >     */
835 >    class PoolCleanerWithReleaser extends PoolCleaner {
836 >        private final Runnable releaser;
837 >        public PoolCleanerWithReleaser(ExecutorService pool, Runnable releaser) {
838 >            super(pool);
839 >            this.releaser = releaser;
840 >        }
841 >        public void close() {
842 >            try {
843 >                releaser.run();
844 >            } finally {
845 >                super.close();
846 >            }
847          }
848      }
849  
850 +    PoolCleaner cleaner(ExecutorService pool) {
851 +        return new PoolCleaner(pool);
852 +    }
853 +
854 +    PoolCleaner cleaner(ExecutorService pool, Runnable releaser) {
855 +        return new PoolCleanerWithReleaser(pool, releaser);
856 +    }
857 +
858 +    PoolCleaner cleaner(ExecutorService pool, CountDownLatch latch) {
859 +        return new PoolCleanerWithReleaser(pool, releaser(latch));
860 +    }
861 +
862 +    Runnable releaser(final CountDownLatch latch) {
863 +        return new Runnable() { public void run() {
864 +            do { latch.countDown(); }
865 +            while (latch.getCount() > 0);
866 +        }};
867 +    }
868 +
869      /**
870       * Waits out termination of a thread pool or fails doing so.
871       */
872      void joinPool(ExecutorService pool) {
873          try {
874              pool.shutdown();
875 <            if (!pool.awaitTermination(2 * LONG_DELAY_MS, MILLISECONDS))
876 <                fail("ExecutorService " + pool +
877 <                     " did not terminate in a timely manner");
875 >            if (!pool.awaitTermination(2 * LONG_DELAY_MS, MILLISECONDS)) {
876 >                try {
877 >                    threadFail("ExecutorService " + pool +
878 >                               " did not terminate in a timely manner");
879 >                } finally {
880 >                    // last resort, for the benefit of subsequent tests
881 >                    pool.shutdownNow();
882 >                    pool.awaitTermination(MEDIUM_DELAY_MS, MILLISECONDS);
883 >                }
884 >            }
885          } catch (SecurityException ok) {
886              // Allowed in case test doesn't have privs
887          } catch (InterruptedException fail) {
888 <            fail("Unexpected InterruptedException");
888 >            threadFail("Unexpected InterruptedException");
889          }
890      }
891  
# Line 753 | Line 899 | public class JSR166TestCase extends Test
899       */
900      void testInParallel(Action ... actions) {
901          ExecutorService pool = Executors.newCachedThreadPool();
902 <        try {
902 >        try (PoolCleaner cleaner = cleaner(pool)) {
903              ArrayList<Future<?>> futures = new ArrayList<>(actions.length);
904              for (final Action action : actions)
905                  futures.add(pool.submit(new CheckedRunnable() {
# Line 766 | Line 912 | public class JSR166TestCase extends Test
912                  } catch (Exception ex) {
913                      threadUnexpectedException(ex);
914                  }
769        } finally {
770            joinPool(pool);
915          }
916      }
917  
918      /**
919 <     * A debugging tool to print all stack traces, as jstack does.
919 >     * A debugging tool to print stack traces of most threads, as jstack does.
920 >     * Uninteresting threads are filtered out.
921       */
922 <    static void printAllStackTraces() {
923 <        for (ThreadInfo info :
924 <                 ManagementFactory.getThreadMXBean()
925 <                 .dumpAllThreads(true, true))
922 >    static void dumpTestThreads() {
923 >        ThreadMXBean threadMXBean = ManagementFactory.getThreadMXBean();
924 >        System.err.println("------ stacktrace dump start ------");
925 >        for (ThreadInfo info : threadMXBean.dumpAllThreads(true, true)) {
926 >            String name = info.getThreadName();
927 >            if ("Signal Dispatcher".equals(name))
928 >                continue;
929 >            if ("Reference Handler".equals(name)
930 >                && info.getLockName().startsWith("java.lang.ref.Reference$Lock"))
931 >                continue;
932 >            if ("Finalizer".equals(name)
933 >                && info.getLockName().startsWith("java.lang.ref.ReferenceQueue$Lock"))
934 >                continue;
935 >            if ("checkForWedgedTest".equals(name))
936 >                continue;
937              System.err.print(info);
938 +        }
939 +        System.err.println("------ stacktrace dump end ------");
940      }
941  
942      /**
# Line 798 | Line 956 | public class JSR166TestCase extends Test
956              delay(millis);
957              assertTrue(thread.isAlive());
958          } catch (InterruptedException fail) {
959 <            fail("Unexpected InterruptedException");
959 >            threadFail("Unexpected InterruptedException");
960          }
961      }
962  
# Line 820 | Line 978 | public class JSR166TestCase extends Test
978              for (Thread thread : threads)
979                  assertTrue(thread.isAlive());
980          } catch (InterruptedException fail) {
981 <            fail("Unexpected InterruptedException");
981 >            threadFail("Unexpected InterruptedException");
982          }
983      }
984  
# Line 1098 | Line 1256 | public class JSR166TestCase extends Test
1256          } finally {
1257              if (t.getState() != Thread.State.TERMINATED) {
1258                  t.interrupt();
1259 <                fail("Test timed out");
1259 >                threadFail("timed out waiting for thread to terminate");
1260              }
1261          }
1262      }
# Line 1223 | Line 1381 | public class JSR166TestCase extends Test
1381      public static final String TEST_STRING = "a test string";
1382  
1383      public static class StringTask implements Callable<String> {
1384 <        public String call() { return TEST_STRING; }
1384 >        final String value;
1385 >        public StringTask() { this(TEST_STRING); }
1386 >        public StringTask(String value) { this.value = value; }
1387 >        public String call() { return value; }
1388      }
1389  
1390      public Callable<String> latchAwaitingStringTask(final CountDownLatch latch) {
# Line 1236 | Line 1397 | public class JSR166TestCase extends Test
1397              }};
1398      }
1399  
1400 <    public Runnable awaiter(final CountDownLatch latch) {
1400 >    public Runnable countDowner(final CountDownLatch latch) {
1401          return new CheckedRunnable() {
1402              public void realRun() throws InterruptedException {
1403 <                await(latch);
1403 >                latch.countDown();
1404              }};
1405      }
1406  
1407 +    class LatchAwaiter extends CheckedRunnable {
1408 +        static final int NEW = 0;
1409 +        static final int RUNNING = 1;
1410 +        static final int DONE = 2;
1411 +        final CountDownLatch latch;
1412 +        int state = NEW;
1413 +        LatchAwaiter(CountDownLatch latch) { this.latch = latch; }
1414 +        public void realRun() throws InterruptedException {
1415 +            state = 1;
1416 +            await(latch);
1417 +            state = 2;
1418 +        }
1419 +    }
1420 +
1421 +    public LatchAwaiter awaiter(CountDownLatch latch) {
1422 +        return new LatchAwaiter(latch);
1423 +    }
1424 +
1425      public void await(CountDownLatch latch) {
1426          try {
1427 <            assertTrue(latch.await(LONG_DELAY_MS, MILLISECONDS));
1427 >            if (!latch.await(LONG_DELAY_MS, MILLISECONDS))
1428 >                fail("timed out waiting for CountDownLatch for "
1429 >                     + (LONG_DELAY_MS/1000) + " sec");
1430          } catch (Throwable fail) {
1431              threadUnexpectedException(fail);
1432          }
# Line 1253 | Line 1434 | public class JSR166TestCase extends Test
1434  
1435      public void await(Semaphore semaphore) {
1436          try {
1437 <            assertTrue(semaphore.tryAcquire(LONG_DELAY_MS, MILLISECONDS));
1437 >            if (!semaphore.tryAcquire(LONG_DELAY_MS, MILLISECONDS))
1438 >                fail("timed out waiting for Semaphore for "
1439 >                     + (LONG_DELAY_MS/1000) + " sec");
1440          } catch (Throwable fail) {
1441              threadUnexpectedException(fail);
1442          }

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines