test/tck/PriorityBlockingQueueTest.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.Comparator;
import java.util.Iterator;
import java.util.NoSuchElementException;
import java.util.Queue;
import java.util.concurrent.BlockingQueue;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.Executors;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.PriorityBlockingQueue;

import junit.framework.Test;

public class PriorityBlockingQueueTest extends JSR166TestCase {

    public static class Generic extends BlockingQueueTest {
        protected BlockingQueue emptyCollection() {
            return new PriorityBlockingQueue();
        }
    }

    public static class InitialCapacity extends BlockingQueueTest {
        protected BlockingQueue emptyCollection() {
            return new PriorityBlockingQueue(SIZE);
        }
    }

    public static void main(String[] args) {
        main(suite(), args);
    }

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

    /** Sample Comparator */
    static class MyReverseComparator implements Comparator {
        public int compare(Object x, Object y) {
            return ((Comparable)y).compareTo(x);
        }
    }

    /**
     * Returns a new queue of given size containing consecutive
     * Integers 0 ... n.
     */
    private PriorityBlockingQueue<Integer> populatedQueue(int n) {
        PriorityBlockingQueue<Integer> q =
            new PriorityBlockingQueue<Integer>(n);
        assertTrue(q.isEmpty());
        for (int i = n - 1; i >= 0; i -= 2)
            assertTrue(q.offer(new Integer(i)));
        for (int i = (n & 1); i < n; i += 2)
            assertTrue(q.offer(new Integer(i)));
        assertFalse(q.isEmpty());
        assertEquals(Integer.MAX_VALUE, q.remainingCapacity());
        assertEquals(n, q.size());
        return q;
    }

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

    /**
     * Constructor throws IAE if capacity argument nonpositive
     */
    public void testConstructor2() {
        try {
            new PriorityBlockingQueue(0);
            shouldThrow();
        } catch (IllegalArgumentException success) {}
    }

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

    /**
     * Initializing from Collection of null elements throws NPE
     */
    public void testConstructor4() {
        Collection<Integer> elements = Arrays.asList(new Integer[SIZE]);
        try {
            new PriorityBlockingQueue(elements);
            shouldThrow();
        } catch (NullPointerException success) {}
    }

    /**
     * Initializing from Collection with some null elements throws NPE
     */
    public void testConstructor5() {
        Integer[] ints = new Integer[SIZE];
        for (int i = 0; i < SIZE - 1; ++i)
            ints[i] = i;
        Collection<Integer> elements = Arrays.asList(ints);
        try {
            new PriorityBlockingQueue(elements);
            shouldThrow();
        } catch (NullPointerException success) {}
    }

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

    /**
     * The comparator used in constructor is used
     */
    public void testConstructor7() {
        MyReverseComparator cmp = new MyReverseComparator();
        PriorityBlockingQueue q = new PriorityBlockingQueue(SIZE, cmp);
        assertEquals(cmp, q.comparator());
        Integer[] ints = new Integer[SIZE];
        for (int i = 0; i < SIZE; ++i)
            ints[i] = new Integer(i);
        q.addAll(Arrays.asList(ints));
        for (int i = SIZE - 1; i >= 0; --i)
            assertEquals(ints[i], q.poll());
    }

