--- jsr166/src/test/tck/LinkedBlockingQueueTest.java 2003/09/14 20:42:40 1.3 +++ jsr166/src/test/tck/LinkedBlockingQueueTest.java 2009/11/21 02:07:26 1.15 @@ -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.*; @@ -13,11 +14,11 @@ import java.io.*; public class LinkedBlockingQueueTest 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(LinkedBlockingQueueTest.class); + return new TestSuite(LinkedBlockingQueueTest.class); } @@ -28,56 +29,75 @@ public class LinkedBlockingQueueTest ext private LinkedBlockingQueue populatedQueue(int n) { LinkedBlockingQueue q = new LinkedBlockingQueue(n); assertTrue(q.isEmpty()); - for(int i = 0; i < n; i++) - assertTrue(q.offer(new Integer(i))); + for (int i = 0; i < n; i++) + assertTrue(q.offer(new Integer(i))); assertFalse(q.isEmpty()); assertEquals(0, q.remainingCapacity()); - assertEquals(n, q.size()); + assertEquals(n, q.size()); return q; } - - public void testConstructor1(){ + + /** + * 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[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[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[SIZE]; for (int i = 0; i < SIZE; ++i) @@ -89,6 +109,9 @@ public class LinkedBlockingQueueTest ext finally {} } + /** + * Queue transitions from empty to full when elements added + */ public void testEmptyFull() { LinkedBlockingQueue q = new LinkedBlockingQueue(2); assertTrue(q.isEmpty()); @@ -97,11 +120,14 @@ public class LinkedBlockingQueueTest ext assertFalse(q.isEmpty()); q.add(two); assertFalse(q.isEmpty()); - assertEquals("queue should be full", 0, q.remainingCapacity()); - assertFalse("offer should be rejected", q.offer(three)); + assertEquals(0, q.remainingCapacity()); + assertFalse(q.offer(three)); } - public void testRemainingCapacity(){ + /** + * 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()); @@ -115,72 +141,121 @@ public class LinkedBlockingQueueTest ext } } - public void testOfferNull(){ - try { + /** + * offer(null) throws NPE + */ + public void testOfferNull() { + try { LinkedBlockingQueue q = new LinkedBlockingQueue(1); q.offer(null); - fail("should throw NPE"); - } catch (NullPointerException success) { } + 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(zero)); assertFalse(q.offer(one)); } - public void testAdd(){ - try { + /** + * add succeeds if not full; throws ISE if full + */ + public void testAdd() { + try { 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(SIZE)); - } catch (IllegalStateException success){ - } + } 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 = 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(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[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[SIZE]; @@ -195,19 +270,25 @@ public class LinkedBlockingQueueTest ext finally {} } + /** + * put(null) throws NPE + */ public void testPutNull() { - try { + try { LinkedBlockingQueue q = new LinkedBlockingQueue(SIZE); q.put(null); - fail("put should throw NPE"); - } - catch (NullPointerException success){ - } + 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(SIZE); @@ -219,11 +300,14 @@ 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; @@ -234,26 +318,29 @@ public class LinkedBlockingQueueTest ext ++added; } q.put(new Integer(SIZE)); - threadFail("put should block"); - } catch (InterruptedException ie){ + threadShouldThrow(); + } catch (InterruptedException ie) { threadAssertEquals(added, SIZE); - } + } }}); t.start(); - try { - Thread.sleep(SHORT_DELAY_MS); + try { + Thread.sleep(SHORT_DELAY_MS); t.interrupt(); 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()); @@ -264,8 +351,8 @@ public class LinkedBlockingQueueTest ext ++added; q.put(new Object()); ++added; - threadFail("Should block"); - } catch (InterruptedException e){ + threadShouldThrow(); + } catch (InterruptedException e) { threadAssertTrue(added >= 2); } } @@ -276,54 +363,63 @@ public class LinkedBlockingQueueTest ext q.take(); t.interrupt(); t.join(); - } catch (Exception e){ - fail("Unexpected exception"); + } catch (Exception e) { + 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()); threadAssertFalse(q.offer(new Object(), SHORT_DELAY_MS, TimeUnit.MILLISECONDS)); q.offer(new Object(), LONG_DELAY_MS, TimeUnit.MILLISECONDS); - threadFail("Should block"); - } catch (InterruptedException success){} + threadShouldThrow(); + } catch (InterruptedException success) {} } }); - + try { t.start(); Thread.sleep(SMALL_DELAY_MS); t.interrupt(); t.join(); - } catch (Exception e){ - fail("Unexpected exception"); + } catch (Exception e) { + unexpectedException(); } } - public void testTake(){ - try { + /** + * take retrieves elements in FIFO order + */ + public void testTake() { + try { LinkedBlockingQueue q = populatedQueue(SIZE); for (int i = 0; i < SIZE; ++i) { assertEquals(i, ((Integer)q.take()).intValue()); } - } catch (InterruptedException e){ - fail("Unexpected exception"); - } + } catch (InterruptedException e) { + 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(); - threadFail("Should block"); - } catch (InterruptedException success){ } + threadShouldThrow(); + } catch (InterruptedException success) { } } }); try { @@ -331,12 +427,15 @@ public class LinkedBlockingQueueTest ext Thread.sleep(SHORT_DELAY_MS); t.interrupt(); t.join(); - } catch (Exception e){ - fail("Unexpected exception"); + } catch (Exception e) { + 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 { @@ -345,30 +444,36 @@ public class LinkedBlockingQueueTest ext assertEquals(i, ((Integer)q.take()).intValue()); } q.take(); - threadFail("take should block"); - } catch (InterruptedException success){ - } + threadShouldThrow(); + } catch (InterruptedException success) { + } }}); t.start(); - try { - Thread.sleep(SHORT_DELAY_MS); + try { + Thread.sleep(SHORT_DELAY_MS); t.interrupt(); t.join(); } catch (InterruptedException ie) { - fail("Unexpected exception"); + unexpectedException(); } } - public void testPoll(){ + /** + * 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()); + assertNull(q.poll()); } + /** + * timed pool with zero timeout succeeds when non-empty, else times out + */ public void testTimedPoll0() { try { LinkedBlockingQueue q = populatedQueue(SIZE); @@ -376,11 +481,14 @@ public class LinkedBlockingQueueTest ext assertEquals(i, ((Integer)q.poll(0, TimeUnit.MILLISECONDS)).intValue()); } assertNull(q.poll(0, TimeUnit.MILLISECONDS)); - } catch (InterruptedException e){ - fail("Unexpected exception"); - } + } catch (InterruptedException e) { + unexpectedException(); + } } + /** + * timed pool with nonzero timeout succeeds when non-empty, else times out + */ public void testTimedPoll() { try { LinkedBlockingQueue q = populatedQueue(SIZE); @@ -388,12 +496,16 @@ public class LinkedBlockingQueueTest ext 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"); - } + } catch (InterruptedException e) { + 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 { @@ -402,30 +514,34 @@ public class LinkedBlockingQueueTest ext threadAssertEquals(i, ((Integer)q.poll(SHORT_DELAY_MS, TimeUnit.MILLISECONDS)).intValue()); } threadAssertNull(q.poll(SHORT_DELAY_MS, TimeUnit.MILLISECONDS)); - } catch (InterruptedException success){ - } + } catch (InterruptedException success) { + } }}); t.start(); - try { - Thread.sleep(SHORT_DELAY_MS); + try { + Thread.sleep(SHORT_DELAY_MS); t.interrupt(); 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 { 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"); - } catch (InterruptedException success) { } + threadShouldThrow(); + } catch (InterruptedException success) { } } }); try { @@ -434,13 +550,15 @@ public class LinkedBlockingQueueTest ext assertTrue(q.offer(zero, SHORT_DELAY_MS, TimeUnit.MILLISECONDS)); t.interrupt(); t.join(); - } catch (Exception e){ - fail("Unexpected exception"); + } catch (Exception e) { + unexpectedException(); } - } - + } - public void testPeek(){ + /** + * 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()); @@ -448,10 +566,13 @@ public class LinkedBlockingQueueTest ext 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() { LinkedBlockingQueue q = populatedQueue(SIZE); for (int i = 0; i < SIZE; ++i) { assertEquals(i, ((Integer)q.element()).intValue()); @@ -459,24 +580,30 @@ public class LinkedBlockingQueueTest ext } 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() { LinkedBlockingQueue 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() { LinkedBlockingQueue q = populatedQueue(SIZE); for (int i = 1; i < SIZE; i+=2) { assertTrue(q.remove(new Integer(i))); @@ -487,8 +614,28 @@ public class LinkedBlockingQueueTest ext } assertTrue(q.isEmpty()); } - - public void testContains(){ + + /** + * An add following remove(x) succeeds + */ + public void testRemoveElementAndAdd() { + try { + LinkedBlockingQueue q = new LinkedBlockingQueue(); + assertTrue(q.add(new Integer(1))); + assertTrue(q.add(new Integer(2))); + assertTrue(q.remove(new Integer(1))); + assertTrue(q.remove(new Integer(2))); + assertTrue(q.add(new Integer(3))); + assertTrue(q.take() != null); + } catch (Exception e) { + unexpectedException(); + } + } + + /** + * 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))); @@ -497,7 +644,10 @@ public class LinkedBlockingQueueTest ext } } - public void testClear(){ + /** + * clear removes all elements + */ + public void testClear() { LinkedBlockingQueue q = populatedQueue(SIZE); q.clear(); assertTrue(q.isEmpty()); @@ -505,11 +655,15 @@ public class LinkedBlockingQueueTest ext assertEquals(SIZE, q.remainingCapacity()); q.add(one); assertFalse(q.isEmpty()); + assertTrue(q.contains(one)); q.clear(); assertTrue(q.isEmpty()); } - public void testContainsAll(){ + /** + * 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) { @@ -520,7 +674,10 @@ public class LinkedBlockingQueueTest ext assertTrue(p.containsAll(q)); } - public void testRetainAll(){ + /** + * 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) { @@ -536,7 +693,10 @@ public class LinkedBlockingQueueTest ext } } - 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) { LinkedBlockingQueue q = populatedQueue(SIZE); LinkedBlockingQueue p = populatedQueue(i); @@ -549,69 +709,118 @@ public class LinkedBlockingQueueTest ext } } + /** + * 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) { + unexpectedException(); + } + } - public void testToArray(){ + /** + * toArray(a) contains all elements + */ + public void testToArray2() { 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"); - } - } - - 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"); - } - } - - 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"); - } + 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) { + unexpectedException(); + } } - public void testIteratorOrdering() { + /** + * toArray(null) throws NPE + */ + public void testToArray_BadArg() { + try { + LinkedBlockingQueue q = populatedQueue(SIZE); + Object o[] = q.toArray(null); + shouldThrow(); + } catch (NullPointerException success) {} + } - final LinkedBlockingQueue q = new LinkedBlockingQueue(3); + /** + * 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) {} + } - q.add(one); + + /** + * 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) { + unexpectedException(); + } + } + + /** + * iterator.remove removes current element + */ + public void testIteratorRemove () { + final LinkedBlockingQueue q = new LinkedBlockingQueue(3); q.add(two); + q.add(one); q.add(three); - assertEquals("queue should be full", 0, q.remainingCapacity()); + Iterator it = q.iterator(); + it.next(); + it.remove(); + + it = q.iterator(); + assertEquals(it.next(), one); + assertEquals(it.next(), three); + assertFalse(it.hasNext()); + } + + /** + * 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(one); q.add(two); q.add(three); - try { for (Iterator it = q.iterator(); it.hasNext();) { q.remove(); @@ -619,31 +828,32 @@ 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(){ + /** + * toString contains toStrings of elements + */ + public void testToString() { LinkedBlockingQueue q = populatedQueue(SIZE); String s = q.toString(); 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(one); q.add(two); - ExecutorService executor = Executors.newFixedThreadPool(2); - executor.execute(new Runnable() { public void run() { threadAssertFalse(q.offer(three)); @@ -652,7 +862,7 @@ public class LinkedBlockingQueueTest ext threadAssertEquals(0, q.remainingCapacity()); } catch (InterruptedException e) { - threadFail("should not be interrupted"); + threadUnexpectedException(); } } }); @@ -664,21 +874,20 @@ public class LinkedBlockingQueueTest ext threadAssertEquals(one, q.take()); } catch (InterruptedException e) { - threadFail("should not be interrupted"); + threadUnexpectedException(); } } }); - - joinPool(executor); + 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() { threadAssertNull(q.poll()); @@ -687,7 +896,7 @@ public class LinkedBlockingQueueTest ext threadAssertTrue(q.isEmpty()); } catch (InterruptedException e) { - threadFail("should not be interrupted"); + threadUnexpectedException(); } } }); @@ -699,14 +908,17 @@ public class LinkedBlockingQueueTest ext q.put(one); } catch (InterruptedException e) { - threadFail("should not be interrupted"); + threadUnexpectedException(); } } }); - + joinPool(executor); } + /** + * A deserialized serialized queue has same elements in same order + */ public void testSerialization() { LinkedBlockingQueue q = populatedQueue(SIZE); @@ -720,11 +932,129 @@ public class LinkedBlockingQueueTest ext ObjectInputStream in = new ObjectInputStream(new BufferedInputStream(bin)); LinkedBlockingQueue r = (LinkedBlockingQueue)in.readObject(); assertEquals(q.size(), r.size()); - while (!q.isEmpty()) + while (!q.isEmpty()) assertEquals(q.remove(), r.remove()); - } catch(Exception e){ - e.printStackTrace(); - fail("unexpected exception"); + } catch (Exception e) { + 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)); + q.add(zero); + q.add(one); + assertFalse(q.isEmpty()); + assertTrue(q.contains(zero)); + assertTrue(q.contains(one)); + l.clear(); + q.drainTo(l); + assertEquals(q.size(), 0); + assertEquals(l.size(), 2); + for (int i = 0; i < 2; ++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); + } 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() { + LinkedBlockingQueue q = new LinkedBlockingQueue(); + for (int i = 0; i < SIZE + 2; ++i) { + for (int j = 0; j < SIZE; j++) + assertTrue(q.offer(new Integer(j))); + ArrayList l = new ArrayList(); + q.drainTo(l, i); + int k = (i < SIZE)? i : SIZE; + assertEquals(l.size(), k); + assertEquals(q.size(), SIZE-k); + for (int j = 0; j < k; ++j) + assertEquals(l.get(j), new Integer(j)); + while (q.poll() != null) ; } }