/*
 * Copyright (c) 2011-2017 Contributors to the Eclipse Foundation
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
 * which is available at https://www.apache.org/licenses/LICENSE-2.0.
 *
 * SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
 */

package io.vertx.core.http;

import io.vertx.core.MultiMap;
import org.junit.Test;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertSame;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;

public abstract class HeadersTestBase {

  protected String separator = "";

  protected abstract MultiMap newMultiMap();

  @Test
  public void testCaseInsensitiveHeaders() {
    MultiMap result = newMultiMap();
    assertNotNull(result);
    assertTrue(result.isEmpty());
    assertEquals(0, result.size());
    assertEquals("", result.toString());
  }

  @Test
  public void testAddAll1() {
    MultiMap mmap = newMultiMap();
    HashMap<String, String> map = new HashMap<>();
    map.put("a", "b");
    MultiMap result = mmap.addAll(map);
    assertNotNull(result);
    assertFalse(result.isEmpty());
    assertEquals(1, result.size());
    assertEquals("a" + separator + "b\n", result.toString());
  }

  @Test
  public void testAddAll2() {
    MultiMap mmap = newMultiMap();
    HashMap<String, String> map = new HashMap<>();
    map.put("a", "b");
    map.put("c", "d");
    assertEquals("a"+ separator + "b\nc" + separator + "d\n", mmap.addAll(map).toString());
  }

  @Test
  public void testAddAllEmptyMap() {
    MultiMap mmap = newMultiMap();
    Map<String, String> map = new HashMap<>();
    assertEquals("", mmap.addAll(map).toString());
  }

  @Test
  public void testAddAllEmptyMultiMap() {
    MultiMap mmap = newMultiMap();
    MultiMap headers = newMultiMap();
    assertEquals("", mmap.addAll(headers).toString());
  }

  @Test
  public void testAddCharSequenceNameCharSequenceValue() {
    MultiMap mmap = newMultiMap();
    CharSequence name = "name";
    CharSequence value = "value";
    assertEquals("name" + separator + "value\n", mmap.add(name, value).toString());
  }

  @Test
  public void testAddCharSequenceNameIterableCharSequenceValue() {
    MultiMap mmap = newMultiMap();
    CharSequence name = "name";
    ArrayList<CharSequence> values = new ArrayList<>();
    values.add("somevalue");
    assertEquals("name" + separator + "somevalue\n", mmap.add(name, values).toString());
  }

  @Test
  public void testAddStringNameStringValue() {
    MultiMap mmap = newMultiMap();
    String name = "a";
    String strVal = "b";
    assertEquals("a" + separator + "b\n", mmap.add(name, strVal).toString());
  }

  @Test
  public void testAddStringNameEmptyStringValue() {
    MultiMap mmap = newMultiMap();
    String name = "aaa";
    String strVal = "";
    assertEquals("aaa" + separator + "\n", mmap.add(name, strVal).toString());
  }

  @Test(expected = NullPointerException.class)
  public void testAddNullStringValueTest() {
    MultiMap mmap = newMultiMap();
    mmap.add("name", (String) null);
  }

  @Test(expected = NullPointerException.class)
  public void testAddNullCharSequenceValueTest() {
    MultiMap mmap = newMultiMap();
    mmap.add("name", (CharSequence) null);
  }

  @Test(expected = NullPointerException.class)
  public void testAddNullIterableStringValueTest() {
    MultiMap mmap = newMultiMap();
    mmap.add("name", (Iterable<String>) null);
  }

  @Test
  public void testAddStringNameIterableStringValue() {
    MultiMap mmap = newMultiMap();
    String name = "name";
    List<String> values = new ArrayList<>();
    values.add("value1");
    values.add("value2");
    MultiMap result = mmap.add(name, values);
    assertEquals(1, result.size());
    assertEquals("name" + separator + "value1\nname" + separator + "value2\n", result.toString());
  }

  @Test
  public void testAddAllMultiMap() {
    MultiMap mmap = newMultiMap();
    MultiMap mm = newMultiMap();
    mm.add("header1", "value1");
    mm.add("header2", "value2");
    MultiMap result = mmap.addAll(mm);
    assertEquals(2, result.size());
    assertEquals("header1" + separator + "value1\nheader2" + separator + "value2\n", result.toString());
  }

  @Test
  public void testClearTest1() {
    MultiMap mmap = newMultiMap();
    MultiMap result = mmap.clear();
    assertNotNull(result);
    assertTrue(result.isEmpty());
    assertEquals(0, result.size());
    assertEquals("", result.toString());
  }

