Add baseline_coverage_files to java_common.compile

Author: fmeum

src/main/java/com/google/devtools/build/lib/rules/java/JavaCompilationHelper.java

@@ -71,6 +71,7 @@ public final class JavaCompilationHelper {
   private NestedSet<String> javaBuilderJvmFlags = NestedSetBuilder.emptySet(Order.STABLE_ORDER);
   private final JavaSemantics semantics;
   private final ImmutableList<Artifact> additionalInputsForDatabinding;
+  @Nullable private final Artifact baselineCoverageFile;
   private boolean enableJspecify = true;
   private boolean enableDirectClasspath = true;
   private final String execGroup;
@@ -81,13 +82,15 @@ public JavaCompilationHelper(
       ImmutableList<String> javacOpts,
       JavaTargetAttributes.Builder attributes,
       JavaToolchainProvider javaToolchainProvider,
-      ImmutableList<Artifact> additionalInputsForDatabinding) {
+      ImmutableList<Artifact> additionalInputsForDatabinding,
+      @Nullable Artifact baselineCoverageFile) {
     this.ruleContext = ruleContext;
     this.javaToolchain = Preconditions.checkNotNull(javaToolchainProvider);
     this.attributes = attributes;
     this.customJavacOpts = javacOptsInterner.intern(javacOpts);
     this.semantics = semantics;
     this.additionalInputsForDatabinding = additionalInputsForDatabinding;
+    this.baselineCoverageFile = baselineCoverageFile;
 
     if (ruleContext.useAutoExecGroups()) {
       this.execGroup = semantics.getJavaToolchainType();
@@ -247,6 +250,7 @@ && getJavaConfiguration().experimentalEnableJspecify()
     builder.setTargetLabel(label);
     Artifact coverageArtifact = maybeCreateCoverageArtifact(outputs.output());
     builder.setCoverageArtifact(coverageArtifact);
+    builder.setBaselineCoverageFile(baselineCoverageFile);
     BootClassPathInfo bootClassPathInfo = getBootclasspathOrDefault();
     builder.setBootClassPath(bootClassPathInfo);
     NestedSet<Artifact> classpath =
@@ -386,7 +390,9 @@ public BootClassPathInfo getBootclasspathOrDefault() throws RuleErrorException {
    */
   @Nullable
   private Artifact maybeCreateCoverageArtifact(Artifact compileJar) {
-    if (!shouldInstrumentJar()) {
+    // baselineCoverageFile != null is meant to be equivalent to shouldInstrumentJar(), but we need
+    // to check both to support older versions of rules_java that do not set baseline_coverage_file.
+    if (!shouldInstrumentJar() && baselineCoverageFile == null) {
       return null;
     }
     PathFragment packageRelativePath =

src/main/java/com/google/devtools/build/lib/rules/java/JavaCompileActionBuilder.java

@@ -136,7 +136,8 @@ public void extend(ExtraActionInfo.Builder builder, ImmutableList<String> argume
   private final JavaToolchainProvider toolchain;
   private final String execGroup;
   private ImmutableSet<Artifact> additionalOutputs = ImmutableSet.of();
-  private Artifact coverageArtifact;
+  @Nullable private Artifact coverageArtifact;
+  @Nullable private Artifact baselineCoverageFile;
   private ImmutableSet<Artifact> sourceFiles = ImmutableSet.of();
   private ImmutableList<Artifact> sourceJars = ImmutableList.of();
   private StrictDepsMode strictJavaDeps = StrictDepsMode.ERROR;
@@ -269,7 +270,12 @@ public JavaCompileAction build() throws RuleErrorException, InterruptedException
   private ImmutableSet<Artifact> allOutputs() {
     ImmutableSet.Builder<Artifact> result =
         ImmutableSet.<Artifact>builder().add(outputs.output()).addAll(additionalOutputs);
-    Stream.of(outputs.depsProto(), outputs.nativeHeader(), genSourceOutput, manifestOutput)
+    Stream.of(
+            outputs.depsProto(),
+            outputs.nativeHeader(),
+            genSourceOutput,
+            manifestOutput,
+            baselineCoverageFile)
         .filter(Objects::nonNull)
         .forEachOrdered(result::add);
     return result.build();
@@ -326,6 +332,13 @@ private CustomCommandLine buildParamFileContents(ImmutableList<String> javacOpts
     if (coverageArtifact != null) {
       result.add("--post_processor");
       result.addExecPath(JACOCO_INSTRUMENTATION_PROCESSOR, coverageArtifact);
+      if (baselineCoverageFile != null) {
+        result.addExecPath(baselineCoverageFile);
+      }
+    } else {
+      Preconditions.checkState(
+          baselineCoverageFile == null,
+          "baselineCoverageFile should be null if coverageArtifact is null");
     }
     return result.build();
   }
@@ -450,11 +463,17 @@ public JavaCompileActionBuilder setJavaBuilder(JavaToolchainTool javaBuilder) {
   }
 
   @CanIgnoreReturnValue
-  public JavaCompileActionBuilder setCoverageArtifact(Artifact coverageArtifact) {
+  public JavaCompileActionBuilder setCoverageArtifact(@Nullable Artifact coverageArtifact) {
     this.coverageArtifact = coverageArtifact;
     return this;
   }
 
+  @CanIgnoreReturnValue
+  public JavaCompileActionBuilder setBaselineCoverageFile(@Nullable Artifact baselineCoverageFile) {
+    this.baselineCoverageFile = baselineCoverageFile;
+    return this;
+  }
+
   @CanIgnoreReturnValue
   public JavaCompileActionBuilder setTargetLabel(Label targetLabel) {
     this.targetLabel = targetLabel;

src/main/java/com/google/devtools/build/lib/rules/java/JavaStarlarkCommon.java

@@ -169,8 +169,8 @@ public void createHeaderCompilationAction(
             JavaHelper.tokenizeJavaOptions(Depset.cast(javacOpts, String.class, "javac_opts")),
             attributesBuilder,
             JavaToolchainProvider.wrap(toolchain),
-            Sequence.cast(additionalInputs, Artifact.class, "additional_inputs")
-                .getImmutableList());
+            Sequence.cast(additionalInputs, Artifact.class, "additional_inputs").getImmutableList(),
+            /* baselineCoverageFile= */ null);
     compilationHelper.enableDirectClasspath(enableDirectClasspath);
     compilationHelper.createHeaderCompilationAction(
         headerJar,
@@ -207,7 +207,8 @@ public void createCompilationAction(
       boolean enableJSpecify,
       boolean enableDirectClasspath,
       Sequence<?> additionalInputs,
-      Sequence<?> additionalOutputs)
+      Sequence<?> additionalOutputs,
+      Object baselineCoverageFile)
       throws EvalException,
           TypeException,
           RuleErrorException,
@@ -261,8 +262,8 @@ public void createCompilationAction(
             JavaHelper.tokenizeJavaOptions(Depset.cast(javacOpts, String.class, "javac_opts")),
             attributesBuilder,
             JavaToolchainProvider.wrap(javaToolchain),
-            Sequence.cast(additionalInputs, Artifact.class, "additional_inputs")
-                .getImmutableList());
+            Sequence.cast(additionalInputs, Artifact.class, "additional_inputs").getImmutableList(),
+            baselineCoverageFile == Starlark.NONE ? null : (Artifact) baselineCoverageFile);
     compilationHelper.javaBuilderJvmFlags(
         Depset.cast(javaBuilderJvmFlags, String.class, "javabuilder_jvm_flags"));
     compilationHelper.enableJspecify(enableJSpecify);

src/main/java/com/google/devtools/build/lib/starlarkbuildapi/java/JavaCommonApi.java

@@ -525,6 +525,7 @@ void createHeaderCompilationAction(
         @Param(name = "enable_direct_classpath", defaultValue = "True", named = true),
         @Param(name = "additional_inputs", defaultValue = "[]", named = true),
         @Param(name = "additional_outputs", defaultValue = "[]", named = true),
+        @Param(name = "baseline_coverage_file", defaultValue = "None", named = true),
       })
   void createCompilationAction(
       StarlarkRuleContextT ctx,
@@ -554,7 +555,8 @@ void createCompilationAction(
       boolean enableJSpecify,
       boolean enableDirectClasspath,
       Sequence<?> additionalInputs,
-      Sequence<?> additionalOutputs)
+      Sequence<?> additionalOutputs,
+      Object baselineCoverageFile)
       throws EvalException,
           TypeException,
           RuleErrorException,

src/test/shell/bazel/bazel_coverage_java_test.sh

@@ -232,6 +232,31 @@ LF:6
 end_of_record"
 
   assert_coverage_result "$expected_result" "./bazel-out/_coverage/_coverage_report.dat"
+
+  local expected_baseline_result="SF:src/main/com/example/Collatz.java
+FN:3,com/example/Collatz::<init> ()V
+FN:6,com/example/Collatz::getCollatzFinal (I)I
+FNDA:0,com/example/Collatz::<init> ()V
+FNDA:0,com/example/Collatz::getCollatzFinal (I)I
+FNF:2
+FNH:0
+BRDA:6,0,0,-
+BRDA:6,0,1,-
+BRDA:9,0,0,-
+BRDA:9,0,1,-
+BRF:4
+BRH:0
+DA:3,0
+DA:6,0
+DA:7,0
+DA:9,0
+DA:10,0
+DA:12,0
+LH:0
+LF:6
+end_of_record"
+  # TODO(#5716): Enable this check after the next rules_java update.
+  # assert_coverage_result "$expected_baseline_result" "./bazel-out/_coverage/_baseline_report.dat"
 }
 
 function test_java_test_java_import_coverage() {