Skip to content

Commit

Permalink
Issue checkstyle#11091: Fail test execution when input file hasn't sp…
Browse files Browse the repository at this point in the history 
…ecified violation messages
  • Loading branch information
@Vyom-Yadav
Vyom-Yadav committed Dec 30, 2021
1 parent 84eb861 commit 594d490
Show file tree
Hide file tree
Showing 2 changed files with 99 additions and 16 deletions.
111 changes: 95 additions & 16 deletions src/test/java/com/puppycrawl/tools/checkstyle/bdd/InlineConfigParser.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,11 @@
import java.io.File;
import java.io.IOException;
import java.io.StringReader;
import java.lang.reflect.Modifier;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Locale;
Expand Down Expand Up @@ -106,16 +108,21 @@ private static TestInputConfiguration parse(String inputFilePath,
boolean setFilteredViolations) throws Exception {
final TestInputConfiguration.Builder testInputConfigBuilder =
new TestInputConfiguration.Builder();
final Path filePath = Paths.get(inputFilePath);
final List<String> lines = readFile(filePath);
try {
final Path filePath = Paths.get(inputFilePath);
final List<String> lines = readFile(filePath);
setModules(testInputConfigBuilder, inputFilePath, lines);
setViolations(testInputConfigBuilder, lines, setFilteredViolations);
}
catch (Exception ex) {
throw new CheckstyleException("Config comment not specified properly in "
+ inputFilePath, ex);
}
try {
setViolations(testInputConfigBuilder, lines, setFilteredViolations);
}
catch (CheckstyleException e) {
throw new CheckstyleException(e.getMessage() + " in " + inputFilePath, e);
}
return testInputConfigBuilder.build();
}

Expand Down Expand Up @@ -263,7 +270,8 @@ else if (value.startsWith("(default)")) {
}

