test/tck/JSR166TestCase.java

/*
 * Written by Doug Lea with assistance from members of JCP JSR-166
 * Expert Group and released to the public domain, as explained at
 * http://creativecommons.org/licenses/publicdomain
 * Other contributors include Andrew Wright, Jeffrey Hayes, 
 * Pat Fisher, Mike Judd. 
 */

import junit.framework.*;
import java.util.*;
import java.util.concurrent.*;
import java.io.*;
import java.security.*;

/**
 * Base class for JSR166 Junit TCK tests.  Defines some constants,
 * utility methods and classes, as well as a simple framework for
 * helping to make sure that assertions failing in generated threads
 * cause the associated test that generated them to itself fail (which
 * JUnit doe not otherwise arrange).  The rules for creating such
 * tests are:
 *
 * <ol>
 *
 * <li> All assertions in code running in generated threads must use
 * the forms {@link #threadFail} , {@link #threadAssertTrue} {@link
 * #threadAssertEquals}, or {@link #threadAssertNull}, (not
 * <tt>fail</tt>, <tt>assertTrue</tt>, etc.) It is OK (but not
 * particularly recommended) for other code to use these forms too.
 * Only the most typically used JUnit assertion methods are defined
 * this way, but enough to live with.</li>
 *
 * <li> If you override {@link #setUp} or {@link #tearDown}, make sure
 * to invoke <tt>super.setUp</tt> and <tt>super.tearDown</tt> within
 * them. These methods are used to clear and check for thread
 * assertion failures.</li>
 *
 * <li>All delays and timeouts must use one of the constants <tt>
 * SHORT_DELAY_MS</tt>, <tt> SMALL_DELAY_MS</tt>, <tt> MEDIUM_DELAY_MS</tt>,
 * <tt> LONG_DELAY_MS</tt>. The idea here is that a SHORT is always
 * discriminable from zero time, and always allows enough time for the
 * small amounts of computation (creating a thread, calling a few
 * methods, etc) needed to reach a timeout point. Similarly, a SMALL
 * is always discriminable as larger than SHORT and smaller than
 * MEDIUM.  And so on. These constants are set to conservative values,
 * but even so, if there is ever any doubt, they can all be increased
 * in one spot to rerun tests on slower platforms</li>
 *
 * <li> All threads generated must be joined inside each test case
 * method (or <tt>fail</tt> to do so) before returning from the
 * method. The <tt> joinPool</tt> method can be used to do this when
 * using Executors.</li>
 *
 * </ol>
 *
 * <p> <b>Other notes</b>
 * <ul>
 *
 * <li> Usually, there is one testcase method per JSR166 method
 * covering "normal" operation, and then as many exception-testing
 * methods as there are exceptions the method can throw. Sometimes
 * there are multiple tests per JSR166 method when the different
 * "normal" behaviors differ significantly. And sometimes testcases
 * cover multiple methods when they cannot be tested in
 * isolation.</li>
 * 
 * <li> The documentation style for testcases is to provide as javadoc
 * a simple sentence or two describing the property that the testcase
 * method purports to test. The javadocs do not say anything about how
 * the property is tested. To find out, read the code.</li>
 *
 * <li> These tests are "conformance tests", and do not attempt to
 * test throughput, latency, scalability or other performance factors
 * (see the separate "jtreg" tests for a set intended to check these
 * for the most central aspects of functionality.) So, most tests use
 * the smallest sensible numbers of threads, collection sizes, etc
 * needed to check basic conformance.</li>
 *
 * <li>The test classes currently do not declare inclusion in
 * any particular package to simplify things for people integrating
 * them in TCK test suites.</li>
 *
 * <li> As a convenience, the <tt>main</tt> of this class (JSR166TestCase)
 * runs all JSR166 unit tests.</li>
 *
 * </ul>
 */
