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.33 by jsr166, Fri Jul 31 23:37:31 2009 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(ForkJoinPoolTest.class));
112 +        suite.addTest(new TestSuite(ForkJoinTaskTest.class));
113 +        suite.addTest(new TestSuite(RecursiveActionTest.class));
114 +        suite.addTest(new TestSuite(RecursiveTaskTest.class));
115 +        suite.addTest(new TestSuite(LinkedTransferQueueTest.class));
116 +        suite.addTest(new TestSuite(PhaserTest.class));
117 +        suite.addTest(new TestSuite(ThreadLocalRandomTest.class));
118 +        suite.addTest(new TestSuite(AbstractExecutorServiceTest.class));
119 +        suite.addTest(new TestSuite(AbstractQueueTest.class));
120 +        suite.addTest(new TestSuite(AbstractQueuedSynchronizerTest.class));
121 +        suite.addTest(new TestSuite(AbstractQueuedLongSynchronizerTest.class));
122 +        suite.addTest(new TestSuite(ArrayBlockingQueueTest.class));
123 +        suite.addTest(new TestSuite(ArrayDequeTest.class));
124 +        suite.addTest(new TestSuite(AtomicBooleanTest.class));
125 +        suite.addTest(new TestSuite(AtomicIntegerArrayTest.class));
126 +        suite.addTest(new TestSuite(AtomicIntegerFieldUpdaterTest.class));
127 +        suite.addTest(new TestSuite(AtomicIntegerTest.class));
128 +        suite.addTest(new TestSuite(AtomicLongArrayTest.class));
129 +        suite.addTest(new TestSuite(AtomicLongFieldUpdaterTest.class));
130 +        suite.addTest(new TestSuite(AtomicLongTest.class));
131 +        suite.addTest(new TestSuite(AtomicMarkableReferenceTest.class));
132 +        suite.addTest(new TestSuite(AtomicReferenceArrayTest.class));
133 +        suite.addTest(new TestSuite(AtomicReferenceFieldUpdaterTest.class));
134 +        suite.addTest(new TestSuite(AtomicReferenceTest.class));
135 +        suite.addTest(new TestSuite(AtomicStampedReferenceTest.class));
136 +        suite.addTest(new TestSuite(ConcurrentHashMapTest.class));
137 +        suite.addTest(new TestSuite(ConcurrentLinkedQueueTest.class));
138 +        suite.addTest(new TestSuite(ConcurrentSkipListMapTest.class));
139 +        suite.addTest(new TestSuite(ConcurrentSkipListSubMapTest.class));
140 +        suite.addTest(new TestSuite(ConcurrentSkipListSetTest.class));
141 +        suite.addTest(new TestSuite(ConcurrentSkipListSubSetTest.class));
142 +        suite.addTest(new TestSuite(CopyOnWriteArrayListTest.class));
143 +        suite.addTest(new TestSuite(CopyOnWriteArraySetTest.class));
144 +        suite.addTest(new TestSuite(CountDownLatchTest.class));
145 +        suite.addTest(new TestSuite(CyclicBarrierTest.class));
146 +        suite.addTest(new TestSuite(DelayQueueTest.class));
147 +        suite.addTest(new TestSuite(EntryTest.class));
148 +        suite.addTest(new TestSuite(ExchangerTest.class));
149 +        suite.addTest(new TestSuite(ExecutorsTest.class));
150 +        suite.addTest(new TestSuite(ExecutorCompletionServiceTest.class));
151 +        suite.addTest(new TestSuite(FutureTaskTest.class));
152 +        suite.addTest(new TestSuite(LinkedBlockingDequeTest.class));
153 +        suite.addTest(new TestSuite(LinkedBlockingQueueTest.class));
154 +        suite.addTest(new TestSuite(LinkedListTest.class));
155 +        suite.addTest(new TestSuite(LockSupportTest.class));
156 +        suite.addTest(new TestSuite(PriorityBlockingQueueTest.class));
157 +        suite.addTest(new TestSuite(PriorityQueueTest.class));
158 +        suite.addTest(new TestSuite(ReentrantLockTest.class));
159 +        suite.addTest(new TestSuite(ReentrantReadWriteLockTest.class));
160 +        suite.addTest(new TestSuite(ScheduledExecutorTest.class));
161 +        suite.addTest(new TestSuite(ScheduledExecutorSubclassTest.class));
162 +        suite.addTest(new TestSuite(SemaphoreTest.class));
163 +        suite.addTest(new TestSuite(SynchronousQueueTest.class));
164 +        suite.addTest(new TestSuite(SystemTest.class));
165 +        suite.addTest(new TestSuite(ThreadLocalTest.class));
166 +        suite.addTest(new TestSuite(ThreadPoolExecutorTest.class));
167 +        suite.addTest(new TestSuite(ThreadPoolExecutorSubclassTest.class));
168 +        suite.addTest(new TestSuite(ThreadTest.class));
169 +        suite.addTest(new TestSuite(TimeUnitTest.class));
170 +        suite.addTest(new TestSuite(TreeMapTest.class));
171 +        suite.addTest(new TestSuite(TreeSetTest.class));
172 +        suite.addTest(new TestSuite(TreeSubMapTest.class));
173 +        suite.addTest(new TestSuite(TreeSubSetTest.class));
174 +
175 +        return suite;
176 +    }
177 +
178  
179      public static long SHORT_DELAY_MS;
180      public static long SMALL_DELAY_MS;
# Line 61 | Line 183 | public class JSR166TestCase extends Test
183  
184  
185      /**
186 <     * Return the shortest timed delay. This could
187 <     * be reimplmented to use for example a Property.
188 <     */
186 >     * Returns the shortest timed delay. This could
187 >     * be reimplemented to use for example a Property.
188 >     */
189      protected long getShortDelay() {
190 <        return 100;
190 >        return 50;
191      }
192  
193  
194      /**
195 <     * Set delays as multiples of SHORT_DELAY.
195 >     * Sets delays as multiples of SHORT_DELAY.
196       */
197      protected  void setDelays() {
198          SHORT_DELAY_MS = getShortDelay();
# Line 85 | Line 207 | public class JSR166TestCase extends Test
207      volatile boolean threadFailed;
208  
209      /**
210 <     * Initialize test to indicate that no thread assertions have failed
210 >     * Initializes test to indicate that no thread assertions have failed
211       */
212 <    public void setUp() {
212 >    public void setUp() {
213          setDelays();
214 <        threadFailed = false;  
214 >        threadFailed = false;
215      }
216  
217      /**
218 <     * Trigger test case failure if any thread assertions have failed
218 >     * Triggers test case failure if any thread assertions have failed
219       */
220 <    public void tearDown() {
221 <        assertFalse(threadFailed);  
220 >    public void tearDown() {
221 >        assertFalse(threadFailed);
222      }
223  
224      /**
225       * Fail, also setting status to indicate current testcase should fail
226 <     */
226 >     */
227      public void threadFail(String reason) {
228          threadFailed = true;
229          fail(reason);
# Line 110 | Line 232 | public class JSR166TestCase extends Test
232      /**
233       * If expression not true, set status to indicate current testcase
234       * should fail
235 <     */
235 >     */
236      public void threadAssertTrue(boolean b) {
237          if (!b) {
238              threadFailed = true;
# Line 121 | Line 243 | public class JSR166TestCase extends Test
243      /**
244       * If expression not false, set status to indicate current testcase
245       * should fail
246 <     */
246 >     */
247      public void threadAssertFalse(boolean b) {
248          if (b) {
249              threadFailed = true;
# Line 132 | Line 254 | public class JSR166TestCase extends Test
254      /**
255       * If argument not null, set status to indicate current testcase
256       * should fail
257 <     */
257 >     */
258      public void threadAssertNull(Object x) {
259          if (x != null) {
260              threadFailed = true;
# Line 143 | Line 265 | public class JSR166TestCase extends Test
265      /**
266       * If arguments not equal, set status to indicate current testcase
267       * should fail
268 <     */
268 >     */
269      public void threadAssertEquals(long x, long y) {
270          if (x != y) {
271              threadFailed = true;
# Line 154 | Line 276 | public class JSR166TestCase extends Test
276      /**
277       * If arguments not equal, set status to indicate current testcase
278       * should fail
279 <     */
279 >     */
280      public void threadAssertEquals(Object x, Object y) {
281          if (x != y && (x == null || !x.equals(y))) {
282              threadFailed = true;
# Line 164 | Line 286 | public class JSR166TestCase extends Test
286  
287      /**
288       * threadFail with message "should throw exception"
289 <     */
289 >     */
290      public void threadShouldThrow() {
291 <        threadFailed = true;
292 <        fail("should throw exception");
291 >       try {
292 >           threadFailed = true;
293 >           fail("should throw exception");
294 >       } catch (AssertionFailedError e) {
295 >           e.printStackTrace();
296 >           throw e;
297 >       }
298      }
299  
300      /**
# Line 178 | Line 305 | public class JSR166TestCase extends Test
305          fail("Unexpected exception");
306      }
307  
308 +    /**
309 +     * threadFail with message "Unexpected exception", with argument
310 +     */
311 +    public void threadUnexpectedException(Throwable ex) {
312 +        threadFailed = true;
313 +        ex.printStackTrace();
314 +        fail("Unexpected exception: " + ex);
315 +    }
316  
317      /**
318       * Wait out termination of a thread pool or fail doing so
# Line 186 | Line 321 | public class JSR166TestCase extends Test
321          try {
322              exec.shutdown();
323              assertTrue(exec.awaitTermination(LONG_DELAY_MS, TimeUnit.MILLISECONDS));
324 <        } catch(InterruptedException ie) {
324 >        } catch (SecurityException ok) {
325 >            // Allowed in case test doesn't have privs
326 >        } catch (InterruptedException ie) {
327              fail("Unexpected exception");
328          }
329      }
# Line 194 | Line 331 | public class JSR166TestCase extends Test
331  
332      /**
333       * fail with message "should throw exception"
334 <     */
334 >     */
335      public void shouldThrow() {
336          fail("Should throw exception");
337      }
# Line 229 | Line 366 | public class JSR166TestCase extends Test
366      static final Integer m3  = new Integer(-3);
367      static final Integer m4 = new Integer(-4);
368      static final Integer m5 = new Integer(-5);
369 +    static final Integer m6 = new Integer(-6);
370      static final Integer m10 = new Integer(-10);
371  
372  
373 +    /**
374 +     * A security policy where new permissions can be dynamically added
375 +     * or all cleared.
376 +     */
377 +    static class AdjustablePolicy extends java.security.Policy {
378 +        Permissions perms = new Permissions();
379 +        AdjustablePolicy() { }
380 +        void addPermission(Permission perm) { perms.add(perm); }
381 +        void clearPermissions() { perms = new Permissions(); }
382 +        public PermissionCollection getPermissions(CodeSource cs) {
383 +            return perms;
384 +        }
385 +        public PermissionCollection getPermissions(ProtectionDomain pd) {
386 +            return perms;
387 +        }
388 +        public boolean implies(ProtectionDomain pd, Permission p) {
389 +            return perms.implies(p);
390 +        }
391 +        public void refresh() {}
392 +    }
393 +
394 +
395      // Some convenient Runnable classes
396  
397      static class NoOpRunnable implements Runnable {
# Line 242 | Line 402 | public class JSR166TestCase extends Test
402          public Object call() { return Boolean.TRUE; }
403      }
404  
405 +    static final String TEST_STRING = "a test string";
406 +
407 +    static class StringTask implements Callable<String> {
408 +        public String call() { return TEST_STRING; }
409 +    }
410 +
411 +    static class NPETask implements Callable<String> {
412 +        public String call() { throw new NullPointerException(); }
413 +    }
414 +
415 +    static class CallableOne implements Callable<Integer> {
416 +        public Integer call() { return one; }
417 +    }
418 +
419      class ShortRunnable implements Runnable {
420          public void run() {
421              try {
422                  Thread.sleep(SHORT_DELAY_MS);
423              }
424 <            catch(Exception e) {
425 <                threadUnexpectedException();
424 >            catch (Exception e) {
425 >                threadUnexpectedException(e);
426              }
427          }
428      }
# Line 259 | Line 433 | public class JSR166TestCase extends Test
433                  Thread.sleep(SHORT_DELAY_MS);
434                  threadShouldThrow();
435              }
436 <            catch(InterruptedException success) {
436 >            catch (InterruptedException success) {
437              }
438          }
439      }
# Line 269 | Line 443 | public class JSR166TestCase extends Test
443              try {
444                  Thread.sleep(SMALL_DELAY_MS);
445              }
446 <            catch(Exception e) {
447 <                threadUnexpectedException();
446 >            catch (Exception e) {
447 >                threadUnexpectedException(e);
448 >            }
449 >        }
450 >    }
451 >
452 >    class SmallPossiblyInterruptedRunnable implements Runnable {
453 >        public void run() {
454 >            try {
455 >                Thread.sleep(SMALL_DELAY_MS);
456 >            }
457 >            catch (Exception e) {
458              }
459          }
460      }
# Line 280 | Line 464 | public class JSR166TestCase extends Test
464              try {
465                  Thread.sleep(SMALL_DELAY_MS);
466              }
467 <            catch(Exception e) {
468 <                threadUnexpectedException();
467 >            catch (Exception e) {
468 >                threadUnexpectedException(e);
469              }
470              return Boolean.TRUE;
471          }
# Line 293 | Line 477 | public class JSR166TestCase extends Test
477                  Thread.sleep(SMALL_DELAY_MS);
478                  threadShouldThrow();
479              }
480 <            catch(InterruptedException success) {
480 >            catch (InterruptedException success) {
481              }
482          }
483      }
# Line 304 | Line 488 | public class JSR166TestCase extends Test
488              try {
489                  Thread.sleep(MEDIUM_DELAY_MS);
490              }
491 <            catch(Exception e) {
492 <                threadUnexpectedException();
491 >            catch (Exception e) {
492 >                threadUnexpectedException(e);
493              }
494          }
495      }
# Line 316 | Line 500 | public class JSR166TestCase extends Test
500                  Thread.sleep(MEDIUM_DELAY_MS);
501                  threadShouldThrow();
502              }
503 <            catch(InterruptedException success) {
503 >            catch (InterruptedException success) {
504              }
505          }
506      }
# Line 326 | Line 510 | public class JSR166TestCase extends Test
510              try {
511                  Thread.sleep(MEDIUM_DELAY_MS);
512              }
513 <            catch(InterruptedException success) {
513 >            catch (InterruptedException success) {
514 >            }
515 >        }
516 >    }
517 >
518 >    class LongPossiblyInterruptedRunnable implements Runnable {
519 >        public void run() {
520 >            try {
521 >                Thread.sleep(LONG_DELAY_MS);
522 >            }
523 >            catch (InterruptedException success) {
524              }
525          }
526      }
# Line 334 | Line 528 | public class JSR166TestCase extends Test
528      /**
529       * For use as ThreadFactory in constructors
530       */
531 <    static class SimpleThreadFactory implements ThreadFactory{
532 <        public Thread newThread(Runnable r){
531 >    static class SimpleThreadFactory implements ThreadFactory {
532 >        public Thread newThread(Runnable r) {
533              return new Thread(r);
534 <        }  
534 >        }
535      }
536  
537 <    static class TrackedRunnable implements Runnable {
537 >    static class TrackedShortRunnable implements Runnable {
538          volatile boolean done = false;
539          public void run() {
540              try {
541                  Thread.sleep(SMALL_DELAY_MS);
542                  done = true;
543 <            } catch(Exception e){
543 >            } catch (Exception e) {
544              }
545          }
546      }
547  
548 +    static class TrackedMediumRunnable implements Runnable {
549 +        volatile boolean done = false;
550 +        public void run() {
551 +            try {
552 +                Thread.sleep(MEDIUM_DELAY_MS);
553 +                done = true;
554 +            } catch (Exception e) {
555 +            }
556 +        }
557 +    }
558 +
559 +    static class TrackedLongRunnable implements Runnable {
560 +        volatile boolean done = false;
561 +        public void run() {
562 +            try {
563 +                Thread.sleep(LONG_DELAY_MS);
564 +                done = true;
565 +            } catch (Exception e) {
566 +            }
567 +        }
568 +    }
569 +
570 +    static class TrackedNoOpRunnable implements Runnable {
571 +        volatile boolean done = false;
572 +        public void run() {
573 +            done = true;
574 +        }
575 +    }
576 +
577      static class TrackedCallable implements Callable {
578          volatile boolean done = false;
579          public Object call() {
580              try {
581                  Thread.sleep(SMALL_DELAY_MS);
582                  done = true;
583 <            } catch(Exception e){
583 >            } catch (Exception e) {
584              }
585              return Boolean.TRUE;
586          }
587      }
588  
589 +
590      /**
591       * For use as RejectedExecutionHandler in constructors
592       */
593 <    static class NoOpREHandler implements RejectedExecutionHandler{
594 <        public void rejectedExecution(Runnable r, ThreadPoolExecutor executor){}
593 >    static class NoOpREHandler implements RejectedExecutionHandler {
594 >        public void rejectedExecution(Runnable r, ThreadPoolExecutor executor){}
595      }
596 <
597 <    
596 >
597 >
598   }

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines