feat: show spotbugs report full path when spotbugs execution fails (#246)

* feat: show spotbugs report full path when spotbugs execution fails

* Update src/main/groovy/com/github/spotbugs/snom/internal/SpotBugsRunnerForWorker.java

Co-authored-by: wreulicke <[email protected]>

* Update src/main/groovy/com/github/spotbugs/snom/internal/SpotBugsRunnerForWorker.java

Co-authored-by: wreulicke <[email protected]>

Co-authored-by: wreulicke <[email protected]>

Author: rpalcolea

src/functionalTest/groovy/com/github/spotbugs/snom/StandardFunctionalTest.groovy

@@ -451,4 +451,38 @@ public class FooTest {
         result.output.contains("Applying com.h3xstream.findsecbugs.PredictableRandomDetector to FooTest")
         !result.output.contains("Trying to add already registered factory")
     }
+
+    @Unroll
+    def 'shows report path when failures are found (Worker API? #isWorkerApi)'() {
+        given:
+        def badCode = new File(rootDir, 'src/main/java/Bar.java')
+        badCode << '''
+        |public class Bar {
+        |  public int unreadField = 42; // warning: URF_UNREAD_FIELD
+        |}
+        |'''.stripMargin()
+
+        when:
+        def arguments = [':spotbugsMain']
+        if(!isWorkerApi) {
+            arguments.add('-Pcom.github.spotbugs.snom.worker=false')
+        }
+        def runner = GradleRunner.create()
+                .withProjectDir(rootDir)
+                .withArguments(arguments)
+                .withPluginClasspath()
+                .forwardOutput()
+                .withGradleVersion(version)
+                .withDebug(true)
+
+        def result = runner.buildAndFail()
+
+        then:
+        result.task(':spotbugsMain').outcome == TaskOutcome.FAILED
+        result.output.contains('SpotBugs report can be found in')
+        result.output.contains('build/reports/spotbugs/main.xml')
+
+        where:
+        isWorkerApi << [true, false]
+    }
 }

src/main/groovy/com/github/spotbugs/snom/internal/SpotBugsRunnerForJavaExec.java

@@ -15,8 +15,10 @@
 
 import com.github.spotbugs.snom.SpotBugsTask;
 import edu.umd.cs.findbugs.annotations.NonNull;
+import java.io.File;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.stream.Collectors;
 import org.gradle.api.Action;
 import org.gradle.api.GradleException;
 import org.gradle.process.JavaExecSpec;
@@ -36,7 +38,15 @@ public void run(@NonNull SpotBugsTask task) {
       if (task.getIgnoreFailures()) {
         log.warn("SpotBugs reported failures", e);
       } else {
-        throw new GradleException("Verification failed: SpotBugs execution thrown exception", e);
+        String errorMessage = "Verification failed: SpotBugs execution thrown exception.";
+        List<String> reportPaths =
+            task.getReportsDir().getAsFileTree().getFiles().stream()
+                .map(File::getAbsolutePath)
+                .collect(Collectors.toList());
+        if (!reportPaths.isEmpty()) {
+          errorMessage += "SpotBugs report can be found in " + String.join(",", reportPaths);
+        }
+        throw new GradleException(errorMessage, e);
       }
     }
   }

src/main/groovy/com/github/spotbugs/snom/internal/SpotBugsRunnerForWorker.java

@@ -19,6 +19,7 @@
 import edu.umd.cs.findbugs.FindBugs2;
 import edu.umd.cs.findbugs.TextUICommandLine;
 import edu.umd.cs.findbugs.annotations.NonNull;
+import java.util.List;
 import java.util.Objects;
 import org.gradle.api.Action;
 import org.gradle.api.GradleException;
@@ -91,18 +92,36 @@ public void execute() {
           findBugs2.execute();
           if (findBugs2.getErrorCount() > 0) {
             throw new GradleException(
-                "Verification failed: SpotBugs error found: " + findBugs2.getErrorCount());
+                "Verification failed: SpotBugs error found: "
+                    + findBugs2.getErrorCount()
+                    + ". SpotBugs report can be found in "
+                    + findReportPath());
           } else if (findBugs2.getBugCount() > 0) {
             throw new GradleException(
-                "Verification failed: SpotBugs violation found: " + findBugs2.getBugCount());
+                "Verification failed: SpotBugs violation found: "
+                    + findBugs2.getBugCount()
+                    + ". SpotBugs report can be found in "
+                    + findReportPath());
           }
         }
-      } catch (Exception e) {
+      } catch (GradleException e) {
         if (params.getIgnoreFailures().getOrElse(Boolean.FALSE).booleanValue()) {
           log.warn("SpotBugs reported failures", e);
         } else {
-          throw new GradleException("Verification failed: SpotBugs execution thrown exception", e);
+          throw e;
         }
+      } catch (Exception e) {
+        throw new GradleException("Verification failed: SpotBugs execution thrown exception", e);
+      }
+    }
+
+    private String findReportPath() {
+      List<String> arguments = getParameters().getArguments().get();
+      int outputFileParameterIndex = arguments.indexOf("-outputFile");
+      if (outputFileParameterIndex > 0) {
+        return arguments.get(outputFileParameterIndex + 1);
+      } else {
+        return null;
       }
     }
   }