--- jsr166/src/test/tck/ArrayBlockingQueueTest.java 2011/05/31 16:16:23 1.49 +++ jsr166/src/test/tck/ArrayBlockingQueueTest.java 2021/01/27 01:57:24 1.99 @@ -6,10 +6,12 @@ * Pat Fisher, Mike Judd. */ -import junit.framework.*; -import java.util.Arrays; +import static java.util.concurrent.TimeUnit.MILLISECONDS; + import java.util.ArrayList; +import java.util.Arrays; import java.util.Collection; +import java.util.Collections; import java.util.Iterator; import java.util.NoSuchElementException; import java.util.Queue; @@ -18,44 +20,78 @@ import java.util.concurrent.BlockingQueu import java.util.concurrent.CountDownLatch; import java.util.concurrent.Executors; import java.util.concurrent.ExecutorService; -import static java.util.concurrent.TimeUnit.MILLISECONDS; +import java.util.concurrent.ThreadLocalRandom; + +import junit.framework.Test; public class ArrayBlockingQueueTest extends JSR166TestCase { - public static class Fair extends BlockingQueueTest { - protected BlockingQueue emptyCollection() { - return new ArrayBlockingQueue(20, true); + public static void main(String[] args) { + main(suite(), args); + } + + public static Test suite() { + class Implementation implements CollectionImplementation { + public Class klazz() { return ArrayBlockingQueue.class; } + public Collection emptyCollection() { + boolean fair = randomBoolean(); + return populatedQueue(0, SIZE, 2 * SIZE, fair); + } + public Object makeElement(int i) { return JSR166TestCase.itemFor(i); } + public boolean isConcurrent() { return true; } + public boolean permitsNulls() { return false; } } + + return newTestSuite( + ArrayBlockingQueueTest.class, + new Fair().testSuite(), + new NonFair().testSuite(), + CollectionTest.testSuite(new Implementation())); } - public static class NonFair extends BlockingQueueTest { - protected BlockingQueue emptyCollection() { - return new ArrayBlockingQueue(20, false); + public static class Fair extends BlockingQueueTest { + protected BlockingQueue emptyCollection() { + return populatedQueue(0, SIZE, 2 * SIZE, true); } } - public static void main(String[] args) { - junit.textui.TestRunner.run(suite()); + public static class NonFair extends BlockingQueueTest { + protected BlockingQueue emptyCollection() { + return populatedQueue(0, SIZE, 2 * SIZE, false); + } } - public static Test suite() { - return newTestSuite(ArrayBlockingQueueTest.class, - new Fair().testSuite(), - new NonFair().testSuite()); + /** + * Returns a new queue of given size containing consecutive + * Items 0 ... n - 1. + */ + static ArrayBlockingQueue populatedQueue(int n) { + return populatedQueue(n, n, n, false); } /** - * Create a queue of given size containing consecutive - * Integers 0 ... n. + * Returns a new queue of given size containing consecutive + * Items 0 ... n - 1, with given capacity range and fairness. */ - private ArrayBlockingQueue populatedQueue(int n) { - ArrayBlockingQueue q = new ArrayBlockingQueue(n); + static ArrayBlockingQueue populatedQueue( + int size, int minCapacity, int maxCapacity, boolean fair) { + ThreadLocalRandom rnd = ThreadLocalRandom.current(); + int capacity = rnd.nextInt(minCapacity, maxCapacity + 1); + ArrayBlockingQueue q = new ArrayBlockingQueue<>(capacity); assertTrue(q.isEmpty()); - for (int i = 0; i < n; i++) - assertTrue(q.offer(new Integer(i))); - assertFalse(q.isEmpty()); - assertEquals(0, q.remainingCapacity()); - assertEquals(n, q.size()); + // shuffle circular array elements so they wrap + { + int n = rnd.nextInt(capacity); + for (int i = 0; i < n; i++) q.add(fortytwo); + for (int i = 0; i < n; i++) q.remove(); + } + for (int i = 0; i < size; i++) + mustOffer(q, i); + mustEqual(size == 0, q.isEmpty()); + mustEqual(capacity - size, q.remainingCapacity()); + mustEqual(size, q.size()); + if (size > 0) + mustEqual(0, q.peek()); return q; } @@ -63,25 +99,33 @@ public class ArrayBlockingQueueTest exte * A new queue has the indicated capacity */ public void testConstructor1() { - assertEquals(SIZE, new ArrayBlockingQueue(SIZE).remainingCapacity()); + mustEqual(SIZE, new ArrayBlockingQueue(SIZE).remainingCapacity()); } /** - * Constructor throws IAE if capacity argument nonpositive + * Constructor throws IllegalArgumentException if capacity argument nonpositive */ - public void testConstructor2() { - try { - new ArrayBlockingQueue(0); - shouldThrow(); - } catch (IllegalArgumentException success) {} + public void testConstructor_nonPositiveCapacity() { + for (int i : new int[] { 0, -1, Integer.MIN_VALUE }) { + try { + new ArrayBlockingQueue(i); + shouldThrow(); + } catch (IllegalArgumentException success) {} + for (boolean fair : new boolean[] { true, false }) { + try { + new ArrayBlockingQueue(i, fair); + shouldThrow(); + } catch (IllegalArgumentException success) {} + } + } } /** * Initializing from null Collection throws NPE */ - public void testConstructor3() { + public void testConstructor_nullCollection() { try { - new ArrayBlockingQueue(1, true, null); + new ArrayBlockingQueue(1, true, null); shouldThrow(); } catch (NullPointerException success) {} } @@ -90,9 +134,9 @@ public class ArrayBlockingQueueTest exte * Initializing from Collection of null elements throws NPE */ public void testConstructor4() { - Collection elements = Arrays.asList(new Integer[SIZE]); + Collection elements = Arrays.asList(new Item[SIZE]); try { - new ArrayBlockingQueue(SIZE, false, elements); + new ArrayBlockingQueue(SIZE, false, elements); shouldThrow(); } catch (NullPointerException success) {} } @@ -101,26 +145,24 @@ public class ArrayBlockingQueueTest exte * Initializing from Collection with some null elements throws NPE */ public void testConstructor5() { - Integer[] ints = new Integer[SIZE]; - for (int i = 0; i < SIZE-1; ++i) - ints[i] = i; - Collection elements = Arrays.asList(ints); + Item[] items = new Item[2]; items[0] = zero; + Collection elements = Arrays.asList(items); try { - new ArrayBlockingQueue(SIZE, false, Arrays.asList(ints)); + new ArrayBlockingQueue(SIZE, false, elements); shouldThrow(); } catch (NullPointerException success) {} } /** - * Initializing from too large collection throws IAE + * Initializing from too large collection throws IllegalArgumentException */ - public void testConstructor6() { - Integer[] ints = new Integer[SIZE]; - for (int i = 0; i < SIZE; ++i) - ints[i] = i; - Collection elements = Arrays.asList(ints); + public void testConstructor_collectionTooLarge() { + // just barely fits - succeeds + new ArrayBlockingQueue(SIZE, false, + Collections.nCopies(SIZE, "")); try { - new ArrayBlockingQueue(SIZE - 1, false, elements); + new ArrayBlockingQueue(SIZE - 1, false, + Collections.nCopies(SIZE, "")); shouldThrow(); } catch (IllegalArgumentException success) {} } @@ -129,27 +171,25 @@ public class ArrayBlockingQueueTest exte * Queue contains all elements of collection used to initialize */ public void testConstructor7() { - Integer[] ints = new Integer[SIZE]; + Item[] items = defaultItems; + Collection elements = Arrays.asList(items); + ArrayBlockingQueue q = new ArrayBlockingQueue<>(SIZE, true, elements); for (int i = 0; i < SIZE; ++i) - ints[i] = i; - Collection elements = Arrays.asList(ints); - ArrayBlockingQueue q = new ArrayBlockingQueue(SIZE, true, elements); - for (int i = 0; i < SIZE; ++i) - assertEquals(ints[i], q.poll()); + mustEqual(items[i], q.poll()); } /** * Queue transitions from empty to full when elements added */ public void testEmptyFull() { - ArrayBlockingQueue q = new ArrayBlockingQueue(2); + BlockingQueue q = populatedQueue(0, 2, 2, false); assertTrue(q.isEmpty()); - assertEquals(2, q.remainingCapacity()); + mustEqual(2, q.remainingCapacity()); q.add(one); assertFalse(q.isEmpty()); - q.add(two); + assertTrue(q.offer(two)); assertFalse(q.isEmpty()); - assertEquals(0, q.remainingCapacity()); + mustEqual(0, q.remainingCapacity()); assertFalse(q.offer(three)); } @@ -157,16 +197,19 @@ public class ArrayBlockingQueueTest exte * remainingCapacity decreases on add, increases on remove */ public void testRemainingCapacity() { - ArrayBlockingQueue q = populatedQueue(SIZE); - for (int i = 0; i < SIZE; ++i) { - assertEquals(i, q.remainingCapacity()); - assertEquals(SIZE-i, q.size()); - q.remove(); - } - for (int i = 0; i < SIZE; ++i) { - assertEquals(SIZE-i, q.remainingCapacity()); - assertEquals(i, q.size()); - q.add(new Integer(i)); + int size = ThreadLocalRandom.current().nextInt(1, SIZE); + BlockingQueue q = populatedQueue(size, size, 2 * size, false); + int spare = q.remainingCapacity(); + int capacity = spare + size; + for (int i = 0; i < size; i++) { + mustEqual(spare + i, q.remainingCapacity()); + mustEqual(capacity, q.size() + q.remainingCapacity()); + mustEqual(i, q.remove()); + } + for (int i = 0; i < size; i++) { + mustEqual(capacity - i, q.remainingCapacity()); + mustEqual(capacity, q.size() + q.remainingCapacity()); + mustAdd(q, i); } } @@ -174,32 +217,30 @@ public class ArrayBlockingQueueTest exte * Offer succeeds if not full; fails if full */ public void testOffer() { - ArrayBlockingQueue q = new ArrayBlockingQueue(1); + ArrayBlockingQueue q = new ArrayBlockingQueue<>(1); assertTrue(q.offer(zero)); assertFalse(q.offer(one)); } /** - * add succeeds if not full; throws ISE if full + * add succeeds if not full; throws IllegalStateException if full */ public void testAdd() { + ArrayBlockingQueue q = new ArrayBlockingQueue<>(SIZE); + for (int i = 0; i < SIZE; i++) assertTrue(q.add(itemFor(i))); + mustEqual(0, q.remainingCapacity()); try { - ArrayBlockingQueue q = new ArrayBlockingQueue(SIZE); - for (int i = 0; i < SIZE; ++i) { - assertTrue(q.add(new Integer(i))); - } - assertEquals(0, q.remainingCapacity()); - q.add(new Integer(SIZE)); + q.add(itemFor(SIZE)); shouldThrow(); } catch (IllegalStateException success) {} } /** - * addAll(this) throws IAE + * addAll(this) throws IllegalArgumentException */ public void testAddAllSelf() { + ArrayBlockingQueue q = populatedQueue(SIZE); try { - ArrayBlockingQueue q = populatedQueue(SIZE); q.addAll(q); shouldThrow(); } catch (IllegalArgumentException success) {} @@ -210,26 +251,28 @@ public class ArrayBlockingQueueTest exte * possibly adding some elements */ public void testAddAll3() { + ArrayBlockingQueue q = new ArrayBlockingQueue<>(SIZE); + Item[] items = new Item[2]; items[0] = zero; try { - ArrayBlockingQueue q = new ArrayBlockingQueue(SIZE); - Integer[] ints = new Integer[SIZE]; - for (int i = 0; i < SIZE-1; ++i) - ints[i] = new Integer(i); - q.addAll(Arrays.asList(ints)); + q.addAll(Arrays.asList(items)); shouldThrow(); } catch (NullPointerException success) {} } /** - * addAll throws ISE if not enough room + * addAll throws IllegalStateException if not enough room */ - public void testAddAll4() { + public void testAddAll_insufficientSpace() { + int size = ThreadLocalRandom.current().nextInt(1, SIZE); + ArrayBlockingQueue q = populatedQueue(0, size, size, false); + // Just fits: + q.addAll(populatedQueue(size, size, 2 * size, false)); + mustEqual(0, q.remainingCapacity()); + mustEqual(size, q.size()); + mustEqual(0, q.peek()); try { - ArrayBlockingQueue q = new ArrayBlockingQueue(1); - Integer[] ints = new Integer[SIZE]; - for (int i = 0; i < SIZE; ++i) - ints[i] = new Integer(i); - q.addAll(Arrays.asList(ints)); + q = populatedQueue(0, size, size, false); + q.addAll(Collections.nCopies(size + 1, fortytwo)); shouldThrow(); } catch (IllegalStateException success) {} } @@ -238,64 +281,62 @@ public class ArrayBlockingQueueTest exte * Queue contains all elements, in traversal order, of successful addAll */ public void testAddAll5() { - Integer[] empty = new Integer[0]; - Integer[] ints = new Integer[SIZE]; - for (int i = 0; i < SIZE; ++i) - ints[i] = new Integer(i); - ArrayBlockingQueue q = new ArrayBlockingQueue(SIZE); + Item[] empty = new Item[0]; + Item[] items = defaultItems; + ArrayBlockingQueue q = new ArrayBlockingQueue<>(SIZE); assertFalse(q.addAll(Arrays.asList(empty))); - assertTrue(q.addAll(Arrays.asList(ints))); + assertTrue(q.addAll(Arrays.asList(items))); for (int i = 0; i < SIZE; ++i) - assertEquals(ints[i], q.poll()); + mustEqual(items[i], q.poll()); } /** * all elements successfully put are contained */ public void testPut() throws InterruptedException { - ArrayBlockingQueue q = new ArrayBlockingQueue(SIZE); + ArrayBlockingQueue q = new ArrayBlockingQueue<>(SIZE); for (int i = 0; i < SIZE; ++i) { - Integer I = new Integer(i); - q.put(I); - assertTrue(q.contains(I)); + Item x = itemFor(i); + q.put(x); + mustContain(q, x); } - assertEquals(0, q.remainingCapacity()); + mustEqual(0, q.remainingCapacity()); } /** * put blocks interruptibly if full */ public void testBlockingPut() throws InterruptedException { - final ArrayBlockingQueue q = new ArrayBlockingQueue(SIZE); + final ArrayBlockingQueue q = new ArrayBlockingQueue<>(SIZE); final CountDownLatch pleaseInterrupt = new CountDownLatch(1); Thread t = newStartedThread(new CheckedRunnable() { public void realRun() throws InterruptedException { for (int i = 0; i < SIZE; ++i) - q.put(i); - assertEquals(SIZE, q.size()); - assertEquals(0, q.remainingCapacity()); + q.put(itemFor(i)); + mustEqual(SIZE, q.size()); + mustEqual(0, q.remainingCapacity()); Thread.currentThread().interrupt(); try { - q.put(99); + q.put(ninetynine); shouldThrow(); } catch (InterruptedException success) {} assertFalse(Thread.interrupted()); pleaseInterrupt.countDown(); try { - q.put(99); + q.put(ninetynine); shouldThrow(); } catch (InterruptedException success) {} assertFalse(Thread.interrupted()); }}); await(pleaseInterrupt); - assertThreadStaysAlive(t); + if (randomBoolean()) assertThreadBlocks(t, Thread.State.WAITING); t.interrupt(); awaitTermination(t); - assertEquals(SIZE, q.size()); - assertEquals(0, q.remainingCapacity()); + mustEqual(SIZE, q.size()); + mustEqual(0, q.remainingCapacity()); } /** @@ -303,57 +344,73 @@ public class ArrayBlockingQueueTest exte */ public void testPutWithTake() throws InterruptedException { final int capacity = 2; - final ArrayBlockingQueue q = new ArrayBlockingQueue(capacity); + final ArrayBlockingQueue q = new ArrayBlockingQueue<>(capacity); final CountDownLatch pleaseTake = new CountDownLatch(1); final CountDownLatch pleaseInterrupt = new CountDownLatch(1); Thread t = newStartedThread(new CheckedRunnable() { public void realRun() throws InterruptedException { for (int i = 0; i < capacity; i++) - q.put(i); + q.put(itemFor(i)); pleaseTake.countDown(); - q.put(86); + q.put(eightysix); + + Thread.currentThread().interrupt(); + try { + q.put(ninetynine); + shouldThrow(); + } catch (InterruptedException success) {} + assertFalse(Thread.interrupted()); pleaseInterrupt.countDown(); try { - q.put(99); + q.put(ninetynine); shouldThrow(); } catch (InterruptedException success) {} assertFalse(Thread.interrupted()); }}); await(pleaseTake); - assertEquals(q.remainingCapacity(), 0); - assertEquals(0, q.take()); + mustEqual(0, q.remainingCapacity()); + mustEqual(0, q.take()); await(pleaseInterrupt); - assertThreadStaysAlive(t); + if (randomBoolean()) assertThreadBlocks(t, Thread.State.WAITING); t.interrupt(); awaitTermination(t); - assertEquals(q.remainingCapacity(), 0); + mustEqual(0, q.remainingCapacity()); } /** * timed offer times out if full and elements not taken */ - public void testTimedOffer() throws InterruptedException { - final ArrayBlockingQueue q = new ArrayBlockingQueue(2); + public void testTimedOffer() { + final ArrayBlockingQueue q = new ArrayBlockingQueue<>(2); final CountDownLatch pleaseInterrupt = new CountDownLatch(1); Thread t = newStartedThread(new CheckedRunnable() { public void realRun() throws InterruptedException { - q.put(new Object()); - q.put(new Object()); + q.put(one); + q.put(two); long startTime = System.nanoTime(); - assertFalse(q.offer(new Object(), timeoutMillis(), MILLISECONDS)); + assertFalse(q.offer(zero, timeoutMillis(), MILLISECONDS)); assertTrue(millisElapsedSince(startTime) >= timeoutMillis()); + + Thread.currentThread().interrupt(); + try { + q.offer(three, randomTimeout(), randomTimeUnit()); + shouldThrow(); + } catch (InterruptedException success) {} + assertFalse(Thread.interrupted()); + pleaseInterrupt.countDown(); try { - q.offer(new Object(), 2 * LONG_DELAY_MS, MILLISECONDS); + q.offer(four, LONGER_DELAY_MS, MILLISECONDS); shouldThrow(); } catch (InterruptedException success) {} + assertFalse(Thread.interrupted()); }}); await(pleaseInterrupt); - assertThreadStaysAlive(t); + if (randomBoolean()) assertThreadBlocks(t, Thread.State.TIMED_WAITING); t.interrupt(); awaitTermination(t); } @@ -362,9 +419,9 @@ public class ArrayBlockingQueueTest exte * take retrieves elements in FIFO order */ public void testTake() throws InterruptedException { - ArrayBlockingQueue q = populatedQueue(SIZE); + ArrayBlockingQueue q = populatedQueue(SIZE); for (int i = 0; i < SIZE; ++i) { - assertEquals(i, q.take()); + mustEqual(i, q.take()); } } @@ -372,13 +429,11 @@ public class ArrayBlockingQueueTest exte * Take removes existing elements until empty, then blocks interruptibly */ public void testBlockingTake() throws InterruptedException { - final ArrayBlockingQueue q = populatedQueue(SIZE); + final ArrayBlockingQueue q = populatedQueue(SIZE); final CountDownLatch pleaseInterrupt = new CountDownLatch(1); Thread t = newStartedThread(new CheckedRunnable() { public void realRun() throws InterruptedException { - for (int i = 0; i < SIZE; ++i) { - assertEquals(i, q.take()); - } + for (int i = 0; i < SIZE; i++) mustEqual(i, q.take()); Thread.currentThread().interrupt(); try { @@ -396,7 +451,7 @@ public class ArrayBlockingQueueTest exte }}); await(pleaseInterrupt); - assertThreadStaysAlive(t); + if (randomBoolean()) assertThreadBlocks(t, Thread.State.WAITING); t.interrupt(); awaitTermination(t); } @@ -405,9 +460,9 @@ public class ArrayBlockingQueueTest exte * poll succeeds unless empty */ public void testPoll() { - ArrayBlockingQueue q = populatedQueue(SIZE); + ArrayBlockingQueue q = populatedQueue(SIZE); for (int i = 0; i < SIZE; ++i) { - assertEquals(i, q.poll()); + mustEqual(i, q.poll()); } assertNull(q.poll()); } @@ -416,9 +471,9 @@ public class ArrayBlockingQueueTest exte * timed poll with zero timeout succeeds when non-empty, else times out */ public void testTimedPoll0() throws InterruptedException { - ArrayBlockingQueue q = populatedQueue(SIZE); + ArrayBlockingQueue q = populatedQueue(SIZE); for (int i = 0; i < SIZE; ++i) { - assertEquals(i, q.poll(0, MILLISECONDS)); + mustEqual(i, q.poll(0, MILLISECONDS)); } assertNull(q.poll(0, MILLISECONDS)); checkEmpty(q); @@ -428,10 +483,10 @@ public class ArrayBlockingQueueTest exte * timed poll with nonzero timeout succeeds when non-empty, else times out */ public void testTimedPoll() throws InterruptedException { - ArrayBlockingQueue q = populatedQueue(SIZE); + ArrayBlockingQueue q = populatedQueue(SIZE); for (int i = 0; i < SIZE; ++i) { long startTime = System.nanoTime(); - assertEquals(i, q.poll(LONG_DELAY_MS, MILLISECONDS)); + mustEqual(i, q.poll(LONG_DELAY_MS, MILLISECONDS)); assertTrue(millisElapsedSince(startTime) < LONG_DELAY_MS); } long startTime = System.nanoTime(); @@ -445,29 +500,32 @@ public class ArrayBlockingQueueTest exte * returning timeout status */ public void testInterruptedTimedPoll() throws InterruptedException { - final BlockingQueue q = populatedQueue(SIZE); - final CountDownLatch aboutToWait = new CountDownLatch(1); + final BlockingQueue q = populatedQueue(SIZE); + final CountDownLatch pleaseInterrupt = new CountDownLatch(1); Thread t = newStartedThread(new CheckedRunnable() { public void realRun() throws InterruptedException { - for (int i = 0; i < SIZE; ++i) { - long t0 = System.nanoTime(); - assertEquals(i, (int) q.poll(LONG_DELAY_MS, MILLISECONDS)); - assertTrue(millisElapsedSince(t0) < SMALL_DELAY_MS); - } - long t0 = System.nanoTime(); - aboutToWait.countDown(); - try { - q.poll(MEDIUM_DELAY_MS, MILLISECONDS); - shouldThrow(); - } catch (InterruptedException success) { - assertTrue(millisElapsedSince(t0) < MEDIUM_DELAY_MS); - } + for (int i = 0; i < SIZE; i++) + mustEqual(i, q.poll(LONG_DELAY_MS, MILLISECONDS)); + + Thread.currentThread().interrupt(); + try { + q.poll(randomTimeout(), randomTimeUnit()); + shouldThrow(); + } catch (InterruptedException success) {} + assertFalse(Thread.interrupted()); + + pleaseInterrupt.countDown(); + try { + q.poll(LONGER_DELAY_MS, MILLISECONDS); + shouldThrow(); + } catch (InterruptedException success) {} + assertFalse(Thread.interrupted()); }}); - aboutToWait.await(); - waitForThreadToEnterWaitState(t, SMALL_DELAY_MS); + await(pleaseInterrupt); + if (randomBoolean()) assertThreadBlocks(t, Thread.State.TIMED_WAITING); t.interrupt(); - awaitTermination(t, MEDIUM_DELAY_MS); + awaitTermination(t); checkEmpty(q); } @@ -475,10 +533,10 @@ public class ArrayBlockingQueueTest exte * peek returns next element, or null if empty */ public void testPeek() { - ArrayBlockingQueue q = populatedQueue(SIZE); + ArrayBlockingQueue q = populatedQueue(SIZE); for (int i = 0; i < SIZE; ++i) { - assertEquals(i, q.peek()); - assertEquals(i, q.poll()); + mustEqual(i, q.peek()); + mustEqual(i, q.poll()); assertTrue(q.peek() == null || !q.peek().equals(i)); } @@ -489,10 +547,10 @@ public class ArrayBlockingQueueTest exte * element returns next element, or throws NSEE if empty */ public void testElement() { - ArrayBlockingQueue q = populatedQueue(SIZE); + ArrayBlockingQueue q = populatedQueue(SIZE); for (int i = 0; i < SIZE; ++i) { - assertEquals(i, q.element()); - assertEquals(i, q.poll()); + mustEqual(i, q.element()); + mustEqual(i, q.poll()); } try { q.element(); @@ -504,9 +562,9 @@ public class ArrayBlockingQueueTest exte * remove removes next element, or throws NSEE if empty */ public void testRemove() { - ArrayBlockingQueue q = populatedQueue(SIZE); + ArrayBlockingQueue q = populatedQueue(SIZE); for (int i = 0; i < SIZE; ++i) { - assertEquals(i, q.remove()); + mustEqual(i, q.remove()); } try { q.remove(); @@ -515,29 +573,16 @@ public class ArrayBlockingQueueTest exte } /** - * remove(x) removes x and returns true if present - */ - public void testRemoveElement() { - ArrayBlockingQueue q = populatedQueue(SIZE); - for (int i = 1; i < SIZE; i+=2) { - assertTrue(q.remove(new Integer(i))); - } - for (int i = 0; i < SIZE; i+=2) { - assertTrue(q.remove(new Integer(i))); - assertFalse(q.remove(new Integer(i+1))); - } - assertTrue(q.isEmpty()); - } - - /** * contains(x) reports true when elements added but not yet removed */ public void testContains() { - ArrayBlockingQueue q = populatedQueue(SIZE); - for (int i = 0; i < SIZE; ++i) { - assertTrue(q.contains(new Integer(i))); - assertEquals(i, q.poll()); - assertFalse(q.contains(new Integer(i))); + int size = ThreadLocalRandom.current().nextInt(1, SIZE); + ArrayBlockingQueue q = populatedQueue(size, size, 2 * size, false); + assertFalse(q.contains(null)); + for (int i = 0; i < size; ++i) { + mustContain(q, i); + mustEqual(i, q.poll()); + mustNotContain(q, i); } } @@ -545,14 +590,16 @@ public class ArrayBlockingQueueTest exte * clear removes all elements */ public void testClear() { - ArrayBlockingQueue q = populatedQueue(SIZE); + int size = ThreadLocalRandom.current().nextInt(1, 5); + ArrayBlockingQueue q = populatedQueue(size, size, 2 * size, false); + int capacity = size + q.remainingCapacity(); q.clear(); assertTrue(q.isEmpty()); - assertEquals(0, q.size()); - assertEquals(SIZE, q.remainingCapacity()); + mustEqual(0, q.size()); + mustEqual(capacity, q.remainingCapacity()); q.add(one); assertFalse(q.isEmpty()); - assertTrue(q.contains(one)); + mustContain(q, one); q.clear(); assertTrue(q.isEmpty()); } @@ -561,12 +608,12 @@ public class ArrayBlockingQueueTest exte * containsAll(c) is true when c contains a subset of elements */ public void testContainsAll() { - ArrayBlockingQueue q = populatedQueue(SIZE); - ArrayBlockingQueue p = new ArrayBlockingQueue(SIZE); + ArrayBlockingQueue q = populatedQueue(SIZE); + ArrayBlockingQueue p = new ArrayBlockingQueue<>(SIZE); for (int i = 0; i < SIZE; ++i) { assertTrue(q.containsAll(p)); assertFalse(p.containsAll(q)); - p.add(new Integer(i)); + mustAdd(p, i); } assertTrue(p.containsAll(q)); } @@ -575,8 +622,8 @@ public class ArrayBlockingQueueTest exte * retainAll(c) retains only those elements of c and reports true if changed */ public void testRetainAll() { - ArrayBlockingQueue q = populatedQueue(SIZE); - ArrayBlockingQueue p = populatedQueue(SIZE); + ArrayBlockingQueue q = populatedQueue(SIZE); + ArrayBlockingQueue p = populatedQueue(SIZE); for (int i = 0; i < SIZE; ++i) { boolean changed = q.retainAll(p); if (i == 0) @@ -585,7 +632,7 @@ public class ArrayBlockingQueueTest exte assertTrue(changed); assertTrue(q.containsAll(p)); - assertEquals(SIZE-i, q.size()); + mustEqual(SIZE - i, q.size()); p.remove(); } } @@ -595,71 +642,124 @@ public class ArrayBlockingQueueTest exte */ public void testRemoveAll() { for (int i = 1; i < SIZE; ++i) { - ArrayBlockingQueue q = populatedQueue(SIZE); - ArrayBlockingQueue p = populatedQueue(i); + ArrayBlockingQueue q = populatedQueue(SIZE); + ArrayBlockingQueue p = populatedQueue(i); assertTrue(q.removeAll(p)); - assertEquals(SIZE-i, q.size()); + mustEqual(SIZE - i, q.size()); for (int j = 0; j < i; ++j) { - Integer I = (Integer)(p.remove()); - assertFalse(q.contains(I)); + Item x = p.remove(); + mustNotContain(q, x); } } } - /** - * toArray contains all elements in FIFO order - */ - public void testToArray() { - ArrayBlockingQueue q = populatedQueue(SIZE); - Object[] o = q.toArray(); - for (int i = 0; i < o.length; i++) - assertSame(o[i], q.poll()); + void checkToArray(ArrayBlockingQueue q) { + int size = q.size(); + Object[] a1 = q.toArray(); + mustEqual(size, a1.length); + Item[] a2 = q.toArray(new Item[0]); + mustEqual(size, a2.length); + Item[] a3 = q.toArray(new Item[Math.max(0, size - 1)]); + mustEqual(size, a3.length); + Item[] a4 = new Item[size]; + assertSame(a4, q.toArray(a4)); + Item[] a5 = new Item[size + 1]; + Arrays.fill(a5, fortytwo); + assertSame(a5, q.toArray(a5)); + Item[] a6 = new Item[size + 2]; + Arrays.fill(a6, fortytwo); + assertSame(a6, q.toArray(a6)); + Object[][] as = { a1, a2, a3, a4, a5, a6 }; + for (Object[] a : as) { + if (a.length > size) assertNull(a[size]); + if (a.length > size + 1) mustEqual(fortytwo, a[size + 1]); + } + Iterator it = q.iterator(); + Item s = q.peek(); + for (int i = 0; i < size; i++) { + Item x = (Item) it.next(); + mustEqual(s.value + i, x); + for (Object[] a : as) + mustEqual(a[i], x); + } } /** - * toArray(a) contains all elements in FIFO order - */ - public void testToArray2() { - ArrayBlockingQueue q = populatedQueue(SIZE); - Integer[] ints = new Integer[SIZE]; - Integer[] array = q.toArray(ints); - assertSame(ints, array); - for (int i = 0; i < ints.length; i++) - assertSame(ints[i], q.poll()); + * toArray() and toArray(a) contain all elements in FIFO order + */ + public void testToArray() { + final ThreadLocalRandom rnd = ThreadLocalRandom.current(); + final int size = rnd.nextInt(6); + final int capacity = Math.max(1, size + rnd.nextInt(size + 1)); + ArrayBlockingQueue q = new ArrayBlockingQueue<>(capacity); + for (int i = 0; i < size; i++) { + checkToArray(q); + mustAdd(q, i); + } + // Provoke wraparound + int added = size * 2; + for (int i = 0; i < added; i++) { + checkToArray(q); + mustEqual(i, q.poll()); + q.add(new Item(size + i)); + } + for (int i = 0; i < size; i++) { + checkToArray(q); + mustEqual((added + i), q.poll()); + } } /** * toArray(incompatible array type) throws ArrayStoreException */ - public void testToArray1_BadArg() { - ArrayBlockingQueue q = populatedQueue(SIZE); + public void testToArray_incompatibleArrayType() { + ArrayBlockingQueue q = populatedQueue(SIZE); try { q.toArray(new String[10]); shouldThrow(); } catch (ArrayStoreException success) {} + try { + q.toArray(new String[0]); + shouldThrow(); + } catch (ArrayStoreException success) {} } /** * iterator iterates through all elements */ public void testIterator() throws InterruptedException { - ArrayBlockingQueue q = populatedQueue(SIZE); - Iterator it = q.iterator(); - while (it.hasNext()) { - assertEquals(it.next(), q.take()); - } + ArrayBlockingQueue q = populatedQueue(SIZE); + Iterator it = q.iterator(); + int i; + for (i = 0; it.hasNext(); i++) + mustContain(q, it.next()); + mustEqual(i, SIZE); + assertIteratorExhausted(it); + + it = q.iterator(); + for (i = 0; it.hasNext(); i++) + mustEqual(it.next(), q.take()); + mustEqual(i, SIZE); + assertIteratorExhausted(it); + } + + /** + * iterator of empty collection has no elements + */ + public void testEmptyIterator() { + assertIteratorExhausted(new ArrayBlockingQueue<>(SIZE).iterator()); } /** * iterator.remove removes current element */ public void testIteratorRemove() { - final ArrayBlockingQueue q = new ArrayBlockingQueue(3); + final ArrayBlockingQueue q = new ArrayBlockingQueue<>(3); q.add(two); q.add(one); q.add(three); - Iterator it = q.iterator(); + Iterator it = q.iterator(); it.next(); it.remove(); @@ -673,7 +773,7 @@ public class ArrayBlockingQueueTest exte * iterator ordering is FIFO */ public void testIteratorOrdering() { - final ArrayBlockingQueue q = new ArrayBlockingQueue(3); + final ArrayBlockingQueue q = new ArrayBlockingQueue<>(3); q.add(one); q.add(two); q.add(three); @@ -681,32 +781,32 @@ public class ArrayBlockingQueueTest exte assertEquals("queue should be full", 0, q.remainingCapacity()); int k = 0; - for (Iterator it = q.iterator(); it.hasNext();) { - assertEquals(++k, it.next()); + for (Iterator it = q.iterator(); it.hasNext();) { + mustEqual(++k, it.next()); } - assertEquals(3, k); + mustEqual(3, k); } /** * Modifications do not cause iterators to fail */ public void testWeaklyConsistentIteration() { - final ArrayBlockingQueue q = new ArrayBlockingQueue(3); + final ArrayBlockingQueue q = new ArrayBlockingQueue<>(3); q.add(one); q.add(two); q.add(three); - for (Iterator it = q.iterator(); it.hasNext();) { + for (Iterator it = q.iterator(); it.hasNext();) { q.remove(); it.next(); } - assertEquals(0, q.size()); + mustEqual(0, q.size()); } /** * toString contains toStrings of elements */ public void testToString() { - ArrayBlockingQueue q = populatedQueue(SIZE); + ArrayBlockingQueue q = populatedQueue(SIZE); String s = q.toString(); for (int i = 0; i < SIZE; ++i) { assertTrue(s.contains(String.valueOf(i))); @@ -717,67 +817,67 @@ public class ArrayBlockingQueueTest exte * offer transfers elements across Executor tasks */ public void testOfferInExecutor() { - final ArrayBlockingQueue q = new ArrayBlockingQueue(2); + final ArrayBlockingQueue q = new ArrayBlockingQueue<>(2); q.add(one); q.add(two); - ExecutorService executor = Executors.newFixedThreadPool(2); final CheckedBarrier threadsStarted = new CheckedBarrier(2); - executor.execute(new CheckedRunnable() { - public void realRun() throws InterruptedException { - assertFalse(q.offer(three)); - threadsStarted.await(); - assertTrue(q.offer(three, LONG_DELAY_MS, MILLISECONDS)); - assertEquals(0, q.remainingCapacity()); - }}); - - executor.execute(new CheckedRunnable() { - public void realRun() throws InterruptedException { - threadsStarted.await(); - assertEquals(0, q.remainingCapacity()); - assertSame(one, q.take()); - }}); - - joinPool(executor); + final ExecutorService executor = Executors.newFixedThreadPool(2); + try (PoolCleaner cleaner = cleaner(executor)) { + executor.execute(new CheckedRunnable() { + public void realRun() throws InterruptedException { + assertFalse(q.offer(three)); + threadsStarted.await(); + assertTrue(q.offer(three, LONG_DELAY_MS, MILLISECONDS)); + mustEqual(0, q.remainingCapacity()); + }}); + + executor.execute(new CheckedRunnable() { + public void realRun() throws InterruptedException { + threadsStarted.await(); + mustEqual(0, q.remainingCapacity()); + assertSame(one, q.take()); + }}); + } } /** * timed poll retrieves elements across Executor threads */ public void testPollInExecutor() { - final ArrayBlockingQueue q = new ArrayBlockingQueue(2); + final ArrayBlockingQueue q = new ArrayBlockingQueue<>(2); final CheckedBarrier threadsStarted = new CheckedBarrier(2); - ExecutorService executor = Executors.newFixedThreadPool(2); - executor.execute(new CheckedRunnable() { - public void realRun() throws InterruptedException { - assertNull(q.poll()); - threadsStarted.await(); - assertSame(one, q.poll(LONG_DELAY_MS, MILLISECONDS)); - checkEmpty(q); - }}); - - executor.execute(new CheckedRunnable() { - public void realRun() throws InterruptedException { - threadsStarted.await(); - q.put(one); - }}); - - joinPool(executor); + final ExecutorService executor = Executors.newFixedThreadPool(2); + try (PoolCleaner cleaner = cleaner(executor)) { + executor.execute(new CheckedRunnable() { + public void realRun() throws InterruptedException { + assertNull(q.poll()); + threadsStarted.await(); + assertSame(one, q.poll(LONG_DELAY_MS, MILLISECONDS)); + checkEmpty(q); + }}); + + executor.execute(new CheckedRunnable() { + public void realRun() throws InterruptedException { + threadsStarted.await(); + q.put(one); + }}); + } } /** - * A deserialized serialized queue has same elements in same order + * A deserialized/reserialized queue has same elements in same order */ public void testSerialization() throws Exception { - Queue x = populatedQueue(SIZE); - Queue y = serialClone(x); + Queue x = populatedQueue(SIZE); + Queue y = serialClone(x); - assertTrue(x != y); - assertEquals(x.size(), y.size()); - assertEquals(x.toString(), y.toString()); + assertNotSame(x, y); + mustEqual(x.size(), y.size()); + mustEqual(x.toString(), y.toString()); assertTrue(Arrays.equals(x.toArray(), y.toArray())); while (!x.isEmpty()) { assertFalse(y.isEmpty()); - assertEquals(x.remove(), y.remove()); + mustEqual(x.remove(), y.remove()); } assertTrue(y.isEmpty()); } @@ -786,42 +886,42 @@ public class ArrayBlockingQueueTest exte * drainTo(c) empties queue into another collection c */ public void testDrainTo() { - ArrayBlockingQueue q = populatedQueue(SIZE); - ArrayList l = new ArrayList(); + ArrayBlockingQueue q = populatedQueue(SIZE); + ArrayList l = new ArrayList<>(); q.drainTo(l); - assertEquals(q.size(), 0); - assertEquals(l.size(), SIZE); + mustEqual(0, q.size()); + mustEqual(SIZE, l.size()); for (int i = 0; i < SIZE; ++i) - assertEquals(l.get(i), new Integer(i)); + mustEqual(l.get(i), i); q.add(zero); q.add(one); assertFalse(q.isEmpty()); - assertTrue(q.contains(zero)); - assertTrue(q.contains(one)); + mustContain(q, zero); + mustContain(q, one); l.clear(); q.drainTo(l); - assertEquals(q.size(), 0); - assertEquals(l.size(), 2); + mustEqual(0, q.size()); + mustEqual(2, l.size()); for (int i = 0; i < 2; ++i) - assertEquals(l.get(i), new Integer(i)); + mustEqual(l.get(i), i); } /** * drainTo empties full queue, unblocking a waiting put. */ public void testDrainToWithActivePut() throws InterruptedException { - final ArrayBlockingQueue q = populatedQueue(SIZE); + final ArrayBlockingQueue q = populatedQueue(SIZE); Thread t = new Thread(new CheckedRunnable() { public void realRun() throws InterruptedException { - q.put(new Integer(SIZE+1)); + q.put(new Item(SIZE + 1)); }}); t.start(); - ArrayList l = new ArrayList(); + 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)); + mustEqual(l.get(i), i); t.join(); assertTrue(q.size() + l.size() >= SIZE); } @@ -830,19 +930,33 @@ public class ArrayBlockingQueueTest exte * drainTo(c, n) empties first min(n, size) elements of queue into c */ public void testDrainToN() { - ArrayBlockingQueue q = new ArrayBlockingQueue(SIZE*2); + ArrayBlockingQueue q = new ArrayBlockingQueue<>(SIZE * 2); 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(); + mustOffer(q, j); + ArrayList l = new ArrayList<>(); q.drainTo(l, i); int k = (i < SIZE) ? i : SIZE; - assertEquals(l.size(), k); - assertEquals(q.size(), SIZE-k); + mustEqual(k, l.size()); + mustEqual(SIZE - k, q.size()); for (int j = 0; j < k; ++j) - assertEquals(l.get(j), new Integer(j)); - while (q.poll() != null) ; + mustEqual(l.get(j), j); + do {} while (q.poll() != null); } } + /** + * remove(null), contains(null) always return false + */ + public void testNeverContainsNull() { + Collection[] qs = { + populatedQueue(0, 1, 10, false), + populatedQueue(2, 2, 10, true), + }; + + for (Collection q : qs) { + assertFalse(q.contains(null)); + assertFalse(q.remove(null)); + } + } }