Fix Jacoco coverage exclusion (#7808)

Author: nikita-tkachenko-datadog

dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/domain/buildsystem/BuildSystemModuleImpl.java

@@ -191,11 +191,11 @@ private Map<String, String> getPropertiesPropagatedToChildProcess(
             CiVisibilityConfig.CIVISIBILITY_SIGNAL_SERVER_PORT),
         String.valueOf(signalServerAddress != null ? signalServerAddress.getPort() : 0));
 
-    List<String> coverageEnabledPackages = sessionSettings.getCoverageEnabledPackages();
+    List<String> coverageIncludedPackages = sessionSettings.getCoverageIncludedPackages();
     propagatedSystemProperties.put(
         Strings.propertyNameToSystemPropertyName(
             CiVisibilityConfig.CIVISIBILITY_CODE_COVERAGE_INCLUDES),
-        String.join(":", coverageEnabledPackages));
+        String.join(":", coverageIncludedPackages));
 
     if (jacocoAgent != null && !config.isCiVisibilityCoverageLinesDisabled()) {
       // If the module is using Jacoco,

dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/domain/buildsystem/BuildSystemSessionImpl.java

@@ -40,9 +40,7 @@
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Collections;
-import java.util.Iterator;
 import java.util.List;
-import java.util.stream.Collectors;
 import javax.annotation.Nullable;
 
 public class BuildSystemSessionImpl<T extends CoverageCalculator> extends AbstractTestSession
@@ -92,7 +90,10 @@ public BuildSystemSessionImpl(
     this.repoIndexProvider = repoIndexProvider;
     this.coverageCalculatorFactory = coverageCalculatorFactory;
     this.coverageCalculator = coverageCalculatorFactory.sessionCoverage(span.getSpanId());
-    this.settings = new BuildSessionSettings(getCoverageEnabledPackages(config, repoIndexProvider));
+    this.settings =
+        new BuildSessionSettings(
+            getCoverageIncludedPackages(config, repoIndexProvider),
+            config.getCiVisibilityCodeCoverageExcludes());
 
     signalServer.registerSignalHandler(
         SignalType.MODULE_EXECUTION_RESULT, moduleSignalRouter::onModuleSignalReceived);
@@ -107,48 +108,19 @@ public BuildSystemSessionImpl(
     setTag(Tags.TEST_COMMAND, startCommand);
   }
 
-  private static List<String> getCoverageEnabledPackages(
+  private static List<String> getCoverageIncludedPackages(
       Config config, RepoIndexProvider repoIndexProvider) {
     if (!config.isCiVisibilityCodeCoverageEnabled()) {
       return Collections.emptyList();
     }
 
     List<String> includedPackages = config.getCiVisibilityCodeCoverageIncludes();
-    List<String> packages;
     if (includedPackages != null && !includedPackages.isEmpty()) {
-      packages = includedPackages;
+      return new ArrayList<>(includedPackages);
     } else {
       RepoIndex repoIndex = repoIndexProvider.getIndex();
-      packages = new ArrayList<>(repoIndex.getRootPackages());
+      return new ArrayList<>(repoIndex.getRootPackages());
     }
-
-    List<String> excludedPackages = config.getCiVisibilityCodeCoverageExcludes();
-    if (excludedPackages != null && !excludedPackages.isEmpty()) {
-      removeMatchingPackages(packages, excludedPackages);
-    }
-    return packages;
-  }
-
-  private static void removeMatchingPackages(List<String> packages, List<String> excludedPackages) {
-    List<String> excludedPrefixes =
-        excludedPackages.stream()
-            .map(BuildSystemSessionImpl::trimTrailingAsterisk)
-            .collect(Collectors.toList());
-    Iterator<String> packagesIterator = packages.iterator();
-    while (packagesIterator.hasNext()) {
-      String p = packagesIterator.next();
-
-      for (String excludedPrefix : excludedPrefixes) {
-        if (p.startsWith(excludedPrefix)) {
-          packagesIterator.remove();
-          break;
-        }
-      }
-    }
-  }
-
-  private static String trimTrailingAsterisk(String s) {
-    return s.endsWith("*") ? s.substring(0, s.length() - 1) : s;
   }
 
   private SignalResponse onRepoIndexRequestReceived(RepoIndexRequest request) {

dd-java-agent/instrumentation/gradle-3.0/src/main/groovy/datadog/trace/instrumentation/gradle/legacy/GradleProjectConfigurator.groovy

@@ -203,13 +203,19 @@ class GradleProjectConfigurator {
       }
     }
 
-    def coverageEnabledPackages = sessionSettings.getCoverageEnabledPackages()
+    def coverageIncludedPackages = sessionSettings.getCoverageIncludedPackages()
+    def coverageExcludedPackages = sessionSettings.getCoverageExcludedPackages()
     forEveryTestTask project, { task ->
       task.jacoco.excludeClassLoaders += [DatadogClassLoader.name]
 
-      for (String coverageEnabledPackage : coverageEnabledPackages) {
-        if (Strings.isNotBlank(coverageEnabledPackage)) {
-          task.jacoco.includes += coverageEnabledPackage
+      for (String includedPackage : coverageIncludedPackages) {
+        if (Strings.isNotBlank(includedPackage)) {
+          task.jacoco.includes += includedPackage
+        }
+      }
+      for (String excludedPackage : coverageExcludedPackages) {
+        if (Strings.isNotBlank(excludedPackage)) {
+          task.jacoco.excludes += excludedPackage
         }
       }
     }

dd-java-agent/instrumentation/gradle-8.3/src/main/java/datadog/trace/instrumentation/gradle/CiVisibilityPluginExtension.java

@@ -170,16 +170,28 @@ private void applyJacocoSettings(JacocoTaskExtension jacocoTaskExtension) {
           new ArrayList<>(ciVisibilityService.getExcludeClassLoaders()));
     }
 
-    List<String> taskIncludePackages = jacocoTaskExtension.getIncludes();
-    if (taskIncludePackages == null) {
-      taskIncludePackages = new ArrayList<>();
-      jacocoTaskExtension.setIncludes(taskIncludePackages);
-    }
-    for (String coverageEnabledPackage : ciVisibilityService.getCoverageEnabledPackages()) {
-      if (coverageEnabledPackage != null && !coverageEnabledPackage.isEmpty()) {
-        taskIncludePackages.add(coverageEnabledPackage);
+    jacocoTaskExtension.setIncludes(
+        merge(
+            jacocoTaskExtension.getIncludes(), ciVisibilityService.getCoverageIncludedPackages()));
+    jacocoTaskExtension.setExcludes(
+        merge(
+            jacocoTaskExtension.getExcludes(), ciVisibilityService.getCoverageExcludedPackages()));
+  }
+
+  @SafeVarargs
+  private static List<String> merge(List<String>... packageLists) {
+    List<String> merged = new ArrayList<>();
+    for (List<String> packageList : packageLists) {
+      if (packageList == null) {
+        continue;
+      }
+      for (String pkg : packageList) {
+        if (pkg != null && !pkg.isEmpty()) {
+          merged.add(pkg);
+        }
       }
     }
+    return merged;
   }
 
   private void applyTracerSettings(

dd-java-agent/instrumentation/gradle-8.3/src/main/java/datadog/trace/instrumentation/gradle/CiVisibilityService.java

@@ -56,9 +56,14 @@ public List<String> getCoverageEnabledSourceSets() {
     return config.getCiVisibilityJacocoGradleSourceSets();
   }
 
-  public List<String> getCoverageEnabledPackages() {
+  public List<String> getCoverageIncludedPackages() {
     BuildSessionSettings sessionSettings = buildEventsHandler.getSessionSettings(SESSION_KEY);
-    return sessionSettings.getCoverageEnabledPackages();
+    return sessionSettings.getCoverageIncludedPackages();
+  }
+
+  public List<String> getCoverageExcludedPackages() {
+    BuildSessionSettings sessionSettings = buildEventsHandler.getSessionSettings(SESSION_KEY);
+    return sessionSettings.getCoverageExcludedPackages();
   }
 
   @SuppressForbidden

dd-java-agent/instrumentation/jacoco/src/main/java/datadog/trace/instrumentation/jacoco/ProbeInserterInstrumentation.java

@@ -139,9 +139,23 @@ static void exit(
       classNameField.setAccessible(true);
       String className = (String) classNameField.get(arrayStrategy);
 
-      String[] excludedClassnames = Config.get().getCiVisibilityCodeCoverageExcludedPackages();
-      for (String excludedClassname : excludedClassnames) {
-        if (className.startsWith(excludedClassname)) {
+      String[] excludedPackages = Config.get().getCiVisibilityCodeCoverageExcludedPackages();
+      for (String excludedPackage : excludedPackages) {
+        if (className.startsWith(excludedPackage)) {
+          return;
+        }
+      }
+
+      String[] includedPackages = Config.get().getCiVisibilityCodeCoverageIncludedPackages();
+      if (includedPackages.length > 0) {
+        boolean included = false;
+        for (String includedPackage : includedPackages) {
+          if (className.startsWith(includedPackage)) {
+            included = true;
+            break;
+          }
+        }
+        if (!included) {
           return;
         }
       }

dd-java-agent/instrumentation/maven-3.2.1/src/main/java/datadog/trace/instrumentation/maven3/MavenProjectConfigurator.java

@@ -312,7 +312,9 @@ private static void configureJacocoPlugin(
     jacocoPlugin.addExecution(prepareAgentExecution);
 
     configureJacocoInstrumentedPackages(
-        prepareAgentExecution, sessionSettings.getCoverageEnabledPackages());
+        prepareAgentExecution,
+        sessionSettings.getCoverageIncludedPackages(),
+        sessionSettings.getCoverageExcludedPackages());
   }
 
   private static Plugin getJacocoPlugin(MavenProject project) {
@@ -345,20 +347,32 @@ private static Plugin getJacocoPlugin(MavenProject project) {
   }
 
   private static void configureJacocoInstrumentedPackages(
-      PluginExecution execution, List<String> instrumentedPackages) {
-    Xpp3Dom includes = new Xpp3Dom("includes");
-    for (String instrumentedPackage : instrumentedPackages) {
-      if (Strings.isNotBlank(instrumentedPackage)) {
-        Xpp3Dom include = new Xpp3Dom("include");
-        include.setValue(instrumentedPackage);
-        includes.addChild(include);
+      PluginExecution execution, List<String> includedPackages, List<String> excludedPackages) {
+    Xpp3Dom configuration = new Xpp3Dom("configuration");
+    execution.setConfiguration(configuration);
+
+    if (!includedPackages.isEmpty()) {
+      Xpp3Dom includes = new Xpp3Dom("includes");
+      for (String instrumentedPackage : includedPackages) {
+        if (Strings.isNotBlank(instrumentedPackage)) {
+          Xpp3Dom include = new Xpp3Dom("include");
+          include.setValue(instrumentedPackage);
+          includes.addChild(include);
+        }
       }
+      configuration.addChild(includes);
     }
 
-    if (includes.getChildCount() > 0) {
-      Xpp3Dom configuration = new Xpp3Dom("configuration");
-      configuration.addChild(includes);
-      execution.setConfiguration(configuration);
+    if (!excludedPackages.isEmpty()) {
+      Xpp3Dom excludes = new Xpp3Dom("excludes");
+      for (String excludedPackage : excludedPackages) {
+        if (Strings.isNotBlank(excludedPackage)) {
+          Xpp3Dom exclude = new Xpp3Dom("exclude");
+          exclude.setValue(excludedPackage);
+          excludes.addChild(exclude);
+        }
+      }
+      configuration.addChild(excludes);
     }
   }
 }

internal-api/src/main/java/datadog/trace/api/civisibility/domain/BuildSessionSettings.java

@@ -4,13 +4,20 @@
 
 public class BuildSessionSettings {
 
-  private final List<String> coverageEnabledPackages;
+  private final List<String> coverageIncludedPackages;
+  private final List<String> coverageExcludedPackages;
 
-  public BuildSessionSettings(List<String> coverageEnabledPackages) {
-    this.coverageEnabledPackages = coverageEnabledPackages;
+  public BuildSessionSettings(
+      List<String> coverageIncludedPackages, List<String> coverageExcludedPackages) {
+    this.coverageIncludedPackages = coverageIncludedPackages;
+    this.coverageExcludedPackages = coverageExcludedPackages;
   }
 
-  public List<String> getCoverageEnabledPackages() {
-    return coverageEnabledPackages;
+  public List<String> getCoverageIncludedPackages() {
+    return coverageIncludedPackages;
+  }
+
+  public List<String> getCoverageExcludedPackages() {
+    return coverageExcludedPackages;
   }
 }