-
Notifications
You must be signed in to change notification settings - Fork 727
/
UnusedMethodTest.java
499 lines (470 loc) · 14.4 KB
/
UnusedMethodTest.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
/*
* 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 com.google.errorprone.BugCheckerRefactoringTestHelper;
import com.google.errorprone.BugCheckerRefactoringTestHelper.TestMode;
import com.google.errorprone.CompilationTestHelper;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
/** Tests for {@link UnusedMethod}. */
@RunWith(JUnit4.class)
public final class UnusedMethodTest {
private final CompilationTestHelper helper =
CompilationTestHelper.newInstance(UnusedMethod.class, getClass());
private final BugCheckerRefactoringTestHelper refactoringHelper =
BugCheckerRefactoringTestHelper.newInstance(UnusedMethod.class, getClass());
@Test
public void unusedNative() {
helper
.addSourceLines(
"UnusedNative.java",
"package unusedvars;",
"public class UnusedNative {",
" private native void aNativeMethod();",
"}")
.doTest();
}
@Test
public void unusedPrivateMethod() {
helper
.addSourceLines(
"UnusedPrivateMethod.java",
"package unusedvars;",
"import com.google.errorprone.annotations.Keep;",
"import java.lang.annotation.ElementType;",
"import java.lang.annotation.Retention;",
"import java.lang.annotation.RetentionPolicy;",
"import java.lang.annotation.Target;",
"import javax.inject.Inject;",
"public class UnusedPrivateMethod {",
" public void test() {",
" used();",
" }",
" private void used() {}",
" // BUG: Diagnostic contains: Method 'notUsed' is never used.",
" private void notUsed() {}",
" @Inject",
" private void notUsedExempted() {}",
" @Keep",
" @Target(ElementType.METHOD)",
" @Retention(RetentionPolicy.SOURCE)",
" private @interface ProvidesCustom {}",
"}")
.doTest();
}
@Test
public void unuseds() {
helper
.addSourceLines(
"Unuseds.java",
"package unusedvars;",
"import java.io.IOException;",
"import java.io.ObjectStreamException;",
"import java.util.List;",
"import javax.inject.Inject;",
"public class Unuseds {",
" // BUG: Diagnostic contains:",
" private void notUsedMethod() {}",
" // BUG: Diagnostic contains:",
" private static void staticNotUsedMethod() {}",
" @SuppressWarnings({\"deprecation\", \"unused\"})",
" class UsesSuppressWarning {",
" private int f1;",
" private void test1() {",
" int local;",
" }",
" @SuppressWarnings(value = \"unused\")",
" private void test2() {",
" int local;",
" }",
" }",
"}")
.doTest();
}
@Test
public void exemptedMethods() {
helper
.addSourceLines(
"Unuseds.java",
"package unusedvars;",
"import java.io.IOException;",
"import java.io.ObjectStreamException;",
"public class Unuseds implements java.io.Serializable {",
" private void readObject(java.io.ObjectInputStream in) throws IOException {",
" in.hashCode();",
" }",
" private void writeObject(java.io.ObjectOutputStream out) throws IOException {",
" out.writeInt(123);",
" }",
" private Object readResolve() {",
" return null;",
" }",
" private void readObjectNoData() throws ObjectStreamException {}",
"}")
.doTest();
}
@Test
public void exemptedByName() {
helper
.addSourceLines(
"Unuseds.java",
"package unusedvars;",
"class ExemptedByName {",
" private void unused1(int a, int unusedParam) {",
" int unusedLocal = a;",
" }",
"}")
.doTest();
}
@Test
public void exemptedByCustomAnnotation() {
helper
.addSourceLines(
"Foo.java", //
"package example;",
"@interface Foo {}")
.addSourceLines(
"ExemptedByCustomAnnotation.java",
"package example;",
"class ExemptedByCustomAnnotation {",
" @Foo",
" private void bar() {}",
"}")
.setArgs("-XepOpt:UnusedMethod:ExemptingMethodAnnotations=example.Foo")
.doTest();
}
@Test
public void suppressions() {
helper
.addSourceLines(
"Unuseds.java",
"package unusedvars;",
"class Suppressed {",
" @SuppressWarnings({\"deprecation\", \"unused\"})",
" class UsesSuppressWarning {",
" private void test1() {",
" int local;",
" }",
" @SuppressWarnings(value = \"unused\")",
" private void test2() {",
" int local;",
" }",
" }",
"}")
.doTest();
}
@Test
public void removal_javadocsAndNonJavadocs() {
refactoringHelper
.addInputLines(
"UnusedWithComment.java",
"package unusedvars;",
"public class UnusedWithComment {",
" /**",
" * Method comment",
" */private void test1() {",
" }",
" /** Method comment */",
" private void test2() {",
" }",
" // Non javadoc comment",
" private void test3() {",
" }",
"}")
.addOutputLines(
"UnusedWithComment.java", //
"package unusedvars;",
"public class UnusedWithComment {",
"}")
.doTest(TestMode.TEXT_MATCH);
}
@Test
public void usedInLambda() {
helper
.addSourceLines(
"UsedInLambda.java",
"package unusedvars;",
"import java.util.Arrays;",
"import java.util.List;",
"import java.util.function.Function;",
"import java.util.stream.Collectors;",
"/** Method parameters used in lambdas and anonymous classes */",
"public class UsedInLambda {",
" private Function<Integer, Integer> usedInLambda() {",
" return x -> 1;",
" }",
" private String print(Object o) {",
" return o.toString();",
" }",
" public List<String> print(List<Object> os) {",
" return os.stream().map(this::print).collect(Collectors.toList());",
" }",
" public static void main(String[] args) {",
" System.err.println(new UsedInLambda().usedInLambda());",
" System.err.println(new UsedInLambda().print(Arrays.asList(1, 2, 3)));",
" }",
"}")
.doTest();
}
@Test
public void onlyForMethodReference() {
helper
.addSourceLines(
"Test.java",
"import java.util.function.Predicate;",
"class Test {",
" private static boolean foo(int a) {",
" return true;",
" }",
" Predicate<Integer> pred = Test::foo;",
"}")
.doTest();
}
@Test
public void methodSource() {
helper
.addSourceLines(
"MethodSource.java",
"package org.junit.jupiter.params.provider;",
"public @interface MethodSource {",
" String[] value();",
"}")
.addSourceLines(
"Test.java",
"import java.util.stream.Stream;",
"import org.junit.jupiter.params.provider.MethodSource;",
"class Test {",
" @MethodSource(\"parameters\")",
" void test() {}",
"",
" private static Stream<String> parameters() {",
" return Stream.of();",
" }",
"}")
.doTest();
}
@Test
public void qualifiedMethodSource() {
helper
.addSourceLines(
"MethodSource.java",
"package org.junit.jupiter.params.provider;",
"public @interface MethodSource {",
" String[] value();",
"}")
.addSourceLines(
"Test.java",
"import java.util.stream.Stream;",
"import org.junit.jupiter.params.provider.MethodSource;",
"class Test {",
" @MethodSource(\"Test#parameters\")",
" void test() {}",
"",
"",
" private static Stream<String> parameters() {",
" return Stream.of();",
" }",
"}")
.doTest();
}
@Test
public void nestedQualifiedMethodSource() {
helper
.addSourceLines(
"MethodSource.java",
"package org.junit.jupiter.params.provider;",
"public @interface MethodSource {",
" String[] value();",
"}")
.addSourceLines(
"Test.java",
"import java.util.stream.Stream;",
"import org.junit.jupiter.params.provider.MethodSource;",
"class Test {",
" // @Nested",
" public class NestedTest {",
" @MethodSource(\"Test#parameters\")",
" void test() {}",
" }",
"",
" private static Stream<String> parameters() {",
" return Stream.of();",
" }",
"}")
.doTest();
}
@Test
public void overriddenMethodNotCalledWithinClass() {
helper
.addSourceLines(
"Test.java",
"class Test {",
" private class Inner {",
" @Override public String toString() { return null; }",
" }",
"}")
.doTest();
}
@Test
public void methodWithinPrivateInnerClass_isEligible() {
helper
.addSourceLines(
"Test.java",
"class Test {",
" private class Inner {",
" // BUG: Diagnostic contains:",
" public void foo() {}",
" }",
"}")
.doTest();
}
@Test
public void unusedConstructor() {
helper
.addSourceLines(
"Test.java", //
"class Test {",
" // BUG: Diagnostic contains: Constructor 'Test'",
" private Test(int a) {}",
"}")
.doTest();
}
@Test
public void unusedConstructor_refactoredToPrivateNoArgVersion() {
refactoringHelper
.addInputLines(
"Test.java", //
"class Test {",
" private Test(int a) {}",
"}")
.addOutputLines(
"Test.java", //
"class Test {",
" private Test() {}",
"}")
.doTest();
}
@Test
public void unusedConstructor_finalFieldsLeftDangling_noFix() {
refactoringHelper
.addInputLines(
"Test.java", //
"class Test {",
" private final int a;",
" private Test(int a) {",
" this.a = a;",
" }",
"}")
.expectUnchanged()
.doTest();
}
@Test
public void unusedConstructor_nonFinalFields_stillRefactored() {
refactoringHelper
.addInputLines(
"Test.java", //
"class Test {",
" private int a;",
" private Test(int a) {}",
"}")
.addOutputLines(
"Test.java", //
"class Test {",
" private int a;",
" private Test() {}",
"}")
.doTest();
}
@Test
public void unusedConstructor_removed() {
refactoringHelper
.addInputLines(
"Test.java", //
"class Test {",
" private Test(int a) {}",
" private Test(String a) {}",
" public Test of() { return new Test(1); }",
"}")
.addOutputLines(
"Test.java", //
"class Test {",
" private Test(int a) {}",
" public Test of() { return new Test(1); }",
"}")
.doTest();
}
@Test
public void privateConstructor_calledWithinClass() {
helper
.addSourceLines(
"Test.java", //
"class Test {",
" private Test(int a) {}",
" public Test of(int a) {",
" return new Test(a);",
" }",
"}")
.doTest();
}
@Test
public void zeroArgConstructor_notFlagged() {
helper
.addSourceLines(
"Test.java", //
"class Test {",
" private Test() {}",
"}")
.doTest();
}
@Test
public void annotationProperty_assignedByname() {
helper
.addSourceLines(
"Test.java",
"class Test {",
" private @interface Anno {",
" int value() default 1;",
" }",
" @Anno(value = 1) int b;",
"}")
.doTest();
}
@Test
public void annotationProperty_assignedAsDefault() {
helper
.addSourceLines(
"Test.java",
"class Test {",
" private @interface Anno {",
" int value();",
" }",
" @Anno(1) int a;",
"}")
.doTest();
}
@Test
public void effectivelyPrivateMethodMadeVisible() {
helper
.addSourceLines(
"Test.java",
"class Test {",
" private class A {",
" public void foo() {}",
" }",
" public class B extends A {}",
"}")
.doTest();
}
}