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.150 by jsr166, Sat Oct 3 19:08:13 2015 UTC vs.
Revision 1.197 by jsr166, Wed Jun 22 14:40:36 2016 UTC

# Line 6 | Line 6
6   * Pat Fisher, Mike Judd.
7   */
8  
9 + /*
10 + * @test
11 + * @summary JSR-166 tck tests
12 + * @modules java.management
13 + * @build *
14 + * @run junit/othervm/timeout=1000 -Djsr166.testImplementationDetails=true JSR166TestCase
15 + * @run junit/othervm/timeout=1000 -Djava.util.concurrent.ForkJoinPool.common.parallelism=0 -Djsr166.testImplementationDetails=true JSR166TestCase
16 + */
17 +
18   import static java.util.concurrent.TimeUnit.MILLISECONDS;
19 + import static java.util.concurrent.TimeUnit.MINUTES;
20   import static java.util.concurrent.TimeUnit.NANOSECONDS;
21  
22   import java.io.ByteArrayInputStream;
# Line 19 | Line 29 | import java.lang.management.ThreadMXBean
29   import java.lang.reflect.Constructor;
30   import java.lang.reflect.Method;
31   import java.lang.reflect.Modifier;
32 + import java.nio.file.Files;
33 + import java.nio.file.Paths;
34   import java.security.CodeSource;
35   import java.security.Permission;
36   import java.security.PermissionCollection;
# Line 47 | Line 59 | import java.util.concurrent.RecursiveAct
59   import java.util.concurrent.RecursiveTask;
60   import java.util.concurrent.RejectedExecutionHandler;
61   import java.util.concurrent.Semaphore;
62 + import java.util.concurrent.SynchronousQueue;
63   import java.util.concurrent.ThreadFactory;
64   import java.util.concurrent.ThreadPoolExecutor;
65   import java.util.concurrent.TimeoutException;
66 + import java.util.concurrent.atomic.AtomicBoolean;
67   import java.util.concurrent.atomic.AtomicReference;
68 + import java.util.regex.Matcher;
69   import java.util.regex.Pattern;
70  
71   import junit.framework.AssertionFailedError;
# Line 108 | Line 123 | import junit.framework.TestSuite;
123   * methods as there are exceptions the method can throw. Sometimes
124   * there are multiple tests per JSR166 method when the different
125   * "normal" behaviors differ significantly. And sometimes testcases
126 < * cover multiple methods when they cannot be tested in
112 < * isolation.
126 > * cover multiple methods when they cannot be tested in isolation.
127   *
128   * <li>The documentation style for testcases is to provide as javadoc
129   * a simple sentence or two describing the property that the testcase
# Line 172 | Line 186 | public class JSR166TestCase extends Test
186      private static final int suiteRuns =
187          Integer.getInteger("jsr166.suiteRuns", 1);
188  
189 +    /**
190 +     * Returns the value of the system property, or NaN if not defined.
191 +     */
192 +    private static float systemPropertyValue(String name) {
193 +        String floatString = System.getProperty(name);
194 +        if (floatString == null)
195 +            return Float.NaN;
196 +        try {
197 +            return Float.parseFloat(floatString);
198 +        } catch (NumberFormatException ex) {
199 +            throw new IllegalArgumentException(
200 +                String.format("Bad float value in system property %s=%s",
201 +                              name, floatString));
202 +        }
203 +    }
204 +
205 +    /**
206 +     * The scaling factor to apply to standard delays used in tests.
207 +     * May be initialized from any of:
208 +     * - the "jsr166.delay.factor" system property
209 +     * - the "test.timeout.factor" system property (as used by jtreg)
210 +     *   See: http://openjdk.java.net/jtreg/tag-spec.html
211 +     * - hard-coded fuzz factor when using a known slowpoke VM
212 +     */
213 +    private static final float delayFactor = delayFactor();
214 +
215 +    private static float delayFactor() {
216 +        float x;
217 +        if (!Float.isNaN(x = systemPropertyValue("jsr166.delay.factor")))
218 +            return x;
219 +        if (!Float.isNaN(x = systemPropertyValue("test.timeout.factor")))
220 +            return x;
221 +        String prop = System.getProperty("java.vm.version");
222 +        if (prop != null && prop.matches(".*debug.*"))
223 +            return 4.0f; // How much slower is fastdebug than product?!
224 +        return 1.0f;
225 +    }
226 +
227      public JSR166TestCase() { super(); }
228      public JSR166TestCase(String name) { super(name); }
229  
# Line 187 | Line 239 | public class JSR166TestCase extends Test
239          return (regex == null) ? null : Pattern.compile(regex);
240      }
241  
242 +    // Instrumentation to debug very rare, but very annoying hung test runs.
243 +    static volatile TestCase currentTestCase;
244 +    // static volatile int currentRun = 0;
245 +    static {
246 +        Runnable checkForWedgedTest = new Runnable() { public void run() {
247 +            // Avoid spurious reports with enormous runsPerTest.
248 +            // A single test case run should never take more than 1 second.
249 +            // But let's cap it at the high end too ...
250 +            final int timeoutMinutes =
251 +                Math.min(15, Math.max(runsPerTest / 60, 1));
252 +            for (TestCase lastTestCase = currentTestCase;;) {
253 +                try { MINUTES.sleep(timeoutMinutes); }
254 +                catch (InterruptedException unexpected) { break; }
255 +                if (lastTestCase == currentTestCase) {
256 +                    System.err.printf(
257 +                        "Looks like we're stuck running test: %s%n",
258 +                        lastTestCase);
259 + //                     System.err.printf(
260 + //                         "Looks like we're stuck running test: %s (%d/%d)%n",
261 + //                         lastTestCase, currentRun, runsPerTest);
262 + //                     System.err.println("availableProcessors=" +
263 + //                         Runtime.getRuntime().availableProcessors());
264 + //                     System.err.printf("cpu model = %s%n", cpuModel());
265 +                    dumpTestThreads();
266 +                    // one stack dump is probably enough; more would be spam
267 +                    break;
268 +                }
269 +                lastTestCase = currentTestCase;
270 +            }}};
271 +        Thread thread = new Thread(checkForWedgedTest, "checkForWedgedTest");
272 +        thread.setDaemon(true);
273 +        thread.start();
274 +    }
275 +
276 + //     public static String cpuModel() {
277 + //         try {
278 + //             Matcher matcher = Pattern.compile("model name\\s*: (.*)")
279 + //                 .matcher(new String(
280 + //                      Files.readAllBytes(Paths.get("/proc/cpuinfo")), "UTF-8"));
281 + //             matcher.find();
282 + //             return matcher.group(1);
283 + //         } catch (Exception ex) { return null; }
284 + //     }
285 +
286      public void runBare() throws Throwable {
287 +        currentTestCase = this;
288          if (methodFilter == null
289              || methodFilter.matcher(toString()).find())
290              super.runBare();
# Line 195 | Line 292 | public class JSR166TestCase extends Test
292  
293      protected void runTest() throws Throwable {
294          for (int i = 0; i < runsPerTest; i++) {
295 +            // currentRun = i;
296              if (profileTests)
297                  runTestProfiled();
298              else
# Line 223 | Line 321 | public class JSR166TestCase extends Test
321          main(suite(), args);
322      }
323  
324 +    static class PithyResultPrinter extends junit.textui.ResultPrinter {
325 +        PithyResultPrinter(java.io.PrintStream writer) { super(writer); }
326 +        long runTime;
327 +        public void startTest(Test test) {}
328 +        protected void printHeader(long runTime) {
329 +            this.runTime = runTime; // defer printing for later
330 +        }
331 +        protected void printFooter(TestResult result) {
332 +            if (result.wasSuccessful()) {
333 +                getWriter().println("OK (" + result.runCount() + " tests)"
334 +                    + "  Time: " + elapsedTimeAsString(runTime));
335 +            } else {
336 +                getWriter().println("Time: " + elapsedTimeAsString(runTime));
337 +                super.printFooter(result);
338 +            }
339 +        }
340 +    }
341 +
342 +    /**
343 +     * Returns a TestRunner that doesn't bother with unnecessary
344 +     * fluff, like printing a "." for each test case.
345 +     */
346 +    static junit.textui.TestRunner newPithyTestRunner() {
347 +        junit.textui.TestRunner runner = new junit.textui.TestRunner();
348 +        runner.setPrinter(new PithyResultPrinter(System.out));
349 +        return runner;
350 +    }
351 +
352      /**
353       * Runs all unit tests in the given test suite.
354       * Actual behavior influenced by jsr166.* system properties.
# Line 234 | Line 360 | public class JSR166TestCase extends Test
360              System.setSecurityManager(new SecurityManager());
361          }
362          for (int i = 0; i < suiteRuns; i++) {
363 <            TestResult result = junit.textui.TestRunner.run(suite);
363 >            TestResult result = newPithyTestRunner().doRun(suite);
364              if (!result.wasSuccessful())
365                  System.exit(1);
366              System.gc();
# Line 387 | Line 513 | public class JSR166TestCase extends Test
513                  "StampedLockTest",
514                  "SubmissionPublisherTest",
515                  "ThreadLocalRandom8Test",
516 +                "TimeUnit8Test",
517              };
518              addNamedTestClasses(suite, java8TestClassNames);
519          }
# Line 394 | Line 521 | public class JSR166TestCase extends Test
521          // Java9+ test classes
522          if (atLeastJava9()) {
523              String[] java9TestClassNames = {
524 <                // Currently empty, but expecting varhandle tests
524 >                "AtomicBoolean9Test",
525 >                "AtomicInteger9Test",
526 >                "AtomicIntegerArray9Test",
527 >                "AtomicLong9Test",
528 >                "AtomicLongArray9Test",
529 >                "AtomicReference9Test",
530 >                "AtomicReferenceArray9Test",
531 >                "ExecutorCompletionService9Test",
532              };
533              addNamedTestClasses(suite, java9TestClassNames);
534          }
# Line 461 | Line 595 | public class JSR166TestCase extends Test
595          } else {
596              return new TestSuite();
597          }
464
598      }
599  
600      // Delays for timing-dependent tests, in milliseconds.
# Line 472 | Line 605 | public class JSR166TestCase extends Test
605      public static long LONG_DELAY_MS;
606  
607      /**
608 <     * Returns the shortest timed delay. This could
609 <     * be reimplemented to use for example a Property.
608 >     * Returns the shortest timed delay. This can be scaled up for
609 >     * slow machines using the jsr166.delay.factor system property,
610 >     * or via jtreg's -timeoutFactor: flag.
611 >     * http://openjdk.java.net/jtreg/command-help.html
612       */
613      protected long getShortDelay() {
614 <        return 50;
614 >        return (long) (50 * delayFactor);
615      }
616  
617      /**
# Line 519 | Line 654 | public class JSR166TestCase extends Test
654       * the same test have no effect.
655       */
656      public void threadRecordFailure(Throwable t) {
657 +        System.err.println(t);
658 +        dumpTestThreads();
659          threadFailure.compareAndSet(null, t);
660      }
661  
# Line 529 | Line 666 | public class JSR166TestCase extends Test
666      void tearDownFail(String format, Object... args) {
667          String msg = toString() + ": " + String.format(format, args);
668          System.err.println(msg);
669 <        printAllStackTraces();
669 >        dumpTestThreads();
670          throw new AssertionFailedError(msg);
671      }
672  
# Line 566 | Line 703 | public class JSR166TestCase extends Test
703      }
704  
705      /**
706 <     * Finds missing try { ... } finally { joinPool(e); }
706 >     * Finds missing PoolCleaners
707       */
708      void checkForkJoinPoolThreadLeaks() throws InterruptedException {
709          Thread[] survivors = new Thread[7];
# Line 598 | Line 735 | public class JSR166TestCase extends Test
735              fail(reason);
736          } catch (AssertionFailedError t) {
737              threadRecordFailure(t);
738 <            fail(reason);
738 >            throw t;
739          }
740      }
741  
# Line 725 | Line 862 | public class JSR166TestCase extends Test
862      /**
863       * Delays, via Thread.sleep, for the given millisecond delay, but
864       * if the sleep is shorter than specified, may re-sleep or yield
865 <     * until time elapses.
865 >     * until time elapses.  Ensures that the given time, as measured
866 >     * by System.nanoTime(), has elapsed.
867       */
868      static void delay(long millis) throws InterruptedException {
869 <        long startTime = System.nanoTime();
870 <        long ns = millis * 1000 * 1000;
871 <        for (;;) {
869 >        long nanos = millis * (1000 * 1000);
870 >        final long wakeupTime = System.nanoTime() + nanos;
871 >        do {
872              if (millis > 0L)
873                  Thread.sleep(millis);
874              else // too short to sleep
875                  Thread.yield();
876 <            long d = ns - (System.nanoTime() - startTime);
877 <            if (d > 0L)
878 <                millis = d / (1000 * 1000);
741 <            else
742 <                break;
743 <        }
876 >            nanos = wakeupTime - System.nanoTime();
877 >            millis = nanos / (1000 * 1000);
878 >        } while (nanos >= 0L);
879      }
880  
881      /**
882       * Allows use of try-with-resources with per-test thread pools.
883       */
884 <    static class PoolCloser<T extends ExecutorService>
885 <            implements AutoCloseable {
886 <        public final T pool;
752 <        public PoolCloser(T pool) { this.pool = pool; }
884 >    class PoolCleaner implements AutoCloseable {
885 >        private final ExecutorService pool;
886 >        public PoolCleaner(ExecutorService pool) { this.pool = pool; }
887          public void close() { joinPool(pool); }
888      }
889  
890      /**
891 +     * An extension of PoolCleaner that has an action to release the pool.
892 +     */
893 +    class PoolCleanerWithReleaser extends PoolCleaner {
894 +        private final Runnable releaser;
895 +        public PoolCleanerWithReleaser(ExecutorService pool, Runnable releaser) {
896 +            super(pool);
897 +            this.releaser = releaser;
898 +        }
899 +        public void close() {
900 +            try {
901 +                releaser.run();
902 +            } finally {
903 +                super.close();
904 +            }
905 +        }
906 +    }
907 +
908 +    PoolCleaner cleaner(ExecutorService pool) {
909 +        return new PoolCleaner(pool);
910 +    }
911 +
912 +    PoolCleaner cleaner(ExecutorService pool, Runnable releaser) {
913 +        return new PoolCleanerWithReleaser(pool, releaser);
914 +    }
915 +
916 +    PoolCleaner cleaner(ExecutorService pool, CountDownLatch latch) {
917 +        return new PoolCleanerWithReleaser(pool, releaser(latch));
918 +    }
919 +
920 +    Runnable releaser(final CountDownLatch latch) {
921 +        return new Runnable() { public void run() {
922 +            do { latch.countDown(); }
923 +            while (latch.getCount() > 0);
924 +        }};
925 +    }
926 +
927 +    PoolCleaner cleaner(ExecutorService pool, AtomicBoolean flag) {
928 +        return new PoolCleanerWithReleaser(pool, releaser(flag));
929 +    }
930 +
931 +    Runnable releaser(final AtomicBoolean flag) {
932 +        return new Runnable() { public void run() { flag.set(true); }};
933 +    }
934 +
935 +    /**
936       * Waits out termination of a thread pool or fails doing so.
937       */
938 <    static void joinPool(ExecutorService pool) {
938 >    void joinPool(ExecutorService pool) {
939          try {
940              pool.shutdown();
941 <            if (!pool.awaitTermination(2 * LONG_DELAY_MS, MILLISECONDS))
942 <                fail("ExecutorService " + pool +
943 <                     " did not terminate in a timely manner");
941 >            if (!pool.awaitTermination(2 * LONG_DELAY_MS, MILLISECONDS)) {
942 >                try {
943 >                    threadFail("ExecutorService " + pool +
944 >                               " did not terminate in a timely manner");
945 >                } finally {
946 >                    // last resort, for the benefit of subsequent tests
947 >                    pool.shutdownNow();
948 >                    pool.awaitTermination(MEDIUM_DELAY_MS, MILLISECONDS);
949 >                }
950 >            }
951          } catch (SecurityException ok) {
952              // Allowed in case test doesn't have privs
953          } catch (InterruptedException fail) {
954 <            fail("Unexpected InterruptedException");
954 >            threadFail("Unexpected InterruptedException");
955          }
956      }
957  
958 <    /** Like Runnable, but with the freedom to throw anything */
958 >    /**
959 >     * Like Runnable, but with the freedom to throw anything.
960 >     * junit folks had the same idea:
961 >     * http://junit.org/junit5/docs/snapshot/api/org/junit/gen5/api/Executable.html
962 >     */
963      interface Action { public void run() throws Throwable; }
964  
965      /**
# Line 779 | Line 969 | public class JSR166TestCase extends Test
969       */
970      void testInParallel(Action ... actions) {
971          ExecutorService pool = Executors.newCachedThreadPool();
972 <        try {
972 >        try (PoolCleaner cleaner = cleaner(pool)) {
973              ArrayList<Future<?>> futures = new ArrayList<>(actions.length);
974              for (final Action action : actions)
975                  futures.add(pool.submit(new CheckedRunnable() {
# Line 792 | Line 982 | public class JSR166TestCase extends Test
982                  } catch (Exception ex) {
983                      threadUnexpectedException(ex);
984                  }
795        } finally {
796            joinPool(pool);
985          }
986      }
987  
988      /**
989 <     * A debugging tool to print all stack traces, as jstack does.
989 >     * A debugging tool to print stack traces of most threads, as jstack does.
990       * Uninteresting threads are filtered out.
991       */
992 <    static void printAllStackTraces() {
992 >    static void dumpTestThreads() {
993 >        SecurityManager sm = System.getSecurityManager();
994 >        if (sm != null) {
995 >            try {
996 >                System.setSecurityManager(null);
997 >            } catch (SecurityException giveUp) {
998 >                return;
999 >            }
1000 >        }
1001 >
1002          ThreadMXBean threadMXBean = ManagementFactory.getThreadMXBean();
1003          System.err.println("------ stacktrace dump start ------");
1004          for (ThreadInfo info : threadMXBean.dumpAllThreads(true, true)) {
# Line 814 | Line 1011 | public class JSR166TestCase extends Test
1011              if ("Finalizer".equals(name)
1012                  && info.getLockName().startsWith("java.lang.ref.ReferenceQueue$Lock"))
1013                  continue;
1014 +            if ("checkForWedgedTest".equals(name))
1015 +                continue;
1016              System.err.print(info);
1017          }
1018          System.err.println("------ stacktrace dump end ------");
1019 +
1020 +        if (sm != null) System.setSecurityManager(sm);
1021      }
1022  
1023      /**
# Line 836 | Line 1037 | public class JSR166TestCase extends Test
1037              delay(millis);
1038              assertTrue(thread.isAlive());
1039          } catch (InterruptedException fail) {
1040 <            fail("Unexpected InterruptedException");
1040 >            threadFail("Unexpected InterruptedException");
1041          }
1042      }
1043  
# Line 858 | Line 1059 | public class JSR166TestCase extends Test
1059              for (Thread thread : threads)
1060                  assertTrue(thread.isAlive());
1061          } catch (InterruptedException fail) {
1062 <            fail("Unexpected InterruptedException");
1062 >            threadFail("Unexpected InterruptedException");
1063          }
1064      }
1065  
# Line 1136 | Line 1337 | public class JSR166TestCase extends Test
1337          } finally {
1338              if (t.getState() != Thread.State.TERMINATED) {
1339                  t.interrupt();
1340 <                fail("Test timed out");
1340 >                threadFail("timed out waiting for thread to terminate");
1341              }
1342          }
1343      }
# Line 1284 | Line 1485 | public class JSR166TestCase extends Test
1485              }};
1486      }
1487  
1488 <    public Runnable awaiter(final CountDownLatch latch) {
1489 <        return new CheckedRunnable() {
1490 <            public void realRun() throws InterruptedException {
1491 <                await(latch);
1492 <            }};
1488 >    class LatchAwaiter extends CheckedRunnable {
1489 >        static final int NEW = 0;
1490 >        static final int RUNNING = 1;
1491 >        static final int DONE = 2;
1492 >        final CountDownLatch latch;
1493 >        int state = NEW;
1494 >        LatchAwaiter(CountDownLatch latch) { this.latch = latch; }
1495 >        public void realRun() throws InterruptedException {
1496 >            state = 1;
1497 >            await(latch);
1498 >            state = 2;
1499 >        }
1500      }
1501  
1502 <    public void await(CountDownLatch latch) {
1502 >    public LatchAwaiter awaiter(CountDownLatch latch) {
1503 >        return new LatchAwaiter(latch);
1504 >    }
1505 >
1506 >    public void await(CountDownLatch latch, long timeoutMillis) {
1507          try {
1508 <            assertTrue(latch.await(LONG_DELAY_MS, MILLISECONDS));
1508 >            if (!latch.await(timeoutMillis, MILLISECONDS))
1509 >                fail("timed out waiting for CountDownLatch for "
1510 >                     + (timeoutMillis/1000) + " sec");
1511          } catch (Throwable fail) {
1512              threadUnexpectedException(fail);
1513          }
1514      }
1515  
1516 +    public void await(CountDownLatch latch) {
1517 +        await(latch, LONG_DELAY_MS);
1518 +    }
1519 +
1520      public void await(Semaphore semaphore) {
1521          try {
1522 <            assertTrue(semaphore.tryAcquire(LONG_DELAY_MS, MILLISECONDS));
1522 >            if (!semaphore.tryAcquire(LONG_DELAY_MS, MILLISECONDS))
1523 >                fail("timed out waiting for Semaphore for "
1524 >                     + (LONG_DELAY_MS/1000) + " sec");
1525          } catch (Throwable fail) {
1526              threadUnexpectedException(fail);
1527          }
# Line 1637 | Line 1857 | public class JSR166TestCase extends Test
1857          } catch (NoSuchElementException success) {}
1858          assertFalse(it.hasNext());
1859      }
1860 +
1861 +    public <T> Callable<T> callableThrowing(final Exception ex) {
1862 +        return new Callable<T>() { public T call() throws Exception { throw ex; }};
1863 +    }
1864 +
1865 +    public Runnable runnableThrowing(final RuntimeException ex) {
1866 +        return new Runnable() { public void run() { throw ex; }};
1867 +    }
1868 +
1869 +    /** A reusable thread pool to be shared by tests. */
1870 +    static final ExecutorService cachedThreadPool =
1871 +        new ThreadPoolExecutor(0, Integer.MAX_VALUE,
1872 +                               1000L, MILLISECONDS,
1873 +                               new SynchronousQueue<Runnable>());
1874 +
1875   }

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines