-
Notifications
You must be signed in to change notification settings - Fork 39
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #31 from oyvindlr/master
Added PC-lint parser
- Loading branch information
Showing
7 changed files
with
262 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
116 changes: 116 additions & 0 deletions
116
src/main/java/se/bjurr/violations/lib/parsers/PCLintParser.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,116 @@ | ||
package se.bjurr.violations.lib.parsers; | ||
|
||
import static java.lang.Integer.parseInt; | ||
import static se.bjurr.violations.lib.model.SEVERITY.ERROR; | ||
import static se.bjurr.violations.lib.model.SEVERITY.INFO; | ||
import static se.bjurr.violations.lib.model.SEVERITY.WARN; | ||
import static se.bjurr.violations.lib.model.Violation.violationBuilder; | ||
import static se.bjurr.violations.lib.reports.Parser.PCLINT; | ||
import static se.bjurr.violations.lib.util.ViolationParserUtils.getLines; | ||
import static se.bjurr.violations.lib.util.ViolationParserUtils.getParts; | ||
|
||
import java.util.ArrayList; | ||
import java.util.List; | ||
import java.util.regex.*; | ||
import se.bjurr.violations.lib.model.SEVERITY; | ||
import se.bjurr.violations.lib.model.Violation; | ||
|
||
public class PCLintParser implements ViolationsParser { | ||
|
||
@Override | ||
public List<Violation> parseReportOutput(String string) throws Exception { | ||
List<Violation> violations = new ArrayList<>(); | ||
List<String> lines = getLines(string); | ||
Pattern misraPattern = Pattern.compile("\\[MISRA.*\\]"); | ||
for (String line : lines) { | ||
Matcher misraMatcher = misraPattern.matcher(line); | ||
if (misraMatcher.find()) { | ||
parseMisraViolation(line, violations); | ||
} else { | ||
parseGeneralViolation(line, violations); | ||
} | ||
} | ||
return violations; | ||
} | ||
|
||
private void parseMisraViolation(String line, List<Violation> violations) { | ||
List<String> parts = | ||
getParts( | ||
line, | ||
"^([^\\(]+)\\(", | ||
"^([\\d]+)\\): ", | ||
"^(?:Error|Warning|Info|Note) [\\d]+: ([^\\[]*)", | ||
"^\\[(.*),", | ||
"(mandatory|required|advisory)\\]", | ||
"^(.*)$"); | ||
if (parts.isEmpty()) { | ||
return; | ||
} | ||
String filename = parts.get(0); | ||
Integer lineNumber = parseInt(parts.get(1)); | ||
|
||
String severityString = parts.get(4); | ||
SEVERITY severity = toMisraSeverity(severityString); | ||
String rule = parts.get(3) + ", " + severityString; | ||
String message = parts.get(2) + " " + parts.get(5); | ||
violations.add( // | ||
violationBuilder() // | ||
.setParser(PCLINT) // | ||
.setStartLine(lineNumber) // | ||
.setFile(filename) // | ||
.setRule(rule) // | ||
.setSeverity(severity) // | ||
.setMessage(message) // | ||
.build() // | ||
); | ||
} | ||
|
||
private void parseGeneralViolation(String line, List<Violation> violations) { | ||
List<String> parts = | ||
getParts( | ||
line, | ||
"^([^\\(]+)\\(", | ||
"^([\\d]+)\\): ", | ||
"^(Error|Warning|Info|Note) ", | ||
"^([\\d]+): ", | ||
"^(.*)$"); | ||
if (parts.isEmpty()) { | ||
return; | ||
} | ||
String filename = parts.get(0); | ||
Integer lineNumber = parseInt(parts.get(1)); | ||
SEVERITY severity = toSeverity(parts.get(2)); | ||
String rule = parts.get(3); | ||
String message = parts.get(4); | ||
violations.add( // | ||
violationBuilder() // | ||
.setParser(PCLINT) // | ||
.setStartLine(lineNumber) // | ||
.setFile(filename) // | ||
.setRule(rule) // | ||
.setSeverity(severity) // | ||
.setMessage(message) // | ||
.build() // | ||
); | ||
} | ||
|
||
private SEVERITY toSeverity(String severity) { | ||
if (severity.equals("Error")) { | ||
return ERROR; | ||
} | ||
if (severity.equals("Warning")) { | ||
return WARN; | ||
} | ||
return INFO; | ||
} | ||
|
||
private SEVERITY toMisraSeverity(String severity) { | ||
if (severity.equals("mandatory")) { | ||
return ERROR; | ||
} | ||
if (severity.equals("required")) { | ||
return WARN; | ||
} | ||
return INFO; | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,109 @@ | ||
package se.bjurr.violations.lib; | ||
|
||
import static org.assertj.core.api.Assertions.assertThat; | ||
import static se.bjurr.violations.lib.TestUtils.getRootFolder; | ||
import static se.bjurr.violations.lib.ViolationsApi.violationsApi; | ||
import static se.bjurr.violations.lib.model.SEVERITY.ERROR; | ||
import static se.bjurr.violations.lib.model.SEVERITY.INFO; | ||
import static se.bjurr.violations.lib.model.SEVERITY.WARN; | ||
import static se.bjurr.violations.lib.model.Violation.violationBuilder; | ||
import static se.bjurr.violations.lib.reports.Parser.PCLINT; | ||
|
||
import java.util.List; | ||
import org.junit.Test; | ||
import se.bjurr.violations.lib.model.Violation; | ||
|
||
public class PCLintTest { | ||
|
||
@Test | ||
public void testThatViolationsCanBeParsed() { | ||
String rootFolder = getRootFolder(); | ||
|
||
List<Violation> actual = | ||
violationsApi() // | ||
.withPattern(".*/pclint/.*\\.txt$") // | ||
.inFolder(rootFolder) // | ||
.findAll(PCLINT) // | ||
.violations(); | ||
|
||
assertThat(actual) // | ||
.hasSize(8); | ||
|
||
assertThat(actual.get(0)) // | ||
.isEqualTo( // | ||
violationBuilder() // | ||
.setParser(PCLINT) // | ||
.setFile("C:\\UST3\\qse30\\Drivers\\drvADC.c") // | ||
.setStartLine(84) // | ||
.setRule("9029") // | ||
.setMessage("Mismatched essential type categories for binary operator") // | ||
.setSeverity(INFO) // | ||
.build() // | ||
); | ||
|
||
assertThat(actual.get(3)) // | ||
.isEqualTo( // | ||
violationBuilder() // | ||
.setParser(PCLINT) // | ||
.setFile("C:\\UST3\\qse30\\Drivers\\drvCAN.c") // | ||
.setStartLine(73) // | ||
.setRule("534") // | ||
.setMessage( | ||
"Ignoring return value of function 'PIC_CAN_Transmit(can_frame_t *)' (compare with line 68, file C:\\UST3\\qse30\\HAL\\hal_ext.h, module C:\\UST3\\qse30\\Drivers\\drvADC.c)") // | ||
.setSeverity(WARN) // | ||
.build() // | ||
); | ||
assertThat(actual.get(5)) // | ||
.isEqualTo( // | ||
violationBuilder() // | ||
.setParser(PCLINT) // | ||
.setFile("C:\\UST3\\qse30\\Drivers\\drvCAN.c") // | ||
.setStartLine(134) // | ||
.setRule("818") // | ||
.setMessage( | ||
"Pointer parameter 'txFrame' (line 100) could be declared as pointing to const") // | ||
.setSeverity(INFO) // | ||
.build() // | ||
); | ||
assertThat(actual.get(6)) // | ||
.isEqualTo( // | ||
violationBuilder() // | ||
.setParser(PCLINT) // | ||
.setFile("C:\\UST3\\qse30\\Modules\\COMM\\J1939\\Broadcast\\dm13.c") // | ||
.setStartLine(123) // | ||
.setRule("48") // | ||
.setMessage("Bad type") // | ||
.setSeverity(ERROR) // | ||
.build() // | ||
); | ||
} | ||
|
||
@Test | ||
public void testThatSeverityAndRulenumberFromMisraTakesPrecedence() { | ||
String rootFolder = getRootFolder(); | ||
|
||
List<Violation> actual = | ||
violationsApi() // | ||
.withPattern(".*/pclint/.*\\.txt$") // | ||
.inFolder(rootFolder) // | ||
.findAll(PCLINT) // | ||
.violations(); | ||
|
||
Violation violation = actual.get(1); | ||
|
||
assertThat(violation.getRule().get()).isEqualTo("MISRA 2012 Rule 10.4, mandatory"); | ||
assertThat(violation.getSeverity()).isEqualTo(ERROR); | ||
|
||
violation = actual.get(2); | ||
|
||
assertThat(violation.getRule().get()).isEqualTo("MISRA 2012 Rule 1.3, required"); | ||
assertThat(violation.getSeverity()).isEqualTo(WARN); | ||
|
||
violation = actual.get(7); | ||
|
||
assertThat(violation.getRule().get()).isEqualTo("MISRA 2012 Rule 10.1, advisory"); | ||
assertThat(violation.getSeverity()).isEqualTo(INFO); | ||
assertThat(violation.getMessage()) | ||
.isEqualTo("Bad type (Error <a href=\"/userContent/LintMsgRef.html#48\">48</a>)"); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
PC-lint for C/C++ (NT) Vers. 9.00L, Copyright Gimpel Software 1985-2014 | ||
|
||
--- Module: C:\UST3\qse30\Drivers\drvADC.c (C) | ||
C:\UST3\qse30\Drivers\drvADC.c(84): Note 9029: Mismatched essential type categories for binary operator | ||
|
||
--- Module: C:\UST3\qse30\Drivers\drvCAN.c (C) | ||
C:\UST3\qse30\Drivers\drvCAN.c(68): Note 9029: Mismatched essential type categories for binary operator [MISRA 2012 Rule 10.4, mandatory] (Note <a href="/userContent/LintMsgRef.html#9029">9029</a>) | ||
C:\UST3\qse30\Drivers\drvCAN.c(72): Note 931: Both sides have side effects [MISRA 2012 Rule 1.3, required] | ||
C:\UST3\qse30\Drivers\drvCAN.c(73): Warning 534: Ignoring return value of function 'PIC_CAN_Transmit(can_frame_t *)' (compare with line 68, file C:\UST3\qse30\HAL\hal_ext.h, module C:\UST3\qse30\Drivers\drvADC.c) | ||
C:\UST3\qse30\Drivers\drvCAN.c(128): Warning 534: Ignoring return value of function 'PIC_CAN_Transmit(can_frame_t *)' (compare with line 68, file C:\UST3\qse30\HAL\hal_ext.h, module C:\UST3\qse30\Drivers\drvADC.c) | ||
C:\UST3\qse30\Drivers\drvCAN.c(134): Info 818: Pointer parameter 'txFrame' (line 100) could be declared as pointing to const | ||
|
||
|
||
--- Module: C:\UST3\qse30\Drivers\drvNTC.c (C) | ||
|
||
--- Module: C:\UST3\qse30\Drivers\drvPWM.c (C) | ||
(0): Info 766: Header file 'C:\UST3\qse30\Kernel\Common\common_types.h' not used in module 'C:\UST3\qse30\Drivers\drvPWM.c' (Info <a href="/userContent/LintMsgRef.html#766">766</a>) | ||
|
||
|
||
--- Module: C:\UST3\qse30\Modules\COMM\J1939\Broadcast\dm13.c (C) | ||
C:\UST3\qse30\Modules\COMM\J1939\Broadcast\dm13.c(123): Error 48: Bad type | ||
C:\UST3\qse30\Modules\COMM\J1939\Broadcast\dm13.c(123): Error 48: Bad type [MISRA 2012 Rule 10.1, advisory] (Error <a href="/userContent/LintMsgRef.html#48">48</a>) | ||
|
||
|
||
|
||
|