--- jsr166/src/test/tck/PriorityQueueTest.java 2003/09/14 20:42:40 1.3 +++ jsr166/src/test/tck/PriorityQueueTest.java 2009/11/21 10:25:05 1.13 @@ -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.*; @@ -11,16 +12,14 @@ import java.util.concurrent.*; import java.io.*; public class PriorityQueueTest extends JSR166TestCase { - public static void main(String[] args) { - junit.textui.TestRunner.run (suite()); + junit.textui.TestRunner.run (suite()); } - public static Test suite() { - return new TestSuite(PriorityQueueTest.class); + return new TestSuite(PriorityQueueTest.class); } - static class MyReverseComparator implements Comparator { + static class MyReverseComparator implements Comparator { public int compare(Object x, Object y) { int i = ((Integer)x).intValue(); int j = ((Integer)y).intValue(); @@ -30,7 +29,6 @@ public class PriorityQueueTest extends J } } - /** * Create a queue of given size containing consecutive * Integers 0 ... n. @@ -38,57 +36,70 @@ public class PriorityQueueTest extends J private PriorityQueue populatedQueue(int n) { PriorityQueue q = new PriorityQueue(n); assertTrue(q.isEmpty()); - for(int i = n-1; i >= 0; i-=2) - assertTrue(q.offer(new Integer(i))); - for(int i = (n & 1); i < n; i+=2) - assertTrue(q.offer(new Integer(i))); + for (int i = n-1; i >= 0; i-=2) + assertTrue(q.offer(new Integer(i))); + for (int i = (n & 1); i < n; i+=2) + assertTrue(q.offer(new Integer(i))); assertFalse(q.isEmpty()); - assertEquals(n, q.size()); + assertEquals(n, q.size()); return q; } - - public void testConstructor1(){ + + /** + * A new queue has unbounded capacity + */ + public void testConstructor1() { assertEquals(0, new PriorityQueue(SIZE).size()); } - public void testConstructor2(){ + /** + * Constructor throws IAE if capacity argument nonpositive + */ + public void testConstructor2() { try { PriorityQueue q = new PriorityQueue(0); - fail("Cannot make zero-sized"); - } - catch (IllegalArgumentException success) {} + shouldThrow(); + } catch (IllegalArgumentException success) {} } + /** + * Initializing from null Collection throws NPE + */ public void testConstructor3() { - try { PriorityQueue q = new PriorityQueue((Collection)null); - fail("Cannot make from null collection"); - } - catch (NullPointerException success) {} + shouldThrow(); + } catch (NullPointerException success) {} } - public void testConstructor4(){ + /** + * Initializing from Collection of null elements throws NPE + */ + public void testConstructor4() { try { Integer[] ints = new Integer[SIZE]; PriorityQueue q = new PriorityQueue(Arrays.asList(ints)); - fail("Cannot make with null elements"); - } - catch (NullPointerException success) {} + 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); PriorityQueue q = new PriorityQueue(Arrays.asList(ints)); - fail("Cannot make with null elements"); - } - catch (NullPointerException success) {} + 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) @@ -100,9 +111,14 @@ public class PriorityQueueTest extends J finally {} } - public void testConstructor7(){ + /** + * The comparator used in constructor is used + */ + public void testConstructor7() { try { - PriorityQueue q = new PriorityQueue(SIZE, new MyReverseComparator()); + MyReverseComparator cmp = new MyReverseComparator(); + PriorityQueue q = new PriorityQueue(SIZE, cmp); + assertEquals(cmp, q.comparator()); Integer[] ints = new Integer[SIZE]; for (int i = 0; i < SIZE; ++i) ints[i] = new Integer(i); @@ -113,6 +129,9 @@ public class PriorityQueueTest extends J finally {} } + /** + * isEmpty is true before add, false after + */ public void testEmpty() { PriorityQueue q = new PriorityQueue(2); assertTrue(q.isEmpty()); @@ -124,6 +143,9 @@ public class PriorityQueueTest extends J assertTrue(q.isEmpty()); } + /** + * size changes when elements added and removed + */ public void testSize() { PriorityQueue q = populatedQueue(SIZE); for (int i = 0; i < SIZE; ++i) { @@ -136,32 +158,54 @@ public class PriorityQueueTest extends J } } - public void testOfferNull(){ - try { + /** + * offer(null) throws NPE + */ + public void testOfferNull() { + try { PriorityQueue q = new PriorityQueue(1); q.offer(null); - fail("should throw NPE"); - } catch (NullPointerException success) { } + shouldThrow(); + } catch (NullPointerException success) {} + } + + /** + * add(null) throws NPE + */ + public void testAddNull() { + try { + PriorityQueue q = new PriorityQueue(1); + q.add(null); + shouldThrow(); + } catch (NullPointerException success) {} } + /** + * Offer of comparable element succeeds + */ public void testOffer() { PriorityQueue q = new PriorityQueue(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 { PriorityQueue q = new PriorityQueue(1); q.offer(new Object()); q.offer(new Object()); q.offer(new Object()); - fail("should throw CCE"); - } - catch(ClassCastException success) {} + shouldThrow(); + } catch (ClassCastException success) {} } - public void testAdd(){ + /** + * add of comparable succeeds + */ + public void testAdd() { PriorityQueue q = new PriorityQueue(SIZE); for (int i = 0; i < SIZE; ++i) { assertEquals(i, q.size()); @@ -169,36 +213,46 @@ public class PriorityQueueTest extends J } } - public void testAddAll1(){ + /** + * addAll(null) throws NPE + */ + public void testAddAll1() { try { PriorityQueue q = new PriorityQueue(1); q.addAll(null); - fail("Cannot add null collection"); - } - catch (NullPointerException success) {} + shouldThrow(); + } catch (NullPointerException success) {} } - public void testAddAll2(){ + /** + * addAll of a collection with null elements throws NPE + */ + public void testAddAll2() { try { PriorityQueue q = new PriorityQueue(SIZE); Integer[] ints = new Integer[SIZE]; q.addAll(Arrays.asList(ints)); - fail("Cannot add null elements"); - } - catch (NullPointerException success) {} + 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 { PriorityQueue q = new PriorityQueue(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"); - } - catch (NullPointerException success) {} + 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]; @@ -213,15 +267,21 @@ public class PriorityQueueTest extends J finally {} } - public void testPoll(){ + /** + * poll succeeds unless empty + */ + public void testPoll() { PriorityQueue q = populatedQueue(SIZE); for (int i = 0; i < SIZE; ++i) { assertEquals(i, ((Integer)q.poll()).intValue()); } - assertNull(q.poll()); + assertNull(q.poll()); } - public void testPeek(){ + /** + * peek returns next element, or null if empty + */ + public void testPeek() { PriorityQueue q = populatedQueue(SIZE); for (int i = 0; i < SIZE; ++i) { assertEquals(i, ((Integer)q.peek()).intValue()); @@ -229,10 +289,13 @@ public class PriorityQueueTest extends J assertTrue(q.peek() == null || i != ((Integer)q.peek()).intValue()); } - assertNull(q.peek()); + assertNull(q.peek()); } - public void testElement(){ + /** + * element returns next element, or throws NSEE if empty + */ + public void testElement() { PriorityQueue q = populatedQueue(SIZE); for (int i = 0; i < SIZE; ++i) { assertEquals(i, ((Integer)q.element()).intValue()); @@ -240,24 +303,28 @@ public class PriorityQueueTest extends J } try { q.element(); - fail("no such element"); - } - catch (NoSuchElementException success) {} + shouldThrow(); + } catch (NoSuchElementException success) {} } - public void testRemove(){ + /** + * remove removes next element, or throws NSEE if empty + */ + public void testRemove() { PriorityQueue q = populatedQueue(SIZE); for (int i = 0; i < SIZE; ++i) { assertEquals(i, ((Integer)q.remove()).intValue()); } try { q.remove(); - fail("remove should throw"); - } catch (NoSuchElementException success){ - } + shouldThrow(); + } catch (NoSuchElementException success) {} } - public void testRemoveElement(){ + /** + * remove(x) removes x and returns true if present + */ + public void testRemoveElement() { PriorityQueue q = populatedQueue(SIZE); for (int i = 1; i < SIZE; i+=2) { assertTrue(q.remove(new Integer(i))); @@ -268,8 +335,11 @@ public class PriorityQueueTest extends J } assertTrue(q.isEmpty()); } - - public void testContains(){ + + /** + * contains(x) reports true when elements added but not yet removed + */ + public void testContains() { PriorityQueue q = populatedQueue(SIZE); for (int i = 0; i < SIZE; ++i) { assertTrue(q.contains(new Integer(i))); @@ -278,7 +348,10 @@ public class PriorityQueueTest extends J } } - public void testClear(){ + /** + * clear removes all elements + */ + public void testClear() { PriorityQueue q = populatedQueue(SIZE); q.clear(); assertTrue(q.isEmpty()); @@ -289,7 +362,10 @@ public class PriorityQueueTest extends J assertTrue(q.isEmpty()); } - public void testContainsAll(){ + /** + * containsAll(c) is true when c contains a subset of elements + */ + public void testContainsAll() { PriorityQueue q = populatedQueue(SIZE); PriorityQueue p = new PriorityQueue(SIZE); for (int i = 0; i < SIZE; ++i) { @@ -300,7 +376,10 @@ public class PriorityQueueTest extends J assertTrue(p.containsAll(q)); } - public void testRetainAll(){ + /** + * retainAll(c) retains only those elements of c and reports true if changed + */ + public void testRetainAll() { PriorityQueue q = populatedQueue(SIZE); PriorityQueue p = populatedQueue(SIZE); for (int i = 0; i < SIZE; ++i) { @@ -316,7 +395,10 @@ public class PriorityQueueTest extends J } } - 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) { PriorityQueue q = populatedQueue(SIZE); PriorityQueue p = populatedQueue(i); @@ -329,38 +411,48 @@ public class PriorityQueueTest extends J } } - public void testToArray(){ + /** + * toArray contains all elements + */ + public void testToArray() { PriorityQueue q = populatedQueue(SIZE); - Object[] o = q.toArray(); + Object[] o = q.toArray(); Arrays.sort(o); - for(int i = 0; i < o.length; i++) - assertEquals(o[i], q.poll()); + for (int i = 0; i < o.length; i++) + assertEquals(o[i], q.poll()); } - public void testToArray2(){ + /** + * toArray(a) contains all elements + */ + public void testToArray2() { PriorityQueue q = populatedQueue(SIZE); - Integer[] ints = new Integer[SIZE]; - ints = (Integer[])q.toArray(ints); + Integer[] ints = new Integer[SIZE]; + ints = (Integer[])q.toArray(ints); Arrays.sort(ints); - for(int i = 0; i < ints.length; i++) + for (int i = 0; i < ints.length; i++) assertEquals(ints[i], q.poll()); } - - public void testIterator(){ + + /** + * iterator iterates through all elements + */ + public void testIterator() { PriorityQueue q = populatedQueue(SIZE); int i = 0; - Iterator it = q.iterator(); - while(it.hasNext()) { + Iterator it = q.iterator(); + while (it.hasNext()) { assertTrue(q.contains(it.next())); ++i; } assertEquals(i, SIZE); } + /** + * iterator.remove removes current element + */ public void testIteratorRemove () { - final PriorityQueue q = new PriorityQueue(3); - q.add(new Integer(2)); q.add(new Integer(1)); q.add(new Integer(3)); @@ -376,30 +468,32 @@ public class PriorityQueueTest extends J } - public void testToString(){ + /** + * toString contains toStrings of elements + */ + public void testToString() { PriorityQueue q = populatedQueue(SIZE); String s = q.toString(); for (int i = 0; i < SIZE; ++i) { assertTrue(s.indexOf(String.valueOf(i)) >= 0); } - } + } - public void testSerialization() { + /** + * A deserialized serialized queue has same elements + */ + public void testSerialization() throws Exception { PriorityQueue q = populatedQueue(SIZE); - try { - ByteArrayOutputStream bout = new ByteArrayOutputStream(10000); - ObjectOutputStream out = new ObjectOutputStream(new BufferedOutputStream(bout)); - out.writeObject(q); - out.close(); - - ByteArrayInputStream bin = new ByteArrayInputStream(bout.toByteArray()); - ObjectInputStream in = new ObjectInputStream(new BufferedInputStream(bin)); - PriorityQueue r = (PriorityQueue)in.readObject(); - assertEquals(q.size(), r.size()); - while (!q.isEmpty()) - assertEquals(q.remove(), r.remove()); - } catch(Exception e){ - fail("unexpected exception"); - } + ByteArrayOutputStream bout = new ByteArrayOutputStream(10000); + ObjectOutputStream out = new ObjectOutputStream(new BufferedOutputStream(bout)); + out.writeObject(q); + out.close(); + + ByteArrayInputStream bin = new ByteArrayInputStream(bout.toByteArray()); + ObjectInputStream in = new ObjectInputStream(new BufferedInputStream(bin)); + PriorityQueue r = (PriorityQueue)in.readObject(); + assertEquals(q.size(), r.size()); + while (!q.isEmpty()) + assertEquals(q.remove(), r.remove()); } }