Adding category to model #39

tomasbjerre · Aug 18, 2018 · 9fa7ff2 · 9fa7ff2
1 parent eb78f2c
commit 9fa7ff2
Show file tree

Hide file tree

Showing 7 changed files with 36 additions and 8 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,5 @@
+.idea
+out
 .okhttpcache
 .classpath
 .project

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,15 @@
 
 Changelog of Violations lib.
 
+## Unreleased
+### GitHub [#39](https://github.com/tomasbjerre/violations-lib/issues/39) AndroidLintParser doesn&#39;t expose rule correctly
+
+**Adding category to model**
+
+
+[3c6f6acd7646597](https://github.com/tomasbjerre/violations-lib/commit/3c6f6acd7646597) Tomas Bjerre *2018-08-18 13:46:33*
+
+
 ## 1.58
 ### No issue
 

diff --git a/src/main/java/se/bjurr/violations/lib/model/Violation.java b/src/main/java/se/bjurr/violations/lib/model/Violation.java
@@ -20,6 +20,7 @@ public static class ViolationBuilder {
     private Parser parser;
     private String reporter;
     private String rule;
+    private String category;
     private SEVERITY severity;
     private String source;
     private Map<String, String> specifics = new HashMap<>();
@@ -66,6 +67,11 @@ public ViolationBuilder setRule(final String rule) {
       return this;
     }
 
+    public ViolationBuilder setCategory(String category) {
+      this.category = category;
+      return this;
+    }
+
     public ViolationBuilder setSeverity(final SEVERITY severity) {
       this.severity = severity;
       return this;
@@ -116,6 +122,7 @@ public static ViolationBuilder violationBuilder() {
   private String reporter;
 
   private final String rule;
+  private final String category;
   private final SEVERITY severity;
   private final String source;
   private final Map<String, String> specifics;
@@ -129,6 +136,7 @@ public Violation() {
     file = null;
     source = null;
     rule = null;
+    category = null;
     reporter = null;
     specifics = null;
     parser = null;
@@ -149,6 +157,7 @@ public Violation(final ViolationBuilder vb) {
     file = checkNotNull(emptyToNull(vb.file), "file").replaceAll("\\\\", "/");
     source = nullToEmpty(vb.source);
     rule = nullToEmpty(vb.rule);
+    category = nullToEmpty(vb.category);
     specifics = vb.specifics;
   }
 
@@ -163,6 +172,7 @@ public Violation(final Violation v) {
     file = v.file;
     source = v.source;
     rule = v.rule;
+    category = v.category;
     specifics = v.specifics;
   }
 
@@ -282,6 +292,10 @@ public String getRule() {
     return rule;
   }
 
+  public String getCategory() {
+    return category;
+  }
+
   public SEVERITY getSeverity() {
     return severity;
   }

diff --git a/src/main/java/se/bjurr/violations/lib/parsers/AndroidLintParser.java b/src/main/java/se/bjurr/violations/lib/parsers/AndroidLintParser.java
@@ -35,7 +35,7 @@ public List<Violation> parseReportOutput(String string) throws Exception {
       String summary = getAttribute(issueChunk, "summary").trim();
       String explanation = getAttribute(issueChunk, "explanation");
 
-      String rule = getAttribute(issueChunk, "category");
+      String category = getAttribute(issueChunk, "category");
 
       violations.add( //
           violationBuilder() //
@@ -44,8 +44,9 @@ public List<Violation> parseReportOutput(String string) throws Exception {
               .setColumn(charAttrib.orNull()) //
               .setFile(filename) //
               .setSeverity(toSeverity(severity)) //
-              .setRule(rule) //
-              .setMessage(id + ": " + summary + "\n" + message + "\n" + explanation) //
+              .setRule(id) //
+              .setCategory(category) //
+              .setMessage(summary + "\n" + message + "\n" + explanation) //
               .build() //
           );
     }

diff --git a/src/main/java/se/bjurr/violations/lib/parsers/PMDParser.java b/src/main/java/se/bjurr/violations/lib/parsers/PMDParser.java
@@ -49,6 +49,7 @@ public List<Violation> parseReportOutput(String string) throws Exception {
                 .setFile(filename) //
                 .setSeverity(severity) //
                 .setRule(rule) //
+                .setCategory(ruleSetOpt.orNull())
                 .setMessage(message.trim()) //
                 .build() //
             );

diff --git a/src/test/java/se/bjurr/violations/lib/AndroidLintTest.java b/src/test/java/se/bjurr/violations/lib/AndroidLintTest.java
@@ -36,9 +36,10 @@ public void testThatViolationsCanBeParsed() {
                 .setStartLine(10) //
                 .setEndLine(10) //
                 .setColumn(9) //
-                .setRule("Correctness")
+                .setRule("ScrollViewSize") //
+                .setCategory("Correctness") //
                 .setMessage(
-                    "ScrollViewSize: ScrollView size validation\n"
+                    "ScrollView size validation\n"
                         + "This LinearLayout should use `android:layout_height=\"wrap_content\"`\n"
                         + "ScrollView children must set their `layout_width` or `layout_height` attributes to `wrap_content` rather than `fill_parent` or `match_parent` in the scrolling dimension") //
                 .setSeverity(WARN) //
@@ -51,9 +52,10 @@ public void testThatViolationsCanBeParsed() {
                 .setStartLine(0) //
                 .setEndLine(0) //
                 .setColumn(null) //
-                .setRule("Correctness") //
+                .setRule("InvalidPackage") //
+                .setCategory("Correctness") //
                 .setMessage(
-                    "InvalidPackage: Package not included in Android\n"
+                    "Package not included in Android\n"
                         + "Invalid package reference in library; not included in Android: `java.nio.file`. Referenced from `okio.Okio`.\n"
                         + "This check scans through libraries looking for calls to APIs that are not included in Android.\n"
                         + "        \n"

diff --git a/src/test/java/se/bjurr/violations/lib/model/ViolationTest.java b/src/test/java/se/bjurr/violations/lib/model/ViolationTest.java
@@ -6,7 +6,6 @@
 import static se.bjurr.violations.lib.reports.Parser.CHECKSTYLE;
 
 import org.junit.Test;
-
 import se.bjurr.violations.lib.model.Violation.ViolationBuilder;
 import uk.co.jemos.podam.api.PodamFactoryImpl;