JENKINS-59813 pipeline-maven JacocoPublisher handle excludes properly (…

…#764)

pipeline-maven/src/main/java/org/jenkinsci/plugins/pipeline/maven/publishers/JacocoReportPublisher.java

@@ -70,6 +70,9 @@ public JacocoReportPublisher() {}
      *     <destFile>${jacoco.destFile}</destFile>
      *     <dumpOnExit>${jacoco.dumpOnExit}</dumpOnExit>
      *     <exclClassLoaders>${jacoco.exclClassLoaders}</exclClassLoaders>
+     *     <excludes>
+     *       <exclude>com/example/exclude/*</exclude>
+     *     </excludes>
      *     <inclBootstrapClasses>${jacoco.inclBootstrapClasses}</inclBootstrapClasses>
      *     <inclNoLocationClasses>${jacoco.inclNoLocationClasses}</inclNoLocationClasses>
      *     <jmx>${jacoco.jmx}</jmx>
@@ -93,6 +96,9 @@ public JacocoReportPublisher() {}
      *     <destFile>${jacoco.destFile}</destFile>
      *     <dumpOnExit>${jacoco.dumpOnExit}</dumpOnExit>
      *     <exclClassLoaders>${jacoco.exclClassLoaders}</exclClassLoaders>
+     *     <excludes>
+     *       <exclude>com/example/exclude/*</exclude>
+     *     </excludes>
      *     <inclBootstrapClasses>${jacoco.inclBootstrapClasses}</inclBootstrapClasses>
      *     <inclNoLocationClasses>${jacoco.inclNoLocationClasses}</inclNoLocationClasses>
      *     <jmx>${jacoco.jmx}</jmx>
@@ -219,15 +225,26 @@ public void process(@NonNull StepContext context, @NonNull Element mavenSpyLogsE
             String sourceDirectoryRelativePath = XmlUtils.getPathInWorkspace(sourceDirectory, workspace);
             String classesDirectoryRelativePath = XmlUtils.getPathInWorkspace(classesDirectory, workspace);
 
+            String excludes = null;
+            Element excludesElt = XmlUtils.getUniqueChildElementOrNull(pluginElt, "excludes");
+            if (excludesElt != null) {
+                List<Element> excludeElements = XmlUtils.getChildrenElements(excludesElt, "exclude");
+                excludes = excludeElements.stream()
+                        .map(e -> e.getTextContent().trim())
+                        .collect(Collectors.joining(","));
+            }
+
             listener.getLogger()
                     .println("[withMaven] jacocoPublisher - Archive JaCoCo analysis results for Maven artifact "
                             + mavenArtifact.toString() + " generated by " + pluginInvocation + ": execFile: " + destFile
                             + ", sources: " + sourceDirectoryRelativePath + ", classes: "
-                            + classesDirectoryRelativePath);
+                            + classesDirectoryRelativePath + ", excludes: "
+                            + excludes);
             jacocoReportDetails.add(new JacocoReportDetails(
                     destFile,
                     sourceDirectoryRelativePath,
                     classesDirectoryRelativePath,
+                    excludes,
                     mavenArtifact.toString() + " " + pluginInvocation));
         }
 
@@ -241,10 +258,16 @@ public void process(@NonNull StepContext context, @NonNull Element mavenSpyLogsE
         String aggregatedClassesDirectory = jacocoReportDetails.stream()
                 .map(details -> details.classesDirectory)
                 .collect(Collectors.joining(","));
+        String aggregatedExclusionPattern = jacocoReportDetails.stream()
+                .map(details -> details.excludes)
+                .filter(e -> e != null && !e.isEmpty())
+                .distinct()
+                .collect(Collectors.joining(","));
 
         jacocoPublisher.setExecPattern(aggregatedDestFile);
         jacocoPublisher.setSourcePattern(aggregatedSourceDirectory);
         jacocoPublisher.setClassPattern(aggregatedClassesDirectory);
+        jacocoPublisher.setExclusionPattern(aggregatedExclusionPattern);
 
         try {
             jacocoPublisher.perform(run, workspace, launcher, listener);
@@ -258,13 +281,14 @@ public void process(@NonNull StepContext context, @NonNull Element mavenSpyLogsE
     }
 
     public static class JacocoReportDetails {
-        final String execFile, sourceDirectory, classesDirectory, description;
+        final String execFile, sourceDirectory, classesDirectory, excludes, description;
 
         public JacocoReportDetails(
-                String execFile, String sourceDirectory, String classesDirectory, String description) {
+                String execFile, String sourceDirectory, String classesDirectory, String excludes, String description) {
             this.execFile = execFile;
             this.sourceDirectory = sourceDirectory;
             this.classesDirectory = classesDirectory;
+            this.excludes = excludes;
             this.description = description;
         }
 
@@ -273,7 +297,8 @@ public String toString() {
             return "JacocoReportDetails{" + "execFile='"
                     + execFile + '\'' + ", sourceDirectory='"
                     + sourceDirectory + '\'' + ", classesDirectory='"
-                    + classesDirectory + '\'' + ", description='"
+                    + classesDirectory + '\'' + ", excludes='"
+                    + excludes + '\'' + ", description='"
                     + description + '\'' + '}';
         }
     }

pipeline-maven/src/test/java/org/jenkinsci/plugins/pipeline/maven/publishers/JacocoReportPublisherTest.java

@@ -1,12 +1,18 @@
 package org.jenkinsci.plugins.pipeline.maven.publishers;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 
 import hudson.model.Result;
 import hudson.plugins.jacoco.JacocoBuildAction;
+import hudson.plugins.jacoco.report.CoverageReport;
+import hudson.plugins.jacoco.report.PackageReport;
 import hudson.tasks.junit.TestResultAction;
 import java.util.Collection;
 import java.util.List;
+import java.util.Map;
+import java.util.Set;
 import org.jenkinsci.plugins.pipeline.maven.AbstractIntegrationTest;
 import org.jenkinsci.plugins.pipeline.maven.TestUtils;
 import org.jenkinsci.plugins.workflow.cps.CpsFlowDefinition;
@@ -57,5 +63,14 @@ public void maven_build_jar_with_jacoco_succeeds() throws Exception {
         assertThat(jacocoBuildActions).hasSize(1);
         JacocoBuildAction jacocoBuildAction = jacocoBuildActions.get(0);
         assertThat(jacocoBuildAction.getProjectActions()).hasSize(1);
+
+        // verify that the excluded package is not in the report
+        CoverageReport result = jacocoBuildAction.getResult();
+        Map<String, PackageReport> children = result.getChildren();
+        Set<String> childrenKeys = children.keySet();
+        // not excluded package
+        assertTrue(childrenKeys.stream().anyMatch("com.example"::equals));
+        // excluded package
+        assertFalse(childrenKeys.stream().anyMatch("com.example.exclude"::equals));
     }
 }

pipeline-maven/src/test/resources/org/jenkinsci/plugins/pipeline/maven/test/test_maven_projects/maven_jar_with_jacoco_project/pom.xml

@@ -42,6 +42,11 @@
         <groupId>org.jacoco</groupId>
         <artifactId>jacoco-maven-plugin</artifactId>
         <version>0.8.10</version>
+        <configuration>
+            <excludes>
+                <exclude>com/example/exclude/*</exclude>
+            </excludes>
+        </configuration>
         <executions>
           <execution>
             <id>default-prepare-agent</id>

pipeline-maven/src/test/resources/org/jenkinsci/plugins/pipeline/maven/test/test_maven_projects/maven_jar_with_jacoco_project/src/main/java/com/example/exclude/MonoModuleMavenExcludeApp.java

@@ -0,0 +1,11 @@
+package com.example.exclude;
+
+public class MonoModuleMavenExcludeApp {
+    /**
+     * TODO message
+     * @param args
+     */
+    public static void main(String[] args) {
+        System.out.println("Hello MonoModuleMavenExcludeApp");
+    }
+}