/* * Copyright (C) 2008 The Guava Authors * * Licensed 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. */ package com.google.common.collect; import static com.google.common.testing.SerializableTester.reserialize; import static com.google.common.truth.Truth.assertThat; import com.google.common.annotations.GwtCompatible; import com.google.common.annotations.GwtIncompatible; import com.google.common.base.Joiner; import com.google.common.collect.ImmutableMap.Builder; import com.google.common.collect.testing.CollectionTestSuiteBuilder; import com.google.common.collect.testing.ListTestSuiteBuilder; import com.google.common.collect.testing.MapInterfaceTest; import com.google.common.collect.testing.MapTestSuiteBuilder; import com.google.common.collect.testing.MinimalSet; import com.google.common.collect.testing.SampleElements.Colliders; import com.google.common.collect.testing.SampleElements.Unhashables; import com.google.common.collect.testing.UnhashableObject; import com.google.common.collect.testing.features.CollectionFeature; import com.google.common.collect.testing.features.CollectionSize; import com.google.common.collect.testing.features.MapFeature; import com.google.common.collect.testing.google.MapGenerators.ImmutableMapCopyOfEntriesGenerator; import com.google.common.collect.testing.google.MapGenerators.ImmutableMapCopyOfEnumMapGenerator; import com.google.common.collect.testing.google.MapGenerators.ImmutableMapCopyOfGenerator; import com.google.common.collect.testing.google.MapGenerators.ImmutableMapEntryListGenerator; import com.google.common.collect.testing.google.MapGenerators.ImmutableMapGenerator; import com.google.common.collect.testing.google.MapGenerators.ImmutableMapKeyListGenerator; import com.google.common.collect.testing.google.MapGenerators.ImmutableMapUnhashableValuesGenerator; import com.google.common.collect.testing.google.MapGenerators.ImmutableMapValueListGenerator; import com.google.common.collect.testing.google.MapGenerators.ImmutableMapValuesAsSingletonSetGenerator; import com.google.common.testing.EqualsTester; import com.google.common.testing.NullPointerTester; import com.google.common.testing.SerializableTester; import java.io.ByteArrayOutputStream; import java.io.ObjectOutputStream; import java.io.Serializable; import java.util.Collection; import java.util.Collections; import java.util.LinkedHashMap; import java.util.Map; import java.util.Map.Entry; import java.util.Set; import junit.framework.Test; import junit.framework.TestCase; import junit.framework.TestSuite; /** * Tests for {@link ImmutableMap}. * * @author Kevin Bourrillion * @author Jesse Wilson */ @GwtCompatible(emulated = true) public class ImmutableMapTest extends TestCase { @GwtIncompatible // suite public static Test suite() { TestSuite suite = new TestSuite(); suite.addTestSuite(ImmutableMapTest.class); suite.addTest( MapTestSuiteBuilder.using(new ImmutableMapGenerator()) .withFeatures( CollectionSize.ANY, CollectionFeature.SERIALIZABLE_INCLUDING_VIEWS, CollectionFeature.KNOWN_ORDER, MapFeature.REJECTS_DUPLICATES_AT_CREATION, CollectionFeature.ALLOWS_NULL_QUERIES) .named("ImmutableMap") .createTestSuite()); suite.addTest( MapTestSuiteBuilder.using(new ImmutableMapCopyOfGenerator()) .withFeatures( CollectionSize.ANY, CollectionFeature.SERIALIZABLE_INCLUDING_VIEWS, CollectionFeature.KNOWN_ORDER, CollectionFeature.ALLOWS_NULL_QUERIES) .named("ImmutableMap.copyOf[Map]") .createTestSuite()); suite.addTest( MapTestSuiteBuilder.using(new ImmutableMapCopyOfEntriesGenerator()) .withFeatures( CollectionSize.ANY, MapFeature.REJECTS_DUPLICATES_AT_CREATION, CollectionFeature.SERIALIZABLE_INCLUDING_VIEWS, CollectionFeature.KNOWN_ORDER, CollectionFeature.ALLOWS_NULL_QUERIES) .named("ImmutableMap.copyOf[Iterable]") .createTestSuite()); suite.addTest( MapTestSuiteBuilder.using(new ImmutableMapCopyOfEnumMapGenerator()) .withFeatures( CollectionSize.ANY, CollectionFeature.SERIALIZABLE_INCLUDING_VIEWS, CollectionFeature.KNOWN_ORDER, CollectionFeature.ALLOWS_NULL_QUERIES) .named("ImmutableMap.copyOf[EnumMap]") .createTestSuite()); suite.addTest( MapTestSuiteBuilder.using(new ImmutableMapValuesAsSingletonSetGenerator()) .withFeatures( CollectionSize.ANY, MapFeature.REJECTS_DUPLICATES_AT_CREATION, CollectionFeature.KNOWN_ORDER, CollectionFeature.ALLOWS_NULL_QUERIES) .named("ImmutableMap.asMultimap.asMap") .createTestSuite()); suite.addTest( CollectionTestSuiteBuilder.using(new ImmutableMapUnhashableValuesGenerator()) .withFeatures( CollectionSize.ANY, CollectionFeature.KNOWN_ORDER, CollectionFeature.ALLOWS_NULL_QUERIES) .named("ImmutableMap.values, unhashable") .createTestSuite()); suite.addTest( ListTestSuiteBuilder.using(new ImmutableMapKeyListGenerator()) .named("ImmutableMap.keySet.asList") .withFeatures( CollectionSize.ANY, CollectionFeature.SERIALIZABLE, CollectionFeature.REJECTS_DUPLICATES_AT_CREATION, CollectionFeature.ALLOWS_NULL_QUERIES) .createTestSuite()); suite.addTest( ListTestSuiteBuilder.using(new ImmutableMapEntryListGenerator()) .named("ImmutableMap.entrySet.asList") .withFeatures( CollectionSize.ANY, CollectionFeature.SERIALIZABLE, CollectionFeature.REJECTS_DUPLICATES_AT_CREATION, CollectionFeature.ALLOWS_NULL_QUERIES) .createTestSuite()); suite.addTest( ListTestSuiteBuilder.using(new ImmutableMapValueListGenerator()) .named("ImmutableMap.values.asList") .withFeatures( CollectionSize.ANY, CollectionFeature.SERIALIZABLE, CollectionFeature.ALLOWS_NULL_QUERIES) .createTestSuite()); return suite; } public abstract static class AbstractMapTests extends MapInterfaceTest { public AbstractMapTests() { super(false, false, false, false, false); } @Override protected Map makeEmptyMap() { throw new UnsupportedOperationException(); } private static final Joiner joiner = Joiner.on(", "); @Override protected void assertMoreInvariants(Map map) { // TODO: can these be moved to MapInterfaceTest? for (Entry entry : map.entrySet()) { assertEquals(entry.getKey() + "=" + entry.getValue(), entry.toString()); } assertEquals("{" + joiner.join(map.entrySet()) + "}", map.toString()); assertEquals("[" + joiner.join(map.entrySet()) + "]", map.entrySet().toString()); assertEquals("[" + joiner.join(map.keySet()) + "]", map.keySet().toString()); assertEquals("[" + joiner.join(map.values()) + "]", map.values().toString()); assertEquals(MinimalSet.from(map.entrySet()), map.entrySet()); assertEquals(Sets.newHashSet(map.keySet()), map.keySet()); } } public static class MapTests extends AbstractMapTests { @Override protected Map makeEmptyMap() { return ImmutableMap.of(); } @Override protected Map makePopulatedMap() { return ImmutableMap.of("one", 1, "two", 2, "three", 3); } @Override protected String getKeyNotInPopulatedMap() { return "minus one"; } @Override protected Integer getValueNotInPopulatedMap() { return -1; } } public static class SingletonMapTests extends AbstractMapTests { @Override protected Map makePopulatedMap() { return ImmutableMap.of("one", 1); } @Override protected String getKeyNotInPopulatedMap() { return "minus one"; } @Override protected Integer getValueNotInPopulatedMap() { return -1; } } @GwtIncompatible // SerializableTester public static class ReserializedMapTests extends AbstractMapTests { @Override protected Map makePopulatedMap() { return SerializableTester.reserialize(ImmutableMap.of("one", 1, "two", 2, "three", 3)); } @Override protected String getKeyNotInPopulatedMap() { return "minus one"; } @Override protected Integer getValueNotInPopulatedMap() { return -1; } } public static class MapTestsWithBadHashes extends AbstractMapTests { @Override protected Map makeEmptyMap() { throw new UnsupportedOperationException(); } @Override protected Map makePopulatedMap() { Colliders colliders = new Colliders(); return ImmutableMap.of( colliders.e0(), 0, colliders.e1(), 1, colliders.e2(), 2, colliders.e3(), 3); } @Override protected Object getKeyNotInPopulatedMap() { return new Colliders().e4(); } @Override protected Integer getValueNotInPopulatedMap() { return 4; } } @GwtIncompatible // GWT's ImmutableMap emulation is backed by java.util.HashMap. public static class MapTestsWithUnhashableValues extends AbstractMapTests { @Override protected Map makeEmptyMap() { return ImmutableMap.of(); } @Override protected Map makePopulatedMap() { Unhashables unhashables = new Unhashables(); return ImmutableMap.of(0, unhashables.e0(), 1, unhashables.e1(), 2, unhashables.e2()); } @Override protected Integer getKeyNotInPopulatedMap() { return 3; } @Override protected UnhashableObject getValueNotInPopulatedMap() { return new Unhashables().e3(); } } @GwtIncompatible // GWT's ImmutableMap emulation is backed by java.util.HashMap. public static class MapTestsWithSingletonUnhashableValue extends MapTestsWithUnhashableValues { @Override protected Map makePopulatedMap() { Unhashables unhashables = new Unhashables(); return ImmutableMap.of(0, unhashables.e0()); } } public static class CreationTests extends TestCase { public void testEmptyBuilder() { ImmutableMap map = new Builder().build(); assertEquals(Collections.emptyMap(), map); } public void testSingletonBuilder() { ImmutableMap map = new Builder().put("one", 1).build(); assertMapEquals(map, "one", 1); } public void testBuilder() { ImmutableMap map = new Builder() .put("one", 1) .put("two", 2) .put("three", 3) .put("four", 4) .put("five", 5) .build(); assertMapEquals(map, "one", 1, "two", 2, "three", 3, "four", 4, "five", 5); } @GwtIncompatible public void testBuilderExactlySizedReusesArray() { ImmutableMap.Builder builder = ImmutableMap.builderWithExpectedSize(10); Object[] builderArray = builder.alternatingKeysAndValues; for (int i = 0; i < 10; i++) { builder.put(i, i); } Object[] builderArrayAfterPuts = builder.alternatingKeysAndValues; RegularImmutableMap map = (RegularImmutableMap) builder.build(); Object[] mapInternalArray = map.alternatingKeysAndValues; assertSame(builderArray, builderArrayAfterPuts); assertSame(builderArray, mapInternalArray); } public void testBuilder_orderEntriesByValue() { ImmutableMap map = new Builder() .orderEntriesByValue(Ordering.natural()) .put("three", 3) .put("one", 1) .put("five", 5) .put("four", 4) .put("two", 2) .build(); assertMapEquals(map, "one", 1, "two", 2, "three", 3, "four", 4, "five", 5); } public void testBuilder_orderEntriesByValueAfterExactSizeBuild() { Builder builder = new Builder(2).put("four", 4).put("one", 1); ImmutableMap keyOrdered = builder.build(); ImmutableMap valueOrdered = builder.orderEntriesByValue(Ordering.natural()).build(); assertMapEquals(keyOrdered, "four", 4, "one", 1); assertMapEquals(valueOrdered, "one", 1, "four", 4); } public void testBuilder_orderEntriesByValue_usedTwiceFails() { ImmutableMap.Builder builder = new Builder().orderEntriesByValue(Ordering.natural()); try { builder.orderEntriesByValue(Ordering.natural()); fail("Expected IllegalStateException"); } catch (IllegalStateException expected) { } } public void testBuilder_withImmutableEntry() { ImmutableMap map = new Builder().put(Maps.immutableEntry("one", 1)).build(); assertMapEquals(map, "one", 1); } public void testBuilder_withImmutableEntryAndNullContents() { Builder builder = new Builder<>(); try { builder.put(Maps.immutableEntry("one", (Integer) null)); fail(); } catch (NullPointerException expected) { } try { builder.put(Maps.immutableEntry((String) null, 1)); fail(); } catch (NullPointerException expected) { } } private static class StringHolder { String string; } public void testBuilder_withMutableEntry() { ImmutableMap.Builder builder = new Builder<>(); final StringHolder holder = new StringHolder(); holder.string = "one"; Entry entry = new AbstractMapEntry() { @Override public String getKey() { return holder.string; } @Override public Integer getValue() { return 1; } }; builder.put(entry); holder.string = "two"; assertMapEquals(builder.build(), "one", 1); } public void testBuilderPutAllWithEmptyMap() { ImmutableMap map = new Builder().putAll(Collections.emptyMap()).build(); assertEquals(Collections.emptyMap(), map); } public void testBuilderPutAll() { Map toPut = new LinkedHashMap<>(); toPut.put("one", 1); toPut.put("two", 2); toPut.put("three", 3); Map moreToPut = new LinkedHashMap<>(); moreToPut.put("four", 4); moreToPut.put("five", 5); ImmutableMap map = new Builder().putAll(toPut).putAll(moreToPut).build(); assertMapEquals(map, "one", 1, "two", 2, "three", 3, "four", 4, "five", 5); } public void testBuilderReuse() { Builder builder = new Builder<>(); ImmutableMap mapOne = builder.put("one", 1).put("two", 2).build(); ImmutableMap mapTwo = builder.put("three", 3).put("four", 4).build(); assertMapEquals(mapOne, "one", 1, "two", 2); assertMapEquals(mapTwo, "one", 1, "two", 2, "three", 3, "four", 4); } public void testBuilderPutNullKeyFailsAtomically() { Builder builder = new Builder<>(); try { builder.put(null, 1); fail(); } catch (NullPointerException expected) { } builder.put("foo", 2); assertMapEquals(builder.build(), "foo", 2); } public void testBuilderPutImmutableEntryWithNullKeyFailsAtomically() { Builder builder = new Builder<>(); try { builder.put(Maps.immutableEntry((String) null, 1)); fail(); } catch (NullPointerException expected) { } builder.put("foo", 2); assertMapEquals(builder.build(), "foo", 2); } // for GWT compatibility static class SimpleEntry extends AbstractMapEntry { public K key; public V value; SimpleEntry(K key, V value) { this.key = key; this.value = value; } @Override public K getKey() { return key; } @Override public V getValue() { return value; } } public void testBuilderPutMutableEntryWithNullKeyFailsAtomically() { Builder builder = new Builder<>(); try { builder.put(new SimpleEntry(null, 1)); fail(); } catch (NullPointerException expected) { } builder.put("foo", 2); assertMapEquals(builder.build(), "foo", 2); } public void testBuilderPutNullKey() { Builder builder = new Builder<>(); try { builder.put(null, 1); fail(); } catch (NullPointerException expected) { } } public void testBuilderPutNullValue() { Builder builder = new Builder<>(); try { builder.put("one", null); fail(); } catch (NullPointerException expected) { } } public void testBuilderPutNullKeyViaPutAll() { Builder builder = new Builder<>(); try { builder.putAll(Collections.singletonMap(null, 1)); fail(); } catch (NullPointerException expected) { } } public void testBuilderPutNullValueViaPutAll() { Builder builder = new Builder<>(); try { builder.putAll(Collections.singletonMap("one", null)); fail(); } catch (NullPointerException expected) { } } public void testPuttingTheSameKeyTwiceThrowsOnBuild() { Builder builder = new Builder() .put("one", 1) .put("one", 1); // throwing on this line would be even better try { builder.build(); fail(); } catch (IllegalArgumentException expected) { } } public void testOf() { assertMapEquals(ImmutableMap.of("one", 1), "one", 1); assertMapEquals(ImmutableMap.of("one", 1, "two", 2), "one", 1, "two", 2); assertMapEquals( ImmutableMap.of("one", 1, "two", 2, "three", 3), "one", 1, "two", 2, "three", 3); assertMapEquals( ImmutableMap.of("one", 1, "two", 2, "three", 3, "four", 4), "one", 1, "two", 2, "three", 3, "four", 4); assertMapEquals( ImmutableMap.of("one", 1, "two", 2, "three", 3, "four", 4, "five", 5), "one", 1, "two", 2, "three", 3, "four", 4, "five", 5); } public void testOfNullKey() { try { ImmutableMap.of(null, 1); fail(); } catch (NullPointerException expected) { } try { ImmutableMap.of("one", 1, null, 2); fail(); } catch (NullPointerException expected) { } } public void testOfNullValue() { try { ImmutableMap.of("one", null); fail(); } catch (NullPointerException expected) { } try { ImmutableMap.of("one", 1, "two", null); fail(); } catch (NullPointerException expected) { } } public void testOfWithDuplicateKey() { try { ImmutableMap.of("one", 1, "one", 1); fail(); } catch (IllegalArgumentException expected) { } } public void testCopyOfEmptyMap() { ImmutableMap copy = ImmutableMap.copyOf(Collections.emptyMap()); assertEquals(Collections.emptyMap(), copy); assertSame(copy, ImmutableMap.copyOf(copy)); } public void testCopyOfSingletonMap() { ImmutableMap copy = ImmutableMap.copyOf(Collections.singletonMap("one", 1)); assertMapEquals(copy, "one", 1); assertSame(copy, ImmutableMap.copyOf(copy)); } public void testCopyOf() { Map original = new LinkedHashMap<>(); original.put("one", 1); original.put("two", 2); original.put("three", 3); ImmutableMap copy = ImmutableMap.copyOf(original); assertMapEquals(copy, "one", 1, "two", 2, "three", 3); assertSame(copy, ImmutableMap.copyOf(copy)); } public static void hashtableTestHelper(ImmutableList sizes) { for (int size : sizes) { Builder builder = ImmutableMap.builderWithExpectedSize(size); for (int i = 0; i < size; i++) { Integer integer = i; builder.put(integer, integer); } ImmutableMap map = builder.build(); assertEquals(size, map.size()); int entries = 0; for (Integer key : map.keySet()) { assertEquals(entries, key.intValue()); assertSame(key, map.get(key)); entries++; } assertEquals(size, entries); } } public void testByteArrayHashtable() { hashtableTestHelper(ImmutableList.of(2, 89)); } public void testShortArrayHashtable() { hashtableTestHelper(ImmutableList.of(90, 22937)); } public void testIntArrayHashtable() { hashtableTestHelper(ImmutableList.of(22938)); } } public void testNullGet() { ImmutableMap map = ImmutableMap.of("one", 1); assertNull(map.get(null)); } public void testAsMultimap() { ImmutableMap map = ImmutableMap.of("one", 1, "won", 1, "two", 2, "too", 2, "three", 3); ImmutableSetMultimap expected = ImmutableSetMultimap.of("one", 1, "won", 1, "two", 2, "too", 2, "three", 3); assertEquals(expected, map.asMultimap()); } public void testAsMultimapWhenEmpty() { ImmutableMap map = ImmutableMap.of(); ImmutableSetMultimap expected = ImmutableSetMultimap.of(); assertEquals(expected, map.asMultimap()); } public void testAsMultimapCaches() { ImmutableMap map = ImmutableMap.of("one", 1); ImmutableSetMultimap multimap1 = map.asMultimap(); ImmutableSetMultimap multimap2 = map.asMultimap(); assertEquals(1, multimap1.asMap().size()); assertSame(multimap1, multimap2); } @GwtIncompatible // NullPointerTester public void testNullPointers() { NullPointerTester tester = new NullPointerTester(); tester.testAllPublicStaticMethods(ImmutableMap.class); tester.testAllPublicInstanceMethods(new ImmutableMap.Builder()); tester.testAllPublicInstanceMethods(ImmutableMap.of()); tester.testAllPublicInstanceMethods(ImmutableMap.of("one", 1)); tester.testAllPublicInstanceMethods(ImmutableMap.of("one", 1, "two", 2, "three", 3)); } private static void assertMapEquals(Map map, Object... alternatingKeysAndValues) { assertEquals(map.size(), alternatingKeysAndValues.length / 2); int i = 0; for (Entry entry : map.entrySet()) { assertEquals(alternatingKeysAndValues[i++], entry.getKey()); assertEquals(alternatingKeysAndValues[i++], entry.getValue()); } } private static class IntHolder implements Serializable { public int value; public IntHolder(int value) { this.value = value; } @Override public boolean equals(Object o) { return (o instanceof IntHolder) && ((IntHolder) o).value == value; } @Override public int hashCode() { return value; } private static final long serialVersionUID = 5; } public void testMutableValues() { IntHolder holderA = new IntHolder(1); IntHolder holderB = new IntHolder(2); Map map = ImmutableMap.of("a", holderA, "b", holderB); holderA.value = 3; assertTrue(map.entrySet().contains(Maps.immutableEntry("a", new IntHolder(3)))); Map intMap = ImmutableMap.of("a", 3, "b", 2); assertEquals(intMap.hashCode(), map.entrySet().hashCode()); assertEquals(intMap.hashCode(), map.hashCode()); } @GwtIncompatible // SerializableTester public void testViewSerialization() { Map map = ImmutableMap.of("one", 1, "two", 2, "three", 3); LenientSerializableTester.reserializeAndAssertLenient(map.entrySet()); LenientSerializableTester.reserializeAndAssertLenient(map.keySet()); Collection reserializedValues = reserialize(map.values()); assertEquals(Lists.newArrayList(map.values()), Lists.newArrayList(reserializedValues)); assertTrue(reserializedValues instanceof ImmutableCollection); } @GwtIncompatible // SerializableTester public void testKeySetIsSerializable_regularImmutableMap() { class NonSerializableClass {} Map map = RegularImmutableMap.create(1, new Object[] {"one", new NonSerializableClass()}); Set set = map.keySet(); LenientSerializableTester.reserializeAndAssertLenient(set); } @GwtIncompatible // SerializableTester public void testValuesCollectionIsSerializable_regularImmutableMap() { class NonSerializableClass {} Map map = RegularImmutableMap.create(1, new Object[] {new NonSerializableClass(), "value"}); Collection collection = map.values(); LenientSerializableTester.reserializeAndAssertElementsEqual(collection); } // TODO: Re-enable this test after moving to new serialization format in ImmutableMap. @GwtIncompatible // SerializableTester @SuppressWarnings("unchecked") public void ignore_testSerializationNoDuplication_regularImmutableMap() throws Exception { // Tests that searializing a map, its keySet, and values only writes the underlying data once. Object[] entries = new Object[2000]; for (int i = 0; i < entries.length; i++) { entries[i] = i; } ImmutableMap map = RegularImmutableMap.create(entries.length / 2, entries); Set keySet = map.keySet(); Collection values = map.values(); ByteArrayOutputStream bytes = new ByteArrayOutputStream(); ObjectOutputStream oos = new ObjectOutputStream(bytes); oos.writeObject(map); oos.flush(); int mapSize = bytes.size(); oos.writeObject(keySet); oos.writeObject(values); oos.close(); int finalSize = bytes.size(); assertThat(finalSize - mapSize).isLessThan(100); } public void testEquals() { new EqualsTester() .addEqualityGroup(ImmutableMap.of(), ImmutableMap.builder().build()) .addEqualityGroup(ImmutableMap.of(1, 1), ImmutableMap.builder().put(1, 1).build()) .addEqualityGroup(ImmutableMap.of(1, 1, 2, 2)) .addEqualityGroup(ImmutableMap.of(1, 1, 2, 2, 3, 3)) .addEqualityGroup(ImmutableMap.of(1, 4, 2, 2, 3, 3)) .addEqualityGroup(ImmutableMap.of(1, 1, 2, 4, 3, 3)) .addEqualityGroup(ImmutableMap.of(1, 1, 2, 2, 3, 4)) .addEqualityGroup(ImmutableMap.of(1, 2, 2, 3, 3, 1)) .addEqualityGroup(ImmutableMap.of(1, 1, 2, 2, 3, 3, 4, 4)) .testEquals(); } }