Add categories for the parsers.

Parsers now have a category to simplify the adaption in the user interface.
jenkinsci · Oct 5, 2024 · 55abb91 · 55abb91
1 parent e3b088d
commit 55abb91
Show file tree

Hide file tree

Showing 15 changed files with 74 additions and 4 deletions.
diff --git a/src/main/java/edu/hm/hafner/analysis/registry/ClairDescriptor.java b/src/main/java/edu/hm/hafner/analysis/registry/ClairDescriptor.java
@@ -33,4 +33,9 @@ public String getHelp() {
     public String getUrl() {
         return "https://github.com/arminc/clair-scanner";
     }
+
+    @Override
+    public Type getType() {
+        return Type.VULNERABILITY;
+    }
 }
diff --git a/src/main/java/edu/hm/hafner/analysis/registry/CodeCheckerDescriptor.java b/src/main/java/edu/hm/hafner/analysis/registry/CodeCheckerDescriptor.java
@@ -4,7 +4,7 @@
 import edu.hm.hafner.analysis.parser.CodeCheckerParser;
 
 /**
- * A descriptor for the Codechecker parser.
+ * A descriptor for the CodeChecker parser.
  *
  */
 class CodeCheckerDescriptor extends ParserDescriptor {

diff --git a/src/main/java/edu/hm/hafner/analysis/registry/DryDescriptor.java b/src/main/java/edu/hm/hafner/analysis/registry/DryDescriptor.java
@@ -67,4 +67,9 @@ private static String getCodeFragment(final DuplicationGroup duplicationGroup) {
     public String getDescription(final Issue issue) {
         return getDuplicateCode(issue.getAdditionalProperties());
     }
+
+    @Override
+    public Type getType() {
+        return Type.DUPLICATION;
+    }
 }
diff --git a/src/main/java/edu/hm/hafner/analysis/registry/ErrorProneDescriptor.java b/src/main/java/edu/hm/hafner/analysis/registry/ErrorProneDescriptor.java
@@ -28,4 +28,9 @@ protected Collection<? extends IssueParser> createParsers() {
     public String getUrl() {
         return "https://errorprone.info";
     }
+
+    @Override
+    public Type getType() {
+        return Type.BUG;
+    }
 }
diff --git a/src/main/java/edu/hm/hafner/analysis/registry/FindBugsDescriptor.java b/src/main/java/edu/hm/hafner/analysis/registry/FindBugsDescriptor.java
@@ -49,4 +49,9 @@ public String getPattern() {
     public String getDescription(final Issue issue) {
         return messages.get().getMessage(issue.getType());
     }
+
+    @Override
+    public Type getType() {
+        return Type.BUG;
+    }
 }
diff --git a/src/main/java/edu/hm/hafner/analysis/registry/FlawfinderDescriptor.java b/src/main/java/edu/hm/hafner/analysis/registry/FlawfinderDescriptor.java
@@ -30,4 +30,9 @@ public String getHelp() {
     public String getUrl() {
         return "https://dwheeler.com/flawfinder/";
     }
+
+    @Override
+    public Type getType() {
+        return Type.VULNERABILITY;
+    }
 }
diff --git a/src/main/java/edu/hm/hafner/analysis/registry/OwaspDependencyCheckDescriptor.java b/src/main/java/edu/hm/hafner/analysis/registry/OwaspDependencyCheckDescriptor.java
@@ -33,4 +33,9 @@ public String getUrl() {
     public String getIconUrl() {
         return "https://raw.githubusercontent.com/jeremylong/DependencyCheck/main/src/site/resources/images/logo.svg";
     }
+
+    @Override
+    public Type getType() {
+        return Type.VULNERABILITY;
+    }
 }
diff --git a/src/main/java/edu/hm/hafner/analysis/registry/ParserDescriptor.java b/src/main/java/edu/hm/hafner/analysis/registry/ParserDescriptor.java
@@ -47,6 +47,16 @@ public String getName() {
         return name;
     }
 
+    /**
+     * Returns the type of the parser. The type is used to customize parsers in the UI.
+     * This default implementation returns {@link Type#WARNING}.
+     *
+     * @return the type of the parser
+     */
+    public Type getType() {
+        return Type.WARNING;
+    }
+
     /**
      * Creates a new {@link IssueParser} instance.
      *
@@ -138,7 +148,9 @@ public enum Type {
         /** A parser that scans the output of a build tool to find bugs. */
         BUG,
         /** A parser that scans the output of a build tool to find vulnerabilities. */
-        VULNERABILITY
+        VULNERABILITY,
+        /** A parser that scans the output of a build tool to find vulnerabilities. */
+        DUPLICATION
     }
 
     /**

diff --git a/src/main/java/edu/hm/hafner/analysis/registry/PnpmAuditDescriptor.java b/src/main/java/edu/hm/hafner/analysis/registry/PnpmAuditDescriptor.java
@@ -41,4 +41,9 @@ public String getUrl() {
     public String getIconUrl() {
         return "https://pnpm.io/img/pnpm-no-name-with-frame.svg";
     }
+
+    @Override
+    public Type getType() {
+        return Type.VULNERABILITY;
+    }
 }
diff --git a/src/main/java/edu/hm/hafner/analysis/registry/SemgrepDescriptor.java b/src/main/java/edu/hm/hafner/analysis/registry/SemgrepDescriptor.java
@@ -35,4 +35,9 @@ public String getUrl() {
     public String getIconUrl() {
         return "https://raw.githubusercontent.com/returntocorp/semgrep/develop/semgrep.svg";
     }
+
+    @Override
+    public Type getType() {
+        return Type.VULNERABILITY;
+    }
 }
diff --git a/src/main/java/edu/hm/hafner/analysis/registry/SpotBugsDescriptor.java b/src/main/java/edu/hm/hafner/analysis/registry/SpotBugsDescriptor.java
@@ -27,4 +27,9 @@ public String getUrl() {
     public String getIconUrl() {
         return "https://raw.githubusercontent.com/spotbugs/spotbugs.github.io/master/images/logos/spotbugs_icon_only_zoom_256px.png";
     }
+
+    @Override
+    public Type getType() {
+        return Type.BUG;
+    }
 }
diff --git a/src/main/java/edu/hm/hafner/analysis/registry/TrivyDescriptor.java b/src/main/java/edu/hm/hafner/analysis/registry/TrivyDescriptor.java
@@ -41,4 +41,9 @@ public String getUrl() {
     public String getIconUrl() {
         return "https://github.com/aquasecurity/trivy/blob/main/docs/imgs/logo.png?raw=true";
     }
+
+    @Override
+    public Type getType() {
+        return Type.VULNERABILITY;
+    }
 }
diff --git a/src/main/java/edu/hm/hafner/analysis/registry/YoctoScannerDescriptor.java b/src/main/java/edu/hm/hafner/analysis/registry/YoctoScannerDescriptor.java
@@ -41,4 +41,9 @@ public String getUrl() {
     public String getIconUrl() {
         return "https://upload.wikimedia.org/wikipedia/commons/0/00/Yocto_Project_logo.svg";
     }
+
+    @Override
+    public Type getType() {
+        return Type.VULNERABILITY;
+    }
 }
diff --git a/src/main/java/edu/hm/hafner/analysis/registry/ZptLintDescriptor.java b/src/main/java/edu/hm/hafner/analysis/registry/ZptLintDescriptor.java
@@ -4,7 +4,7 @@
 import edu.hm.hafner.analysis.parser.violations.ZptLintAdapter;
 
 /**
- * A descriptor for the Yui Compressor parser.
+ * A descriptor for the ZPT Lint parser.
  *
  * @author Lorenz Munsch
  */