public class JSR166TestCase extends TestCase {
    /**
     * Runs all JSR166 unit tests using junit.textui.TestRunner
     */ 
    public static void main (String[] args) {
        int iters = 1;
        if (args.length > 0) 
            iters = Integer.parseInt(args[0]);
        Test s = suite();
        for (int i = 0; i < iters; ++i) {
            junit.textui.TestRunner.run (s);
            System.gc();
            System.runFinalization();
        }
        System.exit(0);
    }

    /**
     * Collects all JSR166 unit tests as one suite
     */ 
    public static Test suite ( ) {
        TestSuite suite = new TestSuite("JSR166 Unit Tests");
        
        suite.addTest(new TestSuite(AbstractExecutorServiceTest.class));
        suite.addTest(new TestSuite(AbstractQueueTest.class));
        suite.addTest(new TestSuite(AbstractQueuedSynchronizerTest.class));
        suite.addTest(new TestSuite(ArrayBlockingQueueTest.class));
        suite.addTest(new TestSuite(AtomicBooleanTest.class)); 
        suite.addTest(new TestSuite(AtomicIntegerArrayTest.class)); 
        suite.addTest(new TestSuite(AtomicIntegerFieldUpdaterTest.class)); 
        suite.addTest(new TestSuite(AtomicIntegerTest.class)); 
        suite.addTest(new TestSuite(AtomicLongArrayTest.class)); 
        suite.addTest(new TestSuite(AtomicLongFieldUpdaterTest.class)); 
        suite.addTest(new TestSuite(AtomicLongTest.class)); 
        suite.addTest(new TestSuite(AtomicMarkableReferenceTest.class)); 
        suite.addTest(new TestSuite(AtomicReferenceArrayTest.class)); 
        suite.addTest(new TestSuite(AtomicReferenceFieldUpdaterTest.class)); 
        suite.addTest(new TestSuite(AtomicReferenceTest.class)); 
        suite.addTest(new TestSuite(AtomicStampedReferenceTest.class)); 
        suite.addTest(new TestSuite(ConcurrentHashMapTest.class));
        suite.addTest(new TestSuite(ConcurrentLinkedQueueTest.class));
        suite.addTest(new TestSuite(CopyOnWriteArrayListTest.class));
        suite.addTest(new TestSuite(CopyOnWriteArraySetTest.class));
        suite.addTest(new TestSuite(CountDownLatchTest.class));
        suite.addTest(new TestSuite(CyclicBarrierTest.class));
        suite.addTest(new TestSuite(DelayQueueTest.class));
        suite.addTest(new TestSuite(ExchangerTest.class));
        suite.addTest(new TestSuite(ExecutorsTest.class));
        suite.addTest(new TestSuite(ExecutorCompletionServiceTest.class));
        suite.addTest(new TestSuite(FutureTaskTest.class));
        suite.addTest(new TestSuite(LinkedBlockingQueueTest.class));
        suite.addTest(new TestSuite(LinkedListTest.class));
        suite.addTest(new TestSuite(LockSupportTest.class));
        suite.addTest(new TestSuite(PriorityBlockingQueueTest.class));
        suite.addTest(new TestSuite(PriorityQueueTest.class));
        suite.addTest(new TestSuite(ReentrantLockTest.class));
        suite.addTest(new TestSuite(ReentrantReadWriteLockTest.class));
        suite.addTest(new TestSuite(ScheduledExecutorTest.class));
        suite.addTest(new TestSuite(SemaphoreTest.class));
        suite.addTest(new TestSuite(SynchronousQueueTest.class));
        suite.addTest(new TestSuite(SystemTest.class));
        suite.addTest(new TestSuite(ThreadLocalTest.class));
        suite.addTest(new TestSuite(ThreadPoolExecutorTest.class));
        suite.addTest(new TestSuite(ThreadTest.class));
        suite.addTest(new TestSuite(TimeUnitTest.class));
                
        return suite;
    }


