/*
 * ====================================================================
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 *
 */
package org.apache.hc.core5.http.message;

import java.util.Iterator;
import java.util.NoSuchElementException;

import org.apache.hc.core5.http.Header;
import org.junit.Assert;
import org.junit.Test;


/**
 * Tests for {@link java.util.Iterator} of {@link org.apache.hc.core5.http.Header}s.
 *
 */
public class TestBasicHeaderIterator {

    @Test
    public void testAllSame() {
        final Header[] headers = new Header[]{
            new BasicHeader("Name", "value0"),
            new BasicHeader("nAme", "value1, value1.1"),
            new BasicHeader("naMe", "value2=whatever"),
            new BasicHeader("namE", "value3;tag=nil"),
        };

        // without filter
        Iterator<Header> hit = new BasicHeaderIterator(headers, null);
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("0", headers[0], hit.next());
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("1", headers[1], hit.next());
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("2", headers[2], hit.next());
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("3", headers[3], hit.next());
        Assert.assertFalse(hit.hasNext());

        // with filter
        hit = new BasicHeaderIterator(headers, "name");
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("0", headers[0], hit.next());
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("1", headers[1], hit.next());
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("2", headers[2], hit.next());
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("3", headers[3], hit.next());
        Assert.assertFalse(hit.hasNext());
    }


    @Test
    public void testFirstLastOneNone() {
        final Header[] headers = new Header[]{
            new BasicHeader("match"   , "value0"),
            new BasicHeader("mismatch", "value1, value1.1"),
            new BasicHeader("single"  , "value2=whatever"),
            new BasicHeader("match"   , "value3;tag=nil"),
        };

        // without filter
        Iterator<Header> hit = new BasicHeaderIterator(headers, null);
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("0", headers[0], hit.next());
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("1", headers[1], hit.next());
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("2", headers[2], hit.next());
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("3", headers[3], hit.next());
        Assert.assertFalse(hit.hasNext());

        // with filter, first & last
        hit = new BasicHeaderIterator(headers, "match");
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("0", headers[0], hit.next());
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("3", headers[3], hit.next());
        Assert.assertFalse(hit.hasNext());

        // with filter, one match
        hit = new BasicHeaderIterator(headers, "single");
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("2", headers[2], hit.next());
        Assert.assertFalse(hit.hasNext());

        // with filter, no match
        hit = new BasicHeaderIterator(headers, "way-off");
        Assert.assertFalse(hit.hasNext());
    }


    @Test
    public void testInterspersed() {
        final Header[] headers = new Header[]{
            new BasicHeader("yellow", "00"),
            new BasicHeader("maroon", "01"),
            new BasicHeader("orange", "02"),
            new BasicHeader("orange", "03"),
            new BasicHeader("orange", "04"),
            new BasicHeader("yellow", "05"),
            new BasicHeader("maroon", "06"),
            new BasicHeader("maroon", "07"),
            new BasicHeader("maroon", "08"),
            new BasicHeader("yellow", "09"),
            new BasicHeader("maroon", "0a"),
            new BasicHeader("yellow", "0b"),
            new BasicHeader("orange", "0c"),
            new BasicHeader("yellow", "0d"),
            new BasicHeader("orange", "0e"),
        };

        // without filter
        Iterator<Header> hit = new BasicHeaderIterator(headers, null);
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("0", headers[0], hit.next());
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("1", headers[1], hit.next());
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("2", headers[2], hit.next());
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("3", headers[3], hit.next());
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("4", headers[4], hit.next());
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("5", headers[5], hit.next());
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("6", headers[6], hit.next());
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("7", headers[7], hit.next());
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("8", headers[8], hit.next());
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("9", headers[9], hit.next());
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("a", headers[10], hit.next());
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("b", headers[11], hit.next());
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("c", headers[12], hit.next());
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("d", headers[13], hit.next());
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("e", headers[14], hit.next());
        Assert.assertFalse(hit.hasNext());

        // yellow 0, 5, 9, 11, 13
        hit = new BasicHeaderIterator(headers, "Yellow");
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("0", headers[0], hit.next());
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("5", headers[5], hit.next());
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("9", headers[9], hit.next());
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("b", headers[11], hit.next());
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("d", headers[13], hit.next());
        Assert.assertFalse(hit.hasNext());

        // maroon 1, 6, 7, 8, 10
        hit = new BasicHeaderIterator(headers, "marOOn");
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("1", headers[1], hit.next());
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("6", headers[6], hit.next());
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("7", headers[7], hit.next());
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("8", headers[8], hit.next());
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("a", headers[10], hit.next());
        Assert.assertFalse(hit.hasNext());

        // orange 2, 3, 4, 12, 14
        hit = new BasicHeaderIterator(headers, "OranGe");
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("2", headers[2], hit.next());
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("3", headers[3], hit.next());
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("4", headers[4], hit.next());
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("b", headers[12], hit.next());
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("e", headers[14], hit.next());
        Assert.assertFalse(hit.hasNext());
    }


    @Test
    public void testInvalid() {

        Iterator<Header> hit = null;
        try {
            hit = new BasicHeaderIterator(null, "whatever");
            Assert.fail("null headers not detected");
        } catch (final IllegalArgumentException iax) {
            // expected
        }

        // this is not invalid
        hit = new BasicHeaderIterator(new Header[0], "whatever");
        Assert.assertFalse(hit.hasNext());

        // but this is
        try {
            hit.next();
            Assert.fail("next beyond end not detected");
        } catch (final NoSuchElementException nsx) {
            // expected
        }
    }


    @Test
    public void testRemaining() {
        // to satisfy Clover and take coverage to 100%

        final Header[] headers = new Header[]{
            new BasicHeader("Name", "value0"),
            new BasicHeader("nAme", "value1, value1.1"),
            new BasicHeader("naMe", "value2=whatever"),
            new BasicHeader("namE", "value3;tag=nil"),
        };

        // without filter, using plain next()
        Iterator<Header> hit = new BasicHeaderIterator(headers, null);
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("0", headers[0], hit.next());
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("1", headers[1], hit.next());
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("2", headers[2], hit.next());
        Assert.assertTrue(hit.hasNext());
        Assert.assertEquals("3", headers[3], hit.next());
        Assert.assertFalse(hit.hasNext());

        hit = new BasicHeaderIterator(headers, null);
        Assert.assertTrue(hit.hasNext());
        try {
            hit.remove();
            Assert.fail("remove not detected");
        } catch (final UnsupportedOperationException uox) {
            // expected
        }
    }
}