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