    public static long SHORT_DELAY_MS;
    public static long SMALL_DELAY_MS;
    public static long MEDIUM_DELAY_MS;
    public static long LONG_DELAY_MS;


    /**
     * Return the shortest timed delay. This could
     * be reimplemented to use for example a Property.
     */ 
    protected long getShortDelay() {
        return 50;
    }


    /**
     * Set delays as multiples of SHORT_DELAY.
     */
    protected  void setDelays() {
        SHORT_DELAY_MS = getShortDelay();
        SMALL_DELAY_MS = SHORT_DELAY_MS * 5;
        MEDIUM_DELAY_MS = SHORT_DELAY_MS * 10;
        LONG_DELAY_MS = SHORT_DELAY_MS * 50;
    }

    /**
     * Flag set true if any threadAssert methods fail
     */
    volatile boolean threadFailed;

    /**
     * Initialize test to indicate that no thread assertions have failed
     */
    public void setUp() { 
        setDelays();
        threadFailed = false;  
    }

    /**
     * Trigger test case failure if any thread assertions have failed
     */
    public void tearDown() { 
        assertFalse(threadFailed);  
    }

    /**
     * Fail, also setting status to indicate current testcase should fail
     */ 
    public void threadFail(String reason) {
        threadFailed = true;
        fail(reason);
    }

    /**
     * If expression not true, set status to indicate current testcase
     * should fail
     */ 
    public void threadAssertTrue(boolean b) {
        if (!b) {
            threadFailed = true;
            assertTrue(b);
        }
    }

    /**
     * If expression not false, set status to indicate current testcase
     * should fail
     */ 
    public void threadAssertFalse(boolean b) {
        if (b) {
            threadFailed = true;
            assertFalse(b);
        }
    }

    /**
     * If argument not null, set status to indicate current testcase
     * should fail
     */ 
    public void threadAssertNull(Object x) {
        if (x != null) {
            threadFailed = true;
            assertNull(x);
        }
    }

    /**
     * If arguments not equal, set status to indicate current testcase
     * should fail
     */ 
    public void threadAssertEquals(long x, long y) {
        if (x != y) {
            threadFailed = true;
            assertEquals(x, y);
        }
    }

    /**
     * If arguments not equal, set status to indicate current testcase
     * should fail
     */ 
    public void threadAssertEquals(Object x, Object y) {
        if (x != y && (x == null || !x.equals(y))) {
            threadFailed = true;
            assertEquals(x, y);
        }
    }

    /**
     * threadFail with message "should throw exception"
     */ 
    public void threadShouldThrow() {
        threadFailed = true;
        fail("should throw exception");
    }

    /**
     * threadFail with message "Unexpected exception"
     */
    public void threadUnexpectedException() {
        threadFailed = true;
        fail("Unexpected exception");
    }


    /**
     * Wait out termination of a thread pool or fail doing so
     */
    public void joinPool(ExecutorService exec) {
        try {
            exec.shutdown();
            assertTrue(exec.awaitTermination(LONG_DELAY_MS, TimeUnit.MILLISECONDS));
        } catch(SecurityException ok) {
            // Allowed in case test doesn't have privs
        } catch(InterruptedException ie) {
            fail("Unexpected exception");
        }
    }


    /**
     * fail with message "should throw exception"
     */ 
    public void shouldThrow() {
        fail("Should throw exception");
    }

    /**
     * fail with message "Unexpected exception"
     */
    public void unexpectedException() {
        fail("Unexpected exception");
    }


    /**
     * The number of elements to place in collections, arrays, etc.
     */
    static final int SIZE = 20;

    // Some convenient Integer constants

