Merge pull request #140 from jborgers/master

Deal properly with PMD processing errors, including NullPointerExceptions from PMD

Author: amitdev

src/main/java/com/intellij/plugins/bodhi/pmd/PMDInvoker.java

@@ -160,6 +160,7 @@ public void run() {
                 PMDResultPanel resultPanel = projectComponent.getResultPanel();
 
                 PMDRootNode rootNode = resultPanel.getRootNode();
+                resultPanel.createProcessingErrorNode();
                 PMDResultCollector.clearReport();
                 rootNode.setFileCount(files.size());
                 rootNode.setRuleSetCount(ruleSetPathArray.length);

src/main/java/com/intellij/plugins/bodhi/pmd/PMDResultPanel.java

@@ -431,11 +431,18 @@ public PMDRootNode getRootNode() {
     }
 
     /**
-     * Creates and returns the processingErrors branch node.
+     * Returns the single processingErrors branch node. Created if needed.
      *
-     * @return the new processingErrors branch node
+     * @return the processingErrors branch node
      */
-    public PMDErrorBranchNode getNewProcessingErrorsNode() {
+    public PMDErrorBranchNode getProcessingErrorsNode() {
+        if (processingErrorsNode == null) {
+            createProcessingErrorNode();
+        }
+        return processingErrorsNode;
+    }
+
+    public PMDErrorBranchNode createProcessingErrorNode() {
         processingErrorsNode = new PMDErrorBranchNode("Processing errors");
         return processingErrorsNode;
     }

src/main/java/com/intellij/plugins/bodhi/pmd/core/PMDProcessingError.java

@@ -18,19 +18,22 @@ public class PMDProcessingError implements HasPositionInFile {
 
     public PMDProcessingError(Report.ProcessingError error) {
         processingError = error;
-        String causeDetailMsg = error.getError().getCause().getMessage();
-        // assumes format by PMD: 'Line \d+, Column \d+:'
-        int atLinePos = causeDetailMsg.indexOf("Line ");
-        int columnPos = causeDetailMsg.indexOf(", Column ");
-        int colonPos = causeDetailMsg.indexOf(":", columnPos);
-        if (atLinePos > -1 && columnPos > atLinePos && colonPos > columnPos) {
-            try {
-                String line = causeDetailMsg.substring(atLinePos + 5, columnPos);
-                String col = causeDetailMsg.substring(columnPos + 9, colonPos);
-                beginLine = Integer.parseInt(line);
-                beginColumn = Integer.parseInt(col);
-            }
-            catch(NumberFormatException | StringIndexOutOfBoundsException e) { // no beginLine, beginColumn
+        Throwable cause = error.getError().getCause(); // fix #137
+        if (cause != null) {
+            String causeDetailMsg = cause.getMessage();
+            // assumes format by PMD: 'Line \d+, Column \d+:'
+            int atLinePos = causeDetailMsg.indexOf("Line ");
+            int columnPos = causeDetailMsg.indexOf(", Column ");
+            int colonPos = causeDetailMsg.indexOf(":", columnPos);
+            if (atLinePos > -1 && columnPos > atLinePos && colonPos > columnPos) {
+                try {
+                    String line = causeDetailMsg.substring(atLinePos + 5, columnPos);
+                    String col = causeDetailMsg.substring(columnPos + 9, colonPos);
+                    beginLine = Integer.parseInt(line);
+                    beginColumn = Integer.parseInt(col);
+                }
+                catch(NumberFormatException | StringIndexOutOfBoundsException e) { // no beginLine, beginColumn
+                }
             }
         }
         positionText = "(" + beginLine + ", " + beginColumn + ") ";
@@ -41,7 +44,14 @@ public PMDProcessingError(Report.ProcessingError error) {
      * @return the simple class name and the throwable detail message.
      */
     public String getMsg() {
-        return processingError.getMsg();
+        // PMDException (deprecated) has a cause
+        Throwable error = processingError.getError();
+        if (error.getCause() != null) {
+            // a proper PMDException indicating for instance wrong java version
+            return processingError.getMsg(); // error class simple name and message
+        }
+        // error in PMD, for instance a NullPointerException, build our own message
+        return error.getClass().getSimpleName() + ": Error while parsing " + processingError.getFile();
     }
 
     /**
@@ -73,11 +83,20 @@ public Throwable getError() {
      * Returns the detail message of the cause of this throwable or {@code null} if the
      * cause is nonexistent or unknown.  (The cause is the throwable that
      * caused this throwable to get thrown.)
-     * @return the detail mesage of the cause throwable.
+     * When cause == null, it returns throw location of the throwable itself.
+     * @return the detail message of the cause throwable.
      */
     public String getCauseMsg() {
-        return processingError.getError().getCause().getMessage();
-    }
+        Throwable error = processingError.getError();
+        Throwable cause = error.getCause();
+        if (cause != null) {
+            return cause.getMessage();
+        }
+        else {
+            // if no cause, it may be a bug in PMD, get first stack element
+            return error.getStackTrace()[0].toString();
+        }
+      }
 
     /**
      * Returns the position text to render.

src/main/java/com/intellij/plugins/bodhi/pmd/core/PMDResultAsTreeRenderer.java

@@ -26,7 +26,6 @@ public class PMDResultAsTreeRenderer extends AbstractIncrementingRenderer {
     private static final Log log = LogFactory.getLog(PMDResultAsTreeRenderer.class);
     private final List<PMDRuleSetEntryNode> pmdRuleResultNodes;
     private final PMDErrorBranchNode processingErrorsNode;
-    private final Set<String> filesWithError = new HashSet<>();
     private final UselessSuppressionsHelper uselessSupHelper;
     private final Map<RuleKey, PMDRuleNode> ruleKeyToNodeMap = new TreeMap<>(); // order by priority and then name
 
@@ -72,9 +71,9 @@ private void renderErrors() {
             PMDTreeNodeFactory nodeFactory = PMDTreeNodeFactory.getInstance();
             for (Report.ProcessingError error : errors) {
                 try {
-                    if (!filesWithError.contains(error.getFile())) {
+                    if (!processingErrorsNode.hasFile(error.getFile())) {
                         processingErrorsNode.add(nodeFactory.createErrorLeafNode(new PMDProcessingError(error)));
-                        filesWithError.add(error.getFile());
+                        processingErrorsNode.registerFile(error.getFile());
                     }
                 }
                 catch(Exception e) {

src/main/java/com/intellij/plugins/bodhi/pmd/core/PMDResultCollector.java

@@ -68,7 +68,7 @@ public List<PMDRuleSetEntryNode> runPMDAndGetResults(List<File> files, String ru
         try {
             PMDConfiguration pmdConfig = getPmdConfig(ruleSetPath, options, project);
 
-            PMDErrorBranchNode errorsNode = comp.getResultPanel().getNewProcessingErrorsNode();
+            PMDErrorBranchNode errorsNode = comp.getResultPanel().getProcessingErrorsNode();
             PMDResultAsTreeRenderer treeRenderer = new PMDResultAsTreeRenderer(pmdRuleSetResults, errorsNode, ruleSetPath);
             treeRenderer.setWriter(IOUtil.createWriter(pmdConfig.getReportFile()));
             treeRenderer.start();
@@ -95,7 +95,7 @@ public List<PMDRuleSetEntryNode> runPMDAndGetResults(List<File> files, String ru
         return pmdRuleSetResults;
     }
 
-    private PMDJsonExportingRenderer addExportRenderer(Map<String, String> options) throws IOException {
+    private PMDJsonExportingRenderer addExportRenderer(Map<String, String> options) {
         PMDJsonExportingRenderer exportingRenderer = null;
         String exportUrlFromForm = options.get(PMDConfigurationForm.STATISTICS_URL);
         boolean exportStats = (PMDUtil.isValidUrl(exportUrlFromForm));

src/main/java/com/intellij/plugins/bodhi/pmd/tree/PMDErrorBranchNode.java

@@ -1,15 +1,29 @@
 package com.intellij.plugins.bodhi.pmd.tree;
 
+import java.util.HashSet;
+import java.util.Set;
+
 /**
  * PMD branch tree node for processing errors. It has a Severity.BLOCKER icon.
+ * It registers files with errors in order to limit the number of errors per file to 1.
  *
  * @author jborgers
  */
 public class PMDErrorBranchNode extends PMDBranchNode {
+
+    private final Set<String> filesWithError = new HashSet<>();
+
     public PMDErrorBranchNode(String name) {
         super(name);
     }
 
+    public boolean hasFile(String file) {
+        return filesWithError.contains(file);
+    }
+
+    public void registerFile(String file) {
+        filesWithError.add(file);
+    }
     @Override
     public synchronized void render(PMDCellRenderer cellRenderer, boolean expanded) {
         cellRenderer.setIcon(Severity.BLOCKER.getIcon());

src/main/java/com/intellij/plugins/bodhi/pmd/tree/PMDErrorNode.java

@@ -27,7 +27,7 @@ public void render(PMDCellRenderer cellRenderer, boolean expanded) {
         cellRenderer.setIcon(Severity.BLOCKER.getIcon());
         // Show error position greyed, like idea shows.
         cellRenderer.append(pmdProcessingError.getPositionText(), GRAYED_ATTRIBUTES);
-        cellRenderer.append(pmdProcessingError.getErrorMsg()); // includes file name
+        cellRenderer.append(pmdProcessingError.getMsg()); // includes simple class and file name
     }
 
     @Override