2
* Copyright (C) 2005 The Guava Authors
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
8
* http://www.apache.org/licenses/LICENSE-2.0
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.
17
package com.google.common.testing;
19
import static com.google.common.base.Preconditions.checkArgument;
20
import static com.google.common.base.Preconditions.checkNotNull;
22
import com.google.common.annotations.GwtIncompatible;
23
import com.google.common.annotations.J2ktIncompatible;
24
import com.google.common.base.Converter;
25
import com.google.common.base.Objects;
26
import com.google.common.collect.ClassToInstanceMap;
27
import com.google.common.collect.ImmutableList;
28
import com.google.common.collect.ImmutableSet;
29
import com.google.common.collect.Lists;
30
import com.google.common.collect.Maps;
31
import com.google.common.collect.MutableClassToInstanceMap;
32
import com.google.common.reflect.Invokable;
33
import com.google.common.reflect.Parameter;
34
import com.google.common.reflect.Reflection;
35
import com.google.common.reflect.TypeToken;
36
import com.google.errorprone.annotations.CanIgnoreReturnValue;
37
import java.lang.annotation.Annotation;
38
import java.lang.reflect.AnnotatedType;
39
import java.lang.reflect.Constructor;
40
import java.lang.reflect.InvocationTargetException;
41
import java.lang.reflect.Member;
42
import java.lang.reflect.Method;
43
import java.lang.reflect.Modifier;
44
import java.lang.reflect.ParameterizedType;
45
import java.lang.reflect.Type;
46
import java.lang.reflect.TypeVariable;
47
import java.util.Arrays;
49
import java.util.concurrent.ConcurrentMap;
50
import junit.framework.Assert;
51
import org.checkerframework.checker.nullness.qual.Nullable;
54
* A test utility that verifies that your methods and constructors throw {@link
55
* NullPointerException} or {@link UnsupportedOperationException} whenever null is passed to a
56
* parameter whose declaration or type isn't annotated with an annotation with the simple name
57
* {@code Nullable}, {@code CheckForNull}, {@code NullableType}, or {@code NullableDecl}.
59
* <p>The tested methods and constructors are invoked -- each time with one parameter being null and
60
* the rest not null -- and the test fails if no expected exception is thrown. {@code
61
* NullPointerTester} uses best effort to pick non-null default values for many common JDK and Guava
62
* types, and also for interfaces and public classes that have public parameter-less constructors.
63
* When the non-null default value for a particular parameter type cannot be provided by {@code
64
* NullPointerTester}, the caller can provide a custom non-null default value for the parameter type
65
* via {@link #setDefault}.
67
* @author Kevin Bourrillion
72
@ElementTypesAreNonnullByDefault
73
public final class NullPointerTester {
75
private final ClassToInstanceMap<Object> defaults = MutableClassToInstanceMap.create();
76
private final List<Member> ignoredMembers = Lists.newArrayList();
78
private ExceptionTypePolicy policy = ExceptionTypePolicy.NPE_OR_UOE;
80
public NullPointerTester() {
83
* Converter.apply has a non-nullable parameter type but doesn't throw for null arguments. For
84
* more information, see the comments in that class.
86
* We already know that that's how it behaves, and subclasses of Converter can't change that
87
* behavior. So there's no sense in making all subclass authors exclude the method from any
88
* NullPointerTester tests that they have.
90
ignoredMembers.add(Converter.class.getMethod("apply", Object.class));
91
} catch (NoSuchMethodException shouldBeImpossible) {
92
// OK, fine: If it doesn't exist, then there's chance that we're going to be asked to test it.
97
* Sets a default value that can be used for any parameter of type {@code type}. Returns this
100
@CanIgnoreReturnValue
101
public <T> NullPointerTester setDefault(Class<T> type, T value) {
102
defaults.putInstance(type, checkNotNull(value));
107
* Ignore {@code method} in the tests that follow. Returns this object.
111
@CanIgnoreReturnValue
112
public NullPointerTester ignore(Method method) {
113
ignoredMembers.add(checkNotNull(method));
118
* Ignore {@code constructor} in the tests that follow. Returns this object.
122
@CanIgnoreReturnValue
123
public NullPointerTester ignore(Constructor<?> constructor) {
124
ignoredMembers.add(checkNotNull(constructor));
129
* Runs {@link #testConstructor} on every constructor in class {@code c} that has at least {@code
130
* minimalVisibility}.
132
public void testConstructors(Class<?> c, Visibility minimalVisibility) {
133
for (Constructor<?> constructor : c.getDeclaredConstructors()) {
134
if (minimalVisibility.isVisible(constructor) && !isIgnored(constructor)) {
135
testConstructor(constructor);
140
/** Runs {@link #testConstructor} on every public constructor in class {@code c}. */
141
public void testAllPublicConstructors(Class<?> c) {
142
testConstructors(c, Visibility.PUBLIC);
146
* Runs {@link #testMethod} on every static method of class {@code c} that has at least {@code
147
* minimalVisibility}, including those "inherited" from superclasses of the same package.
149
public void testStaticMethods(Class<?> c, Visibility minimalVisibility) {
150
for (Method method : minimalVisibility.getStaticMethods(c)) {
151
if (!isIgnored(method)) {
152
testMethod(null, method);
158
* Runs {@link #testMethod} on every public static method of class {@code c}, including those
159
* "inherited" from superclasses of the same package.
161
public void testAllPublicStaticMethods(Class<?> c) {
162
testStaticMethods(c, Visibility.PUBLIC);
166
* Runs {@link #testMethod} on every instance method of the class of {@code instance} with at
167
* least {@code minimalVisibility}, including those inherited from superclasses of the same
170
public void testInstanceMethods(Object instance, Visibility minimalVisibility) {
171
for (Method method : getInstanceMethodsToTest(instance.getClass(), minimalVisibility)) {
172
testMethod(instance, method);
176
ImmutableList<Method> getInstanceMethodsToTest(Class<?> c, Visibility minimalVisibility) {
177
ImmutableList.Builder<Method> builder = ImmutableList.builder();
178
for (Method method : minimalVisibility.getInstanceMethods(c)) {
179
if (!isIgnored(method)) {
183
return builder.build();
187
* Runs {@link #testMethod} on every public instance method of the class of {@code instance},
188
* including those inherited from superclasses of the same package.
190
public void testAllPublicInstanceMethods(Object instance) {
191
testInstanceMethods(instance, Visibility.PUBLIC);
195
* Verifies that {@code method} produces a {@link NullPointerException} or {@link
196
* UnsupportedOperationException} whenever <i>any</i> of its non-nullable parameters are null.
198
* @param instance the instance to invoke {@code method} on, or null if {@code method} is static
200
public void testMethod(@Nullable Object instance, Method method) {
201
Class<?>[] types = method.getParameterTypes();
202
for (int nullIndex = 0; nullIndex < types.length; nullIndex++) {
203
testMethodParameter(instance, method, nullIndex);
208
* Verifies that {@code ctor} produces a {@link NullPointerException} or {@link
209
* UnsupportedOperationException} whenever <i>any</i> of its non-nullable parameters are null.
211
public void testConstructor(Constructor<?> ctor) {
212
Class<?> declaringClass = ctor.getDeclaringClass();
214
Modifier.isStatic(declaringClass.getModifiers())
215
|| declaringClass.getEnclosingClass() == null,
216
"Cannot test constructor of non-static inner class: %s",
217
declaringClass.getName());
218
Class<?>[] types = ctor.getParameterTypes();
219
for (int nullIndex = 0; nullIndex < types.length; nullIndex++) {
220
testConstructorParameter(ctor, nullIndex);
225
* Verifies that {@code method} produces a {@link NullPointerException} or {@link
226
* UnsupportedOperationException} when the parameter in position {@code paramIndex} is null. If
227
* this parameter is marked nullable, this method does nothing.
229
* @param instance the instance to invoke {@code method} on, or null if {@code method} is static
231
public void testMethodParameter(
232
@Nullable final Object instance, final Method method, int paramIndex) {
233
method.setAccessible(true);
234
testParameter(instance, invokable(instance, method), paramIndex, method.getDeclaringClass());
238
* Verifies that {@code ctor} produces a {@link NullPointerException} or {@link
239
* UnsupportedOperationException} when the parameter in position {@code paramIndex} is null. If
240
* this parameter is marked nullable, this method does nothing.
242
public void testConstructorParameter(Constructor<?> ctor, int paramIndex) {
243
ctor.setAccessible(true);
244
testParameter(null, Invokable.from(ctor), paramIndex, ctor.getDeclaringClass());
247
/** Visibility of any method or constructor. */
248
public enum Visibility {
251
boolean isVisible(int modifiers) {
252
return !Modifier.isPrivate(modifiers);
258
boolean isVisible(int modifiers) {
259
return Modifier.isPublic(modifiers) || Modifier.isProtected(modifiers);
265
boolean isVisible(int modifiers) {
266
return Modifier.isPublic(modifiers);
270
abstract boolean isVisible(int modifiers);
272
/** Returns {@code true} if {@code member} is visible under {@code this} visibility. */
273
final boolean isVisible(Member member) {
274
return isVisible(member.getModifiers());
277
final Iterable<Method> getStaticMethods(Class<?> cls) {
278
ImmutableList.Builder<Method> builder = ImmutableList.builder();
279
for (Method method : getVisibleMethods(cls)) {
280
if (Invokable.from(method).isStatic()) {
284
return builder.build();
287
final Iterable<Method> getInstanceMethods(Class<?> cls) {
288
ConcurrentMap<Signature, Method> map = Maps.newConcurrentMap();
289
for (Method method : getVisibleMethods(cls)) {
290
if (!Invokable.from(method).isStatic()) {
291
map.putIfAbsent(new Signature(method), method);
297
private ImmutableList<Method> getVisibleMethods(Class<?> cls) {
298
// Don't use cls.getPackage() because it does nasty things like reading
300
String visiblePackage = Reflection.getPackageName(cls);
301
ImmutableList.Builder<Method> builder = ImmutableList.builder();
302
for (Class<?> type : TypeToken.of(cls).getTypes().rawTypes()) {
303
if (!Reflection.getPackageName(type).equals(visiblePackage)) {
306
for (Method method : type.getDeclaredMethods()) {
307
if (!method.isSynthetic() && isVisible(method)) {
312
return builder.build();
316
private static final class Signature {
317
private final String name;
318
private final ImmutableList<Class<?>> parameterTypes;
320
Signature(Method method) {
321
this(method.getName(), ImmutableList.copyOf(method.getParameterTypes()));
324
Signature(String name, ImmutableList<Class<?>> parameterTypes) {
326
this.parameterTypes = parameterTypes;
330
public boolean equals(@Nullable Object obj) {
331
if (obj instanceof Signature) {
332
Signature that = (Signature) obj;
333
return name.equals(that.name) && parameterTypes.equals(that.parameterTypes);
339
public int hashCode() {
340
return Objects.hashCode(name, parameterTypes);
345
* Verifies that {@code invokable} produces a {@link NullPointerException} or {@link
346
* UnsupportedOperationException} when the parameter in position {@code paramIndex} is null. If
347
* this parameter is marked nullable, this method does nothing.
349
* @param instance the instance to invoke {@code invokable} on, or null if {@code invokable} is
352
private void testParameter(
353
@Nullable Object instance, Invokable<?, ?> invokable, int paramIndex, Class<?> testedClass) {
354
if (isPrimitiveOrNullable(invokable.getParameters().get(paramIndex))) {
355
return; // there's nothing to test
357
@Nullable Object[] params = buildParamList(invokable, paramIndex);
359
@SuppressWarnings("unchecked") // We'll get a runtime exception if the type is wrong.
360
Invokable<Object, ?> unsafe = (Invokable<Object, ?>) invokable;
361
unsafe.invoke(instance, params);
363
"No exception thrown for parameter at index "
367
+ Arrays.toString(params)
370
} catch (InvocationTargetException e) {
371
Throwable cause = e.getCause();
372
if (policy.isExpectedType(cause)) {
375
throw new AssertionError(
377
"wrong exception thrown from %s when passing null to %s parameter at index %s.%n"
378
+ "Full parameters: %s%n"
379
+ "Actual exception message: %s",
381
invokable.getParameters().get(paramIndex).getType(),
383
Arrays.toString(params),
386
} catch (IllegalAccessException e) {
387
throw new RuntimeException(e);
391
private @Nullable Object[] buildParamList(
392
Invokable<?, ?> invokable, int indexOfParamToSetToNull) {
393
ImmutableList<Parameter> params = invokable.getParameters();
394
@Nullable Object[] args = new Object[params.size()];
396
for (int i = 0; i < args.length; i++) {
397
Parameter param = params.get(i);
398
if (i != indexOfParamToSetToNull) {
399
args[i] = getDefaultValue(param.getType());
401
"Can't find or create a sample instance for type '"
403
+ "'; please provide one using NullPointerTester.setDefault()",
404
args[i] != null || isNullable(param));
410
private <T> @Nullable T getDefaultValue(TypeToken<T> type) {
411
// We assume that all defaults are generics-safe, even if they aren't,
413
@SuppressWarnings("unchecked")
414
T defaultValue = (T) defaults.getInstance(type.getRawType());
415
if (defaultValue != null) {
418
@SuppressWarnings("unchecked") // All arbitrary instances are generics-safe
419
T arbitrary = (T) ArbitraryInstances.get(type.getRawType());
420
if (arbitrary != null) {
423
if (type.getRawType() == Class.class) {
424
// If parameter is Class<? extends Foo>, we return Foo.class
425
@SuppressWarnings("unchecked")
426
T defaultClass = (T) getFirstTypeParameter(type.getType()).getRawType();
429
if (type.getRawType() == TypeToken.class) {
430
// If parameter is TypeToken<? extends Foo>, we return TypeToken<Foo>.
431
@SuppressWarnings("unchecked")
432
T defaultType = (T) getFirstTypeParameter(type.getType());
435
if (type.getRawType() == Converter.class) {
436
TypeToken<?> convertFromType = type.resolveType(Converter.class.getTypeParameters()[0]);
437
TypeToken<?> convertToType = type.resolveType(Converter.class.getTypeParameters()[1]);
438
@SuppressWarnings("unchecked") // returns default for both F and T
439
T defaultConverter = (T) defaultConverter(convertFromType, convertToType);
440
return defaultConverter;
442
if (type.getRawType().isInterface()) {
443
return newDefaultReturningProxy(type);
448
private <F, T> Converter<F, T> defaultConverter(
449
final TypeToken<F> convertFromType, final TypeToken<T> convertToType) {
450
return new Converter<F, T>() {
452
protected T doForward(F a) {
453
return doConvert(convertToType);
457
protected F doBackward(T b) {
458
return doConvert(convertFromType);
461
private /*static*/ <S> S doConvert(TypeToken<S> type) {
462
return checkNotNull(getDefaultValue(type));
467
private static TypeToken<?> getFirstTypeParameter(Type type) {
468
if (type instanceof ParameterizedType) {
469
return TypeToken.of(((ParameterizedType) type).getActualTypeArguments()[0]);
471
return TypeToken.of(Object.class);
475
private <T> T newDefaultReturningProxy(final TypeToken<T> type) {
476
return new DummyProxy() {
478
<R> @Nullable R dummyReturnValue(TypeToken<R> returnType) {
479
return getDefaultValue(returnType);
484
private static Invokable<?, ?> invokable(@Nullable Object instance, Method method) {
485
if (instance == null) {
486
return Invokable.from(method);
488
return TypeToken.of(instance.getClass()).method(method);
492
static boolean isPrimitiveOrNullable(Parameter param) {
493
return param.getType().getRawType().isPrimitive() || isNullable(param);
496
private static final ImmutableSet<String> NULLABLE_ANNOTATION_SIMPLE_NAMES =
497
ImmutableSet.of("CheckForNull", "Nullable", "NullableDecl", "NullableType");
499
static boolean isNullable(Invokable<?, ?> invokable) {
500
return NULLNESS_ANNOTATION_READER.isNullable(invokable);
503
static boolean isNullable(Parameter param) {
504
return NULLNESS_ANNOTATION_READER.isNullable(param);
507
private static boolean containsNullable(Annotation[] annotations) {
508
for (Annotation annotation : annotations) {
509
if (NULLABLE_ANNOTATION_SIMPLE_NAMES.contains(annotation.annotationType().getSimpleName())) {
516
private boolean isIgnored(Member member) {
517
return member.isSynthetic() || ignoredMembers.contains(member) || isEquals(member);
521
* Returns true if the given member is a method that overrides {@link Object#equals(Object)}.
523
* <p>The documentation for {@link Object#equals} says it should accept null, so don't require an
524
* explicit {@code @Nullable} annotation (see <a
525
* href="https://github.com/google/guava/issues/1819">#1819</a>).
527
* <p>It is not necessary to consider visibility, return type, or type parameter declarations. The
528
* declaration of a method with the same name and formal parameters as {@link Object#equals} that
529
* is not public and boolean-returning, or that declares any type parameters, would be rejected at
532
private static boolean isEquals(Member member) {
533
if (!(member instanceof Method)) {
536
Method method = (Method) member;
537
if (!method.getName().contentEquals("equals")) {
540
Class<?>[] parameters = method.getParameterTypes();
541
if (parameters.length != 1) {
544
if (!parameters[0].equals(Object.class)) {
550
/** Strategy for exception type matching used by {@link NullPointerTester}. */
551
private enum ExceptionTypePolicy {
554
* Exceptions should be {@link NullPointerException} or {@link UnsupportedOperationException}.
558
public boolean isExpectedType(Throwable cause) {
559
return cause instanceof NullPointerException
560
|| cause instanceof UnsupportedOperationException;
565
* Exceptions should be {@link NullPointerException}, {@link IllegalArgumentException}, or
566
* {@link UnsupportedOperationException}.
570
public boolean isExpectedType(Throwable cause) {
571
return cause instanceof NullPointerException
572
|| cause instanceof IllegalArgumentException
573
|| cause instanceof UnsupportedOperationException;
577
public abstract boolean isExpectedType(Throwable cause);
580
private static boolean annotatedTypeExists() {
582
Class.forName("java.lang.reflect.AnnotatedType");
583
} catch (ClassNotFoundException e) {
589
private static final NullnessAnnotationReader NULLNESS_ANNOTATION_READER =
590
annotatedTypeExists()
591
? NullnessAnnotationReader.FROM_DECLARATION_AND_TYPE_USE_ANNOTATIONS
592
: NullnessAnnotationReader.FROM_DECLARATION_ANNOTATIONS_ONLY;
595
* Looks for declaration nullness annotations and, if supported, type-use nullness annotations.
597
* <p>Under Android VMs, the methods for retrieving type-use annotations don't exist. This means
598
* that {@link NullPointerTester} may misbehave under Android when used on classes that rely on
599
* type-use annotations.
601
* <p>Under j2objc, the necessary APIs exist, but some (perhaps all) return stub values, like
602
* empty arrays. Presumably {@link NullPointerTester} could likewise misbehave under j2objc, but I
603
* don't know that anyone uses it there, anyway.
605
private enum NullnessAnnotationReader {
606
@SuppressWarnings("Java7ApiChecker")
607
FROM_DECLARATION_AND_TYPE_USE_ANNOTATIONS {
609
boolean isNullable(Invokable<?, ?> invokable) {
610
return FROM_DECLARATION_ANNOTATIONS_ONLY.isNullable(invokable)
611
|| containsNullable(invokable.getAnnotatedReturnType().getAnnotations());
612
// TODO(cpovirk): Should we also check isNullableTypeVariable?
616
boolean isNullable(Parameter param) {
617
return FROM_DECLARATION_ANNOTATIONS_ONLY.isNullable(param)
618
|| containsNullable(param.getAnnotatedType().getAnnotations())
619
|| isNullableTypeVariable(param.getAnnotatedType().getType());
622
boolean isNullableTypeVariable(Type type) {
623
if (!(type instanceof TypeVariable)) {
626
TypeVariable<?> typeVar = (TypeVariable<?>) type;
627
for (AnnotatedType bound : typeVar.getAnnotatedBounds()) {
628
// Until Java 15, the isNullableTypeVariable case here won't help:
629
// https://bugs.openjdk.java.net/browse/JDK-8202469
630
if (containsNullable(bound.getAnnotations()) || isNullableTypeVariable(bound.getType())) {
637
FROM_DECLARATION_ANNOTATIONS_ONLY {
639
boolean isNullable(Invokable<?, ?> invokable) {
640
return containsNullable(invokable.getAnnotations());
644
boolean isNullable(Parameter param) {
645
return containsNullable(param.getAnnotations());
649
abstract boolean isNullable(Invokable<?, ?> invokable);
651
abstract boolean isNullable(Parameter param);