lint w/Spotbugs

Author: slominskir

build.gradle

@@ -1,7 +1,10 @@
+import com.github.spotbugs.snom.SpotBugsTask
+
 plugins {
     id 'war'
     id "com.diffplug.spotless" version "7.2.1"
     id 'pmd'
+    id 'com.github.spotbugs' version '6.5.6'
 }
 description = 'Application Registry Manager app'
 group = 'org.jlab'
@@ -67,4 +70,32 @@ pmd {
     // category/java/performance.xml
     // category/java/multithreading.xml
     // category/java/design.xml
+}
+spotbugs {
+    excludeFilter = file("spotbugs-exclude.xml")
+    showProgress = true
+
+    // Allows the build to proceed to custom conditional throw
+    ignoreFailures = true
+}
+tasks.spotbugsMain {
+    reports.create("html") {
+        required = true
+        outputLocation = file("$buildDir/reports/spotbugs.html")
+        stylesheet = "fancy-hist.xsl"
+    }
+    reports.create("text") {
+        required = true
+        outputLocation = file("$buildDir/reports/spotbugs.text")
+    }
+}
+tasks.withType(SpotBugsTask).configureEach {
+    doLast {
+        def reportFile = reports.text.outputLocation.asFile.get()
+        if (reportFile.exists() && reportFile.length() > 0) {
+            logger.lifecycle("\n[SpotBugs Console Stream]\n" + reportFile.text)
+            // Manually break the build here so fails AFTER logging to stdout for CI
+            throw new GradleException("SpotBugs violations found. Check the console log above.")
+        }
+    }
 }

spotbugs-exclude.xml

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<FindBugsFilter>
+    <Match>
+        <!-- @EJB Injected false positive -->
+        <Bug pattern="SE_BAD_FIELD" />
+        <Or>
+            <Class name="org.jlab.sim.presentation.controller.ajax.AddSoftware"/>
+            <Class name="org.jlab.sim.presentation.controller.ajax.EditSoftware"/>
+            <Class name="org.jlab.sim.presentation.controller.ajax.EditSoftwareRisk"/>
+            <Class name="org.jlab.sim.presentation.controller.ajax.RemoveSoftware"/>
+            <Class name="org.jlab.sim.presentation.controller.Directory"/>
+            <Class name="org.jlab.sim.presentation.controller.Repositories"/>
+            <Class name="org.jlab.sim.presentation.controller.Sync"/>
+        </Or>
+    </Match>
+    <Match>
+        <!-- @Entity objects composed of other entities false positive -->
+        <Or>
+            <Bug pattern="EI_EXPOSE_REP" />
+            <Bug pattern="EI_EXPOSE_REP2" />
+        </Or>
+        <Or>
+            <Class name="org.jlab.sim.persistence.entity.Software"/>
+            <Class name="org.jlab.sim.persistence.entity.SoftwareTopic"/>
+        </Or>
+    </Match>
+</FindBugsFilter>

src/main/java/org/jlab/sim/business/service/SyncService.java

@@ -156,7 +156,9 @@ private PaginatedResult paginatedGitLabQuery(String url, Repository repository)
         throw new UserFriendlyException("Could not parse JSON", e);
       }
     } else {
-      throw new UserFriendlyException("Request failed with status code: " + response.statusCode());
+      throw new UserFriendlyException(
+          "Request failed with status code: "
+              + (response == null ? "NONE" : response.statusCode()));
     }
 
     return new PaginatedResult(softwareList, nextUrl);
@@ -294,7 +296,9 @@ private PaginatedResult paginatedGitHubQuery(String url, Repository repository)
         throw new UserFriendlyException("Could not parse JSON", e);
       }
     } else {
-      throw new UserFriendlyException("Request failed with status code: " + response.statusCode());
+      throw new UserFriendlyException(
+          "Request failed with status code: "
+              + (response == null ? "NONE" : response.statusCode()));
     }
 
     return new PaginatedResult(softwareList, nextUrl);
