--- jsr166/src/test/tck/DelayQueueTest.java 2003/09/07 20:39:11 1.2 +++ jsr166/src/test/tck/DelayQueueTest.java 2021/01/27 02:55:18 1.96 @@ -1,141 +1,193 @@ /* - * 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/publicdomain/zero/1.0/ + * Other contributors include Andrew Wright, Jeffrey Hayes, + * Pat Fisher, Mike Judd. */ -import junit.framework.*; -import java.util.*; -import java.util.concurrent.*; - -public class DelayQueueTest extends TestCase { - - private static final int N = 10; - private static final long SHORT_DELAY_MS = 100; - private static final long MEDIUM_DELAY_MS = 1000; - private static final long LONG_DELAY_MS = 10000; - private static final int NOCAP = Integer.MAX_VALUE; +import static java.util.concurrent.TimeUnit.MILLISECONDS; + +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collection; +import java.util.Iterator; +import java.util.NoSuchElementException; +import java.util.concurrent.BlockingQueue; +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.Delayed; +import java.util.concurrent.DelayQueue; +import java.util.concurrent.Executors; +import java.util.concurrent.ExecutorService; +import java.util.concurrent.TimeUnit; + +import junit.framework.Test; + +public class DelayQueueTest extends JSR166TestCase { + + public static class Generic extends BlockingQueueTest { + protected BlockingQueue emptyCollection() { + return new DelayQueue(); + } + protected PDelay makeElement(int i) { + return new PDelay(i); + } + } public static void main(String[] args) { - junit.textui.TestRunner.run (suite()); + main(suite(), args); } public static Test suite() { - return new TestSuite(DelayQueueTest.class); + class Implementation implements CollectionImplementation { + public Class klazz() { return DelayQueue.class; } + public Collection emptyCollection() { return new DelayQueue(); } + public Object makeElement(int i) { return new PDelay(i); } + public boolean isConcurrent() { return true; } + public boolean permitsNulls() { return false; } + } + return newTestSuite(DelayQueueTest.class, + new Generic().testSuite(), + CollectionTest.testSuite(new Implementation())); + } + + /** + * A fake Delayed implementation for testing. + * Most tests use PDelays, where delays are all elapsed + * (so, no blocking solely for delays) but are still ordered + */ + static class PDelay implements Delayed { + final int pseudodelay; + PDelay(int pseudodelay) { this.pseudodelay = pseudodelay; } + public int compareTo(Delayed y) { + return Integer.compare(this.pseudodelay, ((PDelay)y).pseudodelay); + } + public boolean equals(Object other) { + return (other instanceof PDelay) && + this.pseudodelay == ((PDelay)other).pseudodelay; + } + // suppress [overrides] javac warning + public int hashCode() { return pseudodelay; } + public long getDelay(TimeUnit ignore) { + return (long) Integer.MIN_VALUE + pseudodelay; + } + public String toString() { + return String.valueOf(pseudodelay); + } } - // Most Q/BQ tests use Pseudodelays, where delays are all elapsed - // (so, no blocking solely for delays) but are still ordered + /** + * Delayed implementation that actually delays + */ + static class NanoDelay implements Delayed { + final long trigger; + NanoDelay(long i) { + trigger = System.nanoTime() + i; + } - static class PDelay implements Delayed { - int pseudodelay; - PDelay(int i) { pseudodelay = Integer.MIN_VALUE + i; } - public int compareTo(Object y) { - int i = pseudodelay; - int j = ((PDelay)y).pseudodelay; - if (i < j) return -1; - if (i > j) return 1; - return 0; - } - - public int compareTo(PDelay y) { - int i = pseudodelay; - int j = ((PDelay)y).pseudodelay; - if (i < j) return -1; - if (i > j) return 1; - return 0; + public int compareTo(Delayed y) { + return Long.compare(trigger, ((NanoDelay)y).trigger); } public boolean equals(Object other) { - return ((PDelay)other).pseudodelay == pseudodelay; - } - public boolean equals(PDelay other) { - return ((PDelay)other).pseudodelay == pseudodelay; + return (other instanceof NanoDelay) && + this.trigger == ((NanoDelay)other).trigger; } + // suppress [overrides] javac warning + public int hashCode() { return (int) trigger; } - public long getDelay(TimeUnit ignore) { - return pseudodelay; + public long getDelay(TimeUnit unit) { + long n = trigger - System.nanoTime(); + return unit.convert(n, TimeUnit.NANOSECONDS); } - public int intValue() { - return pseudodelay; + + public long getTriggerTime() { + return trigger; } public String toString() { - return String.valueOf(pseudodelay); + return String.valueOf(trigger); } } - - - /** - * Create a queue of given size containing consecutive - * PDelays 0 ... n. + * Returns a new queue of given size containing consecutive + * PDelays 0 ... n - 1. */ - private DelayQueue fullQueue(int n) { - DelayQueue q = new DelayQueue(); + private static DelayQueue populatedQueue(int n) { + DelayQueue q = new DelayQueue<>(); assertTrue(q.isEmpty()); - for(int i = n-1; i >= 0; i-=2) - assertTrue(q.offer(new PDelay(i))); - for(int i = (n & 1); i < n; i+=2) - assertTrue(q.offer(new PDelay(i))); + for (int i = n - 1; i >= 0; i -= 2) + assertTrue(q.offer(new PDelay(i))); + for (int i = (n & 1); i < n; i += 2) + assertTrue(q.offer(new PDelay(i))); assertFalse(q.isEmpty()); - assertEquals(NOCAP, q.remainingCapacity()); - assertEquals(n, q.size()); + mustEqual(Integer.MAX_VALUE, q.remainingCapacity()); + mustEqual(n, q.size()); + mustEqual(new PDelay(0), q.peek()); return q; } - - public void testConstructor1(){ - assertEquals(NOCAP, new DelayQueue().remainingCapacity()); - } - public void testConstructor3(){ + /** + * A new queue has unbounded capacity + */ + public void testConstructor1() { + mustEqual(Integer.MAX_VALUE, new DelayQueue().remainingCapacity()); + } + /** + * Initializing from null Collection throws NPE + */ + public void testConstructor3() { try { - DelayQueue q = new DelayQueue(null); - fail("Cannot make from null collection"); - } - catch (NullPointerException success) {} + new DelayQueue(null); + shouldThrow(); + } catch (NullPointerException success) {} } - public void testConstructor4(){ + /** + * Initializing from Collection of null elements throws NPE + */ + public void testConstructor4() { try { - PDelay[] ints = new PDelay[N]; - DelayQueue q = new DelayQueue(Arrays.asList(ints)); - fail("Cannot make with null elements"); - } - catch (NullPointerException success) {} + new DelayQueue(Arrays.asList(new PDelay[SIZE])); + shouldThrow(); + } catch (NullPointerException success) {} } - public void testConstructor5(){ - try { - PDelay[] ints = new PDelay[N]; - for (int i = 0; i < N-1; ++i) - ints[i] = new PDelay(i); - DelayQueue q = new DelayQueue(Arrays.asList(ints)); - fail("Cannot make with null elements"); - } - catch (NullPointerException success) {} + /** + * Initializing from Collection with some null elements throws NPE + */ + public void testConstructor5() { + PDelay[] a = new PDelay[SIZE]; + for (int i = 0; i < SIZE - 1; ++i) + a[i] = new PDelay(i); + try { + new DelayQueue(Arrays.asList(a)); + shouldThrow(); + } catch (NullPointerException success) {} } - public void testConstructor6(){ - try { - PDelay[] ints = new PDelay[N]; - for (int i = 0; i < N; ++i) - ints[i] = new PDelay(i); - DelayQueue q = new DelayQueue(Arrays.asList(ints)); - for (int i = 0; i < N; ++i) - assertEquals(ints[i], q.poll()); - } - finally {} + /** + * Queue contains all elements of collection used to initialize + */ + public void testConstructor6() { + PDelay[] items = new PDelay[SIZE]; + for (int i = 0; i < SIZE; ++i) + items[i] = new PDelay(i); + DelayQueue q = new DelayQueue<>(Arrays.asList(items)); + for (int i = 0; i < SIZE; ++i) + mustEqual(items[i], q.poll()); } + /** + * isEmpty is true before add, false after + */ public void testEmpty() { - DelayQueue q = new DelayQueue(); + DelayQueue q = new DelayQueue<>(); assertTrue(q.isEmpty()); - assertEquals(NOCAP, q.remainingCapacity()); + mustEqual(Integer.MAX_VALUE, q.remainingCapacity()); q.add(new PDelay(1)); assertFalse(q.isEmpty()); q.add(new PDelay(2)); @@ -144,371 +196,326 @@ public class DelayQueueTest extends Test assertTrue(q.isEmpty()); } - public void testRemainingCapacity(){ - DelayQueue q = fullQueue(N); - for (int i = 0; i < N; ++i) { - assertEquals(NOCAP, q.remainingCapacity()); - assertEquals(N-i, q.size()); - q.remove(); - } - for (int i = 0; i < N; ++i) { - assertEquals(NOCAP, q.remainingCapacity()); - assertEquals(i, q.size()); - q.add(new PDelay(i)); + /** + * remainingCapacity() always returns Integer.MAX_VALUE + */ + public void testRemainingCapacity() { + BlockingQueue q = populatedQueue(SIZE); + for (int i = 0; i < SIZE; ++i) { + mustEqual(Integer.MAX_VALUE, q.remainingCapacity()); + mustEqual(SIZE - i, q.size()); + assertTrue(q.remove() instanceof PDelay); + } + for (int i = 0; i < SIZE; ++i) { + mustEqual(Integer.MAX_VALUE, q.remainingCapacity()); + mustEqual(i, q.size()); + assertTrue(q.add(new PDelay(i))); } } - public void testOfferNull(){ - try { - DelayQueue q = new DelayQueue(); - q.offer(null); - fail("should throw NPE"); - } catch (NullPointerException success) { } - } - + /** + * offer non-null succeeds + */ public void testOffer() { - DelayQueue q = new DelayQueue(); + DelayQueue q = new DelayQueue<>(); assertTrue(q.offer(new PDelay(0))); assertTrue(q.offer(new PDelay(1))); } - public void testAdd(){ - DelayQueue q = new DelayQueue(); - for (int i = 0; i < N; ++i) { - assertEquals(i, q.size()); + /** + * add succeeds + */ + public void testAdd() { + DelayQueue q = new DelayQueue<>(); + for (int i = 0; i < SIZE; ++i) { + mustEqual(i, q.size()); assertTrue(q.add(new PDelay(i))); } } - public void testAddAll1(){ - try { - DelayQueue q = new DelayQueue(); - q.addAll(null); - fail("Cannot add null collection"); - } - catch (NullPointerException success) {} - } - public void testAddAll2(){ - try { - DelayQueue q = new DelayQueue(); - PDelay[] ints = new PDelay[N]; - q.addAll(Arrays.asList(ints)); - fail("Cannot add null elements"); - } - catch (NullPointerException success) {} - } - public void testAddAll3(){ + /** + * addAll(this) throws IllegalArgumentException + */ + public void testAddAllSelf() { + DelayQueue q = populatedQueue(SIZE); try { - DelayQueue q = new DelayQueue(); - PDelay[] ints = new PDelay[N]; - for (int i = 0; i < N-1; ++i) - ints[i] = new PDelay(i); - q.addAll(Arrays.asList(ints)); - fail("Cannot add null elements"); - } - catch (NullPointerException success) {} + q.addAll(q); + shouldThrow(); + } catch (IllegalArgumentException success) {} } - public void testAddAll5(){ - try { - PDelay[] empty = new PDelay[0]; - PDelay[] ints = new PDelay[N]; - for (int i = N-1; i >= 0; --i) - ints[i] = new PDelay(i); - DelayQueue q = new DelayQueue(); - assertFalse(q.addAll(Arrays.asList(empty))); - assertTrue(q.addAll(Arrays.asList(ints))); - for (int i = 0; i < N; ++i) - assertEquals(ints[i], q.poll()); - } - finally {} - } - - public void testPutNull() { - try { - DelayQueue q = new DelayQueue(); - q.put(null); - fail("put should throw NPE"); - } - catch (NullPointerException success){ - } - } - - public void testPut() { - try { - DelayQueue q = new DelayQueue(); - for (int i = 0; i < N; ++i) { - PDelay I = new PDelay(i); - q.put(I); - assertTrue(q.contains(I)); - } - assertEquals(N, q.size()); - } - finally { - } + /** + * addAll of a collection with any null elements throws NPE after + * possibly adding some elements + */ + public void testAddAll3() { + DelayQueue q = new DelayQueue<>(); + PDelay[] a = new PDelay[SIZE]; + for (int i = 0; i < SIZE - 1; ++i) + a[i] = new PDelay(i); + try { + q.addAll(Arrays.asList(a)); + shouldThrow(); + } catch (NullPointerException success) {} } - public void testPutWithTake() { - final DelayQueue q = new DelayQueue(); - Thread t = new Thread(new Runnable() { - public void run(){ - int added = 0; - try { - q.put(new PDelay(0)); - ++added; - q.put(new PDelay(0)); - ++added; - q.put(new PDelay(0)); - ++added; - q.put(new PDelay(0)); - ++added; - assertTrue(added == 4); - } finally { - } - } - }); - try { - t.start(); - Thread.sleep(SHORT_DELAY_MS); - q.take(); - t.interrupt(); - t.join(); - } catch (Exception e){ - fail("Unexpected exception"); - } + /** + * Queue contains all elements of successful addAll + */ + public void testAddAll5() { + PDelay[] empty = new PDelay[0]; + PDelay[] items = new PDelay[SIZE]; + for (int i = SIZE - 1; i >= 0; --i) + items[i] = new PDelay(i); + DelayQueue q = new DelayQueue<>(); + assertFalse(q.addAll(Arrays.asList(empty))); + assertTrue(q.addAll(Arrays.asList(items))); + for (int i = 0; i < SIZE; ++i) + mustEqual(items[i], q.poll()); } - public void testTimedOffer() { - final DelayQueue q = new DelayQueue(); - Thread t = new Thread(new Runnable() { - public void run(){ - try { - q.put(new PDelay(0)); - q.put(new PDelay(0)); - assertTrue(q.offer(new PDelay(0), SHORT_DELAY_MS/2, TimeUnit.MILLISECONDS)); - assertTrue(q.offer(new PDelay(0), LONG_DELAY_MS, TimeUnit.MILLISECONDS)); - } finally { } - } - }); - - try { - t.start(); - Thread.sleep(SHORT_DELAY_MS); - t.interrupt(); - t.join(); - } catch (Exception e){ - fail("Unexpected exception"); + /** + * all elements successfully put are contained + */ + public void testPut() { + DelayQueue q = new DelayQueue<>(); + for (int i = 0; i < SIZE; ++i) { + PDelay x = new PDelay(i); + q.put(x); + assertTrue(q.contains(x)); } + mustEqual(SIZE, q.size()); } - public void testTake(){ - try { - DelayQueue q = fullQueue(N); - for (int i = 0; i < N; ++i) { - assertEquals(new PDelay(i), ((PDelay)q.take())); - } - } catch (InterruptedException e){ - fail("Unexpected exception"); - } + /** + * put doesn't block waiting for take + */ + public void testPutWithTake() throws InterruptedException { + final DelayQueue q = new DelayQueue<>(); + Thread t = newStartedThread(new CheckedRunnable() { + public void realRun() { + q.put(new PDelay(0)); + q.put(new PDelay(0)); + q.put(new PDelay(0)); + q.put(new PDelay(0)); + }}); + + awaitTermination(t); + mustEqual(4, q.size()); } - public void testTakeFromEmpty() { - final DelayQueue q = new DelayQueue(); - Thread t = new Thread(new Runnable() { - public void run(){ - try { - q.take(); - fail("Should block"); - } catch (InterruptedException success){ } - } - }); - try { - t.start(); - Thread.sleep(SHORT_DELAY_MS); - t.interrupt(); - t.join(); - } catch (Exception e){ - fail("Unexpected exception"); - } + /** + * Queue is unbounded, so timed offer never times out + */ + public void testTimedOffer() throws InterruptedException { + final DelayQueue q = new DelayQueue<>(); + Thread t = newStartedThread(new CheckedRunnable() { + public void realRun() throws InterruptedException { + q.put(new PDelay(0)); + q.put(new PDelay(0)); + assertTrue(q.offer(new PDelay(0), SHORT_DELAY_MS, MILLISECONDS)); + assertTrue(q.offer(new PDelay(0), LONG_DELAY_MS, MILLISECONDS)); + }}); + + awaitTermination(t); } - public void testBlockingTake(){ - Thread t = new Thread(new Runnable() { - public void run() { - try { - DelayQueue q = fullQueue(N); - for (int i = 0; i < N; ++i) { - assertEquals(new PDelay(i), ((PDelay)q.take())); - } - q.take(); - fail("take should block"); - } catch (InterruptedException success){ - } - }}); - t.start(); - try { - Thread.sleep(SHORT_DELAY_MS); - t.interrupt(); - t.join(); - } - catch (InterruptedException ie) { - fail("Unexpected exception"); + /** + * take retrieves elements in priority order + */ + public void testTake() throws InterruptedException { + DelayQueue q = populatedQueue(SIZE); + for (int i = 0; i < SIZE; ++i) { + mustEqual(new PDelay(i), q.take()); } } + /** + * Take removes existing elements until empty, then blocks interruptibly + */ + public void testBlockingTake() throws InterruptedException { + final DelayQueue 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++) + mustEqual(new PDelay(i), q.take()); - public void testPoll(){ - DelayQueue q = fullQueue(N); - for (int i = 0; i < N; ++i) { - assertEquals(new PDelay(i), ((PDelay)q.poll())); - } - assertNull(q.poll()); + Thread.currentThread().interrupt(); + try { + q.take(); + shouldThrow(); + } catch (InterruptedException success) {} + assertFalse(Thread.interrupted()); + + pleaseInterrupt.countDown(); + try { + q.take(); + shouldThrow(); + } catch (InterruptedException success) {} + assertFalse(Thread.interrupted()); + }}); + + await(pleaseInterrupt); + if (randomBoolean()) assertThreadBlocks(t, Thread.State.WAITING); + t.interrupt(); + awaitTermination(t); } - public void testTimedPoll0() { - try { - DelayQueue q = fullQueue(N); - for (int i = 0; i < N; ++i) { - assertEquals(new PDelay(i), ((PDelay)q.poll(0, TimeUnit.MILLISECONDS))); - } - assertNull(q.poll(0, TimeUnit.MILLISECONDS)); - } catch (InterruptedException e){ - fail("Unexpected exception"); - } + /** + * poll succeeds unless empty + */ + public void testPoll() { + DelayQueue q = populatedQueue(SIZE); + for (int i = 0; i < SIZE; ++i) { + mustEqual(new PDelay(i), q.poll()); + } + assertNull(q.poll()); } - public void testTimedPoll() { - try { - DelayQueue q = fullQueue(N); - for (int i = 0; i < N; ++i) { - assertEquals(new PDelay(i), ((PDelay)q.poll(SHORT_DELAY_MS, TimeUnit.MILLISECONDS))); - } - assertNull(q.poll(SHORT_DELAY_MS, TimeUnit.MILLISECONDS)); - } catch (InterruptedException e){ - fail("Unexpected exception"); - } - } - - public void testInterruptedTimedPoll(){ - Thread t = new Thread(new Runnable() { - public void run() { - try { - DelayQueue q = fullQueue(N); - for (int i = 0; i < N; ++i) { - assertEquals(new PDelay(i), ((PDelay)q.poll(SHORT_DELAY_MS, TimeUnit.MILLISECONDS))); - } - assertNull(q.poll(SHORT_DELAY_MS, TimeUnit.MILLISECONDS)); - } catch (InterruptedException success){ - } - }}); - t.start(); - try { - Thread.sleep(SHORT_DELAY_MS); - t.interrupt(); - t.join(); - } - catch (InterruptedException ie) { - fail("Unexpected exception"); + /** + * timed poll with zero timeout succeeds when non-empty, else times out + */ + public void testTimedPoll0() throws InterruptedException { + DelayQueue q = populatedQueue(SIZE); + for (int i = 0; i < SIZE; ++i) { + mustEqual(new PDelay(i), q.poll(0, MILLISECONDS)); } + assertNull(q.poll(0, MILLISECONDS)); } - public void testTimedPollWithOffer(){ - final DelayQueue q = new DelayQueue(); - Thread t = new Thread(new Runnable() { - public void run(){ - try { - assertNull(q.poll(SHORT_DELAY_MS, TimeUnit.MILLISECONDS)); - q.poll(LONG_DELAY_MS, TimeUnit.MILLISECONDS); - q.poll(LONG_DELAY_MS, TimeUnit.MILLISECONDS); - fail("Should block"); - } catch (InterruptedException success) { } - } - }); - try { - t.start(); - Thread.sleep(SHORT_DELAY_MS * 2); - assertTrue(q.offer(new PDelay(0), SHORT_DELAY_MS, TimeUnit.MILLISECONDS)); - t.interrupt(); - t.join(); - } catch (Exception e){ - fail("Unexpected exception"); - } - } + /** + * timed poll with nonzero timeout succeeds when non-empty, else times out + */ + public void testTimedPoll() throws InterruptedException { + DelayQueue q = populatedQueue(SIZE); + for (int i = 0; i < SIZE; ++i) { + long startTime = System.nanoTime(); + mustEqual(new PDelay(i), q.poll(LONG_DELAY_MS, MILLISECONDS)); + assertTrue(millisElapsedSince(startTime) < LONG_DELAY_MS); + } + long startTime = System.nanoTime(); + assertNull(q.poll(timeoutMillis(), MILLISECONDS)); + assertTrue(millisElapsedSince(startTime) >= timeoutMillis()); + checkEmpty(q); + } + /** + * Interrupted timed poll throws InterruptedException instead of + * returning timeout status + */ + public void testInterruptedTimedPoll() throws InterruptedException { + final CountDownLatch pleaseInterrupt = new CountDownLatch(1); + final DelayQueue q = populatedQueue(SIZE); + Thread t = newStartedThread(new CheckedRunnable() { + public void realRun() throws InterruptedException { + for (int i = 0; i < SIZE; i++) + mustEqual(new PDelay(i), + q.poll(LONG_DELAY_MS, MILLISECONDS)); - public void testPeek(){ - DelayQueue q = fullQueue(N); - for (int i = 0; i < N; ++i) { - assertEquals(new PDelay(i), ((PDelay)q.peek())); - q.poll(); - assertTrue(q.peek() == null || - i != ((PDelay)q.peek()).intValue()); + 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()); + }}); + + await(pleaseInterrupt); + if (randomBoolean()) assertThreadBlocks(t, Thread.State.TIMED_WAITING); + t.interrupt(); + awaitTermination(t); + checkEmpty(q); + } + + /** + * peek returns next element, or null if empty + */ + public void testPeek() { + DelayQueue q = populatedQueue(SIZE); + for (int i = 0; i < SIZE; ++i) { + mustEqual(new PDelay(i), q.peek()); + mustEqual(new PDelay(i), q.poll()); + if (q.isEmpty()) + assertNull(q.peek()); + else + assertFalse(new PDelay(i).equals(q.peek())); } - assertNull(q.peek()); + assertNull(q.peek()); } - public void testElement(){ - DelayQueue q = fullQueue(N); - for (int i = 0; i < N; ++i) { - assertEquals(new PDelay(i), ((PDelay)q.element())); + /** + * element returns next element, or throws NSEE if empty + */ + public void testElement() { + DelayQueue q = populatedQueue(SIZE); + for (int i = 0; i < SIZE; ++i) { + mustEqual(new PDelay(i), q.element()); q.poll(); } try { q.element(); - fail("no such element"); - } - catch (NoSuchElementException success) {} + shouldThrow(); + } catch (NoSuchElementException success) {} } - public void testRemove(){ - DelayQueue q = fullQueue(N); - for (int i = 0; i < N; ++i) { - assertEquals(new PDelay(i), ((PDelay)q.remove())); + /** + * remove removes next element, or throws NSEE if empty + */ + public void testRemove() { + DelayQueue q = populatedQueue(SIZE); + for (int i = 0; i < SIZE; ++i) { + mustEqual(new PDelay(i), q.remove()); } try { q.remove(); - fail("remove should throw"); - } catch (NoSuchElementException success){ - } + shouldThrow(); + } catch (NoSuchElementException success) {} } - public void testRemoveElement(){ - DelayQueue q = fullQueue(N); - for (int i = 1; i < N; i+=2) { - assertTrue(q.remove(new PDelay(i))); - } - for (int i = 0; i < N; i+=2) { - assertTrue(q.remove(new PDelay(i))); - assertFalse(q.remove(new PDelay(i+1))); - } - assertTrue(q.isEmpty()); - } - - public void testContains(){ - DelayQueue q = fullQueue(N); - for (int i = 0; i < N; ++i) { + /** + * contains(x) reports true when elements added but not yet removed + */ + public void testContains() { + DelayQueue q = populatedQueue(SIZE); + for (int i = 0; i < SIZE; ++i) { assertTrue(q.contains(new PDelay(i))); q.poll(); assertFalse(q.contains(new PDelay(i))); } } - public void testClear(){ - DelayQueue q = fullQueue(N); + /** + * clear removes all elements + */ + public void testClear() { + DelayQueue q = populatedQueue(SIZE); q.clear(); assertTrue(q.isEmpty()); - assertEquals(0, q.size()); - assertEquals(NOCAP, q.remainingCapacity()); - q.add(new PDelay(1)); + mustEqual(0, q.size()); + mustEqual(Integer.MAX_VALUE, q.remainingCapacity()); + PDelay x = new PDelay(1); + q.add(x); assertFalse(q.isEmpty()); + assertTrue(q.contains(x)); q.clear(); assertTrue(q.isEmpty()); } - public void testContainsAll(){ - DelayQueue q = fullQueue(N); - DelayQueue p = new DelayQueue(); - for (int i = 0; i < N; ++i) { + /** + * containsAll(c) is true when c contains a subset of elements + */ + public void testContainsAll() { + DelayQueue q = populatedQueue(SIZE); + DelayQueue p = new DelayQueue<>(); + for (int i = 0; i < SIZE; ++i) { assertTrue(q.containsAll(p)); assertFalse(p.containsAll(q)); p.add(new PDelay(i)); @@ -516,10 +523,13 @@ public class DelayQueueTest extends Test assertTrue(p.containsAll(q)); } - public void testRetainAll(){ - DelayQueue q = fullQueue(N); - DelayQueue 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() { + DelayQueue q = populatedQueue(SIZE); + DelayQueue p = populatedQueue(SIZE); + for (int i = 0; i < SIZE; ++i) { boolean changed = q.retainAll(p); if (i == 0) assertFalse(changed); @@ -527,206 +537,253 @@ public class DelayQueueTest extends Test assertTrue(changed); assertTrue(q.containsAll(p)); - assertEquals(N-i, q.size()); + mustEqual(SIZE - i, q.size()); p.remove(); } } - public void testRemoveAll(){ - for (int i = 1; i < N; ++i) { - DelayQueue q = fullQueue(N); - DelayQueue 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) { + DelayQueue q = populatedQueue(SIZE); + DelayQueue p = populatedQueue(i); assertTrue(q.removeAll(p)); - assertEquals(N-i, q.size()); + mustEqual(SIZE - i, q.size()); for (int j = 0; j < i; ++j) { - PDelay I = (PDelay)(p.remove()); - assertFalse(q.contains(I)); + assertFalse(q.contains(p.remove())); } } } - /* - public void testEqualsAndHashCode(){ - DelayQueue q1 = fullQueue(N); - DelayQueue q2 = fullQueue(N); - assertTrue(q1.equals(q2)); - assertTrue(q2.equals(q1)); - assertEquals(q1.hashCode(), q2.hashCode()); - q1.remove(); - assertFalse(q1.equals(q2)); - assertFalse(q2.equals(q1)); - assertFalse(q1.hashCode() == q2.hashCode()); - q2.remove(); - assertTrue(q1.equals(q2)); - assertTrue(q2.equals(q1)); - assertEquals(q1.hashCode(), q2.hashCode()); - } - */ - - public void testToArray(){ - DelayQueue q = fullQueue(N); - Object[] o = q.toArray(); - Arrays.sort(o); - try { - for(int i = 0; i < o.length; i++) - assertEquals(o[i], q.take()); - } catch (InterruptedException e){ - fail("Unexpected exception"); - } - } - - public void testToArray2(){ - DelayQueue q = fullQueue(N); - PDelay[] ints = new PDelay[N]; - ints = (PDelay[])q.toArray(ints); - Arrays.sort(ints); - try { - for(int i = 0; i < ints.length; i++) - assertEquals(ints[i], q.take()); - } catch (InterruptedException e){ - fail("Unexpected exception"); - } - } - - public void testIterator(){ - DelayQueue q = fullQueue(N); + /** + * toArray contains all elements + */ + public void testToArray() throws InterruptedException { + DelayQueue q = populatedQueue(SIZE); + Object[] a = q.toArray(); + assertSame(Object[].class, a.getClass()); + Arrays.sort(a); + for (Object o : a) + assertSame(o, q.take()); + assertTrue(q.isEmpty()); + } + + /** + * toArray(a) contains all elements + */ + public void testToArray2() { + DelayQueue q = populatedQueue(SIZE); + PDelay[] items = new PDelay[SIZE]; + PDelay[] array = q.toArray(items); + assertSame(items, array); + Arrays.sort(items); + for (PDelay o : items) + assertSame(o, q.remove()); + assertTrue(q.isEmpty()); + } + + /** + * toArray(incompatible array type) throws ArrayStoreException + */ + @SuppressWarnings("CollectionToArraySafeParameter") + public void testToArray_incompatibleArrayType() { + DelayQueue q = populatedQueue(SIZE); + try { + q.toArray(new String[10]); + shouldThrow(); + } catch (ArrayStoreException success) {} + } + + /** + * iterator iterates through all elements + */ + public void testIterator() { + DelayQueue q = populatedQueue(SIZE); int i = 0; - Iterator it = q.iterator(); - while(it.hasNext()) { + Iterator it = q.iterator(); + while (it.hasNext()) { assertTrue(q.contains(it.next())); ++i; } - assertEquals(i, N); + mustEqual(i, SIZE); + assertIteratorExhausted(it); } - public void testIteratorRemove () { - - final DelayQueue q = new DelayQueue(); + /** + * iterator of empty collection has no elements + */ + public void testEmptyIterator() { + assertIteratorExhausted(new DelayQueue().iterator()); + } + /** + * iterator.remove removes current element + */ + public void testIteratorRemove() { + final DelayQueue q = new DelayQueue<>(); q.add(new PDelay(2)); q.add(new PDelay(1)); q.add(new PDelay(3)); - - Iterator it = q.iterator(); + Iterator it = q.iterator(); it.next(); it.remove(); - it = q.iterator(); - assertEquals(it.next(), new PDelay(2)); - assertEquals(it.next(), new PDelay(3)); + mustEqual(new PDelay(2), it.next()); + mustEqual(new PDelay(3), it.next()); assertFalse(it.hasNext()); } - - public void testToString(){ - DelayQueue q = fullQueue(N); + /** + * toString contains toStrings of elements + */ + public void testToString() { + DelayQueue q = populatedQueue(SIZE); String s = q.toString(); - for (int i = 0; i < N; ++i) { - assertTrue(s.indexOf(String.valueOf(i)) >= 0); - } - } + for (Object e : q) + assertTrue(s.contains(e.toString())); + } + /** + * timed poll transfers elements across Executor tasks + */ public void testPollInExecutor() { + final DelayQueue q = new DelayQueue<>(); + final CheckedBarrier threadsStarted = new CheckedBarrier(2); + 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(); + assertNotNull(q.poll(LONG_DELAY_MS, MILLISECONDS)); + checkEmpty(q); + }}); - final DelayQueue q = new DelayQueue(); - - ExecutorService executor = Executors.newFixedThreadPool(2); - - executor.execute(new Runnable() { - public void run() { - assertNull("poll should fail", q.poll()); - try { - assertTrue(null != q.poll(MEDIUM_DELAY_MS * 2, TimeUnit.MILLISECONDS)); - assertTrue(q.isEmpty()); - } - catch (InterruptedException e) { - fail("should not be interrupted"); - } - } - }); - - executor.execute(new Runnable() { - public void run() { - try { - Thread.sleep(MEDIUM_DELAY_MS); + executor.execute(new CheckedRunnable() { + public void realRun() throws InterruptedException { + threadsStarted.await(); q.put(new PDelay(1)); - } - catch (InterruptedException e) { - fail("should not be interrupted"); - } - } - }); - - executor.shutdown(); - - } - - static class NanoDelay implements Delayed { - long trigger; - NanoDelay(long i) { - trigger = System.nanoTime() + i; - } - public int compareTo(Object y) { - long i = trigger; - long j = ((NanoDelay)y).trigger; - if (i < j) return -1; - if (i > j) return 1; - return 0; + }}); } + } - public int compareTo(NanoDelay y) { - long i = trigger; - long j = ((NanoDelay)y).trigger; - if (i < j) return -1; - if (i > j) return 1; - return 0; + /** + * Delayed actions do not occur until their delay elapses + */ + public void testDelay() throws InterruptedException { + DelayQueue q = new DelayQueue<>(); + for (int i = 0; i < SIZE; ++i) + q.add(new NanoDelay(1000000L * (SIZE - i))); + + long last = 0; + for (int i = 0; i < SIZE; ++i) { + NanoDelay e = q.take(); + long tt = e.getTriggerTime(); + assertTrue(System.nanoTime() - tt >= 0); + if (i != 0) + assertTrue(tt >= last); + last = tt; } + assertTrue(q.isEmpty()); + } - public boolean equals(Object other) { - return ((NanoDelay)other).trigger == trigger; - } - public boolean equals(NanoDelay other) { - return ((NanoDelay)other).trigger == trigger; - } + /** + * peek of a non-empty queue returns non-null even if not expired + */ + public void testPeekDelayed() { + DelayQueue q = new DelayQueue<>(); + q.add(new NanoDelay(Long.MAX_VALUE)); + assertNotNull(q.peek()); + } - public long getDelay(TimeUnit unit) { - long n = trigger - System.nanoTime(); - return unit.convert(n, TimeUnit.NANOSECONDS); - } + /** + * poll of a non-empty queue returns null if no expired elements. + */ + public void testPollDelayed() { + DelayQueue q = new DelayQueue<>(); + q.add(new NanoDelay(Long.MAX_VALUE)); + assertNull(q.poll()); + } - public long getTriggerTime() { - return trigger; - } + /** + * timed poll of a non-empty queue returns null if no expired elements. + */ + public void testTimedPollDelayed() throws InterruptedException { + DelayQueue q = new DelayQueue<>(); + q.add(new NanoDelay(LONG_DELAY_MS * 1000000L)); + long startTime = System.nanoTime(); + assertNull(q.poll(timeoutMillis(), MILLISECONDS)); + assertTrue(millisElapsedSince(startTime) >= timeoutMillis()); + } - public String toString() { - return String.valueOf(trigger); - } + /** + * drainTo(c) empties queue into another collection c + */ + public void testDrainTo() { + DelayQueue q = new DelayQueue<>(); + PDelay[] elems = new PDelay[SIZE]; + for (int i = 0; i < SIZE; ++i) { + elems[i] = new PDelay(i); + q.add(elems[i]); + } + ArrayList l = new ArrayList<>(); + q.drainTo(l); + mustEqual(0, q.size()); + for (int i = 0; i < SIZE; ++i) + mustEqual(elems[i], l.get(i)); + q.add(elems[0]); + q.add(elems[1]); + assertFalse(q.isEmpty()); + assertTrue(q.contains(elems[0])); + assertTrue(q.contains(elems[1])); + l.clear(); + q.drainTo(l); + mustEqual(0, q.size()); + mustEqual(2, l.size()); + for (int i = 0; i < 2; ++i) + mustEqual(elems[i], l.get(i)); } - public void testDelay() { - DelayQueue q = new DelayQueue(); - NanoDelay[] elements = new NanoDelay[N]; - for (int i = 0; i < N; ++i) { - elements[i] = new NanoDelay(1000000000L + 1000000L * (N - i)); - } - for (int i = 0; i < N; ++i) { - q.add(elements[i]); - } + /** + * drainTo empties queue + */ + public void testDrainToWithActivePut() throws InterruptedException { + final DelayQueue q = populatedQueue(SIZE); + Thread t = new Thread(new CheckedRunnable() { + public void realRun() { + q.put(new PDelay(SIZE + 1)); + }}); - try { - long last = 0; - for (int i = 0; i < N; ++i) { - NanoDelay e = (NanoDelay)(q.take()); - long tt = e.getTriggerTime(); - assertTrue(tt <= System.nanoTime()); - if (i != 0) - assertTrue(tt >= last); - last = tt; - } - } - catch(InterruptedException ie) { - fail("Unexpected Exception"); + t.start(); + ArrayList l = new ArrayList<>(); + q.drainTo(l); + assertTrue(l.size() >= SIZE); + t.join(); + assertTrue(q.size() + l.size() >= SIZE); + } + + /** + * drainTo(c, n) empties first min(n, size) elements of queue into c + */ + public void testDrainToN() { + for (int i = 0; i < SIZE + 2; ++i) { + DelayQueue q = populatedQueue(SIZE); + ArrayList l = new ArrayList<>(); + q.drainTo(l, i); + int k = (i < SIZE) ? i : SIZE; + mustEqual(SIZE - k, q.size()); + mustEqual(k, l.size()); } } + /** + * remove(null), contains(null) always return false + */ + public void testNeverContainsNull() { + Collection q = populatedQueue(SIZE); + assertFalse(q.contains(null)); + assertFalse(q.remove(null)); + } }