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
|
/*
* Copyright (c) 2023 Uber Technologies, Inc.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package com.uber.nullaway;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
@RunWith(JUnit4.class)
public class NullAwayTypeUseAnnotationsTests extends NullAwayTestsBase {
@Test
public void annotationAppliedToTypeParameter() {
defaultCompilationHelper
.addSourceLines(
"Test.java",
"package com.uber;",
"import java.util.List;",
"import java.util.ArrayList;",
"import org.checkerframework.checker.nullness.qual.Nullable;",
"import org.checkerframework.checker.nullness.qual.NonNull;",
"class TypeArgumentAnnotation {",
" List<@Nullable String> fSafe = new ArrayList<>();",
" @Nullable List<String> fUnsafe = new ArrayList<>();",
" void useParamSafe(List<@Nullable String> list) {",
" list.hashCode();",
" }",
" void unsafeCall() {",
" // BUG: Diagnostic contains: passing @Nullable parameter",
" useParamSafe(null);",
" }",
" void useParamUnsafe(@Nullable List<String> list) {",
" // BUG: Diagnostic contains: dereferenced",
" list.hashCode();",
" }",
" void useParamUnsafeNonNullElements(@Nullable List<@NonNull String> list) {",
" // BUG: Diagnostic contains: dereferenced",
" list.hashCode();",
" }",
" void safeCall() {",
" useParamUnsafeNonNullElements(null);",
" }",
" void useFieldSafe() {",
" fSafe.hashCode();",
" }",
" void useFieldUnsafe() {",
" // BUG: Diagnostic contains: dereferenced",
" fUnsafe.hashCode();",
" }",
"}")
.doTest();
}
@Test
public void annotationAppliedToInnerTypeImplicitly() {
defaultCompilationHelper
.addSourceLines(
"Test.java",
"package com.uber;",
"import org.checkerframework.checker.nullness.qual.Nullable;",
"class Test {",
" @Nullable Foo f;", // i.e. Test.@Nullable Foo
" class Foo { }",
" public void test() {",
" // BUG: Diagnostic contains: dereferenced",
" f.hashCode();",
" }",
"}")
.doTest();
}
@Test
public void annotationAppliedToInnerTypeImplicitlyWithTypeArgs() {
defaultCompilationHelper
.addSourceLines(
"Test.java",
"package com.uber;",
"import org.checkerframework.checker.nullness.qual.Nullable;",
"class Test {",
" @Nullable Foo<String> f1 = null;", // i.e. Test.@Nullable Foo (location [INNER])
" // BUG: Diagnostic contains: assigning @Nullable expression to @NonNull field",
" Foo<@Nullable String> f2 = null;", // (location [INNER, TYPE_ARG(0)])
" @Nullable Foo<@Nullable String> f3 = null;", // two annotations, each with the
// locations above
" class Foo<T> { }",
" public void test() {",
" // BUG: Diagnostic contains: dereferenced",
" f1.hashCode();",
" // safe, because nonnull",
" f2.hashCode();",
" // BUG: Diagnostic contains: dereferenced",
" f3.hashCode();",
" }",
"}")
.doTest();
}
@Test
public void annotationAppliedToInnerTypeExplicitly() {
defaultCompilationHelper
.addSourceLines(
"Test.java",
"package com.uber;",
"import org.checkerframework.checker.nullness.qual.Nullable;",
"class Test {",
" Test.@Nullable Foo f1;",
" @Nullable Test.Foo f2;",
" class Foo { }",
" public void test() {",
" // BUG: Diagnostic contains: dereferenced",
" f1.hashCode();",
" // BUG: Diagnostic contains: dereferenced",
" f2.hashCode();",
" }",
"}")
.doTest();
}
@Test
public void annotationAppliedToInnerTypeExplicitly2() {
defaultCompilationHelper
.addSourceLines(
"Bar.java",
"package com.uber;",
"import org.checkerframework.checker.nullness.qual.Nullable;",
"class Bar {",
" public class Foo { }",
"}")
.addSourceLines(
"Test.java",
"package com.uber;",
"import org.checkerframework.checker.nullness.qual.Nullable;",
"class Test {",
" Bar.@Nullable Foo f1;",
" @Nullable Bar.Foo f2;",
" public void test() {",
" // BUG: Diagnostic contains: dereferenced",
" f1.hashCode();",
" // BUG: Diagnostic contains: dereferenced",
" f2.hashCode();",
" }",
"}")
.doTest();
}
@Test
public void annotationAppliedToInnerTypeOfTypeArgument() {
defaultCompilationHelper
.addSourceLines(
"Test.java",
"package com.uber;",
"import java.util.Set;",
"import org.checkerframework.checker.nullness.qual.Nullable;",
"class Test {",
" // BUG: Diagnostic contains: @NonNull field s not initialized",
" Set<@Nullable Foo> s;", // i.e. Set<Test.@Nullable Foo>
" class Foo { }",
" public void test() {",
" // safe because field is @NonNull",
" s.hashCode();",
" }",
"}")
.doTest();
}
@Test
public void typeUseAnnotationOnArray() {
defaultCompilationHelper
.addSourceLines(
"Test.java",
"package com.uber;",
"import org.checkerframework.checker.nullness.qual.Nullable;",
"class Test {",
" // ok only for backwards compat",
" @Nullable Object[] foo1 = null;",
" // ok according to spec",
" Object @Nullable[] foo2 = null;",
" // ok only for backwards compat",
" @Nullable Object [][] foo3 = null;",
" // ok according to spec",
" Object @Nullable [][] foo4 = null;",
" // NOT ok; @Nullable applies to first array dimension not the elements or the array ref",
" // TODO: Fix this as part of https://github.com/uber/NullAway/issues/708",
" Object [] @Nullable [] foo5 = null;",
"}")
.doTest();
}
@Test
public void typeUseAnnotationOnInnerMultiLevel() {
defaultCompilationHelper
.addSourceLines(
"Test.java",
"package com.uber;",
"import java.util.Set;",
"import org.checkerframework.checker.nullness.qual.Nullable;",
"class A { class B { class C {} } }",
"class Test {",
" // At some point, we should not treat foo1 or foo2 as @Nullable.",
" // For now we do, for ease of compatibility.",
" // TODO: Fix this as part of https://github.com/uber/NullAway/issues/708",
" @Nullable A.B.C foo1 = null;",
" A.@Nullable B.C foo2 = null;",
" A.B.@Nullable C foo3 = null;",
" // No good reason to support the case below, though!",
" // It neither matches were a correct type use annotation for marking foo4 as @Nullable would be,",
" // nor the natural position of a declaration annotation at the start of the type!",
" // BUG: Diagnostic contains: assigning @Nullable expression to @NonNull field",
" A.B.@Nullable C [][] foo4 = null;",
"}")
.doTest();
}
}
|