  @Test
  public void testContainsCharSequence() {
    MultiMap mmap = newMultiMap();
    CharSequence name = String.valueOf(new Object());
    assertFalse(mmap.contains(name));
  }

  @Test
  public void testContainsEmptyString() {
    MultiMap mmap = newMultiMap();
    String name = "";
    assertFalse(mmap.contains(name));
  }

  @Test
  public void testContainsEmptyValue() {
    MultiMap mmap = newMultiMap();
    String name = "0123456789";
    assertFalse(mmap.contains(name));
    mmap.add(name, "");
    assertTrue(mmap.contains(name));
  }

  @Test
  public void testEntriesEmpty() {
    MultiMap mmap = newMultiMap();
    List<Map.Entry<String, String>> result = mmap.entries();
    assertNotNull(result);
    assertEquals(0, result.size());
  }

  @Test
  public void testGetMissingCharSequenceName() {
    MultiMap mmap = newMultiMap();
    CharSequence name = String.valueOf(new Object());
    assertNull(mmap.get(name));
  }

  @Test
  public void testGetMissingStringName() {
    MultiMap mmap = newMultiMap();
    String name = "1";
    assertNull(mmap.get(name));
  }

  @Test
  public void testGetStringName() {
    MultiMap mmap = newMultiMap();
    assertNull(mmap.get("name"));
    mmap.add("name", "value");
    assertEquals("value", mmap.get("name"));
  }

  @Test(expected = NullPointerException.class)
  public void testGetNullStringName() {
    newMultiMap().get(null);
  }

  @Test
  public void testGetAllTestMissingName() {
    MultiMap mmap = newMultiMap();
    List<String> result = mmap.getAll("1");
    assertNotNull(result);
    assertEquals(0, result.size());
  }

  @Test
  public void testGetAll() {
    MultiMap mmap = newMultiMap();
    mmap.add("name", "value1");
    mmap.add("name", "value2");
    List<String> result = mmap.getAll("name");
    assertNotNull(result);
    assertEquals(2, result.size());
    assertEquals("value1", result.get(0));
  }

  @Test(expected = NullPointerException.class)
  public void testGetAllNullName() {
    newMultiMap().getAll(null);
  }

  @Test
  public void testIsEmptyEmpty() {
    MultiMap mmap = newMultiMap();
    assertTrue(mmap.isEmpty());
  }

  @Test
  public void testIsEmptyNonEmpty() {
    MultiMap mmap = newMultiMap();
    mmap.add("a", "b");
    assertFalse(mmap.isEmpty());
  }

  @Test
  public void testIteratorEmpty() {
    MultiMap mmap = newMultiMap();
    Iterator<Map.Entry<String, String>> result = mmap.iterator();
    assertNotNull(result);
    assertFalse(result.hasNext());
  }

  @Test
  public void testIterator() {
    MultiMap mmap = newMultiMap();
    mmap.add("a", "b");
    Iterator<Map.Entry<String, String>> result = mmap.iterator();
    assertNotNull(result);
    assertTrue(result.hasNext());
  }

  @Test
  public void testNamesEmpty() {
    MultiMap mmap = newMultiMap();
    Set<String> result = mmap.names();
    assertNotNull(result);
    assertEquals(0, result.size());
  }

  @Test
  public void testRemoveMissingName() {
    MultiMap mmap = newMultiMap();
    CharSequence name = String.valueOf(new Object());
    MultiMap result = mmap.remove(name);
    assertNotNull(result);
    assertTrue(result.isEmpty());
    assertEquals(0, result.size());
  }

  @Test(expected = NullPointerException.class)
  public void testRemoveNullName() {
    newMultiMap().remove(null);
  }

  @Test
  public void testRemove() {
    MultiMap mmap = newMultiMap();
    mmap.add("name", "value");
    assertTrue(mmap.contains("name"));
    assertSame(mmap, mmap.remove("name"));
    assertFalse(mmap.contains("name"));
  }

  @Test
  public void testSetAll() {
    MultiMap mmap = newMultiMap();
    HashMap<String, String> map = new HashMap<>();
    map.put("aaa", "bbb");
    MultiMap result = mmap.setAll(map);
    assertNotNull(result);
    assertFalse(result.isEmpty());
    assertEquals(1, result.size());
    assertEquals("aaa=bbb\n", result.toString());
  }

