ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/jsr166/jsr166/src/test/tck/JSR166TestCase.java
Revision: 1.8
Committed: Mon Nov 3 13:50:07 2003 UTC (20 years, 6 months ago) by dl
Branch: MAIN
CVS Tags: JSR166_NOV3_FREEZE
Changes since 1.7: +0 -1 lines
Log Message:
Merged FairSemaphore into Semaphore

File Contents

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