[JENKINS-43094] Add Maven Dependencies Fingerprint Publisher

jenkinsci · Jun 9, 2017 · a1ad158 · a1ad158
1 parent 8284bc9
commit a1ad158
Show file tree

Hide file tree

Showing 11 changed files with 436 additions and 8 deletions.
diff --git a/jenkins-plugin/src/main/java/org/jenkinsci/plugins/pipeline/maven/MavenSpyLogProcessor.java b/jenkins-plugin/src/main/java/org/jenkinsci/plugins/pipeline/maven/MavenSpyLogProcessor.java
@@ -44,6 +44,7 @@
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
+import javax.annotation.Nonnull;
 import javax.xml.parsers.DocumentBuilder;
 import javax.xml.parsers.DocumentBuilderFactory;
 import javax.xml.parsers.ParserConfigurationException;
@@ -141,6 +142,10 @@ public String getFileName() {
             return artifactId + "-" + version + ((classifier == null || classifier.isEmpty()) ? "" : "-" + classifier) + "." + extension;
         }
 
+        public boolean isSnapshot() {
+            return version != null && version.endsWith("-SNAPSHOT");
+        }
+
         @Override
         public String toString() {
             return "MavenArtifact{" +
@@ -153,6 +158,34 @@ public String toString() {
                     '}';
         }
     }
