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.4 by dl, Thu Sep 25 11:02:41 2003 UTC vs.
Revision 1.15 by dl, Mon Dec 29 19:05:40 2003 UTC

#	Line 1 | Line 1
1		/*
2	<	* Written by members of JCP JSR-166 Expert Group and released to the
3	<	* public domain. Use, modify, and redistribute this code in any way
4	<	* without acknowledgement. Other contributors include Andrew Wright,
5	<	* Jeffrey Hayes, Pat Fischer, Mike Judd.
2	>	* Written by Doug Lea with assistance from members of JCP JSR-166
3	>	* Expert Group and released to the public domain, as explained at
4	>	* http://creativecommons.org/licenses/publicdomain
5	>	* Other contributors include Andrew Wright, Jeffrey Hayes,
6	>	* Pat Fisher, Mike Judd.
7		*/
8
9		import junit.framework.*;
10		import java.util.*;
11		import java.util.concurrent.*;
12		import java.io.*;
13	<
13	>	import java.security.*;
14
15		/**
16	<	* Base class for JSR166 Junit TCK tests.  Defines some constants and
17	<	* utility methods, as well as a simple framework for helping to make
18	<	* sure that assertions failing in generated threads cause the
19	<	* associated test that generated them to itself fail (which JUnit doe
20	<	* not otherwise arrange).  The rules for creating such tests are:
16	>	* Base class for JSR166 Junit TCK tests.  Defines some constants,
17	>	* utility methods and classes, as well as a simple framework for
18	>	* helping to make sure that assertions failing in generated threads
19	>	* cause the associated test that generated them to itself fail (which
20	>	* JUnit doe not otherwise arrange).  The rules for creating such
21	>	* tests are:
22		*
23		* <ol>
24		*
#	Line 33 | Line 35 | import java.io.*;
35		* them. These methods are used to clear and check for thread
36		* assertion failures.</li>
37		*
38	<	* <li>All delays and timeouts must use one of the constants {@link
39	<	* SHORT_DELAY_MS}, {@link SMALL_DELAY_MS}, {@link MEDIUM_DELAY_MS},
40	<	* {@link LONG_DELAY_MS}. The idea here is that a SHORT is always
41	<	* discriminatable from zero time, and always allows enough time for
42	<	* the small amounts of computation (creating a thread, calling a few
38	>	* <li>All delays and timeouts must use one of the constants <tt>
39	>	* SHORT_DELAY_MS</tt>, <tt> SMALL_DELAY_MS</tt>, <tt> MEDIUM_DELAY_MS</tt>,
40	>	* <tt> LONG_DELAY_MS</tt>. The idea here is that a SHORT is always
41	>	* discriminable from zero time, and always allows enough time for the
42	>	* small amounts of computation (creating a thread, calling a few
43		* methods, etc) needed to reach a timeout point. Similarly, a SMALL
44		* is always discriminable as larger than SHORT and smaller than
45		* MEDIUM.  And so on. These constants are set to conservative values,
#	Line 46 | Line 48 | import java.io.*;
48		*
49		* <li> All threads generated must be joined inside each test case
50		* method (or <tt>fail</tt> to do so) before returning from the
51	<	* method. The {@link joinPool} method can be used to do this when
51	>	* method. The <tt> joinPool</tt> method can be used to do this when
52		* using Executors.</li>
53		*
54		* </ol>
55	+	*
56	+	* <p> <b>Other notes</b>
57	+	* <ul>
58	+	*
59	+	* <li> Usually, there is one testcase method per JSR166 method
60	+	* covering "normal" operation, and then as many exception-testing
61	+	* methods as there are exceptions the method can throw. Sometimes
62	+	* there are multiple tests per JSR166 method when the different
63	+	* "normal" behaviors differ significantly. And sometimes testcases
64	+	* cover multiple methods when they cannot be tested in
65	+	* isolation.</li>
66	+	*
67	+	* <li> The documentation style for testcases is to provide as javadoc
68	+	* a simple sentence or two describing the property that the testcase
69	+	* method purports to test. The javadocs do not say anything about how
70	+	* the property is tested. To find out, read the code.</li>
71	+	*
72	+	* <li> These tests are "conformance tests", and do not attempt to
73	+	* test throughput, latency, scalability or other performance factors
74	+	* (see the separate "jtreg" tests for a set intended to check these
75	+	* for the most central aspects of functionality.) So, most tests use
76	+	* the smallest sensible numbers of threads, collection sizes, etc
77	+	* needed to check basic conformance.</li>
78	+	*
79	+	* <li>The test classes currently do not declare inclusion in
80	+	* any particular package to simplify things for people integrating
81	+	* them in TCK test suites.</li>
82	+	*
83	+	* <li> As a convenience, the <tt>main</tt> of this class (JSR166TestCase)
84	+	* runs all JSR166 unit tests.</li>
85	+	*
86	+	* </ul>
87		*/
88		public class JSR166TestCase extends TestCase {
89	+	/**
90	+	* Runs all JSR166 unit tests using junit.textui.TestRunner
91	+	*/
92	+	public static void main (String[] args) {
93	+	junit.textui.TestRunner.run (suite());
94	+	}
95	+
96	+	/**
97	+	* Collects all JSR166 unit tests as one suite
98	+	*/
99	+	public static Test suite ( ) {
100	+	TestSuite suite = new TestSuite("JSR166 Unit Tests");
101	+
102	+	suite.addTest(new TestSuite(AbstractExecutorServiceTest.class));
103	+	suite.addTest(new TestSuite(AbstractQueuedSynchronizerTest.class));
104	+	suite.addTest(new TestSuite(ArrayBlockingQueueTest.class));
105	+	suite.addTest(new TestSuite(AtomicBooleanTest.class));
106	+	suite.addTest(new TestSuite(AtomicIntegerArrayTest.class));
107	+	suite.addTest(new TestSuite(AtomicIntegerFieldUpdaterTest.class));
108	+	suite.addTest(new TestSuite(AtomicIntegerTest.class));
109	+	suite.addTest(new TestSuite(AtomicLongArrayTest.class));
110	+	suite.addTest(new TestSuite(AtomicLongFieldUpdaterTest.class));
111	+	suite.addTest(new TestSuite(AtomicLongTest.class));
112	+	suite.addTest(new TestSuite(AtomicMarkableReferenceTest.class));
113	+	suite.addTest(new TestSuite(AtomicReferenceArrayTest.class));
114	+	suite.addTest(new TestSuite(AtomicReferenceFieldUpdaterTest.class));
115	+	suite.addTest(new TestSuite(AtomicReferenceTest.class));
116	+	suite.addTest(new TestSuite(AtomicStampedReferenceTest.class));
117	+	suite.addTest(new TestSuite(ConcurrentHashMapTest.class));
118	+	suite.addTest(new TestSuite(ConcurrentLinkedQueueTest.class));
119	+	suite.addTest(new TestSuite(CopyOnWriteArrayListTest.class));
120	+	suite.addTest(new TestSuite(CopyOnWriteArraySetTest.class));
121	+	suite.addTest(new TestSuite(CountDownLatchTest.class));
122	+	suite.addTest(new TestSuite(CyclicBarrierTest.class));
123	+	suite.addTest(new TestSuite(DelayQueueTest.class));
124	+	suite.addTest(new TestSuite(ExchangerTest.class));
125	+	suite.addTest(new TestSuite(ExecutorsTest.class));
126	+	suite.addTest(new TestSuite(ExecutorCompletionServiceTest.class));
127	+	suite.addTest(new TestSuite(FutureTaskTest.class));
128	+	suite.addTest(new TestSuite(LinkedBlockingQueueTest.class));
129	+	suite.addTest(new TestSuite(LinkedListTest.class));
130	+	suite.addTest(new TestSuite(LockSupportTest.class));
131	+	suite.addTest(new TestSuite(PriorityBlockingQueueTest.class));
132	+	suite.addTest(new TestSuite(PriorityQueueTest.class));
133	+	suite.addTest(new TestSuite(ReentrantLockTest.class));
134	+	suite.addTest(new TestSuite(ReentrantReadWriteLockTest.class));
135	+	suite.addTest(new TestSuite(ScheduledExecutorTest.class));
136	+	suite.addTest(new TestSuite(SemaphoreTest.class));
137	+	suite.addTest(new TestSuite(SynchronousQueueTest.class));
138	+	suite.addTest(new TestSuite(SystemTest.class));
139	+	suite.addTest(new TestSuite(ThreadLocalTest.class));
140	+	suite.addTest(new TestSuite(ThreadPoolExecutorTest.class));
141	+	suite.addTest(new TestSuite(ThreadTest.class));
142	+	suite.addTest(new TestSuite(TimeUnitTest.class));
143	+
144	+	return suite;
145	+	}
146	+
147
148		public static long SHORT_DELAY_MS;
149		public static long SMALL_DELAY_MS;
#	Line 61 | Line 153 | public class JSR166TestCase extends Test
153
154		/**
155		* Return the shortest timed delay. This could
156	<	* be reimplmented to use for example a Property.
156	>	* be reimplemented to use for example a Property.
157		*/
158		protected long getShortDelay() {
159		return 100;
#	Line 69 | Line 161 | public class JSR166TestCase extends Test
161
162
163		/**
164	<	* Set delays as multiples fo SHORT_DELAY.
164	>	* Set delays as multiples of SHORT_DELAY.
165		*/
166		protected  void setDelays() {
167		SHORT_DELAY_MS = getShortDelay();
#	Line 81 | Line 173 | public class JSR166TestCase extends Test
173		/**
174		* Flag set true if any threadAssert methods fail
175		*/
176	<	protected volatile boolean threadFailed;
176	>	volatile boolean threadFailed;
177
178		/**
179		* Initialize test to indicate that no thread assertions have failed
#	Line 98 | Line 190 | public class JSR166TestCase extends Test
190		assertFalse(threadFailed);
191		}
192
193	+	/**
194	+	* Fail, also setting status to indicate current testcase should fail
195	+	*/
196		public void threadFail(String reason) {
197		threadFailed = true;
198		fail(reason);
199		}
200
201	+	/**
202	+	* If expression not true, set status to indicate current testcase
203	+	* should fail
204	+	*/
205		public void threadAssertTrue(boolean b) {
206		if (!b) {
207		threadFailed = true;
208		assertTrue(b);
209		}
210		}
211	+
212	+	/**
213	+	* If expression not false, set status to indicate current testcase
214	+	* should fail
215	+	*/
216		public void threadAssertFalse(boolean b) {
217		if (b) {
218		threadFailed = true;
219		assertFalse(b);
220		}
221		}
222	+
223	+	/**
224	+	* If argument not null, set status to indicate current testcase
225	+	* should fail
226	+	*/
227		public void threadAssertNull(Object x) {
228		if (x != null) {
229		threadFailed = true;
230		assertNull(x);
231		}
232		}
233	+
234	+	/**
235	+	* If arguments not equal, set status to indicate current testcase
236	+	* should fail
237	+	*/
238		public void threadAssertEquals(long x, long y) {
239		if (x != y) {
240		threadFailed = true;
241		assertEquals(x, y);
242		}
243		}
244	+
245	+	/**
246	+	* If arguments not equal, set status to indicate current testcase
247	+	* should fail
248	+	*/
249		public void threadAssertEquals(Object x, Object y) {
250		if (x != y && (x == null || !x.equals(y))) {
251		threadFailed = true;
#	Line 134 | Line 253 | public class JSR166TestCase extends Test
253		}
254		}
255
256	+	/**
257	+	* threadFail with message "should throw exception"
258	+	*/
259		public void threadShouldThrow() {
260		threadFailed = true;
261		fail("should throw exception");
262		}
263
264	+	/**
265	+	* threadFail with message "Unexpected exception"
266	+	*/
267		public void threadUnexpectedException() {
268		threadFailed = true;
269		fail("Unexpected exception");
#	Line 157 | Line 282 | public class JSR166TestCase extends Test
282		}
283		}
284
285	<
285	>
286	>	/**
287	>	* fail with message "should throw exception"
288	>	*/
289		public void shouldThrow() {
290		fail("Should throw exception");
291		}
292
293	+	/**
294	+	* fail with message "Unexpected exception"
295	+	*/
296		public void unexpectedException() {
297		fail("Unexpected exception");
298		}
#	Line 170 | Line 301 | public class JSR166TestCase extends Test
301		/**
302		* The number of elements to place in collections, arrays, etc.
303		*/
304	<	public static final int SIZE = 20;
304	>	static final int SIZE = 20;
305
306		// Some convenient Integer constants
307
308	<	public static final Integer zero = new Integer(0);
309	<	public static final Integer one = new Integer(1);
310	<	public static final Integer two = new Integer(2);
311	<	public static final Integer three  = new Integer(3);
312	<	public static final Integer four  = new Integer(4);
313	<	public static final Integer five  = new Integer(5);
314	<	public static final Integer six = new Integer(6);
315	<	public static final Integer seven = new Integer(7);
316	<	public static final Integer eight = new Integer(8);
317	<	public static final Integer nine = new Integer(9);
318	<	public static final Integer m1  = new Integer(-1);
319	<	public static final Integer m2  = new Integer(-2);
320	<	public static final Integer m3  = new Integer(-3);
321	<	public static final Integer m4 = new Integer(-4);
322	<	public static final Integer m5 = new Integer(-5);
323	<	public static final Integer m10 = new Integer(-10);
308	>	static final Integer zero = new Integer(0);
309	>	static final Integer one = new Integer(1);
310	>	static final Integer two = new Integer(2);
311	>	static final Integer three  = new Integer(3);
312	>	static final Integer four  = new Integer(4);
313	>	static final Integer five  = new Integer(5);
314	>	static final Integer six = new Integer(6);
315	>	static final Integer seven = new Integer(7);
316	>	static final Integer eight = new Integer(8);
317	>	static final Integer nine = new Integer(9);
318	>	static final Integer m1  = new Integer(-1);
319	>	static final Integer m2  = new Integer(-2);
320	>	static final Integer m3  = new Integer(-3);
321	>	static final Integer m4 = new Integer(-4);
322	>	static final Integer m5 = new Integer(-5);
323	>	static final Integer m10 = new Integer(-10);
324	>
325	>
326	>	/**
327	>	* A security policy where new permissions can be dynamically added
328	>	* or all cleared.
329	>	*/
330	>	static class AdjustablePolicy extends java.security.Policy {
331	>	Permissions perms = new Permissions();
332	>	AdjustablePolicy() { }
333	>	void addPermission(Permission perm) { perms.add(perm); }
334	>	void clearPermissions() { perms = new Permissions(); }
335	>	public PermissionCollection getPermissions(CodeSource cs) {
336	>	return perms;
337	>	}
338	>	public PermissionCollection getPermissions(ProtectionDomain pd) {
339	>	return perms;
340	>	}
341	>	public boolean implies(ProtectionDomain pd, Permission p) {
342	>	return perms.implies(p);
343	>	}
344	>	public void refresh() {}
345	>	}
346
347
348		// Some convenient Runnable classes
349
350	<	public static class NoOpRunnable implements Runnable {
350	>	static class NoOpRunnable implements Runnable {
351		public void run() {}
352		}
353
354	<	public static class NoOpCallable implements Callable {
354	>	static class NoOpCallable implements Callable {
355		public Object call() { return Boolean.TRUE; }
356		}
357
358	<	public class ShortRunnable implements Runnable {
358	>	static final String TEST_STRING = "a test string";
359	>
360	>	static class StringTask implements Callable<String> {
361	>	public String call() { return TEST_STRING; }
362	>	}
363	>
364	>	static class NPETask implements Callable<String> {
365	>	public String call() { throw new NullPointerException(); }
366	>	}
367	>
368	>	static class CallableOne implements Callable<Integer> {
369	>	public Integer call() { return one; }
370	>	}
371	>
372	>	class ShortRunnable implements Runnable {
373		public void run() {
374		try {
375		Thread.sleep(SHORT_DELAY_MS);
#	Line 213 | Line 380 | public class JSR166TestCase extends Test
380		}
381		}
382
383	<	public class ShortInterruptedRunnable implements Runnable {
383	>	class ShortInterruptedRunnable implements Runnable {
384		public void run() {
385		try {
386		Thread.sleep(SHORT_DELAY_MS);
#	Line 224 | Line 391 | public class JSR166TestCase extends Test
391		}
392		}
393
394	<	public class SmallRunnable implements Runnable {
394	>	class SmallRunnable implements Runnable {
395		public void run() {
396		try {
397		Thread.sleep(SMALL_DELAY_MS);
#	Line 235 | Line 402 | public class JSR166TestCase extends Test
402		}
403		}
404
405	<	public class SmallCallable implements Callable {
405	>	class SmallPossiblyInterruptedRunnable implements Runnable {
406	>	public void run() {
407	>	try {
408	>	Thread.sleep(SMALL_DELAY_MS);
409	>	}
410	>	catch(Exception e) {
411	>	}
412	>	}
413	>	}
414	>
415	>	class SmallCallable implements Callable {
416		public Object call() {
417		try {
418		Thread.sleep(SMALL_DELAY_MS);
#	Line 247 | Line 424 | public class JSR166TestCase extends Test
424		}
425		}
426
427	<	public class SmallInterruptedRunnable implements Runnable {
427	>	class SmallInterruptedRunnable implements Runnable {
428		public void run() {
429		try {
430		Thread.sleep(SMALL_DELAY_MS);
#	Line 259 | Line 436 | public class JSR166TestCase extends Test
436		}
437
438
439	<	public class MediumRunnable implements Runnable {
439	>	class MediumRunnable implements Runnable {
440		public void run() {
441		try {
442		Thread.sleep(MEDIUM_DELAY_MS);
#	Line 270 | Line 447 | public class JSR166TestCase extends Test
447		}
448		}
449
450	<	public class MediumInterruptedRunnable implements Runnable {
450	>	class MediumInterruptedRunnable implements Runnable {
451		public void run() {
452		try {
453		Thread.sleep(MEDIUM_DELAY_MS);
#	Line 281 | Line 458 | public class JSR166TestCase extends Test
458		}
459		}
460
461	<	public class MediumPossiblyInterruptedRunnable implements Runnable {
461	>	class MediumPossiblyInterruptedRunnable implements Runnable {
462		public void run() {
463		try {
464		Thread.sleep(MEDIUM_DELAY_MS);
#	Line 290 | Line 467 | public class JSR166TestCase extends Test
467		}
468		}
469		}
470	+
471	+	class LongPossiblyInterruptedRunnable implements Runnable {
472	+	public void run() {
473	+	try {
474	+	Thread.sleep(LONG_DELAY_MS);
475	+	}
476	+	catch(InterruptedException success) {
477	+	}
478	+	}
479	+	}
480	+
481	+	/**
482	+	* For use as ThreadFactory in constructors
483	+	*/
484	+	static class SimpleThreadFactory implements ThreadFactory{
485	+	public Thread newThread(Runnable r){
486	+	return new Thread(r);
487	+	}
488	+	}
489	+
490	+	static class TrackedShortRunnable implements Runnable {
491	+	volatile boolean done = false;
492	+	public void run() {
493	+	try {
494	+	Thread.sleep(SMALL_DELAY_MS);
495	+	done = true;
496	+	} catch(Exception e){
497	+	}
498	+	}
499	+	}
500	+
501	+	static class TrackedMediumRunnable implements Runnable {
502	+	volatile boolean done = false;
503	+	public void run() {
504	+	try {
505	+	Thread.sleep(MEDIUM_DELAY_MS);
506	+	done = true;
507	+	} catch(Exception e){
508	+	}
509	+	}
510	+	}
511	+
512	+	static class TrackedLongRunnable implements Runnable {
513	+	volatile boolean done = false;
514	+	public void run() {
515	+	try {
516	+	Thread.sleep(LONG_DELAY_MS);
517	+	done = true;
518	+	} catch(Exception e){
519	+	}
520	+	}
521	+	}
522	+
523	+	static class TrackedNoOpRunnable implements Runnable {
524	+	volatile boolean done = false;
525	+	public void run() {
526	+	done = true;
527	+	}
528	+	}
529	+
530	+	static class TrackedCallable implements Callable {
531	+	volatile boolean done = false;
532	+	public Object call() {
533	+	try {
534	+	Thread.sleep(SMALL_DELAY_MS);
535	+	done = true;
536	+	} catch(Exception e){
537	+	}
538	+	return Boolean.TRUE;
539	+	}
540	+	}
541	+
542	+
543	+	/**
544	+	* For use as RejectedExecutionHandler in constructors
545	+	*/
546	+	static class NoOpREHandler implements RejectedExecutionHandler{
547	+	public void rejectedExecution(Runnable r, ThreadPoolExecutor executor){}
548	+	}
549	+
550
551		}

Diff Legend

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