guava

1
/*
2
 * Copyright (C) 2007 The Guava Authors
3
 *
4
 * Licensed under the Apache License, Version 2.0 (the "License");
5
 * you may not use this file except in compliance with the License.
6
 * You may obtain a copy of the License at
7
 *
8
 * http://www.apache.org/licenses/LICENSE-2.0
9
 *
10
 * Unless required by applicable law or agreed to in writing, software
11
 * distributed under the License is distributed on an "AS IS" BASIS,
12
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
 * See the License for the specific language governing permissions and
14
 * limitations under the License.
15
 */
16

17
package com.google.common.collect.testing.testers;
18

19
import static com.google.common.collect.testing.features.CollectionSize.ZERO;
20
import static com.google.common.collect.testing.features.MapFeature.ALLOWS_NULL_KEYS;
21
import static com.google.common.collect.testing.features.MapFeature.ALLOWS_NULL_VALUES;
22
import static com.google.common.collect.testing.features.MapFeature.FAILS_FAST_ON_CONCURRENT_MODIFICATION;
23
import static com.google.common.collect.testing.features.MapFeature.SUPPORTS_PUT;
24
import static java.util.Collections.singletonList;
25

26
import com.google.common.annotations.GwtCompatible;
27
import com.google.common.annotations.GwtIncompatible;
28
import com.google.common.annotations.J2ktIncompatible;
29
import com.google.common.collect.testing.AbstractMapTester;
30
import com.google.common.collect.testing.Helpers;
31
import com.google.common.collect.testing.MinimalCollection;
32
import com.google.common.collect.testing.features.CollectionSize;
33
import com.google.common.collect.testing.features.MapFeature;
34
import java.lang.reflect.Method;
35
import java.util.Collections;
36
import java.util.ConcurrentModificationException;
37
import java.util.Iterator;
38
import java.util.LinkedHashMap;
39
import java.util.List;
40
import java.util.Map;
41
import java.util.Map.Entry;
42
import org.checkerframework.checker.nullness.qual.Nullable;
43
import org.junit.Ignore;
44

45
/**
46
 * A generic JUnit test which tests {@code putAll} operations on a map. Can't be invoked directly;
47
 * please see {@link com.google.common.collect.testing.MapTestSuiteBuilder}.
48
 *
49
 * @author Chris Povirk
50
 * @author Kevin Bourrillion
51
 */
52
@GwtCompatible(emulated = true)
53
@Ignore // Affects only Android test runner, which respects JUnit 4 annotations on JUnit 3 tests.
54
@ElementTypesAreNonnullByDefault
55
public class MapPutAllTester<K extends @Nullable Object, V extends @Nullable Object>
56
    extends AbstractMapTester<K, V> {
57
  private List<Entry<K, V>> containsNullKey;
58
  private List<Entry<K, V>> containsNullValue;
59

60
  @Override
61
  public void setUp() throws Exception {
62
    super.setUp();
63
    containsNullKey = singletonList(entry(null, v3()));
64
    containsNullValue = singletonList(entry(k3(), null));
65
  }
66

67
  @MapFeature.Require(SUPPORTS_PUT)
68
  public void testPutAll_supportedNothing() {
69
    getMap().putAll(emptyMap());
70
    expectUnchanged();
71
  }
72

73
  @MapFeature.Require(absent = SUPPORTS_PUT)
74
  public void testPutAll_unsupportedNothing() {
75
    try {
76
      getMap().putAll(emptyMap());
77
    } catch (UnsupportedOperationException tolerated) {
78
    }
79
    expectUnchanged();
80
  }
81

82
  @MapFeature.Require(SUPPORTS_PUT)
83
  public void testPutAll_supportedNonePresent() {
84
    putAll(createDisjointCollection());
85
    expectAdded(e3(), e4());
86
  }
87

88
  @MapFeature.Require(absent = SUPPORTS_PUT)
89
  public void testPutAll_unsupportedNonePresent() {
90
    try {
91
      putAll(createDisjointCollection());
92
      fail("putAll(nonePresent) should throw");
93
    } catch (UnsupportedOperationException expected) {
94
    }
95
    expectUnchanged();
96
    expectMissing(e3(), e4());
97
  }
98

99
  @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
}
208