TestHeaderGroup.java

/*
 * ====================================================================
 * 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.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.util.Iterator;

import org.apache.hc.core5.http.Header;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;

/**
 * Unit tests for {@link HeaderGroup}.
 *
 */
class TestHeaderGroup {

    @Test
    void testConstructor() {
        final HeaderGroup headergroup = new HeaderGroup();
        Assertions.assertNotNull(headergroup.getHeaders());
        Assertions.assertEquals(0, headergroup.getHeaders().length);
    }

    @Test
    void testClear() {
        final HeaderGroup headergroup = new HeaderGroup();
        headergroup.addHeader(new BasicHeader("name", "value"));
        Assertions.assertEquals(1, headergroup.getHeaders().length);
        headergroup.clear();
        Assertions.assertEquals(0, headergroup.getHeaders().length);
    }

    @Test
    void testAddRemoveHeader() {
        final HeaderGroup headerGroup = new HeaderGroup();
        final Header header = new BasicHeader("name", "value");
        headerGroup.addHeader(header);
        headerGroup.addHeader(null);
        Assertions.assertEquals(1, headerGroup.getHeaders().length);
        Assertions.assertTrue(headerGroup.removeHeader(header));
        Assertions.assertFalse(headerGroup.removeHeader(null));
        Assertions.assertEquals(0, headerGroup.getHeaders().length);
    }

    @Test
    void testAddRemoveHeaders() {
        final HeaderGroup headergroup = new HeaderGroup();
        final Header header = new BasicHeader("name", "value");
        headergroup.addHeader(header);
        headergroup.addHeader(header);
        Assertions.assertEquals(2, headergroup.getHeaders().length);
        Assertions.assertFalse(headergroup.removeHeaders((Header) null));
        Assertions.assertTrue(headergroup.removeHeaders(header));
        Assertions.assertFalse(headergroup.removeHeaders((Header) null));
        Assertions.assertEquals(0, headergroup.getHeaders().length);
    }

    @Test
    void testAddRemoveHeaderWithDifferentButEqualHeaders() {
        final HeaderGroup headergroup = new HeaderGroup();
        final Header header = new BasicHeader("name", "value");
        final Header header2 = new BasicHeader("name", "value");
        headergroup.addHeader(header);
        Assertions.assertEquals(1, headergroup.getHeaders().length);
        Assertions.assertTrue(headergroup.removeHeader(header2));
        Assertions.assertEquals(0, headergroup.getHeaders().length);
    }

    @Test
    void testUpdateHeader() {
        final HeaderGroup headergroup = new HeaderGroup();
        final Header header1 = new BasicHeader("name1", "value1");
        final Header header2 = new BasicHeader("name2", "value2");
        final Header header3 = new BasicHeader("name3", "value3");
        headergroup.addHeader(header1);
        headergroup.addHeader(header2);
        headergroup.addHeader(header3);
        headergroup.setHeader(new BasicHeader("name2", "newvalue"));
        headergroup.setHeader(new BasicHeader("name4", "value4"));
        headergroup.setHeader(null);
        Assertions.assertEquals(4, headergroup.getHeaders().length);
        Assertions.assertEquals("newvalue", headergroup.getFirstHeader("name2").getValue());
    }

    @Test
    void testSetHeaders() {
        final HeaderGroup headergroup = new HeaderGroup();
        final Header header1 = new BasicHeader("name1", "value1");
        final Header header2 = new BasicHeader("name2", "value2");
        final Header header3 = new BasicHeader("name3", "value3");
        headergroup.addHeader(header1);
        headergroup.setHeaders(header2, header3);
        Assertions.assertEquals(2, headergroup.getHeaders().length);
        Assertions.assertEquals(0, headergroup.getHeaders("name1").length);
        Assertions.assertFalse(headergroup.containsHeader("name1"));
        Assertions.assertEquals(1, headergroup.getHeaders("name2").length);
        Assertions.assertTrue(headergroup.containsHeader("name2"));
        Assertions.assertEquals(1, headergroup.getHeaders("name3").length);
        Assertions.assertTrue(headergroup.containsHeader("name3"));
        headergroup.setHeaders();
        Assertions.assertEquals(0, headergroup.getHeaders().length);
    }

