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.5 by dl, Fri Sep 26 15:33:13 2003 UTC vs.
Revision 1.28 by dl, Fri May 20 16:30:17 2005 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,
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
20 > * JUnit does not otherwise arrange).  The rules for creating such
21   * tests are:
22   *
23   * <ol>
24   *
25   * <li> All assertions in code running in generated threads must use
26 < * the forms {@link threadFail} , {@link threadAssertTrue} {@link
27 < * threadAssertEquals}, or {@link threadAssertNull}, (not
26 > * the forms {@link #threadFail}, {@link #threadAssertTrue}, {@link
27 > * #threadAssertEquals}, or {@link #threadAssertNull}, (not
28   * <tt>fail</tt>, <tt>assertTrue</tt>, etc.) It is OK (but not
29   * particularly recommended) for other code to use these forms too.
30   * Only the most typically used JUnit assertion methods are defined
31   * this way, but enough to live with.</li>
32   *
33 < * <li> If you override {@link setUp} or {@link tearDown}, make sure
33 > * <li> If you override {@link #setUp} or {@link #tearDown}, make sure
34   * to invoke <tt>super.setUp</tt> and <tt>super.tearDown</tt> within
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
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,
46   * but even so, if there is ever any doubt, they can all be increased
47 < * in one spot to rerun tests on slower platforms</li>
47 > * in one spot to rerun tests on slower platforms.</li>
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 +        int iters = 1;
94 +        if (args.length > 0)
95 +            iters = Integer.parseInt(args[0]);
96 +        Test s = suite();
97 +        for (int i = 0; i < iters; ++i) {
98 +            junit.textui.TestRunner.run (s);
99 +            System.gc();
100 +            System.runFinalization();
101 +        }
102 +        System.exit(0);
103 +    }
104 +
105 +    /**
106 +     * Collects all JSR166 unit tests as one suite
107 +     */
108 +    public static Test suite ( ) {
109 +        TestSuite suite = new TestSuite("JSR166 Unit Tests");
110 +
111 +        suite.addTest(new TestSuite(AbstractExecutorServiceTest.class));
112 +        suite.addTest(new TestSuite(AbstractQueueTest.class));
113 +        suite.addTest(new TestSuite(AbstractQueuedSynchronizerTest.class));
114 +        suite.addTest(new TestSuite(AbstractQueuedLongSynchronizerTest.class));
115 +        suite.addTest(new TestSuite(ArrayBlockingQueueTest.class));
116 +        suite.addTest(new TestSuite(ArrayDequeTest.class));
117 +        suite.addTest(new TestSuite(AtomicBooleanTest.class));
118 +        suite.addTest(new TestSuite(AtomicIntegerArrayTest.class));
119 +        suite.addTest(new TestSuite(AtomicIntegerFieldUpdaterTest.class));
120 +        suite.addTest(new TestSuite(AtomicIntegerTest.class));
121 +        suite.addTest(new TestSuite(AtomicLongArrayTest.class));
122 +        suite.addTest(new TestSuite(AtomicLongFieldUpdaterTest.class));
123 +        suite.addTest(new TestSuite(AtomicLongTest.class));
124 +        suite.addTest(new TestSuite(AtomicMarkableReferenceTest.class));
125 +        suite.addTest(new TestSuite(AtomicReferenceArrayTest.class));
126 +        suite.addTest(new TestSuite(AtomicReferenceFieldUpdaterTest.class));
127 +        suite.addTest(new TestSuite(AtomicReferenceTest.class));
128 +        suite.addTest(new TestSuite(AtomicStampedReferenceTest.class));
129 +        suite.addTest(new TestSuite(ConcurrentHashMapTest.class));
130 +        suite.addTest(new TestSuite(ConcurrentLinkedQueueTest.class));
131 +        suite.addTest(new TestSuite(ConcurrentSkipListMapTest.class));
132 +        suite.addTest(new TestSuite(ConcurrentSkipListSubMapTest.class));
133 +        suite.addTest(new TestSuite(ConcurrentSkipListSetTest.class));
134 +        suite.addTest(new TestSuite(ConcurrentSkipListSubSetTest.class));
135 +        suite.addTest(new TestSuite(CopyOnWriteArrayListTest.class));
136 +        suite.addTest(new TestSuite(CopyOnWriteArraySetTest.class));
137 +        suite.addTest(new TestSuite(CountDownLatchTest.class));
138 +        suite.addTest(new TestSuite(CyclicBarrierTest.class));
139 +        suite.addTest(new TestSuite(DelayQueueTest.class));
140 +        suite.addTest(new TestSuite(ExchangerTest.class));
141 +        suite.addTest(new TestSuite(ExecutorsTest.class));
142 +        suite.addTest(new TestSuite(ExecutorCompletionServiceTest.class));
143 +        suite.addTest(new TestSuite(FutureTaskTest.class));
144 +        suite.addTest(new TestSuite(LinkedBlockingDequeTest.class));
145 +        suite.addTest(new TestSuite(LinkedBlockingQueueTest.class));
146 +        suite.addTest(new TestSuite(LinkedListTest.class));
147 +        suite.addTest(new TestSuite(LockSupportTest.class));
148 +        suite.addTest(new TestSuite(PriorityBlockingQueueTest.class));
149 +        suite.addTest(new TestSuite(PriorityQueueTest.class));
150 +        suite.addTest(new TestSuite(ReentrantLockTest.class));
151 +        suite.addTest(new TestSuite(ReentrantReadWriteLockTest.class));
152 +        suite.addTest(new TestSuite(ScheduledExecutorTest.class));
153 +        suite.addTest(new TestSuite(ScheduledExecutorSubclassTest.class));
154 +        suite.addTest(new TestSuite(SemaphoreTest.class));
155 +        suite.addTest(new TestSuite(SynchronousQueueTest.class));
156 +        suite.addTest(new TestSuite(SystemTest.class));
157 +        suite.addTest(new TestSuite(ThreadLocalTest.class));
158 +        suite.addTest(new TestSuite(ThreadPoolExecutorTest.class));
159 +        suite.addTest(new TestSuite(ThreadPoolExecutorSubclassTest.class));
160 +        suite.addTest(new TestSuite(ThreadTest.class));
161 +        suite.addTest(new TestSuite(TimeUnitTest.class));
162 +        suite.addTest(new TestSuite(TreeMapTest.class));
163 +        suite.addTest(new TestSuite(TreeSetTest.class));
164 +        suite.addTest(new TestSuite(TreeSubMapTest.class));
165 +        suite.addTest(new TestSuite(TreeSubSetTest.class));
166 +
167 +        return suite;
168 +    }
169 +
170  
171      public static long SHORT_DELAY_MS;
172      public static long SMALL_DELAY_MS;
# Line 61 | Line 175 | public class JSR166TestCase extends Test
175  
176  
177      /**
178 <     * Return the shortest timed delay. This could
179 <     * be reimplmented to use for example a Property.
180 <     */
178 >     * Returns the shortest timed delay. This could
179 >     * be reimplemented to use for example a Property.
180 >     */
181      protected long getShortDelay() {
182 <        return 100;
182 >        return 50;
183      }
184  
185  
186      /**
187 <     * Set delays as multiples of SHORT_DELAY.
187 >     * Sets delays as multiples of SHORT_DELAY.
188       */
189      protected  void setDelays() {
190          SHORT_DELAY_MS = getShortDelay();
# Line 85 | Line 199 | public class JSR166TestCase extends Test
199      volatile boolean threadFailed;
200  
201      /**
202 <     * Initialize test to indicate that no thread assertions have failed
202 >     * Initializes test to indicate that no thread assertions have failed
203       */
204 <    public void setUp() {
204 >    public void setUp() {
205          setDelays();
206 <        threadFailed = false;  
206 >        threadFailed = false;
207      }
208  
209      /**
210 <     * Trigger test case failure if any thread assertions have failed
210 >     * Triggers test case failure if any thread assertions have failed
211       */
212 <    public void tearDown() {
213 <        assertFalse(threadFailed);  
212 >    public void tearDown() {
213 >        assertFalse(threadFailed);
214      }
215  
216      /**
217       * Fail, also setting status to indicate current testcase should fail
218 <     */
218 >     */
219      public void threadFail(String reason) {
220          threadFailed = true;
221          fail(reason);
# Line 110 | Line 224 | public class JSR166TestCase extends Test
224      /**
225       * If expression not true, set status to indicate current testcase
226       * should fail
227 <     */
227 >     */
228      public void threadAssertTrue(boolean b) {
229          if (!b) {
230              threadFailed = true;
# Line 121 | Line 235 | public class JSR166TestCase extends Test
235      /**
236       * If expression not false, set status to indicate current testcase
237       * should fail
238 <     */
238 >     */
239      public void threadAssertFalse(boolean b) {
240          if (b) {
241              threadFailed = true;
# Line 132 | Line 246 | public class JSR166TestCase extends Test
246      /**
247       * If argument not null, set status to indicate current testcase
248       * should fail
249 <     */
249 >     */
250      public void threadAssertNull(Object x) {
251          if (x != null) {
252              threadFailed = true;
# Line 143 | Line 257 | public class JSR166TestCase extends Test
257      /**
258       * If arguments not equal, set status to indicate current testcase
259       * should fail
260 <     */
260 >     */
261      public void threadAssertEquals(long x, long y) {
262          if (x != y) {
263              threadFailed = true;
# Line 154 | Line 268 | public class JSR166TestCase extends Test
268      /**
269       * If arguments not equal, set status to indicate current testcase
270       * should fail
271 <     */
271 >     */
272      public void threadAssertEquals(Object x, Object y) {
273          if (x != y && (x == null || !x.equals(y))) {
274              threadFailed = true;
# Line 164 | Line 278 | public class JSR166TestCase extends Test
278  
279      /**
280       * threadFail with message "should throw exception"
281 <     */
281 >     */
282      public void threadShouldThrow() {
283          threadFailed = true;
284          fail("should throw exception");
# Line 186 | Line 300 | public class JSR166TestCase extends Test
300          try {
301              exec.shutdown();
302              assertTrue(exec.awaitTermination(LONG_DELAY_MS, TimeUnit.MILLISECONDS));
303 +        } catch(SecurityException ok) {
304 +            // Allowed in case test doesn't have privs
305          } catch(InterruptedException ie) {
306              fail("Unexpected exception");
307          }
# Line 194 | Line 310 | public class JSR166TestCase extends Test
310  
311      /**
312       * fail with message "should throw exception"
313 <     */
313 >     */
314      public void shouldThrow() {
315          fail("Should throw exception");
316      }
# Line 232 | Line 348 | public class JSR166TestCase extends Test
348      static final Integer m10 = new Integer(-10);
349  
350  
351 +    /**
352 +     * A security policy where new permissions can be dynamically added
353 +     * or all cleared.
354 +     */
355 +    static class AdjustablePolicy extends java.security.Policy {
356 +        Permissions perms = new Permissions();
357 +        AdjustablePolicy() { }
358 +        void addPermission(Permission perm) { perms.add(perm); }
359 +        void clearPermissions() { perms = new Permissions(); }
360 +        public PermissionCollection getPermissions(CodeSource cs) {
361 +            return perms;
362 +        }
363 +        public PermissionCollection getPermissions(ProtectionDomain pd) {
364 +            return perms;
365 +        }
366 +        public boolean implies(ProtectionDomain pd, Permission p) {
367 +            return perms.implies(p);
368 +        }
369 +        public void refresh() {}
370 +    }
371 +
372 +
373      // Some convenient Runnable classes
374  
375      static class NoOpRunnable implements Runnable {
# Line 242 | Line 380 | public class JSR166TestCase extends Test
380          public Object call() { return Boolean.TRUE; }
381      }
382  
383 +    static final String TEST_STRING = "a test string";
384 +
385 +    static class StringTask implements Callable<String> {
386 +        public String call() { return TEST_STRING; }
387 +    }
388 +
389 +    static class NPETask implements Callable<String> {
390 +        public String call() { throw new NullPointerException(); }
391 +    }
392 +
393 +    static class CallableOne implements Callable<Integer> {
394 +        public Integer call() { return one; }
395 +    }
396 +
397      class ShortRunnable implements Runnable {
398          public void run() {
399              try {
# Line 275 | Line 427 | public class JSR166TestCase extends Test
427          }
428      }
429  
430 +    class SmallPossiblyInterruptedRunnable implements Runnable {
431 +        public void run() {
432 +            try {
433 +                Thread.sleep(SMALL_DELAY_MS);
434 +            }
435 +            catch(Exception e) {
436 +            }
437 +        }
438 +    }
439 +
440      class SmallCallable implements Callable {
441          public Object call() {
442              try {
# Line 331 | Line 493 | public class JSR166TestCase extends Test
493          }
494      }
495  
496 +    class LongPossiblyInterruptedRunnable implements Runnable {
497 +        public void run() {
498 +            try {
499 +                Thread.sleep(LONG_DELAY_MS);
500 +            }
501 +            catch(InterruptedException success) {
502 +            }
503 +        }
504 +    }
505 +
506      /**
507       * For use as ThreadFactory in constructors
508       */
509      static class SimpleThreadFactory implements ThreadFactory{
510          public Thread newThread(Runnable r){
511              return new Thread(r);
512 <        }  
512 >        }
513      }
514  
515 <    static class TrackedRunnable implements Runnable {
515 >    static class TrackedShortRunnable implements Runnable {
516          volatile boolean done = false;
517          public void run() {
518              try {
# Line 351 | Line 523 | public class JSR166TestCase extends Test
523          }
524      }
525  
526 +    static class TrackedMediumRunnable implements Runnable {
527 +        volatile boolean done = false;
528 +        public void run() {
529 +            try {
530 +                Thread.sleep(MEDIUM_DELAY_MS);
531 +                done = true;
532 +            } catch(Exception e){
533 +            }
534 +        }
535 +    }
536 +
537 +    static class TrackedLongRunnable implements Runnable {
538 +        volatile boolean done = false;
539 +        public void run() {
540 +            try {
541 +                Thread.sleep(LONG_DELAY_MS);
542 +                done = true;
543 +            } catch(Exception e){
544 +            }
545 +        }
546 +    }
547 +
548 +    static class TrackedNoOpRunnable implements Runnable {
549 +        volatile boolean done = false;
550 +        public void run() {
551 +            done = true;
552 +        }
553 +    }
554 +
555      static class TrackedCallable implements Callable {
556          volatile boolean done = false;
557          public Object call() {
# Line 363 | Line 564 | public class JSR166TestCase extends Test
564          }
565      }
566  
567 +
568      /**
569       * For use as RejectedExecutionHandler in constructors
570       */
571      static class NoOpREHandler implements RejectedExecutionHandler{
572 <        public void rejectedExecution(Runnable r, ThreadPoolExecutor executor){}
572 >        public void rejectedExecution(Runnable r, ThreadPoolExecutor executor){}
573      }
574 <
575 <    
574 >
575 >
576   }

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines