--- jsr166/src/test/tck/DelayQueueTest.java 2003/09/14 20:42:40 1.3 +++ jsr166/src/test/tck/DelayQueueTest.java 2003/10/05 23:00:40 1.6 @@ -20,9 +20,11 @@ public class DelayQueueTest extends JSR1 private static final int NOCAP = Integer.MAX_VALUE; - // Most Q/BQ tests use Pseudodelays, where delays are all elapsed - // (so, no blocking solely for delays) but are still ordered - + /** + * A delayed implmentation for testing. + * Most tests use Pseudodelays, where delays are all elapsed + * (so, no blocking solely for delays) but are still ordered + */ static class PDelay implements Delayed { int pseudodelay; PDelay(int i) { pseudodelay = Integer.MIN_VALUE + i; } @@ -63,6 +65,50 @@ public class DelayQueueTest extends JSR1 } + /** + * Delayed implementation that actually delays + */ + static class NanoDelay implements Delayed { + long trigger; + NanoDelay(long i) { + trigger = System.nanoTime() + i; + } + public int compareTo(Object y) { + long i = trigger; + long j = ((NanoDelay)y).trigger; + if (i < j) return -1; + if (i > j) return 1; + return 0; + } + + public int compareTo(NanoDelay y) { + long i = trigger; + long j = ((NanoDelay)y).trigger; + if (i < j) return -1; + if (i > j) return 1; + return 0; + } + + public boolean equals(Object other) { + return ((NanoDelay)other).trigger == trigger; + } + public boolean equals(NanoDelay other) { + return ((NanoDelay)other).trigger == trigger; + } + + public long getDelay(TimeUnit unit) { + long n = trigger - System.nanoTime(); + return unit.convert(n, TimeUnit.NANOSECONDS); + } + + public long getTriggerTime() { + return trigger; + } + + public String toString() { + return String.valueOf(trigger); + } + } /** @@ -82,40 +128,54 @@ public class DelayQueueTest extends JSR1 return q; } - public void testConstructor1(){ + /** + * A new queue has unbounded capacity + */ + public void testConstructor1() { assertEquals(NOCAP, new DelayQueue().remainingCapacity()); } - public void testConstructor3(){ - + /** + * Initializing from null Collection throws NPE + */ + public void testConstructor3() { try { DelayQueue q = new DelayQueue(null); - fail("Cannot make from null collection"); + shouldThrow(); } catch (NullPointerException success) {} } - public void testConstructor4(){ + /** + * Initializing from Collection of null elements throws NPE + */ + public void testConstructor4() { try { PDelay[] ints = new PDelay[SIZE]; DelayQueue q = new DelayQueue(Arrays.asList(ints)); - fail("Cannot make with null elements"); + shouldThrow(); } catch (NullPointerException success) {} } - public void testConstructor5(){ + /** + * Initializing from Collection with some null elements throws NPE + */ + public void testConstructor5() { try { PDelay[] ints = new PDelay[SIZE]; for (int i = 0; i < SIZE-1; ++i) ints[i] = new PDelay(i); DelayQueue q = new DelayQueue(Arrays.asList(ints)); - fail("Cannot make with null elements"); + shouldThrow(); } catch (NullPointerException success) {} } - public void testConstructor6(){ + /** + * Queue contains all elements of collection used to initialize + */ + public void testConstructor6() { try { PDelay[] ints = new PDelay[SIZE]; for (int i = 0; i < SIZE; ++i) @@ -127,6 +187,9 @@ public class DelayQueueTest extends JSR1 finally {} } + /** + * isEmpty is true before add, false after + */ public void testEmpty() { DelayQueue q = new DelayQueue(); assertTrue(q.isEmpty()); @@ -139,7 +202,11 @@ public class DelayQueueTest extends JSR1 assertTrue(q.isEmpty()); } - public void testRemainingCapacity(){ + /** + * remainingCapacity does not change when elementa added or removed, + * but size does + */ + public void testRemainingCapacity() { DelayQueue q = populatedQueue(SIZE); for (int i = 0; i < SIZE; ++i) { assertEquals(NOCAP, q.remainingCapacity()); @@ -153,21 +220,41 @@ public class DelayQueueTest extends JSR1 } } - public void testOfferNull(){ + /** + * offer(null) throws NPE + */ + public void testOfferNull() { try { DelayQueue q = new DelayQueue(); q.offer(null); - fail("should throw NPE"); + shouldThrow(); } catch (NullPointerException success) { } } + /** + * add(null) throws NPE + */ + public void testAddNull() { + try { + DelayQueue q = new DelayQueue(); + q.add(null); + shouldThrow(); + } catch (NullPointerException success) { } + } + + /** + * offer non-null succeeds + */ public void testOffer() { DelayQueue q = new DelayQueue(); assertTrue(q.offer(new PDelay(0))); assertTrue(q.offer(new PDelay(1))); } - public void testAdd(){ + /** + * add succeeds + */ + public void testAdd() { DelayQueue q = new DelayQueue(); for (int i = 0; i < SIZE; ++i) { assertEquals(i, q.size()); @@ -175,36 +262,63 @@ public class DelayQueueTest extends JSR1 } } - public void testAddAll1(){ + /** + * addAll(null) throws NPE + */ + public void testAddAll1() { try { DelayQueue q = new DelayQueue(); q.addAll(null); - fail("Cannot add null collection"); + shouldThrow(); } catch (NullPointerException success) {} } - public void testAddAll2(){ + + + /** + * addAll(this) throws IAE + */ + public void testAddAllSelf() { + try { + DelayQueue q = populatedQueue(SIZE); + q.addAll(q); + shouldThrow(); + } + catch (IllegalArgumentException success) {} + } + + /** + * addAll of a collection with null elements throws NPE + */ + public void testAddAll2() { try { DelayQueue q = new DelayQueue(); PDelay[] ints = new PDelay[SIZE]; q.addAll(Arrays.asList(ints)); - fail("Cannot add null elements"); + shouldThrow(); } catch (NullPointerException success) {} } - public void testAddAll3(){ + /** + * addAll of a collection with any null elements throws NPE after + * possibly adding some elements + */ + public void testAddAll3() { try { DelayQueue q = new DelayQueue(); PDelay[] ints = new PDelay[SIZE]; for (int i = 0; i < SIZE-1; ++i) ints[i] = new PDelay(i); q.addAll(Arrays.asList(ints)); - fail("Cannot add null elements"); + shouldThrow(); } catch (NullPointerException success) {} } - public void testAddAll5(){ + /** + * Queue contains all elements of successful addAll + */ + public void testAddAll5() { try { PDelay[] empty = new PDelay[0]; PDelay[] ints = new PDelay[SIZE]; @@ -219,16 +333,22 @@ public class DelayQueueTest extends JSR1 finally {} } + /** + * put(null) throws NPE + */ public void testPutNull() { try { DelayQueue q = new DelayQueue(); q.put(null); - fail("put should throw NPE"); + shouldThrow(); } catch (NullPointerException success){ } } + /** + * all elements successfully put are contained + */ public void testPut() { try { DelayQueue q = new DelayQueue(); @@ -243,10 +363,13 @@ public class DelayQueueTest extends JSR1 } } + /** + * put doesn't block waiting for take + */ public void testPutWithTake() { final DelayQueue q = new DelayQueue(); Thread t = new Thread(new Runnable() { - public void run(){ + public void run() { int added = 0; try { q.put(new PDelay(0)); @@ -269,14 +392,17 @@ public class DelayQueueTest extends JSR1 t.interrupt(); t.join(); } catch (Exception e){ - fail("Unexpected exception"); + unexpectedException(); } } + /** + * timed offer does not time out + */ public void testTimedOffer() { final DelayQueue q = new DelayQueue(); Thread t = new Thread(new Runnable() { - public void run(){ + public void run() { try { q.put(new PDelay(0)); q.put(new PDelay(0)); @@ -292,28 +418,34 @@ public class DelayQueueTest extends JSR1 t.interrupt(); t.join(); } catch (Exception e){ - fail("Unexpected exception"); + unexpectedException(); } } - public void testTake(){ + /** + * take retrieves elements in priority order + */ + public void testTake() { try { DelayQueue q = populatedQueue(SIZE); for (int i = 0; i < SIZE; ++i) { assertEquals(new PDelay(i), ((PDelay)q.take())); } } catch (InterruptedException e){ - fail("Unexpected exception"); + unexpectedException(); } } + /** + * take blocks interruptibly when empty + */ public void testTakeFromEmpty() { final DelayQueue q = new DelayQueue(); Thread t = new Thread(new Runnable() { - public void run(){ + public void run() { try { q.take(); - threadFail("Should block"); + threadShouldThrow(); } catch (InterruptedException success){ } } }); @@ -323,11 +455,14 @@ public class DelayQueueTest extends JSR1 t.interrupt(); t.join(); } catch (Exception e){ - fail("Unexpected exception"); + unexpectedException(); } } - public void testBlockingTake(){ + /** + * Take removes existing elements until empty, then blocks interruptibly + */ + public void testBlockingTake() { Thread t = new Thread(new Runnable() { public void run() { try { @@ -336,7 +471,7 @@ public class DelayQueueTest extends JSR1 threadAssertEquals(new PDelay(i), ((PDelay)q.take())); } q.take(); - threadFail("take should block"); + threadShouldThrow(); } catch (InterruptedException success){ } }}); @@ -347,12 +482,15 @@ public class DelayQueueTest extends JSR1 t.join(); } catch (InterruptedException ie) { - fail("Unexpected exception"); + unexpectedException(); } } - public void testPoll(){ + /** + * poll succeeds unless empty + */ + public void testPoll() { DelayQueue q = populatedQueue(SIZE); for (int i = 0; i < SIZE; ++i) { assertEquals(new PDelay(i), ((PDelay)q.poll())); @@ -360,6 +498,9 @@ public class DelayQueueTest extends JSR1 assertNull(q.poll()); } + /** + * timed pool with zero timeout succeeds when non-empty, else times out + */ public void testTimedPoll0() { try { DelayQueue q = populatedQueue(SIZE); @@ -368,10 +509,13 @@ public class DelayQueueTest extends JSR1 } assertNull(q.poll(0, TimeUnit.MILLISECONDS)); } catch (InterruptedException e){ - fail("Unexpected exception"); + unexpectedException(); } } + /** + * timed pool with nonzero timeout succeeds when non-empty, else times out + */ public void testTimedPoll() { try { DelayQueue q = populatedQueue(SIZE); @@ -380,11 +524,15 @@ public class DelayQueueTest extends JSR1 } assertNull(q.poll(SHORT_DELAY_MS, TimeUnit.MILLISECONDS)); } catch (InterruptedException e){ - fail("Unexpected exception"); + unexpectedException(); } } - public void testInterruptedTimedPoll(){ + /** + * Interrupted timed poll throws InterruptedException instead of + * returning timeout status + */ + public void testInterruptedTimedPoll() { Thread t = new Thread(new Runnable() { public void run() { try { @@ -403,14 +551,18 @@ public class DelayQueueTest extends JSR1 t.join(); } catch (InterruptedException ie) { - fail("Unexpected exception"); + unexpectedException(); } } - public void testTimedPollWithOffer(){ + /** + * timed poll before a delayed offer fails; after offer succeeds; + * on interruption throws + */ + public void testTimedPollWithOffer() { final DelayQueue q = new DelayQueue(); Thread t = new Thread(new Runnable() { - public void run(){ + public void run() { try { threadAssertNull(q.poll(SHORT_DELAY_MS, TimeUnit.MILLISECONDS)); q.poll(LONG_DELAY_MS, TimeUnit.MILLISECONDS); @@ -426,12 +578,15 @@ public class DelayQueueTest extends JSR1 t.interrupt(); t.join(); } catch (Exception e){ - fail("Unexpected exception"); + unexpectedException(); } } - public void testPeek(){ + /** + * peek returns next element, or null if empty + */ + public void testPeek() { DelayQueue q = populatedQueue(SIZE); for (int i = 0; i < SIZE; ++i) { assertEquals(new PDelay(i), ((PDelay)q.peek())); @@ -442,7 +597,10 @@ public class DelayQueueTest extends JSR1 assertNull(q.peek()); } - public void testElement(){ + /** + * element returns next element, or throws NSEE if empty + */ + public void testElement() { DelayQueue q = populatedQueue(SIZE); for (int i = 0; i < SIZE; ++i) { assertEquals(new PDelay(i), ((PDelay)q.element())); @@ -450,24 +608,30 @@ public class DelayQueueTest extends JSR1 } try { q.element(); - fail("no such element"); + shouldThrow(); } catch (NoSuchElementException success) {} } - public void testRemove(){ + /** + * remove removes next element, or throws NSEE if empty + */ + public void testRemove() { DelayQueue q = populatedQueue(SIZE); for (int i = 0; i < SIZE; ++i) { assertEquals(new PDelay(i), ((PDelay)q.remove())); } try { q.remove(); - fail("remove should throw"); + shouldThrow(); } catch (NoSuchElementException success){ } } - public void testRemoveElement(){ + /** + * remove(x) removes x and returns true if present + */ + public void testRemoveElement() { DelayQueue q = populatedQueue(SIZE); for (int i = 1; i < SIZE; i+=2) { assertTrue(q.remove(new PDelay(i))); @@ -479,7 +643,10 @@ public class DelayQueueTest extends JSR1 assertTrue(q.isEmpty()); } - public void testContains(){ + /** + * contains(x) reports true when elements added but not yet removed + */ + public void testContains() { DelayQueue q = populatedQueue(SIZE); for (int i = 0; i < SIZE; ++i) { assertTrue(q.contains(new PDelay(i))); @@ -488,7 +655,10 @@ public class DelayQueueTest extends JSR1 } } - public void testClear(){ + /** + * clear removes all elements + */ + public void testClear() { DelayQueue q = populatedQueue(SIZE); q.clear(); assertTrue(q.isEmpty()); @@ -500,7 +670,10 @@ public class DelayQueueTest extends JSR1 assertTrue(q.isEmpty()); } - public void testContainsAll(){ + /** + * containsAll(c) is true when c contains a subset of elements + */ + public void testContainsAll() { DelayQueue q = populatedQueue(SIZE); DelayQueue p = new DelayQueue(); for (int i = 0; i < SIZE; ++i) { @@ -511,7 +684,10 @@ public class DelayQueueTest extends JSR1 assertTrue(p.containsAll(q)); } - public void testRetainAll(){ + /** + * retainAll(c) retains only those elements of c and reports true if changed + */ + public void testRetainAll() { DelayQueue q = populatedQueue(SIZE); DelayQueue p = populatedQueue(SIZE); for (int i = 0; i < SIZE; ++i) { @@ -527,7 +703,10 @@ public class DelayQueueTest extends JSR1 } } - public void testRemoveAll(){ + /** + * removeAll(c) removes only those elements of c and reports true if changed + */ + public void testRemoveAll() { for (int i = 1; i < SIZE; ++i) { DelayQueue q = populatedQueue(SIZE); DelayQueue p = populatedQueue(i); @@ -540,7 +719,10 @@ public class DelayQueueTest extends JSR1 } } - public void testToArray(){ + /** + * toArray contains all elements + */ + public void testToArray() { DelayQueue q = populatedQueue(SIZE); Object[] o = q.toArray(); Arrays.sort(o); @@ -548,11 +730,14 @@ public class DelayQueueTest extends JSR1 for(int i = 0; i < o.length; i++) assertEquals(o[i], q.take()); } catch (InterruptedException e){ - fail("Unexpected exception"); + unexpectedException(); } } - public void testToArray2(){ + /** + * toArray(a) contains all elements + */ + public void testToArray2() { DelayQueue q = populatedQueue(SIZE); PDelay[] ints = new PDelay[SIZE]; ints = (PDelay[])q.toArray(ints); @@ -561,11 +746,37 @@ public class DelayQueueTest extends JSR1 for(int i = 0; i < ints.length; i++) assertEquals(ints[i], q.take()); } catch (InterruptedException e){ - fail("Unexpected exception"); + unexpectedException(); } } + + + /** + * toArray(null) throws NPE + */ + public void testToArray_BadArg() { + try { + DelayQueue q = populatedQueue(SIZE); + Object o[] = q.toArray(null); + shouldThrow(); + } catch(NullPointerException success){} + } + + /** + * toArray with incompatable array type throws CCE + */ + public void testToArray1_BadArg() { + try { + DelayQueue q = populatedQueue(SIZE); + Object o[] = q.toArray(new String[10] ); + shouldThrow(); + } catch(ArrayStoreException success){} + } - public void testIterator(){ + /** + * iterator iterates through all elements + */ + public void testIterator() { DelayQueue q = populatedQueue(SIZE); int i = 0; Iterator it = q.iterator(); @@ -576,18 +787,17 @@ public class DelayQueueTest extends JSR1 assertEquals(i, SIZE); } + /** + * iterator.remove removes current element + */ public void testIteratorRemove () { - final DelayQueue q = new DelayQueue(); - q.add(new PDelay(2)); q.add(new PDelay(1)); q.add(new PDelay(3)); - Iterator it = q.iterator(); it.next(); it.remove(); - it = q.iterator(); assertEquals(it.next(), new PDelay(2)); assertEquals(it.next(), new PDelay(3)); @@ -595,7 +805,10 @@ public class DelayQueueTest extends JSR1 } - public void testToString(){ + /** + * toString contains toStrings of elements + */ + public void testToString() { DelayQueue q = populatedQueue(SIZE); String s = q.toString(); for (int i = 0; i < SIZE; ++i) { @@ -603,12 +816,12 @@ public class DelayQueueTest extends JSR1 } } + /** + * offer transfers elements across Executor tasks + */ public void testPollInExecutor() { - final DelayQueue q = new DelayQueue(); - ExecutorService executor = Executors.newFixedThreadPool(2); - executor.execute(new Runnable() { public void run() { threadAssertNull(q.poll()); @@ -617,7 +830,7 @@ public class DelayQueueTest extends JSR1 threadAssertTrue(q.isEmpty()); } catch (InterruptedException e) { - threadFail("should not be interrupted"); + threadUnexpectedException(); } } }); @@ -629,57 +842,18 @@ public class DelayQueueTest extends JSR1 q.put(new PDelay(1)); } catch (InterruptedException e) { - threadFail("should not be interrupted"); + threadUnexpectedException(); } } }); - joinPool(executor); } - static class NanoDelay implements Delayed { - long trigger; - NanoDelay(long i) { - trigger = System.nanoTime() + i; - } - public int compareTo(Object y) { - long i = trigger; - long j = ((NanoDelay)y).trigger; - if (i < j) return -1; - if (i > j) return 1; - return 0; - } - - public int compareTo(NanoDelay y) { - long i = trigger; - long j = ((NanoDelay)y).trigger; - if (i < j) return -1; - if (i > j) return 1; - return 0; - } - - public boolean equals(Object other) { - return ((NanoDelay)other).trigger == trigger; - } - public boolean equals(NanoDelay other) { - return ((NanoDelay)other).trigger == trigger; - } - - public long getDelay(TimeUnit unit) { - long n = trigger - System.nanoTime(); - return unit.convert(n, TimeUnit.NANOSECONDS); - } - - public long getTriggerTime() { - return trigger; - } - - public String toString() { - return String.valueOf(trigger); - } - } + /** + * Dekayed actions do not occur until their delay elapses + */ public void testDelay() { DelayQueue q = new DelayQueue(); NanoDelay[] elements = new NanoDelay[SIZE]; @@ -702,8 +876,105 @@ public class DelayQueueTest extends JSR1 } } catch(InterruptedException ie) { - fail("Unexpected Exception"); + unexpectedException(); + } + } + + + /** + * drainTo(null) throws NPE + */ + public void testDrainToNull() { + DelayQueue q = populatedQueue(SIZE); + try { + q.drainTo(null); + shouldThrow(); + } catch(NullPointerException success) { + } + } + + /** + * drainTo(this) throws IAE + */ + public void testDrainToSelf() { + DelayQueue q = populatedQueue(SIZE); + try { + q.drainTo(q); + shouldThrow(); + } catch(IllegalArgumentException success) { } } + /** + * drainTo(c) empties queue into another collection c + */ + public void testDrainTo() { + DelayQueue q = populatedQueue(SIZE); + ArrayList l = new ArrayList(); + q.drainTo(l); + assertEquals(q.size(), 0); + assertEquals(l.size(), SIZE); + } + + /** + * drainTo empties queue + */ + public void testDrainToWithActivePut() { + final DelayQueue q = populatedQueue(SIZE); + Thread t = new Thread(new Runnable() { + public void run() { + q.put(new PDelay(SIZE+1)); + } + }); + try { + t.start(); + ArrayList l = new ArrayList(); + q.drainTo(l); + assertTrue(l.size() >= SIZE); + t.join(); + assertTrue(q.size() + l.size() == SIZE+1); + } catch(Exception e){ + unexpectedException(); + } + } + + /** + * drainTo(null, n) throws NPE + */ + public void testDrainToNullN() { + DelayQueue q = populatedQueue(SIZE); + try { + q.drainTo(null, 0); + shouldThrow(); + } catch(NullPointerException success) { + } + } + + /** + * drainTo(this, n) throws IAE + */ + public void testDrainToSelfN() { + DelayQueue q = populatedQueue(SIZE); + try { + q.drainTo(q, 0); + shouldThrow(); + } catch(IllegalArgumentException success) { + } + } + + /** + * drainTo(c, n) empties first max {n, size} elements of queue into c + */ + public void testDrainToN() { + for (int i = 0; i < SIZE + 2; ++i) { + DelayQueue q = populatedQueue(SIZE); + ArrayList l = new ArrayList(); + q.drainTo(l, i); + int k = (i < SIZE)? i : SIZE; + assertEquals(q.size(), SIZE-k); + assertEquals(l.size(), k); + } + } + + }