    @Test
    void testFirstLastHeaders() {
        final HeaderGroup headergroup = new HeaderGroup();
        final Header header1 = new BasicHeader("name", "value1");
        final Header header2 = new BasicHeader("name", "value2");
        final Header header3 = new BasicHeader("name", "value3");
        headergroup.setHeaders(header1, header2, header3);

        Assertions.assertNull(headergroup.getFirstHeader("whatever"));
        Assertions.assertNull(headergroup.getLastHeader("whatever"));

        Assertions.assertEquals("value1", headergroup.getFirstHeader("name").getValue());
        Assertions.assertEquals("value3", headergroup.getLastHeader("name").getValue());
    }

    @Test
    void testCondensedHeader() {
        final HeaderGroup headergroup = new HeaderGroup();
        Assertions.assertNull(headergroup.getCondensedHeader("name"));

        final Header header1 = new BasicHeader("name", "value1");
        final Header header2 = new BasicHeader("name", "value2");
        final Header header3 = new BasicHeader("name", "value3");
        headergroup.setHeaders(header1, header2, header3);

        Assertions.assertEquals("value1, value2, value3", headergroup.getCondensedHeader("name").getValue());

        headergroup.setHeaders(header1);
        Assertions.assertEquals(header1, headergroup.getCondensedHeader("name"));
    }

    @Test
    void testIterator() {
        final HeaderGroup headergroup = new HeaderGroup();
        final Iterator<Header> i = headergroup.headerIterator();
        Assertions.assertNotNull(i);
        Assertions.assertFalse(i.hasNext());
    }

    @Test
    void testHeaderRemove() {
        final HeaderGroup headergroup = new HeaderGroup();
        final Header header1 = new BasicHeader("name", "value1");
        final Header header2 = new BasicHeader("name", "value2");
        final Header header3 = new BasicHeader("name", "value3");
        headergroup.setHeaders(header1, header2, header3);
        final Iterator<Header> i = headergroup.headerIterator();
        Assertions.assertNotNull(i);
        Assertions.assertTrue(i.hasNext());
        i.next();
        Assertions.assertTrue(i.hasNext());
        i.next();
        i.remove();
        Assertions.assertEquals(2, headergroup.getHeaders().length);
        Assertions.assertTrue(i.hasNext());
        i.next();
        i.remove();
        Assertions.assertEquals(1, headergroup.getHeaders().length);
        Assertions.assertFalse(i.hasNext());
    }

    @Test
    void testSerialization() throws Exception {
        final HeaderGroup orig = new HeaderGroup();
        final Header header1 = new BasicHeader("name", "value1");
        final Header header2 = new BasicHeader("name", "value2");
        final Header header3 = new BasicHeader("name", "value3");
        orig.setHeaders(header1, header2, header3);
        final ByteArrayOutputStream outbuffer = new ByteArrayOutputStream();
        try (ObjectOutputStream outStream = new ObjectOutputStream(outbuffer)) {
            outStream.writeObject(orig);
        }
        final byte[] raw = outbuffer.toByteArray();
        final ByteArrayInputStream inBuffer = new ByteArrayInputStream(raw);
        final ObjectInputStream inStream = new ObjectInputStream(inBuffer);
        final HeaderGroup clone = (HeaderGroup) inStream.readObject();
        final Header[] headers1 = orig.getHeaders();
        final Header[] headers2 = clone.getHeaders();
        Assertions.assertNotNull(headers1);
        Assertions.assertNotNull(headers2);
        Assertions.assertEquals(headers1.length, headers2.length);
        for (int i = 0; i < headers1.length; i++) {
            Assertions.assertEquals(headers1[i].getName(), headers2[i].getName());
            Assertions.assertEquals(headers1[i].getValue(), headers2[i].getValue());
        }
    }

}