    /**
     * isEmpty is true before add, false after
     */
    public void testEmpty() {
        PriorityBlockingQueue q = new PriorityBlockingQueue(2);
        assertTrue(q.isEmpty());
        assertEquals(Integer.MAX_VALUE, q.remainingCapacity());
        q.add(one);
        assertFalse(q.isEmpty());
        q.add(two);
        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());
            assertEquals(i, q.remove());
        }
        for (int i = 0; i < SIZE; ++i) {
            assertEquals(Integer.MAX_VALUE, q.remainingCapacity());
            assertEquals(i, q.size());
            assertTrue(q.add(i));
        }
    }

    /**
     * Offer of comparable element succeeds
     */
    public void testOffer() {
        PriorityBlockingQueue q = new PriorityBlockingQueue(1);
        assertTrue(q.offer(zero));
        assertTrue(q.offer(one));
    }

    /**
     * Offer of non-Comparable throws CCE
     */
    public void testOfferNonComparable() {
        PriorityBlockingQueue q = new PriorityBlockingQueue(1);
        try {
            q.offer(new Object());
            q.offer(new Object());
            shouldThrow();
        } catch (ClassCastException success) {}
    }

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

    /**
     * addAll(this) throws IAE
     */
    public void testAddAllSelf() {
        PriorityBlockingQueue 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() {
        PriorityBlockingQueue q = new PriorityBlockingQueue(SIZE);
        Integer[] ints = new Integer[SIZE];
        for (int i = 0; i < SIZE - 1; ++i)
            ints[i] = new Integer(i);
        try {
            q.addAll(Arrays.asList(ints));
            shouldThrow();
        } catch (NullPointerException success) {}
    }

    /**
     * Queue contains all elements of successful addAll
     */
    public void testAddAll5() {
        Integer[] empty = new Integer[0];
        Integer[] ints = new Integer[SIZE];
        for (int i = SIZE - 1; i >= 0; --i)
            ints[i] = new Integer(i);
        PriorityBlockingQueue q = new PriorityBlockingQueue(SIZE);
        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() {
        PriorityBlockingQueue q = new PriorityBlockingQueue(SIZE);
        for (int i = 0; i < SIZE; ++i) {
            Integer x = new Integer(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 PriorityBlockingQueue q = new PriorityBlockingQueue(2);
        final int size = 4;
        Thread t = newStartedThread(new CheckedRunnable() {
            public void realRun() {
                for (int i = 0; i < size; i++)
                    q.put(new Integer(0));
            }});

        awaitTermination(t);
        assertEquals(size, q.size());
        q.take();
    }

    /**
     * timed offer does not time out
     */
    public void testTimedOffer() throws InterruptedException {
        final PriorityBlockingQueue q = new PriorityBlockingQueue(2);
        Thread t = newStartedThread(new CheckedRunnable() {
            public void realRun() {
                q.put(new Integer(0));
                q.put(new Integer(0));
                assertTrue(q.offer(new Integer(0), SHORT_DELAY_MS, MILLISECONDS));
                assertTrue(q.offer(new Integer(0), LONG_DELAY_MS, MILLISECONDS));
            }});

        awaitTermination(t);
    }

    /**
     * take retrieves elements in priority order
     */
    public void testTake() throws InterruptedException {
        PriorityBlockingQueue q = populatedQueue(SIZE);
        for (int i = 0; i < SIZE; ++i) {
            assertEquals(i, q.take());
        }
    }

    /**
     * Take removes existing elements until empty, then blocks interruptibly
     */
    public void testBlockingTake() throws InterruptedException {
        final PriorityBlockingQueue 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(i, 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() {
        PriorityBlockingQueue q = populatedQueue(SIZE);
        for (int i = 0; i < SIZE; ++i) {
            assertEquals(i, q.poll());
        }
        assertNull(q.poll());
    }

    /**
     * timed poll with zero timeout succeeds when non-empty, else times out
     */
    public void testTimedPoll0() throws InterruptedException {
        PriorityBlockingQueue q = populatedQueue(SIZE);
        for (int i = 0; i < SIZE; ++i) {
            assertEquals(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 {
        PriorityBlockingQueue<Integer> q = populatedQueue(SIZE);
        for (int i = 0; i < SIZE; ++i) {
            long startTime = System.nanoTime();
            assertEquals(i, (int) 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 BlockingQueue<Integer> q = populatedQueue(SIZE);
        final CountDownLatch aboutToWait = new CountDownLatch(1);
        Thread t = newStartedThread(new CheckedRunnable() {
            public void realRun() throws InterruptedException {
                long startTime = System.nanoTime();
                for (int i = 0; i < SIZE; ++i) {
                    assertEquals(i, (int) q.poll(LONG_DELAY_MS, MILLISECONDS));
                }
                aboutToWait.countDown();
                try {
                    q.poll(LONG_DELAY_MS, MILLISECONDS);
                    shouldThrow();
                } catch (InterruptedException success) {
                    assertTrue(millisElapsedSince(startTime) < LONG_DELAY_MS);
                }
            }});

        aboutToWait.await();
        waitForThreadToEnterWaitState(t, LONG_DELAY_MS);
        t.interrupt();
        awaitTermination(t);
    }

    /**
     * peek returns next element, or null if empty
     */
    public void testPeek() {
        PriorityBlockingQueue q = populatedQueue(SIZE);
        for (int i = 0; i < SIZE; ++i) {
            assertEquals(i, q.peek());
            assertEquals(i, q.poll());
            assertTrue(q.peek() == null ||
                       !q.peek().equals(i));
        }
        assertNull(q.peek());
    }

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

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

    /**
     * contains(x) reports true when elements added but not yet removed
     */
    public void testContains() {
        PriorityBlockingQueue q = populatedQueue(SIZE);
        for (int i = 0; i < SIZE; ++i) {
            assertTrue(q.contains(new Integer(i)));
            q.poll();
            assertFalse(q.contains(new Integer(i)));
        }
    }

    /**
     * clear removes all elements
     */
    public void testClear() {
        PriorityBlockingQueue q = populatedQueue(SIZE);
        q.clear();
        assertTrue(q.isEmpty());
        assertEquals(0, q.size());
        q.add(one);
        assertFalse(q.isEmpty());
        assertTrue(q.contains(one));
        q.clear();
        assertTrue(q.isEmpty());
    }

    /**
     * containsAll(c) is true when c contains a subset of elements
     */
    public void testContainsAll() {
        PriorityBlockingQueue q = populatedQueue(SIZE);
        PriorityBlockingQueue p = new PriorityBlockingQueue(SIZE);
        for (int i = 0; i < SIZE; ++i) {
            assertTrue(q.containsAll(p));
            assertFalse(p.containsAll(q));
            p.add(new Integer(i));
        }
        assertTrue(p.containsAll(q));
    }

    /**
     * retainAll(c) retains only those elements of c and reports true if changed
     */
    public void testRetainAll() {
        PriorityBlockingQueue q = populatedQueue(SIZE);
        PriorityBlockingQueue 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) {
            PriorityBlockingQueue q = populatedQueue(SIZE);
            PriorityBlockingQueue p = populatedQueue(i);
            assertTrue(q.removeAll(p));
            assertEquals(SIZE - i, q.size());
            for (int j = 0; j < i; ++j) {
                Integer x = (Integer)(p.remove());
                assertFalse(q.contains(x));
            }
        }
    }

    /**
     * toArray contains all elements
     */
    public void testToArray() throws InterruptedException {
        PriorityBlockingQueue 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() throws InterruptedException {
        PriorityBlockingQueue<Integer> q = populatedQueue(SIZE);
        Integer[] ints = new Integer[SIZE];
        Integer[] array = q.toArray(ints);
        assertSame(ints, array);
        Arrays.sort(ints);
        for (int i = 0; i < ints.length; i++)
            assertSame(ints[i], q.take());
    }

    /**
     * toArray(incompatible array type) throws ArrayStoreException
     */
    public void testToArray1_BadArg() {
        PriorityBlockingQueue q = populatedQueue(SIZE);
        try {
            q.toArray(new String[10]);
            shouldThrow();
        } catch (ArrayStoreException success) {}
    }

    /**
     * iterator iterates through all elements
     */
    public void testIterator() {
        PriorityBlockingQueue q = populatedQueue(SIZE);
        Iterator it = q.iterator();
        int i;
        for (i = 0; it.hasNext(); i++)
            assertTrue(q.contains(it.next()));
        assertEquals(i, SIZE);
        assertIteratorExhausted(it);
    }

    /**
     * iterator of empty collection has no elements
     */
    public void testEmptyIterator() {
        assertIteratorExhausted(new PriorityBlockingQueue().iterator());
    }

    /**
     * iterator.remove removes current element
     */
    public void testIteratorRemove() {
        final PriorityBlockingQueue q = new PriorityBlockingQueue(3);
        q.add(new Integer(2));
        q.add(new Integer(1));
        q.add(new Integer(3));

        Iterator it = q.iterator();
        it.next();
        it.remove();

        it = q.iterator();
        assertEquals(it.next(), new Integer(2));
        assertEquals(it.next(), new Integer(3));
        assertFalse(it.hasNext());
    }

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

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

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

    /**
     * A deserialized serialized queue has same elements
     */
    public void testSerialization() throws Exception {
        Queue x = populatedQueue(SIZE);
        Queue y = serialClone(x);

        assertNotSame(x, y);
        assertEquals(x.size(), y.size());
        while (!x.isEmpty()) {
            assertFalse(y.isEmpty());
            assertEquals(x.remove(), y.remove());
        }
        assertTrue(y.isEmpty());
    }

    /**
     * drainTo(c) empties queue into another collection c
     */
    public void testDrainTo() {
        PriorityBlockingQueue q = populatedQueue(SIZE);
        ArrayList l = new ArrayList();
        q.drainTo(l);
        assertEquals(0, q.size());
        assertEquals(SIZE, l.size());
        for (int i = 0; i < SIZE; ++i)
            assertEquals(l.get(i), new Integer(i));
        q.add(zero);
        q.add(one);
        assertFalse(q.isEmpty());
        assertTrue(q.contains(zero));
        assertTrue(q.contains(one));
        l.clear();
        q.drainTo(l);
        assertEquals(0, q.size());
        assertEquals(2, l.size());
        for (int i = 0; i < 2; ++i)
            assertEquals(l.get(i), new Integer(i));
    }

    /**
     * drainTo empties queue
     */
    public void testDrainToWithActivePut() throws InterruptedException {
        final PriorityBlockingQueue q = populatedQueue(SIZE);
        Thread t = new Thread(new CheckedRunnable() {
            public void realRun() {
                q.put(new Integer(SIZE + 1));
            }});

        t.start();
        ArrayList l = new ArrayList();
        q.drainTo(l);
        assertTrue(l.size() >= SIZE);
        for (int i = 0; i < SIZE; ++i)
            assertEquals(l.get(i), new Integer(i));
        t.join();
        assertTrue(q.size() + l.size() >= SIZE);
    }

    /**
     * drainTo(c, n) empties first min(n, size) elements of queue into c
     */
    public void testDrainToN() {
        PriorityBlockingQueue q = new PriorityBlockingQueue(SIZE * 2);
        for (int i = 0; i < SIZE + 2; ++i) {
            for (int j = 0; j < SIZE; j++)
                assertTrue(q.offer(new Integer(j)));
            ArrayList l = new ArrayList();
            q.drainTo(l, i);
            int k = (i < SIZE) ? i : SIZE;
            assertEquals(k, l.size());
            assertEquals(SIZE - k, q.size());
            for (int j = 0; j < k; ++j)
                assertEquals(l.get(j), new Integer(j));
            do {} while (q.poll() != null);
        }
    }

    /**
     * remove(null), contains(null) always return false
     */
    public void testNeverContainsNull() {
        Collection<?>[] qs = {
            new PriorityBlockingQueue<Object>(),
            populatedQueue(2),
        };

        for (Collection<?> q : qs) {
            assertFalse(q.contains(null));
            assertFalse(q.remove(null));
        }
    }

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