+    public static class MavenDependency extends MavenArtifact {
+
+        private String scope;
+        public boolean optional;
+
+        @Nonnull
+        public String getScope() {
+            return scope == null ? "compile" : scope;
+        }
+
+        public void setScope(String scope) {
+            this.scope = scope;
+        }
+
+        @Override
+        public String toString() {
+            return "MavenDependency{" +
+                    groupId + ":" +
+                    artifactId + ":" +
+                    type +
+                    (classifier == null ? "" : ":" + classifier) + ":" +
+                    version + ", " +
+                    "scope: " + scope + ", " +
+                    " optional: " + optional +
+                    (file == null ? "" : " " + file) +
+                    '}';
+        }
+    }
 
     /*
       <plugin executionId="default-test" goal="test" groupId="org.apache.maven.plugins" artifactId="maven-surefire-plugin" version="2.19.1">

diff --git a/...ava/org/jenkinsci/plugins/pipeline/maven/publishers/DependenciesFingerprintPublisher.java b/...ava/org/jenkinsci/plugins/pipeline/maven/publishers/DependenciesFingerprintPublisher.java
@@ -0,0 +1,212 @@
+package org.jenkinsci.plugins.pipeline.maven.publishers;
+
+import hudson.Extension;
+import hudson.FilePath;
+import hudson.model.FingerprintMap;
+import hudson.model.Run;
+import hudson.model.TaskListener;
+import hudson.tasks.Fingerprinter;
+import jenkins.model.Jenkins;
+import org.apache.commons.lang.StringUtils;
+import org.jenkinsci.Symbol;
+import org.jenkinsci.plugins.pipeline.maven.MavenPublisher;
+import org.jenkinsci.plugins.pipeline.maven.MavenSpyLogProcessor;
+import org.jenkinsci.plugins.pipeline.maven.util.XmlUtils;
+import org.jenkinsci.plugins.workflow.steps.StepContext;
+import org.w3c.dom.Element;
+
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+import java.util.TreeSet;
+import java.util.logging.Level;
+import java.util.logging.Logger;
+
+import javax.annotation.Nonnull;
+
+/**
+ * Fingerprint the dependencies of the maven project.
+ *
+ * @author <a href="mailto:cleclerc@cloudbees.com">Cyrille Le Clerc</a>
+ */
+public class DependenciesFingerprintPublisher extends MavenPublisher {
+    private static final long serialVersionUID = 1L;
+
+    private static final Logger LOGGER = Logger.getLogger(MavenSpyLogProcessor.class.getName());
+
+    private boolean includeSnapshotVersions = true;
+
+    private boolean includeReleaseVersions;
+
+    private boolean includeScopeCompile = true;
+
+    private boolean includeScopeRuntime;
+
+    private boolean includeScopeTest;
+
+    private boolean includeScopeProvided = true;
+
+    protected Set<String> getIncludedScopes() {
+        Set<String> includedScopes = new TreeSet<>();
+        if (includeScopeCompile)
+            includedScopes.add("compile");
+        if (includeScopeRuntime)
+            includedScopes.add("runtime");
+        if (includeScopeProvided)
+            includedScopes.add("provided");
+        if (includeScopeTest)
+            includedScopes.add("test");
+        return includedScopes;
+    }
+
+    @Override
+    public void process(@Nonnull StepContext context, @Nonnull Element mavenSpyLogsElt) throws IOException, InterruptedException {
+        Run run = context.get(Run.class);
+        TaskListener listener = context.get(TaskListener.class);
+
+        FilePath workspace = context.get(FilePath.class);
+
+        List<MavenSpyLogProcessor.MavenDependency> dependencies = listDependencies(mavenSpyLogsElt);
+
+        Map<String, String> artifactsToFingerPrint = new HashMap<>(); // artifactPathInFingerprintZone -> artifactMd5
+        for (MavenSpyLogProcessor.MavenDependency dependency : dependencies) {
+            if (dependency.isSnapshot()) {
+                if (!includeSnapshotVersions) {
+                    if (LOGGER.isLoggable(Level.FINE)) {
+                        listener.getLogger().println("[withMaven] Skip fingerprinting snapshot dependency: " + dependency);
+                    }
+                    continue;
+                }
+            } else {
+                if (!includeReleaseVersions) {
+                    if (LOGGER.isLoggable(Level.FINE)) {
+                        listener.getLogger().println("[withMaven] Skip fingerprinting release dependency: " + dependency);
+                    }
+                    continue;
+                }
+            }
+            if (!getIncludedScopes().contains(dependency.getScope())) {
+                if (LOGGER.isLoggable(Level.FINE)) {
+                    listener.getLogger().println("[withMaven] Skip fingerprinting dependency with ignored scope: " + dependency);
+                }
+                continue;
+            }
+
+            try {
+                if (StringUtils.isEmpty(dependency.file)) {
+                    if (LOGGER.isLoggable(Level.FINER)) {
+                        listener.getLogger().println("[withMaven] Can't fingerprint maven dependency with no file attached: " + dependency);
+                    }
+                    continue;
+                }
+
+                FilePath dependencyFilePath = new FilePath(workspace, dependency.file);
+
+                if (!(dependency.file.endsWith("." + dependency.extension))) {
+                    if (dependencyFilePath.isDirectory()) {
+                        if (LOGGER.isLoggable(Level.FINE)) {
+                            listener.getLogger().println("[withMaven] Skip fingerprinting of maven dependency of type directory " + dependency);
+                        }
+                        continue;
+                    }
+                }
+
+                String dependencyMavenRepoStyleFilePath =
+                        dependency.groupId.replace('.', '/') + "/" +
+                                dependency.artifactId + "/" +
+                                dependency.version + "/" +
+                                dependency.getFileName();
+
+
+                if (dependencyFilePath.exists()) {
+                    // the subsequent call to digest could test the existence but we don't want to prematurely optimize performances
+                    if (LOGGER.isLoggable(Level.FINE)) {
+                        listener.getLogger().println("[withMaven] Fingerprint dependency " + dependencyMavenRepoStyleFilePath);
+                    }
+                    String artifactDigest = dependencyFilePath.digest();
+                    artifactsToFingerPrint.put(dependencyMavenRepoStyleFilePath, artifactDigest);
+                } else {
+                    listener.getLogger().println("[withMaven] FAILURE to fingerprint " + dependencyMavenRepoStyleFilePath + ", file not found");
+                }
+
+            } catch (IOException | RuntimeException e) {
+                listener.error("[withMaven] WARNING: Exception fingerprinting " + dependency + ", skip");
+                e.printStackTrace(listener.getLogger());
+                listener.getLogger().flush();
+            }
+        }
+        LOGGER.log(Level.FINER, "Fingerprint {0}", artifactsToFingerPrint);
+
+        // FINGERPRINT GENERATED MAVEN ARTIFACT
+        FingerprintMap fingerprintMap = Jenkins.getInstance().getFingerprintMap();
+        for (Map.Entry<String, String> artifactToFingerprint : artifactsToFingerPrint.entrySet()) {
+            String artifactPathInFingerprintZone = artifactToFingerprint.getKey();
+            String artifactMd5 = artifactToFingerprint.getValue();
+            fingerprintMap.getOrCreate(run, artifactPathInFingerprintZone, artifactMd5);
+        }
+
+        // add action
+        Fingerprinter.FingerprintAction fingerprintAction = run.getAction(Fingerprinter.FingerprintAction.class);
+        if (fingerprintAction == null) {
+            run.addAction(new Fingerprinter.FingerprintAction(run, artifactsToFingerPrint));
+        } else {
+            fingerprintAction.add(artifactsToFingerPrint);
+        }
+    }
+
+    /**
+     * @param mavenSpyLogs Root XML element
+     * @return list of {@link MavenSpyLogProcessor.MavenArtifact}
+     */
+    @Nonnull
+    public List<MavenSpyLogProcessor.MavenDependency> listDependencies(Element mavenSpyLogs) {
+
+        List<MavenSpyLogProcessor.MavenDependency> result = new ArrayList<>();
+
+        for (Element dependencyResolutionResult : XmlUtils.getChildrenElements(mavenSpyLogs, "DependencyResolutionResult")) {
+            Element resolvedDependenciesElt = XmlUtils.getUniqueChildElementOrNull(dependencyResolutionResult, "resolvedDependencies");
+
+            if (resolvedDependenciesElt == null) {
+                continue;
+            }
+
+            for (Element dependencyElt : XmlUtils.getChildrenElements(resolvedDependenciesElt, "dependency")) {
+                MavenSpyLogProcessor.MavenDependency dependencyArtifact = XmlUtils.newMavenDependency(dependencyElt);
+
+                Element fileElt = XmlUtils.getUniqueChildElementOrNull(dependencyElt, "file");
+                if (fileElt == null | fileElt.getTextContent() == null || fileElt.getTextContent().isEmpty()) {
+                    LOGGER.log(Level.WARNING, "listDependencies: no associated file found for " + dependencyArtifact + " in " + XmlUtils.toString(dependencyElt));
+                }
+                dependencyArtifact.file = StringUtils.trim(fileElt.getTextContent());
+
+                result.add(dependencyArtifact);
+            }
+        }
+
+        return result;
+    }
+
+    @Symbol("dependenciesFingerprintPublisher")
+    @Extension
+    public static class DescriptorImpl extends MavenPublisher.DescriptorImpl {
+        @Nonnull
+        @Override
+        public String getDisplayName() {
+            return "Dependencies Fingerprint Publisher";
+        }
+
+        @Override
+        public int ordinal() {
+            return 20;
+        }
+
+        @Nonnull
+        @Override
+        public String getSkipFileName() {
+            return ".skip-fingerprint-maven-dependencies";
+        }
+    }
+}
diff --git a/jenkins-plugin/src/main/java/org/jenkinsci/plugins/pipeline/maven/util/XmlUtils.java b/jenkins-plugin/src/main/java/org/jenkinsci/plugins/pipeline/maven/util/XmlUtils.java
@@ -32,7 +32,6 @@
 import org.w3c.dom.Node;
 import org.w3c.dom.NodeList;
 
