--- jsr166/src/test/tck/LinkedBlockingQueueTest.java 2003/09/07 20:39:11 1.2 +++ jsr166/src/test/tck/LinkedBlockingQueueTest.java 2003/12/29 19:05:40 1.8 @@ -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.*; @@ -10,12 +11,7 @@ import java.util.*; import java.util.concurrent.*; import java.io.*; -public class LinkedBlockingQueueTest extends TestCase { - - private static int N = 10; - private static long SHORT_DELAY_MS = 100; - private static long MEDIUM_DELAY_MS = 1000; - private static long LONG_DELAY_MS = 10000; +public class LinkedBlockingQueueTest extends JSR166TestCase { public static void main(String[] args) { junit.textui.TestRunner.run (suite()); @@ -25,11 +21,12 @@ public class LinkedBlockingQueueTest ext return new TestSuite(LinkedBlockingQueueTest.class); } + /** * Create a queue of given size containing consecutive * Integers 0 ... n. */ - private LinkedBlockingQueue fullQueue(int n) { + private LinkedBlockingQueue populatedQueue(int n) { LinkedBlockingQueue q = new LinkedBlockingQueue(n); assertTrue(q.isEmpty()); for(int i = 0; i < n; i++) @@ -40,182 +37,262 @@ public class LinkedBlockingQueueTest ext return q; } - public void testConstructor1(){ - assertEquals(N, new LinkedBlockingQueue(N).remainingCapacity()); + /** + * A new queue has the indicated capacity, or Integer.MAX_VALUE if + * none given + */ + public void testConstructor1() { + assertEquals(SIZE, new LinkedBlockingQueue(SIZE).remainingCapacity()); + assertEquals(Integer.MAX_VALUE, new LinkedBlockingQueue().remainingCapacity()); } - public void testConstructor2(){ + /** + * Constructor throws IAE if capacity argument nonpositive + */ + public void testConstructor2() { try { LinkedBlockingQueue q = new LinkedBlockingQueue(0); - fail("Cannot make zero-sized"); + shouldThrow(); } catch (IllegalArgumentException success) {} } - public void testConstructor3(){ - + /** + * Initializing from null Collection throws NPE + */ + public void testConstructor3() { try { LinkedBlockingQueue q = new LinkedBlockingQueue(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[N]; + Integer[] ints = new Integer[SIZE]; LinkedBlockingQueue q = new LinkedBlockingQueue(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[N]; - for (int i = 0; i < N-1; ++i) + Integer[] ints = new Integer[SIZE]; + for (int i = 0; i < SIZE-1; ++i) ints[i] = new Integer(i); LinkedBlockingQueue q = new LinkedBlockingQueue(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[N]; - for (int i = 0; i < N; ++i) + Integer[] ints = new Integer[SIZE]; + for (int i = 0; i < SIZE; ++i) ints[i] = new Integer(i); LinkedBlockingQueue q = new LinkedBlockingQueue(Arrays.asList(ints)); - for (int i = 0; i < N; ++i) + for (int i = 0; i < SIZE; ++i) assertEquals(ints[i], q.poll()); } finally {} } + /** + * Queue transitions from empty to full when elements added + */ public void testEmptyFull() { LinkedBlockingQueue q = new LinkedBlockingQueue(2); assertTrue(q.isEmpty()); assertEquals("should have room for 2", 2, q.remainingCapacity()); - q.add(new Integer(1)); + q.add(one); assertFalse(q.isEmpty()); - q.add(new Integer(2)); + q.add(two); assertFalse(q.isEmpty()); - assertEquals("queue should be full", 0, q.remainingCapacity()); - assertFalse("offer should be rejected", q.offer(new Integer(3))); + assertEquals(0, q.remainingCapacity()); + assertFalse(q.offer(three)); } - public void testRemainingCapacity(){ - LinkedBlockingQueue q = fullQueue(N); - for (int i = 0; i < N; ++i) { + /** + * remainingCapacity decreases on add, increases on remove + */ + public void testRemainingCapacity() { + LinkedBlockingQueue q = populatedQueue(SIZE); + for (int i = 0; i < SIZE; ++i) { assertEquals(i, q.remainingCapacity()); - assertEquals(N-i, q.size()); + assertEquals(SIZE-i, q.size()); q.remove(); } - for (int i = 0; i < N; ++i) { - assertEquals(N-i, q.remainingCapacity()); + for (int i = 0; i < SIZE; ++i) { + assertEquals(SIZE-i, q.remainingCapacity()); assertEquals(i, q.size()); q.add(new Integer(i)); } } - public void testOfferNull(){ + /** + * offer(null) throws NPE + */ + public void testOfferNull() { try { LinkedBlockingQueue q = new LinkedBlockingQueue(1); q.offer(null); - fail("should throw NPE"); + shouldThrow(); + } catch (NullPointerException success) { } + } + + /** + * add(null) throws NPE + */ + public void testAddNull() { + try { + LinkedBlockingQueue q = new LinkedBlockingQueue(1); + q.add(null); + shouldThrow(); } catch (NullPointerException success) { } } - public void testOffer(){ + /** + * Offer succeeds if not full; fails if full + */ + public void testOffer() { LinkedBlockingQueue q = new LinkedBlockingQueue(1); - assertTrue(q.offer(new Integer(0))); - assertFalse(q.offer(new Integer(1))); + assertTrue(q.offer(zero)); + assertFalse(q.offer(one)); } - public void testAdd(){ + /** + * add succeeds if not full; throws ISE if full + */ + public void testAdd() { try { - LinkedBlockingQueue q = new LinkedBlockingQueue(N); - for (int i = 0; i < N; ++i) { + LinkedBlockingQueue q = new LinkedBlockingQueue(SIZE); + for (int i = 0; i < SIZE; ++i) { assertTrue(q.add(new Integer(i))); } assertEquals(0, q.remainingCapacity()); - q.add(new Integer(N)); + q.add(new Integer(SIZE)); } catch (IllegalStateException success){ } } - public void testAddAll1(){ + /** + * addAll(null) throws NPE + */ + public void testAddAll1() { try { LinkedBlockingQueue q = new LinkedBlockingQueue(1); q.addAll(null); - fail("Cannot add null collection"); + shouldThrow(); } catch (NullPointerException success) {} } - public void testAddAll2(){ + + /** + * addAll(this) throws IAE + */ + public void testAddAllSelf() { try { - LinkedBlockingQueue q = new LinkedBlockingQueue(N); - Integer[] ints = new Integer[N]; + LinkedBlockingQueue q = populatedQueue(SIZE); + q.addAll(q); + shouldThrow(); + } + catch (IllegalArgumentException success) {} + } + + /** + * addAll of a collection with null elements throws NPE + */ + public void testAddAll2() { + try { + LinkedBlockingQueue q = new LinkedBlockingQueue(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 { - LinkedBlockingQueue q = new LinkedBlockingQueue(N); - Integer[] ints = new Integer[N]; - for (int i = 0; i < N-1; ++i) + LinkedBlockingQueue q = new LinkedBlockingQueue(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 testAddAll4(){ + /** + * addAll throws ISE if not enough room + */ + public void testAddAll4() { try { LinkedBlockingQueue q = new LinkedBlockingQueue(1); - Integer[] ints = new Integer[N]; - for (int i = 0; i < N; ++i) + Integer[] ints = new Integer[SIZE]; + for (int i = 0; i < SIZE; ++i) ints[i] = new Integer(i); q.addAll(Arrays.asList(ints)); - fail("Cannot add with insufficient capacity"); + shouldThrow(); } catch (IllegalStateException success) {} } - public void testAddAll5(){ + /** + * Queue contains all elements, in traversal order, of successful addAll + */ + public void testAddAll5() { try { Integer[] empty = new Integer[0]; - Integer[] ints = new Integer[N]; - for (int i = 0; i < N; ++i) + Integer[] ints = new Integer[SIZE]; + for (int i = 0; i < SIZE; ++i) ints[i] = new Integer(i); - LinkedBlockingQueue q = new LinkedBlockingQueue(N); + LinkedBlockingQueue q = new LinkedBlockingQueue(SIZE); assertFalse(q.addAll(Arrays.asList(empty))); assertTrue(q.addAll(Arrays.asList(ints))); - for (int i = 0; i < N; ++i) + for (int i = 0; i < SIZE; ++i) assertEquals(ints[i], q.poll()); } finally {} } + /** + * put(null) throws NPE + */ public void testPutNull() { try { - LinkedBlockingQueue q = new LinkedBlockingQueue(N); + LinkedBlockingQueue q = new LinkedBlockingQueue(SIZE); q.put(null); - fail("put should throw NPE"); + shouldThrow(); } catch (NullPointerException success){ } catch (InterruptedException ie) { - fail("Unexpected exception"); + unexpectedException(); } } + /** + * all elements successfully put are contained + */ public void testPut() { try { - LinkedBlockingQueue q = new LinkedBlockingQueue(N); - for (int i = 0; i < N; ++i) { + LinkedBlockingQueue q = new LinkedBlockingQueue(SIZE); + for (int i = 0; i < SIZE; ++i) { Integer I = new Integer(i); q.put(I); assertTrue(q.contains(I)); @@ -223,24 +300,27 @@ public class LinkedBlockingQueueTest ext assertEquals(0, q.remainingCapacity()); } catch (InterruptedException ie) { - fail("Unexpected exception"); + unexpectedException(); } } - public void testBlockingPut(){ + /** + * put blocks interruptibly if full + */ + public void testBlockingPut() { Thread t = new Thread(new Runnable() { public void run() { int added = 0; try { - LinkedBlockingQueue q = new LinkedBlockingQueue(N); - for (int i = 0; i < N; ++i) { + LinkedBlockingQueue q = new LinkedBlockingQueue(SIZE); + for (int i = 0; i < SIZE; ++i) { q.put(new Integer(i)); ++added; } - q.put(new Integer(N)); - fail("put should block"); + q.put(new Integer(SIZE)); + threadShouldThrow(); } catch (InterruptedException ie){ - assertEquals(added, N); + threadAssertEquals(added, SIZE); } }}); t.start(); @@ -250,14 +330,17 @@ public class LinkedBlockingQueueTest ext t.join(); } catch (InterruptedException ie) { - fail("Unexpected exception"); + unexpectedException(); } } + /** + * put blocks waiting for take when full + */ public void testPutWithTake() { final LinkedBlockingQueue q = new LinkedBlockingQueue(2); Thread t = new Thread(new Runnable() { - public void run(){ + public void run() { int added = 0; try { q.put(new Object()); @@ -268,9 +351,9 @@ public class LinkedBlockingQueueTest ext ++added; q.put(new Object()); ++added; - fail("Should block"); + threadShouldThrow(); } catch (InterruptedException e){ - assertTrue(added >= 2); + threadAssertTrue(added >= 2); } } }); @@ -281,52 +364,61 @@ public class LinkedBlockingQueueTest ext t.interrupt(); t.join(); } catch (Exception e){ - fail("Unexpected exception"); + unexpectedException(); } } + /** + * timed offer times out if full and elements not taken + */ public void testTimedOffer() { final LinkedBlockingQueue q = new LinkedBlockingQueue(2); Thread t = new Thread(new Runnable() { - public void run(){ + public void run() { try { q.put(new Object()); q.put(new Object()); - assertFalse(q.offer(new Object(), SHORT_DELAY_MS/2, TimeUnit.MILLISECONDS)); + threadAssertFalse(q.offer(new Object(), SHORT_DELAY_MS, TimeUnit.MILLISECONDS)); q.offer(new Object(), LONG_DELAY_MS, TimeUnit.MILLISECONDS); - fail("Should block"); + threadShouldThrow(); } catch (InterruptedException success){} } }); try { t.start(); - Thread.sleep(SHORT_DELAY_MS); + Thread.sleep(SMALL_DELAY_MS); t.interrupt(); t.join(); } catch (Exception e){ - fail("Unexpected exception"); + unexpectedException(); } } - public void testTake(){ + /** + * take retrieves elements in FIFO order + */ + public void testTake() { try { - LinkedBlockingQueue q = fullQueue(N); - for (int i = 0; i < N; ++i) { + LinkedBlockingQueue 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 LinkedBlockingQueue q = new LinkedBlockingQueue(2); Thread t = new Thread(new Runnable() { - public void run(){ + public void run() { try { q.take(); - fail("Should block"); + threadShouldThrow(); } catch (InterruptedException success){ } } }); @@ -336,20 +428,23 @@ public class LinkedBlockingQueueTest ext 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 { - LinkedBlockingQueue q = fullQueue(N); - for (int i = 0; i < N; ++i) { + LinkedBlockingQueue q = populatedQueue(SIZE); + for (int i = 0; i < SIZE; ++i) { assertEquals(i, ((Integer)q.take()).intValue()); } q.take(); - fail("take should block"); + threadShouldThrow(); } catch (InterruptedException success){ } }}); @@ -360,52 +455,65 @@ public class LinkedBlockingQueueTest ext t.join(); } catch (InterruptedException ie) { - fail("Unexpected exception"); + unexpectedException(); } } - public void testPoll(){ - LinkedBlockingQueue q = fullQueue(N); - for (int i = 0; i < N; ++i) { + /** + * poll succeeds unless empty + */ + public void testPoll() { + LinkedBlockingQueue q = populatedQueue(SIZE); + for (int i = 0; i < SIZE; ++i) { assertEquals(i, ((Integer)q.poll()).intValue()); } assertNull(q.poll()); } + /** + * timed pool with zero timeout succeeds when non-empty, else times out + */ public void testTimedPoll0() { try { - LinkedBlockingQueue q = fullQueue(N); - for (int i = 0; i < N; ++i) { + LinkedBlockingQueue q = populatedQueue(SIZE); + for (int i = 0; i < SIZE; ++i) { assertEquals(i, ((Integer)q.poll(0, TimeUnit.MILLISECONDS)).intValue()); } 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 { - LinkedBlockingQueue q = fullQueue(N); - for (int i = 0; i < N; ++i) { + LinkedBlockingQueue q = populatedQueue(SIZE); + for (int i = 0; i < SIZE; ++i) { assertEquals(i, ((Integer)q.poll(SHORT_DELAY_MS, TimeUnit.MILLISECONDS)).intValue()); } 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 { - LinkedBlockingQueue q = fullQueue(N); - for (int i = 0; i < N; ++i) { - assertEquals(i, ((Integer)q.poll(SHORT_DELAY_MS, TimeUnit.MILLISECONDS)).intValue()); + LinkedBlockingQueue q = populatedQueue(SIZE); + for (int i = 0; i < SIZE; ++i) { + threadAssertEquals(i, ((Integer)q.poll(SHORT_DELAY_MS, TimeUnit.MILLISECONDS)).intValue()); } - assertNull(q.poll(SHORT_DELAY_MS, TimeUnit.MILLISECONDS)); + threadAssertNull(q.poll(SHORT_DELAY_MS, TimeUnit.MILLISECONDS)); } catch (InterruptedException success){ } }}); @@ -416,37 +524,43 @@ public class LinkedBlockingQueueTest ext 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 LinkedBlockingQueue q = new LinkedBlockingQueue(2); Thread t = new Thread(new Runnable() { - public void run(){ + public void run() { try { - assertNull(q.poll(SHORT_DELAY_MS, TimeUnit.MILLISECONDS)); + threadAssertNull(q.poll(SHORT_DELAY_MS, TimeUnit.MILLISECONDS)); q.poll(LONG_DELAY_MS, TimeUnit.MILLISECONDS); q.poll(LONG_DELAY_MS, TimeUnit.MILLISECONDS); - fail("Should block"); + threadShouldThrow(); } catch (InterruptedException success) { } } }); try { t.start(); - Thread.sleep(SHORT_DELAY_MS * 2); - assertTrue(q.offer(new Integer(0), SHORT_DELAY_MS, TimeUnit.MILLISECONDS)); + Thread.sleep(SMALL_DELAY_MS); + assertTrue(q.offer(zero, SHORT_DELAY_MS, TimeUnit.MILLISECONDS)); t.interrupt(); t.join(); } catch (Exception e){ - fail("Unexpected exception"); + unexpectedException(); } } - - public void testPeek(){ - LinkedBlockingQueue q = fullQueue(N); - for (int i = 0; i < N; ++i) { + /** + * peek returns next element, or null if empty + */ + public void testPeek() { + LinkedBlockingQueue q = populatedQueue(SIZE); + for (int i = 0; i < SIZE; ++i) { assertEquals(i, ((Integer)q.peek()).intValue()); q.poll(); assertTrue(q.peek() == null || @@ -455,68 +569,86 @@ public class LinkedBlockingQueueTest ext assertNull(q.peek()); } - public void testElement(){ - LinkedBlockingQueue q = fullQueue(N); - for (int i = 0; i < N; ++i) { + /** + * element returns next element, or throws NSEE if empty + */ + public void testElement() { + LinkedBlockingQueue q = populatedQueue(SIZE); + for (int i = 0; i < SIZE; ++i) { assertEquals(i, ((Integer)q.element()).intValue()); q.poll(); } try { q.element(); - fail("no such element"); + shouldThrow(); } catch (NoSuchElementException success) {} } - public void testRemove(){ - LinkedBlockingQueue q = fullQueue(N); - for (int i = 0; i < N; ++i) { + /** + * remove removes next element, or throws NSEE if empty + */ + public void testRemove() { + LinkedBlockingQueue 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(){ - LinkedBlockingQueue q = fullQueue(N); - for (int i = 1; i < N; i+=2) { + /** + * remove(x) removes x and returns true if present + */ + public void testRemoveElement() { + LinkedBlockingQueue q = populatedQueue(SIZE); + for (int i = 1; i < SIZE; i+=2) { assertTrue(q.remove(new Integer(i))); } - for (int i = 0; i < N; i+=2) { + for (int i = 0; i < SIZE; i+=2) { assertTrue(q.remove(new Integer(i))); assertFalse(q.remove(new Integer(i+1))); } assertTrue(q.isEmpty()); } - public void testContains(){ - LinkedBlockingQueue q = fullQueue(N); - for (int i = 0; i < N; ++i) { + /** + * contains(x) reports true when elements added but not yet removed + */ + public void testContains() { + LinkedBlockingQueue q = populatedQueue(SIZE); + for (int i = 0; i < SIZE; ++i) { assertTrue(q.contains(new Integer(i))); q.poll(); assertFalse(q.contains(new Integer(i))); } } - public void testClear(){ - LinkedBlockingQueue q = fullQueue(N); + /** + * clear removes all elements + */ + public void testClear() { + LinkedBlockingQueue q = populatedQueue(SIZE); q.clear(); assertTrue(q.isEmpty()); assertEquals(0, q.size()); - assertEquals(N, q.remainingCapacity()); - q.add(new Integer(1)); + assertEquals(SIZE, q.remainingCapacity()); + q.add(one); assertFalse(q.isEmpty()); q.clear(); assertTrue(q.isEmpty()); } - public void testContainsAll(){ - LinkedBlockingQueue q = fullQueue(N); - LinkedBlockingQueue p = new LinkedBlockingQueue(N); - for (int i = 0; i < N; ++i) { + /** + * containsAll(c) is true when c contains a subset of elements + */ + public void testContainsAll() { + LinkedBlockingQueue q = populatedQueue(SIZE); + LinkedBlockingQueue p = new LinkedBlockingQueue(SIZE); + for (int i = 0; i < SIZE; ++i) { assertTrue(q.containsAll(p)); assertFalse(p.containsAll(q)); p.add(new Integer(i)); @@ -524,10 +656,13 @@ public class LinkedBlockingQueueTest ext assertTrue(p.containsAll(q)); } - public void testRetainAll(){ - LinkedBlockingQueue q = fullQueue(N); - LinkedBlockingQueue p = fullQueue(N); - for (int i = 0; i < N; ++i) { + /** + * retainAll(c) retains only those elements of c and reports true if changed + */ + public void testRetainAll() { + LinkedBlockingQueue q = populatedQueue(SIZE); + LinkedBlockingQueue p = populatedQueue(SIZE); + for (int i = 0; i < SIZE; ++i) { boolean changed = q.retainAll(p); if (i == 0) assertFalse(changed); @@ -535,17 +670,20 @@ public class LinkedBlockingQueueTest ext assertTrue(changed); assertTrue(q.containsAll(p)); - assertEquals(N-i, q.size()); + assertEquals(SIZE-i, q.size()); p.remove(); } } - public void testRemoveAll(){ - for (int i = 1; i < N; ++i) { - LinkedBlockingQueue q = fullQueue(N); - LinkedBlockingQueue p = fullQueue(i); + /** + * removeAll(c) removes only those elements of c and reports true if changed + */ + public void testRemoveAll() { + for (int i = 1; i < SIZE; ++i) { + LinkedBlockingQueue q = populatedQueue(SIZE); + LinkedBlockingQueue p = populatedQueue(i); assertTrue(q.removeAll(p)); - assertEquals(N-i, q.size()); + assertEquals(SIZE-i, q.size()); for (int j = 0; j < i; ++j) { Integer I = (Integer)(p.remove()); assertFalse(q.contains(I)); @@ -553,69 +691,118 @@ public class LinkedBlockingQueueTest ext } } - - public void testToArray(){ - LinkedBlockingQueue q = fullQueue(N); + /** + * toArray contains all elements + */ + public void testToArray() { + LinkedBlockingQueue q = populatedQueue(SIZE); Object[] o = q.toArray(); try { for(int i = 0; i < o.length; i++) assertEquals(o[i], q.take()); } catch (InterruptedException e){ - fail("Unexpected exception"); + unexpectedException(); } } - public void testToArray2(){ - LinkedBlockingQueue q = fullQueue(N); - Integer[] ints = new Integer[N]; + /** + * toArray(a) contains all elements + */ + public void testToArray2() { + LinkedBlockingQueue q = populatedQueue(SIZE); + Integer[] ints = new Integer[SIZE]; ints = (Integer[])q.toArray(ints); try { 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 { + LinkedBlockingQueue q = populatedQueue(SIZE); + Object o[] = q.toArray(null); + shouldThrow(); + } catch(NullPointerException success){} + } + + /** + * toArray with incompatible array type throws CCE + */ + public void testToArray1_BadArg() { + try { + LinkedBlockingQueue q = populatedQueue(SIZE); + Object o[] = q.toArray(new String[10] ); + shouldThrow(); + } catch(ArrayStoreException success){} + } + - public void testIterator(){ - LinkedBlockingQueue q = fullQueue(N); + /** + * iterator iterates through all elements + */ + public void testIterator() { + LinkedBlockingQueue q = populatedQueue(SIZE); Iterator it = q.iterator(); try { while(it.hasNext()){ assertEquals(it.next(), q.take()); } } catch (InterruptedException e){ - fail("Unexpected exception"); + unexpectedException(); } } - public void testIteratorOrdering() { - + /** + * iterator.remove removes current element + */ + public void testIteratorRemove () { final LinkedBlockingQueue q = new LinkedBlockingQueue(3); + q.add(two); + q.add(one); + q.add(three); + + Iterator it = q.iterator(); + it.next(); + it.remove(); + + it = q.iterator(); + assertEquals(it.next(), one); + assertEquals(it.next(), three); + assertFalse(it.hasNext()); + } - q.add(new Integer(1)); - q.add(new Integer(2)); - q.add(new Integer(3)); - - assertEquals("queue should be full", 0, q.remainingCapacity()); + /** + * iterator ordering is FIFO + */ + public void testIteratorOrdering() { + final LinkedBlockingQueue q = new LinkedBlockingQueue(3); + q.add(one); + q.add(two); + q.add(three); + assertEquals(0, q.remainingCapacity()); int k = 0; for (Iterator it = q.iterator(); it.hasNext();) { int i = ((Integer)(it.next())).intValue(); - assertEquals("items should come out in order", ++k, i); + assertEquals(++k, i); } - - assertEquals("should go through 3 elements", 3, k); + assertEquals(3, k); } + /** + * Modifications do not cause iterators to fail + */ public void testWeaklyConsistentIteration () { - final LinkedBlockingQueue q = new LinkedBlockingQueue(3); - - q.add(new Integer(1)); - q.add(new Integer(2)); - q.add(new Integer(3)); - + q.add(one); + q.add(two); + q.add(three); try { for (Iterator it = q.iterator(); it.hasNext();) { q.remove(); @@ -623,40 +810,41 @@ public class LinkedBlockingQueueTest ext } } catch (ConcurrentModificationException e) { - fail("weakly consistent iterator; should not get CME"); + unexpectedException(); } - - assertEquals("queue should be empty again", 0, q.size()); + assertEquals(0, q.size()); } - public void testToString(){ - LinkedBlockingQueue q = fullQueue(N); + /** + * toString contains toStrings of elements + */ + public void testToString() { + LinkedBlockingQueue q = populatedQueue(SIZE); String s = q.toString(); - for (int i = 0; i < N; ++i) { + for (int i = 0; i < SIZE; ++i) { assertTrue(s.indexOf(String.valueOf(i)) >= 0); } } + /** + * offer transfers elements across Executor tasks + */ public void testOfferInExecutor() { - final LinkedBlockingQueue q = new LinkedBlockingQueue(2); - - q.add(new Integer(1)); - q.add(new Integer(2)); - + q.add(one); + q.add(two); ExecutorService executor = Executors.newFixedThreadPool(2); - executor.execute(new Runnable() { public void run() { - assertFalse("offer should be rejected", q.offer(new Integer(3))); + threadAssertFalse(q.offer(three)); try { - assertTrue("offer should be accepted", q.offer(new Integer(3), MEDIUM_DELAY_MS * 2, TimeUnit.MILLISECONDS)); - assertEquals(0, q.remainingCapacity()); + threadAssertTrue(q.offer(three, MEDIUM_DELAY_MS, TimeUnit.MILLISECONDS)); + threadAssertEquals(0, q.remainingCapacity()); } catch (InterruptedException e) { - fail("should not be interrupted"); + threadUnexpectedException(); } } }); @@ -664,34 +852,33 @@ public class LinkedBlockingQueueTest ext executor.execute(new Runnable() { public void run() { try { - Thread.sleep(MEDIUM_DELAY_MS); - assertEquals("first item in queue should be 1", new Integer(1), q.take()); + Thread.sleep(SMALL_DELAY_MS); + threadAssertEquals(one, q.take()); } catch (InterruptedException e) { - fail("should not be interrupted"); + threadUnexpectedException(); } } }); - executor.shutdown(); - + joinPool(executor); } + /** + * poll retrieves elements across Executor threads + */ public void testPollInExecutor() { - final LinkedBlockingQueue q = new LinkedBlockingQueue(2); - ExecutorService executor = Executors.newFixedThreadPool(2); - executor.execute(new Runnable() { public void run() { - assertNull("poll should fail", q.poll()); + threadAssertNull(q.poll()); try { - assertTrue(null != q.poll(MEDIUM_DELAY_MS * 2, TimeUnit.MILLISECONDS)); - assertTrue(q.isEmpty()); + threadAssertTrue(null != q.poll(MEDIUM_DELAY_MS, TimeUnit.MILLISECONDS)); + threadAssertTrue(q.isEmpty()); } catch (InterruptedException e) { - fail("should not be interrupted"); + threadUnexpectedException(); } } }); @@ -699,21 +886,23 @@ public class LinkedBlockingQueueTest ext executor.execute(new Runnable() { public void run() { try { - Thread.sleep(MEDIUM_DELAY_MS); - q.put(new Integer(1)); + Thread.sleep(SMALL_DELAY_MS); + q.put(one); } catch (InterruptedException e) { - fail("should not be interrupted"); + threadUnexpectedException(); } } }); - executor.shutdown(); - + joinPool(executor); } + /** + * A deserialized serialized queue has same elements in same order + */ public void testSerialization() { - LinkedBlockingQueue q = fullQueue(N); + LinkedBlockingQueue q = populatedQueue(SIZE); try { ByteArrayOutputStream bout = new ByteArrayOutputStream(10000); @@ -728,8 +917,112 @@ public class LinkedBlockingQueueTest ext while (!q.isEmpty()) assertEquals(q.remove(), r.remove()); } catch(Exception e){ - e.printStackTrace(); - fail("unexpected exception"); + unexpectedException(); + } + } + + /** + * drainTo(null) throws NPE + */ + public void testDrainToNull() { + LinkedBlockingQueue q = populatedQueue(SIZE); + try { + q.drainTo(null); + shouldThrow(); + } catch(NullPointerException success) { + } + } + + /** + * drainTo(this) throws IAE + */ + public void testDrainToSelf() { + LinkedBlockingQueue q = populatedQueue(SIZE); + try { + q.drainTo(q); + shouldThrow(); + } catch(IllegalArgumentException success) { + } + } + + /** + * drainTo(c) empties queue into another collection c + */ + public void testDrainTo() { + LinkedBlockingQueue 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 full queue, unblocking a waiting put. + */ + public void testDrainToWithActivePut() { + final LinkedBlockingQueue q = populatedQueue(SIZE); + Thread t = new Thread(new Runnable() { + public void run() { + try { + q.put(new Integer(SIZE+1)); + } catch (InterruptedException ie){ + threadUnexpectedException(); + } + } + }); + 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() { + LinkedBlockingQueue q = populatedQueue(SIZE); + try { + q.drainTo(null, 0); + shouldThrow(); + } catch(NullPointerException success) { + } + } + + /** + * drainTo(this, n) throws IAE + */ + public void testDrainToSelfN() { + LinkedBlockingQueue 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) { + LinkedBlockingQueue 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) + assertEquals(l.get(j), new Integer(j)); } }