@@ -317,16 +321,18 @@ private List<Software> fetchGitHub(Repository repository) throws UserFriendlyExc
   }
 
   private SoftwareType getFromTopicList(List<String> topicList) {
-    SoftwareType type = SoftwareType.APP;
+    SoftwareType type;
 
     if (topicList.contains("app")) {
-      // break out of if/else
+      type = SoftwareType.APP;
     } else if (topicList.contains("lib")) {
       type = SoftwareType.LIB;
     } else if (topicList.contains("script")) {
       type = SoftwareType.SCRIPT;
     } else if (topicList.contains("plugin")) {
       type = SoftwareType.PLUGIN;
+    } else {
+      throw new IllegalArgumentException("Unknown type");
     }
 
     return type;
@@ -351,10 +357,18 @@ private List<Software> fetchCSUE(Repository repository) throws UserFriendlyExcep
 
         final int NUM_COLUMNS = 5;
         if (cells.size() == NUM_COLUMNS) {
-          Element a = cells.first().select("a").first();
-          String name = a.text();
-          Attributes attributes = a.attributes();
-          String homeUrl = BASE_URL + attributes.get("href");
+          String name = "";
+          String homeUrl = "";
+          Element first = cells.first();
+          if (first != null) {
+            Element a = first.select("a").first();
+            if (a != null) {
+              name = a.text();
+              Attributes attributes = a.attributes();
+              homeUrl = BASE_URL + attributes.get("href");
+            }
+          }
+
           String maintainerUsernameCsv = cells.get(3).text();
           String description = cells.get(4).text();
 
@@ -410,10 +424,17 @@ private List<Software> fetchCertifiedType(Repository repository, String param, S
 
         final int NUM_COLUMNS = 2;
         if (cells.size() == NUM_COLUMNS) {
-          Element a = cells.first().select("a").first();
-          String name = a.text();
-          Attributes attributes = a.attributes();
-          String homeUrl = BASE_URL + attributes.get("href");
+          String name = "";
+          String homeUrl = "";
+          Element first = cells.first();
+          if (first != null) {
+            Element a = first.select("a").first();
+            if (a != null) {
+              name = a.text();
+              Attributes attributes = a.attributes();
+              homeUrl = BASE_URL + attributes.get("href");
+            }
+          }
           String maintainerUsernameCsv = null;
           String description = cells.get(1).text();
 
@@ -480,7 +501,9 @@ private List<Software> fetchLLAPP(Repository repository) throws UserFriendlyExce
         }
       }
     } else {
-      throw new UserFriendlyException("Request failed with status code: " + response.statusCode());
+      throw new UserFriendlyException(
+          "Request failed with status code: "
+              + (response == null ? "NONE" : response.statusCode()));
     }
 
     return softwareList;

src/main/java/org/jlab/sim/presentation/controller/Directory.java

@@ -138,7 +138,7 @@ private String createSelectionMessage(
       Include includeArchived) {
     DecimalFormat formatter = new DecimalFormat("###,###");
 
-    String selectionMessage = "All Software ";
+    StringBuilder selectionMessage = new StringBuilder("All Software ");
 
     List<String> filters = new ArrayList<>();
 
@@ -167,29 +167,30 @@ private String createSelectionMessage(
     }
 
     if (!filters.isEmpty()) {
-      selectionMessage = filters.get(0);
+      selectionMessage = new StringBuilder(filters.get(0));
 
       for (int i = 1; i < filters.size(); i++) {
         String filter = filters.get(i);
-        selectionMessage += " and " + filter;
+        selectionMessage.append(" and ").append(filter);
       }
     }
 
     if (paginator.getTotalRecords() < paginator.getMaxPerPage() && paginator.getOffset() == 0) {
-      selectionMessage =
-          selectionMessage + " {" + formatter.format(paginator.getTotalRecords()) + "}";
+      selectionMessage
+          .append(" {")
+          .append(formatter.format(paginator.getTotalRecords()))
+          .append("}");
     } else {
-      selectionMessage =
-          selectionMessage
-              + " {"
-              + formatter.format(paginator.getStartNumber())
-              + " - "
-              + formatter.format(paginator.getEndNumber())
-              + " of "
-              + formatter.format(paginator.getTotalRecords())
-              + "}";
+      selectionMessage
+          .append(" {")
+          .append(formatter.format(paginator.getStartNumber()))
+          .append(" - ")
+          .append(formatter.format(paginator.getEndNumber()))
+          .append(" of ")
+          .append(formatter.format(paginator.getTotalRecords()))
+          .append("}");
     }
 
-    return selectionMessage;
+    return selectionMessage.toString();
   }
 }