test/tck/DelayQueueTest.java

/*
 * 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 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) {
        main(suite(), args);
    }

    public static Test suite() {
        return newTestSuite(DelayQueueTest.class,
                            new Generic().testSuite());
    }

    /**
     * A delayed implementation for testing.
     * Most tests use Pseudodelays, where delays are all elapsed
     * (so, no blocking solely for delays) but are still ordered
     */
    static class PDelay implements Delayed {
        int pseudodelay;
        PDelay(int i) { pseudodelay = i; }
        public int compareTo(PDelay other) {
            int a = this.pseudodelay;
            int b = other.pseudodelay;
            return (a < b) ? -1 : (a > b) ? 1 : 0;
        }
        public int compareTo(Delayed y) {
            return compareTo((PDelay)y);
        }
        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 Integer.MIN_VALUE + pseudodelay;
        }
        public String toString() {
            return String.valueOf(pseudodelay);
        }
    }

    /**
     * Delayed implementation that actually delays
     */
    static class NanoDelay implements Delayed {
        long trigger;
        NanoDelay(long i) {
            trigger = System.nanoTime() + i;
        }
        public int compareTo(NanoDelay y) {
            long i = trigger;
            long j = y.trigger;
            if (i < j) return -1;
            if (i > j) return 1;
            return 0;
        }

        public int compareTo(Delayed y) {
            return compareTo((NanoDelay)y);
        }

        public boolean equals(Object other) {
            return (other instanceof NanoDelay) &&
                this.trigger == ((NanoDelay)other).trigger;
        }

        // suppress [overrides] javac warning
        public int hashCode() { return (int) trigger; }

        public long getDelay(TimeUnit unit) {
            long n = trigger - System.nanoTime();
            return unit.convert(n, TimeUnit.NANOSECONDS);
        }

        public long getTriggerTime() {
            return trigger;
        }

        public String toString() {
            return String.valueOf(trigger);
        }
    }

    /**
     * Returns a new queue of given size containing consecutive
     * PDelays 0 ... n.
     */
    private DelayQueue<PDelay> populatedQueue(int n) {
        DelayQueue<PDelay> q = new DelayQueue<PDelay>();
        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)));
        assertFalse(q.isEmpty());
        assertEquals(Integer.MAX_VALUE, q.remainingCapacity());
        assertEquals(n, q.size());
        return q;
    }

    /**
     * A new queue has unbounded capacity
     */
    public void testConstructor1() {
        assertEquals(Integer.MAX_VALUE, new DelayQueue().remainingCapacity());
    }

    /**
     * Initializing from null Collection throws NPE
     */
    public void testConstructor3() {
        try {
            new DelayQueue(null);
            shouldThrow();
        } catch (NullPointerException success) {}
    }

    /**
     * Initializing from Collection of null elements throws NPE
     */
    public void testConstructor4() {
        try {
            new DelayQueue(Arrays.asList(new PDelay[SIZE]));
            shouldThrow();
        } 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) {}
    }

    /**
     * Queue contains all elements of collection used to initialize
     */
    public void testConstructor6() {
        PDelay[] ints = new PDelay[SIZE];
        for (int i = 0; i < SIZE; ++i)
            ints[i] = new PDelay(i);
        DelayQueue q = new DelayQueue(Arrays.asList(ints));
        for (int i = 0; i < SIZE; ++i)
            assertEquals(ints[i], q.poll());
    }

    /**
     * isEmpty is true before add, false after
     */
    public void testEmpty() {
        DelayQueue q = new DelayQueue();
        assertTrue(q.isEmpty());
        assertEquals(Integer.MAX_VALUE, q.remainingCapacity());
        q.add(new PDelay(1));
        assertFalse(q.isEmpty());
        q.add(new PDelay(2));
        q.remove();
        q.remove();
        assertTrue(q.isEmpty());
    }

    /**
     * remainingCapacity() always returns Integer.MAX_VALUE
     */
    public void testRemainingCapacity() {
        BlockingQueue q = populatedQueue(SIZE);
        for (int i = 0; i < SIZE; ++i) {
            assertEquals(Integer.MAX_VALUE, q.remainingCapacity());
            assertEquals(SIZE - i, q.size());
            assertTrue(q.remove() instanceof PDelay);
        }
        for (int i = 0; i < SIZE; ++i) {
            assertEquals(Integer.MAX_VALUE, q.remainingCapacity());
            assertEquals(i, q.size());
            assertTrue(q.add(new PDelay(i)));
        }
    }

    /**
     * offer non-null succeeds
     */
    public void testOffer() {
        DelayQueue q = new DelayQueue();
        assertTrue(q.offer(new PDelay(0)));
        assertTrue(q.offer(new PDelay(1)));
    }

    /**
     * add succeeds
     */
    public void testAdd() {
        DelayQueue q = new DelayQueue();
        for (int i = 0; i < SIZE; ++i) {
            assertEquals(i, q.size());
            assertTrue(q.add(new PDelay(i)));
        }
    }

    /**
     * addAll(this) throws IAE
     */
    public void testAddAllSelf() {
        DelayQueue q = populatedQueue(SIZE);
        try {
            q.addAll(q);
            shouldThrow();
        } catch (IllegalArgumentException success) {}
    }

    /**
     * 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) {}
    }

    /**
     * Queue contains all elements of successful addAll
     */
    public void testAddAll5() {
        PDelay[] empty = new PDelay[0];
        PDelay[] ints = new PDelay[SIZE];
        for (int i = SIZE - 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 < SIZE; ++i)
            assertEquals(ints[i], q.poll());
    }

    /**
     * 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));
        }
        assertEquals(SIZE, q.size());
    }

    /**
     * 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);
        assertEquals(4, q.size());
    }

    /**
     * timed offer does not time 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);
    }

    /**
     * take retrieves elements in priority order
     */
    public void testTake() throws InterruptedException {
        DelayQueue q = populatedQueue(SIZE);
        for (int i = 0; i < SIZE; ++i) {
            assertEquals(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) {
                    assertEquals(new PDelay(i), ((PDelay)q.take()));
                }

                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);
        assertThreadStaysAlive(t);
        t.interrupt();
        awaitTermination(t);
    }

    /**
     * poll succeeds unless empty
     */
    public void testPoll() {
        DelayQueue q = populatedQueue(SIZE);
        for (int i = 0; i < SIZE; ++i) {
            assertEquals(new PDelay(i), q.poll());
        }
        assertNull(q.poll());
    }

    /**
     * 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) {
            assertEquals(new PDelay(i), q.poll(0, MILLISECONDS));
        }
        assertNull(q.poll(0, MILLISECONDS));
    }

    /**
     * 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();
            assertEquals(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 {
                long startTime = System.nanoTime();
                for (int i = 0; i < SIZE; ++i) {
                    assertEquals(new PDelay(i),
                                 ((PDelay)q.poll(LONG_DELAY_MS, MILLISECONDS)));
                }

                Thread.currentThread().interrupt();
                try {
                    q.poll(LONG_DELAY_MS, MILLISECONDS);
                    shouldThrow();
                } catch (InterruptedException success) {}
                assertFalse(Thread.interrupted());

                pleaseInterrupt.countDown();
                try {
                    q.poll(LONG_DELAY_MS, MILLISECONDS);
                    shouldThrow();
                } catch (InterruptedException success) {}
                assertFalse(Thread.interrupted());
                assertTrue(millisElapsedSince(startTime) < LONG_DELAY_MS);
            }});

        await(pleaseInterrupt);
        assertThreadStaysAlive(t);
        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) {
            assertEquals(new PDelay(i), q.peek());
            assertEquals(new PDelay(i), q.poll());
            if (q.isEmpty())
                assertNull(q.peek());
            else
                assertFalse(new PDelay(i).equals(q.peek()));
        }
        assertNull(q.peek());
    }

    /**
     * element returns next element, or throws NSEE if empty
     */
    public void testElement() {
        DelayQueue q = populatedQueue(SIZE);
        for (int i = 0; i < SIZE; ++i) {
            assertEquals(new PDelay(i), q.element());
            q.poll();
        }
        try {
            q.element();
            shouldThrow();
        } catch (NoSuchElementException success) {}
    }

    /**
     * remove removes next element, or throws NSEE if empty
     */
    public void testRemove() {
        DelayQueue q = populatedQueue(SIZE);
        for (int i = 0; i < SIZE; ++i) {
            assertEquals(new PDelay(i), q.remove());
        }
        try {
            q.remove();
            shouldThrow();
        } catch (NoSuchElementException success) {}
    }

    /**
     * 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)));
        }
    }

    /**
     * clear removes all elements
     */
    public void testClear() {
        DelayQueue q = populatedQueue(SIZE);
        q.clear();
        assertTrue(q.isEmpty());
        assertEquals(0, q.size());
        assertEquals(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());
    }

    /**
     * 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));
        }
        assertTrue(p.containsAll(q));
    }

    /**
     * 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);
            else
                assertTrue(changed);

            assertTrue(q.containsAll(p));
            assertEquals(SIZE - i, q.size());
            p.remove();
        }
    }

    /**
     * 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(SIZE - i, q.size());
            for (int j = 0; j < i; ++j) {
                PDelay x = (PDelay)(p.remove());
                assertFalse(q.contains(x));
            }
        }
    }

    /**
     * toArray contains all elements
     */
    public void testToArray() throws InterruptedException {
        DelayQueue q = populatedQueue(SIZE);
        Object[] o = q.toArray();
        Arrays.sort(o);
        for (int i = 0; i < o.length; i++)
            assertSame(o[i], q.take());
    }

    /**
     * toArray(a) contains all elements
     */
    public void testToArray2() {
        DelayQueue<PDelay> q = populatedQueue(SIZE);
        PDelay[] ints = new PDelay[SIZE];
        PDelay[] array = q.toArray(ints);
        assertSame(ints, array);
        Arrays.sort(ints);
        for (int i = 0; i < ints.length; i++)
            assertSame(ints[i], q.remove());
    }

    /**
     * toArray(incompatible array type) throws ArrayStoreException
     */
    public void testToArray1_BadArg() {
        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()) {
            assertTrue(q.contains(it.next()));
            ++i;
        }
        assertEquals(i, SIZE);
        assertIteratorExhausted(it);
    }

    /**
     * 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();
        it.next();
        it.remove();
        it = q.iterator();
        assertEquals(new PDelay(2), it.next());
        assertEquals(new PDelay(3), it.next());
        assertFalse(it.hasNext());
    }

    /**
     * toString contains toStrings of elements
     */
    public void testToString() {
        DelayQueue q = populatedQueue(SIZE);
        String s = q.toString();
        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);
                }});

            executor.execute(new CheckedRunnable() {
                public void realRun() throws InterruptedException {
                    threadsStarted.await();
                    q.put(new PDelay(1));
                }});
        }
    }

    /**
     * Delayed actions do not occur until their delay elapses
     */
    public void testDelay() throws InterruptedException {
        DelayQueue<NanoDelay> q = new DelayQueue<NanoDelay>();
        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());
    }

    /**
     * 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());
    }

    /**
     * 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());
    }

    /**
     * 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));
        assertNull(q.poll(timeoutMillis(), MILLISECONDS));
    }

    /**
     * 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);
        assertEquals(0, q.size());
        for (int i = 0; i < SIZE; ++i)
            assertEquals(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);
        assertEquals(0, q.size());
        assertEquals(2, l.size());
        for (int i = 0; i < 2; ++i)
            assertEquals(elems[i], l.get(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));
            }});

        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;
            assertEquals(SIZE - k, q.size());
            assertEquals(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));
    }
}
Revision:	1.77
Committed:	Thu Sep 15 17:07:16 2016 UTC (7 years, 7 months ago) by jsr166
Branch:	MAIN
Changes since 1.76:	+2 -4 lines
Log Message:	fix errorprone NonOverridingEquals warning
#	Content
1	/*
2	* Written by Doug Lea with assistance from members of JCP JSR-166
3	* Expert Group and released to the public domain, as explained at
4	* http://creativecommons.org/publicdomain/zero/1.0/
5	* Other contributors include Andrew Wright, Jeffrey Hayes,
6	* Pat Fisher, Mike Judd.
7	*/
8
9	import static java.util.concurrent.TimeUnit.MILLISECONDS;
10
11	import java.util.ArrayList;
12	import java.util.Arrays;
13	import java.util.Collection;
14	import java.util.Iterator;
15	import java.util.NoSuchElementException;
16	import java.util.concurrent.BlockingQueue;
17	import java.util.concurrent.CountDownLatch;
18	import java.util.concurrent.Delayed;
19	import java.util.concurrent.DelayQueue;
20	import java.util.concurrent.Executors;
21	import java.util.concurrent.ExecutorService;
22	import java.util.concurrent.TimeUnit;
23
24	import junit.framework.Test;
25
26	public class DelayQueueTest extends JSR166TestCase {
27
28	public static class Generic extends BlockingQueueTest {
29	protected BlockingQueue emptyCollection() {
30	return new DelayQueue();
31	}
32	protected PDelay makeElement(int i) {
33	return new PDelay(i);
34	}
35	}
36
37	public static void main(String[] args) {
38	main(suite(), args);
39	}
40
41	public static Test suite() {
42	return newTestSuite(DelayQueueTest.class,
43	new Generic().testSuite());
44	}
45
46	/**
47	* A delayed implementation for testing.
48	* Most tests use Pseudodelays, where delays are all elapsed
49	* (so, no blocking solely for delays) but are still ordered
50	*/
51	static class PDelay implements Delayed {
52	int pseudodelay;
53	PDelay(int i) { pseudodelay = i; }
54	public int compareTo(PDelay other) {
55	int a = this.pseudodelay;
56	int b = other.pseudodelay;
57	return (a < b) ? -1 : (a > b) ? 1 : 0;
58	}
59	public int compareTo(Delayed y) {
60	return compareTo((PDelay)y);
61	}
62	public boolean equals(Object other) {
63	return (other instanceof PDelay) &&
64	this.pseudodelay == ((PDelay)other).pseudodelay;
65	}
66	// suppress [overrides] javac warning
67	public int hashCode() { return pseudodelay; }
68	public long getDelay(TimeUnit ignore) {
69	return Integer.MIN_VALUE + pseudodelay;
70	}
71	public String toString() {
72	return String.valueOf(pseudodelay);
73	}
74	}
75
76	/**
77	* Delayed implementation that actually delays
78	*/
79	static class NanoDelay implements Delayed {
80	long trigger;
81	NanoDelay(long i) {
82	trigger = System.nanoTime() + i;
83	}
84	public int compareTo(NanoDelay y) {
85	long i = trigger;
86	long j = y.trigger;
87	if (i < j) return -1;
88	if (i > j) return 1;
89	return 0;
90	}
91
92	public int compareTo(Delayed y) {
93	return compareTo((NanoDelay)y);
94	}
95
96	public boolean equals(Object other) {
97	return (other instanceof NanoDelay) &&
98	this.trigger == ((NanoDelay)other).trigger;
99	}
100
101	// suppress [overrides] javac warning
102	public int hashCode() { return (int) trigger; }
103
104	public long getDelay(TimeUnit unit) {
105	long n = trigger - System.nanoTime();
106	return unit.convert(n, TimeUnit.NANOSECONDS);
107	}
108
109	public long getTriggerTime() {
110	return trigger;
111	}
112
113	public String toString() {
114	return String.valueOf(trigger);
115	}
116	}
117
118	/**
119	* Returns a new queue of given size containing consecutive
120	* PDelays 0 ... n.
121	*/
122	private DelayQueue<PDelay> populatedQueue(int n) {
123	DelayQueue<PDelay> q = new DelayQueue<PDelay>();
124	assertTrue(q.isEmpty());
125	for (int i = n - 1; i >= 0; i -= 2)
126	assertTrue(q.offer(new PDelay(i)));
127	for (int i = (n & 1); i < n; i += 2)
128	assertTrue(q.offer(new PDelay(i)));
129	assertFalse(q.isEmpty());
130	assertEquals(Integer.MAX_VALUE, q.remainingCapacity());
131	assertEquals(n, q.size());
132	return q;
133	}
134
135	/**
136	* A new queue has unbounded capacity
137	*/
138	public void testConstructor1() {
139	assertEquals(Integer.MAX_VALUE, new DelayQueue().remainingCapacity());
140	}
141
142	/**
143	* Initializing from null Collection throws NPE
144	*/
145	public void testConstructor3() {
146	try {
147	new DelayQueue(null);
148	shouldThrow();
149	} catch (NullPointerException success) {}
150	}
151
152	/**
153	* Initializing from Collection of null elements throws NPE
154	*/
155	public void testConstructor4() {
156	try {
157	new DelayQueue(Arrays.asList(new PDelay[SIZE]));
158	shouldThrow();
159	} catch (NullPointerException success) {}
160	}
161
162	/**
163	* Initializing from Collection with some null elements throws NPE
164	*/
165	public void testConstructor5() {
166	PDelay[] a = new PDelay[SIZE];
167	for (int i = 0; i < SIZE - 1; ++i)
168	a[i] = new PDelay(i);
169	try {
170	new DelayQueue(Arrays.asList(a));
171	shouldThrow();
172	} catch (NullPointerException success) {}
173	}
174
175	/**
176	* Queue contains all elements of collection used to initialize
177	*/
178	public void testConstructor6() {
179	PDelay[] ints = new PDelay[SIZE];
180	for (int i = 0; i < SIZE; ++i)
181	ints[i] = new PDelay(i);
182	DelayQueue q = new DelayQueue(Arrays.asList(ints));
183	for (int i = 0; i < SIZE; ++i)
184	assertEquals(ints[i], q.poll());
185	}
186
187	/**
188	* isEmpty is true before add, false after
189	*/
190	public void testEmpty() {
191	DelayQueue q = new DelayQueue();
192	assertTrue(q.isEmpty());
193	assertEquals(Integer.MAX_VALUE, q.remainingCapacity());
194	q.add(new PDelay(1));
195	assertFalse(q.isEmpty());
196	q.add(new PDelay(2));
197	q.remove();
198	q.remove();
199	assertTrue(q.isEmpty());
200	}
201
202	/**
203	* remainingCapacity() always returns Integer.MAX_VALUE
204	*/
205	public void testRemainingCapacity() {
206	BlockingQueue q = populatedQueue(SIZE);
207	for (int i = 0; i < SIZE; ++i) {
208	assertEquals(Integer.MAX_VALUE, q.remainingCapacity());
209	assertEquals(SIZE - i, q.size());
210	assertTrue(q.remove() instanceof PDelay);
211	}
212	for (int i = 0; i < SIZE; ++i) {
213	assertEquals(Integer.MAX_VALUE, q.remainingCapacity());
214	assertEquals(i, q.size());
215	assertTrue(q.add(new PDelay(i)));
216	}
217	}
218
219	/**
220	* offer non-null succeeds
221	*/
222	public void testOffer() {
223	DelayQueue q = new DelayQueue();
224	assertTrue(q.offer(new PDelay(0)));
225	assertTrue(q.offer(new PDelay(1)));
226	}
227
228	/**
229	* add succeeds
230	*/
231	public void testAdd() {
232	DelayQueue q = new DelayQueue();
233	for (int i = 0; i < SIZE; ++i) {
234	assertEquals(i, q.size());
235	assertTrue(q.add(new PDelay(i)));
236	}
237	}
238
239	/**
240	* addAll(this) throws IAE
241	*/
242	public void testAddAllSelf() {
243	DelayQueue q = populatedQueue(SIZE);
244	try {
245	q.addAll(q);
246	shouldThrow();
247	} catch (IllegalArgumentException success) {}
248	}
249
250	/**
251	* addAll of a collection with any null elements throws NPE after
252	* possibly adding some elements
253	*/
254	public void testAddAll3() {
255	DelayQueue q = new DelayQueue();
256	PDelay[] a = new PDelay[SIZE];
257	for (int i = 0; i < SIZE - 1; ++i)
258	a[i] = new PDelay(i);
259	try {
260	q.addAll(Arrays.asList(a));
261	shouldThrow();
262	} catch (NullPointerException success) {}
263	}
264
265	/**
266	* Queue contains all elements of successful addAll
267	*/
268	public void testAddAll5() {
269	PDelay[] empty = new PDelay[0];
270	PDelay[] ints = new PDelay[SIZE];
271	for (int i = SIZE - 1; i >= 0; --i)
272	ints[i] = new PDelay(i);
273	DelayQueue q = new DelayQueue();
274	assertFalse(q.addAll(Arrays.asList(empty)));
275	assertTrue(q.addAll(Arrays.asList(ints)));
276	for (int i = 0; i < SIZE; ++i)
277	assertEquals(ints[i], q.poll());
278	}
279
280	/**
281	* all elements successfully put are contained
282	*/
283	public void testPut() {
284	DelayQueue q = new DelayQueue();
285	for (int i = 0; i < SIZE; ++i) {
286	PDelay x = new PDelay(i);
287	q.put(x);
288	assertTrue(q.contains(x));
289	}
290	assertEquals(SIZE, q.size());
291	}
292
293	/**
294	* put doesn't block waiting for take
295	*/
296	public void testPutWithTake() throws InterruptedException {
297	final DelayQueue q = new DelayQueue();
298	Thread t = newStartedThread(new CheckedRunnable() {
299	public void realRun() {
300	q.put(new PDelay(0));
301	q.put(new PDelay(0));
302	q.put(new PDelay(0));
303	q.put(new PDelay(0));
304	}});
305
306	awaitTermination(t);
307	assertEquals(4, q.size());
308	}
309
310	/**
311	* timed offer does not time out
312	*/
313	public void testTimedOffer() throws InterruptedException {
314	final DelayQueue q = new DelayQueue();
315	Thread t = newStartedThread(new CheckedRunnable() {
316	public void realRun() throws InterruptedException {
317	q.put(new PDelay(0));
318	q.put(new PDelay(0));
319	assertTrue(q.offer(new PDelay(0), SHORT_DELAY_MS, MILLISECONDS));
320	assertTrue(q.offer(new PDelay(0), LONG_DELAY_MS, MILLISECONDS));
321	}});
322
323	awaitTermination(t);
324	}
325
326	/**
327	* take retrieves elements in priority order
328	*/
329	public void testTake() throws InterruptedException {
330	DelayQueue q = populatedQueue(SIZE);
331	for (int i = 0; i < SIZE; ++i) {
332	assertEquals(new PDelay(i), q.take());
333	}
334	}
335
336	/**
337	* Take removes existing elements until empty, then blocks interruptibly
338	*/
339	public void testBlockingTake() throws InterruptedException {
340	final DelayQueue q = populatedQueue(SIZE);
341	final CountDownLatch pleaseInterrupt = new CountDownLatch(1);
342	Thread t = newStartedThread(new CheckedRunnable() {
343	public void realRun() throws InterruptedException {
344	for (int i = 0; i < SIZE; ++i) {
345	assertEquals(new PDelay(i), ((PDelay)q.take()));
346	}
347
348	Thread.currentThread().interrupt();
349	try {
350	q.take();
351	shouldThrow();
352	} catch (InterruptedException success) {}
353	assertFalse(Thread.interrupted());
354
355	pleaseInterrupt.countDown();
356	try {
357	q.take();
358	shouldThrow();
359	} catch (InterruptedException success) {}
360	assertFalse(Thread.interrupted());
361	}});
362
363	await(pleaseInterrupt);
364	assertThreadStaysAlive(t);
365	t.interrupt();
366	awaitTermination(t);
367	}
368
369	/**
370	* poll succeeds unless empty
371	*/
372	public void testPoll() {
373	DelayQueue q = populatedQueue(SIZE);
374	for (int i = 0; i < SIZE; ++i) {
375	assertEquals(new PDelay(i), q.poll());
376	}
377	assertNull(q.poll());
378	}
379
380	/**
381	* timed poll with zero timeout succeeds when non-empty, else times out
382	*/
383	public void testTimedPoll0() throws InterruptedException {
384	DelayQueue q = populatedQueue(SIZE);
385	for (int i = 0; i < SIZE; ++i) {
386	assertEquals(new PDelay(i), q.poll(0, MILLISECONDS));
387	}
388	assertNull(q.poll(0, MILLISECONDS));
389	}
390
391	/**
392	* timed poll with nonzero timeout succeeds when non-empty, else times out
393	*/
394	public void testTimedPoll() throws InterruptedException {
395	DelayQueue q = populatedQueue(SIZE);
396	for (int i = 0; i < SIZE; ++i) {
397	long startTime = System.nanoTime();
398	assertEquals(new PDelay(i), q.poll(LONG_DELAY_MS, MILLISECONDS));
399	assertTrue(millisElapsedSince(startTime) < LONG_DELAY_MS);
400	}
401	long startTime = System.nanoTime();
402	assertNull(q.poll(timeoutMillis(), MILLISECONDS));
403	assertTrue(millisElapsedSince(startTime) >= timeoutMillis());
404	checkEmpty(q);
405	}
406
407	/**
408	* Interrupted timed poll throws InterruptedException instead of
409	* returning timeout status
410	*/
411	public void testInterruptedTimedPoll() throws InterruptedException {
412	final CountDownLatch pleaseInterrupt = new CountDownLatch(1);
413	final DelayQueue q = populatedQueue(SIZE);
414	Thread t = newStartedThread(new CheckedRunnable() {
415	public void realRun() throws InterruptedException {
416	long startTime = System.nanoTime();
417	for (int i = 0; i < SIZE; ++i) {
418	assertEquals(new PDelay(i),
419	((PDelay)q.poll(LONG_DELAY_MS, MILLISECONDS)));
420	}
421
422	Thread.currentThread().interrupt();
423	try {
424	q.poll(LONG_DELAY_MS, MILLISECONDS);
425	shouldThrow();
426	} catch (InterruptedException success) {}
427	assertFalse(Thread.interrupted());
428
429	pleaseInterrupt.countDown();
430	try {
431	q.poll(LONG_DELAY_MS, MILLISECONDS);
432	shouldThrow();
433	} catch (InterruptedException success) {}
434	assertFalse(Thread.interrupted());
435	assertTrue(millisElapsedSince(startTime) < LONG_DELAY_MS);
436	}});
437
438	await(pleaseInterrupt);
439	assertThreadStaysAlive(t);
440	t.interrupt();
441	awaitTermination(t);
442	checkEmpty(q);
443	}
444
445	/**
446	* peek returns next element, or null if empty
447	*/
448	public void testPeek() {
449	DelayQueue q = populatedQueue(SIZE);
450	for (int i = 0; i < SIZE; ++i) {
451	assertEquals(new PDelay(i), q.peek());
452	assertEquals(new PDelay(i), q.poll());
453	if (q.isEmpty())
454	assertNull(q.peek());
455	else
456	assertFalse(new PDelay(i).equals(q.peek()));
457	}
458	assertNull(q.peek());
459	}
460
461	/**
462	* element returns next element, or throws NSEE if empty
463	*/
464	public void testElement() {
465	DelayQueue q = populatedQueue(SIZE);
466	for (int i = 0; i < SIZE; ++i) {
467	assertEquals(new PDelay(i), q.element());
468	q.poll();
469	}
470	try {
471	q.element();
472	shouldThrow();
473	} catch (NoSuchElementException success) {}
474	}
475
476	/**
477	* remove removes next element, or throws NSEE if empty
478	*/
479	public void testRemove() {
480	DelayQueue q = populatedQueue(SIZE);
481	for (int i = 0; i < SIZE; ++i) {
482	assertEquals(new PDelay(i), q.remove());
483	}
484	try {
485	q.remove();
486	shouldThrow();
487	} catch (NoSuchElementException success) {}
488	}
489
490	/**
491	* contains(x) reports true when elements added but not yet removed
492	*/
493	public void testContains() {
494	DelayQueue q = populatedQueue(SIZE);
495	for (int i = 0; i < SIZE; ++i) {
496	assertTrue(q.contains(new PDelay(i)));
497	q.poll();
498	assertFalse(q.contains(new PDelay(i)));
499	}
500	}
501
502	/**
503	* clear removes all elements
504	*/
505	public void testClear() {
506	DelayQueue q = populatedQueue(SIZE);
507	q.clear();
508	assertTrue(q.isEmpty());
509	assertEquals(0, q.size());
510	assertEquals(Integer.MAX_VALUE, q.remainingCapacity());
511	PDelay x = new PDelay(1);
512	q.add(x);
513	assertFalse(q.isEmpty());
514	assertTrue(q.contains(x));
515	q.clear();
516	assertTrue(q.isEmpty());
517	}
518
519	/**
520	* containsAll(c) is true when c contains a subset of elements
521	*/
522	public void testContainsAll() {
523	DelayQueue q = populatedQueue(SIZE);
524	DelayQueue p = new DelayQueue();
525	for (int i = 0; i < SIZE; ++i) {
526	assertTrue(q.containsAll(p));
527	assertFalse(p.containsAll(q));
528	p.add(new PDelay(i));
529	}
530	assertTrue(p.containsAll(q));
531	}
532
533	/**
534	* retainAll(c) retains only those elements of c and reports true if changed
535	*/
536	public void testRetainAll() {
537	DelayQueue q = populatedQueue(SIZE);
538	DelayQueue p = populatedQueue(SIZE);
539	for (int i = 0; i < SIZE; ++i) {
540	boolean changed = q.retainAll(p);
541	if (i == 0)
542	assertFalse(changed);
543	else
544	assertTrue(changed);
545
546	assertTrue(q.containsAll(p));
547	assertEquals(SIZE - i, q.size());
548	p.remove();
549	}
550	}
551
552	/**
553	* removeAll(c) removes only those elements of c and reports true if changed
554	*/
555	public void testRemoveAll() {
556	for (int i = 1; i < SIZE; ++i) {
557	DelayQueue q = populatedQueue(SIZE);
558	DelayQueue p = populatedQueue(i);
559	assertTrue(q.removeAll(p));
560	assertEquals(SIZE - i, q.size());
561	for (int j = 0; j < i; ++j) {
562	PDelay x = (PDelay)(p.remove());
563	assertFalse(q.contains(x));
564	}
565	}
566	}
567
568	/**
569	* toArray contains all elements
570	*/
571	public void testToArray() throws InterruptedException {
572	DelayQueue q = populatedQueue(SIZE);
573	Object[] o = q.toArray();
574	Arrays.sort(o);
575	for (int i = 0; i < o.length; i++)
576	assertSame(o[i], q.take());
577	}
578
579	/**
580	* toArray(a) contains all elements
581	*/
582	public void testToArray2() {
583	DelayQueue<PDelay> q = populatedQueue(SIZE);
584	PDelay[] ints = new PDelay[SIZE];
585	PDelay[] array = q.toArray(ints);
586	assertSame(ints, array);
587	Arrays.sort(ints);
588	for (int i = 0; i < ints.length; i++)
589	assertSame(ints[i], q.remove());
590	}
591
592	/**
593	* toArray(incompatible array type) throws ArrayStoreException
594	*/
595	public void testToArray1_BadArg() {
596	DelayQueue q = populatedQueue(SIZE);
597	try {
598	q.toArray(new String[10]);
599	shouldThrow();
600	} catch (ArrayStoreException success) {}
601	}
602
603	/**
604	* iterator iterates through all elements
605	*/
606	public void testIterator() {
607	DelayQueue q = populatedQueue(SIZE);
608	int i = 0;
609	Iterator it = q.iterator();
610	while (it.hasNext()) {
611	assertTrue(q.contains(it.next()));
612	++i;
613	}
614	assertEquals(i, SIZE);
615	assertIteratorExhausted(it);
616	}
617
618	/**
619	* iterator of empty collection has no elements
620	*/
621	public void testEmptyIterator() {
622	assertIteratorExhausted(new DelayQueue().iterator());
623	}
624
625	/**
626	* iterator.remove removes current element
627	*/
628	public void testIteratorRemove() {
629	final DelayQueue q = new DelayQueue();
630	q.add(new PDelay(2));
631	q.add(new PDelay(1));
632	q.add(new PDelay(3));
633	Iterator it = q.iterator();
634	it.next();
635	it.remove();
636	it = q.iterator();
637	assertEquals(new PDelay(2), it.next());
638	assertEquals(new PDelay(3), it.next());
639	assertFalse(it.hasNext());
640	}
641
642	/**
643	* toString contains toStrings of elements
644	*/
645	public void testToString() {
646	DelayQueue q = populatedQueue(SIZE);
647	String s = q.toString();
648	for (Object e : q)
649	assertTrue(s.contains(e.toString()));
650	}
651
652	/**
653	* timed poll transfers elements across Executor tasks
654	*/
655	public void testPollInExecutor() {
656	final DelayQueue q = new DelayQueue();
657	final CheckedBarrier threadsStarted = new CheckedBarrier(2);
658	final ExecutorService executor = Executors.newFixedThreadPool(2);
659	try (PoolCleaner cleaner = cleaner(executor)) {
660	executor.execute(new CheckedRunnable() {
661	public void realRun() throws InterruptedException {
662	assertNull(q.poll());
663	threadsStarted.await();
664	assertNotNull(q.poll(LONG_DELAY_MS, MILLISECONDS));
665	checkEmpty(q);
666	}});
667
668	executor.execute(new CheckedRunnable() {
669	public void realRun() throws InterruptedException {
670	threadsStarted.await();
671	q.put(new PDelay(1));
672	}});
673	}
674	}
675
676	/**
677	* Delayed actions do not occur until their delay elapses
678	*/
679	public void testDelay() throws InterruptedException {
680	DelayQueue<NanoDelay> q = new DelayQueue<NanoDelay>();
681	for (int i = 0; i < SIZE; ++i)
682	q.add(new NanoDelay(1000000L * (SIZE - i)));
683
684	long last = 0;
685	for (int i = 0; i < SIZE; ++i) {
686	NanoDelay e = q.take();
687	long tt = e.getTriggerTime();
688	assertTrue(System.nanoTime() - tt >= 0);
689	if (i != 0)
690	assertTrue(tt >= last);
691	last = tt;
692	}
693	assertTrue(q.isEmpty());
694	}
695
696	/**
697	* peek of a non-empty queue returns non-null even if not expired
698	*/
699	public void testPeekDelayed() {
700	DelayQueue q = new DelayQueue();
701	q.add(new NanoDelay(Long.MAX_VALUE));
702	assertNotNull(q.peek());
703	}
704
705	/**
706	* poll of a non-empty queue returns null if no expired elements.
707	*/
708	public void testPollDelayed() {
709	DelayQueue q = new DelayQueue();
710	q.add(new NanoDelay(Long.MAX_VALUE));
711	assertNull(q.poll());
712	}
713
714	/**
715	* timed poll of a non-empty queue returns null if no expired elements.
716	*/
717	public void testTimedPollDelayed() throws InterruptedException {
718	DelayQueue q = new DelayQueue();
719	q.add(new NanoDelay(LONG_DELAY_MS * 1000000L));
720	assertNull(q.poll(timeoutMillis(), MILLISECONDS));
721	}
722
723	/**
724	* drainTo(c) empties queue into another collection c
725	*/
726	public void testDrainTo() {
727	DelayQueue q = new DelayQueue();
728	PDelay[] elems = new PDelay[SIZE];
729	for (int i = 0; i < SIZE; ++i) {
730	elems[i] = new PDelay(i);
731	q.add(elems[i]);
732	}
733	ArrayList l = new ArrayList();
734	q.drainTo(l);
735	assertEquals(0, q.size());
736	for (int i = 0; i < SIZE; ++i)
737	assertEquals(elems[i], l.get(i));
738	q.add(elems[0]);
739	q.add(elems[1]);
740	assertFalse(q.isEmpty());
741	assertTrue(q.contains(elems[0]));
742	assertTrue(q.contains(elems[1]));
743	l.clear();
744	q.drainTo(l);
745	assertEquals(0, q.size());
746	assertEquals(2, l.size());
747	for (int i = 0; i < 2; ++i)
748	assertEquals(elems[i], l.get(i));
749	}
750
751	/**
752	* drainTo empties queue
753	*/
754	public void testDrainToWithActivePut() throws InterruptedException {
755	final DelayQueue q = populatedQueue(SIZE);
756	Thread t = new Thread(new CheckedRunnable() {
757	public void realRun() {
758	q.put(new PDelay(SIZE + 1));
759	}});
760
761	t.start();
762	ArrayList l = new ArrayList();
763	q.drainTo(l);
764	assertTrue(l.size() >= SIZE);
765	t.join();
766	assertTrue(q.size() + l.size() >= SIZE);
767	}
768
769	/**
770	* drainTo(c, n) empties first min(n, size) elements of queue into c
771	*/
772	public void testDrainToN() {
773	for (int i = 0; i < SIZE + 2; ++i) {
774	DelayQueue q = populatedQueue(SIZE);
775	ArrayList l = new ArrayList();
776	q.drainTo(l, i);
777	int k = (i < SIZE) ? i : SIZE;
778	assertEquals(SIZE - k, q.size());
779	assertEquals(k, l.size());
780	}
781	}
782
783	/**
784	* remove(null), contains(null) always return false
785	*/
786	public void testNeverContainsNull() {
787	Collection<?> q = populatedQueue(SIZE);
788	assertFalse(q.contains(null));
789	assertFalse(q.remove(null));
790	}
791	}