/
BaseCheckTestSupport.java
411 lines (371 loc) · 17.5 KB
/
BaseCheckTestSupport.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
////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2017 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;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.LineNumberReader;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.text.MessageFormat;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.ResourceBundle;
import java.util.stream.Collectors;
import com.google.common.collect.MapDifference;
import com.google.common.collect.MapDifference.ValueDifference;
import com.google.common.collect.Maps;
import com.puppycrawl.tools.checkstyle.api.Configuration;
import com.puppycrawl.tools.checkstyle.api.LocalizedMessage;
public class BaseCheckTestSupport {
protected final ByteArrayOutputStream stream = new ByteArrayOutputStream();
protected static DefaultConfiguration createCheckConfig(Class<?> clazz) {
return new DefaultConfiguration(clazz.getName());
}
/**
* Creates {@link Checker} instance based on the given {@link Configuration} instance.
* @param checkConfig {@link Configuration} instance.
* @return {@link Checker} instance based on the given {@link Configuration} instance.
* @throws Exception if an exception occurs during checker configuration.
*/
public Checker createChecker(Configuration checkConfig)
throws Exception {
final DefaultConfiguration dc = createCheckerConfig(checkConfig);
final Checker checker = new Checker();
checker.setModuleClassLoader(Thread.currentThread().getContextClassLoader());
checker.configure(dc);
checker.addListener(new BriefUtLogger(stream));
return checker;
}
/**
* Creates {@link DefaultConfiguration} for the {@link Checker}
* based on the given {@link Configuration} instance.
* @param config {@link Configuration} instance.
* @return {@link DefaultConfiguration} for the {@link Checker}
* based on the given {@link Configuration} instance.
*/
protected DefaultConfiguration createCheckerConfig(Configuration config) {
final DefaultConfiguration dc =
new DefaultConfiguration("configuration");
final DefaultConfiguration twConf = createCheckConfig(TreeWalker.class);
// make sure that the tests always run with this charset
dc.addAttribute("charset", "UTF-8");
dc.addChild(twConf);
twConf.addChild(config);
return dc;
}
/**
* Returns canonical path for the file with the given file name.
* The path is formed base on the root location.
* This implementation uses 'src/test/resources/com/puppycrawl/tools/checkstyle/'
* as a root location.
* @param filename file name.
* @return canonical path for the file name.
* @throws IOException if I/O exception occurs while forming the path.
*/
protected String getPath(String filename) throws IOException {
return new File("src/test/resources/com/puppycrawl/tools/checkstyle/" + filename)
.getCanonicalPath();
}
/**
* Returns URI-representation of the path for the given file name.
* The path is formed base on the root location.
* This implementation uses 'src/test/resources/com/puppycrawl/tools/checkstyle/'
* as a root location.
* @param filename file name.
* @return URI-representation of the path for the file with the given file name.
*/
protected String getUriString(String filename) {
return new File("src/test/resources/com/puppycrawl/tools/checkstyle/" + filename).toURI()
.toString();
}
/**
* Returns canonical path for the file with the given file name.
* The path is formed base on the sources location.
* This implementation uses 'src/test/java/com/puppycrawl/tools/checkstyle/'
* as a src location.
* @param filename file name.
* @return canonical path for the file with the given file name.
* @throws IOException if I/O exception occurs while forming the path.
*/
protected static String getSrcPath(String filename) throws IOException {
return new File("src/test/java/com/puppycrawl/tools/checkstyle/" + filename)
.getCanonicalPath();
}
/**
* Returns canonical path for the file with the given file name.
* The path is formed base on the non-compilable resources location.
* This implementation uses 'src/test/resources-noncompilable/com/puppycrawl/tools/checkstyle/'
* as a non-compilable resource location.
* @param filename file name.
* @return canonical path for the file with the given file name.
* @throws IOException if I/O exception occurs while forming the path.
*/
protected String getNonCompilablePath(String filename) throws IOException {
return new File("src/test/resources-noncompilable/com/puppycrawl/tools/checkstyle/"
+ filename).getCanonicalPath();
}
/**
* Performs verification of the given text ast tree representation.
* This implementation uses {@link BaseCheckTestSupport#verifyAst(String, String, boolean)}
* method inside.
* @param expectedTextPrintFileName expected text ast tree representation.
* @param actualJavaFileName actual text ast tree representation.
* @throws Exception if exception occurs during verification.
*/
protected static void verifyAst(String expectedTextPrintFileName, String actualJavaFileName)
throws Exception {
verifyAst(expectedTextPrintFileName, actualJavaFileName, false);
}
/**
* Performs verification of the given text ast tree representation.
* @param expectedTextPrintFileName expected text ast tree representation.
* @param actualJavaFileName actual text ast tree representation.
* @param withComments whether to perform verification of comment nodes in tree.
* @throws Exception if exception occurs during verification.
*/
protected static void verifyAst(String expectedTextPrintFileName, String actualJavaFileName,
boolean withComments) throws Exception {
final String expectedContents = new String(Files.readAllBytes(
Paths.get(expectedTextPrintFileName)), StandardCharsets.UTF_8)
.replaceAll("\\\\r\\\\n", "\\\\n");
final String actualContents = AstTreeStringPrinter.printFileAst(
new File(actualJavaFileName), withComments).replaceAll("\\\\r\\\\n", "\\\\n");
assertEquals("Generated AST from Java file should match pre-defined AST", expectedContents,
actualContents);
}
/**
* Performs verification of the file with the given file name. Uses specified configuration.
* Expected messages are represented by the array of strings.
* This implementation uses overloaded
* {@link BaseCheckTestSupport#verify(Checker, File[], String, String...)} method inside.
* @param aConfig configuration.
* @param fileName file name to verify.
* @param expected an array of expected messages.
* @throws Exception if exception occurs during verification process.
*/
protected void verify(Configuration aConfig, String fileName, String... expected)
throws Exception {
verify(createChecker(aConfig), fileName, fileName, expected);
}
/**
* Performs verification of the file with the given file name.
* Uses provided {@link Checker} instance.
* Expected messages are represented by the array of strings.
* This implementation uses overloaded
* {@link BaseCheckTestSupport#verify(Checker, String, String, String...)} method inside.
* @param checker {@link Checker} instance.
* @param fileName file name to verify.
* @param expected an array of expected messages.
* @throws Exception if exception occurs during verification process.
*/
protected void verify(Checker checker, String fileName, String... expected)
throws Exception {
verify(checker, fileName, fileName, expected);
}
/**
* Performs verification of the file with the given file name.
* Uses provided {@link Checker} instance.
* Expected messages are represented by the array of strings.
* This implementation uses overloaded
* {@link BaseCheckTestSupport#verify(Checker, File[], String, String...)} method inside.
* @param checker {@link Checker} instance.
* @param processedFilename file name to verify.
* @param messageFileName message file name.
* @param expected an array of expected messages.
* @throws Exception if exception occurs during verification process.
*/
protected void verify(Checker checker,
String processedFilename,
String messageFileName,
String... expected)
throws Exception {
verify(checker,
new File[] {new File(processedFilename)},
messageFileName, expected);
}
/**
* We keep two verify methods with separate logic only for convenience of debuging
* We have minimum amount of multi-file test cases
*/
protected void verify(Checker checker,
File[] processedFiles,
String messageFileName,
String... expected)
throws Exception {
stream.flush();
final List<File> theFiles = new ArrayList<>();
Collections.addAll(theFiles, processedFiles);
final int errs = checker.process(theFiles);
// process each of the lines
final ByteArrayInputStream inputStream =
new ByteArrayInputStream(stream.toByteArray());
try (LineNumberReader lnr = new LineNumberReader(
new InputStreamReader(inputStream, StandardCharsets.UTF_8))) {
final List<String> actuals = lnr.lines().limit(expected.length)
.sorted().collect(Collectors.toList());
Arrays.sort(expected);
for (int i = 0; i < expected.length; i++) {
final String expectedResult = messageFileName + ":" + expected[i];
assertEquals("error message " + i, expectedResult, actuals.get(i));
}
assertEquals("unexpected output: " + lnr.readLine(),
expected.length, errs);
}
checker.destroy();
}
/**
* Performs verification of the given files.
* @param checker {@link Checker} instance
* @param processedFiles files to process.
* @param expectedViolations a map of expected violations per files.
* @throws Exception if exception occurs during verification process.
*/
protected void verify(Checker checker,
File[] processedFiles,
Map<String, List<String>> expectedViolations)
throws Exception {
stream.flush();
final List<File> theFiles = new ArrayList<>();
Collections.addAll(theFiles, processedFiles);
final int errs = checker.process(theFiles);
// process each of the lines
final Map<String, List<String>> actualViolations = getActualViolations(errs);
final Map<String, List<String>> realExpectedViolations =
Maps.filterValues(expectedViolations, input -> !input.isEmpty());
final MapDifference<String, List<String>> violationDifferences =
Maps.difference(realExpectedViolations, actualViolations);
final Map<String, List<String>> missingViolations =
violationDifferences.entriesOnlyOnLeft();
final Map<String, List<String>> unexpectedViolations =
violationDifferences.entriesOnlyOnRight();
final Map<String, ValueDifference<List<String>>> differingViolations =
violationDifferences.entriesDiffering();
final StringBuilder message = new StringBuilder();
if (!missingViolations.isEmpty()) {
message.append("missing violations: ").append(missingViolations);
}
if (!unexpectedViolations.isEmpty()) {
if (message.length() > 0) {
message.append('\n');
}
message.append("unexpected violations: ").append(unexpectedViolations);
}
if (!differingViolations.isEmpty()) {
if (message.length() > 0) {
message.append('\n');
}
message.append("differing violations: ").append(differingViolations);
}
assertTrue(message.toString(),
missingViolations.isEmpty()
&& unexpectedViolations.isEmpty()
&& differingViolations.isEmpty());
checker.destroy();
}
private Map<String, List<String>> getActualViolations(int errorCount) throws IOException {
// process each of the lines
final ByteArrayInputStream inputStream =
new ByteArrayInputStream(stream.toByteArray());
try (LineNumberReader lnr = new LineNumberReader(
new InputStreamReader(inputStream, StandardCharsets.UTF_8))) {
final Map<String, List<String>> actualViolations = new HashMap<>();
for (String line = lnr.readLine(); line != null && lnr.getLineNumber() <= errorCount;
line = lnr.readLine()) {
// have at least 2 characters before the splitting colon,
// to not split after the drive letter on windows
final String[] actualViolation = line.split("(?<=.{2}):", 2);
final String actualViolationFileName = actualViolation[0];
final String actualViolationMessage = actualViolation[1];
List<String> actualViolationsPerFile =
actualViolations.get(actualViolationFileName);
if (actualViolationsPerFile == null) {
actualViolationsPerFile = new ArrayList<>();
actualViolations.put(actualViolationFileName, actualViolationsPerFile);
}
actualViolationsPerFile.add(actualViolationMessage);
}
return actualViolations;
}
}
/**
* Gets the check message 'as is' from appropriate 'messages.properties'
* file.
*
* @param messageKey the key of message in 'messages.properties' file.
* @param arguments the arguments of message in 'messages.properties' file.
*/
protected String getCheckMessage(String messageKey, Object... arguments) {
return internalGetCheckMessage(getMessageBundle(), messageKey, arguments);
}
/**
* Gets the check message 'as is' from appropriate 'messages.properties'
* file.
*
* @param clazz the related check class.
* @param messageKey the key of message in 'messages.properties' file.
* @param arguments the arguments of message in 'messages.properties' file.
*/
protected String getCheckMessage(
Class<?> clazz, String messageKey, Object... arguments) {
return internalGetCheckMessage(getMessageBundle(clazz.getName()), messageKey, arguments);
}
/**
* Gets the check message 'as is' from appropriate 'messages.properties'
* file.
*
* @param messageBundle the bundle name.
* @param messageKey the key of message in 'messages.properties' file.
* @param arguments the arguments of message in 'messages.properties' file.
*/
protected String internalGetCheckMessage(
String messageBundle, String messageKey, Object... arguments) {
final ResourceBundle resourceBundle = ResourceBundle.getBundle(
messageBundle,
Locale.getDefault(),
Thread.currentThread().getContextClassLoader(),
new LocalizedMessage.Utf8Control());
final String pattern = resourceBundle.getString(messageKey);
final MessageFormat formatter = new MessageFormat(pattern, Locale.ROOT);
return formatter.format(arguments);
}
private String getMessageBundle() {
final String className = getClass().getName();
return getMessageBundle(className);
}
private static String getMessageBundle(String className) {
final int endIndex = className.lastIndexOf('.');
final String messages = "messages";
if (endIndex < 0) {
return messages;
}
final String packageName = className.substring(0, endIndex);
return packageName + "." + messages;
}
}