-
Notifications
You must be signed in to change notification settings - Fork 742
/
AnnotationPositionTest.java
532 lines (500 loc) · 15.5 KB
/
AnnotationPositionTest.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
/*
* 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;
import static com.google.errorprone.BugCheckerRefactoringTestHelper.TestMode.TEXT_MATCH;
import static org.junit.Assume.assumeTrue;
import com.google.errorprone.BugCheckerRefactoringTestHelper;
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;
/**
* Tests for {@link AnnotationPosition} bugpattern.
*
* @author ghm@google.com (Graeme Morgan)
*/
@RunWith(JUnit4.class)
public final class AnnotationPositionTest {
private final BugCheckerRefactoringTestHelper refactoringHelper =
BugCheckerRefactoringTestHelper.newInstance(AnnotationPosition.class, getClass())
.addInputLines(
"TypeUse.java",
"import java.lang.annotation.ElementType;",
"import java.lang.annotation.Target;",
"@Target({ElementType.TYPE_USE})",
"@interface TypeUse {",
" String value() default \"\";",
"}")
.expectUnchanged()
.addInputLines(
"EitherUse.java",
"import java.lang.annotation.ElementType;",
"import java.lang.annotation.Target;",
"@Target({ElementType.TYPE_USE, ElementType.METHOD, ElementType.TYPE})",
"@interface EitherUse {",
" String value() default \"\";",
"}")
.expectUnchanged()
.addInputLines(
"NonTypeUse.java", //
"@interface NonTypeUse {}")
.expectUnchanged();
private final CompilationTestHelper helper =
CompilationTestHelper.newInstance(AnnotationPosition.class, getClass())
.addSourceLines(
"TypeUse.java",
"import java.lang.annotation.ElementType;",
"import java.lang.annotation.Target;",
"@Target({ElementType.TYPE_USE, ElementType.METHOD, ElementType.TYPE})",
"@interface TypeUse {",
" String value() default \"\";",
"}")
.addSourceLines(
"NonTypeUse.java", //
"@interface NonTypeUse {}")
.addSourceLines(
"EitherUse.java",
"import java.lang.annotation.ElementType;",
"import java.lang.annotation.Target;",
"@Target({ElementType.TYPE_USE, ElementType.METHOD, ElementType.TYPE})",
"@interface EitherUse {",
" String value() default \"\";",
"}");
@Test
public void nonTypeAnnotation() {
refactoringHelper
.addInputLines(
"Test.java", //
"interface Test {", //
" public @Override boolean equals(Object o);",
"}")
.addOutputLines(
"Test.java", //
"interface Test {",
" @Override public boolean equals(Object o);",
"}")
.doTest(TEXT_MATCH);
}
@Test
public void interspersedJavadoc() {
refactoringHelper
.addInputLines(
"Test.java",
"interface Test {",
" @NonTypeUse",
" /** Javadoc! */",
" public void foo();",
"}")
.addOutputLines(
"Test.java",
"interface Test {",
" /** Javadoc! */",
" @NonTypeUse",
" public void foo();",
"}")
.doTest(TEXT_MATCH);
}
@Test
public void interspersedJavadoc_treeAlreadyHasJavadoc_noSuggestion() {
refactoringHelper
.addInputLines(
"Test.java",
"interface Test {",
" /** Actually Javadoc. */",
" @NonTypeUse",
" /** Javadoc! */",
" public void foo();",
"}")
.expectUnchanged()
.doTest(TEXT_MATCH);
}
@Test
public void interspersedJavadoc_withComment() {
refactoringHelper
.addInputLines(
"Test.java",
"interface Test {",
" @NonTypeUse",
" /** Javadoc! */",
" // TODO: fix",
" public void foo();",
"}")
.addOutputLines(
"Test.java",
"interface Test {",
" /** Javadoc! */",
" @NonTypeUse",
" // TODO: fix",
" public void foo();",
"}")
.doTest(TEXT_MATCH);
}
@Test
public void negatives() {
refactoringHelper
.addInputLines(
"Test.java",
"interface Test {",
" /** Javadoc */",
" @NonTypeUse",
" public boolean foo();",
" @NonTypeUse",
" public boolean bar();",
" public @EitherUse boolean baz();",
" /** Javadoc */",
" @NonTypeUse",
" // comment",
" public boolean quux();",
"}")
.expectUnchanged()
.doTest(TEXT_MATCH);
}
@Test
public void negative_parameter() {
refactoringHelper
.addInputLines(
"Test.java",
"interface Test {",
" public boolean foo(final @NonTypeUse String s);",
"}")
.addOutputLines(
"Test.java",
"interface Test {",
" public boolean foo(@NonTypeUse final String s);",
"}")
.doTest(TEXT_MATCH);
}
@Test
public void typeAnnotation() {
refactoringHelper
.addInputLines(
"Test.java",
"interface Test {",
" /** Javadoc */",
" public @NonTypeUse @EitherUse String foo();",
" /** Javadoc */",
" public @EitherUse @NonTypeUse String bar();",
" public @EitherUse /** Javadoc */ @NonTypeUse String baz();",
" public @EitherUse static @NonTypeUse int quux() { return 1; }",
"}")
.addOutputLines(
"Test.java",
"interface Test {",
" /** Javadoc */",
" @NonTypeUse public @EitherUse String foo();",
" /** Javadoc */",
" @NonTypeUse public @EitherUse String bar();",
" /** Javadoc */",
" @NonTypeUse public @EitherUse String baz();",
" @NonTypeUse public static @EitherUse int quux() { return 1; }",
"}")
.doTest(TEXT_MATCH);
}
@Test
public void variables() {
refactoringHelper
.addInputLines(
"Test.java",
"interface Test {",
" public @EitherUse static /** Javadoc */ @NonTypeUse int foo = 1;",
"}")
.addOutputLines(
"Test.java",
"interface Test {",
" /** Javadoc */",
" @NonTypeUse public static @EitherUse int foo = 1;",
"}")
.doTest(TEXT_MATCH);
}
@Test
public void classes() {
refactoringHelper
.addInputLines(
"Test.java", //
"public @NonTypeUse",
"interface Test {}")
.addOutputLines(
"Test.java", //
"@NonTypeUse",
"public interface Test {}")
.doTest(TEXT_MATCH);
}
@Test
public void class_typeUseBeforeModifiers() {
refactoringHelper
.addInputLines(
"Test.java", //
"public @EitherUse interface Test {}")
.addOutputLines(
"Test.java", //
"@EitherUse",
"public interface Test {}")
.doTest(TEXT_MATCH);
}
@Test
public void class_intermingledJavadoc() {
refactoringHelper
.addInputLines(
"Test.java", //
"@NonTypeUse public /** Javadoc */ final class Test {}")
.addOutputLines(
"Test.java", //
"/** Javadoc */",
"@NonTypeUse public final class Test {}")
.doTest(TEXT_MATCH);
}
@Test
public void betweenModifiers() {
refactoringHelper
.addInputLines(
"Test.java",
"interface Test {",
" public @EitherUse static @NonTypeUse int foo() { return 1; }",
" public @EitherUse @NonTypeUse static int bar() { return 1; }",
"}")
.addOutputLines(
"Test.java",
"interface Test {",
" @NonTypeUse public static @EitherUse int foo() { return 1; }",
" @NonTypeUse public static @EitherUse int bar() { return 1; }",
"}")
.doTest(TEXT_MATCH);
}
@Test
public void betweenModifiersWithValue() {
refactoringHelper
.addInputLines(
"Test.java",
"class Test {",
" public final @EitherUse(\"foo\") int foo(final int a) { return 1; }",
"}")
.addOutputLines(
"Test.java",
"class Test {",
" public final @EitherUse(\"foo\") int foo(final int a) { return 1; }",
"}")
.doTest(TEXT_MATCH);
}
@Test
public void interspersedComments() {
refactoringHelper
.addInputLines(
"Test.java",
"interface Test {",
" public @EitherUse /** Javadoc */ @NonTypeUse String baz();",
" /* a */ public /* b */ @EitherUse /* c */ static /* d */ "
+ "@NonTypeUse /* e */ int quux() { return 1; }",
"}")
.addOutputLines(
"Test.java",
"interface Test {",
" /** Javadoc */",
" @NonTypeUse public @EitherUse String baz();",
" /* a */ @NonTypeUse public /* b */ /* c */ static @EitherUse "
+ "/* d */ /* e */ int quux() { return 1; }",
"}")
.doTest(TEXT_MATCH);
}
@Test
public void messages() {
helper
.addSourceLines(
"Test.java",
"interface Test {",
" // BUG: Diagnostic contains: @Override is not a TYPE_USE annotation",
" public @Override boolean equals(Object o);",
" // BUG: Diagnostic contains: @Override, @NonTypeUse are not TYPE_USE annotations",
" public @Override @NonTypeUse int hashCode();",
" // BUG: Diagnostic contains: Javadocs should appear before any modifiers",
" @NonTypeUse /** Javadoc */ public boolean bar();",
"}")
.doTest();
}
@Test
public void diagnostic() {
helper
.addSourceLines(
"Test.java", //
"interface Test {",
" // BUG: Diagnostic contains: is a TYPE_USE",
" public @EitherUse static int foo = 1;",
"}")
.doTest();
}
// TODO(b/168625474): 'sealed' doesn't have a TokenKind
@Test
public void sealedInterface() {
assumeTrue(RuntimeVersion.isAtLeast15());
refactoringHelper
.addInputLines(
"Test.java", //
"/** Javadoc! */",
"sealed @Deprecated interface Test {",
" final class A implements Test {}",
"}")
.addOutputLines(
"Test.java", //
"/** Javadoc! */",
"sealed @Deprecated interface Test {",
" final class A implements Test {}",
"}")
.setArgs("--enable-preview", "--release", Integer.toString(RuntimeVersion.release()))
.doTest(TEXT_MATCH);
}
@Test
public void typeArgument_annotationOfEitherUse_canRemainBefore() {
refactoringHelper
.addInputLines(
"Test.java", //
"interface T {",
" @EitherUse <T> T f();",
"}")
.addOutputLines(
"Test.java", //
"interface T {",
" @EitherUse <T> T f();",
"}")
.doTest(TEXT_MATCH);
}
@Test
public void typeArgument_typeUseAnnotation_movesAfter() {
refactoringHelper
.addInputLines(
"Test.java", //
"interface T {",
" @TypeUse <T> T f();",
"}")
.addOutputLines(
"Test.java", //
"interface T {",
" <T> @TypeUse T f();",
"}")
.doTest(TEXT_MATCH);
}
@Test
public void genericsWithBounds() {
refactoringHelper
.addInputLines(
"Test.java", //
"import java.util.List;",
"interface T {",
" @TypeUse <T extends List<T>> T f();",
"}")
.addOutputLines(
"Test.java", //
"import java.util.List;",
"interface T {",
" <T extends List<T>> @TypeUse T f();",
"}")
.doTest(TEXT_MATCH);
}
@Test
public void typeUseAndNonTypeUse_inWrongOrder() {
refactoringHelper
.addInputLines(
"Test.java", //
"interface T {",
" @TypeUse @NonTypeUse T f();",
"}")
.addOutputLines(
"Test.java", //
"interface T {",
" @NonTypeUse @TypeUse T f();",
"}")
.doTest(TEXT_MATCH);
}
@Test
public void annotationOfEitherUse_isAllowedToRemainBeforeModifiers() {
refactoringHelper
.addInputLines(
"Test.java", //
"interface T {",
" @NonTypeUse @EitherUse public T a();",
" @NonTypeUse public @EitherUse T b();",
"}")
.expectUnchanged()
.doTest(TEXT_MATCH);
}
@Test
public void constructor() {
refactoringHelper
.addInputLines(
"Test.java", //
"import javax.inject.Inject;",
"class T {",
" @Inject T(int x) {}",
" @Inject T() {",
" System.err.println();",
" }",
"}")
.expectUnchanged()
.doTest(TEXT_MATCH);
}
@Test
public void parameters_withAnnotationsOutOfOrder() {
refactoringHelper
.addInputLines(
"Test.java", //
"class T {",
" Object foo(@TypeUse @NonTypeUse Object a) {",
" return null;",
" }",
"}")
.addOutputLines(
"Test.java", //
"class T {",
" Object foo(@NonTypeUse @TypeUse Object a) {",
" return null;",
" }",
"}")
.doTest(TEXT_MATCH);
}
@Test
public void parameters_withInterspersedModifiers() {
refactoringHelper
.addInputLines(
"Test.java", //
"class T {",
" Object foo(@TypeUse final Object a) {",
" return null;",
" }",
"}")
.addOutputLines(
"Test.java", //
"class T {",
" Object foo(final @TypeUse Object a) {",
" return null;",
" }",
"}")
.doTest(TEXT_MATCH);
}
@Test
public void varKeyword() {
refactoringHelper
.addInputLines(
"Test.java",
"import com.google.errorprone.annotations.Var;",
"class T {",
" void m() {",
" @Var var x = 1;",
" x = 2;",
" }",
"}")
.expectUnchanged()
.doTest(TEXT_MATCH);
}
}