[JENKINS-51675] Publish SpotBugs reports

jenkinsci · Jun 4, 2018 · 8d59a29 · 8d59a29
1 parent bde7e05
commit 8d59a29
Show file tree

Hide file tree

Showing 5 changed files with 478 additions and 0 deletions.
diff --git a/.../main/java/org/jenkinsci/plugins/pipeline/maven/publishers/SpotBugsAnalysisPublisher.java b/.../main/java/org/jenkinsci/plugins/pipeline/maven/publishers/SpotBugsAnalysisPublisher.java
@@ -0,0 +1,268 @@
+/*
+ * The MIT License
+ *
+ * Copyright (c) 2016, CloudBees, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+package org.jenkinsci.plugins.pipeline.maven.publishers;
+
+import hudson.Extension;
+import hudson.FilePath;
+import hudson.Launcher;
+import hudson.model.Run;
+import hudson.model.StreamBuildListener;
+import hudson.model.TaskListener;
+import hudson.plugins.findbugs.FindBugsPublisher;
+import org.jenkinsci.Symbol;
+import org.jenkinsci.plugins.pipeline.maven.MavenArtifact;
+import org.jenkinsci.plugins.pipeline.maven.MavenSpyLogProcessor;
+import org.jenkinsci.plugins.pipeline.maven.util.XmlUtils;
+import org.jenkinsci.plugins.workflow.steps.StepContext;
+import org.kohsuke.stapler.DataBoundConstructor;
+import org.w3c.dom.Element;
+
+import javax.annotation.Nonnull;
+import java.io.IOException;
+import java.io.OutputStream;
+import java.util.List;
+import java.util.logging.Level;
+import java.util.logging.Logger;
+
+/**
+ * handle {@code mvn spotbugs:spotbugs} invocations.
+ *
+ * @author <a href="mailto:cleclerc@cloudbees.com">Cyrille Le Clerc</a>
+ */
+public class SpotBugsAnalysisPublisher extends AbstractHealthAwarePublisher {
+    private static final Logger LOGGER = Logger.getLogger(SpotBugsAnalysisPublisher.class.getName());
+
+    private static final long serialVersionUID = 1L;
+
+    @DataBoundConstructor
+    public SpotBugsAnalysisPublisher() {
+
+    }
+
+    /*
+    <ExecutionEvent type="MojoStarted" class="org.apache.maven.lifecycle.internal.DefaultExecutionEvent" _time="2018-06-04 09:32:13.205">
+        <project baseDir="/path/to/test-spotbugs" file="/path/to/test-spotbugs/pom.xml" groupId="com.example.spotbugs" name="my-jar" artifactId="my-jar" version="0.1-SNAPSHOT">
+            <build sourceDirectory="/path/to/test-spotbugs/src/main/java" directory="/path/to/test-spotbugs/target"/>
+        </project>
+        <plugin executionId="default-cli" goal="spotbugs" groupId="com.github.spotbugs" artifactId="spotbugs-maven-plugin" version="3.1.3">
+            <classFilesDirectory>${project.build.outputDirectory}</classFilesDirectory>
+            <compileSourceRoots>${project.compileSourceRoots}</compileSourceRoots>
+            <debug>${spotbugs.debug}</debug>
+            <effort>${spotbugs.effort}</effort>
+            <excludeBugsFile>${spotbugs.excludeBugsFile}</excludeBugsFile>
+            <excludeFilterFile>${spotbugs.excludeFilterFile}</excludeFilterFile>
+            <failOnError>${spotbugs.failOnError}</failOnError>
+            <fork>${spotbugs.fork}</fork>
+            <includeFilterFile>${spotbugs.includeFilterFile}</includeFilterFile>
+            <includeTests>${spotbugs.includeTests}</includeTests>
+            <inputEncoding>${encoding}</inputEncoding>
+            <jvmArgs>${spotbugs.jvmArgs}</jvmArgs>
+            <localRepository>${localRepository}</localRepository>
+            <maxHeap>${spotbugs.maxHeap}</maxHeap>
+            <maxRank>${spotbugs.maxRank}</maxRank>
+            <nested>${spotbugs.nested}</nested>
+            <omitVisitors>${spotbugs.omitVisitors}</omitVisitors>
+            <onlyAnalyze>${spotbugs.onlyAnalyze}</onlyAnalyze>
+            <outputDirectory>${project.reporting.outputDirectory}</outputDirectory>
+            <outputEncoding>${outputEncoding}</outputEncoding>
+            <pluginArtifacts>${plugin.artifacts}</pluginArtifacts>
+            <pluginList>${spotbugs.pluginList}</pluginList>
+            <project>${project}</project>
+            <relaxed>${spotbugs.relaxed}</relaxed>
+            <remoteArtifactRepositories>${project.remoteArtifactRepositories}</remoteArtifactRepositories>
+            <remoteRepositories>${project.remoteArtifactRepositories}</remoteRepositories>
+            <skip>${spotbugs.skip}</skip>
+            <skipEmptyReport>${spotbugs.skipEmptyReport}</skipEmptyReport>
+            <sourceEncoding>${encoding}</sourceEncoding>
+            <spotbugsXmlOutput>true</spotbugsXmlOutput>
+            <spotbugsXmlOutputDirectory>${project.build.directory}</spotbugsXmlOutputDirectory>
+            <testClassFilesDirectory>${project.build.testOutputDirectory}</testClassFilesDirectory>
+            <testSourceRoots>${project.testCompileSourceRoots}</testSourceRoots>
+            <threshold>${spotbugs.threshold}</threshold>
+            <timeout>${spotbugs.timeout}</timeout>
+            <trace>${spotbugs.trace}</trace>
+            <userPrefs>${spotbugs.userPrefs}</userPrefs>
+            <visitors>${spotbugs.visitors}</visitors>
+            <xmlEncoding>UTF-8</xmlEncoding>
+            <xmlOutput>${spotbugs.xmlOutput}</xmlOutput>
+            <xmlOutputDirectory>${project.build.directory}</xmlOutputDirectory>
+            <xrefLocation>${project.reporting.outputDirectory}/xref</xrefLocation>
+            <xrefTestLocation>${project.reporting.outputDirectory}/xref-test</xrefTestLocation>
+        </plugin>
+    </ExecutionEvent>
+    <ExecutionEvent type="MojoSucceeded" class="org.apache.maven.lifecycle.internal.DefaultExecutionEvent" _time="2018-06-04 09:32:19.043">
+        <project baseDir="/path/to/test-spotbugs" file="/path/to/test-spotbugs/pom.xml" groupId="com.example.spotbugs" name="my-jar" artifactId="my-jar" version="0.1-SNAPSHOT">
+            <build sourceDirectory="/path/to/test-spotbugs/src/main/java" directory="/path/to/test-spotbugs/target"/>
+        </project>
+        <plugin executionId="default-cli" goal="spotbugs" groupId="com.github.spotbugs" artifactId="spotbugs-maven-plugin" version="3.1.3">
+            <classFilesDirectory>${project.build.outputDirectory}</classFilesDirectory>
+            <compileSourceRoots>${project.compileSourceRoots}</compileSourceRoots>
+            <debug>${spotbugs.debug}</debug>
+            <effort>${spotbugs.effort}</effort>
+            <excludeBugsFile>${spotbugs.excludeBugsFile}</excludeBugsFile>
+            <excludeFilterFile>${spotbugs.excludeFilterFile}</excludeFilterFile>
+            <failOnError>${spotbugs.failOnError}</failOnError>
+            <fork>${spotbugs.fork}</fork>
+            <includeFilterFile>${spotbugs.includeFilterFile}</includeFilterFile>
+            <includeTests>${spotbugs.includeTests}</includeTests>
+            <inputEncoding>${encoding}</inputEncoding>
+            <jvmArgs>${spotbugs.jvmArgs}</jvmArgs>
+            <localRepository>${localRepository}</localRepository>
+            <maxHeap>${spotbugs.maxHeap}</maxHeap>
+            <maxRank>${spotbugs.maxRank}</maxRank>
+            <nested>${spotbugs.nested}</nested>
+            <omitVisitors>${spotbugs.omitVisitors}</omitVisitors>
+            <onlyAnalyze>${spotbugs.onlyAnalyze}</onlyAnalyze>
+            <outputDirectory>${project.reporting.outputDirectory}</outputDirectory>
+            <outputEncoding>${outputEncoding}</outputEncoding>
+            <pluginArtifacts>${plugin.artifacts}</pluginArtifacts>
+            <pluginList>${spotbugs.pluginList}</pluginList>
+            <project>${project}</project>
+            <relaxed>${spotbugs.relaxed}</relaxed>
+            <remoteArtifactRepositories>${project.remoteArtifactRepositories}</remoteArtifactRepositories>
+            <remoteRepositories>${project.remoteArtifactRepositories}</remoteRepositories>
+            <skip>${spotbugs.skip}</skip>
+            <skipEmptyReport>${spotbugs.skipEmptyReport}</skipEmptyReport>
+            <sourceEncoding>${encoding}</sourceEncoding>
+            <spotbugsXmlOutput>true</spotbugsXmlOutput>
+            <spotbugsXmlOutputDirectory>${project.build.directory}</spotbugsXmlOutputDirectory>
+            <testClassFilesDirectory>${project.build.testOutputDirectory}</testClassFilesDirectory>
+            <testSourceRoots>${project.testCompileSourceRoots}</testSourceRoots>
+            <threshold>${spotbugs.threshold}</threshold>
+            <timeout>${spotbugs.timeout}</timeout>
+            <trace>${spotbugs.trace}</trace>
+            <userPrefs>${spotbugs.userPrefs}</userPrefs>
+            <visitors>${spotbugs.visitors}</visitors>
+            <xmlEncoding>UTF-8</xmlEncoding>
+            <xmlOutput>${spotbugs.xmlOutput}</xmlOutput>
+            <xmlOutputDirectory>${project.build.directory}</xmlOutputDirectory>
+            <xrefLocation>${project.reporting.outputDirectory}/xref</xrefLocation>
+            <xrefTestLocation>${project.reporting.outputDirectory}/xref-test</xrefTestLocation>
+        </plugin>
+    </ExecutionEvent>
+         */
+    @Override
+    public void process(@Nonnull StepContext context, @Nonnull Element mavenSpyLogsElt) throws IOException, InterruptedException {
+
+        TaskListener listener = context.get(TaskListener.class);
+        FilePath workspace = context.get(FilePath.class);
+        Run run = context.get(Run.class);
+        Launcher launcher = context.get(Launcher.class);
+
+         List<Element> spotbugsEvents = XmlUtils.getExecutionEvents(mavenSpyLogsElt, "com.github.spotbugs", "spotbugs-maven-plugin", "spotbugs");
+
+        if (spotbugsEvents.isEmpty()) {
+            LOGGER.log(Level.FINE, "No com.github.spotbugs:spotbugs-maven-plugin:spotbugs execution found");
+            return;
+        }
+        try {
+            Class.forName("hudson.plugins.findbugs.FindBugsPublisher");
+        } catch (ClassNotFoundException e) {
+            listener.getLogger().print("[withMaven] Jenkins ");
+            listener.hyperlink("https://wiki.jenkins-ci.org/display/JENKINS/FindBugs+Plugin", "FindBugs Plugin");
+            listener.getLogger().println(" not found, don't display com.github.spotbugs:spotbugs-maven-plugin:spotbugs results in pipeline screen.");
+            return;
+        }
+
+        for (Element findBugsTestEvent : spotbugsEvents) {
+            String findBugsEventType = findBugsTestEvent.getAttribute("type");
+            if (!findBugsEventType.equals("MojoSucceeded") && !findBugsEventType.equals("MojoFailed")) {
+                continue;
+            }
+
+            Element pluginElt = XmlUtils.getUniqueChildElement(findBugsTestEvent, "plugin");
+            Element xmlOutputDirectoryElt = XmlUtils.getUniqueChildElementOrNull(pluginElt, "xmlOutputDirectory");
+            Element projectElt = XmlUtils.getUniqueChildElement(findBugsTestEvent, "project");
+            MavenArtifact mavenArtifact = XmlUtils.newMavenArtifact(projectElt);
+            MavenSpyLogProcessor.PluginInvocation pluginInvocation = XmlUtils.newPluginInvocation(pluginElt);
+
+            if (xmlOutputDirectoryElt == null) {
+                listener.getLogger().println("[withMaven] No <xmlOutputDirectoryElt> element found for <plugin> in " + XmlUtils.toString(findBugsTestEvent));
+                continue;
+            }
+            String xmlOutputDirectory = xmlOutputDirectoryElt.getTextContent().trim();
+            if (xmlOutputDirectory.contains("${project.build.directory}")) {
+                String projectBuildDirectory = XmlUtils.getProjectBuildDirectory(projectElt);
+                if (projectBuildDirectory == null || projectBuildDirectory.isEmpty()) {
+                    listener.getLogger().println("[withMaven] '${project.build.directory}' found for <project> in " + XmlUtils.toString(findBugsTestEvent));
+                    continue;
+                }
+
+                xmlOutputDirectory = xmlOutputDirectory.replace("${project.build.directory}", projectBuildDirectory);
+
+            } else if (xmlOutputDirectory.contains("${basedir}")) {
+                String baseDir = projectElt.getAttribute("baseDir");
+                if (baseDir.isEmpty()) {
+                    listener.getLogger().println("[withMaven] '${basedir}' found for <project> in " + XmlUtils.toString(findBugsTestEvent));
+                    continue;
+                }
+
+                xmlOutputDirectory = xmlOutputDirectory.replace("${basedir}", baseDir);
+            }
+
+            xmlOutputDirectory = XmlUtils.getPathInWorkspace(xmlOutputDirectory, workspace);
+
+            String findBugsResultsFile = xmlOutputDirectory + "/spotbugsXml.xml";
+            listener.getLogger().println("[withMaven] SpotBugsPublisher - Archive SpotBugs analysis results for Maven artifact " + mavenArtifact.toString() + " generated by " +
+                    pluginInvocation + ": " + findBugsResultsFile);
+            FindBugsPublisher findBugsPublisher = new FindBugsPublisher();
+
+            findBugsPublisher.setPattern(findBugsResultsFile);
+
+            setHealthAwarePublisherAttributes(findBugsPublisher);
+
+            try {
+                findBugsPublisher.perform(run, workspace, launcher, listener);
+            } catch (Exception e) {
+                listener.error("[withMaven] SpotBugsPublisher - Silently ignore exception archiving FindBugs results for Maven artifact " + mavenArtifact.toString() + " generated by " +
+                        pluginInvocation + ": " + e);
+                LOGGER.log(Level.WARNING, "Exception processing " + XmlUtils.toString(findBugsTestEvent), e);
+            }
+
+        }
+
+    }
+
+    @Symbol("spotbugsPublisher")
+    @Extension
+    public static class DescriptorImpl extends AbstractHealthAwarePublisher.DescriptorImpl {
+        @Nonnull
+        @Override
+        public String getDisplayName() {
+            return "SpotBugs Publisher";
+        }
+
+        @Override
+        public int ordinal() {
+            return 20;
+        }
+
+        @Nonnull
+        @Override
+        public String getSkipFileName() {
+            return ".skip-publish-spotbugs-results";
+        }
+    }
+}
diff --git a/...es/org/jenkinsci/plugins/pipeline/maven/publishers/SpotBugsAnalysisPublisher/config.jelly b/...es/org/jenkinsci/plugins/pipeline/maven/publishers/SpotBugsAnalysisPublisher/config.jelly
@@ -0,0 +1,32 @@
+<!--
+The MIT License
+
+Copyright (c) 2004-2009, Sun Microsystems, Inc., Kohsuke Kawaguchi, Seiji Sogabe, Tom Huybrechts
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+-->
+
+<?jelly escape-by-default='true'?>
+<j:jelly xmlns:j="jelly:core" xmlns:st="jelly:stapler" xmlns:d="jelly:define" xmlns:l="/lib/layout"
+         xmlns:t="/lib/hudson" xmlns:f="/lib/form">
+
+    <st:include page="maven-publisher" class="${descriptor.clazz}"/>
+
+    <st:include page="health" class="${descriptor.clazz}" />
+</j:jelly>
diff --git a/.../jenkinsci/plugins/pipeline/maven/publishers/SpotBugsAnalysisPublisher/help-disabled.html b/.../jenkinsci/plugins/pipeline/maven/publishers/SpotBugsAnalysisPublisher/help-disabled.html
@@ -0,0 +1,3 @@
+<div>
+    Skip the publishing of SpotBugs reports.
+</div>
diff --git a/...urces/org/jenkinsci/plugins/pipeline/maven/publishers/SpotBugsAnalysisPublisher/help.html b/...urces/org/jenkinsci/plugins/pipeline/maven/publishers/SpotBugsAnalysisPublisher/help.html
@@ -0,0 +1,6 @@
+<div>
+    Publish SpotBugs reports generated by "<code>com.github.spotbugs:spotbugs-maven-plugin:spotbugs</code>".<br/>
+
+    SpotBugs results are by default published if the
+    <a href="https://wiki.jenkins-ci.org/display/JENKINS/FindBugs+Plugin">Jenkins FindBugs Plugin</a> is installed.
+</div>