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 junit.framework.*;
import java.util.Arrays;
import java.util.ArrayList;
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 static java.util.concurrent.TimeUnit.MILLISECONDS;

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

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

    private static final int NOCAP = Integer.MAX_VALUE;

    /**
     * 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 = Integer.MIN_VALUE + i; }
        public int compareTo(PDelay y) {
            int i = pseudodelay;
            int j = y.pseudodelay;
            if (i < j) return -1;
            if (i > j) return 1;
            return 0;
        }

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

        public boolean equals(Object other) {
            return equals((PDelay)other);
        }
        public boolean equals(PDelay other) {
            return other.pseudodelay == pseudodelay;
        }

        public long getDelay(TimeUnit ignore) {
            return pseudodelay;
        }
        public int intValue() {
            return 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 equals((NanoDelay)other);
        }
        public boolean equals(NanoDelay other) {
            return other.trigger == 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);
        }
    }

    /**
     * Create a 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(NOCAP, q.remainingCapacity());
        assertEquals(n, q.size());
        return q;
    }

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

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

    /**
     * Initializing from Collection of null elements throws NPE
     */
    public void testConstructor4() {
        try {
            PDelay[] ints = new PDelay[SIZE];
            DelayQueue q = new DelayQueue(Arrays.asList(ints));
            shouldThrow();
        } catch (NullPointerException success) {}
    }

    /**
     * Initializing from Collection with some null elements throws NPE
     */
    public void testConstructor5() {
        try {
            PDelay[] ints = new PDelay[SIZE];
            for (int i = 0; i < SIZE-1; ++i)
                ints[i] = new PDelay(i);
            DelayQueue q = new DelayQueue(Arrays.asList(ints));
            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(NOCAP, q.remainingCapacity());
        q.add(new PDelay(1));
        assertFalse(q.isEmpty());
        q.add(new PDelay(2));
        q.remove();
        q.remove();
        assertTrue(q.isEmpty());
    }

    /**
     * remainingCapacity does not change when elements added or removed,
     * but size does
     */
    public void testRemainingCapacity() {
        DelayQueue q = populatedQueue(SIZE);
        for (int i = 0; i < SIZE; ++i) {
            assertEquals(NOCAP, q.remainingCapacity());
            assertEquals(SIZE-i, q.size());
            q.remove();
        }
        for (int i = 0; i < SIZE; ++i) {
            assertEquals(NOCAP, q.remainingCapacity());
            assertEquals(i, q.size());
            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() {
        try {
            DelayQueue q = populatedQueue(SIZE);
            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() {
        try {
            DelayQueue q = new DelayQueue();
            PDelay[] ints = new PDelay[SIZE];
            for (int i = 0; i < SIZE-1; ++i)
                ints[i] = new PDelay(i);
            q.addAll(Arrays.asList(ints));
            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 I = new PDelay(i);
            q.put(I);
            assertTrue(q.contains(I));
        }
        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), ((PDelay)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), ((PDelay)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), ((PDelay)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), ((PDelay)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);
        Thread t = newStartedThread(new CheckedRunnable() {
            public void realRun() throws InterruptedException {
                DelayQueue q = populatedQueue(SIZE);
                for (int i = 0; i < SIZE; ++i) {
                    assertEquals(new PDelay(i), ((PDelay)q.poll(SHORT_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());
            }});

        await(pleaseInterrupt);
        assertThreadStaysAlive(t);
        t.interrupt();
        awaitTermination(t);
    }

    /**
     * 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), ((PDelay)q.peek()));
            assertEquals(new PDelay(i), ((PDelay)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), ((PDelay)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), ((PDelay)q.remove()));
        }
        try {
            q.remove();
            shouldThrow();
        } catch (NoSuchElementException success) {}
    }

    /**
     * remove(x) removes x and returns true if present
     */
    public void testRemoveElement() {
        DelayQueue q = populatedQueue(SIZE);
        for (int i = 1; i < SIZE; i+=2) {
            assertTrue(q.remove(new PDelay(i)));
        }
        for (int i = 0; i < SIZE; i+=2) {
            assertTrue(q.remove(new PDelay(i)));
            assertFalse(q.remove(new PDelay(i+1)));
        }
        assertTrue(q.isEmpty());
    }

    /**
     * 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(NOCAP, 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 I = (PDelay)(p.remove());
                assertFalse(q.contains(I));
            }
        }
    }

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

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

    /**
     * toString contains toStrings of elements
     */
    public void testToString() {
        DelayQueue q = populatedQueue(SIZE);
        String s = q.toString();
        for (int i = 0; i < SIZE; ++i) {
            assertTrue(s.contains(String.valueOf(Integer.MIN_VALUE+i)));
        }
    }

    /**
     * timed poll transfers elements across Executor tasks
     */
    public void testPollInExecutor() {
        final DelayQueue q = new DelayQueue();
        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();
                assertTrue(null != q.poll(LONG_DELAY_MS, MILLISECONDS));
                checkEmpty(q);
            }});

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

        joinPool(executor);
    }

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

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