/
NullPointerTesterTest.java
1428 lines (1190 loc) · 44.5 KB
/
NullPointerTesterTest.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
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright (C) 2005 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.testing;
import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Preconditions.checkNotNull;
import static com.google.common.truth.Truth.assertThat;
import com.google.common.base.Converter;
import com.google.common.base.Function;
import com.google.common.base.Supplier;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableMultimap;
import com.google.common.collect.ImmutableMultiset;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.ImmutableSortedSet;
import com.google.common.collect.ImmutableTable;
import com.google.common.collect.Maps;
import com.google.common.collect.Multimap;
import com.google.common.collect.Multiset;
import com.google.common.collect.Table;
import com.google.common.reflect.TypeToken;
import com.google.common.testing.NullPointerTester.Visibility;
import com.google.common.testing.anotherpackage.SomeClassThatDoesNotUseNullable;
import java.lang.reflect.Constructor;
import java.lang.reflect.Method;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Set;
import java.util.SortedSet;
import junit.framework.AssertionFailedError;
import junit.framework.TestCase;
import org.checkerframework.checker.nullness.compatqual.NullableDecl;
/**
* Unit test for {@link NullPointerTester}.
*
* @author Kevin Bourrillion
* @author Mick Killianey
*/
public class NullPointerTesterTest extends TestCase {
/** Non-NPE RuntimeException. */
public static class FooException extends RuntimeException {
private static final long serialVersionUID = 1L;
}
/**
* Class for testing all permutations of static/non-static one-argument methods using
* methodParameter().
*/
@SuppressWarnings("unused") // used by reflection
public static class OneArg {
public static void staticOneArgCorrectlyThrowsNpe(String s) {
checkNotNull(s); // expect NPE here on null
}
public static void staticOneArgThrowsOtherThanNpe(String s) {
throw new FooException(); // should catch as failure
}
public static void staticOneArgShouldThrowNpeButDoesnt(String s) {
// should catch as failure
}
public static void staticOneArgCheckForNullCorrectlyDoesNotThrowNPE(
@javax.annotation.CheckForNull String s) {
// null? no problem
}
public static void staticOneArgJsr305NullableCorrectlyDoesNotThrowNPE(@NullableDecl String s) {
// null? no problem
}
public static void staticOneArgNullableCorrectlyDoesNotThrowNPE(@NullableDecl String s) {
// null? no problem
}
public static void staticOneArgCheckForNullCorrectlyThrowsOtherThanNPE(
@javax.annotation.CheckForNull String s) {
throw new FooException(); // ok, as long as it's not NullPointerException
}
public static void staticOneArgNullableCorrectlyThrowsOtherThanNPE(@NullableDecl String s) {
throw new FooException(); // ok, as long as it's not NullPointerException
}
public static void staticOneArgCheckForNullThrowsNPE(@javax.annotation.CheckForNull String s) {
checkNotNull(s); // doesn't check if you said you'd accept null, but you don't
}
public static void staticOneArgNullableThrowsNPE(@NullableDecl String s) {
checkNotNull(s); // doesn't check if you said you'd accept null, but you don't
}
public void oneArgCorrectlyThrowsNpe(String s) {
checkNotNull(s); // expect NPE here on null
}
public void oneArgThrowsOtherThanNpe(String s) {
throw new FooException(); // should catch as failure
}
public void oneArgShouldThrowNpeButDoesnt(String s) {
// should catch as failure
}
public void oneArgCheckForNullCorrectlyDoesNotThrowNPE(
@javax.annotation.CheckForNull String s) {
// null? no problem
}
public void oneArgNullableCorrectlyDoesNotThrowNPE(@NullableDecl String s) {
// null? no problem
}
public void oneArgCheckForNullCorrectlyThrowsOtherThanNPE(
@javax.annotation.CheckForNull String s) {
throw new FooException(); // ok, as long as it's not NullPointerException
}
public void oneArgNullableCorrectlyThrowsOtherThanNPE(@NullableDecl String s) {
throw new FooException(); // ok, as long as it's not NullPointerException
}
public void oneArgCheckForNullThrowsNPE(@javax.annotation.CheckForNull String s) {
checkNotNull(s); // doesn't check if you said you'd accept null, but you don't
}
public void oneArgNullableThrowsNPE(@NullableDecl String s) {
checkNotNull(s); // doesn't check if you said you'd accept null, but you don't
}
}
private static final String[] STATIC_ONE_ARG_METHODS_SHOULD_PASS = {
"staticOneArgCorrectlyThrowsNpe",
"staticOneArgCheckForNullCorrectlyDoesNotThrowNPE",
"staticOneArgCheckForNullCorrectlyThrowsOtherThanNPE",
"staticOneArgCheckForNullThrowsNPE",
"staticOneArgNullableCorrectlyDoesNotThrowNPE",
"staticOneArgNullableCorrectlyThrowsOtherThanNPE",
"staticOneArgNullableThrowsNPE",
};
private static final String[] STATIC_ONE_ARG_METHODS_SHOULD_FAIL = {
"staticOneArgThrowsOtherThanNpe", "staticOneArgShouldThrowNpeButDoesnt",
};
private static final String[] NONSTATIC_ONE_ARG_METHODS_SHOULD_PASS = {
"oneArgCorrectlyThrowsNpe",
"oneArgCheckForNullCorrectlyDoesNotThrowNPE",
"oneArgCheckForNullCorrectlyThrowsOtherThanNPE",
"oneArgCheckForNullThrowsNPE",
"oneArgNullableCorrectlyDoesNotThrowNPE",
"oneArgNullableCorrectlyThrowsOtherThanNPE",
"oneArgNullableThrowsNPE",
};
private static final String[] NONSTATIC_ONE_ARG_METHODS_SHOULD_FAIL = {
"oneArgThrowsOtherThanNpe", "oneArgShouldThrowNpeButDoesnt",
};
private static class ThrowsIae {
public static void christenPoodle(String name) {
checkArgument(name != null);
}
}
private static class ThrowsNpe {
public static void christenPoodle(String name) {
checkNotNull(name);
}
}
private static class ThrowsUoe {
public static void christenPoodle(String name) {
throw new UnsupportedOperationException();
}
}
private static class ThrowsSomethingElse {
public static void christenPoodle(String name) {
throw new RuntimeException();
}
}
public void testDontAcceptIae() {
NullPointerTester tester = new NullPointerTester();
tester.testAllPublicStaticMethods(ThrowsNpe.class);
tester.testAllPublicStaticMethods(ThrowsUoe.class);
try {
tester.testAllPublicStaticMethods(ThrowsIae.class);
} catch (AssertionFailedError expected) {
return;
}
fail();
}
public void testStaticOneArgMethodsThatShouldPass() throws Exception {
for (String methodName : STATIC_ONE_ARG_METHODS_SHOULD_PASS) {
Method method = OneArg.class.getMethod(methodName, String.class);
try {
new NullPointerTester().testMethodParameter(new OneArg(), method, 0);
} catch (AssertionFailedError unexpected) {
fail("Should not have flagged method " + methodName);
}
}
}
public void testStaticOneArgMethodsThatShouldFail() throws Exception {
for (String methodName : STATIC_ONE_ARG_METHODS_SHOULD_FAIL) {
Method method = OneArg.class.getMethod(methodName, String.class);
boolean foundProblem = false;
try {
new NullPointerTester().testMethodParameter(new OneArg(), method, 0);
} catch (AssertionFailedError expected) {
foundProblem = true;
}
assertTrue("Should report error in method " + methodName, foundProblem);
}
}
public void testNonStaticOneArgMethodsThatShouldPass() throws Exception {
OneArg foo = new OneArg();
for (String methodName : NONSTATIC_ONE_ARG_METHODS_SHOULD_PASS) {
Method method = OneArg.class.getMethod(methodName, String.class);
try {
new NullPointerTester().testMethodParameter(foo, method, 0);
} catch (AssertionFailedError unexpected) {
fail("Should not have flagged method " + methodName);
}
}
}
public void testNonStaticOneArgMethodsThatShouldFail() throws Exception {
OneArg foo = new OneArg();
for (String methodName : NONSTATIC_ONE_ARG_METHODS_SHOULD_FAIL) {
Method method = OneArg.class.getMethod(methodName, String.class);
boolean foundProblem = false;
try {
new NullPointerTester().testMethodParameter(foo, method, 0);
} catch (AssertionFailedError expected) {
foundProblem = true;
}
assertTrue("Should report error in method " + methodName, foundProblem);
}
}
public void testMessageOtherException() throws Exception {
Method method = OneArg.class.getMethod("staticOneArgThrowsOtherThanNpe", String.class);
boolean foundProblem = false;
try {
new NullPointerTester().testMethodParameter(new OneArg(), method, 0);
} catch (AssertionFailedError expected) {
assertThat(expected.getMessage()).contains("index 0");
assertThat(expected.getMessage()).contains("[null]");
foundProblem = true;
}
assertTrue("Should report error when different exception is thrown", foundProblem);
}
public void testMessageNoException() throws Exception {
Method method = OneArg.class.getMethod("staticOneArgShouldThrowNpeButDoesnt", String.class);
boolean foundProblem = false;
try {
new NullPointerTester().testMethodParameter(new OneArg(), method, 0);
} catch (AssertionFailedError expected) {
assertThat(expected.getMessage()).contains("index 0");
assertThat(expected.getMessage()).contains("[null]");
foundProblem = true;
}
assertTrue("Should report error when no exception is thrown", foundProblem);
}
/**
* Class for testing all permutations of nullable/non-nullable two-argument methods using
* testMethod().
*
* <ul>
* <li>normalNormal: two params, neither is Nullable
* <li>nullableNormal: only first param is Nullable
* <li>normalNullable: only second param is Nullable
* <li>nullableNullable: both params are Nullable
* </ul>
*/
public static class TwoArg {
/** Action to take on a null param. */
public enum Action {
THROW_A_NPE {
@Override
public void act() {
throw new NullPointerException();
}
},
THROW_OTHER {
@Override
public void act() {
throw new FooException();
}
},
JUST_RETURN {
@Override
public void act() {}
};
public abstract void act();
}
Action actionWhenFirstParamIsNull;
Action actionWhenSecondParamIsNull;
public TwoArg(Action actionWhenFirstParamIsNull, Action actionWhenSecondParamIsNull) {
this.actionWhenFirstParamIsNull = actionWhenFirstParamIsNull;
this.actionWhenSecondParamIsNull = actionWhenSecondParamIsNull;
}
/** Method that decides how to react to parameters. */
public void reactToNullParameters(Object first, Object second) {
if (first == null) {
actionWhenFirstParamIsNull.act();
}
if (second == null) {
actionWhenSecondParamIsNull.act();
}
}
/** Two-arg method with no Nullable params. */
public void normalNormal(String first, Integer second) {
reactToNullParameters(first, second);
}
/** Two-arg method with the second param Nullable. */
public void normalNullable(String first, @NullableDecl Integer second) {
reactToNullParameters(first, second);
}
/** Two-arg method with the first param Nullable. */
public void nullableNormal(@NullableDecl String first, Integer second) {
reactToNullParameters(first, second);
}
/** Two-arg method with the both params Nullable. */
public void nullableNullable(@NullableDecl String first, @NullableDecl Integer second) {
reactToNullParameters(first, second);
}
/** To provide sanity during debugging. */
@Override
public String toString() {
return rootLocaleFormat(
"Bar(%s, %s)", actionWhenFirstParamIsNull, actionWhenSecondParamIsNull);
}
}
public void verifyBarPass(Method method, TwoArg bar) {
try {
new NullPointerTester().testMethod(bar, method);
} catch (AssertionFailedError incorrectError) {
String errorMessage =
rootLocaleFormat("Should not have flagged method %s for %s", method.getName(), bar);
assertNull(errorMessage, incorrectError);
}
}
public void verifyBarFail(Method method, TwoArg bar) {
try {
new NullPointerTester().testMethod(bar, method);
} catch (AssertionFailedError expected) {
return; // good...we wanted a failure
}
String errorMessage =
rootLocaleFormat("Should have flagged method %s for %s", method.getName(), bar);
fail(errorMessage);
}
public void testTwoArgNormalNormal() throws Exception {
Method method = TwoArg.class.getMethod("normalNormal", String.class, Integer.class);
for (TwoArg.Action first : TwoArg.Action.values()) {
for (TwoArg.Action second : TwoArg.Action.values()) {
TwoArg bar = new TwoArg(first, second);
if (first.equals(TwoArg.Action.THROW_A_NPE) && second.equals(TwoArg.Action.THROW_A_NPE)) {
verifyBarPass(method, bar); // require both params to throw NPE
} else {
verifyBarFail(method, bar);
}
}
}
}
public void testTwoArgNormalNullable() throws Exception {
Method method = TwoArg.class.getMethod("normalNullable", String.class, Integer.class);
for (TwoArg.Action first : TwoArg.Action.values()) {
for (TwoArg.Action second : TwoArg.Action.values()) {
TwoArg bar = new TwoArg(first, second);
if (first.equals(TwoArg.Action.THROW_A_NPE)) {
verifyBarPass(method, bar); // only pass if 1st param throws NPE
} else {
verifyBarFail(method, bar);
}
}
}
}
public void testTwoArgNullableNormal() throws Exception {
Method method = TwoArg.class.getMethod("nullableNormal", String.class, Integer.class);
for (TwoArg.Action first : TwoArg.Action.values()) {
for (TwoArg.Action second : TwoArg.Action.values()) {
TwoArg bar = new TwoArg(first, second);
if (second.equals(TwoArg.Action.THROW_A_NPE)) {
verifyBarPass(method, bar); // only pass if 2nd param throws NPE
} else {
verifyBarFail(method, bar);
}
}
}
}
public void testTwoArgNullableNullable() throws Exception {
Method method = TwoArg.class.getMethod("nullableNullable", String.class, Integer.class);
for (TwoArg.Action first : TwoArg.Action.values()) {
for (TwoArg.Action second : TwoArg.Action.values()) {
TwoArg bar = new TwoArg(first, second);
verifyBarPass(method, bar); // All args nullable: anything goes!
}
}
}
/*
* This next part consists of several sample classes that provide
* demonstrations of conditions that cause NullPointerTester
* to succeed/fail.
*/
/** Lots of well-behaved methods. */
@SuppressWarnings("unused") // used by reflection
private static class PassObject extends SomeClassThatDoesNotUseNullable {
public static void doThrow(Object arg) {
if (arg == null) {
throw new FooException();
}
}
public void noArg() {}
public void oneArg(String s) {
checkNotNull(s);
}
void packagePrivateOneArg(String s) {
checkNotNull(s);
}
protected void protectedOneArg(String s) {
checkNotNull(s);
}
public void oneNullableArg(@NullableDecl String s) {}
public void oneNullableArgThrows(@NullableDecl String s) {
doThrow(s);
}
public void twoArg(String s, Integer i) {
checkNotNull(s);
i.intValue();
}
public void twoMixedArgs(String s, @NullableDecl Integer i) {
checkNotNull(s);
}
public void twoMixedArgs(@NullableDecl Integer i, String s) {
checkNotNull(s);
}
public void twoMixedArgsThrows(String s, @NullableDecl Integer i) {
checkNotNull(s);
doThrow(i);
}
public void twoMixedArgsThrows(@NullableDecl Integer i, String s) {
checkNotNull(s);
doThrow(i);
}
public void twoNullableArgs(@NullableDecl String s, @NullableDecl Integer i) {}
public void twoNullableArgsThrowsFirstArg(@NullableDecl String s, @NullableDecl Integer i) {
doThrow(s);
}
public void twoNullableArgsThrowsSecondArg(@NullableDecl String s, @NullableDecl Integer i) {
doThrow(i);
}
public static void staticOneArg(String s) {
checkNotNull(s);
}
public static void staticOneNullableArg(@NullableDecl String s) {}
public static void staticOneNullableArgThrows(@NullableDecl String s) {
doThrow(s);
}
}
public void testGoodClass() {
shouldPass(new PassObject());
}
private static class FailOneArgDoesntThrowNPE extends PassObject {
@Override
public void oneArg(String s) {
// Fail: missing NPE for s
}
}
public void testFailOneArgDoesntThrowNpe() {
shouldFail(new FailOneArgDoesntThrowNPE());
}
private static class FailOneArgThrowsWrongType extends PassObject {
@Override
public void oneArg(String s) {
doThrow(s); // Fail: throwing non-NPE exception for null s
}
}
public void testFailOneArgThrowsWrongType() {
shouldFail(new FailOneArgThrowsWrongType());
}
private static class PassOneNullableArgThrowsNPE extends PassObject {
@Override
public void oneNullableArg(@NullableDecl String s) {
checkNotNull(s); // ok to throw NPE
}
}
public void testPassOneNullableArgThrowsNPE() {
shouldPass(new PassOneNullableArgThrowsNPE());
}
private static class FailTwoArgsFirstArgDoesntThrowNPE extends PassObject {
@Override
public void twoArg(String s, Integer i) {
// Fail: missing NPE for s
i.intValue();
}
}
public void testFailTwoArgsFirstArgDoesntThrowNPE() {
shouldFail(new FailTwoArgsFirstArgDoesntThrowNPE());
}
private static class FailTwoArgsFirstArgThrowsWrongType extends PassObject {
@Override
public void twoArg(String s, Integer i) {
doThrow(s); // Fail: throwing non-NPE exception for null s
i.intValue();
}
}
public void testFailTwoArgsFirstArgThrowsWrongType() {
shouldFail(new FailTwoArgsFirstArgThrowsWrongType());
}
private static class FailTwoArgsSecondArgDoesntThrowNPE extends PassObject {
@Override
public void twoArg(String s, Integer i) {
checkNotNull(s);
// Fail: missing NPE for i
}
}
public void testFailTwoArgsSecondArgDoesntThrowNPE() {
shouldFail(new FailTwoArgsSecondArgDoesntThrowNPE());
}
private static class FailTwoArgsSecondArgThrowsWrongType extends PassObject {
@Override
public void twoArg(String s, Integer i) {
checkNotNull(s);
doThrow(i); // Fail: throwing non-NPE exception for null i
}
}
public void testFailTwoArgsSecondArgThrowsWrongType() {
shouldFail(new FailTwoArgsSecondArgThrowsWrongType());
}
private static class FailTwoMixedArgsFirstArgDoesntThrowNPE extends PassObject {
@Override
public void twoMixedArgs(String s, @NullableDecl Integer i) {
// Fail: missing NPE for s
}
}
public void testFailTwoMixedArgsFirstArgDoesntThrowNPE() {
shouldFail(new FailTwoMixedArgsFirstArgDoesntThrowNPE());
}
private static class FailTwoMixedArgsFirstArgThrowsWrongType extends PassObject {
@Override
public void twoMixedArgs(String s, @NullableDecl Integer i) {
doThrow(s); // Fail: throwing non-NPE exception for null s
}
}
public void testFailTwoMixedArgsFirstArgThrowsWrongType() {
shouldFail(new FailTwoMixedArgsFirstArgThrowsWrongType());
}
private static class PassTwoMixedArgsNullableArgThrowsNPE extends PassObject {
@Override
public void twoMixedArgs(String s, @NullableDecl Integer i) {
checkNotNull(s);
i.intValue(); // ok to throw NPE?
}
}
public void testPassTwoMixedArgsNullableArgThrowsNPE() {
shouldPass(new PassTwoMixedArgsNullableArgThrowsNPE());
}
private static class PassTwoMixedArgSecondNullableArgThrowsOther extends PassObject {
@Override
public void twoMixedArgs(String s, @NullableDecl Integer i) {
checkNotNull(s);
doThrow(i); // ok to throw non-NPE exception for null i
}
}
public void testPassTwoMixedArgSecondNullableArgThrowsOther() {
shouldPass(new PassTwoMixedArgSecondNullableArgThrowsOther());
}
private static class FailTwoMixedArgsSecondArgDoesntThrowNPE extends PassObject {
@Override
public void twoMixedArgs(@NullableDecl Integer i, String s) {
// Fail: missing NPE for null s
}
}
public void testFailTwoMixedArgsSecondArgDoesntThrowNPE() {
shouldFail(new FailTwoMixedArgsSecondArgDoesntThrowNPE());
}
private static class FailTwoMixedArgsSecondArgThrowsWrongType extends PassObject {
@Override
public void twoMixedArgs(@NullableDecl Integer i, String s) {
doThrow(s); // Fail: throwing non-NPE exception for null s
}
}
public void testFailTwoMixedArgsSecondArgThrowsWrongType() {
shouldFail(new FailTwoMixedArgsSecondArgThrowsWrongType());
}
private static class PassTwoNullableArgsFirstThrowsNPE extends PassObject {
@Override
public void twoNullableArgs(@NullableDecl String s, @NullableDecl Integer i) {
checkNotNull(s); // ok to throw NPE?
}
}
public void testPassTwoNullableArgsFirstThrowsNPE() {
shouldPass(new PassTwoNullableArgsFirstThrowsNPE());
}
private static class PassTwoNullableArgsFirstThrowsOther extends PassObject {
@Override
public void twoNullableArgs(@NullableDecl String s, @NullableDecl Integer i) {
doThrow(s); // ok to throw non-NPE exception for null s
}
}
public void testPassTwoNullableArgsFirstThrowsOther() {
shouldPass(new PassTwoNullableArgsFirstThrowsOther());
}
private static class PassTwoNullableArgsSecondThrowsNPE extends PassObject {
@Override
public void twoNullableArgs(@NullableDecl String s, @NullableDecl Integer i) {
i.intValue(); // ok to throw NPE?
}
}
public void testPassTwoNullableArgsSecondThrowsNPE() {
shouldPass(new PassTwoNullableArgsSecondThrowsNPE());
}
private static class PassTwoNullableArgsSecondThrowsOther extends PassObject {
@Override
public void twoNullableArgs(@NullableDecl String s, @NullableDecl Integer i) {
doThrow(i); // ok to throw non-NPE exception for null i
}
}
public void testPassTwoNullableArgsSecondThrowsOther() {
shouldPass(new PassTwoNullableArgsSecondThrowsOther());
}
private static class PassTwoNullableArgsNeitherThrowsAnything extends PassObject {
@Override
public void twoNullableArgs(@NullableDecl String s, @NullableDecl Integer i) {
// ok to do nothing
}
}
public void testPassTwoNullableArgsNeitherThrowsAnything() {
shouldPass(new PassTwoNullableArgsNeitherThrowsAnything());
}
@SuppressWarnings("unused") // for NullPointerTester
private abstract static class BaseClassThatFailsToThrow {
public void oneArg(String s) {}
}
private static class SubclassWithBadSuperclass extends BaseClassThatFailsToThrow {}
public void testSubclassWithBadSuperclass() {
shouldFail(new SubclassWithBadSuperclass());
}
@SuppressWarnings("unused") // for NullPointerTester
private abstract static class BaseClassThatFailsToThrowForPackagePrivate {
void packagePrivateOneArg(String s) {}
}
private static class SubclassWithBadSuperclassForPackagePrivate
extends BaseClassThatFailsToThrowForPackagePrivate {}
public void testSubclassWithBadSuperclassForPackagePrivateMethod() {
shouldFail(new SubclassWithBadSuperclassForPackagePrivate(), Visibility.PACKAGE);
}
@SuppressWarnings("unused") // for NullPointerTester
private abstract static class BaseClassThatFailsToThrowForProtected {
protected void protectedOneArg(String s) {}
}
private static class SubclassWithBadSuperclassForProtected
extends BaseClassThatFailsToThrowForProtected {}
public void testSubclassWithBadSuperclassForPackageProtectedMethod() {
shouldFail(new SubclassWithBadSuperclassForProtected(), Visibility.PROTECTED);
}
private static class SubclassThatOverridesBadSuperclassMethod extends BaseClassThatFailsToThrow {
@Override
public void oneArg(@NullableDecl String s) {}
}
public void testSubclassThatOverridesBadSuperclassMethod() {
shouldPass(new SubclassThatOverridesBadSuperclassMethod());
}
@SuppressWarnings("unused") // for NullPointerTester
private static class SubclassOverridesTheWrongMethod extends BaseClassThatFailsToThrow {
public void oneArg(@NullableDecl CharSequence s) {}
}
public void testSubclassOverridesTheWrongMethod() {
shouldFail(new SubclassOverridesTheWrongMethod());
}
@SuppressWarnings("unused") // for NullPointerTester
private static class ClassThatFailsToThrowForStatic {
static void staticOneArg(String s) {}
}
public void testClassThatFailsToThrowForStatic() {
shouldFail(ClassThatFailsToThrowForStatic.class);
}
private static class SubclassThatFailsToThrowForStatic extends ClassThatFailsToThrowForStatic {}
public void testSubclassThatFailsToThrowForStatic() {
shouldFail(SubclassThatFailsToThrowForStatic.class);
}
private static class SubclassThatTriesToOverrideBadStaticMethod
extends ClassThatFailsToThrowForStatic {
static void staticOneArg(@NullableDecl String s) {}
}
public void testSubclassThatTriesToOverrideBadStaticMethod() {
shouldFail(SubclassThatTriesToOverrideBadStaticMethod.class);
}
private static final class HardToCreate {
private HardToCreate(HardToCreate x) {}
}
@SuppressWarnings("unused") // used by reflection
private static class CanCreateDefault {
public void foo(@NullableDecl HardToCreate ignored, String required) {
checkNotNull(required);
}
}
public void testCanCreateDefault() {
shouldPass(new CanCreateDefault());
}
@SuppressWarnings("unused") // used by reflection
private static class CannotCreateDefault {
public void foo(HardToCreate ignored, String required) {
checkNotNull(ignored);
checkNotNull(required);
}
}
public void testCannotCreateDefault() {
shouldFail(new CannotCreateDefault());
}
private static void shouldPass(Object instance, Visibility visibility) {
new NullPointerTester().testInstanceMethods(instance, visibility);
}
private static void shouldPass(Object instance) {
shouldPass(instance, Visibility.PACKAGE);
shouldPass(instance, Visibility.PROTECTED);
shouldPass(instance, Visibility.PUBLIC);
}
// TODO(cpovirk): eliminate surprising Object/Class overloading of shouldFail
private static void shouldFail(Object instance, Visibility visibility) {
try {
new NullPointerTester().testInstanceMethods(instance, visibility);
} catch (AssertionFailedError expected) {
return;
}
fail("Should detect problem in " + instance.getClass().getSimpleName());
}
private static void shouldFail(Object instance) {
shouldFail(instance, Visibility.PACKAGE);
shouldFail(instance, Visibility.PROTECTED);
shouldFail(instance, Visibility.PUBLIC);
}
private static void shouldFail(Class<?> cls, Visibility visibility) {
try {
new NullPointerTester().testStaticMethods(cls, visibility);
} catch (AssertionFailedError expected) {
return;
}
fail("Should detect problem in " + cls.getSimpleName());
}
private static void shouldFail(Class<?> cls) {
shouldFail(cls, Visibility.PACKAGE);
}
@SuppressWarnings("unused") // used by reflection
private static class PrivateClassWithPrivateConstructor {
private PrivateClassWithPrivateConstructor(@NullableDecl Integer argument) {}
}
public void testPrivateClass() {
NullPointerTester tester = new NullPointerTester();
for (Constructor<?> constructor :
PrivateClassWithPrivateConstructor.class.getDeclaredConstructors()) {
tester.testConstructor(constructor);
}
}
private interface Foo<T> {
void doSomething(T bar, Integer baz);
}
private static class StringFoo implements Foo<String> {
@Override
public void doSomething(String bar, Integer baz) {
checkNotNull(bar);
checkNotNull(baz);
}
}
public void testBridgeMethodIgnored() {
new NullPointerTester().testAllPublicInstanceMethods(new StringFoo());
}
private abstract static class DefaultValueChecker {
private final Map<Integer, Object> arguments = Maps.newHashMap();
final DefaultValueChecker runTester() {
new NullPointerTester().testInstanceMethods(this, Visibility.PACKAGE);
return this;
}
final void assertNonNullValues(Object... expectedValues) {
assertEquals(expectedValues.length, arguments.size());
for (int i = 0; i < expectedValues.length; i++) {
assertEquals("Default value for parameter #" + i, expectedValues[i], arguments.get(i));
}
}
final Object getDefaultParameterValue(int position) {
return arguments.get(position);
}
final void calledWith(Object... args) {
for (int i = 0; i < args.length; i++) {
if (args[i] != null) {
arguments.put(i, args[i]);
}
}
for (Object arg : args) {
checkNotNull(arg); // to fulfill null check
}
}
}
private enum Gender {
MALE,
FEMALE
}
private static class AllDefaultValuesChecker extends DefaultValueChecker {
@SuppressWarnings("unused") // called by NullPointerTester
public void checkDefaultValuesForTheseTypes(
Gender gender,
Integer integer,
int i,
String string,
CharSequence charSequence,
List<String> list,
ImmutableList<Integer> immutableList,
Map<String, Integer> map,
ImmutableMap<String, String> immutableMap,
Set<String> set,
ImmutableSet<Integer> immutableSet,
SortedSet<Number> sortedSet,
ImmutableSortedSet<Number> immutableSortedSet,
Multiset<String> multiset,
ImmutableMultiset<Integer> immutableMultiset,
Multimap<String, Integer> multimap,
ImmutableMultimap<String, Integer> immutableMultimap,
Table<String, Integer, Exception> table,
ImmutableTable<Integer, String, Exception> immutableTable) {
calledWith(
gender,
integer,
i,
string,
charSequence,
list,
immutableList,
map,
immutableMap,
set,
immutableSet,
sortedSet,
immutableSortedSet,
multiset,
immutableMultiset,
multimap,
immutableMultimap,
table,
immutableTable);
}
final void check() {
runTester()
.assertNonNullValues(
Gender.MALE,
Integer.valueOf(0),
0,
"",
"",
ImmutableList.of(),
ImmutableList.of(),
ImmutableMap.of(),
ImmutableMap.of(),
ImmutableSet.of(),
ImmutableSet.of(),
ImmutableSortedSet.of(),
ImmutableSortedSet.of(),