    static final Integer zero = new Integer(0);
    static final Integer one = new Integer(1);
    static final Integer two = new Integer(2);
    static final Integer three  = new Integer(3);
    static final Integer four  = new Integer(4);
    static final Integer five  = new Integer(5);
    static final Integer six = new Integer(6);
    static final Integer seven = new Integer(7);
    static final Integer eight = new Integer(8);
    static final Integer nine = new Integer(9);
    static final Integer m1  = new Integer(-1);
    static final Integer m2  = new Integer(-2);
    static final Integer m3  = new Integer(-3);
    static final Integer m4 = new Integer(-4);
    static final Integer m5 = new Integer(-5);
    static final Integer m10 = new Integer(-10);


    /**
     * A security policy where new permissions can be dynamically added
     * or all cleared.
     */
    static class AdjustablePolicy extends java.security.Policy {
        Permissions perms = new Permissions();
        AdjustablePolicy() { }
        void addPermission(Permission perm) { perms.add(perm); }
        void clearPermissions() { perms = new Permissions(); }
        public PermissionCollection getPermissions(CodeSource cs) {
            return perms;
        }
        public PermissionCollection getPermissions(ProtectionDomain pd) {
            return perms;
        }
        public boolean implies(ProtectionDomain pd, Permission p) {
            return perms.implies(p);
        }
        public void refresh() {}
    }


    // Some convenient Runnable classes

    static class NoOpRunnable implements Runnable {
        public void run() {}
    }

    static class NoOpCallable implements Callable {
        public Object call() { return Boolean.TRUE; }
    }

    static final String TEST_STRING = "a test string";

    static class StringTask implements Callable<String> {
        public String call() { return TEST_STRING; }
    }

    static class NPETask implements Callable<String> {
        public String call() { throw new NullPointerException(); }
    }

    static class CallableOne implements Callable<Integer> {
        public Integer call() { return one; }
    }

    class ShortRunnable implements Runnable {
        public void run() {
            try {
                Thread.sleep(SHORT_DELAY_MS);
            }
            catch(Exception e) {
                threadUnexpectedException();
            }
        }
    }

    class ShortInterruptedRunnable implements Runnable {
        public void run() {
            try {
                Thread.sleep(SHORT_DELAY_MS);
                threadShouldThrow();
            }
            catch(InterruptedException success) {
            }
        }
    }

    class SmallRunnable implements Runnable {
        public void run() {
            try {
                Thread.sleep(SMALL_DELAY_MS);
            }
            catch(Exception e) {
                threadUnexpectedException();
            }
        }
    }

    class SmallPossiblyInterruptedRunnable implements Runnable {
        public void run() {
            try {
                Thread.sleep(SMALL_DELAY_MS);
            }
            catch(Exception e) {
            }
        }
    }

    class SmallCallable implements Callable {
        public Object call() {
            try {
                Thread.sleep(SMALL_DELAY_MS);
            }
            catch(Exception e) {
                threadUnexpectedException();
            }
            return Boolean.TRUE;
        }
    }

    class SmallInterruptedRunnable implements Runnable {
        public void run() {
            try {
                Thread.sleep(SMALL_DELAY_MS);
                threadShouldThrow();
            }
            catch(InterruptedException success) {
            }
        }
    }


    class MediumRunnable implements Runnable {
        public void run() {
            try {
                Thread.sleep(MEDIUM_DELAY_MS);
            }
            catch(Exception e) {
                threadUnexpectedException();
            }
        }
    }

    class MediumInterruptedRunnable implements Runnable {
        public void run() {
            try {
                Thread.sleep(MEDIUM_DELAY_MS);
                threadShouldThrow();
            }
            catch(InterruptedException success) {
            }
        }
    }

    class MediumPossiblyInterruptedRunnable implements Runnable {
        public void run() {
            try {
                Thread.sleep(MEDIUM_DELAY_MS);
            }
            catch(InterruptedException success) {
            }
        }
    }

    class LongPossiblyInterruptedRunnable implements Runnable {
        public void run() {
            try {
                Thread.sleep(LONG_DELAY_MS);
            }
            catch(InterruptedException success) {
            }
        }
    }

