/
AbstractMapTester.java
256 lines (217 loc) · 7.49 KB
/
AbstractMapTester.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
/*
* Copyright (C) 2007 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.testing;
import com.google.common.annotations.GwtCompatible;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;
import java.util.ListIterator;
import java.util.Map;
import java.util.Map.Entry;
import org.checkerframework.checker.nullness.qual.Nullable;
import org.junit.Ignore;
/**
* Base class for map testers.
*
* <p>TODO: see how much of this is actually needed once Map testers are written. (It was cloned
* from AbstractCollectionTester.)
*
* @param <K> the key type of the map to be tested.
* @param <V> the value type of the map to be tested.
* @author George van den Driessche
*/
@GwtCompatible
@Ignore // Affects only Android test runner, which respects JUnit 4 annotations on JUnit 3 tests.
@ElementTypesAreNonnullByDefault
public abstract class AbstractMapTester<K extends @Nullable Object, V extends @Nullable Object>
extends AbstractContainerTester<Map<K, V>, Entry<K, V>> {
protected Map<K, V> getMap() {
return container;
}
@Override
protected Collection<Entry<K, V>> actualContents() {
return getMap().entrySet();
}
/** @see AbstractContainerTester#resetContainer() */
protected final void resetMap() {
resetContainer();
}
protected void resetMap(Entry<K, V>[] entries) {
resetContainer(getSubjectGenerator().create((Object[]) entries));
}
protected void expectMissingKeys(K... elements) {
for (K element : elements) {
assertFalse("Should not contain key " + element, getMap().containsKey(element));
}
}
protected void expectMissingValues(V... elements) {
for (V element : elements) {
assertFalse("Should not contain value " + element, getMap().containsValue(element));
}
}
/** @return an array of the proper size with {@code null} as the key of the middle element. */
protected Entry<K, V>[] createArrayWithNullKey() {
Entry<K, V>[] array = createSamplesArray();
int nullKeyLocation = getNullLocation();
Entry<K, V> oldEntry = array[nullKeyLocation];
array[nullKeyLocation] = entry(null, oldEntry.getValue());
return array;
}
protected V getValueForNullKey() {
return getEntryNullReplaces().getValue();
}
protected K getKeyForNullValue() {
return getEntryNullReplaces().getKey();
}
private Entry<K, V> getEntryNullReplaces() {
Iterator<Entry<K, V>> entries = getSampleElements().iterator();
for (int i = 0; i < getNullLocation(); i++) {
entries.next();
}
return entries.next();
}
/** @return an array of the proper size with {@code null} as the value of the middle element. */
protected Entry<K, V>[] createArrayWithNullValue() {
Entry<K, V>[] array = createSamplesArray();
int nullValueLocation = getNullLocation();
Entry<K, V> oldEntry = array[nullValueLocation];
array[nullValueLocation] = entry(oldEntry.getKey(), null);
return array;
}
protected void initMapWithNullKey() {
resetMap(createArrayWithNullKey());
}
protected void initMapWithNullValue() {
resetMap(createArrayWithNullValue());
}
/**
* Equivalent to {@link #expectMissingKeys(Object[]) expectMissingKeys} {@code (null)} except that
* the call to {@code contains(null)} is permitted to throw a {@code NullPointerException}.
*
* @param message message to use upon assertion failure
*/
protected void expectNullKeyMissingWhenNullKeysUnsupported(String message) {
try {
assertFalse(message, getMap().containsKey(null));
} catch (NullPointerException tolerated) {
// Tolerated
}
}
/**
* Equivalent to {@link #expectMissingValues(Object[]) expectMissingValues} {@code (null)} except
* that the call to {@code contains(null)} is permitted to throw a {@code NullPointerException}.
*
* @param message message to use upon assertion failure
*/
protected void expectNullValueMissingWhenNullValuesUnsupported(String message) {
try {
assertFalse(message, getMap().containsValue(null));
} catch (NullPointerException tolerated) {
// Tolerated
}
}
@Override
protected MinimalCollection<Entry<K, V>> createDisjointCollection() {
return MinimalCollection.of(e3(), e4());
}
protected int getNumEntries() {
return getNumElements();
}
protected Collection<Entry<K, V>> getSampleEntries(int howMany) {
return getSampleElements(howMany);
}
protected Collection<Entry<K, V>> getSampleEntries() {
return getSampleElements();
}
@Override
protected void expectMissing(Entry<K, V>... entries) {
for (Entry<K, V> entry : entries) {
assertFalse("Should not contain entry " + entry, actualContents().contains(entry));
assertFalse(
"Should not contain key " + entry.getKey() + " mapped to value " + entry.getValue(),
equal(getMap().get(entry.getKey()), entry.getValue()));
}
}
private static boolean equal(@Nullable Object a, @Nullable Object b) {
return a == b || (a != null && a.equals(b));
}
// This one-liner saves us from some ugly casts
protected Entry<K, V> entry(K key, V value) {
return Helpers.mapEntry(key, value);
}
@Override
protected void expectContents(Collection<Entry<K, V>> expected) {
// TODO: move this to invariant checks once the appropriate hook exists?
super.expectContents(expected);
for (Entry<K, V> entry : expected) {
assertEquals(
"Wrong value for key " + entry.getKey(), entry.getValue(), getMap().get(entry.getKey()));
}
}
protected final void expectReplacement(Entry<K, V> newEntry) {
List<Entry<K, V>> expected = Helpers.copyToList(getSampleElements());
replaceValue(expected, newEntry);
expectContents(expected);
}
private void replaceValue(List<Entry<K, V>> expected, Entry<K, V> newEntry) {
for (ListIterator<Entry<K, V>> i = expected.listIterator(); i.hasNext(); ) {
if (Helpers.equal(i.next().getKey(), newEntry.getKey())) {
i.set(newEntry);
return;
}
}
throw new IllegalArgumentException(
Platform.format("key %s not found in entries %s", newEntry.getKey(), expected));
}
/**
* Wrapper for {@link Map#get(Object)} that forces the caller to pass in a key of the same type as
* the map. Besides being slightly shorter than code that uses {@link #getMap()}, it also ensures
* that callers don't pass an {@link Entry} by mistake.
*/
protected V get(K key) {
return getMap().get(key);
}
protected final K k0() {
return e0().getKey();
}
protected final V v0() {
return e0().getValue();
}
protected final K k1() {
return e1().getKey();
}
protected final V v1() {
return e1().getValue();
}
protected final K k2() {
return e2().getKey();
}
protected final V v2() {
return e2().getValue();
}
protected final K k3() {
return e3().getKey();
}
protected final V v3() {
return e3().getValue();
}
protected final K k4() {
return e4().getKey();
}
protected final V v4() {
return e4().getValue();
}
}