Pylint: Add types and make categories types and categories, categories #104

JeanChristopheMorinPerso · 2019-03-03T02:42:56Z

As mentionned in Jira, the actual categories for Pylint should be types.

So I took the time to do the change. So I swapped the categories for the types, and introduced real categories. Now the Pylint parser does the same thing as the other parsers.

Note that I also added the category [I]nformational since it was missing and it's a valid Pylint category.

JeanChristopheMorinPerso · 2019-03-03T02:48:30Z

src/main/java/edu/hm/hafner/analysis/parser/PyLintParser.java


-    private static final String UNKNOWN_CAT = "pylint-unknown";
+    private static final String UNKNOWN_CAT = "pylint-unknown-category";
+    private static final String UNKNOWN_TYPE = "pylint-unkown-type";


Typo in pylint-unknown-type. I'm missing a n after the k.

codecov · 2019-03-03T03:14:25Z

Codecov Report

Merging #104 into master will increase coverage by 0.14%.
The diff coverage is 100%.

@@             Coverage Diff              @@
##             master     #104      +/-   ##
============================================
+ Coverage     86.48%   86.63%   +0.14%     
- Complexity     1192     1203      +11     
============================================
  Files           159      159              
  Lines          3840     3852      +12     
  Branches        428      429       +1     
============================================
+ Hits           3321     3337      +16     
+ Misses          357      355       -2     
+ Partials        162      160       -2

Impacted Files	Coverage Δ	Complexity Δ
...va/edu/hm/hafner/analysis/parser/PyLintParser.java	`100% <100%> (+16%)`	`19 <14> (+11)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update eaadd8b...2abffae. Read the comment docs.

codecov · 2019-03-03T03:14:25Z

Codecov Report

Merging #104 into master will decrease coverage by 0.06%.
The diff coverage is 61.53%.

@@             Coverage Diff              @@
##             master     #104      +/-   ##
============================================
- Coverage     86.45%   86.39%   -0.07%     
- Complexity     1190     1196       +6     
============================================
  Files           159      159              
  Lines          3832     3843      +11     
  Branches        426      427       +1     
============================================
+ Hits           3313     3320       +7     
- Misses          357      359       +2     
- Partials        162      164       +2

Impacted Files	Coverage Δ	Complexity Δ
...va/edu/hm/hafner/analysis/parser/PyLintParser.java	`71.42% <61.53%> (-5.05%)`	`12 <6> (+6)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a117c9f...a771fe1. Read the comment docs.

uhafner · 2019-03-03T10:05:06Z

src/main/java/edu/hm/hafner/analysis/parser/PyLintParser.java

@@ -39,14 +40,38 @@ protected boolean isLineInteresting(final String line) {
    protected Optional<Issue> createIssue(final Matcher matcher, final IssueBuilder builder) {
        String category = matcher.group("category");
        builder.setSeverity(mapPriority(category));
-        builder.setCategory(StringUtils.firstNonBlank(matcher.group("symbol"), category, UNKNOWN_CAT));
+        builder.setCategory(StringUtils.firstNonBlank(mapCategory(category), UNKNOWN_CAT));


Since mapCategory is non-empty,

builder.setCategory(mapCategory(category));

uhafner · 2019-03-03T10:06:57Z

src/main/java/edu/hm/hafner/analysis/parser/PyLintParser.java


        return builder.setFileName(matcher.group("path"))
                .setLineStart(matcher.group("line"))
                .setMessage(matcher.group("message"))
                .buildOptional();
    }

+    private String mapCategory(final String category) {
+        if (category.isEmpty()) {


StringUtils.isEmpty(category), otherwise a NPE might occur

uhafner · 2019-03-03T10:08:28Z

src/main/java/edu/hm/hafner/analysis/parser/PyLintParser.java

-            case 'E':
-            case 'F':
+            case "E":
+            case "F":
                return Severity.WARNING_HIGH;


We also have Severity.ERROR. Would it make sense to use it as well?

That is a really good idea.

…ests for more coverage.

JeanChristopheMorinPerso · 2019-03-03T17:53:59Z

src/main/java/edu/hm/hafner/analysis/parser/PyLintParser.java

@@ -19,9 +19,10 @@
    private static final long serialVersionUID = 4464053085862883240L;

    // the default pattern matches "--output-format=parseable" output.
-    private static final String PYLINT_PATTERN = "(?<path>[^:]*)(?:\\:(?<module>.*))?:(?<line>\\d+): \\[(?<category>\\D\\d*)(?:\\((?<symbol>.*)\\), )?.*?\\] (?<message>.*)";
+    private static final String PYLINT_PATTERN = "(?<path>[^:]*)(?:\\:(?<module>.*))?:(?<line>\\d+): \\[(?<type>(?<category>[A-Z])\\d*)?(?:\\((?<symbol>.*)\\), )?.*?\\] (?<message>.*)";


The type (and so the category) group is now optional. That way, in the case where someone would not add {msg_id} in the --msg-template, we won't have a java.util.NoSuchElementException error.

JeanChristopheMorinPerso · 2019-03-03T17:54:40Z

src/main/java/edu/hm/hafner/analysis/parser/PyLintParser.java

    private Severity mapPriority(final String category) {
        // First letter of the Pylint classification is one of F/E/W/R/C. E/F/W are high
        // priority.

        // See http://docs.pylint.org/output.html for definitions of the categories
-        if (category.isEmpty()) {
+        if (StringUtils.isEmpty(category)) {


I also added StringUtils.isEmpty to protect against NPE.

uhafner · 2019-03-04T06:55:25Z

Thanks!

Followup to jenkinsci/analysis-model#104.

JeanChristopheMorinPerso commented Mar 3, 2019

View reviewed changes

uhafner requested changes Mar 3, 2019

View reviewed changes

JeanChristopheMorinPerso added 4 commits March 3, 2019 12:15

Pylint: Add types and make categories types and categories, categories

9493355

Fix PR comments

95a0952

Set fatal issues severity to error.

b580955

Rebase with master and fix case of category is missing and add more t…

a2b1205

…ests for more coverage.

JeanChristopheMorinPerso force-pushed the dev_pylint_categories_and_types branch from 4b41e9a to a2b1205 Compare March 3, 2019 17:52

JeanChristopheMorinPerso commented Mar 3, 2019

View reviewed changes

More coverage for unknown category

2abffae

uhafner approved these changes Mar 4, 2019

View reviewed changes

uhafner merged commit 7956fc0 into jenkinsci:master Mar 4, 2019

JeanChristopheMorinPerso deleted the dev_pylint_categories_and_types branch March 4, 2019 13:54

uhafner added a commit to jenkinsci/warnings-ng-plugin that referenced this pull request Mar 5, 2019

Update of Pylint to use type to obtain description.

1483e55

Followup to jenkinsci/analysis-model#104.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Pylint: Add types and make categories types and categories, categories #104

Pylint: Add types and make categories types and categories, categories #104

JeanChristopheMorinPerso commented Mar 3, 2019

JeanChristopheMorinPerso Mar 3, 2019

codecov bot commented Mar 3, 2019 •

edited

Loading

codecov bot commented Mar 3, 2019

uhafner Mar 3, 2019

uhafner Mar 3, 2019

uhafner Mar 3, 2019

JeanChristopheMorinPerso Mar 3, 2019

JeanChristopheMorinPerso Mar 3, 2019

JeanChristopheMorinPerso Mar 3, 2019

JeanChristopheMorinPerso Mar 3, 2019

uhafner commented Mar 4, 2019

Pylint: Add types and make categories types and categories, categories #104

Pylint: Add types and make categories types and categories, categories #104

Conversation

JeanChristopheMorinPerso commented Mar 3, 2019

Choose a reason for hiding this comment

codecov bot commented Mar 3, 2019 • edited Loading

Codecov Report

codecov bot commented Mar 3, 2019

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

uhafner commented Mar 4, 2019

codecov bot commented Mar 3, 2019 •

edited

Loading