/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

/*

 * This file is available under and governed by the GNU General Public

 * License version 2 only, as published by the Free Software Foundation.

 * However, the following notice accompanied the original version of this

 * file:

 *

 * 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.Collections;

import java.util.Iterator;

import java.util.NoSuchElementException;

import java.util.Queue;

import java.util.concurrent.ArrayBlockingQueue;

import java.util.concurrent.BlockingQueue;

import java.util.concurrent.CountDownLatch;

import java.util.concurrent.Executors;

import java.util.concurrent.ExecutorService;

import java.util.concurrent.ThreadLocalRandom;

import junit.framework.Test;

public class ArrayBlockingQueueTest extends JSR166TestCase {

    public static void main(String[] args) {

        main(suite(), args);

    }

    public static Test suite() {

        class Implementation implements CollectionImplementation {

            public Class<?> klazz() { return ArrayBlockingQueue.class; }

            public Collection emptyCollection() {

                return populatedQueue(0, SIZE, 2 * SIZE, fair);

            }

            public Object makeElement(int i) { return i; }

            public boolean isConcurrent() { return true; }

            public boolean permitsNulls() { return false; }

        }

        return newTestSuite(

            ArrayBlockingQueueTest.class,

            new Fair().testSuite(),

            new NonFair().testSuite(),

            CollectionTest.testSuite(new Implementation()));

    }

    public static class Fair extends BlockingQueueTest {

        protected BlockingQueue emptyCollection() {

            return populatedQueue(0, SIZE, 2 * SIZE, true);

        }

    }

    public static class NonFair extends BlockingQueueTest {

        protected BlockingQueue emptyCollection() {

            return populatedQueue(0, SIZE, 2 * SIZE, false);

        }

    }

    /**

     * Returns a new queue of given size containing consecutive

     * Integers 0 ... n - 1.

     */

    static ArrayBlockingQueue<Integer> populatedQueue(int n) {

        return populatedQueue(n, n, n, false);

    }

    /**

     * Returns a new queue of given size containing consecutive

     * Integers 0 ... n - 1, with given capacity range and fairness.

     */

    static ArrayBlockingQueue<Integer> populatedQueue(

        int size, int minCapacity, int maxCapacity, boolean fair) {

        ThreadLocalRandom rnd = ThreadLocalRandom.current();

        int capacity = rnd.nextInt(minCapacity, maxCapacity + 1);

        ArrayBlockingQueue<Integer> q = new ArrayBlockingQueue<>(capacity);

        assertTrue(q.isEmpty());

        // shuffle circular array elements so they wrap

        {

            int n = rnd.nextInt(capacity);

            for (int i = 0; i < n; i++) q.add(42);

            for (int i = 0; i < n; i++) q.remove();

        }

        for (int i = 0; i < size; i++)

            assertTrue(q.offer((Integer) i));

        assertEquals(size == 0, q.isEmpty());

        assertEquals(capacity - size, q.remainingCapacity());

        assertEquals(size, q.size());

        if (size > 0)

            assertEquals((Integer) 0, q.peek());

        return q;

    }

    /**

     * A new queue has the indicated capacity

     */

    public void testConstructor1() {

        assertEquals(SIZE, new ArrayBlockingQueue(SIZE).remainingCapacity());

    }

    /**

     * Constructor throws IllegalArgumentException if capacity argument nonpositive

     */

    public void testConstructor_nonPositiveCapacity() {

        for (int i : new int[] { 0, -1, Integer.MIN_VALUE }) {

            try {

                new ArrayBlockingQueue(i);

                shouldThrow();

            } catch (IllegalArgumentException success) {}

            for (boolean fair : new boolean[] { true, false }) {

                try {

                    new ArrayBlockingQueue(i, fair);

                    shouldThrow();

                } catch (IllegalArgumentException success) {}

            }

        }

    }

    /**

     * Initializing from null Collection throws NPE

     */

    public void testConstructor_nullCollection() {

        try {

            new ArrayBlockingQueue(1, true, 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 ArrayBlockingQueue(SIZE, false, 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 ArrayBlockingQueue(SIZE, false, elements);

            shouldThrow();

        } catch (NullPointerException success) {}

    }

    /**

     * Initializing from too large collection throws IllegalArgumentException

     */

    public void testConstructor_collectionTooLarge() {

        // just barely fits - succeeds

        new ArrayBlockingQueue(SIZE, false,

                               Collections.nCopies(SIZE, ""));

        try {

            new ArrayBlockingQueue(SIZE - 1, false,

                                   Collections.nCopies(SIZE, ""));

            shouldThrow();

        } catch (IllegalArgumentException success) {}

    }

    /**

     * Queue contains all elements of collection used to initialize

     */

    public void testConstructor7() {

        Integer[] ints = new Integer[SIZE];

        for (int i = 0; i < SIZE; ++i)

            ints[i] = i;

        Collection<Integer> elements = Arrays.asList(ints);

        ArrayBlockingQueue q = new ArrayBlockingQueue(SIZE, true, elements);

        for (int i = 0; i < SIZE; ++i)

            assertEquals(ints[i], q.poll());

    }

    /**

     * Queue transitions from empty to full when elements added

     */

    public void testEmptyFull() {

        BlockingQueue q = populatedQueue(0, 2, 2, false);

        assertTrue(q.isEmpty());

        assertEquals(2, q.remainingCapacity());

        q.add(one);

        assertFalse(q.isEmpty());

        assertTrue(q.offer(two));

        assertFalse(q.isEmpty());

        assertEquals(0, q.remainingCapacity());

        assertFalse(q.offer(three));

    }

    /**

     * remainingCapacity decreases on add, increases on remove

     */

    public void testRemainingCapacity() {

        int size = ThreadLocalRandom.current().nextInt(1, SIZE);

        BlockingQueue q = populatedQueue(size, size, 2 * size, false);

        int spare = q.remainingCapacity();

        int capacity = spare + size;

        for (int i = 0; i < size; i++) {

            assertEquals(spare + i, q.remainingCapacity());

            assertEquals(capacity, q.size() + q.remainingCapacity());

            assertEquals(i, q.remove());

        }

        for (int i = 0; i < size; i++) {

            assertEquals(capacity - i, q.remainingCapacity());

            assertEquals(capacity, q.size() + q.remainingCapacity());

            assertTrue(q.add(i));

        }

    }

    /**

     * Offer succeeds if not full; fails if full

     */

    public void testOffer() {

        ArrayBlockingQueue q = new ArrayBlockingQueue(1);

        assertTrue(q.offer(zero));

        assertFalse(q.offer(one));

    }

    /**

     * add succeeds if not full; throws IllegalStateException if full

     */

    public void testAdd() {

        ArrayBlockingQueue q = new ArrayBlockingQueue(SIZE);

        for (int i = 0; i < SIZE; i++) assertTrue(q.add((Integer) i));

        assertEquals(0, q.remainingCapacity());

        try {

            q.add((Integer) SIZE);

            shouldThrow();

        } catch (IllegalStateException success) {}

    }

    /**

     * addAll(this) throws IllegalArgumentException

     */

    public void testAddAllSelf() {

        ArrayBlockingQueue 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() {

        ArrayBlockingQueue q = new ArrayBlockingQueue(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) {}

    }

    /**

     * addAll throws IllegalStateException if not enough room

     */

    public void testAddAll_insufficientSpace() {

        int size = ThreadLocalRandom.current().nextInt(1, SIZE);

        ArrayBlockingQueue q = populatedQueue(0, size, size, false);

        // Just fits:

        q.addAll(populatedQueue(size, size, 2 * size, false));

        assertEquals(0, q.remainingCapacity());

        assertEquals(size, q.size());

        assertEquals(0, q.peek());

        try {

            q = populatedQueue(0, size, size, false);

            q.addAll(Collections.nCopies(size + 1, 42));

            shouldThrow();

        } catch (IllegalStateException success) {}

    }

    /**

     * Queue contains all elements, in traversal order, of successful addAll

     */

    public void testAddAll5() {

        Integer[] empty = new Integer[0];

        Integer[] ints = new Integer[SIZE];

        for (int i = 0; i < SIZE; ++i)

            ints[i] = new Integer(i);

        ArrayBlockingQueue q = new ArrayBlockingQueue(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() throws InterruptedException {

        ArrayBlockingQueue q = new ArrayBlockingQueue(SIZE);

        for (int i = 0; i < SIZE; ++i) {

            Integer x = new Integer(i);

            q.put(x);

            assertTrue(q.contains(x));

        }

        assertEquals(0, q.remainingCapacity());

    }

    /**

     * put blocks interruptibly if full

     */

    public void testBlockingPut() throws InterruptedException {

        final ArrayBlockingQueue q = new ArrayBlockingQueue(SIZE);

        final CountDownLatch pleaseInterrupt = new CountDownLatch(1);

        Thread t = newStartedThread(new CheckedRunnable() {

            public void realRun() throws InterruptedException {

                for (int i = 0; i < SIZE; ++i)

                    q.put(i);

                assertEquals(SIZE, q.size());

                assertEquals(0, q.remainingCapacity());

                Thread.currentThread().interrupt();

                try {

                    q.put(99);

                    shouldThrow();

                } catch (InterruptedException success) {}

                assertFalse(Thread.interrupted());

                pleaseInterrupt.countDown();

                try {

                    q.put(99);

                    shouldThrow();

                } catch (InterruptedException success) {}

                assertFalse(Thread.interrupted());

            }});

        await(pleaseInterrupt);

        t.interrupt();

        awaitTermination(t);

        assertEquals(SIZE, q.size());

        assertEquals(0, q.remainingCapacity());

    }

    /**

     * put blocks interruptibly waiting for take when full

     */

    public void testPutWithTake() throws InterruptedException {

        final int capacity = 2;

        final ArrayBlockingQueue q = new ArrayBlockingQueue(capacity);

        final CountDownLatch pleaseTake = new CountDownLatch(1);

        final CountDownLatch pleaseInterrupt = new CountDownLatch(1);

        Thread t = newStartedThread(new CheckedRunnable() {

            public void realRun() throws InterruptedException {

                for (int i = 0; i < capacity; i++)

                    q.put(i);

                pleaseTake.countDown();

                q.put(86);

                Thread.currentThread().interrupt();

                try {

                    q.put(99);

                    shouldThrow();

                } catch (InterruptedException success) {}

                assertFalse(Thread.interrupted());

                pleaseInterrupt.countDown();

                try {

                    q.put(99);

                    shouldThrow();

                } catch (InterruptedException success) {}

                assertFalse(Thread.interrupted());

            }});

        await(pleaseTake);

        assertEquals(0, q.remainingCapacity());

        assertEquals(0, q.take());

        await(pleaseInterrupt);

        t.interrupt();

        awaitTermination(t);

        assertEquals(0, q.remainingCapacity());

    }

    /**

     * timed offer times out if full and elements not taken

     */

    public void testTimedOffer() {

        final ArrayBlockingQueue q = new ArrayBlockingQueue(2);

        final CountDownLatch pleaseInterrupt = new CountDownLatch(1);

        Thread t = newStartedThread(new CheckedRunnable() {

            public void realRun() throws InterruptedException {

                q.put(new Object());

                q.put(new Object());

                long startTime = System.nanoTime();

                assertFalse(q.offer(new Object(), timeoutMillis(), MILLISECONDS));

                assertTrue(millisElapsedSince(startTime) >= timeoutMillis());

                Thread.currentThread().interrupt();

                try {

                    shouldThrow();

                } catch (InterruptedException success) {}

                assertFalse(Thread.interrupted());

                pleaseInterrupt.countDown();

                try {

                    shouldThrow();

                } catch (InterruptedException success) {}

                assertFalse(Thread.interrupted());

            }});

        await(pleaseInterrupt);

        t.interrupt();

        awaitTermination(t);

    }

    /**

     * take retrieves elements in FIFO order

     */

    public void testTake() throws InterruptedException {

        ArrayBlockingQueue 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 ArrayBlockingQueue 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);

        t.interrupt();

        awaitTermination(t);

    }

    /**

     * poll succeeds unless empty

     */

    public void testPoll() {

        ArrayBlockingQueue 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 {

        ArrayBlockingQueue q = populatedQueue(SIZE);

        for (int i = 0; i < SIZE; ++i) {

            assertEquals(i, q.poll(0, MILLISECONDS));

        }

        assertNull(q.poll(0, MILLISECONDS));

        checkEmpty(q);

    }