/
ContractsTests.java
443 lines (429 loc) · 16.3 KB
/
ContractsTests.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
package com.uber.nullaway;
import java.util.Arrays;
import org.junit.Test;
public class ContractsTests extends NullAwayTestsBase {
@Test
public void checkContractPositiveCases() {
makeTestHelperWithArgs(
Arrays.asList(
"-d",
temporaryFolder.getRoot().getAbsolutePath(),
"-XepOpt:NullAway:AnnotatedPackages=com.uber",
"-XepOpt:NullAway:CheckContracts=true"))
.addSourceFile("CheckContractPositiveCases.java")
.doTest();
}
@Test
public void checkContractNegativeCases() {
makeTestHelperWithArgs(
Arrays.asList(
"-d",
temporaryFolder.getRoot().getAbsolutePath(),
"-XepOpt:NullAway:AnnotatedPackages=com.uber",
"-XepOpt:NullAway:CheckContracts=true"))
.addSourceFile("CheckContractNegativeCases.java")
.doTest();
}
@Test
public void basicContractAnnotation() {
makeTestHelperWithArgs(
Arrays.asList(
"-d",
temporaryFolder.getRoot().getAbsolutePath(),
"-XepOpt:NullAway:AnnotatedPackages=com.uber"))
.addSourceLines(
"NullnessChecker.java",
"package com.uber;",
"import javax.annotation.Nullable;",
"import org.jetbrains.annotations.Contract;",
"public class NullnessChecker {",
" @Contract(\"_, null -> true\")",
" static boolean isNull(boolean flag, @Nullable Object o) { return o == null; }",
" @Contract(\"null -> false\")",
" static boolean isNonNull(@Nullable Object o) { return o != null; }",
" @Contract(\"null -> fail\")",
" static void assertNonNull(@Nullable Object o) { if (o != null) throw new Error(); }",
"}")
.addSourceLines(
"Test.java",
"package com.uber;",
"import javax.annotation.Nullable;",
"class Test {",
" String test1(@Nullable Object o) {",
" return NullnessChecker.isNonNull(o) ? o.toString() : \"null\";",
" }",
" String test2(@Nullable Object o) {",
" return NullnessChecker.isNull(false, o) ? \"null\" : o.toString();",
" }",
" String test3(@Nullable Object o) {",
" NullnessChecker.assertNonNull(o);",
" return o.toString();",
" }",
" String test4(java.util.Map<String,Object> m) {",
" NullnessChecker.assertNonNull(m.get(\"foo\"));",
" return m.get(\"foo\").toString();",
" }",
"}")
.doTest();
}
@Test
public void impliesNonNullContractAnnotation() {
makeTestHelperWithArgs(
Arrays.asList(
"-d",
temporaryFolder.getRoot().getAbsolutePath(),
"-XepOpt:NullAway:AnnotatedPackages=com.uber"))
.addSourceLines(
"NullnessChecker.java",
"package com.uber;",
"import javax.annotation.Nullable;",
"import org.jetbrains.annotations.Contract;",
"public class NullnessChecker {",
" @Contract(\"!null -> !null\")",
" static @Nullable Object noOp(@Nullable Object o) { return o; }",
"}")
.addSourceLines(
"Test.java",
"package com.uber;",
"import javax.annotation.Nullable;",
"class Test {",
" String test1(@Nullable Object o1) {",
" // BUG: Diagnostic contains: dereferenced expression",
" return NullnessChecker.noOp(o1).toString();",
" }",
" String test2(Object o2) {",
" return NullnessChecker.noOp(o2).toString();",
" }",
" Object test3(@Nullable Object o1) {",
" // BUG: Diagnostic contains: returning @Nullable expression",
" return NullnessChecker.noOp(o1);",
" }",
"}")
.doTest();
}
@Test
public void malformedContractAnnotations() {
makeTestHelperWithArgs(
Arrays.asList(
"-d",
temporaryFolder.getRoot().getAbsolutePath(),
"-XepOpt:NullAway:AnnotatedPackages=com.uber"))
.addSourceLines(
"Test.java",
"package com.uber;",
"import javax.annotation.Nullable;",
"import org.jetbrains.annotations.Contract;",
"class Test {",
" @Contract(\"!null -> -> !null\")",
" static @Nullable Object foo(@Nullable Object o) { return o; }",
" @Contract(\"!null -> !null\")",
" static @Nullable Object bar(@Nullable Object o, String s) { return o; }",
" @Contract(\"jabberwocky -> !null\")",
" static @Nullable Object baz(@Nullable Object o) { return o; }",
// We don't care as long as nobody calls the method:
" @Contract(\"!null -> -> !null\")",
" static @Nullable Object dontcare(@Nullable Object o) { return o; }",
" static Object test1() {",
" // BUG: Diagnostic contains: Invalid @Contract annotation",
" return foo(null);",
" }",
" static Object test2() {",
" // BUG: Diagnostic contains: Invalid @Contract annotation",
" return bar(null, \"\");",
" }",
" static Object test3() {",
" // BUG: Diagnostic contains: Invalid @Contract annotation",
" return baz(null);",
" }",
"}")
.doTest();
}
@Test
public void contractNonVarArg() {
makeTestHelperWithArgs(
Arrays.asList(
"-d",
temporaryFolder.getRoot().getAbsolutePath(),
"-XepOpt:NullAway:AnnotatedPackages=com.uber"))
.addSourceLines(
"NullnessChecker.java",
"package com.uber;",
"import javax.annotation.Nullable;",
"import org.jetbrains.annotations.Contract;",
"public class NullnessChecker {",
" @Contract(\"null -> fail\")",
" static void assertNonNull(@Nullable Object o) { if (o != null) throw new Error(); }",
"}")
.addSourceLines(
"Test.java",
"package com.uber;",
"import javax.annotation.Nullable;",
"class Test {",
" void test(java.util.function.Function<Object, Object> fun) {",
" NullnessChecker.assertNonNull(fun.apply(new Object()));",
" }",
"}")
.doTest();
}
@Test
public void contractPureOnlyIgnored() {
makeTestHelperWithArgs(
Arrays.asList(
"-d",
temporaryFolder.getRoot().getAbsolutePath(),
"-XepOpt:NullAway:AnnotatedPackages=com.uber"))
.addSourceLines(
"PureLibrary.java",
"package com.example.library;",
"import org.jetbrains.annotations.Contract;",
"public class PureLibrary {",
" @Contract(",
" pure = true",
" )",
" public static String pi() {",
" // Meh, close enough...",
" return Double.toString(3.14);",
" }",
"}")
.addSourceLines(
"Test.java",
"package com.uber;",
"import com.example.library.PureLibrary;",
"import javax.annotation.Nullable;",
"class Test {",
" String piValue() {",
" String pi = PureLibrary.pi();",
" // Note: we must trigger dataflow to ensure that",
" // ContractHandler.onDataflowVisitMethodInvocation is called",
" if (pi != null) {",
" return pi;",
" }",
" return Integer.toString(3);",
" }",
"}")
.doTest();
}
@Test
public void customContractAnnotation() {
makeTestHelperWithArgs(
Arrays.asList(
"-d",
temporaryFolder.getRoot().getAbsolutePath(),
"-XepOpt:NullAway:AnnotatedPackages=com.uber",
"-XepOpt:NullAway:CustomContractAnnotations=com.example.library.CustomContract",
"-XepOpt:NullAway:CheckContracts=true"))
.addSourceLines(
"CustomContract.java",
"package com.example.library;",
"import static java.lang.annotation.RetentionPolicy.CLASS;",
"import java.lang.annotation.Retention;",
"@Retention(CLASS)",
"public @interface CustomContract {",
" String value();",
"}")
.addSourceLines(
"NullnessChecker.java",
"package com.uber;",
"import javax.annotation.Nullable;",
"import com.example.library.CustomContract;",
"public class NullnessChecker {",
" @CustomContract(\"_, !null -> !null\")",
" @Nullable",
" static Object bad(Object a, @Nullable Object b) {",
" if (a.hashCode() % 2 == 0) {",
" // BUG: Diagnostic contains: Method bad has @Contract",
" return null;",
" }",
" return new Object();",
" }",
"",
" @CustomContract(\"_, !null -> !null\")",
" @Nullable",
" static Object good(Object a, @Nullable Object b) {",
" if (a.hashCode() % 2 == 0) {",
" return b;",
" }",
" return new Object();",
" }",
"}")
.addSourceLines(
"Test.java",
"package com.uber;",
"import javax.annotation.Nullable;",
"class Test {",
" String test1() {",
" return NullnessChecker.good(\"bar\", \"foo\").toString();",
" }",
" String test2() {",
" // BUG: Diagnostic contains: dereferenced expression",
" return NullnessChecker.good(\"bar\", null).toString();",
" }",
"}")
.doTest();
}
@Test
public void contractDeclaringBothNotNull() {
makeTestHelperWithArgs(
Arrays.asList(
"-d",
temporaryFolder.getRoot().getAbsolutePath(),
"-XepOpt:NullAway:AnnotatedPackages=com.uber"))
.addSourceLines(
"NullnessChecker.java",
"package com.uber;",
"import javax.annotation.Nullable;",
"import org.jetbrains.annotations.Contract;",
"public class NullnessChecker {",
" @Contract(\"null, _ -> false; _, null -> false\")",
" static boolean bothNotNull(@Nullable Object o1, @Nullable Object o2) {",
" // null, _ -> false",
" if (o1 == null) {",
" return false;",
" }",
" // _, null -> false",
" if (o2 == null) {",
" return false;",
" }",
" // Function cannot declare a contract for true",
" return System.currentTimeMillis() % 100 == 0;",
" }",
"}")
.addSourceLines(
"Test.java",
"package com.uber;",
"import javax.annotation.Nullable;",
"class Test {",
" String test1(@Nullable Object o) {",
" return NullnessChecker.bothNotNull(\"\", o)",
" ? o.toString()",
" // BUG: Diagnostic contains: dereferenced expression",
" : o.toString();",
" }",
" String test2(@Nullable Object o) {",
" return NullnessChecker.bothNotNull(o, \"\")",
" ? o.toString()",
" // BUG: Diagnostic contains: dereferenced expression",
" : o.toString();",
" }",
"}")
.doTest();
}
@Test
public void contractDeclaringEitherNull() {
makeTestHelperWithArgs(
Arrays.asList(
"-d",
temporaryFolder.getRoot().getAbsolutePath(),
"-XepOpt:NullAway:AnnotatedPackages=com.uber"))
.addSourceLines(
"NullnessChecker.java",
"package com.uber;",
"import javax.annotation.Nullable;",
"import org.jetbrains.annotations.Contract;",
"public class NullnessChecker {",
" @Contract(\"null, _ -> true; _, null -> true\")",
" static boolean eitherIsNullOrRandom(@Nullable Object o1, @Nullable Object o2) {",
" // null, _ -> true",
" if (o1 == null) {",
" return true;",
" }",
" // _, null -> true",
" if (o2 == null) {",
" return true;",
" }",
" // Function cannot declare a contract for false",
" return System.currentTimeMillis() % 100 == 0;",
" }",
"}")
.addSourceLines(
"Test.java",
"package com.uber;",
"import javax.annotation.Nullable;",
"class Test {",
" String test1(@Nullable Object o) {",
" return NullnessChecker.eitherIsNullOrRandom(\"\", o)",
" // BUG: Diagnostic contains: dereferenced expression",
" ? o.toString()",
" : o.toString();",
" }",
" String test2(@Nullable Object o) {",
" return NullnessChecker.eitherIsNullOrRandom(o, \"\")",
" // BUG: Diagnostic contains: dereferenced expression",
" ? o.toString()",
" : o.toString();",
" }",
"}")
.doTest();
}
@Test
public void contractDeclaringNullOrRandomFalse() {
makeTestHelperWithArgs(
Arrays.asList(
"-d",
temporaryFolder.getRoot().getAbsolutePath(),
"-XepOpt:NullAway:AnnotatedPackages=com.uber"))
.addSourceLines(
"NullnessChecker.java",
"package com.uber;",
"import javax.annotation.Nullable;",
"import org.jetbrains.annotations.Contract;",
"public class NullnessChecker {",
" @Contract(\"null -> false\")",
" static boolean isHashCodeZero(@Nullable Object o) {",
" // null -> false",
" if (o == null) {",
" return false;",
" }",
" // Function cannot declare a contract for true",
" return o.hashCode() == 0;",
" }",
"}")
.addSourceLines(
"Test.java",
"package com.uber;",
"import javax.annotation.Nullable;",
"class Test {",
" String test1(@Nullable Object o) {",
" return NullnessChecker.isHashCodeZero(o)",
" ? o.toString()",
" // BUG: Diagnostic contains: dereferenced expression",
" : o.toString();",
" }",
"}")
.doTest();
}
@Test
public void contractUnreachablePath() {
makeTestHelperWithArgs(
Arrays.asList(
"-d",
temporaryFolder.getRoot().getAbsolutePath(),
"-XepOpt:NullAway:AnnotatedPackages=com.uber"))
.addSourceLines(
"NullnessChecker.java",
"package com.uber;",
"import javax.annotation.Nullable;",
"import org.jetbrains.annotations.Contract;",
"public class NullnessChecker {",
" @Contract(\"!null -> false\")",
" static boolean isNull(@Nullable Object o) {",
" // !null -> false",
" if (o != null) {",
" return false;",
" }",
" return true;",
" }",
"}")
.addSourceLines(
"Test.java",
"package com.uber;",
"class Test {",
" String test(Object required) {",
" return NullnessChecker.isNull(required)",
" ? required.toString()",
" : required.toString();",
" }",
"}")
.doTest();
}
}