-import java.io.IOException;
 import java.io.StringWriter;
 import java.nio.file.Path;
 import java.util.ArrayList;
@@ -60,16 +59,30 @@ public class XmlUtils {
 
     public static MavenSpyLogProcessor.MavenArtifact newMavenArtifact(Element artifactElt) {
         MavenSpyLogProcessor.MavenArtifact mavenArtifact = new MavenSpyLogProcessor.MavenArtifact();
+        loadMavenArtifact(artifactElt, mavenArtifact);
+
+        return mavenArtifact;
+    }
+
+    public static MavenSpyLogProcessor.MavenDependency newMavenDependency(Element dependencyElt) {
+        MavenSpyLogProcessor.MavenDependency dependency = new MavenSpyLogProcessor.MavenDependency();
+        loadMavenArtifact(dependencyElt, dependency);
+        dependency.scope = dependencyElt.getAttribute("scope");
+        dependency.optional = Boolean.valueOf(dependencyElt.getAttribute("optional"));
+
+        return dependency;
+    }
+
+    private static void loadMavenArtifact(Element artifactElt, MavenSpyLogProcessor.MavenArtifact mavenArtifact) {
         mavenArtifact.groupId = artifactElt.getAttribute("groupId");
         mavenArtifact.artifactId = artifactElt.getAttribute("artifactId");
         mavenArtifact.version = artifactElt.getAttribute("version");
         mavenArtifact.type = artifactElt.getAttribute("type");
         mavenArtifact.classifier = artifactElt.hasAttribute("classifier") ? artifactElt.getAttribute("classifier") : null;
         mavenArtifact.extension = artifactElt.getAttribute("extension");
-
-        return mavenArtifact;
     }
 
+
     /*
   <plugin executionId="default-test" goal="test" groupId="org.apache.maven.plugins" artifactId="maven-surefire-plugin" version="2.19.1">
  */

diff --git a/...jenkinsci/plugins/pipeline/maven/publishers/DependenciesFingerprintPublisher/config.jelly b/...jenkinsci/plugins/pipeline/maven/publishers/DependenciesFingerprintPublisher/config.jelly
@@ -0,0 +1,31 @@
+<!--
+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}"/>
+
+</j:jelly>
diff --git a/...sci/plugins/pipeline/maven/publishers/DependenciesFingerprintPublisher/help-disabled.html b/...sci/plugins/pipeline/maven/publishers/DependenciesFingerprintPublisher/help-disabled.html
@@ -0,0 +1,3 @@
+<div>
+    Skip the fingerprinting of the dependencies of the maven project.
+</div>
diff --git a/...rg/jenkinsci/plugins/pipeline/maven/publishers/DependenciesFingerprintPublisher/help.html b/...rg/jenkinsci/plugins/pipeline/maven/publishers/DependenciesFingerprintPublisher/help.html
@@ -0,0 +1,3 @@
+<div>
+    Fingerprint the Maven dependencies used by the maven project.<br/>
+</div>
diff --git a/jenkins-plugin/src/test/java/org/jenkinsci/plugins/pipeline/maven/MavenPublisherTest.java b/jenkins-plugin/src/test/java/org/jenkinsci/plugins/pipeline/maven/MavenPublisherTest.java
@@ -29,11 +29,11 @@ public class MavenPublisherTest {
     public JenkinsRule jenkinsRule = new JenkinsRule();
 
     @Test
-    public void listMavenReporters() throws Exception {
+    public void listMavenPublishers() throws Exception {
         ByteArrayOutputStream baos = new ByteArrayOutputStream();
 
         List<MavenPublisher> mavenPublishers = MavenPublisher.buildPublishersList(Collections.<MavenPublisher>emptyList(), new StreamTaskListener(baos));
-        Assert.assertThat(mavenPublishers.size(), CoreMatchers.is(4));
+        Assert.assertThat(mavenPublishers.size(), CoreMatchers.is(5));
 
         Map<String, MavenPublisher> reportersByDescriptorId = new HashMap<>();
         for(MavenPublisher mavenPublisher : mavenPublishers) {