diff --git a/src/test/java/edu/hm/hafner/analysis/registry/ParserRegistryTest.java b/src/test/java/edu/hm/hafner/analysis/registry/ParserRegistryTest.java
@@ -10,6 +10,7 @@
 import edu.hm.hafner.analysis.Report;
 import edu.hm.hafner.analysis.Severity;
 import edu.hm.hafner.analysis.registry.ParserDescriptor.Option;
+import edu.hm.hafner.analysis.registry.ParserDescriptor.Type;
 import edu.hm.hafner.util.ResourceTest;
 
 import static edu.hm.hafner.analysis.assertions.Assertions.*;
@@ -37,7 +38,8 @@ void shouldFindSomeParsers() {
         var parserRegistry = new ParserRegistry();
 
         assertThat(parserRegistry).hasIds(SPOTBUGS, CHECKSTYLE, PMD).hasNames("SpotBugs", "CheckStyle", "PMD");
-        assertThat(parserRegistry.get(SPOTBUGS)).hasId(SPOTBUGS).hasName("SpotBugs");
+        assertThat(parserRegistry.get(SPOTBUGS)).hasId(SPOTBUGS).hasName("SpotBugs").hasType(Type.BUG);
+        assertThat(parserRegistry.get("owasp-dependency-check")).hasName("OWASP Dependency Check").hasType(Type.VULNERABILITY);
         assertThat(parserRegistry.contains(SPOTBUGS)).isTrue();
         assertThat(parserRegistry.contains("nothing")).isFalse();
         List<ParserDescriptor> descriptors = parserRegistry.getAllDescriptors();
@@ -49,6 +51,7 @@ void shouldFindSomeParsers() {
     void shouldConfigureCpdParser() {
         var parserRegistry = new ParserRegistry();
         var cpdDescriptor = parserRegistry.get("cpd");
+        assertThat(cpdDescriptor).hasType(Type.DUPLICATION).hasName("CPD");
 
         IssueParser parser = cpdDescriptor.createParser();