ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/jsr166/jsr166/src/test/tck/JSR166TestCase.java
(Generate patch)

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.13 by dl, Sat Dec 27 19:26:43 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(ArrayBlockingQueueTest.class));
104 +        suite.addTest(new TestSuite(AtomicBooleanTest.class));
105 +        suite.addTest(new TestSuite(AtomicIntegerArrayTest.class));
106 +        suite.addTest(new TestSuite(AtomicIntegerFieldUpdaterTest.class));
107 +        suite.addTest(new TestSuite(AtomicIntegerTest.class));
108 +        suite.addTest(new TestSuite(AtomicLongArrayTest.class));
109 +        suite.addTest(new TestSuite(AtomicLongFieldUpdaterTest.class));
110 +        suite.addTest(new TestSuite(AtomicLongTest.class));
111 +        suite.addTest(new TestSuite(AtomicMarkableReferenceTest.class));
112 +        suite.addTest(new TestSuite(AtomicReferenceArrayTest.class));
113 +        suite.addTest(new TestSuite(AtomicReferenceFieldUpdaterTest.class));
114 +        suite.addTest(new TestSuite(AtomicReferenceTest.class));
115 +        suite.addTest(new TestSuite(AtomicStampedReferenceTest.class));
116 +        suite.addTest(new TestSuite(ConcurrentHashMapTest.class));
117 +        suite.addTest(new TestSuite(ConcurrentLinkedQueueTest.class));
118 +        suite.addTest(new TestSuite(CopyOnWriteArrayListTest.class));
119 +        suite.addTest(new TestSuite(CopyOnWriteArraySetTest.class));
120 +        suite.addTest(new TestSuite(CountDownLatchTest.class));
121 +        suite.addTest(new TestSuite(CyclicBarrierTest.class));
122 +        suite.addTest(new TestSuite(DelayQueueTest.class));
123 +        suite.addTest(new TestSuite(ExchangerTest.class));
124 +        suite.addTest(new TestSuite(ExecutorsTest.class));
125 +        suite.addTest(new TestSuite(ExecutorCompletionServiceTest.class));
126 +        suite.addTest(new TestSuite(FutureTaskTest.class));
127 +        suite.addTest(new TestSuite(LinkedBlockingQueueTest.class));
128 +        suite.addTest(new TestSuite(LinkedListTest.class));
129 +        suite.addTest(new TestSuite(LockSupportTest.class));
130 +        suite.addTest(new TestSuite(PriorityBlockingQueueTest.class));
131 +        suite.addTest(new TestSuite(PriorityQueueTest.class));
132 +        suite.addTest(new TestSuite(ReentrantLockTest.class));
133 +        suite.addTest(new TestSuite(ReentrantReadWriteLockTest.class));
134 +        suite.addTest(new TestSuite(ScheduledExecutorTest.class));
135 +        suite.addTest(new TestSuite(SemaphoreTest.class));
136 +        suite.addTest(new TestSuite(SynchronousQueueTest.class));
137 +        suite.addTest(new TestSuite(SystemTest.class));
138 +        suite.addTest(new TestSuite(ThreadLocalTest.class));
139 +        suite.addTest(new TestSuite(ThreadPoolExecutorTest.class));
140 +        suite.addTest(new TestSuite(ThreadTest.class));
141 +        suite.addTest(new TestSuite(TimeUnitTest.class));
142 +                
143 +        return suite;
144 +    }
145 +
146  
147      public static long SHORT_DELAY_MS;
148      public static long SMALL_DELAY_MS;
# Line 69 | Line 160 | public class JSR166TestCase extends Test
160  
161  
162      /**
163 <     * Set delays as multiples fo SHORT_DELAY.
163 >     * Set delays as multiples of SHORT_DELAY.
164       */
165      protected  void setDelays() {
166          SHORT_DELAY_MS = getShortDelay();
# Line 81 | Line 172 | public class JSR166TestCase extends Test
172      /**
173       * Flag set true if any threadAssert methods fail
174       */
175 <    protected volatile boolean threadFailed;
175 >    volatile boolean threadFailed;
176  
177      /**
178       * Initialize test to indicate that no thread assertions have failed
# Line 98 | Line 189 | public class JSR166TestCase extends Test
189          assertFalse(threadFailed);  
190      }
191  
192 +    /**
193 +     * Fail, also setting status to indicate current testcase should fail
194 +     */
195      public void threadFail(String reason) {
196          threadFailed = true;
197          fail(reason);
198      }
199  
200 +    /**
201 +     * If expression not true, set status to indicate current testcase
202 +     * should fail
203 +     */
204      public void threadAssertTrue(boolean b) {
205          if (!b) {
206              threadFailed = true;
207              assertTrue(b);
208          }
209      }
210 +
211 +    /**
212 +     * If expression not false, set status to indicate current testcase
213 +     * should fail
214 +     */
215      public void threadAssertFalse(boolean b) {
216          if (b) {
217              threadFailed = true;
218              assertFalse(b);
219          }
220      }
221 +
222 +    /**
223 +     * If argument not null, set status to indicate current testcase
224 +     * should fail
225 +     */
226      public void threadAssertNull(Object x) {
227          if (x != null) {
228              threadFailed = true;
229              assertNull(x);
230          }
231      }
232 +
233 +    /**
234 +     * If arguments not equal, set status to indicate current testcase
235 +     * should fail
236 +     */
237      public void threadAssertEquals(long x, long y) {
238          if (x != y) {
239              threadFailed = true;
240              assertEquals(x, y);
241          }
242      }
243 +
244 +    /**
245 +     * If arguments not equal, set status to indicate current testcase
246 +     * should fail
247 +     */
248      public void threadAssertEquals(Object x, Object y) {
249          if (x != y && (x == null || !x.equals(y))) {
250              threadFailed = true;
# Line 134 | Line 252 | public class JSR166TestCase extends Test
252          }
253      }
254  
255 +    /**
256 +     * threadFail with message "should throw exception"
257 +     */
258      public void threadShouldThrow() {
259          threadFailed = true;
260          fail("should throw exception");
261      }
262  
263 +    /**
264 +     * threadFail with message "Unexpected exception"
265 +     */
266      public void threadUnexpectedException() {
267          threadFailed = true;
268          fail("Unexpected exception");
# Line 157 | Line 281 | public class JSR166TestCase extends Test
281          }
282      }
283  
284 <    
284 >
285 >    /**
286 >     * fail with message "should throw exception"
287 >     */
288      public void shouldThrow() {
289          fail("Should throw exception");
290      }
291  
292 +    /**
293 +     * fail with message "Unexpected exception"
294 +     */
295      public void unexpectedException() {
296          fail("Unexpected exception");
297      }
# Line 170 | Line 300 | public class JSR166TestCase extends Test
300      /**
301       * The number of elements to place in collections, arrays, etc.
302       */
303 <    public static final int SIZE = 20;
303 >    static final int SIZE = 20;
304  
305      // Some convenient Integer constants
306  
307 <    public static final Integer zero = new Integer(0);
308 <    public static final Integer one = new Integer(1);
309 <    public static final Integer two = new Integer(2);
310 <    public static final Integer three  = new Integer(3);
311 <    public static final Integer four  = new Integer(4);
312 <    public static final Integer five  = new Integer(5);
313 <    public static final Integer six = new Integer(6);
314 <    public static final Integer seven = new Integer(7);
315 <    public static final Integer eight = new Integer(8);
316 <    public static final Integer nine = new Integer(9);
317 <    public static final Integer m1  = new Integer(-1);
318 <    public static final Integer m2  = new Integer(-2);
319 <    public static final Integer m3  = new Integer(-3);
320 <    public static final Integer m4 = new Integer(-4);
321 <    public static final Integer m5 = new Integer(-5);
322 <    public static final Integer m10 = new Integer(-10);
307 >    static final Integer zero = new Integer(0);
308 >    static final Integer one = new Integer(1);
309 >    static final Integer two = new Integer(2);
310 >    static final Integer three  = new Integer(3);
311 >    static final Integer four  = new Integer(4);
312 >    static final Integer five  = new Integer(5);
313 >    static final Integer six = new Integer(6);
314 >    static final Integer seven = new Integer(7);
315 >    static final Integer eight = new Integer(8);
316 >    static final Integer nine = new Integer(9);
317 >    static final Integer m1  = new Integer(-1);
318 >    static final Integer m2  = new Integer(-2);
319 >    static final Integer m3  = new Integer(-3);
320 >    static final Integer m4 = new Integer(-4);
321 >    static final Integer m5 = new Integer(-5);
322 >    static final Integer m10 = new Integer(-10);
323 >
324 >
325 >    /**
326 >     * A security policy where new permissions can be dynamically added
327 >     * or all cleared.
328 >     */
329 >    static class AdjustablePolicy extends java.security.Policy {
330 >        Permissions perms = new Permissions();
331 >        AdjustablePolicy() { }
332 >        void addPermission(Permission perm) { perms.add(perm); }
333 >        void clearPermissions() { perms = new Permissions(); }
334 >        public PermissionCollection getPermissions(CodeSource cs) {
335 >            return perms;
336 >        }
337 >        public PermissionCollection getPermissions(ProtectionDomain pd) {
338 >            return perms;
339 >        }
340 >        public boolean implies(ProtectionDomain pd, Permission p) {
341 >            return perms.implies(p);
342 >        }
343 >        public void refresh() {}
344 >    }
345  
346  
347      // Some convenient Runnable classes
348  
349 <    public static class NoOpRunnable implements Runnable {
349 >    static class NoOpRunnable implements Runnable {
350          public void run() {}
351      }
352  
353 <    public static class NoOpCallable implements Callable {
353 >    static class NoOpCallable implements Callable {
354          public Object call() { return Boolean.TRUE; }
355      }
356  
357 <    public class ShortRunnable implements Runnable {
357 >    static final String TEST_STRING = "a test string";
358 >
359 >    static class StringTask implements Callable<String> {
360 >        public String call() { return TEST_STRING; }
361 >    }
362 >
363 >    static class NPETask implements Callable<String> {
364 >        public String call() { throw new NullPointerException(); }
365 >    }
366 >
367 >    static class CallableOne implements Callable<Integer> {
368 >        public Integer call() { return one; }
369 >    }
370 >
371 >    class ShortRunnable implements Runnable {
372          public void run() {
373              try {
374                  Thread.sleep(SHORT_DELAY_MS);
# Line 213 | Line 379 | public class JSR166TestCase extends Test
379          }
380      }
381  
382 <    public class ShortInterruptedRunnable implements Runnable {
382 >    class ShortInterruptedRunnable implements Runnable {
383          public void run() {
384              try {
385                  Thread.sleep(SHORT_DELAY_MS);
# Line 224 | Line 390 | public class JSR166TestCase extends Test
390          }
391      }
392  
393 <    public class SmallRunnable implements Runnable {
393 >    class SmallRunnable implements Runnable {
394          public void run() {
395              try {
396                  Thread.sleep(SMALL_DELAY_MS);
# Line 235 | Line 401 | public class JSR166TestCase extends Test
401          }
402      }
403  
404 <    public class SmallCallable implements Callable {
404 >    class SmallPossiblyInterruptedRunnable implements Runnable {
405 >        public void run() {
406 >            try {
407 >                Thread.sleep(SMALL_DELAY_MS);
408 >            }
409 >            catch(Exception e) {
410 >            }
411 >        }
412 >    }
413 >
414 >    class SmallCallable implements Callable {
415          public Object call() {
416              try {
417                  Thread.sleep(SMALL_DELAY_MS);
# Line 247 | Line 423 | public class JSR166TestCase extends Test
423          }
424      }
425  
426 <    public class SmallInterruptedRunnable implements Runnable {
426 >    class SmallInterruptedRunnable implements Runnable {
427          public void run() {
428              try {
429                  Thread.sleep(SMALL_DELAY_MS);
# Line 259 | Line 435 | public class JSR166TestCase extends Test
435      }
436  
437  
438 <    public class MediumRunnable implements Runnable {
438 >    class MediumRunnable implements Runnable {
439          public void run() {
440              try {
441                  Thread.sleep(MEDIUM_DELAY_MS);
# Line 270 | Line 446 | public class JSR166TestCase extends Test
446          }
447      }
448  
449 <    public class MediumInterruptedRunnable implements Runnable {
449 >    class MediumInterruptedRunnable implements Runnable {
450          public void run() {
451              try {
452                  Thread.sleep(MEDIUM_DELAY_MS);
# Line 281 | Line 457 | public class JSR166TestCase extends Test
457          }
458      }
459  
460 <    public class MediumPossiblyInterruptedRunnable implements Runnable {
460 >    class MediumPossiblyInterruptedRunnable implements Runnable {
461          public void run() {
462              try {
463                  Thread.sleep(MEDIUM_DELAY_MS);
# Line 290 | Line 466 | public class JSR166TestCase extends Test
466              }
467          }
468      }
469 +
470 +    class LongPossiblyInterruptedRunnable implements Runnable {
471 +        public void run() {
472 +            try {
473 +                Thread.sleep(LONG_DELAY_MS);
474 +            }
475 +            catch(InterruptedException success) {
476 +            }
477 +        }
478 +    }
479 +
480 +    /**
481 +     * For use as ThreadFactory in constructors
482 +     */
483 +    static class SimpleThreadFactory implements ThreadFactory{
484 +        public Thread newThread(Runnable r){
485 +            return new Thread(r);
486 +        }  
487 +    }
488 +
489 +    static class TrackedShortRunnable implements Runnable {
490 +        volatile boolean done = false;
491 +        public void run() {
492 +            try {
493 +                Thread.sleep(SMALL_DELAY_MS);
494 +                done = true;
495 +            } catch(Exception e){
496 +            }
497 +        }
498 +    }
499 +
500 +    static class TrackedMediumRunnable implements Runnable {
501 +        volatile boolean done = false;
502 +        public void run() {
503 +            try {
504 +                Thread.sleep(MEDIUM_DELAY_MS);
505 +                done = true;
506 +            } catch(Exception e){
507 +            }
508 +        }
509 +    }
510 +
511 +    static class TrackedLongRunnable implements Runnable {
512 +        volatile boolean done = false;
513 +        public void run() {
514 +            try {
515 +                Thread.sleep(LONG_DELAY_MS);
516 +                done = true;
517 +            } catch(Exception e){
518 +            }
519 +        }
520 +    }
521 +
522 +    static class TrackedNoOpRunnable implements Runnable {
523 +        volatile boolean done = false;
524 +        public void run() {
525 +            done = true;
526 +        }
527 +    }
528 +
529 +    static class TrackedCallable implements Callable {
530 +        volatile boolean done = false;
531 +        public Object call() {
532 +            try {
533 +                Thread.sleep(SMALL_DELAY_MS);
534 +                done = true;
535 +            } catch(Exception e){
536 +            }
537 +            return Boolean.TRUE;
538 +        }
539 +    }
540 +
541 +    /**
542 +     * For use as RejectedExecutionHandler in constructors
543 +     */
544 +    static class NoOpREHandler implements RejectedExecutionHandler{
545 +        public void rejectedExecution(Runnable r, ThreadPoolExecutor executor){}
546 +    }
547 +
548      
549   }

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines