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.177 by jsr166, Mon Oct 12 23:52:44 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 37 | Line 41 | import java.util.concurrent.BlockingQueu
41		import java.util.concurrent.Callable;
42		import java.util.concurrent.CountDownLatch;
43		import java.util.concurrent.CyclicBarrier;
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 47 | 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 65 | 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 87 | 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 183 | 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();
201	<	long t0 = System.nanoTime();
202	<	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 282 | Line 340 | public class JSR166TestCase extends Test
340		public static boolean atLeastJava7() { return JAVA_CLASS_VERSION >= 51.0; }
341		public static boolean atLeastJava8() { return JAVA_CLASS_VERSION >= 52.0; }
342		public static boolean atLeastJava9() {
343	<	// As of 2015-09, java9 still uses 52.0 class file version
344	<	return JAVA_SPECIFICATION_VERSION.matches("^(1\\.)?(9|[0-9][0-9])$");
343	>	return JAVA_CLASS_VERSION >= 53.0
344	>	// As of 2015-09, java9 still uses 52.0 class file version
345	>	|| JAVA_SPECIFICATION_VERSION.matches("^(1\\.)?(9|[0-9][0-9])$");
346		}
288	–	// public static boolean atLeastJava9() { return JAVA_CLASS_VERSION >= 53.0; }
347		public static boolean atLeastJava10() {
348	<	return JAVA_SPECIFICATION_VERSION.matches("^(1\\.)?[0-9][0-9]$");
348	>	return JAVA_CLASS_VERSION >= 54.0
349	>	|| JAVA_SPECIFICATION_VERSION.matches("^(1\\.)?[0-9][0-9]$");
350		}
351
352		/**
#	Line 376 | Line 435 | public class JSR166TestCase extends Test
435		"LongAdderTest",
436		"SplittableRandomTest",
437		"StampedLockTest",
438	+	"SubmissionPublisherTest",
439		"ThreadLocalRandom8Test",
440		};
441		addNamedTestClasses(suite, java8TestClassNames);
#	Line 384 | Line 444 | public class JSR166TestCase extends Test
444		// Java9+ test classes
445		if (atLeastJava9()) {
446		String[] java9TestClassNames = {
447	<	"ThreadPoolExecutor9Test",
447	>	// Currently empty, but expecting varhandle tests
448		};
449		addNamedTestClasses(suite, java9TestClassNames);
450		}
#	Line 451 | Line 511 | public class JSR166TestCase extends Test
511		} else {
512		return new TestSuite();
513		}
454	–
514		}
515
516		// Delays for timing-dependent tests, in milliseconds.
#	Line 509 | Line 568 | public class JSR166TestCase extends Test
568		* the same test have no effect.
569		*/
570		public void threadRecordFailure(Throwable t) {
571	+	System.err.println(t);
572	+	dumpTestThreads();
573		threadFailure.compareAndSet(null, t);
574		}
575
#	Line 516 | Line 577 | public class JSR166TestCase extends Test
577		setDelays();
578		}
579
580	+	void tearDownFail(String format, Object... args) {
581	+	String msg = toString() + ": " + String.format(format, args);
582	+	System.err.println(msg);
583	+	dumpTestThreads();
584	+	throw new AssertionFailedError(msg);
585	+	}
586	+
587		/**
588		* Extra checks that get done for all test cases.
589		*
#	Line 543 | Line 611 | public class JSR166TestCase extends Test
611		}
612
613		if (Thread.interrupted())
614	<	throw new AssertionFailedError("interrupt status set in main thread");
614	>	tearDownFail("interrupt status set in main thread");
615
616		checkForkJoinPoolThreadLeaks();
617		}
618
619		/**
620	<	* Finds missing try { ... } finally { joinPool(e); }
620	>	* Finds missing PoolCleaners
621		*/
622		void checkForkJoinPoolThreadLeaks() throws InterruptedException {
623	<	Thread[] survivors = new Thread[5];
623	>	Thread[] survivors = new Thread[7];
624		int count = Thread.enumerate(survivors);
625		for (int i = 0; i < count; i++) {
626		Thread thread = survivors[i];
#	Line 560 | Line 628 | public class JSR166TestCase extends Test
628		if (name.startsWith("ForkJoinPool-")) {
629		// give thread some time to terminate
630		thread.join(LONG_DELAY_MS);
631	<	if (!thread.isAlive()) continue;
632	<	throw new AssertionFailedError
633	<	(String.format("Found leaked ForkJoinPool thread test=%s thread=%s%n",
566	<	toString(), name));
631	>	if (thread.isAlive())
632	>	tearDownFail("Found leaked ForkJoinPool thread thread=%s",
633	>	thread);
634		}
635		}
636	+
637	+	if (!ForkJoinPool.commonPool()
638	+	.awaitQuiescence(LONG_DELAY_MS, MILLISECONDS))
639	+	tearDownFail("ForkJoin common pool thread stuck");
640		}
641
642		/**
#	Line 578 | Line 649 | public class JSR166TestCase extends Test
649		fail(reason);
650		} catch (AssertionFailedError t) {
651		threadRecordFailure(t);
652	<	fail(reason);
652	>	throw t;
653		}
654		}
655
#	Line 705 | Line 776 | public class JSR166TestCase extends Test
776		/**
777		* Delays, via Thread.sleep, for the given millisecond delay, but
778		* if the sleep is shorter than specified, may re-sleep or yield
779	<	* until time elapses.
779	>	* until time elapses.  Ensures that the given time, as measured
780	>	* by System.nanoTime(), has elapsed.
781		*/
782		static void delay(long millis) throws InterruptedException {
783	<	long startTime = System.nanoTime();
784	<	long ns = millis * 1000 * 1000;
785	<	for (;;) {
783	>	long nanos = millis * (1000 * 1000);
784	>	final long wakeupTime = System.nanoTime() + nanos;
785	>	do {
786		if (millis > 0L)
787		Thread.sleep(millis);
788		else // too short to sleep
789		Thread.yield();
790	<	long d = ns - (System.nanoTime() - startTime);
791	<	if (d > 0L)
792	<	millis = d / (1000 * 1000);
793	<	else
794	<	break;
790	>	nanos = wakeupTime - System.nanoTime();
791	>	millis = nanos / (1000 * 1000);
792	>	} while (nanos >= 0L);
793	>	}
794	>
795	>	/**
796	>	* Allows use of try-with-resources with per-test thread pools.
797	>	*/
798	>	class PoolCleaner implements AutoCloseable {
799	>	private final ExecutorService pool;
800	>	public PoolCleaner(ExecutorService pool) { this.pool = pool; }
801	>	public void close() { joinPool(pool); }
802	>	}
803	>
804	>	/**
805	>	* An extension of PoolCleaner that has an action to release the pool.
806	>	*/
807	>	class PoolCleanerWithReleaser extends PoolCleaner {
808	>	private final Runnable releaser;
809	>	public PoolCleanerWithReleaser(ExecutorService pool, Runnable releaser) {
810	>	super(pool);
811	>	this.releaser = releaser;
812	>	}
813	>	public void close() {
814	>	try {
815	>	releaser.run();
816	>	} finally {
817	>	super.close();
818	>	}
819		}
820		}
821
822	+	PoolCleaner cleaner(ExecutorService pool) {
823	+	return new PoolCleaner(pool);
824	+	}
825	+
826	+	PoolCleaner cleaner(ExecutorService pool, Runnable releaser) {
827	+	return new PoolCleanerWithReleaser(pool, releaser);
828	+	}
829	+
830	+	PoolCleaner cleaner(ExecutorService pool, CountDownLatch latch) {
831	+	return new PoolCleanerWithReleaser(pool, releaser(latch));
832	+	}
833	+
834	+	Runnable releaser(final CountDownLatch latch) {
835	+	return new Runnable() { public void run() {
836	+	do { latch.countDown(); }
837	+	while (latch.getCount() > 0);
838	+	}};
839	+	}
840	+
841		/**
842		* Waits out termination of a thread pool or fails doing so.
843		*/
844	<	void joinPool(ExecutorService exec) {
844	>	void joinPool(ExecutorService pool) {
845		try {
846	<	exec.shutdown();
847	<	if (!exec.awaitTermination(2 * LONG_DELAY_MS, MILLISECONDS))
848	<	fail("ExecutorService " + exec +
849	<	" did not terminate in a timely manner");
846	>	pool.shutdown();
847	>	if (!pool.awaitTermination(2 * LONG_DELAY_MS, MILLISECONDS)) {
848	>	try {
849	>	threadFail("ExecutorService " + pool +
850	>	" did not terminate in a timely manner");
851	>	} finally {
852	>	// last resort, for the benefit of subsequent tests
853	>	pool.shutdownNow();
854	>	pool.awaitTermination(MEDIUM_DELAY_MS, MILLISECONDS);
855	>	}
856	>	}
857		} catch (SecurityException ok) {
858		// Allowed in case test doesn't have privs
859		} catch (InterruptedException fail) {
860	<	fail("Unexpected InterruptedException");
860	>	threadFail("Unexpected InterruptedException");
861		}
862		}
863
864	+	/** Like Runnable, but with the freedom to throw anything */
865	+	interface Action { public void run() throws Throwable; }
866	+
867		/**
868	<	* A debugging tool to print all stack traces, as jstack does.
868	>	* Runs all the given actions in parallel, failing if any fail.
869	>	* Useful for running multiple variants of tests that are
870	>	* necessarily individually slow because they must block.
871		*/
872	<	static void printAllStackTraces() {
873	<	for (ThreadInfo info :
874	<	ManagementFactory.getThreadMXBean()
875	<	.dumpAllThreads(true, true))
872	>	void testInParallel(Action ... actions) {
873	>	ExecutorService pool = Executors.newCachedThreadPool();
874	>	try (PoolCleaner cleaner = cleaner(pool)) {
875	>	ArrayList<Future<?>> futures = new ArrayList<>(actions.length);
876	>	for (final Action action : actions)
877	>	futures.add(pool.submit(new CheckedRunnable() {
878	>	public void realRun() throws Throwable { action.run();}}));
879	>	for (Future<?> future : futures)
880	>	try {
881	>	assertNull(future.get(LONG_DELAY_MS, MILLISECONDS));
882	>	} catch (ExecutionException ex) {
883	>	threadUnexpectedException(ex.getCause());
884	>	} catch (Exception ex) {
885	>	threadUnexpectedException(ex);
886	>	}
887	>	}
888	>	}
889	>
890	>	/**
891	>	* A debugging tool to print stack traces of most threads, as jstack does.
892	>	* Uninteresting threads are filtered out.
893	>	*/
894	>	static void dumpTestThreads() {
895	>	ThreadMXBean threadMXBean = ManagementFactory.getThreadMXBean();
896	>	System.err.println("------ stacktrace dump start ------");
897	>	for (ThreadInfo info : threadMXBean.dumpAllThreads(true, true)) {
898	>	String name = info.getThreadName();
899	>	if ("Signal Dispatcher".equals(name))
900	>	continue;
901	>	if ("Reference Handler".equals(name)
902	>	&& info.getLockName().startsWith("java.lang.ref.Reference$Lock"))
903	>	continue;
904	>	if ("Finalizer".equals(name)
905	>	&& info.getLockName().startsWith("java.lang.ref.ReferenceQueue$Lock"))
906	>	continue;
907	>	if ("checkForWedgedTest".equals(name))
908	>	continue;
909		System.err.print(info);
910	+	}
911	+	System.err.println("------ stacktrace dump end ------");
912		}
913
914		/**
#	Line 766 | Line 928 | public class JSR166TestCase extends Test
928		delay(millis);
929		assertTrue(thread.isAlive());
930		} catch (InterruptedException fail) {
931	<	fail("Unexpected InterruptedException");
931	>	threadFail("Unexpected InterruptedException");
932		}
933		}
934
#	Line 788 | Line 950 | public class JSR166TestCase extends Test
950		for (Thread thread : threads)
951		assertTrue(thread.isAlive());
952		} catch (InterruptedException fail) {
953	<	fail("Unexpected InterruptedException");
953	>	threadFail("Unexpected InterruptedException");
954		}
955		}
956
#	Line 1066 | Line 1228 | public class JSR166TestCase extends Test
1228		} finally {
1229		if (t.getState() != Thread.State.TERMINATED) {
1230		t.interrupt();
1231	<	fail("Test timed out");
1231	>	threadFail("timed out waiting for thread to terminate");
1232		}
1233		}
1234		}
#	Line 1191 | Line 1353 | public class JSR166TestCase extends Test
1353		public static final String TEST_STRING = "a test string";
1354
1355		public static class StringTask implements Callable<String> {
1356	<	public String call() { return TEST_STRING; }
1356	>	final String value;
1357	>	public StringTask() { this(TEST_STRING); }
1358	>	public StringTask(String value) { this.value = value; }
1359	>	public String call() { return value; }
1360		}
1361
1362		public Callable<String> latchAwaitingStringTask(final CountDownLatch latch) {
#	Line 1204 | Line 1369 | public class JSR166TestCase extends Test
1369		}};
1370		}
1371
1372	<	public Runnable awaiter(final CountDownLatch latch) {
1372	>	public Runnable countDowner(final CountDownLatch latch) {
1373		return new CheckedRunnable() {
1374		public void realRun() throws InterruptedException {
1375	<	await(latch);
1375	>	latch.countDown();
1376		}};
1377		}
1378
1379	+	class LatchAwaiter extends CheckedRunnable {
1380	+	static final int NEW = 0;
1381	+	static final int RUNNING = 1;
1382	+	static final int DONE = 2;
1383	+	final CountDownLatch latch;
1384	+	int state = NEW;
1385	+	LatchAwaiter(CountDownLatch latch) { this.latch = latch; }
1386	+	public void realRun() throws InterruptedException {
1387	+	state = 1;
1388	+	await(latch);
1389	+	state = 2;
1390	+	}
1391	+	}
1392	+
1393	+	public LatchAwaiter awaiter(CountDownLatch latch) {
1394	+	return new LatchAwaiter(latch);
1395	+	}
1396	+
1397		public void await(CountDownLatch latch) {
1398		try {
1399	<	assertTrue(latch.await(LONG_DELAY_MS, MILLISECONDS));
1399	>	if (!latch.await(LONG_DELAY_MS, MILLISECONDS))
1400	>	fail("timed out waiting for CountDownLatch for "
1401	>	+ (LONG_DELAY_MS/1000) + " sec");
1402		} catch (Throwable fail) {
1403		threadUnexpectedException(fail);
1404		}
#	Line 1221 | Line 1406 | public class JSR166TestCase extends Test
1406
1407		public void await(Semaphore semaphore) {
1408		try {
1409	<	assertTrue(semaphore.tryAcquire(LONG_DELAY_MS, MILLISECONDS));
1409	>	if (!semaphore.tryAcquire(LONG_DELAY_MS, MILLISECONDS))
1410	>	fail("timed out waiting for Semaphore for "
1411	>	+ (LONG_DELAY_MS/1000) + " sec");
1412		} catch (Throwable fail) {
1413		threadUnexpectedException(fail);
1414		}

Diff Legend

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