  @Test
  public void testSetAllEmptyMap() {
    MultiMap mmap = newMultiMap();
    MultiMap result = mmap.setAll(new HashMap<>());
    assertNotNull(result);
    assertTrue(result.isEmpty());
    assertEquals(0, result.size());
    assertEquals("", result.toString());
  }

  @Test
  public void testSetAllEmptyMultiMap() {
    MultiMap mmap = newMultiMap();
    MultiMap result = mmap.setAll(newMultiMap());
    assertNotNull(result);
    assertTrue(result.isEmpty());
    assertEquals(0, result.size());
    assertEquals("", result.toString());
  }

  @Test
  public void testSetCharSequenceNameCharSequenceValue() {
    MultiMap mmap = newMultiMap();
    CharSequence name = "name";
    CharSequence value = "value";
    MultiMap result = mmap.set(name, value);
    assertNotNull(result);
    assertFalse(result.isEmpty());
    assertEquals(1, result.size());
    assertEquals("name" + separator + "value\n", result.toString());
  }

  @Test
  public void testSetCharSequenceNameIterableCharSequenceValue() {
    MultiMap mmap = newMultiMap();
    CharSequence name = "name";
    ArrayList<CharSequence> values = new ArrayList<>();
    values.add("somevalue");
    assertEquals("name" + separator + "somevalue\n", mmap.set(name, values).toString());
  }

  @Test
  public void testSetStringNameStringValue() {
    MultiMap mmap = newMultiMap();
    String name = "aaa";
    String strVal = "bbb";
    MultiMap result = mmap.set(name, strVal);
    assertNotNull(result);
    assertFalse(result.isEmpty());
    assertEquals(1, result.size());
    assertEquals("aaa" + separator + "bbb\n", result.toString());
  }

  @Test
  public void testSetStringNameEmptyStringValue() {
    MultiMap mmap = newMultiMap();
    String name = "aaa";
    String strVal = "";
    MultiMap result = mmap.set(name, strVal);
    assertNotNull(result);
    assertFalse(result.isEmpty());
    assertEquals(1, result.size());
    assertEquals("aaa" + separator + "\n", result.toString());
  }

  @Test
  public void testSetNullCharSequenceValue() {
    MultiMap mmap = newMultiMap();
    mmap.set("name", "value");
    mmap.set("name", (CharSequence) null);
    assertFalse(mmap.contains("name"));
    assertTrue(mmap.isEmpty());
    assertFalse(mmap.iterator().hasNext());
  }

  @Test
  public void testSetNullStringValue() {
    MultiMap mmap = newMultiMap();
    mmap.set("name", "value");
    mmap.set("name", (String) null);
    assertFalse(mmap.contains("name"));
    assertTrue(mmap.isEmpty());
    assertFalse(mmap.iterator().hasNext());
  }

  @Test(expected = NullPointerException.class)
  public void testSetNullIterableStringValue() {
    newMultiMap().set("name", (Iterable<String>) null);
  }

  @Test(expected = NullPointerException.class)
  public void testSetNullIterableCharSequenceValue() {
    newMultiMap().set("name", (Iterable<String>) null);
  }

  @Test
  public void testSetEmptyIterableStringValue() {
    MultiMap mmap = newMultiMap();
    String name = "name";
    List<String> values = new ArrayList<>();
    MultiMap result = mmap.set(name, values);
    assertNotNull(result);
    assertTrue(result.isEmpty());
    assertEquals(0, result.size());
    assertEquals("", result.toString());
  }

  @Test
  public void testSetEmptyIterableCharSequenceValue() {
    MultiMap mmap = newMultiMap();
    String name = "name";
    List<CharSequence> values = new ArrayList<>();
    MultiMap result = mmap.set(name, values);
    assertNotNull(result);
    assertTrue(result.isEmpty());
    assertEquals(0, result.size());
    assertEquals("", result.toString());
  }

  @Test
  public void testSetIterableStringValue() {
    MultiMap mmap = newMultiMap();
    String name = "name";
    List<String> values = new ArrayList<>();
    values.add("value1");
    values.add(null);
    values.add("value3");
    MultiMap result = mmap.set(name, values);
    assertNotNull(result);
    assertFalse(result.isEmpty());
    assertEquals(1, result.size());
    assertEquals("name" + separator + "value1\n", result.toString());
  }

  @Test
  public void testSize() {
    MultiMap mmap = newMultiMap();
    assertEquals(0, mmap.size());
    mmap.add("header", "value");
    assertEquals(1, mmap.size());
    mmap.add("header2", "value2");
    assertEquals(2, mmap.size());
    mmap.add("header", "value3");
    assertEquals(2, mmap.size());
  }

