ViewVC Help

View File | Revision Log | Show Annotations | Download File | Root Listing

root/jsr166/jsr166/src/test/tck/JSR166TestCase.java

Comparing jsr166/src/test/tck/JSR166TestCase.java (file contents):
Revision 1.136 by jsr166, Fri Sep 4 18:16:28 2015 UTC vs.
Revision 1.159 by jsr166, Sun Oct 4 00:30:50 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 282 | Line 313 | public class JSR166TestCase extends Test
313		public static boolean atLeastJava7() { return JAVA_CLASS_VERSION >= 51.0; }
314		public static boolean atLeastJava8() { return JAVA_CLASS_VERSION >= 52.0; }
315		public static boolean atLeastJava9() {
316	<	// As of 2015-09, java9 still uses 52.0 class file version
317	<	return JAVA_SPECIFICATION_VERSION.matches("^(1\\.)?(9|[0-9][0-9])$");
316	>	return JAVA_CLASS_VERSION >= 53.0
317	>	// As of 2015-09, java9 still uses 52.0 class file version
318	>	|| JAVA_SPECIFICATION_VERSION.matches("^(1\\.)?(9|[0-9][0-9])$");
319		}
288	–	// public static boolean atLeastJava9() { return JAVA_CLASS_VERSION >= 53.0; }
320		public static boolean atLeastJava10() {
321	<	return JAVA_SPECIFICATION_VERSION.matches("^(1\\.)?[0-9][0-9]$");
321	>	return JAVA_CLASS_VERSION >= 54.0
322	>	|| JAVA_SPECIFICATION_VERSION.matches("^(1\\.)?[0-9][0-9]$");
323		}
324
325		/**
#	Line 376 | Line 408 | public class JSR166TestCase extends Test
408		"LongAdderTest",
409		"SplittableRandomTest",
410		"StampedLockTest",
411	+	"SubmissionPublisherTest",
412		"ThreadLocalRandom8Test",
413		};
414		addNamedTestClasses(suite, java8TestClassNames);
#	Line 384 | Line 417 | public class JSR166TestCase extends Test
417		// Java9+ test classes
418		if (atLeastJava9()) {
419		String[] java9TestClassNames = {
420	<	"ThreadPoolExecutor9Test",
420	>	// Currently empty, but expecting varhandle tests
421		};
422		addNamedTestClasses(suite, java9TestClassNames);
423		}
#	Line 451 | Line 484 | public class JSR166TestCase extends Test
484		} else {
485		return new TestSuite();
486		}
454	–
487		}
488
489		// Delays for timing-dependent tests, in milliseconds.
#	Line 509 | Line 541 | public class JSR166TestCase extends Test
541		* the same test have no effect.
542		*/
543		public void threadRecordFailure(Throwable t) {
544	+	System.err.println(t);
545	+	dumpTestThreads();
546		threadFailure.compareAndSet(null, t);
547		}
548
#	Line 516 | Line 550 | public class JSR166TestCase extends Test
550		setDelays();
551		}
552
553	+	void tearDownFail(String format, Object... args) {
554	+	String msg = toString() + ": " + String.format(format, args);
555	+	System.err.println(msg);
556	+	dumpTestThreads();
557	+	throw new AssertionFailedError(msg);
558	+	}
559	+
560		/**
561		* Extra checks that get done for all test cases.
562		*
#	Line 543 | Line 584 | public class JSR166TestCase extends Test
584		}
585
586		if (Thread.interrupted())
587	<	throw new AssertionFailedError("interrupt status set in main thread");
587	>	tearDownFail("interrupt status set in main thread");
588
589		checkForkJoinPoolThreadLeaks();
590		}
#	Line 552 | Line 593 | public class JSR166TestCase extends Test
593		* Finds missing try { ... } finally { joinPool(e); }
594		*/
595		void checkForkJoinPoolThreadLeaks() throws InterruptedException {
596	<	Thread[] survivors = new Thread[5];
596	>	Thread[] survivors = new Thread[7];
597		int count = Thread.enumerate(survivors);
598		for (int i = 0; i < count; i++) {
599		Thread thread = survivors[i];
#	Line 560 | Line 601 | public class JSR166TestCase extends Test
601		if (name.startsWith("ForkJoinPool-")) {
602		// give thread some time to terminate
603		thread.join(LONG_DELAY_MS);
604	<	if (!thread.isAlive()) continue;
605	<	throw new AssertionFailedError
606	<	(String.format("Found leaked ForkJoinPool thread test=%s thread=%s%n",
566	<	toString(), name));
604	>	if (thread.isAlive())
605	>	tearDownFail("Found leaked ForkJoinPool thread thread=%s",
606	>	thread);
607		}
608		}
609	+
610	+	if (!ForkJoinPool.commonPool()
611	+	.awaitQuiescence(LONG_DELAY_MS, MILLISECONDS))
612	+	tearDownFail("ForkJoin common pool thread stuck");
613		}
614
615		/**
#	Line 578 | Line 622 | public class JSR166TestCase extends Test
622		fail(reason);
623		} catch (AssertionFailedError t) {
624		threadRecordFailure(t);
625	<	fail(reason);
625	>	throw t;
626		}
627		}
628
#	Line 724 | Line 768 | public class JSR166TestCase extends Test
768		}
769
770		/**
771	+	* Allows use of try-with-resources with per-test thread pools.
772	+	*/
773	+	class PoolCleaner<T extends ExecutorService>
774	+	implements AutoCloseable {
775	+	public final T pool;
776	+	public PoolCleaner(T pool) { this.pool = pool; }
777	+	public void close() { joinPool(pool); }
778	+	}
779	+
780	+	<T extends ExecutorService> PoolCleaner<T> cleaner(T pool) {
781	+	return new PoolCleaner<T>(pool);
782	+	}
783	+
784	+	/**
785		* Waits out termination of a thread pool or fails doing so.
786		*/
787	<	void joinPool(ExecutorService exec) {
787	>	void joinPool(ExecutorService pool) {
788		try {
789	<	exec.shutdown();
790	<	if (!exec.awaitTermination(2 * LONG_DELAY_MS, MILLISECONDS))
791	<	fail("ExecutorService " + exec +
792	<	" did not terminate in a timely manner");
789	>	pool.shutdown();
790	>	if (!pool.awaitTermination(2 * LONG_DELAY_MS, MILLISECONDS)) {
791	>	try {
792	>	threadFail("ExecutorService " + pool +
793	>	" did not terminate in a timely manner");
794	>	} finally {
795	>	// last resort, for the benefit of subsequent tests
796	>	pool.shutdownNow();
797	>	pool.awaitTermination(SMALL_DELAY_MS, MILLISECONDS);
798	>	}
799	>	}
800		} catch (SecurityException ok) {
801		// Allowed in case test doesn't have privs
802		} catch (InterruptedException fail) {
803	<	fail("Unexpected InterruptedException");
803	>	threadFail("Unexpected InterruptedException");
804		}
805		}
806
807	+	/** Like Runnable, but with the freedom to throw anything */
808	+	interface Action { public void run() throws Throwable; }
809	+
810		/**
811	<	* A debugging tool to print all stack traces, as jstack does.
811	>	* Runs all the given actions in parallel, failing if any fail.
812	>	* Useful for running multiple variants of tests that are
813	>	* necessarily individually slow because they must block.
814		*/
815	<	static void printAllStackTraces() {
816	<	for (ThreadInfo info :
817	<	ManagementFactory.getThreadMXBean()
818	<	.dumpAllThreads(true, true))
815	>	void testInParallel(Action ... actions) {
816	>	try (PoolCleaner<ExecutorService> cleaner
817	>	= cleaner(Executors.newCachedThreadPool())) {
818	>	ExecutorService pool = cleaner.pool;
819	>	ArrayList<Future<?>> futures = new ArrayList<>(actions.length);
820	>	for (final Action action : actions)
821	>	futures.add(pool.submit(new CheckedRunnable() {
822	>	public void realRun() throws Throwable { action.run();}}));
823	>	for (Future<?> future : futures)
824	>	try {
825	>	assertNull(future.get(LONG_DELAY_MS, MILLISECONDS));
826	>	} catch (ExecutionException ex) {
827	>	threadUnexpectedException(ex.getCause());
828	>	} catch (Exception ex) {
829	>	threadUnexpectedException(ex);
830	>	}
831	>	}
832	>	}
833	>
834	>	/**
835	>	* A debugging tool to print stack traces of most threads, as jstack does.
836	>	* Uninteresting threads are filtered out.
837	>	*/
838	>	static void dumpTestThreads() {
839	>	ThreadMXBean threadMXBean = ManagementFactory.getThreadMXBean();
840	>	System.err.println("------ stacktrace dump start ------");
841	>	for (ThreadInfo info : threadMXBean.dumpAllThreads(true, true)) {
842	>	String name = info.getThreadName();
843	>	if ("Signal Dispatcher".equals(name))
844	>	continue;
845	>	if ("Reference Handler".equals(name)
846	>	&& info.getLockName().startsWith("java.lang.ref.Reference$Lock"))
847	>	continue;
848	>	if ("Finalizer".equals(name)
849	>	&& info.getLockName().startsWith("java.lang.ref.ReferenceQueue$Lock"))
850	>	continue;
851	>	if ("checkForWedgedTest".equals(name))
852	>	continue;
853		System.err.print(info);
854	+	}
855	+	System.err.println("------ stacktrace dump end ------");
856		}
857
858		/**
#	Line 766 | Line 872 | public class JSR166TestCase extends Test
872		delay(millis);
873		assertTrue(thread.isAlive());
874		} catch (InterruptedException fail) {
875	<	fail("Unexpected InterruptedException");
875	>	threadFail("Unexpected InterruptedException");
876		}
877		}
878
#	Line 788 | Line 894 | public class JSR166TestCase extends Test
894		for (Thread thread : threads)
895		assertTrue(thread.isAlive());
896		} catch (InterruptedException fail) {
897	<	fail("Unexpected InterruptedException");
897	>	threadFail("Unexpected InterruptedException");
898		}
899		}
900
#	Line 1191 | Line 1297 | public class JSR166TestCase extends Test
1297		public static final String TEST_STRING = "a test string";
1298
1299		public static class StringTask implements Callable<String> {
1300	<	public String call() { return TEST_STRING; }
1300	>	final String value;
1301	>	public StringTask() { this(TEST_STRING); }
1302	>	public StringTask(String value) { this.value = value; }
1303	>	public String call() { return value; }
1304		}
1305
1306		public Callable<String> latchAwaitingStringTask(final CountDownLatch latch) {
#	Line 1204 | Line 1313 | public class JSR166TestCase extends Test
1313		}};
1314		}
1315
1316	+	public Runnable countDowner(final CountDownLatch latch) {
1317	+	return new CheckedRunnable() {
1318	+	public void realRun() throws InterruptedException {
1319	+	latch.countDown();
1320	+	}};
1321	+	}
1322	+
1323		public Runnable awaiter(final CountDownLatch latch) {
1324		return new CheckedRunnable() {
1325		public void realRun() throws InterruptedException {

Diff Legend

–	Removed lines
+	Added lines
<	Changed lines
>	Changed lines