--- jsr166/src/test/tck/PriorityBlockingQueueTest.java 2003/09/14 20:42:40 1.3 +++ jsr166/src/test/tck/PriorityBlockingQueueTest.java 2003/12/29 19:05:40 1.9 @@ -1,8 +1,9 @@ /* - * Written by members of JCP JSR-166 Expert Group and released to the - * public domain. Use, modify, and redistribute this code in any way - * without acknowledgement. Other contributors include Andrew Wright, - * Jeffrey Hayes, Pat Fischer, Mike Judd. + * 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.*; @@ -14,7 +15,6 @@ public class PriorityBlockingQueueTest e public static void main(String[] args) { junit.textui.TestRunner.run (suite()); } - public static Test suite() { return new TestSuite(PriorityBlockingQueueTest.class); } @@ -32,7 +32,6 @@ public class PriorityBlockingQueueTest e } } - /** * Create a queue of given size containing consecutive * Integers 0 ... n. @@ -50,48 +49,65 @@ public class PriorityBlockingQueueTest e return q; } - public void testConstructor1(){ + /** + * A new queue has unbounded capacity + */ + public void testConstructor1() { assertEquals(NOCAP, new PriorityBlockingQueue(SIZE).remainingCapacity()); } - public void testConstructor2(){ + /** + * Constructor throws IAE if capacity argument nonpositive + */ + public void testConstructor2() { try { PriorityBlockingQueue q = new PriorityBlockingQueue(0); - fail("Cannot make zero-sized"); + shouldThrow(); } catch (IllegalArgumentException success) {} } - public void testConstructor3(){ - + /** + * Initializing from null Collection throws NPE + */ + public void testConstructor3() { try { PriorityBlockingQueue q = new PriorityBlockingQueue(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 { Integer[] ints = new Integer[SIZE]; PriorityBlockingQueue q = new PriorityBlockingQueue(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 { Integer[] ints = new Integer[SIZE]; for (int i = 0; i < SIZE-1; ++i) ints[i] = new Integer(i); PriorityBlockingQueue q = new PriorityBlockingQueue(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 { Integer[] ints = new Integer[SIZE]; for (int i = 0; i < SIZE; ++i) @@ -103,9 +119,14 @@ public class PriorityBlockingQueueTest e finally {} } - public void testConstructor7(){ + /** + * The comparator used in constructor is used + */ + public void testConstructor7() { try { - PriorityBlockingQueue q = new PriorityBlockingQueue(SIZE, new MyReverseComparator()); + MyReverseComparator cmp = new MyReverseComparator(); + PriorityBlockingQueue q = new PriorityBlockingQueue(SIZE, cmp); + assertEquals(cmp, q.comparator()); Integer[] ints = new Integer[SIZE]; for (int i = 0; i < SIZE; ++i) ints[i] = new Integer(i); @@ -116,19 +137,26 @@ public class PriorityBlockingQueueTest e finally {} } + /** + * isEmpty is true before add, false after + */ public void testEmpty() { PriorityBlockingQueue q = new PriorityBlockingQueue(2); assertTrue(q.isEmpty()); assertEquals(NOCAP, q.remainingCapacity()); - q.add(new Integer(1)); + q.add(one); assertFalse(q.isEmpty()); - q.add(new Integer(2)); + q.add(two); q.remove(); q.remove(); assertTrue(q.isEmpty()); } - public void testRemainingCapacity(){ + /** + * remainingCapacity does not change when elements added or removed, + * but size does + */ + public void testRemainingCapacity() { PriorityBlockingQueue q = populatedQueue(SIZE); for (int i = 0; i < SIZE; ++i) { assertEquals(NOCAP, q.remainingCapacity()); @@ -142,32 +170,55 @@ public class PriorityBlockingQueueTest e } } - public void testOfferNull(){ + /** + * offer(null) throws NPE + */ + public void testOfferNull() { try { PriorityBlockingQueue q = new PriorityBlockingQueue(1); q.offer(null); - fail("should throw NPE"); + shouldThrow(); } catch (NullPointerException success) { } } + /** + * add(null) throws NPE + */ + public void testAddNull() { + try { + PriorityBlockingQueue q = new PriorityBlockingQueue(1); + q.add(null); + shouldThrow(); + } catch (NullPointerException success) { } + } + + /** + * Offer of comparable element succeeds + */ public void testOffer() { PriorityBlockingQueue q = new PriorityBlockingQueue(1); - assertTrue(q.offer(new Integer(0))); - assertTrue(q.offer(new Integer(1))); + assertTrue(q.offer(zero)); + assertTrue(q.offer(one)); } + /** + * Offer of non-Comparable throws CCE + */ public void testOfferNonComparable() { try { PriorityBlockingQueue q = new PriorityBlockingQueue(1); q.offer(new Object()); q.offer(new Object()); q.offer(new Object()); - fail("should throw CCE"); + shouldThrow(); } catch(ClassCastException success) {} } - public void testAdd(){ + /** + * add of comparable succeeds + */ + public void testAdd() { PriorityBlockingQueue q = new PriorityBlockingQueue(SIZE); for (int i = 0; i < SIZE; ++i) { assertEquals(i, q.size()); @@ -175,36 +226,62 @@ public class PriorityBlockingQueueTest e } } - public void testAddAll1(){ + /** + * addAll(null) throws NPE + */ + public void testAddAll1() { try { PriorityBlockingQueue q = new PriorityBlockingQueue(1); q.addAll(null); - fail("Cannot add null collection"); + shouldThrow(); } catch (NullPointerException success) {} } - public void testAddAll2(){ + + /** + * addAll(this) throws IAE + */ + public void testAddAllSelf() { + try { + PriorityBlockingQueue q = populatedQueue(SIZE); + q.addAll(q); + shouldThrow(); + } + catch (IllegalArgumentException success) {} + } + + /** + * addAll of a collection with null elements throws NPE + */ + public void testAddAll2() { try { PriorityBlockingQueue q = new PriorityBlockingQueue(SIZE); Integer[] ints = new Integer[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 { PriorityBlockingQueue q = new PriorityBlockingQueue(SIZE); Integer[] ints = new Integer[SIZE]; for (int i = 0; i < SIZE-1; ++i) ints[i] = new Integer(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 { Integer[] empty = new Integer[0]; Integer[] ints = new Integer[SIZE]; @@ -219,16 +296,22 @@ public class PriorityBlockingQueueTest e finally {} } + /** + * put(null) throws NPE + */ public void testPutNull() { try { PriorityBlockingQueue q = new PriorityBlockingQueue(SIZE); q.put(null); - fail("put should throw NPE"); + shouldThrow(); } catch (NullPointerException success){ } } + /** + * all elements successfully put are contained + */ public void testPut() { try { PriorityBlockingQueue q = new PriorityBlockingQueue(SIZE); @@ -243,10 +326,13 @@ public class PriorityBlockingQueueTest e } } + /** + * put doesn't block waiting for take + */ public void testPutWithTake() { final PriorityBlockingQueue q = new PriorityBlockingQueue(2); Thread t = new Thread(new Runnable() { - public void run(){ + public void run() { int added = 0; try { q.put(new Integer(0)); @@ -269,14 +355,17 @@ public class PriorityBlockingQueueTest e t.interrupt(); t.join(); } catch (Exception e){ - fail("Unexpected exception"); + unexpectedException(); } } + /** + * timed offer does not time out + */ public void testTimedOffer() { final PriorityBlockingQueue q = new PriorityBlockingQueue(2); Thread t = new Thread(new Runnable() { - public void run(){ + public void run() { try { q.put(new Integer(0)); q.put(new Integer(0)); @@ -292,28 +381,34 @@ public class PriorityBlockingQueueTest e t.interrupt(); t.join(); } catch (Exception e){ - fail("Unexpected exception"); + unexpectedException(); } } - public void testTake(){ + /** + * take retrieves elements in priority order + */ + public void testTake() { try { PriorityBlockingQueue q = populatedQueue(SIZE); for (int i = 0; i < SIZE; ++i) { assertEquals(i, ((Integer)q.take()).intValue()); } } catch (InterruptedException e){ - fail("Unexpected exception"); + unexpectedException(); } } + /** + * take blocks interruptibly when empty + */ public void testTakeFromEmpty() { final PriorityBlockingQueue q = new PriorityBlockingQueue(2); Thread t = new Thread(new Runnable() { - public void run(){ + public void run() { try { q.take(); - threadFail("Should block"); + threadShouldThrow(); } catch (InterruptedException success){ } } }); @@ -323,11 +418,14 @@ public class PriorityBlockingQueueTest e 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 +434,7 @@ public class PriorityBlockingQueueTest e threadAssertEquals(i, ((Integer)q.take()).intValue()); } q.take(); - threadFail("take should block"); + threadShouldThrow(); } catch (InterruptedException success){ } }}); @@ -347,12 +445,15 @@ public class PriorityBlockingQueueTest e t.join(); } catch (InterruptedException ie) { - fail("Unexpected exception"); + unexpectedException(); } } - public void testPoll(){ + /** + * poll succeeds unless empty + */ + public void testPoll() { PriorityBlockingQueue q = populatedQueue(SIZE); for (int i = 0; i < SIZE; ++i) { assertEquals(i, ((Integer)q.poll()).intValue()); @@ -360,6 +461,9 @@ public class PriorityBlockingQueueTest e assertNull(q.poll()); } + /** + * timed pool with zero timeout succeeds when non-empty, else times out + */ public void testTimedPoll0() { try { PriorityBlockingQueue q = populatedQueue(SIZE); @@ -368,10 +472,13 @@ public class PriorityBlockingQueueTest e } 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 { PriorityBlockingQueue q = populatedQueue(SIZE); @@ -380,11 +487,15 @@ public class PriorityBlockingQueueTest e } 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,19 +514,23 @@ public class PriorityBlockingQueueTest e 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 PriorityBlockingQueue q = new PriorityBlockingQueue(2); 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); q.poll(LONG_DELAY_MS, TimeUnit.MILLISECONDS); - threadFail("Should block"); + threadShouldThrow(); } catch (InterruptedException success) { } } }); @@ -426,12 +541,15 @@ public class PriorityBlockingQueueTest e 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() { PriorityBlockingQueue q = populatedQueue(SIZE); for (int i = 0; i < SIZE; ++i) { assertEquals(i, ((Integer)q.peek()).intValue()); @@ -442,7 +560,10 @@ public class PriorityBlockingQueueTest e assertNull(q.peek()); } - public void testElement(){ + /** + * element returns next element, or throws NSEE if empty + */ + public void testElement() { PriorityBlockingQueue q = populatedQueue(SIZE); for (int i = 0; i < SIZE; ++i) { assertEquals(i, ((Integer)q.element()).intValue()); @@ -450,24 +571,30 @@ public class PriorityBlockingQueueTest e } 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() { PriorityBlockingQueue q = populatedQueue(SIZE); for (int i = 0; i < SIZE; ++i) { assertEquals(i, ((Integer)q.remove()).intValue()); } 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() { PriorityBlockingQueue q = populatedQueue(SIZE); for (int i = 1; i < SIZE; i+=2) { assertTrue(q.remove(new Integer(i))); @@ -479,7 +606,10 @@ public class PriorityBlockingQueueTest e assertTrue(q.isEmpty()); } - public void testContains(){ + /** + * contains(x) reports true when elements added but not yet removed + */ + public void testContains() { PriorityBlockingQueue q = populatedQueue(SIZE); for (int i = 0; i < SIZE; ++i) { assertTrue(q.contains(new Integer(i))); @@ -488,7 +618,10 @@ public class PriorityBlockingQueueTest e } } - public void testClear(){ + /** + * clear removes all elements + */ + public void testClear() { PriorityBlockingQueue q = populatedQueue(SIZE); q.clear(); assertTrue(q.isEmpty()); @@ -500,7 +633,10 @@ public class PriorityBlockingQueueTest e assertTrue(q.isEmpty()); } - public void testContainsAll(){ + /** + * containsAll(c) is true when c contains a subset of elements + */ + public void testContainsAll() { PriorityBlockingQueue q = populatedQueue(SIZE); PriorityBlockingQueue p = new PriorityBlockingQueue(SIZE); for (int i = 0; i < SIZE; ++i) { @@ -511,7 +647,10 @@ public class PriorityBlockingQueueTest e assertTrue(p.containsAll(q)); } - public void testRetainAll(){ + /** + * retainAll(c) retains only those elements of c and reports true if changed + */ + public void testRetainAll() { PriorityBlockingQueue q = populatedQueue(SIZE); PriorityBlockingQueue p = populatedQueue(SIZE); for (int i = 0; i < SIZE; ++i) { @@ -527,7 +666,10 @@ public class PriorityBlockingQueueTest e } } - 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) { PriorityBlockingQueue q = populatedQueue(SIZE); PriorityBlockingQueue p = populatedQueue(i); @@ -540,7 +682,10 @@ public class PriorityBlockingQueueTest e } } - public void testToArray(){ + /** + * toArray contains all elements + */ + public void testToArray() { PriorityBlockingQueue q = populatedQueue(SIZE); Object[] o = q.toArray(); Arrays.sort(o); @@ -548,11 +693,14 @@ public class PriorityBlockingQueueTest e 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() { PriorityBlockingQueue q = populatedQueue(SIZE); Integer[] ints = new Integer[SIZE]; ints = (Integer[])q.toArray(ints); @@ -561,11 +709,36 @@ public class PriorityBlockingQueueTest e 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 { + PriorityBlockingQueue q = populatedQueue(SIZE); + Object o[] = q.toArray(null); + shouldThrow(); + } catch(NullPointerException success){} + } + + /** + * toArray with incompatible array type throws CCE + */ + public void testToArray1_BadArg() { + try { + PriorityBlockingQueue 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() { PriorityBlockingQueue q = populatedQueue(SIZE); int i = 0; Iterator it = q.iterator(); @@ -576,10 +749,11 @@ public class PriorityBlockingQueueTest e assertEquals(i, SIZE); } + /** + * iterator.remove removes current element + */ public void testIteratorRemove () { - final PriorityBlockingQueue q = new PriorityBlockingQueue(3); - q.add(new Integer(2)); q.add(new Integer(1)); q.add(new Integer(3)); @@ -595,7 +769,10 @@ public class PriorityBlockingQueueTest e } - public void testToString(){ + /** + * toString contains toStrings of elements + */ + public void testToString() { PriorityBlockingQueue q = populatedQueue(SIZE); String s = q.toString(); for (int i = 0; i < SIZE; ++i) { @@ -603,12 +780,12 @@ public class PriorityBlockingQueueTest e } } + /** + * offer transfers elements across Executor tasks + */ public void testPollInExecutor() { - final PriorityBlockingQueue q = new PriorityBlockingQueue(2); - ExecutorService executor = Executors.newFixedThreadPool(2); - executor.execute(new Runnable() { public void run() { threadAssertNull(q.poll()); @@ -617,7 +794,7 @@ public class PriorityBlockingQueueTest e threadAssertTrue(q.isEmpty()); } catch (InterruptedException e) { - threadFail("should not be interrupted"); + threadUnexpectedException(); } } }); @@ -629,15 +806,17 @@ public class PriorityBlockingQueueTest e q.put(new Integer(1)); } catch (InterruptedException e) { - threadFail("should not be interrupted"); + threadUnexpectedException(); } } }); joinPool(executor); - } + /** + * A deserialized serialized queue has same elements + */ public void testSerialization() { PriorityBlockingQueue q = populatedQueue(SIZE); try { @@ -653,8 +832,110 @@ public class PriorityBlockingQueueTest e while (!q.isEmpty()) assertEquals(q.remove(), r.remove()); } catch(Exception e){ - fail("unexpected exception"); + unexpectedException(); } } + /** + * drainTo(null) throws NPE + */ + public void testDrainToNull() { + PriorityBlockingQueue q = populatedQueue(SIZE); + try { + q.drainTo(null); + shouldThrow(); + } catch(NullPointerException success) { + } + } + + /** + * drainTo(this) throws IAE + */ + public void testDrainToSelf() { + PriorityBlockingQueue q = populatedQueue(SIZE); + try { + q.drainTo(q); + shouldThrow(); + } catch(IllegalArgumentException success) { + } + } + + /** + * drainTo(c) empties queue into another collection c + */ + public void testDrainTo() { + PriorityBlockingQueue q = populatedQueue(SIZE); + ArrayList l = new ArrayList(); + q.drainTo(l); + assertEquals(q.size(), 0); + assertEquals(l.size(), SIZE); + for (int i = 0; i < SIZE; ++i) + assertEquals(l.get(i), new Integer(i)); + } + + /** + * drainTo empties queue + */ + public void testDrainToWithActivePut() { + final PriorityBlockingQueue q = populatedQueue(SIZE); + Thread t = new Thread(new Runnable() { + public void run() { + q.put(new Integer(SIZE+1)); + } + }); + try { + t.start(); + ArrayList l = new ArrayList(); + q.drainTo(l); + assertTrue(l.size() >= SIZE); + for (int i = 0; i < SIZE; ++i) + assertEquals(l.get(i), new Integer(i)); + t.join(); + assertTrue(q.size() + l.size() == SIZE+1); + } catch(Exception e){ + unexpectedException(); + } + } + + /** + * drainTo(null, n) throws NPE + */ + public void testDrainToNullN() { + PriorityBlockingQueue q = populatedQueue(SIZE); + try { + q.drainTo(null, 0); + shouldThrow(); + } catch(NullPointerException success) { + } + } + + /** + * drainTo(this, n) throws IAE + */ + public void testDrainToSelfN() { + PriorityBlockingQueue 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) { + PriorityBlockingQueue 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); + for (int j = 0; j < k; ++j) + assertTrue(l.contains(new Integer(j))); + } + } + + }