feat: allow stack trace suppression (#266) (#275)

* feat: allow stack trace suppression (#266) * feat: addressed review comments
spotbugs · Jun 18, 2020 · 2c7e412 · 2c7e412
1 parent b6a6d92
commit 2c7e412
Show file tree

Hide file tree

Showing 6 changed files with 67 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -33,6 +33,7 @@ Configure `spotbugs` extension to configure the behaviour of tasks:
 ```groovy
 spotbugs {
     ignoreFailures = false
+    showStackTraces = true
     showProgress = true
     effort = 'default'
     reportLevel = 'default'

diff --git a/src/functionalTest/groovy/com/github/spotbugs/snom/StandardFunctionalTest.groovy b/src/functionalTest/groovy/com/github/spotbugs/snom/StandardFunctionalTest.groovy
@@ -251,6 +251,44 @@ spotbugs {
 
         then:
         result.task(':spotbugsMain').outcome == TaskOutcome.SUCCESS
+        result.output.contains('\tat ')
+
+        where:
+        isWorkerApi << [true, false]
+    }
+
+    @Unroll
+    def 'build does not show stack traces when bugs are found with `showStacktraces = false` (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()
+
+        buildFile << """
+spotbugs {
+    ignoreFailures = true
+    showStackTraces = false
+}"""
+        when:
+        def arguments = [':spotbugsMain', '-is']
+        if(!isWorkerApi) {
+            arguments.add('-Pcom.github.spotbugs.snom.worker=false')
+        }
+        def runner = GradleRunner.create()
+                .withProjectDir(rootDir)
+                .withArguments(arguments)
+                .withPluginClasspath()
+                .forwardOutput()
+                .withGradleVersion(version)
+
+        def result = runner. build()
+
+        then:
+        result.task(':spotbugsMain').outcome == TaskOutcome.SUCCESS
+        !(result.output.contains('\tat '))
 
         where:
         isWorkerApi << [true, false]

diff --git a/src/main/groovy/com/github/spotbugs/snom/SpotBugsExtension.groovy b/src/main/groovy/com/github/spotbugs/snom/SpotBugsExtension.groovy
@@ -34,6 +34,7 @@ import org.gradle.api.provider.Property;
  * <p>After you apply the SpotBugs Gradle plugin to project, write extension like below:<div><code>
  * spotbugs {<br>
  * &nbsp;&nbsp;&nbsp;&nbsp;ignoreFailures = false<br>
+ * &nbsp;&nbsp;&nbsp;&nbsp;showStackTraces = true<br>
  * &nbsp;&nbsp;&nbsp;&nbsp;showProgress = false<br>
  * &nbsp;&nbsp;&nbsp;&nbsp;reportLevel = 'default'<br>
  * &nbsp;&nbsp;&nbsp;&nbsp;effort = 'default'<br>
@@ -57,6 +58,8 @@ class SpotBugsExtension {
 
     @NonNull
     final Property<Boolean> ignoreFailures;
+    @NonNull
+    final Property<Boolean> showStackTraces;
     /**
      * Property to enable progress reporting during the analysis. Default value is {@code false}.
      */
@@ -150,6 +153,7 @@ class SpotBugsExtension {
     @Inject
     SpotBugsExtension(Project project, ObjectFactory objects) {
         ignoreFailures = objects.property(Boolean).convention(false);
+        showStackTraces = objects.property(Boolean).convention(true);
         showProgress = objects.property(Boolean);
         reportLevel = objects.property(Confidence);
         effort = objects.property(Effort);

diff --git a/src/main/groovy/com/github/spotbugs/snom/SpotBugsTask.groovy b/src/main/groovy/com/github/spotbugs/snom/SpotBugsTask.groovy
@@ -65,6 +65,7 @@ import javax.inject.Inject
  * &nbsp;&nbsp;&nbsp;&nbsp;auxClassPaths = sourceSets.main.compileClasspath<br>
  * <br>
  * &nbsp;&nbsp;&nbsp;&nbsp;ignoreFailures = false<br>
+ * &nbsp;&nbsp;&nbsp;&nbsp;showStackTraces = true<br>
  * &nbsp;&nbsp;&nbsp;&nbsp;showProgress = false<br>
  * &nbsp;&nbsp;&nbsp;&nbsp;reportLevel = 'default'<br>
  * &nbsp;&nbsp;&nbsp;&nbsp;effort = 'default'<br>
@@ -92,6 +93,7 @@ class SpotBugsTask extends DefaultTask implements VerificationTask {
     private final WorkerExecutor workerExecutor;
 
     @NonNull final Property<Boolean> ignoreFailures;
+    @NonNull final Property<Boolean> showStackTraces;
     /**
      * Property to enable progress reporting during the analysis. Default value is {@code false}.
      */
@@ -279,6 +281,7 @@ class SpotBugsTask extends DefaultTask implements VerificationTask {
         sourceDirs = objects.fileCollection()
         auxClassPaths = objects.fileCollection()
         ignoreFailures = objects.property(Boolean)
+        showStackTraces = objects.property(Boolean)
         showProgress = objects.property(Boolean);
         reportLevel = objects.property(Confidence);
         effort = objects.property(Effort);
@@ -318,6 +321,7 @@ class SpotBugsTask extends DefaultTask implements VerificationTask {
      */
     void init(SpotBugsExtension extension) {
         ignoreFailures.convention(extension.ignoreFailures)
+        showStackTraces.convention(extension.showStackTraces)
         showProgress.convention(extension.showProgress)
         reportLevel.convention(extension.reportLevel)
         effort.convention(extension.effort)
@@ -410,11 +414,24 @@ class SpotBugsTask extends DefaultTask implements VerificationTask {
         ignoreFailures.set(b);
     }
 
+    void setShowStackTraces(Provider<Boolean> b) {
+        showStackTraces.set(b);
+    }
+
+    void setShowStackTraces(boolean b) {
+        showStackTraces.set(b)
+    }
+
     @Input
     boolean getIgnoreFailures() {
         ignoreFailures.get();
     }
 
+    @Input
+    boolean getShowStackTraces() {
+        showStackTraces.get();
+    }
+
     @Internal
     String getBaseName() {
         String prunedName = name.replaceFirst("spotbugs", "")

diff --git a/src/main/groovy/com/github/spotbugs/snom/internal/SpotBugsRunnerForJavaExec.java b/src/main/groovy/com/github/spotbugs/snom/internal/SpotBugsRunnerForJavaExec.java
@@ -36,7 +36,7 @@ public void run(@NonNull SpotBugsTask task) {
       task.getProject().javaexec(configureJavaExec(task)).rethrowFailure().assertNormalExitValue();
     } catch (ExecException e) {
       if (task.getIgnoreFailures()) {
-        log.warn("SpotBugs reported failures", e);
+        log.warn("SpotBugs reported failures", task.getShowStackTraces() ? e : null);
       } else {
         String errorMessage = "Verification failed: SpotBugs execution thrown exception.";
         List<String> reportPaths =

diff --git a/src/main/groovy/com/github/spotbugs/snom/internal/SpotBugsRunnerForWorker.java b/src/main/groovy/com/github/spotbugs/snom/internal/SpotBugsRunnerForWorker.java
@@ -67,13 +67,16 @@ private Action<SpotBugsWorkParameters> configureWorkParameters(SpotBugsTask task
     return params -> {
       params.getArguments().addAll(buildArguments(task));
       params.getIgnoreFailures().set(task.getIgnoreFailures());
+      params.getShowStackTraces().set(task.getShowStackTraces());
     };
   }
 
   interface SpotBugsWorkParameters extends WorkParameters {
     ListProperty<String> getArguments();
 
     Property<Boolean> getIgnoreFailures();
+
+    Property<Boolean> getShowStackTraces();
   }
 
   public abstract static class SpotBugsExecutor implements WorkAction<SpotBugsWorkParameters> {
@@ -107,7 +110,9 @@ public void execute() {
         }
       } catch (GradleException e) {
         if (params.getIgnoreFailures().getOrElse(Boolean.FALSE).booleanValue()) {
-          log.warn("SpotBugs reported failures", e);
+          final boolean showStackTraces =
+              params.getShowStackTraces().getOrElse(Boolean.TRUE).booleanValue();
+          log.warn("SpotBugs reported failures", showStackTraces ? e : null);
         } else {
           throw e;
         }