  // we have to sort the string since a map doesn't do sorting
  private String sortByLine(String str) {
    String[] lines = str.split("\n");
    Arrays.sort(lines);
    StringBuilder sb = new StringBuilder();
    for (String s:lines) {
      sb.append(s);
      sb.append("\n");
    }
    return sb.toString();
  }

  @Test
  public void testToString() {
    MultiMap mm = newMultiMap();
    assertEquals("", mm.toString());
    mm.add("header1", "Value1");
    assertEquals("header1" + separator + "Value1\n", sortByLine(mm.toString()));
    mm.add("header2", "Value2");
    assertEquals("header1" + separator + "Value1\nheader2" + separator + "Value2\n", sortByLine(mm.toString()));
    mm.add("header1", "Value3");
    assertEquals("header1" + separator + "Value1\nheader1" + separator + "Value3\nheader2" + separator + "Value2\n", sortByLine(mm.toString()));
    mm.remove("header1");
    assertEquals("header2" + separator + "Value2\n", sortByLine(mm.toString()));
    mm.set("header2", "Value4");
    assertEquals("header2" + separator + "Value4\n", sortByLine(mm.toString()));
  }

  /*
   * unit tests for public method in MapEntry
   * (isn't actually used in the implementation)
   */

  @Test
  public void testMapEntrySetValue() {
    MultiMap mmap = newMultiMap();
    mmap.add("header", "oldvalue");
    for (Map.Entry<String, String> me : mmap) {
      me.setValue("newvalue");
    }
    assertEquals("newvalue", mmap.get("header"));
  }

  @Test
  public void testMapEntryToString() {
    MultiMap mmap = newMultiMap();
    mmap.add("header", "value");
    assertEquals("header" + separator + "value", mmap.iterator().next().toString());
  }

  @Test(expected = NullPointerException.class)
  public void testMapEntrySetValueNull() {
    MultiMap mmap = newMultiMap();
    mmap.add("header", "oldvalue");
    for (Map.Entry<String, String> me:mmap) {
      me.setValue(null);
    }
  }

  @Test
  public void testContainsValueString() {
    MultiMap mmap = newMultiMap();
    mmap.add("headeR", "vAlue");
    assertTrue(mmap.contains("heaDer", "vAlue", false));
    assertFalse(mmap.contains("heaDer", "Value", false));
  }

  @Test
  public void testContainsValueStringIgnoreCase() {
    MultiMap mmap = newMultiMap();
    mmap.add("headeR", "vAlue");
    assertTrue(mmap.contains("heaDer", "vAlue", true));
    assertTrue(mmap.contains("heaDer", "Value", true));
  }

  @Test
  public void testContainsValueCharSequence() {
    MultiMap mmap = newMultiMap();
    mmap.add("headeR", "vAlue");
    CharSequence name = HttpHeaders.createOptimized("heaDer");
    CharSequence vAlue = HttpHeaders.createOptimized("vAlue");
    CharSequence Value = HttpHeaders.createOptimized("Value");
    assertTrue(mmap.contains(name, vAlue, false));
    assertFalse(mmap.contains(name, Value, false));
  }

  @Test
  public void testContainsValueCharSequenceIgnoreCase() {
    MultiMap mmap = newMultiMap();
    mmap.add("headeR", "vAlue");
    CharSequence name = HttpHeaders.createOptimized("heaDer");
    CharSequence vAlue = HttpHeaders.createOptimized("vAlue");
    CharSequence Value = HttpHeaders.createOptimized("Value");
    assertTrue(mmap.contains(name, vAlue, true));
    assertTrue(mmap.contains(name, Value, true));
  }

  @Test
  public void testGetShouldReturnAddedEntriesInOrder() {
    MultiMap mmap = newMultiMap();
    mmap.add("header", "value1");
    mmap.add("header", "value2");
    mmap.add("header", "value3");
    assertEquals("value1", mmap.get("header"));
    assertEquals(Arrays.asList("value1", "value2", "value3"), mmap.getAll("header"));
  }

  @Test
  public void testGetShouldReturnEntriesFromListInOrder() {
    MultiMap mmap = newMultiMap();
    mmap.add("header", Arrays.<CharSequence>asList("value1", "value2", "value3"));
    assertEquals("value1", mmap.get("header"));
    assertEquals(Arrays.asList("value1", "value2", "value3"), mmap.getAll("header"));
  }
}
