Implement sending total coverage percentage for sessions and modules (DataDog#5769)

Author: nikita-tkachenko-datadog

dd-java-agent/agent-ci-visibility/build.gradle

@@ -7,6 +7,8 @@ apply from: "$rootDir/gradle/java.gradle"
 apply from: "$rootDir/gradle/version.gradle"
 
 minimumBranchCoverage = 0.7
+minimumInstructionCoverage = 0.8
+
 excludedClassesCoverage += [
   "datadog.trace.civisibility.CiVisibilitySystem",
   "datadog.trace.civisibility.CiVisibilitySystem.1",
@@ -38,14 +40,16 @@ excludedClassesCoverage += [
   "datadog.trace.civisibility.context.EmptyTestContext",
   "datadog.trace.civisibility.context.ParentProcessTestContext",
   "datadog.trace.civisibility.context.SpanTestContext",
-  "datadog.trace.civisibility.coverage.TestProbes.TestProbesFactory",
+  "datadog.trace.civisibility.coverage.CoverageUtils",
+  "datadog.trace.civisibility.coverage.CoverageUtils.RepoIndexFileLocator",
   "datadog.trace.civisibility.coverage.ExecutionDataAdapter",
   "datadog.trace.civisibility.coverage.NoopCoverageProbeStore",
   "datadog.trace.civisibility.coverage.NoopCoverageProbeStore.NoopCoverageProbeStoreFactory",
   "datadog.trace.civisibility.coverage.SegmentlessTestProbes",
   "datadog.trace.civisibility.coverage.SegmentlessTestProbes.SegmentlessTestProbesFactory",
   "datadog.trace.civisibility.coverage.SourceAnalyzer",
   "datadog.trace.civisibility.coverage.TestProbes",
+  "datadog.trace.civisibility.coverage.TestProbes.TestProbesFactory",
   "datadog.trace.civisibility.events.BuildEventsHandlerImpl",
   "datadog.trace.civisibility.events.TestEventsHandlerImpl",
   "datadog.trace.civisibility.events.TestDescriptor",
@@ -69,15 +73,14 @@ excludedClassesCoverage += [
   "datadog.trace.civisibility.utils.ShellCommandExecutor",
   "datadog.trace.civisibility.utils.ShellCommandExecutor.OutputParser",
 ]
-minimumInstructionCoverage = 0.8
-
 
 dependencies {
   api deps.slf4j
 
   implementation deps.asm
   implementation deps.asmcommons
   implementation group: 'org.jacoco', name: 'org.jacoco.core', version: '0.8.9'
+  implementation group: 'org.jacoco', name: 'org.jacoco.report', version: '0.8.9'
 
   implementation project(':communication')
   implementation project(':internal-api')

dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/CiVisibilitySystem.java

@@ -4,6 +4,7 @@
 import datadog.trace.api.Config;
 import datadog.trace.api.civisibility.CIVisibility;
 import datadog.trace.api.civisibility.InstrumentationBridge;
+import datadog.trace.api.civisibility.coverage.CoverageDataSupplier;
 import datadog.trace.api.civisibility.events.BuildEventsHandler;
 import datadog.trace.api.civisibility.events.TestEventsHandler;
 import datadog.trace.api.config.CiVisibilityConfig;
@@ -188,6 +189,7 @@ private static DDTestSessionImpl.SessionImplFactory sessionFactory(
         RepoIndexBuilder indexBuilder = new RepoIndexBuilder(repoRoot, FileSystems.getDefault());
         return new DDTestSessionParent(
             projectName,
+            repoRoot,
             startTime,
             config,
             testModuleRegistry,
@@ -214,6 +216,7 @@ private static DDTestSessionImpl.SessionImplFactory sessionFactory(
         signalServerAddress = new InetSocketAddress(host, Integer.parseInt(port));
       }
 
+      CoverageDataSupplier coverageDataSupplier = InstrumentationBridge::getCoverageData;
       return new DDTestSessionChild(
           parentProcessSessionId,
           parentProcessModuleId,
@@ -223,6 +226,7 @@ private static DDTestSessionImpl.SessionImplFactory sessionFactory(
           codeowners,
           methodLinesResolver,
           coverageProbeStoreFactory,
+          coverageDataSupplier,
           signalServerAddress);
     };
   }

dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/DDTestModuleChild.java

@@ -2,6 +2,7 @@
 
 import datadog.trace.api.Config;
 import datadog.trace.api.civisibility.config.SkippableTest;
+import datadog.trace.api.civisibility.coverage.CoverageDataSupplier;
 import datadog.trace.bootstrap.instrumentation.api.Tags;
 import datadog.trace.civisibility.codeowners.Codeowners;
 import datadog.trace.civisibility.config.JvmInfo;
@@ -30,6 +31,7 @@ public class DDTestModuleChild extends DDTestModuleImpl {
   private static final Logger log = LoggerFactory.getLogger(DDTestModuleChild.class);
 
   private final ParentProcessTestContext context;
+  private final CoverageDataSupplier coverageDataSupplier;
 
   public DDTestModuleChild(
       Long parentProcessSessionId,
@@ -41,6 +43,7 @@ public DDTestModuleChild(
       Codeowners codeowners,
       MethodLinesResolver methodLinesResolver,
       CoverageProbeStoreFactory coverageProbeStoreFactory,
+      CoverageDataSupplier coverageDataSupplier,
       @Nullable InetSocketAddress signalServerAddress) {
     super(
         moduleName,
@@ -52,6 +55,7 @@ public DDTestModuleChild(
         coverageProbeStoreFactory,
         signalServerAddress);
     context = new ParentProcessTestContext(parentProcessSessionId, parentProcessModuleId);
+    this.coverageDataSupplier = coverageDataSupplier;
   }
 
   @Override
@@ -89,6 +93,7 @@ private void sendModuleExecutionResult() {
     long testsSkippedTotal = testsSkipped.sum();
     String testFramework = String.valueOf(context.getChildTag(Tags.TEST_FRAMEWORK));
     String testFrameworkVersion = String.valueOf(context.getChildTag(Tags.TEST_FRAMEWORK_VERSION));
+    byte[] coverageData = coverageDataSupplier.get();
 
     ModuleExecutionResult moduleExecutionResult =
         new ModuleExecutionResult(
@@ -98,7 +103,8 @@ private void sendModuleExecutionResult() {
             itrEnabled,
             testsSkippedTotal,
             testFramework,
-            testFrameworkVersion);
+            testFrameworkVersion,
+            coverageData);
 
     try (SignalClient signalClient = new SignalClient(signalServerAddress)) {
       signalClient.send(moduleExecutionResult);

dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/DDTestModuleParent.java

@@ -17,15 +17,22 @@
 import datadog.trace.civisibility.context.SpanTestContext;
 import datadog.trace.civisibility.context.TestContext;
 import datadog.trace.civisibility.coverage.CoverageProbeStoreFactory;
+import datadog.trace.civisibility.coverage.CoverageUtils;
 import datadog.trace.civisibility.decorator.TestDecorator;
 import datadog.trace.civisibility.ipc.ModuleExecutionResult;
 import datadog.trace.civisibility.source.MethodLinesResolver;
 import datadog.trace.civisibility.source.SourcePathResolver;
+import datadog.trace.civisibility.source.index.RepoIndexProvider;
+import java.io.File;
 import java.net.InetSocketAddress;
+import java.nio.file.Paths;
 import java.util.Collection;
 import java.util.HashSet;
 import java.util.Map;
 import javax.annotation.Nullable;
+import org.jacoco.core.analysis.IBundleCoverage;
+import org.jacoco.core.analysis.ICounter;
+import org.jacoco.core.data.ExecutionDataStore;
 
 /**
  * Representation of a test module in a parent process:
@@ -40,22 +47,27 @@ public class DDTestModuleParent extends DDTestModuleImpl {
   private final AgentSpan span;
   private final SpanTestContext context;
   private final TestContext sessionContext;
-  private final TestModuleRegistry testModuleRegistry;
+  private final String repoRoot;
+  private final Collection<File> outputClassesDirs;
   private final ModuleExecutionSettingsFactory moduleExecutionSettingsFactory;
+  private final RepoIndexProvider repoIndexProvider;
   private volatile boolean codeCoverageEnabled;
   private volatile boolean itrEnabled;
 
   public DDTestModuleParent(
       TestContext sessionContext,
       String moduleName,
+      String repoRoot,
+      @Nullable String startCommand,
       @Nullable Long startTime,
+      Collection<File> outputClassesDirs,
       Config config,
-      TestModuleRegistry testModuleRegistry,
       TestDecorator testDecorator,
       SourcePathResolver sourcePathResolver,
       Codeowners codeowners,
       MethodLinesResolver methodLinesResolver,
       ModuleExecutionSettingsFactory moduleExecutionSettingsFactory,
+      RepoIndexProvider repoIndexProvider,
       CoverageProbeStoreFactory coverageProbeStoreFactory,
       @Nullable InetSocketAddress signalServerAddress) {
     super(
@@ -68,8 +80,10 @@ public DDTestModuleParent(
         coverageProbeStoreFactory,
         signalServerAddress);
     this.sessionContext = sessionContext;
-    this.testModuleRegistry = testModuleRegistry;
+    this.repoRoot = repoRoot;
+    this.outputClassesDirs = outputClassesDirs;
     this.moduleExecutionSettingsFactory = moduleExecutionSettingsFactory;
+    this.repoIndexProvider = repoIndexProvider;
 
     AgentSpan sessionSpan = sessionContext.getSpan();
     AgentSpan.Context sessionSpanContext = sessionSpan != null ? sessionSpan.context() : null;
@@ -91,6 +105,10 @@ public DDTestModuleParent(
     span.setTag(Tags.TEST_MODULE_ID, context.getId());
     span.setTag(Tags.TEST_SESSION_ID, sessionContext.getId());
 
+    if (startCommand != null) {
+      span.setTag(Tags.TEST_COMMAND, startCommand);
+    }
+
     testDecorator.afterStart(span);
   }
 
@@ -121,8 +139,6 @@ public void setSkipReason(String skipReason) {
 
   @Override
   public void end(@Nullable Long endTime) {
-    testModuleRegistry.removeModule(this);
-
     span.setTag(Tags.TEST_STATUS, context.getStatus());
     sessionContext.reportChildStatus(context.getStatus());
 
@@ -165,7 +181,8 @@ private boolean propertyEnabled(Map<String, String> systemProperties, String pro
     return Boolean.parseBoolean(property);
   }
 
-  public void onModuleExecutionResultReceived(ModuleExecutionResult result) {
+  public void onModuleExecutionResultReceived(
+      ModuleExecutionResult result, ExecutionDataStore coverageData) {
     codeCoverageEnabled = result.isCoverageEnabled();
     itrEnabled = result.isItrEnabled();
     testsSkipped.add(result.getTestsSkippedTotal());
@@ -179,5 +196,44 @@ public void onModuleExecutionResultReceived(ModuleExecutionResult result) {
     if (testFrameworkVersion != null) {
       span.setTag(Tags.TEST_FRAMEWORK_VERSION, testFrameworkVersion);
     }
+
+    processCoverageData(coverageData);
+  }
+
+  private void processCoverageData(ExecutionDataStore coverageData) {
+    if (coverageData == null) {
+      return;
+    }
+    IBundleCoverage coverageBundle =
+        CoverageUtils.createCoverageBundle(coverageData, outputClassesDirs);
+    if (coverageBundle == null) {
+      return;
+    }
+
+    long coveragePercentage = getCoveragePercentage(coverageBundle);
+    span.setTag(Tags.TEST_CODE_COVERAGE_LINES_PERCENTAGE, coveragePercentage);
+
+    File coverageReportFolder = getCoverageReportFolder();
+    if (coverageReportFolder != null) {
+      CoverageUtils.dumpCoverageReport(
+          coverageBundle, repoIndexProvider.getIndex(), repoRoot, coverageReportFolder);
+    }
+  }
+
+  private static long getCoveragePercentage(IBundleCoverage coverageBundle) {
+    ICounter instructionCounter = coverageBundle.getInstructionCounter();
+    int totalInstructionsCount = instructionCounter.getTotalCount();
+    int coveredInstructionsCount = instructionCounter.getCoveredCount();
+    return Math.round((100d * coveredInstructionsCount) / totalInstructionsCount);
+  }
+
+  private File getCoverageReportFolder() {
+    String coverageReportDumpDir = config.getCiVisibilityCodeCoverageReportDumpDir();
+    if (coverageReportDumpDir != null) {
+      return Paths.get(coverageReportDumpDir, "session-" + context.getParentId(), moduleName)
+          .toFile();
+    } else {
+      return null;
+    }
   }
 }

dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/DDTestSessionChild.java

@@ -2,13 +2,16 @@
 
 import datadog.trace.api.Config;
 import datadog.trace.api.civisibility.config.ModuleExecutionSettings;
+import datadog.trace.api.civisibility.coverage.CoverageDataSupplier;
 import datadog.trace.civisibility.codeowners.Codeowners;
 import datadog.trace.civisibility.config.JvmInfo;
 import datadog.trace.civisibility.coverage.CoverageProbeStoreFactory;
 import datadog.trace.civisibility.decorator.TestDecorator;
 import datadog.trace.civisibility.source.MethodLinesResolver;
 import datadog.trace.civisibility.source.SourcePathResolver;
+import java.io.File;
 import java.net.InetSocketAddress;
+import java.util.Collection;
 import javax.annotation.Nullable;
 
 public class DDTestSessionChild extends DDTestSessionImpl {
@@ -21,6 +24,7 @@ public class DDTestSessionChild extends DDTestSessionImpl {
   private final Codeowners codeowners;
   private final MethodLinesResolver methodLinesResolver;
   private final CoverageProbeStoreFactory coverageProbeStoreFactory;
+  private final CoverageDataSupplier coverageDataSupplier;
   @Nullable private final InetSocketAddress signalServerAddress;
 
   public DDTestSessionChild(
@@ -32,6 +36,7 @@ public DDTestSessionChild(
       Codeowners codeowners,
       MethodLinesResolver methodLinesResolver,
       CoverageProbeStoreFactory coverageProbeStoreFactory,
+      CoverageDataSupplier coverageDataSupplier,
       @Nullable InetSocketAddress signalServerAddress) {
     this.parentProcessSessionId = parentProcessSessionId;
     this.parentProcessModuleId = parentProcessModuleId;
@@ -41,6 +46,7 @@ public DDTestSessionChild(
     this.codeowners = codeowners;
     this.methodLinesResolver = methodLinesResolver;
     this.coverageProbeStoreFactory = coverageProbeStoreFactory;
+    this.coverageDataSupplier = coverageDataSupplier;
     this.signalServerAddress = signalServerAddress;
   }
 
@@ -65,7 +71,8 @@ public void end(@Nullable Long endTime) {
   }
 
   @Override
-  public DDTestModuleImpl testModuleStart(String moduleName, @Nullable Long startTime) {
+  public DDTestModuleImpl testModuleStart(
+      String moduleName, @Nullable Long startTime, Collection<File> outputClassesDirs) {
     return new DDTestModuleChild(
         parentProcessSessionId,
         parentProcessModuleId,
@@ -76,6 +83,7 @@ public DDTestModuleImpl testModuleStart(String moduleName, @Nullable Long startT
         codeowners,
         methodLinesResolver,
         coverageProbeStoreFactory,
+        coverageDataSupplier,
         signalServerAddress);
   }
 

dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/DDTestSessionImpl.java

@@ -4,12 +4,20 @@
 import datadog.trace.api.civisibility.DDTestSession;
 import datadog.trace.api.civisibility.config.ModuleExecutionSettings;
 import datadog.trace.civisibility.config.JvmInfo;
+import java.io.File;
 import java.nio.file.Path;
+import java.util.Collection;
+import java.util.Collections;
 import javax.annotation.Nullable;
 
 public abstract class DDTestSessionImpl implements DDTestSession {
 
-  public abstract DDTestModuleImpl testModuleStart(String moduleName, @Nullable Long startTime);
+  public DDTestModuleImpl testModuleStart(String moduleName, @Nullable Long startTime) {
+    return testModuleStart(moduleName, startTime, Collections.emptyList());
+  }
+
+  public abstract DDTestModuleImpl testModuleStart(
+      String moduleName, @Nullable Long startTime, Collection<File> outputClassesDirs);
 
   public abstract ModuleExecutionSettings getModuleExecutionSettings(JvmInfo jvmInfo);