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.ZERO;
020import static com.google.common.collect.testing.features.MapFeature.ALLOWS_NULL_KEYS;
021import static com.google.common.collect.testing.features.MapFeature.ALLOWS_NULL_VALUES;
022import static com.google.common.collect.testing.features.MapFeature.FAILS_FAST_ON_CONCURRENT_MODIFICATION;
023import static com.google.common.collect.testing.features.MapFeature.SUPPORTS_PUT;
024import static java.util.Collections.singletonList;
025
026import com.google.common.annotations.GwtCompatible;
027import com.google.common.annotations.GwtIncompatible;
028import com.google.common.annotations.J2ktIncompatible;
029import com.google.common.collect.testing.AbstractMapTester;
030import com.google.common.collect.testing.Helpers;
031import com.google.common.collect.testing.MinimalCollection;
032import com.google.common.collect.testing.features.CollectionSize;
033import com.google.common.collect.testing.features.MapFeature;
034import java.lang.reflect.Method;
035import java.util.Collections;
036import java.util.ConcurrentModificationException;
037import java.util.Iterator;
038import java.util.LinkedHashMap;
039import java.util.List;
040import java.util.Map;
041import java.util.Map.Entry;
042import org.checkerframework.checker.nullness.qual.Nullable;
043import org.junit.Ignore;
044
045/**
046 * A generic JUnit test which tests {@code putAll} operations on a map. Can't be invoked directly;
047 * please see {@link com.google.common.collect.testing.MapTestSuiteBuilder}.
048 *
049 * @author Chris Povirk
050 * @author Kevin Bourrillion
051 */
052@GwtCompatible(emulated = true)
053@Ignore // Affects only Android test runner, which respects JUnit 4 annotations on JUnit 3 tests.
054@ElementTypesAreNonnullByDefault
055public class MapPutAllTester<K extends @Nullable Object, V extends @Nullable Object>
056    extends AbstractMapTester<K, V> {
057  private List<Entry<K, V>> containsNullKey;
058  private List<Entry<K, V>> containsNullValue;
059
060  @Override
061  public void setUp() throws Exception {
062    super.setUp();
063    containsNullKey = singletonList(entry(null, v3()));
064    containsNullValue = singletonList(entry(k3(), null));
065  }
066
067  @MapFeature.Require(SUPPORTS_PUT)
068  public void testPutAll_supportedNothing() {
069    getMap().putAll(emptyMap());
070    expectUnchanged();
071  }
072
073  @MapFeature.Require(absent = SUPPORTS_PUT)
074  public void testPutAll_unsupportedNothing() {
075    try {
076      getMap().putAll(emptyMap());
077    } catch (UnsupportedOperationException tolerated) {
078    }
079    expectUnchanged();
080  }
081
082  @MapFeature.Require(SUPPORTS_PUT)
083  public void testPutAll_supportedNonePresent() {
084    putAll(createDisjointCollection());
085    expectAdded(e3(), e4());
086  }
087
088  @MapFeature.Require(absent = SUPPORTS_PUT)
089  public void testPutAll_unsupportedNonePresent() {
090    try {
091      putAll(createDisjointCollection());
092      fail("putAll(nonePresent) should throw");
093    } catch (UnsupportedOperationException expected) {
094    }
095    expectUnchanged();
096    expectMissing(e3(), e4());
097  }
098
099  @MapFeature.Require(SUPPORTS_PUT)
100  @CollectionSize.Require(absent = ZERO)
101  public void testPutAll_supportedSomePresent() {
102    putAll(MinimalCollection.of(e3(), e0()));
103    expectAdded(e3());
104  }
105
106  @MapFeature.Require({FAILS_FAST_ON_CONCURRENT_MODIFICATION, SUPPORTS_PUT})
107  @CollectionSize.Require(absent = ZERO)
108  public void testPutAllSomePresentConcurrentWithEntrySetIteration() {
109    try {
110      Iterator<Entry<K, V>> iterator = getMap().entrySet().iterator();
111      putAll(MinimalCollection.of(e3(), e0()));
112      iterator.next();
113      fail("Expected ConcurrentModificationException");
114    } catch (ConcurrentModificationException expected) {
115      // success
116    }
117  }
118
119  @MapFeature.Require(absent = SUPPORTS_PUT)
120  @CollectionSize.Require(absent = ZERO)
121  public void testPutAll_unsupportedSomePresent() {
122    try {
123      putAll(MinimalCollection.of(e3(), e0()));
124      fail("putAll(somePresent) should throw");
125    } catch (UnsupportedOperationException expected) {
126    }
127    expectUnchanged();
128  }
129
130  @MapFeature.Require(absent = SUPPORTS_PUT)
131  @CollectionSize.Require(absent = ZERO)
132  public void testPutAll_unsupportedAllPresent() {
133    try {
134      putAll(MinimalCollection.of(e0()));
135    } catch (UnsupportedOperationException tolerated) {
136    }
137    expectUnchanged();
138  }
139
140  @MapFeature.Require({SUPPORTS_PUT, ALLOWS_NULL_KEYS})
141  public void testPutAll_nullKeySupported() {
142    putAll(containsNullKey);
143    expectAdded(containsNullKey.get(0));
144  }
145
146  @MapFeature.Require(value = SUPPORTS_PUT, absent = ALLOWS_NULL_KEYS)
147  public void testPutAll_nullKeyUnsupported() {
148    try {
149      putAll(containsNullKey);
150      fail("putAll(containsNullKey) should throw");
151    } catch (NullPointerException expected) {
152    }
153    expectUnchanged();
154    expectNullKeyMissingWhenNullKeysUnsupported(
155        "Should not contain null key after unsupported putAll(containsNullKey)");
156  }
157
158  @MapFeature.Require({SUPPORTS_PUT, ALLOWS_NULL_VALUES})
159  public void testPutAll_nullValueSupported() {
160    putAll(containsNullValue);
161    expectAdded(containsNullValue.get(0));
162  }
163
164  @MapFeature.Require(value = SUPPORTS_PUT, absent = ALLOWS_NULL_VALUES)
165  public void testPutAll_nullValueUnsupported() {
166    try {
167      putAll(containsNullValue);
168      fail("putAll(containsNullValue) should throw");
169    } catch (NullPointerException expected) {
170    }
171    expectUnchanged();
172    expectNullValueMissingWhenNullValuesUnsupported(
173        "Should not contain null value after unsupported putAll(containsNullValue)");
174  }
175
176  @MapFeature.Require(SUPPORTS_PUT)
177  public void testPutAll_nullCollectionReference() {
178    try {
179      getMap().putAll(null);
180      fail("putAll(null) should throw NullPointerException");
181    } catch (NullPointerException expected) {
182    }
183  }
184
185  private Map<K, V> emptyMap() {
186    return Collections.emptyMap();
187  }
188
189  private void putAll(Iterable<Entry<K, V>> entries) {
190    Map<K, V> map = new LinkedHashMap<>();
191    for (Entry<K, V> entry : entries) {
192      map.put(entry.getKey(), entry.getValue());
193    }
194    getMap().putAll(map);
195  }
196
197  /**
198   * Returns the {@link Method} instance for {@link #testPutAll_nullKeyUnsupported()} so that tests
199   * can suppress it with {@code FeatureSpecificTestSuiteBuilder.suppressing()} until <a
200   * href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=5045147">Sun bug 5045147</a> is fixed.
201   */
202  @J2ktIncompatible
203  @GwtIncompatible // reflection
204  public static Method getPutAllNullKeyUnsupportedMethod() {
205    return Helpers.getMethod(MapPutAllTester.class, "testPutAll_nullKeyUnsupported");
206  }
207}