Add a TestProgress event type to the Build Event Protocol

This event may be used to report information about an executing TestRunner action.

PiperOrigin-RevId: 556865690
Change-Id: Ia654d2e228e94008218ca8e7362a9c11d353d4fe

Author: Googler

src/main/java/com/google/devtools/build/lib/analysis/BUILD

@@ -2777,6 +2777,18 @@ java_library(
     ],
 )
 
+java_library(
+    name = "test/test_progress",
+    srcs = ["test/TestProgress.java"],
+    deps = [
+        "//src/main/java/com/google/devtools/build/lib/buildeventstream",
+        "//src/main/java/com/google/devtools/build/lib/buildeventstream/proto:build_event_stream_java_proto",
+        "//src/main/java/com/google/devtools/build/lib/concurrent",
+        "//third_party:guava",
+        "//third_party:jsr305",
+    ],
+)
+
 java_library(
     name = "transitive_dependency_state",
     srcs = ["TransitiveDependencyState.java"],

src/main/java/com/google/devtools/build/lib/analysis/test/TestProgress.java

@@ -0,0 +1,107 @@
+// Copyright 2023 The Bazel Authors. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//    http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+package com.google.devtools.build.lib.analysis.test;
+
+import com.google.common.base.Objects;
+import com.google.common.collect.ImmutableList;
+import com.google.devtools.build.lib.buildeventstream.BuildEvent;
+import com.google.devtools.build.lib.buildeventstream.BuildEventContext;
+import com.google.devtools.build.lib.buildeventstream.BuildEventIdUtil;
+import com.google.devtools.build.lib.buildeventstream.BuildEventStreamProtos;
+import com.google.devtools.build.lib.buildeventstream.BuildEventStreamProtos.BuildEventId;
+import com.google.devtools.build.lib.buildeventstream.BuildEventStreamProtos.BuildEventId.ConfigurationId;
+import com.google.devtools.build.lib.buildeventstream.GenericBuildEvent;
+import com.google.devtools.build.lib.concurrent.ThreadSafety.Immutable;
+import javax.annotation.Nullable;
+
+/** This event may be raised while a test action is executing to report info about its execution. */
+@Immutable
+public final class TestProgress implements BuildEvent {
+  /** The label of the target for the action. */
+  private final String label;
+
+  /** The configuration under which the action is running. */
+  private final BuildEventId.ConfigurationId configId;
+
+  /** The run number of the test action (e.g. for runs_per_test > 1). */
+  private final int run;
+
+  /** For sharded tests, the shard number of the test action. */
+  private final int shard;
+
+  /** The execution attempt number which may increase due to retries. */
+  private final int attempt;
+
+  /** A count which may be incremented to differentiate events. */
+  private final int opaqueCount;
+
+  /** Identifies a resource that can provide info about the active test run. */
+  private final String uri;
+
+  public TestProgress(
+      String label,
+      ConfigurationId configId,
+      int run,
+      int shard,
+      int attempt,
+      int opaqueCount,
+      String uri) {
+    this.label = label;
+    this.configId = configId;
+    this.run = run;
+    this.shard = shard;
+    this.attempt = attempt;
+    this.opaqueCount = opaqueCount;
+    this.uri = uri;
+  }
+
+  @Override
+  public BuildEventId getEventId() {
+    return BuildEventIdUtil.testProgressId(label, configId, run, shard, attempt, opaqueCount);
+  }
+
+  @Override
+  public ImmutableList<BuildEventId> getChildrenEvents() {
+    return ImmutableList.of();
+  }
+
+  @Override
+  public BuildEventStreamProtos.BuildEvent asStreamProto(BuildEventContext converters) {
+    return GenericBuildEvent.protoChaining(this).setTestProgress(asTestResult()).build();
+  }
+
+  @Override
+  public int hashCode() {
+    return Objects.hashCode(label, configId, run, shard, attempt, opaqueCount, uri);
+  }
+
+  @Override
+  public boolean equals(@Nullable Object object) {
+    if (!(object instanceof TestProgress)) {
+      return false;
+    }
+    TestProgress other = (TestProgress) object;
+    return label.equals(other.label)
+        && configId.equals(other.configId)
+        && run == other.run
+        && shard == other.shard
+        && attempt == other.attempt
+        && opaqueCount == other.opaqueCount
+        && uri.equals(other.uri);
+  }
+
+  private BuildEventStreamProtos.TestProgress asTestResult() {
+    return BuildEventStreamProtos.TestProgress.newBuilder().setUri(uri).build();
+  }
+}

src/main/java/com/google/devtools/build/lib/buildeventstream/BuildEventIdUtil.java

@@ -257,6 +257,25 @@ public static BuildEventId testResult(
     return testResult(target, run, shard, 1, configuration);
   }
 
+  public static BuildEventId testProgressId(
+      String label,
+      BuildEventId.ConfigurationId configId,
+      int run,
+      int shard,
+      int attempt,
+      int opaqueCount) {
+    return BuildEventId.newBuilder()
+        .setTestProgress(
+            BuildEventId.TestProgressId.newBuilder()
+                .setLabel(label)
+                .setConfiguration(configId)
+                .setRun(run)
+                .setShard(shard)
+                .setAttempt(attempt)
+                .setOpaqueCount(opaqueCount))
+        .build();
+  }
+
   public static BuildEventId testSummary(Label target, BuildEventId configuration) {
     BuildEventId.ConfigurationId configId = configuration.getConfiguration();
     BuildEventId.TestSummaryId summaryId =

src/main/java/com/google/devtools/build/lib/buildeventstream/proto/build_event_stream.proto

@@ -201,6 +201,24 @@ message BuildEventId {
     int32 attempt = 4;
   }
 
+  // Identifier of an event reporting progress of an individual test run.
+  message TestProgressId {
+    // The label of the target for the action.
+    string label = 1;
+    // The configuration under which the action is running.
+    ConfigurationId configuration = 2;
+    // The run number of the test action (e.g. for runs_per_test > 1).
+    int32 run = 3;
+    // For sharded tests, the shard number of the test action.
+    int32 shard = 4;
+    // The execution attempt number which may increase due to retries (e.g. for
+    // flaky tests).
+    int32 attempt = 5;
+    // An incrementing count used to differentiate TestProgressIds for the same
+    // test attempt.
+    int32 opaque_count = 6;
+  }
+
   // Identifier of an event reporting the summary of a test.
   message TestSummaryId {
     string label = 1;
@@ -252,6 +270,7 @@ message BuildEventId {
     UnconfiguredLabelId unconfigured_label = 19;
     ConfiguredLabelId configured_label = 21;
     TestResultId test_result = 8;
+    TestProgressId test_progress = 29;
     TestSummaryId test_summary = 7;
     TargetSummaryId target_summary = 26;
     BuildFinishedId build_finished = 9;
@@ -725,6 +744,15 @@ message TestResult {
   ExecutionInfo execution_info = 8;
 }
 
+// Event payload providing information about an active, individual test run.
+message TestProgress {
+  // Identifies a resource that may provide information about an active test
+  // run. The resource is not necessarily a file and may need to be queried
+  // for information. The URI is not guaranteed to be available after the test
+  // completes. The string is encoded according to RFC2396.
+  string uri = 1;
+}
+
 // Payload of the event summarizing a test.
 message TestSummary {
   // Wrapper around BlazeTestStatus to support importing that enum to proto3.
@@ -1250,6 +1278,7 @@ message BuildEvent {
     NamedSetOfFiles named_set_of_files = 15;
     TargetComplete completed = 8;
     TestResult test_result = 10;
+    TestProgress test_progress = 30;
     TestSummary test_summary = 9;
     TargetSummary target_summary = 28;
     BuildFinished finished = 14;

src/test/java/com/google/devtools/build/lib/analysis/BUILD

@@ -119,6 +119,7 @@ java_library(
         "//src/main/java/com/google/devtools/build/lib/analysis:target_and_configuration",
         "//src/main/java/com/google/devtools/build/lib/analysis:test/instrumented_files_info",
         "//src/main/java/com/google/devtools/build/lib/analysis:test/test_configuration",
+        "//src/main/java/com/google/devtools/build/lib/analysis:test/test_progress",
         "//src/main/java/com/google/devtools/build/lib/analysis:test/test_trimming_transition_factory",
         "//src/main/java/com/google/devtools/build/lib/analysis:top_level_artifact_context",
         "//src/main/java/com/google/devtools/build/lib/analysis:transitive_dependency_state",

src/test/java/com/google/devtools/build/lib/analysis/test/TestProgressTest.java

@@ -0,0 +1,75 @@
+// Copyright 2023 The Bazel Authors. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+package com.google.devtools.build.lib.analysis.test;
+
+import static com.google.common.truth.extensions.proto.ProtoTruth.assertThat;
+
+import com.google.devtools.build.lib.buildeventstream.BuildEventStreamProtos;
+import com.google.devtools.build.lib.buildeventstream.BuildEventStreamProtos.BuildEvent;
+import com.google.devtools.build.lib.buildeventstream.BuildEventStreamProtos.BuildEventId;
+import com.google.devtools.build.lib.buildeventstream.BuildEventStreamProtos.BuildEventId.ConfigurationId;
+import com.google.devtools.build.lib.buildeventstream.BuildEventStreamProtos.BuildEventId.TestProgressId;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.junit.runners.JUnit4;
+
+@RunWith(JUnit4.class)
+public class TestProgressTest {
+  @Test
+  public void testTestProgress_convertsToEventId() {
+    TestProgress progress =
+        new TestProgress(
+            "alabel", ConfigurationId.newBuilder().setId("configid").build(), 1, 2, 3, 4, "auri");
+
+    BuildEventId id = progress.getEventId();
+
+    assertThat(id)
+        .isEqualTo(
+            BuildEventId.newBuilder()
+                .setTestProgress(
+                    TestProgressId.newBuilder()
+                        .setLabel("alabel")
+                        .setConfiguration(ConfigurationId.newBuilder().setId("configid"))
+                        .setRun(1)
+                        .setShard(2)
+                        .setAttempt(3)
+                        .setOpaqueCount(4))
+                .build());
+  }
+
+  @Test
+  public void testTestProgress_convertsToEvent() {
+    TestProgress progress =
+        new TestProgress(
+            "alabel", ConfigurationId.newBuilder().setId("configid").build(), 1, 2, 3, 4, "auri");
+
+    BuildEvent event = progress.asStreamProto(null);
+
+    assertThat(event)
+        .isEqualTo(
+            BuildEvent.newBuilder()
+                .setId(
+                    BuildEventId.newBuilder()
+                        .setTestProgress(
+                            TestProgressId.newBuilder()
+                                .setLabel("alabel")
+                                .setConfiguration(ConfigurationId.newBuilder().setId("configid"))
+                                .setRun(1)
+                                .setShard(2)
+                                .setAttempt(3)
+                                .setOpaqueCount(4)))
+                .setTestProgress(BuildEventStreamProtos.TestProgress.newBuilder().setUri("auri"))
+                .build());
+  }
+}