Skip to content

SONARJAVA-5397 Support the import of custom checkstyle issues #6059

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aurelien-coet-sonarsource merged 2 commits into from
Sep 1, 2026
+17 −8
Merged

SONARJAVA-5397 Support the import of custom checkstyle issues #6059

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6f6760e
Support the import of custom checkstyle issues
aurelien-coet-sonarsource Aug 28, 2026
dd442c5
Apply Gitar review fix
aurelien-coet-sonarsource Aug 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions external-reports/src/main/java/org/sonar/java/externalreport/CheckstyleXmlReportReader.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,15 +112,15 @@ private void onErrorElement(StartElement element) {
String source = getAttributeValue(element, SOURCE);
String line = getAttributeValue(element, LINE);
String message = getAttributeValue(element, MESSAGE);
if (!source.startsWith(CHECKSTYLE_PREFIX)) {
LOG.debug("Unexpected rule key without '{}' prefix: '{}'", CHECKSTYLE_PREFIX, source);
if (source.isEmpty()) {
LOG.debug("Unexpected error without rule key (missing 'source' attribute).");
return;
}
if (message.isEmpty()) {
LOG.debug("Unexpected error without message for rule: '{}'", source);
return;
}
String key = source.substring(CHECKSTYLE_PREFIX.length());
String key = source.startsWith(CHECKSTYLE_PREFIX) ? source.substring(CHECKSTYLE_PREFIX.length()) : source;
consumer.onError(context, inputFile, key, line, message);
Comment thread
gitar-bot[bot] marked this conversation as resolved.
}

Expand Down
17 changes: 13 additions & 4 deletions external-reports/src/test/java/org/sonar/java/externalreport/CheckstyleSensorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ void no_issues_with_invalid_report(String fileName) throws IOException {
@Test
void issues_when_xml_file_has_errors() throws IOException {
List<ExternalIssue> externalIssues = executeSensorImporting("checkstyle-with-errors.xml");
assertThat(externalIssues).hasSize(1);
assertThat(externalIssues).hasSize(2);

ExternalIssue first = externalIssues.get(0);
assertThat(first.primaryLocation().inputComponent().key()).isEqualTo("checkstyle-project:Main.java");
Expand All @@ -165,13 +165,22 @@ void issues_when_xml_file_has_errors() throws IOException {
assertThat(first.primaryLocation().message()).isEqualTo("Error at file level with an unknown rule key.");
assertThat(first.primaryLocation().textRange()).isNull();

ExternalIssue second = externalIssues.get(1);
assertThat(second.primaryLocation().inputComponent().key()).isEqualTo("checkstyle-project:A.java");
assertThat(second.engineId()).isEqualTo("checkstyle");
assertThat(second.ruleId()).isEqualTo("com.example.CustomCheck");
assertThat(second.ruleKey().rule()).isEqualTo("com.example.CustomCheck");
assertThat(second.type()).isEqualTo(RuleType.CODE_SMELL);
assertThat(second.severity()).isEqualTo(Severity.MAJOR);
assertThat(second.primaryLocation().message()).isEqualTo("Custom rule issue.");
assertThat(second.primaryLocation().textRange().start().line()).isEqualTo(1);

assertThat(logTester.logs(Level.ERROR)).isEmpty();
assertThat(onlyOneLogElement(logTester.logs(Level.WARN)))
.startsWith("No input file found for '")
.endsWith("not-existing-file.java'. No checkstyle issues will be imported on this file.");
assertThat(logTester.logs(Level.DEBUG)).containsExactlyInAnyOrder(
"Unexpected error without message for rule: 'com.puppycrawl.tools.checkstyle.checks.ArrayTypeStyleCheck'",
"Unexpected rule key without 'com.puppycrawl.tools.checkstyle.checks.' prefix: 'invalid-format'");
assertThat(logTester.logs(Level.DEBUG)).containsExactly(
"Unexpected error without message for rule: 'com.puppycrawl.tools.checkstyle.checks.ArrayTypeStyleCheck'");
}

private List<ExternalIssue> executeSensorImporting(@Nullable String fileName) throws IOException {
Expand Down
2 changes: 1 addition & 1 deletion external-reports/src/test/resources/checkstyle/checkstyle-with-errors.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@
<error message="Error at file level with an unknown rule key." source="com.puppycrawl.tools.checkstyle.checks.UnknownRuleKey" />
</file>
<file name="${PROJECT_DIR}A.java">
<error line="1" column="1" severity="error" message="Unsupported rule key format." source="invalid-format" />
<error line="1" column="1" severity="error" message="Custom rule issue." source="com.example.CustomCheck" />
</file>
</checkstyle>
Loading