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.130 by jsr166, Tue Apr 21 05:00:23 2015 UTC vs.
Revision 1.154 by jsr166, Sat Oct 3 19:39:16 2015 UTC

# Line 15 | Line 15 | import java.io.ObjectInputStream;
15   import java.io.ObjectOutputStream;
16   import java.lang.management.ManagementFactory;
17   import java.lang.management.ThreadInfo;
18 + import java.lang.management.ThreadMXBean;
19 + import java.lang.reflect.Constructor;
20   import java.lang.reflect.Method;
21 + import java.lang.reflect.Modifier;
22   import java.security.CodeSource;
23   import java.security.Permission;
24   import java.security.PermissionCollection;
# Line 35 | Line 38 | import java.util.concurrent.BlockingQueu
38   import java.util.concurrent.Callable;
39   import java.util.concurrent.CountDownLatch;
40   import java.util.concurrent.CyclicBarrier;
41 + import java.util.concurrent.ExecutionException;
42 + import java.util.concurrent.Executors;
43   import java.util.concurrent.ExecutorService;
44 + import java.util.concurrent.ForkJoinPool;
45   import java.util.concurrent.Future;
46   import java.util.concurrent.RecursiveAction;
47   import java.util.concurrent.RecursiveTask;
# Line 50 | Line 56 | import java.util.regex.Pattern;
56   import junit.framework.AssertionFailedError;
57   import junit.framework.Test;
58   import junit.framework.TestCase;
59 + import junit.framework.TestResult;
60   import junit.framework.TestSuite;
61  
62   /**
# Line 62 | Line 69 | import junit.framework.TestSuite;
69   *
70   * <ol>
71   *
72 < * <li> All assertions in code running in generated threads must use
72 > * <li>All assertions in code running in generated threads must use
73   * the forms {@link #threadFail}, {@link #threadAssertTrue}, {@link
74   * #threadAssertEquals}, or {@link #threadAssertNull}, (not
75   * {@code fail}, {@code assertTrue}, etc.) It is OK (but not
76   * particularly recommended) for other code to use these forms too.
77   * Only the most typically used JUnit assertion methods are defined
78 < * this way, but enough to live with.</li>
78 > * this way, but enough to live with.
79   *
80 < * <li> If you override {@link #setUp} or {@link #tearDown}, make sure
80 > * <li>If you override {@link #setUp} or {@link #tearDown}, make sure
81   * to invoke {@code super.setUp} and {@code super.tearDown} within
82   * them. These methods are used to clear and check for thread
83 < * assertion failures.</li>
83 > * assertion failures.
84   *
85   * <li>All delays and timeouts must use one of the constants {@code
86   * SHORT_DELAY_MS}, {@code SMALL_DELAY_MS}, {@code MEDIUM_DELAY_MS},
# Line 84 | Line 91 | import junit.framework.TestSuite;
91   * is always discriminable as larger than SHORT and smaller than
92   * MEDIUM.  And so on. These constants are set to conservative values,
93   * but even so, if there is ever any doubt, they can all be increased
94 < * in one spot to rerun tests on slower platforms.</li>
94 > * in one spot to rerun tests on slower platforms.
95   *
96 < * <li> All threads generated must be joined inside each test case
96 > * <li>All threads generated must be joined inside each test case
97   * method (or {@code fail} to do so) before returning from the
98   * method. The {@code joinPool} method can be used to do this when
99 < * using Executors.</li>
99 > * using Executors.
100   *
101   * </ol>
102   *
103   * <p><b>Other notes</b>
104   * <ul>
105   *
106 < * <li> Usually, there is one testcase method per JSR166 method
106 > * <li>Usually, there is one testcase method per JSR166 method
107   * covering "normal" operation, and then as many exception-testing
108   * methods as there are exceptions the method can throw. Sometimes
109   * there are multiple tests per JSR166 method when the different
110   * "normal" behaviors differ significantly. And sometimes testcases
111   * cover multiple methods when they cannot be tested in
112 < * isolation.</li>
112 > * isolation.
113   *
114 < * <li> The documentation style for testcases is to provide as javadoc
114 > * <li>The documentation style for testcases is to provide as javadoc
115   * a simple sentence or two describing the property that the testcase
116   * method purports to test. The javadocs do not say anything about how
117 < * the property is tested. To find out, read the code.</li>
117 > * the property is tested. To find out, read the code.
118   *
119 < * <li> These tests are "conformance tests", and do not attempt to
119 > * <li>These tests are "conformance tests", and do not attempt to
120   * test throughput, latency, scalability or other performance factors
121   * (see the separate "jtreg" tests for a set intended to check these
122   * for the most central aspects of functionality.) So, most tests use
123   * the smallest sensible numbers of threads, collection sizes, etc
124 < * needed to check basic conformance.</li>
124 > * needed to check basic conformance.
125   *
126   * <li>The test classes currently do not declare inclusion in
127   * any particular package to simplify things for people integrating
128 < * them in TCK test suites.</li>
128 > * them in TCK test suites.
129   *
130 < * <li> As a convenience, the {@code main} of this class (JSR166TestCase)
131 < * runs all JSR166 unit tests.</li>
130 > * <li>As a convenience, the {@code main} of this class (JSR166TestCase)
131 > * runs all JSR166 unit tests.
132   *
133   * </ul>
134   */
# Line 160 | Line 167 | public class JSR166TestCase extends Test
167          Integer.getInteger("jsr166.runsPerTest", 1);
168  
169      /**
170 +     * The number of repetitions of the test suite (for finding leaks?).
171 +     */
172 +    private static final int suiteRuns =
173 +        Integer.getInteger("jsr166.suiteRuns", 1);
174 +
175 +    public JSR166TestCase() { super(); }
176 +    public JSR166TestCase(String name) { super(name); }
177 +
178 +    /**
179       * A filter for tests to run, matching strings of the form
180       * methodName(className), e.g. "testInvokeAll5(ForkJoinPoolTest)"
181       * Usefully combined with jsr166.runsPerTest.
# Line 171 | Line 187 | public class JSR166TestCase extends Test
187          return (regex == null) ? null : Pattern.compile(regex);
188      }
189  
190 <    protected void runTest() throws Throwable {
190 >    public void runBare() throws Throwable {
191          if (methodFilter == null
192 <            || methodFilter.matcher(toString()).find()) {
193 <            for (int i = 0; i < runsPerTest; i++) {
194 <                if (profileTests)
195 <                    runTestProfiled();
196 <                else
197 <                    super.runTest();
198 <            }
192 >            || methodFilter.matcher(toString()).find())
193 >            super.runBare();
194 >    }
195 >
196 >    protected void runTest() throws Throwable {
197 >        for (int i = 0; i < runsPerTest; i++) {
198 >            if (profileTests)
199 >                runTestProfiled();
200 >            else
201 >                super.runTest();
202          }
203      }
204  
205      protected void runTestProfiled() throws Throwable {
206 <        // Warmup run, notably to trigger all needed classloading.
207 <        super.runTest();
189 <        long t0 = System.nanoTime();
190 <        try {
206 >        for (int i = 0; i < 2; i++) {
207 >            long startTime = System.nanoTime();
208              super.runTest();
209 <        } finally {
210 <            long elapsedMillis = millisElapsedSince(t0);
211 <            if (elapsedMillis >= profileThreshold)
209 >            long elapsedMillis = millisElapsedSince(startTime);
210 >            if (elapsedMillis < profileThreshold)
211 >                break;
212 >            // Never report first run of any test; treat it as a
213 >            // warmup run, notably to trigger all needed classloading,
214 >            if (i > 0)
215                  System.out.printf("%n%s: %d%n", toString(), elapsedMillis);
216          }
217      }
218  
219      /**
220       * Runs all JSR166 unit tests using junit.textui.TestRunner.
201     * Optional command line arg provides the number of iterations to
202     * repeat running the tests.
221       */
222      public static void main(String[] args) {
223 +        main(suite(), args);
224 +    }
225 +
226 +    /**
227 +     * Runs all unit tests in the given test suite.
228 +     * Actual behavior influenced by jsr166.* system properties.
229 +     */
230 +    static void main(Test suite, String[] args) {
231          if (useSecurityManager) {
232              System.err.println("Setting a permissive security manager");
233              Policy.setPolicy(permissivePolicy());
234              System.setSecurityManager(new SecurityManager());
235          }
236 <        int iters = (args.length == 0) ? 1 : Integer.parseInt(args[0]);
237 <
238 <        Test s = suite();
239 <        for (int i = 0; i < iters; ++i) {
214 <            junit.textui.TestRunner.run(s);
236 >        for (int i = 0; i < suiteRuns; i++) {
237 >            TestResult result = junit.textui.TestRunner.run(suite);
238 >            if (!result.wasSuccessful())
239 >                System.exit(1);
240              System.gc();
241              System.runFinalization();
242          }
218        System.exit(0);
243      }
244  
245      public static TestSuite newTestSuite(Object... suiteOrClasses) {
# Line 265 | Line 289 | public class JSR166TestCase extends Test
289      public static boolean atLeastJava6() { return JAVA_CLASS_VERSION >= 50.0; }
290      public static boolean atLeastJava7() { return JAVA_CLASS_VERSION >= 51.0; }
291      public static boolean atLeastJava8() { return JAVA_CLASS_VERSION >= 52.0; }
292 <    public static boolean atLeastJava9() { return JAVA_CLASS_VERSION >= 53.0; }
292 >    public static boolean atLeastJava9() {
293 >        return JAVA_CLASS_VERSION >= 53.0
294 >            // As of 2015-09, java9 still uses 52.0 class file version
295 >            || JAVA_SPECIFICATION_VERSION.matches("^(1\\.)?(9|[0-9][0-9])$");
296 >    }
297 >    public static boolean atLeastJava10() {
298 >        return JAVA_CLASS_VERSION >= 54.0
299 >            || JAVA_SPECIFICATION_VERSION.matches("^(1\\.)?[0-9][0-9]$");
300 >    }
301  
302      /**
303       * Collects all JSR166 unit tests as one suite.
# Line 353 | Line 385 | public class JSR166TestCase extends Test
385                  "LongAdderTest",
386                  "SplittableRandomTest",
387                  "StampedLockTest",
388 +                "SubmissionPublisherTest",
389                  "ThreadLocalRandom8Test",
390              };
391              addNamedTestClasses(suite, java8TestClassNames);
# Line 361 | Line 394 | public class JSR166TestCase extends Test
394          // Java9+ test classes
395          if (atLeastJava9()) {
396              String[] java9TestClassNames = {
397 <                "ThreadPoolExecutor9Test",
397 >                // Currently empty, but expecting varhandle tests
398              };
399              addNamedTestClasses(suite, java9TestClassNames);
400          }
# Line 369 | Line 402 | public class JSR166TestCase extends Test
402          return suite;
403      }
404  
405 +    /** Returns list of junit-style test method names in given class. */
406 +    public static ArrayList<String> testMethodNames(Class<?> testClass) {
407 +        Method[] methods = testClass.getDeclaredMethods();
408 +        ArrayList<String> names = new ArrayList<String>(methods.length);
409 +        for (Method method : methods) {
410 +            if (method.getName().startsWith("test")
411 +                && Modifier.isPublic(method.getModifiers())
412 +                // method.getParameterCount() requires jdk8+
413 +                && method.getParameterTypes().length == 0) {
414 +                names.add(method.getName());
415 +            }
416 +        }
417 +        return names;
418 +    }
419 +
420 +    /**
421 +     * Returns junit-style testSuite for the given test class, but
422 +     * parameterized by passing extra data to each test.
423 +     */
424 +    public static <ExtraData> Test parameterizedTestSuite
425 +        (Class<? extends JSR166TestCase> testClass,
426 +         Class<ExtraData> dataClass,
427 +         ExtraData data) {
428 +        try {
429 +            TestSuite suite = new TestSuite();
430 +            Constructor c =
431 +                testClass.getDeclaredConstructor(dataClass, String.class);
432 +            for (String methodName : testMethodNames(testClass))
433 +                suite.addTest((Test) c.newInstance(data, methodName));
434 +            return suite;
435 +        } catch (Exception e) {
436 +            throw new Error(e);
437 +        }
438 +    }
439 +
440 +    /**
441 +     * Returns junit-style testSuite for the jdk8 extension of the
442 +     * given test class, but parameterized by passing extra data to
443 +     * each test.  Uses reflection to allow compilation in jdk7.
444 +     */
445 +    public static <ExtraData> Test jdk8ParameterizedTestSuite
446 +        (Class<? extends JSR166TestCase> testClass,
447 +         Class<ExtraData> dataClass,
448 +         ExtraData data) {
449 +        if (atLeastJava8()) {
450 +            String name = testClass.getName();
451 +            String name8 = name.replaceAll("Test$", "8Test");
452 +            if (name.equals(name8)) throw new Error(name);
453 +            try {
454 +                return (Test)
455 +                    Class.forName(name8)
456 +                    .getMethod("testSuite", new Class[] { dataClass })
457 +                    .invoke(null, data);
458 +            } catch (Exception e) {
459 +                throw new Error(e);
460 +            }
461 +        } else {
462 +            return new TestSuite();
463 +        }
464 +
465 +    }
466 +
467      // Delays for timing-dependent tests, in milliseconds.
468  
469      public static long SHORT_DELAY_MS;
# Line 403 | Line 498 | public class JSR166TestCase extends Test
498      }
499  
500      /**
501 <     * Returns a new Date instance representing a time delayMillis
502 <     * milliseconds in the future.
501 >     * Returns a new Date instance representing a time at least
502 >     * delayMillis milliseconds in the future.
503       */
504      Date delayedDate(long delayMillis) {
505 <        return new Date(System.currentTimeMillis() + delayMillis);
505 >        // Add 1 because currentTimeMillis is known to round into the past.
506 >        return new Date(System.currentTimeMillis() + delayMillis + 1);
507      }
508  
509      /**
# Line 423 | Line 519 | public class JSR166TestCase extends Test
519       * the same test have no effect.
520       */
521      public void threadRecordFailure(Throwable t) {
522 +        threadDump();
523          threadFailure.compareAndSet(null, t);
524      }
525  
# Line 430 | Line 527 | public class JSR166TestCase extends Test
527          setDelays();
528      }
529  
530 +    void tearDownFail(String format, Object... args) {
531 +        String msg = toString() + ": " + String.format(format, args);
532 +        System.err.println(msg);
533 +        threadDump();
534 +        throw new AssertionFailedError(msg);
535 +    }
536 +
537      /**
538       * Extra checks that get done for all test cases.
539       *
# Line 457 | Line 561 | public class JSR166TestCase extends Test
561          }
562  
563          if (Thread.interrupted())
564 <            throw new AssertionFailedError("interrupt status set in main thread");
564 >            tearDownFail("interrupt status set in main thread");
565  
566          checkForkJoinPoolThreadLeaks();
567      }
# Line 466 | Line 570 | public class JSR166TestCase extends Test
570       * Finds missing try { ... } finally { joinPool(e); }
571       */
572      void checkForkJoinPoolThreadLeaks() throws InterruptedException {
573 <        Thread[] survivors = new Thread[5];
573 >        Thread[] survivors = new Thread[7];
574          int count = Thread.enumerate(survivors);
575          for (int i = 0; i < count; i++) {
576              Thread thread = survivors[i];
# Line 474 | Line 578 | public class JSR166TestCase extends Test
578              if (name.startsWith("ForkJoinPool-")) {
579                  // give thread some time to terminate
580                  thread.join(LONG_DELAY_MS);
581 <                if (!thread.isAlive()) continue;
582 <                thread.stop();
583 <                throw new AssertionFailedError
480 <                    (String.format("Found leaked ForkJoinPool thread test=%s thread=%s%n",
481 <                                   toString(), name));
581 >                if (thread.isAlive())
582 >                    tearDownFail("Found leaked ForkJoinPool thread thread=%s",
583 >                                 thread);
584              }
585          }
586 +
587 +        if (!ForkJoinPool.commonPool()
588 +            .awaitQuiescence(LONG_DELAY_MS, MILLISECONDS))
589 +            tearDownFail("ForkJoin common pool thread stuck");
590      }
591  
592      /**
# Line 493 | Line 599 | public class JSR166TestCase extends Test
599              fail(reason);
600          } catch (AssertionFailedError t) {
601              threadRecordFailure(t);
602 <            fail(reason);
602 >            throw t;
603          }
604      }
605  
# Line 639 | Line 745 | public class JSR166TestCase extends Test
745      }
746  
747      /**
748 +     * Allows use of try-with-resources with per-test thread pools.
749 +     */
750 +    static class PoolCloser<T extends ExecutorService>
751 +            implements AutoCloseable {
752 +        public final T pool;
753 +        public PoolCloser(T pool) { this.pool = pool; }
754 +        public void close() { joinPool(pool); }
755 +    }
756 +
757 +    /**
758       * Waits out termination of a thread pool or fails doing so.
759       */
760 <    void joinPool(ExecutorService exec) {
760 >    static void joinPool(ExecutorService pool) {
761          try {
762 <            exec.shutdown();
763 <            if (!exec.awaitTermination(2 * LONG_DELAY_MS, MILLISECONDS))
764 <                fail("ExecutorService " + exec +
762 >            pool.shutdown();
763 >            if (!pool.awaitTermination(2 * LONG_DELAY_MS, MILLISECONDS))
764 >                fail("ExecutorService " + pool +
765                       " did not terminate in a timely manner");
766          } catch (SecurityException ok) {
767              // Allowed in case test doesn't have privs
# Line 654 | Line 770 | public class JSR166TestCase extends Test
770          }
771      }
772  
773 +    /** Like Runnable, but with the freedom to throw anything */
774 +    interface Action { public void run() throws Throwable; }
775 +
776 +    /**
777 +     * Runs all the given actions in parallel, failing if any fail.
778 +     * Useful for running multiple variants of tests that are
779 +     * necessarily individually slow because they must block.
780 +     */
781 +    void testInParallel(Action ... actions) {
782 +        try (PoolCloser<ExecutorService> poolCloser
783 +             = new PoolCloser<>(Executors.newCachedThreadPool())) {
784 +            ExecutorService pool = poolCloser.pool;
785 +            ArrayList<Future<?>> futures = new ArrayList<>(actions.length);
786 +            for (final Action action : actions)
787 +                futures.add(pool.submit(new CheckedRunnable() {
788 +                    public void realRun() throws Throwable { action.run();}}));
789 +            for (Future<?> future : futures)
790 +                try {
791 +                    assertNull(future.get(LONG_DELAY_MS, MILLISECONDS));
792 +                } catch (ExecutionException ex) {
793 +                    threadUnexpectedException(ex.getCause());
794 +                } catch (Exception ex) {
795 +                    threadUnexpectedException(ex);
796 +                }
797 +        }
798 +    }
799 +
800      /**
801       * A debugging tool to print all stack traces, as jstack does.
802 +     * Uninteresting threads are filtered out.
803       */
804 <    static void printAllStackTraces() {
805 <        for (ThreadInfo info :
806 <                 ManagementFactory.getThreadMXBean()
807 <                 .dumpAllThreads(true, true))
804 >    static void threadDump() {
805 >        ThreadMXBean threadMXBean = ManagementFactory.getThreadMXBean();
806 >        System.err.println("------ stacktrace dump start ------");
807 >        for (ThreadInfo info : threadMXBean.dumpAllThreads(true, true)) {
808 >            String name = info.getThreadName();
809 >            if ("Signal Dispatcher".equals(name))
810 >                continue;
811 >            if ("Reference Handler".equals(name)
812 >                && info.getLockName().startsWith("java.lang.ref.Reference$Lock"))
813 >                continue;
814 >            if ("Finalizer".equals(name)
815 >                && info.getLockName().startsWith("java.lang.ref.ReferenceQueue$Lock"))
816 >                continue;
817              System.err.print(info);
818 +        }
819 +        System.err.println("------ stacktrace dump end ------");
820      }
821  
822      /**
# Line 1106 | Line 1261 | public class JSR166TestCase extends Test
1261      public static final String TEST_STRING = "a test string";
1262  
1263      public static class StringTask implements Callable<String> {
1264 <        public String call() { return TEST_STRING; }
1264 >        final String value;
1265 >        public StringTask() { this(TEST_STRING); }
1266 >        public StringTask(String value) { this.value = value; }
1267 >        public String call() { return value; }
1268      }
1269  
1270      public Callable<String> latchAwaitingStringTask(final CountDownLatch latch) {
# Line 1119 | Line 1277 | public class JSR166TestCase extends Test
1277              }};
1278      }
1279  
1280 +    public Runnable countDowner(final CountDownLatch latch) {
1281 +        return new CheckedRunnable() {
1282 +            public void realRun() throws InterruptedException {
1283 +                latch.countDown();
1284 +            }};
1285 +    }
1286 +
1287      public Runnable awaiter(final CountDownLatch latch) {
1288          return new CheckedRunnable() {
1289              public void realRun() throws InterruptedException {

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines