/*

 * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved.

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

 */

/*

 * @test

 * @summary Test Map default methods

 * @author Mike Duigou

 * @run testng Defaults

 */

import java.util.AbstractMap;

import java.util.AbstractSet;

import java.util.ArrayList;

import java.util.Arrays;

import java.util.Collection;

import java.util.Collections;

import java.util.EnumMap;

import java.util.HashMap;

import java.util.HashSet;

import java.util.Hashtable;

import java.util.IdentityHashMap;

import java.util.Iterator;

import java.util.LinkedHashMap;

import java.util.Map;

import java.util.TreeMap;

import java.util.Set;

import java.util.WeakHashMap;

import java.util.concurrent.ConcurrentMap;

import java.util.concurrent.ConcurrentHashMap;

import java.util.concurrent.ConcurrentSkipListMap;

import java.util.function.BiFunction;

import java.util.function.Supplier;

import org.testng.annotations.Test;

import org.testng.annotations.DataProvider;

import static org.testng.Assert.fail;

import static org.testng.Assert.assertEquals;

import static org.testng.Assert.assertTrue;

import static org.testng.Assert.assertFalse;

import static org.testng.Assert.assertNull;

import static org.testng.Assert.assertSame;

public class Defaults {

    @Test(dataProvider = "Map<IntegerEnum,String> rw=all keys=withNull values=withNull")

    public void testGetOrDefaultNulls(String description, Map<IntegerEnum, String> map) {

        assertTrue(map.containsKey(null), description + ": null key absent");

        assertNull(map.get(null), description + ": value not null");

        assertSame(map.get(null), map.getOrDefault(null, EXTRA_VALUE), description + ": values should match");

    }

    @Test(dataProvider = "Map<IntegerEnum,String> rw=all keys=all values=all")

    public void testGetOrDefault(String description, Map<IntegerEnum, String> map) {

        assertTrue(map.containsKey(KEYS[1]), "expected key missing");

        assertSame(map.get(KEYS[1]), map.getOrDefault(KEYS[1], EXTRA_VALUE), "values should match");

        assertFalse(map.containsKey(EXTRA_KEY), "expected absent key");

        assertSame(map.getOrDefault(EXTRA_KEY, EXTRA_VALUE), EXTRA_VALUE, "value not returned as default");

        assertNull(map.getOrDefault(EXTRA_KEY, null), "null not returned as default");

    }

    @Test(dataProvider = "Map<IntegerEnum,String> rw=true keys=withNull values=withNull")

    public void testPutIfAbsentNulls(String description, Map<IntegerEnum, String> map) {

        assertTrue(map.containsKey(null), "null key absent");

        assertNull(map.get(null), "value not null");

        assertNull(map.putIfAbsent(null, EXTRA_VALUE), "previous not null");

        assertTrue(map.containsKey(null), "null key absent");

        assertSame(map.get(null), EXTRA_VALUE, "unexpected value");

        assertSame(map.putIfAbsent(null, null), EXTRA_VALUE, "previous not expected value");

        assertTrue(map.containsKey(null), "null key absent");

        assertSame(map.get(null), EXTRA_VALUE, "unexpected value");

        assertSame(map.remove(null), EXTRA_VALUE, "removed unexpected value");

        assertFalse(map.containsKey(null), description + ": key present after remove");

        assertNull(map.putIfAbsent(null, null), "previous not null");

        assertTrue(map.containsKey(null), "null key absent");

        assertNull(map.get(null), "value not null");

        assertNull(map.putIfAbsent(null, EXTRA_VALUE), "previous not null");

        assertSame(map.get(null), EXTRA_VALUE, "value not expected");

    }

    @Test(dataProvider = "Map<IntegerEnum,String> rw=true keys=all values=all")

    public void testPutIfAbsent(String description, Map<IntegerEnum, String> map) {

        assertTrue(map.containsKey(KEYS[1]));

        Object expected = map.get(KEYS[1]);

        assertTrue(null == expected || expected == VALUES[1]);

        assertSame(map.putIfAbsent(KEYS[1], EXTRA_VALUE), expected);

        assertSame(map.get(KEYS[1]), expected);

        assertFalse(map.containsKey(EXTRA_KEY));

        assertSame(map.putIfAbsent(EXTRA_KEY, EXTRA_VALUE), null);

        assertSame(map.get(EXTRA_KEY), EXTRA_VALUE);

    }

    @Test(dataProvider = "Map<IntegerEnum,String> rw=all keys=all values=all")

    public void testForEach(String description, Map<IntegerEnum, String> map) {

        IntegerEnum[] EACH_KEY = new IntegerEnum[map.size()];

        map.forEach((k, v) -> {

            int idx = (null == k) ? 0 : k.ordinal(); // substitute for index.

            assertNull(EACH_KEY[idx]);

            EACH_KEY[idx] = (idx == 0) ? KEYS[0] : k; // substitute for comparison.

            assertSame(v, map.get(k));

        });

        assertEquals(KEYS, EACH_KEY, description);

    }

    @Test(dataProvider = "Map<IntegerEnum,String> rw=true keys=all values=all")

    public static void testReplaceAll(String description, Map<IntegerEnum, String> map) {

        IntegerEnum[] EACH_KEY = new IntegerEnum[map.size()];

        Set<String> EACH_REPLACE = new HashSet<>(map.size());

        map.replaceAll((k,v) -> {

            int idx = (null == k) ? 0 : k.ordinal(); // substitute for index.

            assertNull(EACH_KEY[idx]);

            EACH_KEY[idx] = (idx == 0) ? KEYS[0] : k; // substitute for comparison.

            assertSame(v, map.get(k));

            String replacement = v + " replaced";

            EACH_REPLACE.add(replacement);

            return replacement;

        });

        assertEquals(KEYS, EACH_KEY, description);

        assertEquals(map.values().size(), EACH_REPLACE.size(), description + EACH_REPLACE);

        assertTrue(EACH_REPLACE.containsAll(map.values()), description + " : " + EACH_REPLACE + " != " + map.values());

        assertTrue(map.values().containsAll(EACH_REPLACE), description + " : " + EACH_REPLACE + " != " + map.values());

    }

    @Test(dataProvider = "Map<IntegerEnum,String> rw=true keys=nonNull values=nonNull")

    public static void testReplaceAllNoNullReplacement(String description, Map<IntegerEnum, String> map) {

        assertThrows(

            () -> { map.replaceAll(null); },

            NullPointerException.class,

            description);

        assertThrows(

            () -> { map.replaceAll((k,v) -> null); },

            NullPointerException.class,

            description + " should not allow replacement with null value");

    }

    @Test(dataProvider = "Map<IntegerEnum,String> rw=true keys=withNull values=withNull")

    public static void testRemoveNulls(String description, Map<IntegerEnum, String> map) {

        assertTrue(map.containsKey(null), "null key absent");

        assertNull(map.get(null), "value not null");

        assertFalse(map.remove(null, EXTRA_VALUE), description);

        assertTrue(map.containsKey(null));

        assertNull(map.get(null));

        assertTrue(map.remove(null, null));

        assertFalse(map.containsKey(null));

        assertNull(map.get(null));

        assertFalse(map.remove(null, null));

    }

    @Test(dataProvider = "Map<IntegerEnum,String> rw=true keys=all values=all")

    public static void testRemove(String description, Map<IntegerEnum, String> map) {

        assertTrue(map.containsKey(KEYS[1]));

        Object expected = map.get(KEYS[1]);

        assertTrue(null == expected || expected == VALUES[1]);

        assertFalse(map.remove(KEYS[1], EXTRA_VALUE), description);

        assertSame(map.get(KEYS[1]), expected);

        assertTrue(map.remove(KEYS[1], expected));

        assertNull(map.get(KEYS[1]));

        assertFalse(map.remove(KEYS[1], expected));

        assertFalse(map.containsKey(EXTRA_KEY));

        assertFalse(map.remove(EXTRA_KEY, EXTRA_VALUE));

    }

    @Test(dataProvider = "Map<IntegerEnum,String> rw=true keys=withNull values=withNull")

    public void testReplaceKVNulls(String description, Map<IntegerEnum, String> map) {

        assertTrue(map.containsKey(null), "null key absent");

        assertNull(map.get(null), "value not null");

        assertSame(map.replace(null, EXTRA_VALUE), null);

        assertSame(map.get(null), EXTRA_VALUE);

    }

    @Test(dataProvider = "Map<IntegerEnum,String> rw=true keys=nonNull values=nonNull")

    public void testReplaceKVNoNulls(String description, Map<IntegerEnum, String> map) {

        assertTrue(map.containsKey(FIRST_KEY), "expected key missing");

        assertSame(map.get(FIRST_KEY), FIRST_VALUE, "found wrong value");

        assertThrows( () -> {map.replace(FIRST_KEY, null);}, NullPointerException.class, description + ": should throw NPE");

        assertSame(map.replace(FIRST_KEY, EXTRA_VALUE), FIRST_VALUE, description + ": replaced wrong value");

        assertSame(map.get(FIRST_KEY), EXTRA_VALUE, "found wrong value");

    }

    @Test(dataProvider = "Map<IntegerEnum,String> rw=true keys=all values=all")

    public void testReplaceKV(String description, Map<IntegerEnum, String> map) {

        assertTrue(map.containsKey(KEYS[1]));

        Object expected = map.get(KEYS[1]);

        assertTrue(null == expected || expected == VALUES[1]);

        assertSame(map.replace(KEYS[1], EXTRA_VALUE), expected);

        assertSame(map.get(KEYS[1]), EXTRA_VALUE);

        assertFalse(map.containsKey(EXTRA_KEY));

        assertNull(map.replace(EXTRA_KEY, EXTRA_VALUE));

        assertFalse(map.containsKey(EXTRA_KEY));

        assertNull(map.get(EXTRA_KEY));

        assertNull(map.put(EXTRA_KEY, EXTRA_VALUE));

        assertSame(map.get(EXTRA_KEY), EXTRA_VALUE);

        assertSame(map.replace(EXTRA_KEY, (String)expected), EXTRA_VALUE);

        assertSame(map.get(EXTRA_KEY), expected);

    }

    @Test(dataProvider = "Map<IntegerEnum,String> rw=true keys=withNull values=withNull")

    public void testReplaceKVVNulls(String description, Map<IntegerEnum, String> map) {

        assertTrue(map.containsKey(null), "null key absent");

        assertNull(map.get(null), "value not null");

        assertFalse(map.replace(null, EXTRA_VALUE, EXTRA_VALUE));

        assertNull(map.get(null));

        assertTrue(map.replace(null, null, EXTRA_VALUE));

        assertSame(map.get(null), EXTRA_VALUE);

        assertTrue(map.replace(null, EXTRA_VALUE, EXTRA_VALUE));

        assertSame(map.get(null), EXTRA_VALUE);

    }

    @Test(dataProvider = "Map<IntegerEnum,String> rw=true keys=nonNull values=nonNull")

    public void testReplaceKVVNoNulls(String description, Map<IntegerEnum, String> map) {

        assertTrue(map.containsKey(FIRST_KEY), "expected key missing");

        assertSame(map.get(FIRST_KEY), FIRST_VALUE, "found wrong value");

        assertThrows( () -> {map.replace(FIRST_KEY, FIRST_VALUE, null);}, NullPointerException.class, description + ": should throw NPE");

        assertThrows( () -> {if (!map.replace(FIRST_KEY, null, EXTRA_VALUE)) throw new NullPointerException("default returns false rather than throwing");}, NullPointerException.class,  description + ": should throw NPE");

        assertTrue(map.replace(FIRST_KEY, FIRST_VALUE, EXTRA_VALUE), description + ": replaced wrong value");

        assertSame(map.get(FIRST_KEY), EXTRA_VALUE, "found wrong value");

    }

    @Test(dataProvider = "Map<IntegerEnum,String> rw=true keys=all values=all")

    public void testReplaceKVV(String description, Map<IntegerEnum, String> map) {

        assertTrue(map.containsKey(KEYS[1]));

        Object expected = map.get(KEYS[1]);

        assertTrue(null == expected || expected == VALUES[1]);

        assertFalse(map.replace(KEYS[1], EXTRA_VALUE, EXTRA_VALUE));

        assertSame(map.get(KEYS[1]), expected);

        assertTrue(map.replace(KEYS[1], (String)expected, EXTRA_VALUE));

        assertSame(map.get(KEYS[1]), EXTRA_VALUE);

        assertTrue(map.replace(KEYS[1], EXTRA_VALUE, EXTRA_VALUE));

        assertSame(map.get(KEYS[1]), EXTRA_VALUE);

        assertFalse(map.containsKey(EXTRA_KEY));

        assertFalse(map.replace(EXTRA_KEY, EXTRA_VALUE, EXTRA_VALUE));

        assertFalse(map.containsKey(EXTRA_KEY));

        assertNull(map.get(EXTRA_KEY));

        assertNull(map.put(EXTRA_KEY, EXTRA_VALUE));

        assertTrue(map.containsKey(EXTRA_KEY));

        assertSame(map.get(EXTRA_KEY), EXTRA_VALUE);

        assertTrue(map.replace(EXTRA_KEY, EXTRA_VALUE, EXTRA_VALUE));

        assertSame(map.get(EXTRA_KEY), EXTRA_VALUE);

    }

    @Test(dataProvider = "Map<IntegerEnum,String> rw=true keys=withNull values=withNull")

    public void testComputeIfAbsentNulls(String description, Map<IntegerEnum, String> map) {

        assertTrue(map.containsKey(null), "null key absent");

        assertNull(map.get(null), "value not null");

        assertSame(map.computeIfAbsent(null, (k) -> EXTRA_VALUE), EXTRA_VALUE, description);

        assertSame(map.get(null), EXTRA_VALUE, description);

    }

    @Test(dataProvider = "Map<IntegerEnum,String> rw=true keys=all values=all")

    public void testComputeIfAbsent(String description, Map<IntegerEnum, String> map) {

        assertTrue(map.containsKey(KEYS[1]));

        Object expected = map.get(KEYS[1]);

        assertTrue(null == expected || expected == VALUES[1], description + String.valueOf(expected));

        expected = (null == expected) ? EXTRA_VALUE : expected;

        assertSame(map.computeIfAbsent(KEYS[1], (k) -> EXTRA_VALUE), expected, description);

        assertSame(map.get(KEYS[1]), expected, description);

        assertFalse(map.containsKey(EXTRA_KEY));

        assertSame(map.computeIfAbsent(EXTRA_KEY, (k) -> EXTRA_VALUE), EXTRA_VALUE);

        assertSame(map.get(EXTRA_KEY), EXTRA_VALUE);

    }

    @Test(dataProvider = "Map<IntegerEnum,String> rw=true keys=withNull values=withNull")

    public void testComputeIfPresentNulls(String description, Map<IntegerEnum, String> map) {

        assertTrue(map.containsKey(null), description + ": null key absent");

        assertNull(map.get(null), description + ": value not null");

        assertSame(map.computeIfPresent(null, (k, v) -> {

            fail(description + ": null value is not deemed present");

            return EXTRA_VALUE;

        }), null, description);

        assertTrue(map.containsKey(null));

        assertNull(map.get(null), description);

        assertNull(map.remove(EXTRA_KEY), description + ": unexpected mapping");

        assertNull(map.put(EXTRA_KEY, null), description + ": unexpected value");

        assertSame(map.computeIfPresent(EXTRA_KEY, (k, v) -> {

            fail(description + ": null value is not deemed present");

            return EXTRA_VALUE;

        }), null, description);

        assertNull(map.get(EXTRA_KEY), description + ": null mapping gone");

    }

    @Test(dataProvider = "Map<IntegerEnum,String> rw=true keys=all values=all")

    public void testComputeIfPresent(String description, Map<IntegerEnum, String> map) {

        assertTrue(map.containsKey(KEYS[1]));

        Object value = map.get(KEYS[1]);

        assertTrue(null == value || value == VALUES[1], description + String.valueOf(value));

        Object expected = (null == value) ? null : EXTRA_VALUE;

        assertSame(map.computeIfPresent(KEYS[1], (k, v) -> {

            assertSame(v, value);

            return EXTRA_VALUE;

        }), expected, description);

        assertSame(map.get(KEYS[1]), expected, description);

        assertFalse(map.containsKey(EXTRA_KEY));

        assertSame(map.computeIfPresent(EXTRA_KEY, (k, v) -> {

            fail();

            return EXTRA_VALUE;

        }), null);

        assertFalse(map.containsKey(EXTRA_KEY));

        assertSame(map.get(EXTRA_KEY), null);

    }

    @Test(dataProvider = "Map<IntegerEnum,String> rw=true keys=withNull values=withNull")

