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.128 by jsr166, Fri Feb 27 22:06:24 2015 UTC vs.
Revision 1.158 by jsr166, Sat Oct 3 23:17:03 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.security.CodeSource;
24		import java.security.Permission;
25		import java.security.PermissionCollection;
#	Line 35 | 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 50 | Line 57 | import java.util.regex.Pattern;
57		import junit.framework.AssertionFailedError;
58		import junit.framework.Test;
59		import junit.framework.TestCase;
60	+	import junit.framework.TestResult;
61		import junit.framework.TestSuite;
62
63		/**
#	Line 62 | 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 84 | 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 160 | Line 168 | public class JSR166TestCase extends Test
168		Integer.getInteger("jsr166.runsPerTest", 1);
169
170		/**
171	+	* The number of repetitions of the test suite (for finding leaks?).
172	+	*/
173	+	private static final int suiteRuns =
174	+	Integer.getInteger("jsr166.suiteRuns", 1);
175	+
176	+	public JSR166TestCase() { super(); }
177	+	public JSR166TestCase(String name) { super(name); }
178	+
179	+	/**
180		* A filter for tests to run, matching strings of the form
181		* methodName(className), e.g. "testInvokeAll5(ForkJoinPoolTest)"
182		* Usefully combined with jsr166.runsPerTest.
#	Line 171 | 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();
189	<	long t0 = System.nanoTime();
190	<	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		}
241
242		/**
243		* 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.
244		*/
245		public static void main(String[] args) {
246	+	main(suite(), args);
247	+	}
248	+
249	+	/**
250	+	* Runs all unit tests in the given test suite.
251	+	* Actual behavior influenced by jsr166.* system properties.
252	+	*/
253	+	static void main(Test suite, String[] args) {
254		if (useSecurityManager) {
255		System.err.println("Setting a permissive security manager");
256		Policy.setPolicy(permissivePolicy());
257		System.setSecurityManager(new SecurityManager());
258		}
259	<	int iters = (args.length == 0) ? 1 : Integer.parseInt(args[0]);
260	<
261	<	Test s = suite();
262	<	for (int i = 0; i < iters; ++i) {
214	<	junit.textui.TestRunner.run(s);
259	>	for (int i = 0; i < suiteRuns; i++) {
260	>	TestResult result = junit.textui.TestRunner.run(suite);
261	>	if (!result.wasSuccessful())
262	>	System.exit(1);
263		System.gc();
264		System.runFinalization();
265		}
218	–	System.exit(0);
266		}
267
268		public static TestSuite newTestSuite(Object... suiteOrClasses) {
#	Line 266 | 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 2014-05, java9 still uses 52.0 class file version
317	<	return JAVA_SPECIFICATION_VERSION.startsWith("1.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	>	}
320	>	public static boolean atLeastJava10() {
321	>	return JAVA_CLASS_VERSION >= 54.0
322	>	|| JAVA_SPECIFICATION_VERSION.matches("^(1\\.)?[0-9][0-9]$");
323		}
324
325		/**
#	Line 356 | Line 408 | public class JSR166TestCase extends Test
408		"LongAdderTest",
409		"SplittableRandomTest",
410		"StampedLockTest",
411	+	"SubmissionPublisherTest",
412		"ThreadLocalRandom8Test",
413		};
414		addNamedTestClasses(suite, java8TestClassNames);
#	Line 364 | 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 372 | Line 425 | public class JSR166TestCase extends Test
425		return suite;
426		}
427
428	+	/** Returns list of junit-style test method names in given class. */
429	+	public static ArrayList<String> testMethodNames(Class<?> testClass) {
430	+	Method[] methods = testClass.getDeclaredMethods();
431	+	ArrayList<String> names = new ArrayList<String>(methods.length);
432	+	for (Method method : methods) {
433	+	if (method.getName().startsWith("test")
434	+	&& Modifier.isPublic(method.getModifiers())
435	+	// method.getParameterCount() requires jdk8+
436	+	&& method.getParameterTypes().length == 0) {
437	+	names.add(method.getName());
438	+	}
439	+	}
440	+	return names;
441	+	}
442	+
443	+	/**
444	+	* Returns junit-style testSuite for the given test class, but
445	+	* parameterized by passing extra data to each test.
446	+	*/
447	+	public static <ExtraData> Test parameterizedTestSuite
448	+	(Class<? extends JSR166TestCase> testClass,
449	+	Class<ExtraData> dataClass,
450	+	ExtraData data) {
451	+	try {
452	+	TestSuite suite = new TestSuite();
453	+	Constructor c =
454	+	testClass.getDeclaredConstructor(dataClass, String.class);
455	+	for (String methodName : testMethodNames(testClass))
456	+	suite.addTest((Test) c.newInstance(data, methodName));
457	+	return suite;
458	+	} catch (Exception e) {
459	+	throw new Error(e);
460	+	}
461	+	}
462	+
463	+	/**
464	+	* Returns junit-style testSuite for the jdk8 extension of the
465	+	* given test class, but parameterized by passing extra data to
466	+	* each test.  Uses reflection to allow compilation in jdk7.
467	+	*/
468	+	public static <ExtraData> Test jdk8ParameterizedTestSuite
469	+	(Class<? extends JSR166TestCase> testClass,
470	+	Class<ExtraData> dataClass,
471	+	ExtraData data) {
472	+	if (atLeastJava8()) {
473	+	String name = testClass.getName();
474	+	String name8 = name.replaceAll("Test$", "8Test");
475	+	if (name.equals(name8)) throw new Error(name);
476	+	try {
477	+	return (Test)
478	+	Class.forName(name8)
479	+	.getMethod("testSuite", new Class[] { dataClass })
480	+	.invoke(null, data);
481	+	} catch (Exception e) {
482	+	throw new Error(e);
483	+	}
484	+	} else {
485	+	return new TestSuite();
486	+	}
487	+	}
488	+
489		// Delays for timing-dependent tests, in milliseconds.
490
491		public static long SHORT_DELAY_MS;
#	Line 406 | Line 520 | public class JSR166TestCase extends Test
520		}
521
522		/**
523	<	* Returns a new Date instance representing a time delayMillis
524	<	* milliseconds in the future.
523	>	* Returns a new Date instance representing a time at least
524	>	* delayMillis milliseconds in the future.
525		*/
526		Date delayedDate(long delayMillis) {
527	<	return new Date(System.currentTimeMillis() + delayMillis);
527	>	// Add 1 because currentTimeMillis is known to round into the past.
528	>	return new Date(System.currentTimeMillis() + delayMillis + 1);
529		}
530
531		/**
#	Line 426 | 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 433 | 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 460 | 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 469 | 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 477 | 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	<	thread.stop();
606	<	throw new AssertionFailedError
483	<	(String.format("Found leaked ForkJoinPool thread test=%s thread=%s%n",
484	<	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 496 | 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 564 | Line 690 | public class JSR166TestCase extends Test
690		public void threadAssertEquals(Object x, Object y) {
691		try {
692		assertEquals(x, y);
693	<	} catch (AssertionFailedError t) {
694	<	threadRecordFailure(t);
695	<	throw t;
696	<	} catch (Throwable t) {
697	<	threadUnexpectedException(t);
693	>	} catch (AssertionFailedError fail) {
694	>	threadRecordFailure(fail);
695	>	throw fail;
696	>	} catch (Throwable fail) {
697	>	threadUnexpectedException(fail);
698		}
699		}
700
#	Line 580 | Line 706 | public class JSR166TestCase extends Test
706		public void threadAssertSame(Object x, Object y) {
707		try {
708		assertSame(x, y);
709	<	} catch (AssertionFailedError t) {
710	<	threadRecordFailure(t);
711	<	throw t;
709	>	} catch (AssertionFailedError fail) {
710	>	threadRecordFailure(fail);
711	>	throw fail;
712		}
713		}
714
#	Line 642 | 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 PoolCloser<T extends ExecutorService>
774	+	implements AutoCloseable {
775	+	public final T pool;
776	+	public PoolCloser(T pool) { this.pool = pool; }
777	+	public void close() { joinPool(pool); }
778	+	}
779	+
780	+	/**
781		* Waits out termination of a thread pool or fails doing so.
782		*/
783	<	void joinPool(ExecutorService exec) {
783	>	void joinPool(ExecutorService pool) {
784		try {
785	<	exec.shutdown();
786	<	if (!exec.awaitTermination(2 * LONG_DELAY_MS, MILLISECONDS))
787	<	fail("ExecutorService " + exec +
788	<	" did not terminate in a timely manner");
785	>	pool.shutdown();
786	>	if (!pool.awaitTermination(2 * LONG_DELAY_MS, MILLISECONDS)) {
787	>	try {
788	>	threadFail("ExecutorService " + pool +
789	>	" did not terminate in a timely manner");
790	>	} finally {
791	>	// last resort, for the benefit of subsequent tests
792	>	pool.shutdownNow();
793	>	pool.awaitTermination(SMALL_DELAY_MS, MILLISECONDS);
794	>	}
795	>	}
796		} catch (SecurityException ok) {
797		// Allowed in case test doesn't have privs
798		} catch (InterruptedException fail) {
799	<	fail("Unexpected InterruptedException");
799	>	threadFail("Unexpected InterruptedException");
800		}
801		}
802
803	+	/** Like Runnable, but with the freedom to throw anything */
804	+	interface Action { public void run() throws Throwable; }
805	+
806		/**
807	<	* A debugging tool to print all stack traces, as jstack does.
807	>	* Runs all the given actions in parallel, failing if any fail.
808	>	* Useful for running multiple variants of tests that are
809	>	* necessarily individually slow because they must block.
810		*/
811	<	static void printAllStackTraces() {
812	<	for (ThreadInfo info :
813	<	ManagementFactory.getThreadMXBean()
814	<	.dumpAllThreads(true, true))
811	>	void testInParallel(Action ... actions) {
812	>	try (PoolCloser<ExecutorService> poolCloser
813	>	= new PoolCloser<>(Executors.newCachedThreadPool())) {
814	>	ExecutorService pool = poolCloser.pool;
815	>	ArrayList<Future<?>> futures = new ArrayList<>(actions.length);
816	>	for (final Action action : actions)
817	>	futures.add(pool.submit(new CheckedRunnable() {
818	>	public void realRun() throws Throwable { action.run();}}));
819	>	for (Future<?> future : futures)
820	>	try {
821	>	assertNull(future.get(LONG_DELAY_MS, MILLISECONDS));
822	>	} catch (ExecutionException ex) {
823	>	threadUnexpectedException(ex.getCause());
824	>	} catch (Exception ex) {
825	>	threadUnexpectedException(ex);
826	>	}
827	>	}
828	>	}
829	>
830	>	/**
831	>	* A debugging tool to print stack traces of most threads, as jstack does.
832	>	* Uninteresting threads are filtered out.
833	>	*/
834	>	static void dumpTestThreads() {
835	>	ThreadMXBean threadMXBean = ManagementFactory.getThreadMXBean();
836	>	System.err.println("------ stacktrace dump start ------");
837	>	for (ThreadInfo info : threadMXBean.dumpAllThreads(true, true)) {
838	>	String name = info.getThreadName();
839	>	if ("Signal Dispatcher".equals(name))
840	>	continue;
841	>	if ("Reference Handler".equals(name)
842	>	&& info.getLockName().startsWith("java.lang.ref.Reference$Lock"))
843	>	continue;
844	>	if ("Finalizer".equals(name)
845	>	&& info.getLockName().startsWith("java.lang.ref.ReferenceQueue$Lock"))
846	>	continue;
847	>	if ("checkForWedgedTest".equals(name))
848	>	continue;
849		System.err.print(info);
850	+	}
851	+	System.err.println("------ stacktrace dump end ------");
852		}
853
854		/**
#	Line 684 | Line 868 | public class JSR166TestCase extends Test
868		delay(millis);
869		assertTrue(thread.isAlive());
870		} catch (InterruptedException fail) {
871	<	fail("Unexpected InterruptedException");
871	>	threadFail("Unexpected InterruptedException");
872		}
873		}
874
#	Line 706 | Line 890 | public class JSR166TestCase extends Test
890		for (Thread thread : threads)
891		assertTrue(thread.isAlive());
892		} catch (InterruptedException fail) {
893	<	fail("Unexpected InterruptedException");
893	>	threadFail("Unexpected InterruptedException");
894		}
895		}
896
#	Line 1109 | Line 1293 | public class JSR166TestCase extends Test
1293		public static final String TEST_STRING = "a test string";
1294
1295		public static class StringTask implements Callable<String> {
1296	<	public String call() { return TEST_STRING; }
1296	>	final String value;
1297	>	public StringTask() { this(TEST_STRING); }
1298	>	public StringTask(String value) { this.value = value; }
1299	>	public String call() { return value; }
1300		}
1301
1302		public Callable<String> latchAwaitingStringTask(final CountDownLatch latch) {
#	Line 1122 | Line 1309 | public class JSR166TestCase extends Test
1309		}};
1310		}
1311
1312	+	public Runnable countDowner(final CountDownLatch latch) {
1313	+	return new CheckedRunnable() {
1314	+	public void realRun() throws InterruptedException {
1315	+	latch.countDown();
1316	+	}};
1317	+	}
1318	+
1319		public Runnable awaiter(final CountDownLatch latch) {
1320		return new CheckedRunnable() {
1321		public void realRun() throws InterruptedException {

Diff Legend

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