001/*
002 * Copyright (C) 2007 The Guava Authors
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package com.google.common.collect.testing.testers;
018
019import static com.google.common.collect.testing.features.CollectionSize.ONE;
020import static com.google.common.collect.testing.features.CollectionSize.ZERO;
021import static com.google.common.collect.testing.features.MapFeature.ALLOWS_NULL_KEYS;
022import static com.google.common.collect.testing.features.MapFeature.ALLOWS_NULL_VALUES;
023import static com.google.common.collect.testing.features.MapFeature.REJECTS_DUPLICATES_AT_CREATION;
024
025import com.google.common.annotations.GwtCompatible;
026import com.google.common.annotations.GwtIncompatible;
027import com.google.common.annotations.J2ktIncompatible;
028import com.google.common.collect.testing.AbstractMapTester;
029import com.google.common.collect.testing.Helpers;
030import com.google.common.collect.testing.features.CollectionSize;
031import com.google.common.collect.testing.features.MapFeature;
032import java.lang.reflect.Method;
033import java.util.Arrays;
034import java.util.List;
035import java.util.Map.Entry;
036import org.junit.Ignore;
037
038/**
039 * A generic JUnit test which tests creation (typically through a constructor or static factory
040 * method) of a map. Can't be invoked directly; please see {@link
041 * com.google.common.collect.testing.MapTestSuiteBuilder}.
042 *
043 * @author Chris Povirk
044 * @author Kevin Bourrillion
045 */
046@GwtCompatible(emulated = true)
047@Ignore // Affects only Android test runner, which respects JUnit 4 annotations on JUnit 3 tests.
048public class MapCreationTester<K, V> extends AbstractMapTester<K, V> {
049  @MapFeature.Require(ALLOWS_NULL_KEYS)
050  @CollectionSize.Require(absent = ZERO)
051  public void testCreateWithNullKeySupported() {
052    initMapWithNullKey();
053    expectContents(createArrayWithNullKey());
054  }
055
056  @MapFeature.Require(absent = ALLOWS_NULL_KEYS)
057  @CollectionSize.Require(absent = ZERO)
058  public void testCreateWithNullKeyUnsupported() {
059    try {
060      initMapWithNullKey();
061      fail("Creating a map containing a null key should fail");
062    } catch (NullPointerException expected) {
063    }
064  }
065
066  @MapFeature.Require(ALLOWS_NULL_VALUES)
067  @CollectionSize.Require(absent = ZERO)
068  public void testCreateWithNullValueSupported() {
069    initMapWithNullValue();
070    expectContents(createArrayWithNullValue());
071  }
072
073  @MapFeature.Require(absent = ALLOWS_NULL_VALUES)
074  @CollectionSize.Require(absent = ZERO)
075  public void testCreateWithNullValueUnsupported() {
076    try {
077      initMapWithNullValue();
078      fail("Creating a map containing a null value should fail");
079    } catch (NullPointerException expected) {
080    }
081  }
082
083  @MapFeature.Require({ALLOWS_NULL_KEYS, ALLOWS_NULL_VALUES})
084  @CollectionSize.Require(absent = ZERO)
085  public void testCreateWithNullKeyAndValueSupported() {
086    Entry<K, V>[] entries = createSamplesArray();
087    entries[getNullLocation()] = entry(null, null);
088    resetMap(entries);
089    expectContents(entries);
090  }
091
092  @MapFeature.Require(value = ALLOWS_NULL_KEYS, absent = REJECTS_DUPLICATES_AT_CREATION)
093  @CollectionSize.Require(absent = {ZERO, ONE})
094  public void testCreateWithDuplicates_nullDuplicatesNotRejected() {
095    expectFirstRemoved(getEntriesMultipleNullKeys());
096  }
097
098  @MapFeature.Require(absent = REJECTS_DUPLICATES_AT_CREATION)
099  @CollectionSize.Require(absent = {ZERO, ONE})
100  public void testCreateWithDuplicates_nonNullDuplicatesNotRejected() {
101    expectFirstRemoved(getEntriesMultipleNonNullKeys());
102  }
103
104  @MapFeature.Require({ALLOWS_NULL_KEYS, REJECTS_DUPLICATES_AT_CREATION})
105  @CollectionSize.Require(absent = {ZERO, ONE})
106  public void testCreateWithDuplicates_nullDuplicatesRejected() {
107    Entry<K, V>[] entries = getEntriesMultipleNullKeys();
108    try {
109      resetMap(entries);
110      fail("Should reject duplicate null elements at creation");
111    } catch (IllegalArgumentException expected) {
112    }
113  }
114
115  @MapFeature.Require(REJECTS_DUPLICATES_AT_CREATION)
116  @CollectionSize.Require(absent = {ZERO, ONE})
117  public void testCreateWithDuplicates_nonNullDuplicatesRejected() {
118    Entry<K, V>[] entries = getEntriesMultipleNonNullKeys();
119    try {
120      resetMap(entries);
121      fail("Should reject duplicate non-null elements at creation");
122    } catch (IllegalArgumentException expected) {
123    }
124  }
125
126  private Entry<K, V>[] getEntriesMultipleNullKeys() {
127    Entry<K, V>[] entries = createArrayWithNullKey();
128    entries[0] = entry(null, entries[0].getValue());
129    return entries;
130  }
131
132  private Entry<K, V>[] getEntriesMultipleNonNullKeys() {
133    Entry<K, V>[] entries = createSamplesArray();
134    entries[0] = entry(k1(), v0());
135    return entries;
136  }
137
138  private void expectFirstRemoved(Entry<K, V>[] entries) {
139    resetMap(entries);
140
141    List<Entry<K, V>> expectedWithDuplicateRemoved =
142        Arrays.asList(entries).subList(1, getNumElements());
143    expectContents(expectedWithDuplicateRemoved);
144  }
145
146  /**
147   * Returns the {@link Method} instance for {@link #testCreateWithNullKeyUnsupported()} so that
148   * tests can suppress it with {@code FeatureSpecificTestSuiteBuilder.suppressing()} until <a
149   * href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=5045147">Sun bug 5045147</a> is fixed.
150   */
151  @J2ktIncompatible
152  @GwtIncompatible // reflection
153  public static Method getCreateWithNullKeyUnsupportedMethod() {
154    return Helpers.getMethod(MapCreationTester.class, "testCreateWithNullKeyUnsupported");
155  }
156}