    /**
     * For use as ThreadFactory in constructors
     */
    static class SimpleThreadFactory implements ThreadFactory{
        public Thread newThread(Runnable r){
            return new Thread(r);
        }   
    }

    static class TrackedShortRunnable implements Runnable {
        volatile boolean done = false;
        public void run() {
            try {
                Thread.sleep(SMALL_DELAY_MS);
                done = true;
            } catch(Exception e){
            }
        }
    }

    static class TrackedMediumRunnable implements Runnable {
        volatile boolean done = false;
        public void run() {
            try {
                Thread.sleep(MEDIUM_DELAY_MS);
                done = true;
            } catch(Exception e){
            }
        }
    }

    static class TrackedLongRunnable implements Runnable {
        volatile boolean done = false;
        public void run() {
            try {
                Thread.sleep(LONG_DELAY_MS);
                done = true;
            } catch(Exception e){
            }
        }
    }

    static class TrackedNoOpRunnable implements Runnable {
        volatile boolean done = false;
        public void run() {
            done = true;
        }
    }

    static class TrackedCallable implements Callable {
        volatile boolean done = false;
        public Object call() {
            try {
                Thread.sleep(SMALL_DELAY_MS);
                done = true;
            } catch(Exception e){
            }
            return Boolean.TRUE;
        }
    }


