Skip to content

Commit 33e858f

Browse files
david-m-sdavid-m-s
authored
Allow to configure the plugin to fail on any severity (#478)
Allow to configure the plugin to fail on any severity of detected issues. This is necessary to ease the integration to cicd with requirements to not pass if any static code violation is found, without needing to configure the checkstyle, pmd and findbugs in depth to produce only error level, which is hard to do and can be difficult to maintain regarding future versions. Signed-off-by: David Mas <david.mas@ocado.com>
1 parent a14277b commit 33e858f

File tree

3 files changed

+92
-29
lines changed

3 files changed

+92
-29
lines changed

‎docs/maven-plugin.md‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -129,12 +129,14 @@ Description:
129129

130130
Parameters:
131131

132-
| Name | Type| Description |
133-
| ------ | ------| -------- |
134-
| **report.targetDir** | String | The directory where the individual report will be generated (default value is **${project.build.directory}/code-analysis**) |
135-
| **report.summary.targetDir** | String | The directory where the summary report, containing links to the individual reports will be generated (Default value is **${session.executionRootDirectory}/target**)|
136-
| **report.fail.on.error** | Boolean | Describes of the build should fail if high priority error is found (Default value is **true**)|
137-
| **report.in.maven** | Boolean | Enable/Disable maven console logging of all messages (Default value is **true**)|
132+
| Name | Type| Description |
133+
|------------------------------| ------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
134+
| **report.targetDir** | String | The directory where the individual report will be generated (default value is **${project.build.directory}/code-analysis**) |
135+
| **report.summary.targetDir** | String | The directory where the summary report, containing links to the individual reports will be generated (Default value is **${session.executionRootDirectory}/target**) |
136+
| **report.fail.on.error** | Boolean | Describes of the build should fail if high priority error is found (Default value is **true**) |
137+
| **report.fail.on.warning** | Boolean | Describes of the build should fail if warning is found (Default value is **false**) |
138+
| **report.fail.on.info** | Boolean | Describes of the build should fail if info is found (Default value is **false**) |
139+
| **report.in.maven** | Boolean | Enable/Disable maven console logging of all messages (Default value is **true**) |
138140

139141
## Customization
140142

‎sat-plugin/src/main/java/org/openhab/tools/analysis/report/ReportMojo.java‎

Lines changed: 61 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,9 @@
5555
import java.time.ZonedDateTime;
5656
import java.time.format.DateTimeFormatter;
5757
import java.time.format.DateTimeFormatterBuilder;
58+
import java.util.ArrayList;
5859
import java.util.LinkedList;
60+
import java.util.List;
5961
import java.util.Queue;
6062

6163
import javax.xml.parsers.DocumentBuilder;
@@ -115,6 +117,18 @@ public class ReportMojo extends AbstractMojo {
115117
@Parameter(property = "report.fail.on.error", defaultValue = "true")
116118
private boolean failOnError;
117119

120+
/**
121+
* Describes of the build should fail if medium priority error is found
122+
*/
123+
@Parameter(property = "report.fail.on.warning", defaultValue = "false")
124+
private boolean failOnWarning;
125+
126+
/**
127+
* Describes of the build should fail if low priority error is found
128+
*/
129+
@Parameter(property = "report.fail.on.info", defaultValue = "false")
130+
private boolean failOnInfo;
131+
118132
/**
119133
* The directory where the summary report, containing links to the individual reports will be
120134
* generated
@@ -142,6 +156,14 @@ public void setFailOnError(boolean failOnError) {
142156
this.failOnError = failOnError;
143157
}
144158

159+
public void setFailOnWarning(boolean failOnWarning) {
160+
this.failOnWarning = failOnWarning;
161+
}
162+
163+
public void setFailOnInfo(boolean failOnInfo) {
164+
this.failOnInfo = failOnInfo;
165+
}
166+
145167
public void setSummaryReport(File summaryReport) {
146168
this.summaryReportDirectory = summaryReport;
147169
}
@@ -222,8 +244,8 @@ public void execute() throws MojoFailureException {
222244
reportWarningsAndErrors(mergedReport, htmlOutputFileName);
223245
}
224246

225-
// 9. Fail the build if the option is enabled and high priority warnings are found
226-
if (failOnError) {
247+
// 9. Fail the build if any level error is enabled and configured error levels are found
248+
if (failOnError || failOnWarning || failOnInfo) {
227249
failOnErrors(mergedReport);
228250
}
229251

@@ -342,13 +364,44 @@ private int countPriority(NodeList messages, String priority) {
342364
}
343365

344366
private void failOnErrors(File mergedReport) throws MojoFailureException {
345-
int errorCount = selectNodes(mergedReport, "/sca/file/message[@priority=1]").getLength();
346-
if (errorCount > 0) {
347-
throw new MojoFailureException(String.format(
348-
"%n" + "Code Analysis Tool has found %d error(s)! %n"
349-
+ "Please fix the errors and rerun the build. %n",
350-
selectNodes(mergedReport, "/sca/file/message[@priority=1]").getLength()));
367+
List<String> errorMessages = new ArrayList<>();
368+
if (failOnError) {
369+
detectFailures(errorMessages, mergedReport, 1);
370+
}
371+
if (failOnWarning) {
372+
detectFailures(errorMessages, mergedReport, 2);
373+
}
374+
if (failOnInfo) {
375+
detectFailures(errorMessages, mergedReport, 3);
351376
}
377+
if (!errorMessages.isEmpty()) {
378+
throw new MojoFailureException(String.join("\n", errorMessages));
379+
}
380+
}
381+
382+
private void detectFailures(List<String> errorMessages, File mergedReport, int priority) {
383+
NodeList messages = selectNodes(mergedReport, "/sca/file/message");
384+
int count = countPriority(messages, String.valueOf(priority));
385+
if (count > 0) {
386+
errorMessages.add(failureMessage(priority(priority), count));
387+
}
388+
}
389+
390+
private String priority(int priority) {
391+
switch (priority) {
392+
case 1:
393+
return "error";
394+
case 2:
395+
return "warning";
396+
case 3:
397+
default:
398+
return "info";
399+
}
400+
}
401+
402+
private String failureMessage(String severity, int count) {
403+
return String.format("%nCode Analysis Tool has found %d %s(s)! %nPlease fix the %s(s) and rerun the build.",
404+
count, severity, severity);
352405
}
353406

354407
private void report(String priority, String log) {

‎sat-plugin/src/test/java/org/openhab/tools/analysis/report/ReportMojoTest.java‎

Lines changed: 23 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,21 @@
1313
package org.openhab.tools.analysis.report;
1414

1515
import static org.junit.jupiter.api.Assertions.*;
16+
import static org.junit.jupiter.params.provider.Arguments.arguments;
1617
import static org.mockito.Mockito.verify;
1718
import static org.openhab.tools.analysis.report.ReportUtil.RESULT_FILE_NAME;
1819

1920
import java.io.File;
21+
import java.util.stream.Stream;
2022

2123
import org.apache.maven.plugin.MojoFailureException;
2224
import org.apache.maven.plugin.logging.Log;
2325
import org.junit.jupiter.api.BeforeEach;
2426
import org.junit.jupiter.api.Test;
2527
import org.junit.jupiter.api.extension.ExtendWith;
28+
import org.junit.jupiter.params.ParameterizedTest;
29+
import org.junit.jupiter.params.provider.Arguments;
30+
import org.junit.jupiter.params.provider.MethodSource;
2631
import org.mockito.Mock;
2732
import org.mockito.junit.jupiter.MockitoExtension;
2833

@@ -57,29 +62,32 @@ public void setUp() throws Exception {
5762
}
5863
}
5964

60-
@Test
61-
public void assertReportIsCreatedAndBuildFails() throws Exception {
65+
@ParameterizedTest
66+
@MethodSource("provideReportParameters")
67+
public void assertReportIsCreatedAndBuildFailsAsExpected(boolean failOnError, boolean failOnWarning,
68+
boolean failOnInfo, boolean buildFailExpected) {
6269
assertFalse(resultFile.exists());
6370

64-
subject.setFailOnError(true);
71+
subject.setFailOnError(failOnError);
72+
subject.setFailOnWarning(failOnWarning);
73+
subject.setFailOnInfo(failOnInfo);
6574
subject.setSummaryReport(null);
6675
subject.setTargetDirectory(new File(TARGET_ABSOLUTE_DIR));
6776

68-
assertThrows(MojoFailureException.class, () -> subject.execute());
77+
if (buildFailExpected) {
78+
assertThrows(MojoFailureException.class, () -> subject.execute());
79+
} else {
80+
assertDoesNotThrow(() -> subject.execute());
81+
82+
}
6983
assertTrue(resultFile.exists());
7084
}
7185

72-
@Test
73-
public void assertReportISCreatedAndBuildCompletes() throws MojoFailureException {
74-
assertFalse(resultFile.exists());
75-
76-
subject.setFailOnError(false);
77-
subject.setSummaryReport(null);
78-
subject.setTargetDirectory(new File(TARGET_ABSOLUTE_DIR));
79-
80-
subject.execute();
81-
82-
assertTrue(resultFile.exists());
86+
private static Stream<Arguments> provideReportParameters() {
87+
return Stream.of(arguments(false, false, false, false), arguments(false, false, true, true),
88+
arguments(false, true, false, true), arguments(false, true, true, true),
89+
arguments(true, false, false, true), arguments(true, false, true, true),
90+
arguments(true, true, false, true), arguments(true, true, true, true));
8391
}
8492

8593
@Test

0 commit comments

Comments
 (0)