    public void testComputeNulls(String description, Map<IntegerEnum, String> map) {

        assertTrue(map.containsKey(null), "null key absent");

        assertNull(map.get(null), "value not null");

        assertSame(map.compute(null, (k, v) -> {

            assertNull(k);

            assertNull(v);

            return null;

        }), null, description);

        assertFalse(map.containsKey(null), description + ": null key present.");

        assertSame(map.compute(null, (k, v) -> {

            assertSame(k, null);

            assertNull(v);

            return EXTRA_VALUE;

        }), EXTRA_VALUE, description);

        assertTrue(map.containsKey(null));

        assertSame(map.get(null), EXTRA_VALUE, description);

        assertSame(map.remove(null), EXTRA_VALUE, description + ": removed value not expected");

        // no mapping before and after

        assertFalse(map.containsKey(null), description + ": null key present");

        assertSame(map.compute(null, (k, v) -> {

            assertNull(k);

            assertNull(v);

            return null;

        }), null, description + ": expected null result" );

        assertFalse(map.containsKey(null), description + ": null key present");

        // compute with map not containing value

        assertNull(map.remove(EXTRA_KEY),  description + ": unexpected mapping");

        assertFalse(map.containsKey(EXTRA_KEY),  description + ": key present");

        assertSame(map.compute(EXTRA_KEY, (k, v) -> {

            assertSame(k, EXTRA_KEY);

            assertNull(v);

            return null;

        }), null, description);

        assertFalse(map.containsKey(EXTRA_KEY),  description + ": null key present");

        // ensure removal.

        assertNull(map.put(EXTRA_KEY, EXTRA_VALUE));

        assertSame(map.compute(EXTRA_KEY, (k, v) -> {

            assertSame(k, EXTRA_KEY);

            assertSame(v, EXTRA_VALUE);

            return null;

        }), null, description + ": null resulted expected");

        assertFalse(map.containsKey(EXTRA_KEY),  description + ": null key present");

       // compute with map containing null value

        assertNull(map.put(EXTRA_KEY, null),  description + ": unexpected value");

        assertSame(map.compute(EXTRA_KEY, (k, v) -> {

            assertSame(k, EXTRA_KEY);

            assertNull(v);

            return null;

        }), null, description);

        assertFalse(map.containsKey(EXTRA_KEY),  description + ": null key present");

        assertNull(map.put(EXTRA_KEY, null),  description + ": unexpected value");

        assertSame(map.compute(EXTRA_KEY, (k, v) -> {

            assertSame(k, EXTRA_KEY);

            assertNull(v);

            return EXTRA_VALUE;

        }), EXTRA_VALUE, description);

        assertTrue(map.containsKey(EXTRA_KEY), "null key present");

    }

    @Test(dataProvider = "Map<IntegerEnum,String> rw=true keys=all values=all")

    public void testCompute(String description, Map<IntegerEnum, String> map) {

        assertTrue(map.containsKey(KEYS[1]));

        Object value = map.get(KEYS[1]);

        assertTrue(null == value || value == VALUES[1], description + String.valueOf(value));

        assertSame(map.compute(KEYS[1], (k, v) -> {

            assertSame(k, KEYS[1]);

            assertSame(v, value);

            return EXTRA_VALUE;

        }), EXTRA_VALUE, description);

        assertSame(map.get(KEYS[1]), EXTRA_VALUE, description);

        assertNull(map.compute(KEYS[1], (k, v) -> {

            assertSame(v, EXTRA_VALUE);

            return null;

        }), description);

        assertFalse(map.containsKey(KEYS[1]));

        assertFalse(map.containsKey(EXTRA_KEY));

        assertSame(map.compute(EXTRA_KEY, (k, v) -> {

            assertNull(v);

            return EXTRA_VALUE;

        }), EXTRA_VALUE);

        assertTrue(map.containsKey(EXTRA_KEY));

        assertSame(map.get(EXTRA_KEY), EXTRA_VALUE);

    }

    @Test(dataProvider = "Map<IntegerEnum,String> rw=true keys=withNull values=withNull")

    public void testMergeNulls(String description, Map<IntegerEnum, String> map) {

        assertTrue(map.containsKey(null), "null key absent");

        assertNull(map.get(null), "value not null");

        assertSame(map.merge(null, EXTRA_VALUE, (v, vv) -> {

            assertNull(v);

            assertSame(vv, EXTRA_VALUE);

            return vv;

        }), EXTRA_VALUE, description);

        assertTrue(map.containsKey(null));

        assertSame(map.get(null), EXTRA_VALUE, description);

    }

    @Test(dataProvider = "Map<IntegerEnum,String> rw=true keys=all values=all")

    public void testMerge(String description, Map<IntegerEnum, String> map) {

        assertTrue(map.containsKey(KEYS[1]));

        Object value = map.get(KEYS[1]);

        assertTrue(null == value || value == VALUES[1], description + String.valueOf(value));

        assertSame(map.merge(KEYS[1], EXTRA_VALUE, (v, vv) -> {

            assertSame(v, value);

            assertSame(vv, EXTRA_VALUE);

            return vv;

        }), EXTRA_VALUE, description);

        assertSame(map.get(KEYS[1]), EXTRA_VALUE, description);

        assertNull(map.merge(KEYS[1], EXTRA_VALUE, (v, vv) -> {

            assertSame(v, EXTRA_VALUE);

            assertSame(vv, EXTRA_VALUE);

            return null;

        }), description);

        assertFalse(map.containsKey(KEYS[1]));