    /**
     * For use as RejectedExecutionHandler in constructors
     */
    static class NoOpREHandler implements RejectedExecutionHandler{
        public void rejectedExecution(Runnable r, ThreadPoolExecutor executor){} 
    }
 
    
}
Revision:	1.22
Committed:	Tue Jan 20 20:20:56 2004 UTC (20 years, 3 months ago) by dl
Branch:	MAIN
CVS Tags:	JSR166_PFD
Changes since 1.21:	+7 -1 lines
Log Message:	Don't fail if test harness doesn't have sufficient permissions
#	Content
1	/*
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	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
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
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
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 <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>
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 <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(ArrayBlockingQueueTest.class));
115	suite.addTest(new TestSuite(AtomicBooleanTest.class));
116	suite.addTest(new TestSuite(AtomicIntegerArrayTest.class));
117	suite.addTest(new TestSuite(AtomicIntegerFieldUpdaterTest.class));
118	suite.addTest(new TestSuite(AtomicIntegerTest.class));
119	suite.addTest(new TestSuite(AtomicLongArrayTest.class));
120	suite.addTest(new TestSuite(AtomicLongFieldUpdaterTest.class));
121	suite.addTest(new TestSuite(AtomicLongTest.class));
122	suite.addTest(new TestSuite(AtomicMarkableReferenceTest.class));
123	suite.addTest(new TestSuite(AtomicReferenceArrayTest.class));
124	suite.addTest(new TestSuite(AtomicReferenceFieldUpdaterTest.class));
125	suite.addTest(new TestSuite(AtomicReferenceTest.class));
126	suite.addTest(new TestSuite(AtomicStampedReferenceTest.class));
127	suite.addTest(new TestSuite(ConcurrentHashMapTest.class));
128	suite.addTest(new TestSuite(ConcurrentLinkedQueueTest.class));
129	suite.addTest(new TestSuite(CopyOnWriteArrayListTest.class));
130	suite.addTest(new TestSuite(CopyOnWriteArraySetTest.class));
131	suite.addTest(new TestSuite(CountDownLatchTest.class));
132	suite.addTest(new TestSuite(CyclicBarrierTest.class));
133	suite.addTest(new TestSuite(DelayQueueTest.class));
134	suite.addTest(new TestSuite(ExchangerTest.class));
135	suite.addTest(new TestSuite(ExecutorsTest.class));
136	suite.addTest(new TestSuite(ExecutorCompletionServiceTest.class));
137	suite.addTest(new TestSuite(FutureTaskTest.class));
138	suite.addTest(new TestSuite(LinkedBlockingQueueTest.class));
139	suite.addTest(new TestSuite(LinkedListTest.class));
140	suite.addTest(new TestSuite(LockSupportTest.class));
141	suite.addTest(new TestSuite(PriorityBlockingQueueTest.class));
142	suite.addTest(new TestSuite(PriorityQueueTest.class));
143	suite.addTest(new TestSuite(ReentrantLockTest.class));
144	suite.addTest(new TestSuite(ReentrantReadWriteLockTest.class));
145	suite.addTest(new TestSuite(ScheduledExecutorTest.class));
146	suite.addTest(new TestSuite(SemaphoreTest.class));
147	suite.addTest(new TestSuite(SynchronousQueueTest.class));
148	suite.addTest(new TestSuite(SystemTest.class));
149	suite.addTest(new TestSuite(ThreadLocalTest.class));
150	suite.addTest(new TestSuite(ThreadPoolExecutorTest.class));
151	suite.addTest(new TestSuite(ThreadTest.class));
152	suite.addTest(new TestSuite(TimeUnitTest.class));
153
154	return suite;
155	}
156
157
158	public static long SHORT_DELAY_MS;
159	public static long SMALL_DELAY_MS;
160	public static long MEDIUM_DELAY_MS;
161	public static long LONG_DELAY_MS;
162
163
164	/**
165	* Return the shortest timed delay. This could
166	* be reimplemented to use for example a Property.
167	*/
168	protected long getShortDelay() {
169	return 50;
170	}
171
172
173	/**
174	* Set delays as multiples of SHORT_DELAY.
175	*/
176	protected void setDelays() {
177	SHORT_DELAY_MS = getShortDelay();
178	SMALL_DELAY_MS = SHORT_DELAY_MS * 5;
179	MEDIUM_DELAY_MS = SHORT_DELAY_MS * 10;
180	LONG_DELAY_MS = SHORT_DELAY_MS * 50;
181	}
182
183	/**
184	* Flag set true if any threadAssert methods fail
185	*/
186	volatile boolean threadFailed;
187
188	/**
189	* Initialize test to indicate that no thread assertions have failed
190	*/
191	public void setUp() {
192	setDelays();
193	threadFailed = false;
194	}
195
196	/**
197	* Trigger test case failure if any thread assertions have failed
198	*/
199	public void tearDown() {
200	assertFalse(threadFailed);
201	}
202
203	/**
204	* Fail, also setting status to indicate current testcase should fail
205	*/
206	public void threadFail(String reason) {
207	threadFailed = true;
208	fail(reason);
209	}
210
211	/**
212	* If expression not true, set status to indicate current testcase
213	* should fail
214	*/
215	public void threadAssertTrue(boolean b) {
216	if (!b) {
217	threadFailed = true;
218	assertTrue(b);
219	}
220	}
221
222	/**
223	* If expression not false, set status to indicate current testcase
224	* should fail
225	*/
226	public void threadAssertFalse(boolean b) {
227	if (b) {
228	threadFailed = true;
229	assertFalse(b);
230	}
231	}
232
233	/**
234	* If argument not null, set status to indicate current testcase
235	* should fail
236	*/
237	public void threadAssertNull(Object x) {
238	if (x != null) {
239	threadFailed = true;
240	assertNull(x);
241	}
242	}
243
244	/**
245	* If arguments not equal, set status to indicate current testcase
246	* should fail
247	*/
248	public void threadAssertEquals(long x, long y) {
249	if (x != y) {
250	threadFailed = true;
251	assertEquals(x, y);
252	}
253	}
254
255	/**
256	* If arguments not equal, set status to indicate current testcase
257	* should fail
258	*/
259	public void threadAssertEquals(Object x, Object y) {
260	if (x != y && (x == null \|\| !x.equals(y))) {
261	threadFailed = true;
262	assertEquals(x, y);
263	}
264	}
265
266	/**
267	* threadFail with message "should throw exception"
268	*/
269	public void threadShouldThrow() {
270	threadFailed = true;
271	fail("should throw exception");
272	}
273
274	/**
275	* threadFail with message "Unexpected exception"
276	*/
277	public void threadUnexpectedException() {
278	threadFailed = true;
279	fail("Unexpected exception");
280	}
281
282
283	/**
284	* Wait out termination of a thread pool or fail doing so
285	*/
286	public void joinPool(ExecutorService exec) {
287	try {
288	exec.shutdown();
289	assertTrue(exec.awaitTermination(LONG_DELAY_MS, TimeUnit.MILLISECONDS));
290	} catch(SecurityException ok) {
291	// Allowed in case test doesn't have privs
292	} catch(InterruptedException ie) {
293	fail("Unexpected exception");
294	}
295	}
296
297
298	/**
299	* fail with message "should throw exception"
300	*/
301	public void shouldThrow() {
302	fail("Should throw exception");
303	}
304
305	/**
306	* fail with message "Unexpected exception"
307	*/
308	public void unexpectedException() {
309	fail("Unexpected exception");
310	}
311
312
313	/**
314	* The number of elements to place in collections, arrays, etc.
315	*/
316	static final int SIZE = 20;
317
318	// Some convenient Integer constants
319
320	static final Integer zero = new Integer(0);
321	static final Integer one = new Integer(1);
322	static final Integer two = new Integer(2);
323	static final Integer three = new Integer(3);
324	static final Integer four = new Integer(4);
325	static final Integer five = new Integer(5);
326	static final Integer six = new Integer(6);
327	static final Integer seven = new Integer(7);
328	static final Integer eight = new Integer(8);
329	static final Integer nine = new Integer(9);
330	static final Integer m1 = new Integer(-1);
331	static final Integer m2 = new Integer(-2);
332	static final Integer m3 = new Integer(-3);
333	static final Integer m4 = new Integer(-4);
334	static final Integer m5 = new Integer(-5);
335	static final Integer m10 = new Integer(-10);
336
337
338	/**
339	* A security policy where new permissions can be dynamically added
340	* or all cleared.
341	*/
342	static class AdjustablePolicy extends java.security.Policy {
343	Permissions perms = new Permissions();
344	AdjustablePolicy() { }
345	void addPermission(Permission perm) { perms.add(perm); }
346	void clearPermissions() { perms = new Permissions(); }
347	public PermissionCollection getPermissions(CodeSource cs) {
348	return perms;
349	}
350	public PermissionCollection getPermissions(ProtectionDomain pd) {
351	return perms;
352	}
353	public boolean implies(ProtectionDomain pd, Permission p) {
354	return perms.implies(p);
355	}
356	public void refresh() {}
357	}
358
359
360	// Some convenient Runnable classes
361
362	static class NoOpRunnable implements Runnable {
363	public void run() {}
364	}
365
366	static class NoOpCallable implements Callable {
367	public Object call() { return Boolean.TRUE; }
368	}
369
370	static final String TEST_STRING = "a test string";
371
372	static class StringTask implements Callable<String> {
373	public String call() { return TEST_STRING; }
374	}
375
376	static class NPETask implements Callable<String> {
377	public String call() { throw new NullPointerException(); }
378	}
379
380	static class CallableOne implements Callable<Integer> {
381	public Integer call() { return one; }
382	}
383
384	class ShortRunnable implements Runnable {
385	public void run() {
386	try {
387	Thread.sleep(SHORT_DELAY_MS);
388	}
389	catch(Exception e) {
390	threadUnexpectedException();
391	}
392	}
393	}
394
395	class ShortInterruptedRunnable implements Runnable {
396	public void run() {
397	try {
398	Thread.sleep(SHORT_DELAY_MS);
399	threadShouldThrow();
400	}
401	catch(InterruptedException success) {
402	}
403	}
404	}
405
406	class SmallRunnable implements Runnable {
407	public void run() {
408	try {
409	Thread.sleep(SMALL_DELAY_MS);
410	}
411	catch(Exception e) {
412	threadUnexpectedException();
413	}
414	}
415	}
416
417	class SmallPossiblyInterruptedRunnable implements Runnable {
418	public void run() {
419	try {
420	Thread.sleep(SMALL_DELAY_MS);
421	}
422	catch(Exception e) {
423	}
424	}
425	}
426
427	class SmallCallable implements Callable {
428	public Object call() {
429	try {
430	Thread.sleep(SMALL_DELAY_MS);
431	}
432	catch(Exception e) {
433	threadUnexpectedException();
434	}
435	return Boolean.TRUE;
436	}
437	}
438
439	class SmallInterruptedRunnable implements Runnable {
440	public void run() {
441	try {
442	Thread.sleep(SMALL_DELAY_MS);
443	threadShouldThrow();
444	}
445	catch(InterruptedException success) {
446	}
447	}
448	}
449
450
451	class MediumRunnable implements Runnable {
452	public void run() {
453	try {
454	Thread.sleep(MEDIUM_DELAY_MS);
455	}
456	catch(Exception e) {
457	threadUnexpectedException();
458	}
459	}
460	}
461
462	class MediumInterruptedRunnable implements Runnable {
463	public void run() {
464	try {
465	Thread.sleep(MEDIUM_DELAY_MS);
466	threadShouldThrow();
467	}
468	catch(InterruptedException success) {
469	}
470	}
471	}
472
473	class MediumPossiblyInterruptedRunnable implements Runnable {
474	public void run() {
475	try {
476	Thread.sleep(MEDIUM_DELAY_MS);
477	}
478	catch(InterruptedException success) {
479	}
480	}
481	}
482
483	class LongPossiblyInterruptedRunnable implements Runnable {
484	public void run() {
485	try {
486	Thread.sleep(LONG_DELAY_MS);
487	}
488	catch(InterruptedException success) {
489	}
490	}
491	}
492
493	/**
494	* For use as ThreadFactory in constructors
495	*/
496	static class SimpleThreadFactory implements ThreadFactory{
497	public Thread newThread(Runnable r){
498	return new Thread(r);
499	}
500	}
501
502	static class TrackedShortRunnable implements Runnable {
503	volatile boolean done = false;
504	public void run() {
505	try {
506	Thread.sleep(SMALL_DELAY_MS);
507	done = true;
508	} catch(Exception e){
509	}
510	}
511	}
512
513	static class TrackedMediumRunnable implements Runnable {
514	volatile boolean done = false;
515	public void run() {
516	try {
517	Thread.sleep(MEDIUM_DELAY_MS);
518	done = true;
519	} catch(Exception e){
520	}
521	}
522	}
523
524	static class TrackedLongRunnable implements Runnable {
525	volatile boolean done = false;
526	public void run() {
527	try {
528	Thread.sleep(LONG_DELAY_MS);
529	done = true;
530	} catch(Exception e){
531	}
532	}
533	}
534
535	static class TrackedNoOpRunnable implements Runnable {
536	volatile boolean done = false;
537	public void run() {
538	done = true;
539	}
540	}
541
542	static class TrackedCallable implements Callable {
543	volatile boolean done = false;
544	public Object call() {
545	try {
546	Thread.sleep(SMALL_DELAY_MS);
547	done = true;
548	} catch(Exception e){
549	}
550	return Boolean.TRUE;
551	}
552	}
553
554
555	/**
556	* For use as RejectedExecutionHandler in constructors
557	*/
558	static class NoOpREHandler implements RejectedExecutionHandler{
559	public void rejectedExecution(Runnable r, ThreadPoolExecutor executor){}
560	}
561
562
563	}