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.140 by dl, Mon Sep 7 17:14:06 2015 UTC vs.
Revision 1.166 by jsr166, Mon Oct 5 21:39:39 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 40 | Line 42 | import java.util.concurrent.CyclicBarrie
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 67 | 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 89 | 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 185 | 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	>	// one stack dump is probably enough; more would be spam
205	>	break;
206	>	}
207	>	lastTestCase = currentTestCase;
208	>	}}};
209	>	Thread thread = new Thread(checkForWedgedTest, "checkForWedgedTest");
210	>	thread.setDaemon(true);
211	>	thread.start();
212	>	}
213	>
214	>	public void runBare() throws Throwable {
215	>	currentTestCase = this;
216		if (methodFilter == null
217	<	|| methodFilter.matcher(toString()).find()) {
218	<	for (int i = 0; i < runsPerTest; i++) {
219	<	if (profileTests)
220	<	runTestProfiled();
221	<	else
222	<	super.runTest();
223	<	}
217	>	|| methodFilter.matcher(toString()).find())
218	>	super.runBare();
219	>	}
220	>
221	>	protected void runTest() throws Throwable {
222	>	for (int i = 0; i < runsPerTest; i++) {
223	>	if (profileTests)
224	>	runTestProfiled();
225	>	else
226	>	super.runTest();
227		}
228		}
229
230		protected void runTestProfiled() throws Throwable {
231	<	// Warmup run, notably to trigger all needed classloading.
232	<	super.runTest();
203	<	long t0 = System.nanoTime();
204	<	try {
231	>	for (int i = 0; i < 2; i++) {
232	>	long startTime = System.nanoTime();
233		super.runTest();
234	<	} finally {
235	<	long elapsedMillis = millisElapsedSince(t0);
236	<	if (elapsedMillis >= profileThreshold)
234	>	long elapsedMillis = millisElapsedSince(startTime);
235	>	if (elapsedMillis < profileThreshold)
236	>	break;
237	>	// Never report first run of any test; treat it as a
238	>	// warmup run, notably to trigger all needed classloading,
239	>	if (i > 0)
240		System.out.printf("%n%s: %d%n", toString(), elapsedMillis);
241		}
242		}
#	Line 388 | Line 419 | public class JSR166TestCase extends Test
419		// Java9+ test classes
420		if (atLeastJava9()) {
421		String[] java9TestClassNames = {
422	<	// Currently empty
422	>	// Currently empty, but expecting varhandle tests
423		};
424		addNamedTestClasses(suite, java9TestClassNames);
425		}
#	Line 455 | Line 486 | public class JSR166TestCase extends Test
486		} else {
487		return new TestSuite();
488		}
458	–
489		}
490
491		// Delays for timing-dependent tests, in milliseconds.
#	Line 513 | Line 543 | public class JSR166TestCase extends Test
543		* the same test have no effect.
544		*/
545		public void threadRecordFailure(Throwable t) {
546	+	System.err.println(t);
547	+	dumpTestThreads();
548		threadFailure.compareAndSet(null, t);
549		}
550
#	Line 520 | Line 552 | public class JSR166TestCase extends Test
552		setDelays();
553		}
554
555	+	void tearDownFail(String format, Object... args) {
556	+	String msg = toString() + ": " + String.format(format, args);
557	+	System.err.println(msg);
558	+	dumpTestThreads();
559	+	throw new AssertionFailedError(msg);
560	+	}
561	+
562		/**
563		* Extra checks that get done for all test cases.
564		*
#	Line 547 | Line 586 | public class JSR166TestCase extends Test
586		}
587
588		if (Thread.interrupted())
589	<	throw new AssertionFailedError("interrupt status set in main thread");
589	>	tearDownFail("interrupt status set in main thread");
590
591		checkForkJoinPoolThreadLeaks();
592		}
593
594		/**
595	<	* Finds missing try { ... } finally { joinPool(e); }
595	>	* Finds missing PoolCleaners
596		*/
597		void checkForkJoinPoolThreadLeaks() throws InterruptedException {
598	<	Thread[] survivors = new Thread[5];
598	>	Thread[] survivors = new Thread[7];
599		int count = Thread.enumerate(survivors);
600		for (int i = 0; i < count; i++) {
601		Thread thread = survivors[i];
#	Line 564 | Line 603 | public class JSR166TestCase extends Test
603		if (name.startsWith("ForkJoinPool-")) {
604		// give thread some time to terminate
605		thread.join(LONG_DELAY_MS);
606	<	if (!thread.isAlive()) continue;
607	<	throw new AssertionFailedError
608	<	(String.format("Found leaked ForkJoinPool thread test=%s thread=%s%n",
570	<	toString(), name));
606	>	if (thread.isAlive())
607	>	tearDownFail("Found leaked ForkJoinPool thread thread=%s",
608	>	thread);
609		}
610		}
611	+
612	+	if (!ForkJoinPool.commonPool()
613	+	.awaitQuiescence(LONG_DELAY_MS, MILLISECONDS))
614	+	tearDownFail("ForkJoin common pool thread stuck");
615		}
616
617		/**
#	Line 582 | Line 624 | public class JSR166TestCase extends Test
624		fail(reason);
625		} catch (AssertionFailedError t) {
626		threadRecordFailure(t);
627	<	fail(reason);
627	>	throw t;
628		}
629		}
630
#	Line 709 | Line 751 | public class JSR166TestCase extends Test
751		/**
752		* Delays, via Thread.sleep, for the given millisecond delay, but
753		* if the sleep is shorter than specified, may re-sleep or yield
754	<	* until time elapses.
754	>	* until time elapses.  Ensures that the given time, as measured
755	>	* by System.nanoTime(), has elapsed.
756		*/
757		static void delay(long millis) throws InterruptedException {
758	<	long startTime = System.nanoTime();
759	<	long ns = millis * 1000 * 1000;
760	<	for (;;) {
758	>	long nanos = millis * (1000 * 1000);
759	>	final long wakeupTime = System.nanoTime() + nanos;
760	>	do {
761		if (millis > 0L)
762		Thread.sleep(millis);
763		else // too short to sleep
764		Thread.yield();
765	<	long d = ns - (System.nanoTime() - startTime);
766	<	if (d > 0L)
767	<	millis = d / (1000 * 1000);
768	<	else
769	<	break;
765	>	nanos = wakeupTime - System.nanoTime();
766	>	millis = nanos / (1000 * 1000);
767	>	} while (nanos >= 0L);
768	>	}
769	>
770	>	/**
771	>	* Allows use of try-with-resources with per-test thread pools.
772	>	*/
773	>	class PoolCleaner implements AutoCloseable {
774	>	private final ExecutorService pool;
775	>	public PoolCleaner(ExecutorService pool) { this.pool = pool; }
776	>	public void close() { joinPool(pool); }
777	>	}
778	>
779	>	/**
780	>	* An extension of PoolCleaner that has an action to release the pool.
781	>	*/
782	>	class PoolCleanerWithReleaser extends PoolCleaner {
783	>	private final Runnable releaser;
784	>	public PoolCleanerWithReleaser(ExecutorService pool, Runnable releaser) {
785	>	super(pool);
786	>	this.releaser = releaser;
787	>	}
788	>	public void close() {
789	>	try {
790	>	releaser.run();
791	>	} finally {
792	>	super.close();
793	>	}
794		}
795		}
796
797	+	PoolCleaner cleaner(ExecutorService pool) {
798	+	return new PoolCleaner(pool);
799	+	}
800	+
801	+	PoolCleaner cleaner(ExecutorService pool, Runnable releaser) {
802	+	return new PoolCleanerWithReleaser(pool, releaser);
803	+	}
804	+
805	+	PoolCleaner cleaner(ExecutorService pool, CountDownLatch latch) {
806	+	return new PoolCleanerWithReleaser(pool, releaser(latch));
807	+	}
808	+
809	+	Runnable releaser(final CountDownLatch latch) {
810	+	return new Runnable() { public void run() {
811	+	do { latch.countDown(); }
812	+	while (latch.getCount() > 0);
813	+	}};
814	+	}
815	+
816		/**
817		* Waits out termination of a thread pool or fails doing so.
818		*/
819		void joinPool(ExecutorService pool) {
820		try {
821		pool.shutdown();
822	<	if (!pool.awaitTermination(2 * LONG_DELAY_MS, MILLISECONDS))
823	<	fail("ExecutorService " + pool +
824	<	" did not terminate in a timely manner");
822	>	if (!pool.awaitTermination(2 * LONG_DELAY_MS, MILLISECONDS)) {
823	>	try {
824	>	threadFail("ExecutorService " + pool +
825	>	" did not terminate in a timely manner");
826	>	} finally {
827	>	// last resort, for the benefit of subsequent tests
828	>	pool.shutdownNow();
829	>	pool.awaitTermination(SMALL_DELAY_MS, MILLISECONDS);
830	>	}
831	>	}
832		} catch (SecurityException ok) {
833		// Allowed in case test doesn't have privs
834		} catch (InterruptedException fail) {
835	<	fail("Unexpected InterruptedException");
835	>	threadFail("Unexpected InterruptedException");
836		}
837		}
838
839		/** Like Runnable, but with the freedom to throw anything */
840	<	interface Thunk { public void run() throws Throwable; }
840	>	interface Action { public void run() throws Throwable; }
841
842		/**
843	<	* Runs all the given tasks in parallel, failing if any fail.
843	>	* Runs all the given actions in parallel, failing if any fail.
844		* Useful for running multiple variants of tests that are
845		* necessarily individually slow because they must block.
846		*/
847	<	void testInParallel(Thunk ... thunks) {
847	>	void testInParallel(Action ... actions) {
848		ExecutorService pool = Executors.newCachedThreadPool();
849	<	try {
850	<	ArrayList<Future<?>> futures = new ArrayList<>(thunks.length);
851	<	for (final Thunk thunk : thunks)
849	>	try (PoolCleaner cleaner = cleaner(pool)) {
850	>	ArrayList<Future<?>> futures = new ArrayList<>(actions.length);
851	>	for (final Action action : actions)
852		futures.add(pool.submit(new CheckedRunnable() {
853	<	public void realRun() throws Throwable { thunk.run();}}));
853	>	public void realRun() throws Throwable { action.run();}}));
854		for (Future<?> future : futures)
855		try {
856		assertNull(future.get(LONG_DELAY_MS, MILLISECONDS));
#	Line 766 | Line 859 | public class JSR166TestCase extends Test
859		} catch (Exception ex) {
860		threadUnexpectedException(ex);
861		}
769	–	} finally {
770	–	joinPool(pool);
862		}
863		}
864
865		/**
866	<	* A debugging tool to print all stack traces, as jstack does.
866	>	* A debugging tool to print stack traces of most threads, as jstack does.
867	>	* Uninteresting threads are filtered out.
868		*/
869	<	static void printAllStackTraces() {
870	<	for (ThreadInfo info :
871	<	ManagementFactory.getThreadMXBean()
872	<	.dumpAllThreads(true, true))
869	>	static void dumpTestThreads() {
870	>	ThreadMXBean threadMXBean = ManagementFactory.getThreadMXBean();
871	>	System.err.println("------ stacktrace dump start ------");
872	>	for (ThreadInfo info : threadMXBean.dumpAllThreads(true, true)) {
873	>	String name = info.getThreadName();
874	>	if ("Signal Dispatcher".equals(name))
875	>	continue;
876	>	if ("Reference Handler".equals(name)
877	>	&& info.getLockName().startsWith("java.lang.ref.Reference$Lock"))
878	>	continue;
879	>	if ("Finalizer".equals(name)
880	>	&& info.getLockName().startsWith("java.lang.ref.ReferenceQueue$Lock"))
881	>	continue;
882	>	if ("checkForWedgedTest".equals(name))
883	>	continue;
884		System.err.print(info);
885	+	}
886	+	System.err.println("------ stacktrace dump end ------");
887		}
888
889		/**
#	Line 798 | Line 903 | public class JSR166TestCase extends Test
903		delay(millis);
904		assertTrue(thread.isAlive());
905		} catch (InterruptedException fail) {
906	<	fail("Unexpected InterruptedException");
906	>	threadFail("Unexpected InterruptedException");
907		}
908		}
909
#	Line 820 | Line 925 | public class JSR166TestCase extends Test
925		for (Thread thread : threads)
926		assertTrue(thread.isAlive());
927		} catch (InterruptedException fail) {
928	<	fail("Unexpected InterruptedException");
928	>	threadFail("Unexpected InterruptedException");
929		}
930		}
931
#	Line 1223 | Line 1328 | public class JSR166TestCase extends Test
1328		public static final String TEST_STRING = "a test string";
1329
1330		public static class StringTask implements Callable<String> {
1331	<	public String call() { return TEST_STRING; }
1331	>	final String value;
1332	>	public StringTask() { this(TEST_STRING); }
1333	>	public StringTask(String value) { this.value = value; }
1334	>	public String call() { return value; }
1335		}
1336
1337		public Callable<String> latchAwaitingStringTask(final CountDownLatch latch) {
#	Line 1236 | Line 1344 | public class JSR166TestCase extends Test
1344		}};
1345		}
1346
1347	<	public Runnable awaiter(final CountDownLatch latch) {
1347	>	public Runnable countDowner(final CountDownLatch latch) {
1348		return new CheckedRunnable() {
1349		public void realRun() throws InterruptedException {
1350	<	await(latch);
1350	>	latch.countDown();
1351		}};
1352		}
1353
1354	+	class LatchAwaiter extends CheckedRunnable {
1355	+	static final int NEW = 0;
1356	+	static final int RUNNING = 1;
1357	+	static final int DONE = 2;
1358	+	final CountDownLatch latch;
1359	+	int state = NEW;
1360	+	LatchAwaiter(CountDownLatch latch) { this.latch = latch; }
1361	+	public void realRun() throws InterruptedException {
1362	+	state = 1;
1363	+	await(latch);
1364	+	state = 2;
1365	+	}
1366	+	}
1367	+
1368	+	public LatchAwaiter awaiter(CountDownLatch latch) {
1369	+	return new LatchAwaiter(latch);
1370	+	}
1371	+
1372		public void await(CountDownLatch latch) {
1373		try {
1374		assertTrue(latch.await(LONG_DELAY_MS, MILLISECONDS));

Diff Legend

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