-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
/
ModuleReflectionUtilTest.java
415 lines (334 loc) · 13.9 KB
/
ModuleReflectionUtilTest.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
///////////////////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code and other text files for adherence to a set of rules.
// Copyright (C) 2001-2022 the original author or authors.
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
///////////////////////////////////////////////////////////////////////////////////////////////
package com.puppycrawl.tools.checkstyle.utils;
import static com.google.common.truth.Truth.assertWithMessage;
import static com.puppycrawl.tools.checkstyle.internal.utils.TestUtil.isUtilsClassHasPrivateConstructor;
import java.io.File;
import java.util.List;
import org.junit.jupiter.api.Test;
import com.puppycrawl.tools.checkstyle.DefaultLogger;
import com.puppycrawl.tools.checkstyle.TreeWalkerAuditEvent;
import com.puppycrawl.tools.checkstyle.TreeWalkerFilter;
import com.puppycrawl.tools.checkstyle.XpathFileGeneratorAstFilter;
import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
import com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck;
import com.puppycrawl.tools.checkstyle.api.AuditEvent;
import com.puppycrawl.tools.checkstyle.api.AuditListener;
import com.puppycrawl.tools.checkstyle.api.AutomaticBean;
import com.puppycrawl.tools.checkstyle.api.BeforeExecutionFileFilter;
import com.puppycrawl.tools.checkstyle.api.FileText;
import com.puppycrawl.tools.checkstyle.api.Filter;
import com.puppycrawl.tools.checkstyle.api.RootModule;
public class ModuleReflectionUtilTest {
@Test
public void testIsProperUtilsClass() throws ReflectiveOperationException {
assertWithMessage("Constructor is not private")
.that(isUtilsClassHasPrivateConstructor(ModuleReflectionUtil.class))
.isTrue();
}
@Test
public void testIsCheckstyleModule() {
assertWithMessage("Should return true when checkstyle module is passed")
.that(ModuleReflectionUtil.isCheckstyleModule(CheckClass.class))
.isTrue();
assertWithMessage("Should return true when checkstyle module is passed")
.that(ModuleReflectionUtil.isCheckstyleModule(FileSetModuleClass.class))
.isTrue();
assertWithMessage("Should return true when checkstyle module is passed")
.that(ModuleReflectionUtil.isCheckstyleModule(FilterClass.class))
.isTrue();
assertWithMessage("Should return true when checkstyle module is passed")
.that(ModuleReflectionUtil.isCheckstyleModule(TreeWalkerFilterClass.class))
.isTrue();
assertWithMessage("Should return true when checkstyle module is passed")
.that(ModuleReflectionUtil.isCheckstyleModule(FileFilterModuleClass.class))
.isTrue();
assertWithMessage("Should return true when checkstyle module is passed")
.that(ModuleReflectionUtil.isCheckstyleModule(AuditListenerClass.class))
.isTrue();
assertWithMessage("Should return true when checkstyle module is passed")
.that(ModuleReflectionUtil.isCheckstyleModule(RootModuleClass.class))
.isTrue();
}
@Test
public void testIsValidCheckstyleClass() {
assertWithMessage("Should return true when valid checkstyle class is passed")
.that(ModuleReflectionUtil.isValidCheckstyleClass(ValidCheckstyleClass.class))
.isTrue();
assertWithMessage("Should return false when invalid class is passed")
.that(
ModuleReflectionUtil.isValidCheckstyleClass(InvalidNonAutomaticBeanClass.class))
.isFalse();
assertWithMessage("Should return false when invalid class is passed")
.that(ModuleReflectionUtil.isValidCheckstyleClass(AbstractInvalidClass.class))
.isFalse();
assertWithMessage("Should return false when invalid class is passed")
.that(ModuleReflectionUtil
.isValidCheckstyleClass(InvalidNonDefaultConstructorClass.class))
.isFalse();
assertWithMessage("Should return false when forced invalid class is passed")
.that(
ModuleReflectionUtil.isValidCheckstyleClass(XpathFileGeneratorAstFilter.class))
.isFalse();
}
@Test
public void testIsCheckstyleCheck() {
assertWithMessage("Should return true when valid checkstyle check is passed")
.that(ModuleReflectionUtil.isCheckstyleTreeWalkerCheck(CheckClass.class))
.isTrue();
assertWithMessage("Should return false when invalid class is passed")
.that(ModuleReflectionUtil.isCheckstyleTreeWalkerCheck(NotCheckstyleCheck.class))
.isFalse();
}
@Test
public void testIsFileSetModule() {
assertWithMessage("Should return true when valid checkstyle file set module is passed")
.that(ModuleReflectionUtil.isFileSetModule(FileSetModuleClass.class))
.isTrue();
assertWithMessage("Should return false when invalid class is passed")
.that(ModuleReflectionUtil.isFileSetModule(NotCheckstyleCheck.class))
.isFalse();
}
@Test
public void testIsFilterModule() {
assertWithMessage("Should return true when valid checkstyle filter module is passed")
.that(ModuleReflectionUtil.isFilterModule(FilterClass.class))
.isTrue();
assertWithMessage("Should return false when invalid class is passed")
.that(ModuleReflectionUtil.isFilterModule(NotCheckstyleCheck.class))
.isFalse();
}
@Test
public void testIsFileFilterModule() {
assertWithMessage("Should return true when valid checkstyle file filter module is passed")
.that(ModuleReflectionUtil.isFileFilterModule(FileFilterModuleClass.class))
.isTrue();
assertWithMessage("Should return false when invalid class is passed")
.that(ModuleReflectionUtil.isFileFilterModule(NotCheckstyleCheck.class))
.isFalse();
}
@Test
public void testIsTreeWalkerFilterModule() {
assertWithMessage(
"Should return true when valid checkstyle TreeWalker filter module is passed")
.that(ModuleReflectionUtil.isTreeWalkerFilterModule(TreeWalkerFilterClass.class))
.isTrue();
assertWithMessage("Should return false when invalid class is passed")
.that(ModuleReflectionUtil.isTreeWalkerFilterModule(NotCheckstyleCheck.class))
.isFalse();
}
@Test
public void testIsAuditListener() {
assertWithMessage("Should return true when valid checkstyle AuditListener module is passed")
.that(ModuleReflectionUtil.isAuditListener(DefaultLogger.class))
.isTrue();
assertWithMessage("Should return false when invalid class is passed")
.that(ModuleReflectionUtil.isAuditListener(NotCheckstyleCheck.class))
.isFalse();
}
@Test
public void testIsRootModule() {
assertWithMessage("Should return true when valid checkstyle root module is passed")
.that(ModuleReflectionUtil.isRootModule(RootModuleClass.class))
.isTrue();
assertWithMessage("Should return false when invalid class is passed")
.that(ModuleReflectionUtil.isRootModule(NotCheckstyleCheck.class))
.isFalse();
}
@Test
public void testKeepEclipseHappy() {
final InvalidNonDefaultConstructorClass test = new InvalidNonDefaultConstructorClass(0);
assertWithMessage("should use constructor")
.that(test)
.isNotNull();
assertWithMessage("should use field")
.that(test.getField())
.isEqualTo(1);
}
@Test
public void testIdentification() {
assertWithMessage("Should return false when invalid class is passed by default")
.that(ModuleReflectionUtil
.isCheckstyleModule(InvalidWithDefaultConstructorClass.class))
.isFalse();
ModuleReflectionUtil.addNewModuleIdentification(
clazz -> clazz == InvalidWithDefaultConstructorClass.class);
assertWithMessage("Should return true with a new identification")
.that(ModuleReflectionUtil
.isCheckstyleModule(InvalidWithDefaultConstructorClass.class))
.isTrue();
ModuleReflectionUtil.resetIdentification();
assertWithMessage("Should return false when identification is reset")
.that(ModuleReflectionUtil
.isCheckstyleModule(InvalidWithDefaultConstructorClass.class))
.isFalse();
}
private static class ValidCheckstyleClass extends AutomaticBean {
// empty, use default constructor
@Override
protected void finishLocalSetup() {
// dummy method
}
}
private static class InvalidNonAutomaticBeanClass {
// empty, use default constructor
}
/**
* AbstractInvalidClass.
*
* @noinspection AbstractClassNeverImplemented
* @noinspectionreason AbstractClassNeverImplemented - class is only used in testing
*/
private abstract static class AbstractInvalidClass extends AutomaticBean {
public abstract void method();
}
private static class CheckClass extends AbstractCheck {
@Override
public int[] getDefaultTokens() {
return new int[] {0};
}
@Override
public int[] getAcceptableTokens() {
return getDefaultTokens();
}
@Override
public int[] getRequiredTokens() {
return getDefaultTokens();
}
}
private static class FileSetModuleClass extends AbstractFileSetCheck {
@Override
protected void processFiltered(File file, FileText fileText) {
// dummy method
}
}
private static class FilterClass extends AutomaticBean implements Filter {
@Override
protected void finishLocalSetup() {
// dummy method
}
@Override
public boolean accept(AuditEvent event) {
return false;
}
}
private static class FileFilterModuleClass extends AutomaticBean
implements BeforeExecutionFileFilter {
@Override
protected void finishLocalSetup() {
// dummy method
}
@Override
public boolean accept(String uri) {
return false;
}
}
private static class RootModuleClass extends AutomaticBean implements RootModule {
@Override
protected void finishLocalSetup() {
// dummy method
}
@Override
public void addListener(AuditListener listener) {
// dummy method
}
@Override
public int process(List<File> files) {
return 0;
}
@Override
public void destroy() {
// dummy method
}
@Override
public void setModuleClassLoader(ClassLoader moduleClassLoader) {
// dummy method
}
}
private static class TreeWalkerFilterClass extends AutomaticBean implements TreeWalkerFilter {
@Override
protected void finishLocalSetup() {
// dummy method
}
@Override
public boolean accept(TreeWalkerAuditEvent treeWalkerAuditEvent) {
return false;
}
}
private static class AuditListenerClass extends AutomaticBean implements AuditListener {
@Override
protected void finishLocalSetup() {
// dummy method
}
@Override
public void auditStarted(AuditEvent event) {
// dummy method
}
@Override
public void auditFinished(AuditEvent event) {
// dummy method
}
@Override
public void fileStarted(AuditEvent event) {
// dummy method
}
@Override
public void fileFinished(AuditEvent event) {
// dummy method
}
@Override
public void addError(AuditEvent event) {
// dummy method
}
@Override
public void addException(AuditEvent event, Throwable throwable) {
// dummy method
}
}
private static class NotCheckstyleCheck {
// empty, use default constructor
}
private static class InvalidNonDefaultConstructorClass extends AutomaticBean {
private int field;
protected InvalidNonDefaultConstructorClass(int data) {
// keep pmd calm and happy
field = 0;
method(data);
}
public final void method(int data) {
field++;
if (data > 0) {
method(data - 1);
}
}
public int getField() {
return field;
}
@Override
protected void finishLocalSetup() {
// dummy method
}
}
private static class InvalidWithDefaultConstructorClass extends AutomaticBean {
@Override
protected void finishLocalSetup() {
// dummy method
}
}
}