private static void setViolations(TestInputConfiguration.Builder inputConfigBuilder,
List<String> lines, boolean useFilteredViolations) {
List<String> lines, boolean useFilteredViolations)
throws ClassNotFoundException, CheckstyleException {
for (int lineNo = 0; lineNo < lines.size(); lineNo++) {
setViolations(inputConfigBuilder, lines, useFilteredViolations, lineNo);
}
Expand All @@ -280,7 +288,11 @@ private static void setViolations(TestInputConfiguration.Builder inputConfigBuil
*/
private static void setViolations(TestInputConfiguration.Builder inputConfigBuilder,
List<String> lines, boolean useFilteredViolations,
int lineNo) {
int lineNo)
throws ClassNotFoundException, CheckstyleException {
List<ModuleInputConfiguration> moduleLists = inputConfigBuilder.getChildrenModules();
final boolean specifyViolationMessage = (moduleLists.size() == 1)
&& getNumberOfMessages(moduleLists.get(0).getModuleName()) > 1;
final Matcher violationMatcher =
VIOLATION_PATTERN.matcher(lines.get(lineNo));
final Matcher violationAboveMatcher =
Expand All @@ -298,23 +310,39 @@ private static void setViolations(TestInputConfiguration.Builder inputConfigBuil
final Matcher violationSomeLinesBelowMatcher =
VIOLATION_SOME_LINES_BELOW_PATTERN.matcher(lines.get(lineNo));
if (violationMatcher.matches()) {
inputConfigBuilder.addViolation(lineNo + 1, violationMatcher.group(1));
final String violationMessage = violationMatcher.group(1);
final int violationLineNum = lineNo + 1;
checkWhetherViolationSpecified(specifyViolationMessage, violationMessage,
violationLineNum);
inputConfigBuilder.addViolation(violationLineNum, violationMessage);
}
else if (violationAboveMatcher.matches()) {
inputConfigBuilder.addViolation(lineNo, violationAboveMatcher.group(1));
final String violationMessage = violationAboveMatcher.group(1);
checkWhetherViolationSpecified(specifyViolationMessage, violationMessage, lineNo);
inputConfigBuilder.addViolation(lineNo, violationMessage);
}
else if (violationBelowMatcher.matches()) {
inputConfigBuilder.addViolation(lineNo + 2, violationBelowMatcher.group(1));
final String violationMessage = violationBelowMatcher.group(1);
final int violationLineNum = lineNo + 2;
checkWhetherViolationSpecified(specifyViolationMessage, violationMessage,
violationLineNum);
inputConfigBuilder.addViolation(violationLineNum, violationMessage);
}
else if (violationSomeLinesAboveMatcher.matches()) {
final String violationMessage = violationSomeLinesAboveMatcher.group(2);
final int linesAbove = Integer.parseInt(violationSomeLinesAboveMatcher.group(1)) - 1;
inputConfigBuilder.addViolation(lineNo - linesAbove,
violationSomeLinesAboveMatcher.group(2));
final int violationLineNum = lineNo - linesAbove;
checkWhetherViolationSpecified(specifyViolationMessage, violationMessage,
violationLineNum);
inputConfigBuilder.addViolation(violationLineNum, violationMessage);
}
else if (violationSomeLinesBelowMatcher.matches()) {
final String violationMessage = violationSomeLinesBelowMatcher.group(2);
final int linesBelow = Integer.parseInt(violationSomeLinesBelowMatcher.group(1)) + 1;
inputConfigBuilder.addViolation(lineNo + linesBelow,
violationSomeLinesBelowMatcher.group(2));
final int violationLineNum = lineNo + linesBelow;
checkWhetherViolationSpecified(specifyViolationMessage, violationMessage,
violationLineNum);
inputConfigBuilder.addViolation(violationLineNum, violationMessage);
}
else if (multipleViolationsMatcher.matches()) {
Collections
Expand Down Expand Up @@ -344,21 +372,72 @@ else if (useFilteredViolations) {
}

private static void setFilteredViolation(TestInputConfiguration.Builder inputConfigBuilder,
int lineNo, String line) {
int lineNo, String line)
throws ClassNotFoundException, CheckstyleException {
List<ModuleInputConfiguration> moduleLists = inputConfigBuilder.getChildrenModules();
final boolean specifyViolationMessage = (moduleLists.size() == 1)
&& getNumberOfMessages(moduleLists.get(0).getModuleName()) > 1;
final Matcher violationMatcher =
FILTERED_VIOLATION_PATTERN.matcher(line);
final Matcher violationAboveMatcher =
FILTERED_VIOLATION_ABOVE_PATTERN.matcher(line);
final Matcher violationBelowMatcher =
FILTERED_VIOLATION_BELOW_PATTERN.matcher(line);
if (violationMatcher.matches()) {
inputConfigBuilder.addFilteredViolation(lineNo, violationMatcher.group(1));
String violationMessage = violationMatcher.group(1);
checkWhetherViolationSpecified(specifyViolationMessage, violationMessage, lineNo);
inputConfigBuilder.addFilteredViolation(lineNo, violationMessage);
}
else if (violationAboveMatcher.matches()) {
inputConfigBuilder.addFilteredViolation(lineNo - 1, violationAboveMatcher.group(1));
String violationMessage = violationAboveMatcher.group(1);
final int violationLineNum = lineNo - 1;
checkWhetherViolationSpecified(specifyViolationMessage, violationMessage,
violationLineNum);
inputConfigBuilder.addFilteredViolation(violationLineNum, violationMessage);
}
else if (violationBelowMatcher.matches()) {
inputConfigBuilder.addFilteredViolation(lineNo + 1, violationBelowMatcher.group(1));
String violationMessage = violationBelowMatcher.group(1);
final int violationLineNum = lineNo + 1;
checkWhetherViolationSpecified(specifyViolationMessage, violationMessage,
violationLineNum);
inputConfigBuilder.addFilteredViolation(violationLineNum, violationMessage);
}
}

/**
* Gets the number of message keys in a check.
*
* @param className className
* @return number of message keys in a check
* @throws ClassNotFoundException classNotFoundException
*/
private static long getNumberOfMessages(String className) throws ClassNotFoundException {
Class<?> clazz = Class.forName(className);
final String messageInitials = "MSG_";
return Arrays.stream(clazz.getDeclaredFields())
.filter(field -> {
final int modifiers = field.getModifiers();
final String fieldName = field.getName();
return fieldName.startsWith(messageInitials)
&& Modifier.isStatic(modifiers)
&& Modifier.isFinal(modifiers);
})
.count();
}

/**
* Check whether violation is specified along with {@code // violation} comment.
*
* @param shouldViolationMsgBeSpecified should violation messages be specified.
* @param violationMessage violation message
* @param lineNum line number
* @throws CheckstyleException checkstyleException
*/
private static void checkWhetherViolationSpecified(boolean shouldViolationMsgBeSpecified,
String violationMessage, int lineNum) throws CheckstyleException {
if (shouldViolationMsgBeSpecified && violationMessage == null) {
throw new CheckstyleException(
"Violation message should be specified on line " + lineNum);
}
}
}
4 changes: 4 additions & 0 deletions src/test/java/com/puppycrawl/tools/checkstyle/bdd/TestInputConfiguration.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -149,5 +149,9 @@ public TestInputConfiguration build() {
filteredViolations
);
}

public List<ModuleInputConfiguration> getChildrenModules() {
return childrenModules;
}
}
}

0 comments on commit 594d490

Please sign in to comment.