forked from google/error-prone
-
Notifications
You must be signed in to change notification settings - Fork 2
/
InvalidParamTest.java
283 lines (265 loc) · 7.79 KB
/
InvalidParamTest.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
/*
* Copyright 2018 The Error Prone 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.errorprone.bugpatterns.javadoc;
import static org.junit.Assume.assumeTrue;
import com.google.errorprone.BugCheckerRefactoringTestHelper;
import com.google.errorprone.BugCheckerRefactoringTestHelper.TestMode;
import com.google.errorprone.CompilationTestHelper;
import com.google.errorprone.util.RuntimeVersion;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
/** Unit tests for {@link InvalidParam} bug pattern. */
@RunWith(JUnit4.class)
public final class InvalidParamTest {
private final BugCheckerRefactoringTestHelper refactoring =
BugCheckerRefactoringTestHelper.newInstance(InvalidParam.class, getClass());
private final CompilationTestHelper helper =
CompilationTestHelper.newInstance(InvalidParam.class, getClass());
@Test
public void badParameterName_positioning() {
helper
.addSourceLines(
"Test.java",
"interface Test {",
" /**",
" * @param <T> baz",
" // BUG: Diagnostic contains: Parameter name `c` is unknown",
" * @param c foo",
" * @param b bar",
" */",
" <T> void foo(int a, int b);",
"}")
.doTest();
}
@Test
public void badParameterName() {
refactoring
.addInputLines(
"Test.java",
"interface Test {",
" /**",
" * @param <T> baz",
" * @param c foo",
" * @param b bar",
" */",
" <T> void foo(int a, int b);",
"}")
.addOutputLines(
"Test.java",
"interface Test {",
" /**",
" * @param <T> baz",
" * @param a foo",
" * @param b bar",
" */",
" <T> void foo(int a, int b);",
"}")
.doTest(TestMode.TEXT_MATCH);
}
@Test
public void badTypeParameterName() {
refactoring
.addInputLines(
"Test.java",
"interface Test {",
" /**",
" * @param <S> baz",
" * @param a bar",
" */",
" <T> void foo(int a);",
"}")
.addOutputLines(
"Test.java",
"interface Test {",
" /**",
" * @param <T> baz",
" * @param a bar",
" */",
" <T> void foo(int a);",
"}")
.doTest(TestMode.TEXT_MATCH);
}
@Test
public void verySimilarCodeParam() {
refactoring
.addInputLines(
"Test.java",
"interface Test {",
" /**",
" * {@code foabar}, {@code barfoo}",
" */",
" void foo(int foobar);",
"}")
.addOutputLines(
"Test.java",
"interface Test {",
" /**",
" * {@code foobar}, {@code barfoo}",
" */",
" void foo(int foobar);",
"}")
.doTest(TestMode.TEXT_MATCH);
}
@Test
public void verySimilarCodeParam_diagnosticMessage() {
helper
.addSourceLines(
"Test.java",
"interface Test {",
" /**",
" // BUG: Diagnostic contains: `foabar` is very close to the parameter `foobar`",
" * {@code foabar}, {@code barfoo}",
" */",
" void foo(int foobar);",
"}")
.doTest();
}
@Test
public void negative() {
helper
.addSourceLines(
"Test.java",
"interface Test {",
" /**",
" * Frobnicates a {@code foobarbaz}.",
" * @param <T> baz",
" * @param a bar",
" * @param b quux",
" */",
" <T> void foo(int a, int b, int foobarbaz);",
"}")
.doTest();
}
@Test
public void excludedName_noMatchDespiteSimilarParam() {
helper
.addSourceLines(
"Test.java",
"interface Test {",
" /** Returns {@code true}. */",
" boolean foo(int tree);",
"}")
.doTest();
}
@Test
public void negative_record() {
assumeTrue(RuntimeVersion.isAtLeast16());
helper
.addSourceLines(
"Test.java", //
"/**",
" * @param name Name.",
" */",
"public record Test(String name) {}")
.doTest();
}
@Test
public void badParameterName_record() {
assumeTrue(RuntimeVersion.isAtLeast16());
helper
.addSourceLines(
"Test.java",
"/**",
" // BUG: Diagnostic contains: Parameter name `bar` is unknown",
" * @param bar Foo.",
" */",
"public record Test(String foo) {}")
.doTest();
}
@Test
public void multipleConstructors_record() {
assumeTrue(RuntimeVersion.isAtLeast16());
helper
.addSourceLines(
"Test.java",
"/**",
" * @param foo Foo.",
" * @param bar Bar.",
" */",
"public record Test(String foo, Integer bar) {",
" public Test(Integer bar) {",
" this(null, bar);",
" }",
"",
" /**",
" // BUG: Diagnostic contains: Parameter name `bar` is unknown",
" * @param bar Foo.",
" */",
" public Test(String foo) {",
" this(foo, null);",
" }",
"}")
.doTest();
}
@Test
public void typeParameter_record() {
assumeTrue(RuntimeVersion.isAtLeast16());
helper
.addSourceLines(
"Negative.java",
"/**",
" * @param <T> The type parameter.",
" * @param contents Contents.",
" * @param bar Bar.",
" */",
"public record Negative<T>(T contents, String bar) {}")
.addSourceLines(
"Positive.java",
"/**",
" // BUG: Diagnostic contains: Parameter name `E` is unknown",
" * @param <E> The type parameter.",
" * @param contents Contents.",
" * @param bar Bar.",
" */",
"public record Positive<T>(T contents, String bar) {}")
.doTest();
}
@Test
public void compactConstructor_record() {
assumeTrue(RuntimeVersion.isAtLeast16());
helper
.addSourceLines(
"Test.java",
"/**",
" * @param name Name.",
" */",
"public record Test(String name) {",
" public Test {}",
"}")
.doTest();
}
@Test
public void normalConstructor_record() {
assumeTrue(RuntimeVersion.isAtLeast16());
helper
.addSourceLines(
"Test.java",
"/**",
" * @param name Name.",
" */",
"public record Test(String name) {",
" /**",
" // BUG: Diagnostic contains: Parameter name `foo` is unknown",
" * @param foo Name.",
" */",
" public Test(String name) {",
" this.name = name;",
" }",
" }")
.doTest();
}
}