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.31 by dl, Sun Apr 13 14:16:25 2008 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(EntryTest.class));
141 +        suite.addTest(new TestSuite(ExchangerTest.class));
142 +        suite.addTest(new TestSuite(ExecutorsTest.class));
143 +        suite.addTest(new TestSuite(ExecutorCompletionServiceTest.class));
144 +        suite.addTest(new TestSuite(FutureTaskTest.class));
145 +        suite.addTest(new TestSuite(LinkedBlockingDequeTest.class));
146 +        suite.addTest(new TestSuite(LinkedBlockingQueueTest.class));
147 +        suite.addTest(new TestSuite(LinkedListTest.class));
148 +        suite.addTest(new TestSuite(LockSupportTest.class));
149 +        suite.addTest(new TestSuite(PriorityBlockingQueueTest.class));
150 +        suite.addTest(new TestSuite(PriorityQueueTest.class));
151 +        suite.addTest(new TestSuite(ReentrantLockTest.class));
152 +        suite.addTest(new TestSuite(ReentrantReadWriteLockTest.class));
153 +        suite.addTest(new TestSuite(ScheduledExecutorTest.class));
154 +        suite.addTest(new TestSuite(ScheduledExecutorSubclassTest.class));
155 +        suite.addTest(new TestSuite(SemaphoreTest.class));
156 +        suite.addTest(new TestSuite(SynchronousQueueTest.class));
157 +        suite.addTest(new TestSuite(SystemTest.class));
158 +        suite.addTest(new TestSuite(ThreadLocalTest.class));
159 +        suite.addTest(new TestSuite(ThreadPoolExecutorTest.class));
160 +        suite.addTest(new TestSuite(ThreadPoolExecutorSubclassTest.class));
161 +        suite.addTest(new TestSuite(ThreadTest.class));
162 +        suite.addTest(new TestSuite(TimeUnitTest.class));
163 +        suite.addTest(new TestSuite(TreeMapTest.class));
164 +        suite.addTest(new TestSuite(TreeSetTest.class));
165 +        suite.addTest(new TestSuite(TreeSubMapTest.class));
166 +        suite.addTest(new TestSuite(TreeSubSetTest.class));
167 +
168 +        return suite;
169 +    }
170 +
171  
172      public static long SHORT_DELAY_MS;
173      public static long SMALL_DELAY_MS;
# Line 61 | Line 176 | public class JSR166TestCase extends Test
176  
177  
178      /**
179 <     * Return the shortest timed delay. This could
180 <     * be reimplmented to use for example a Property.
181 <     */
179 >     * Returns the shortest timed delay. This could
180 >     * be reimplemented to use for example a Property.
181 >     */
182      protected long getShortDelay() {
183 <        return 100;
183 >        return 50;
184      }
185  
186  
187      /**
188 <     * Set delays as multiples of SHORT_DELAY.
188 >     * Sets delays as multiples of SHORT_DELAY.
189       */
190      protected  void setDelays() {
191          SHORT_DELAY_MS = getShortDelay();
# Line 85 | Line 200 | public class JSR166TestCase extends Test
200      volatile boolean threadFailed;
201  
202      /**
203 <     * Initialize test to indicate that no thread assertions have failed
203 >     * Initializes test to indicate that no thread assertions have failed
204       */
205 <    public void setUp() {
205 >    public void setUp() {
206          setDelays();
207 <        threadFailed = false;  
207 >        threadFailed = false;
208      }
209  
210      /**
211 <     * Trigger test case failure if any thread assertions have failed
211 >     * Triggers test case failure if any thread assertions have failed
212       */
213 <    public void tearDown() {
214 <        assertFalse(threadFailed);  
213 >    public void tearDown() {
214 >        assertFalse(threadFailed);
215      }
216  
217      /**
218       * Fail, also setting status to indicate current testcase should fail
219 <     */
219 >     */
220      public void threadFail(String reason) {
221          threadFailed = true;
222          fail(reason);
# Line 110 | Line 225 | public class JSR166TestCase extends Test
225      /**
226       * If expression not true, set status to indicate current testcase
227       * should fail
228 <     */
228 >     */
229      public void threadAssertTrue(boolean b) {
230          if (!b) {
231              threadFailed = true;
# Line 121 | Line 236 | public class JSR166TestCase extends Test
236      /**
237       * If expression not false, set status to indicate current testcase
238       * should fail
239 <     */
239 >     */
240      public void threadAssertFalse(boolean b) {
241          if (b) {
242              threadFailed = true;
# Line 132 | Line 247 | public class JSR166TestCase extends Test
247      /**
248       * If argument not null, set status to indicate current testcase
249       * should fail
250 <     */
250 >     */
251      public void threadAssertNull(Object x) {
252          if (x != null) {
253              threadFailed = true;
# Line 143 | Line 258 | public class JSR166TestCase extends Test
258      /**
259       * If arguments not equal, set status to indicate current testcase
260       * should fail
261 <     */
261 >     */
262      public void threadAssertEquals(long x, long y) {
263          if (x != y) {
264              threadFailed = true;
# Line 154 | Line 269 | public class JSR166TestCase extends Test
269      /**
270       * If arguments not equal, set status to indicate current testcase
271       * should fail
272 <     */
272 >     */
273      public void threadAssertEquals(Object x, Object y) {
274          if (x != y && (x == null || !x.equals(y))) {
275              threadFailed = true;
# Line 166 | Line 281 | public class JSR166TestCase extends Test
281       * threadFail with message "should throw exception"
282       */
283      public void threadShouldThrow() {
284 <        threadFailed = true;
285 <        fail("should throw exception");
284 >       try {
285 >           threadFailed = true;
286 >           fail("should throw exception");
287 >       } catch (AssertionFailedError e) {
288 >           e.printStackTrace();
289 >           throw e;
290 >       }
291      }
292  
293      /**
# Line 178 | Line 298 | public class JSR166TestCase extends Test
298          fail("Unexpected exception");
299      }
300  
301 +    /**
302 +     * threadFail with message "Unexpected exception", with argument
303 +     */
304 +    public void threadUnexpectedException(Throwable ex) {
305 +        threadFailed = true;
306 +        ex.printStackTrace();
307 +        fail("Unexpected exception: " + ex);
308 +    }
309  
310      /**
311       * Wait out termination of a thread pool or fail doing so
# Line 186 | Line 314 | public class JSR166TestCase extends Test
314          try {
315              exec.shutdown();
316              assertTrue(exec.awaitTermination(LONG_DELAY_MS, TimeUnit.MILLISECONDS));
317 +        } catch(SecurityException ok) {
318 +            // Allowed in case test doesn't have privs
319          } catch(InterruptedException ie) {
320              fail("Unexpected exception");
321          }
# Line 194 | Line 324 | public class JSR166TestCase extends Test
324  
325      /**
326       * fail with message "should throw exception"
327 <     */
327 >     */
328      public void shouldThrow() {
329          fail("Should throw exception");
330      }
# Line 229 | Line 359 | public class JSR166TestCase extends Test
359      static final Integer m3  = new Integer(-3);
360      static final Integer m4 = new Integer(-4);
361      static final Integer m5 = new Integer(-5);
362 +    static final Integer m6 = new Integer(-6);
363      static final Integer m10 = new Integer(-10);
364  
365  
366 +    /**
367 +     * A security policy where new permissions can be dynamically added
368 +     * or all cleared.
369 +     */
370 +    static class AdjustablePolicy extends java.security.Policy {
371 +        Permissions perms = new Permissions();
372 +        AdjustablePolicy() { }
373 +        void addPermission(Permission perm) { perms.add(perm); }
374 +        void clearPermissions() { perms = new Permissions(); }
375 +        public PermissionCollection getPermissions(CodeSource cs) {
376 +            return perms;
377 +        }
378 +        public PermissionCollection getPermissions(ProtectionDomain pd) {
379 +            return perms;
380 +        }
381 +        public boolean implies(ProtectionDomain pd, Permission p) {
382 +            return perms.implies(p);
383 +        }
384 +        public void refresh() {}
385 +    }
386 +
387 +
388      // Some convenient Runnable classes
389  
390      static class NoOpRunnable implements Runnable {
# Line 242 | Line 395 | public class JSR166TestCase extends Test
395          public Object call() { return Boolean.TRUE; }
396      }
397  
398 +    static final String TEST_STRING = "a test string";
399 +
400 +    static class StringTask implements Callable<String> {
401 +        public String call() { return TEST_STRING; }
402 +    }
403 +
404 +    static class NPETask implements Callable<String> {
405 +        public String call() { throw new NullPointerException(); }
406 +    }
407 +
408 +    static class CallableOne implements Callable<Integer> {
409 +        public Integer call() { return one; }
410 +    }
411 +
412      class ShortRunnable implements Runnable {
413          public void run() {
414              try {
415                  Thread.sleep(SHORT_DELAY_MS);
416              }
417              catch(Exception e) {
418 <                threadUnexpectedException();
418 >                threadUnexpectedException(e);
419              }
420          }
421      }
# Line 270 | Line 437 | public class JSR166TestCase extends Test
437                  Thread.sleep(SMALL_DELAY_MS);
438              }
439              catch(Exception e) {
440 <                threadUnexpectedException();
440 >                threadUnexpectedException(e);
441 >            }
442 >        }
443 >    }
444 >
445 >    class SmallPossiblyInterruptedRunnable implements Runnable {
446 >        public void run() {
447 >            try {
448 >                Thread.sleep(SMALL_DELAY_MS);
449 >            }
450 >            catch(Exception e) {
451              }
452          }
453      }
# Line 281 | Line 458 | public class JSR166TestCase extends Test
458                  Thread.sleep(SMALL_DELAY_MS);
459              }
460              catch(Exception e) {
461 <                threadUnexpectedException();
461 >                threadUnexpectedException(e);
462              }
463              return Boolean.TRUE;
464          }
# Line 305 | Line 482 | public class JSR166TestCase extends Test
482                  Thread.sleep(MEDIUM_DELAY_MS);
483              }
484              catch(Exception e) {
485 <                threadUnexpectedException();
485 >                threadUnexpectedException(e);
486              }
487          }
488      }
# Line 331 | Line 508 | public class JSR166TestCase extends Test
508          }
509      }
510  
511 +    class LongPossiblyInterruptedRunnable implements Runnable {
512 +        public void run() {
513 +            try {
514 +                Thread.sleep(LONG_DELAY_MS);
515 +            }
516 +            catch(InterruptedException success) {
517 +            }
518 +        }
519 +    }
520 +
521      /**
522       * For use as ThreadFactory in constructors
523       */
524      static class SimpleThreadFactory implements ThreadFactory{
525          public Thread newThread(Runnable r){
526              return new Thread(r);
527 <        }  
527 >        }
528      }
529  
530 <    static class TrackedRunnable implements Runnable {
530 >    static class TrackedShortRunnable implements Runnable {
531          volatile boolean done = false;
532          public void run() {
533              try {
# Line 351 | Line 538 | public class JSR166TestCase extends Test
538          }
539      }
540  
541 +    static class TrackedMediumRunnable implements Runnable {
542 +        volatile boolean done = false;
543 +        public void run() {
544 +            try {
545 +                Thread.sleep(MEDIUM_DELAY_MS);
546 +                done = true;
547 +            } catch(Exception e){
548 +            }
549 +        }
550 +    }
551 +
552 +    static class TrackedLongRunnable implements Runnable {
553 +        volatile boolean done = false;
554 +        public void run() {
555 +            try {
556 +                Thread.sleep(LONG_DELAY_MS);
557 +                done = true;
558 +            } catch(Exception e){
559 +            }
560 +        }
561 +    }
562 +
563 +    static class TrackedNoOpRunnable implements Runnable {
564 +        volatile boolean done = false;
565 +        public void run() {
566 +            done = true;
567 +        }
568 +    }
569 +
570      static class TrackedCallable implements Callable {
571          volatile boolean done = false;
572          public Object call() {
# Line 363 | Line 579 | public class JSR166TestCase extends Test
579          }
580      }
581  
582 +
583      /**
584       * For use as RejectedExecutionHandler in constructors
585       */
586      static class NoOpREHandler implements RejectedExecutionHandler{
587 <        public void rejectedExecution(Runnable r, ThreadPoolExecutor executor){}
587 >        public void rejectedExecution(Runnable r, ThreadPoolExecutor executor){}
588      }
589 <
590 <    
589 >
590 >
591   }

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines