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