Allow to manually set PR info (#8566)

Author: nikita-tkachenko-datadog

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

@@ -9,6 +9,7 @@
 import datadog.trace.civisibility.ci.CIProviderInfo;
 import datadog.trace.civisibility.ci.CITagsProvider;
 import datadog.trace.civisibility.ci.PullRequestInfo;
+import datadog.trace.civisibility.ci.env.CiEnvironment;
 import datadog.trace.civisibility.codeowners.Codeowners;
 import datadog.trace.civisibility.codeowners.CodeownersProvider;
 import datadog.trace.civisibility.codeowners.NoCodeowners;
@@ -39,6 +40,7 @@
 import java.nio.file.Paths;
 import java.util.Map;
 import java.util.concurrent.CompletableFuture;
+import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -64,7 +66,7 @@ public class CiVisibilityRepoServices {
     ciProvider = ciProviderInfo.getProvider();
 
     CIInfo ciInfo = ciProviderInfo.buildCIInfo();
-    PullRequestInfo pullRequestInfo = ciProviderInfo.buildPullRequestInfo();
+    PullRequestInfo pullRequestInfo = buildPullRequestInfo(services.environment, ciProviderInfo);
 
     if (pullRequestInfo.isNotEmpty()) {
       LOGGER.info("PR detected: {}", pullRequestInfo);
@@ -107,6 +109,22 @@ public class CiVisibilityRepoServices {
     }
   }
 
+  @Nonnull
+  private static PullRequestInfo buildPullRequestInfo(
+      CiEnvironment environment, CIProviderInfo ciProviderInfo) {
+    PullRequestInfo ciProviderPrInfo = ciProviderInfo.buildPullRequestInfo();
+    if (ciProviderPrInfo.isNotEmpty()) {
+      return ciProviderPrInfo;
+    }
+
+    // could not get PR info from CI provider,
+    // check if it was set manually
+    return new PullRequestInfo(
+        null,
+        environment.get(Constants.DDCI_PULL_REQUEST_TARGET_SHA),
+        environment.get(Constants.DDCI_PULL_REQUEST_SOURCE_SHA));
+  }
+
   private static String getRepoRoot(CIInfo ciInfo, GitClient.Factory gitClientFactory) {
     String ciWorkspace = ciInfo.getNormalizedCiWorkspace();
     if (Strings.isNotBlank(ciWorkspace)) {

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

@@ -67,6 +67,7 @@ public class CiVisibilityServices {
   final CiVisibilityMetricCollector metricCollector;
   final BackendApi backendApi;
   final JvmInfoFactory jvmInfoFactory;
+  final CiEnvironment environment;
   final CIProviderInfoFactory ciProviderInfoFactory;
   final GitClient.Factory gitClientFactory;
   final GitInfoProvider gitInfoProvider;
@@ -87,7 +88,7 @@ public class CiVisibilityServices {
     this.jvmInfoFactory = new CachingJvmInfoFactory(config, new JvmInfoFactoryImpl());
     this.gitClientFactory = buildGitClientFactory(config, metricCollector);
 
-    CiEnvironment environment = buildCiEnvironment(config, sco);
+    this.environment = buildCiEnvironment(config, sco);
     this.ciProviderInfoFactory = new CIProviderInfoFactory(config, environment);
     this.linesResolver =
         new BestEffortLinesResolver(new CompilerAidedLinesResolver(), new ByteCodeLinesResolver());

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

@@ -0,0 +1,25 @@
+package datadog.trace.civisibility;
+
+/** Constants that are not part of the internal (or external) API. */
+public interface Constants {
+
+  /**
+   * Indicates that early flakiness detection feature was aborted in a test session because too many
+   * test cases were considered new.
+   */
+  String EFD_ABORT_REASON_FAULTY = "faulty";
+
+  String CI_VISIBILITY_INSTRUMENTATION_NAME = "civisibility";
+
+  /**
+   * Env var containing SHA of the feature branch HEAD commit when running in a PR. Set manually if
+   * the necessary data is not exposed by the CI provider
+   */
+  String DDCI_PULL_REQUEST_SOURCE_SHA = "DDCI_PULL_REQUEST_SOURCE_SHA";
+
+  /**
+   * Env var containing SHA of the target branch HEAD commit when running in a PR. Set manually if
+   * the necessary data is not exposed by the CI provider
+   */
+  String DDCI_PULL_REQUEST_TARGET_SHA = "DDCI_PULL_REQUEST_TARGET_SHA";
+}

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

@@ -1,6 +1,6 @@
 package datadog.trace.civisibility.domain;
 
-import static datadog.trace.api.civisibility.CIConstants.CI_VISIBILITY_INSTRUMENTATION_NAME;
+import static datadog.trace.civisibility.Constants.CI_VISIBILITY_INSTRUMENTATION_NAME;
 
 import datadog.trace.api.Config;
 import datadog.trace.api.civisibility.telemetry.CiVisibilityCountMetric;

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

@@ -1,7 +1,7 @@
 package datadog.trace.civisibility.domain;
 
 import static datadog.trace.api.TracePropagationStyle.NONE;
-import static datadog.trace.api.civisibility.CIConstants.CI_VISIBILITY_INSTRUMENTATION_NAME;
+import static datadog.trace.civisibility.Constants.CI_VISIBILITY_INSTRUMENTATION_NAME;
 
 import datadog.trace.api.Config;
 import datadog.trace.api.DDTraceId;

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

@@ -1,8 +1,8 @@
 package datadog.trace.civisibility.domain;
 
 import static datadog.json.JsonMapper.toJson;
-import static datadog.trace.api.civisibility.CIConstants.CI_VISIBILITY_INSTRUMENTATION_NAME;
 import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.activateSpan;
+import static datadog.trace.civisibility.Constants.CI_VISIBILITY_INSTRUMENTATION_NAME;
 
 import datadog.trace.api.Config;
 import datadog.trace.api.DDTraceId;

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

@@ -1,8 +1,8 @@
 package datadog.trace.civisibility.domain;
 
 import static datadog.json.JsonMapper.toJson;
-import static datadog.trace.api.civisibility.CIConstants.CI_VISIBILITY_INSTRUMENTATION_NAME;
 import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.activateSpan;
+import static datadog.trace.civisibility.Constants.CI_VISIBILITY_INSTRUMENTATION_NAME;
 
 import datadog.trace.api.Config;
 import datadog.trace.api.civisibility.DDTestSuite;

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

@@ -6,7 +6,6 @@
 import datadog.context.propagation.CarrierSetter;
 import datadog.trace.api.Config;
 import datadog.trace.api.DDTags;
-import datadog.trace.api.civisibility.CIConstants;
 import datadog.trace.api.civisibility.domain.BuildModuleLayout;
 import datadog.trace.api.civisibility.domain.BuildModuleSettings;
 import datadog.trace.api.civisibility.domain.BuildSessionSettings;
@@ -16,6 +15,7 @@
 import datadog.trace.bootstrap.instrumentation.api.AgentSpan;
 import datadog.trace.bootstrap.instrumentation.api.AgentSpanContext;
 import datadog.trace.bootstrap.instrumentation.api.Tags;
+import datadog.trace.civisibility.Constants;
 import datadog.trace.civisibility.codeowners.Codeowners;
 import datadog.trace.civisibility.config.ExecutionSettings;
 import datadog.trace.civisibility.coverage.percentage.CoverageCalculator;
@@ -269,7 +269,7 @@ private SignalResponse onModuleExecutionResultReceived(ModuleExecutionResult res
     if (result.isEarlyFlakeDetectionEnabled()) {
       setTag(Tags.TEST_EARLY_FLAKE_ENABLED, true);
       if (result.isEarlyFlakeDetectionFaulty()) {
-        setTag(Tags.TEST_EARLY_FLAKE_ABORT_REASON, CIConstants.EFD_ABORT_REASON_FAULTY);
+        setTag(Tags.TEST_EARLY_FLAKE_ABORT_REASON, Constants.EFD_ABORT_REASON_FAULTY);
       }
     }
 

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

@@ -4,7 +4,6 @@
 
 import datadog.trace.api.Config;
 import datadog.trace.api.DDTags;
-import datadog.trace.api.civisibility.CIConstants;
 import datadog.trace.api.civisibility.domain.BuildModuleLayout;
 import datadog.trace.api.civisibility.domain.BuildSessionSettings;
 import datadog.trace.api.civisibility.domain.JavaAgent;
@@ -14,6 +13,7 @@
 import datadog.trace.api.civisibility.telemetry.tag.Provider;
 import datadog.trace.bootstrap.instrumentation.api.AgentSpan;
 import datadog.trace.bootstrap.instrumentation.api.Tags;
+import datadog.trace.civisibility.Constants;
 import datadog.trace.civisibility.codeowners.Codeowners;
 import datadog.trace.civisibility.config.ExecutionSettings;
 import datadog.trace.civisibility.config.ExecutionSettingsFactory;
@@ -208,8 +208,7 @@ public BuildSessionSettings getSettings() {
 
   @Override
   protected Collection<TagValue> additionalTelemetryTags() {
-    if (CIConstants.EFD_ABORT_REASON_FAULTY.equals(
-        span.getTag(Tags.TEST_EARLY_FLAKE_ABORT_REASON))) {
+    if (Constants.EFD_ABORT_REASON_FAULTY.equals(span.getTag(Tags.TEST_EARLY_FLAKE_ABORT_REASON))) {
       return Collections.singleton(EarlyFlakeDetectionAbortReason.FAULTY);
     }
     return Collections.emptySet();

dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/domain/headless/HeadlessTestModule.java

@@ -2,7 +2,6 @@
 
 import datadog.trace.api.Config;
 import datadog.trace.api.DDTags;
-import datadog.trace.api.civisibility.CIConstants;
 import datadog.trace.api.civisibility.config.LibraryCapability;
 import datadog.trace.api.civisibility.config.TestIdentifier;
 import datadog.trace.api.civisibility.config.TestSourceData;
@@ -14,6 +13,7 @@
 import datadog.trace.bootstrap.instrumentation.api.AgentSpan;
 import datadog.trace.bootstrap.instrumentation.api.AgentSpanContext;
 import datadog.trace.bootstrap.instrumentation.api.Tags;
+import datadog.trace.civisibility.Constants;
 import datadog.trace.civisibility.codeowners.Codeowners;
 import datadog.trace.civisibility.config.EarlyFlakeDetectionSettings;
 import datadog.trace.civisibility.config.ExecutionSettings;
@@ -150,7 +150,7 @@ public void end(@Nullable Long endTime) {
     if (earlyFlakeDetectionSettings.isEnabled()) {
       setTag(Tags.TEST_EARLY_FLAKE_ENABLED, true);
       if (executionStrategy.isEFDLimitReached()) {
-        setTag(Tags.TEST_EARLY_FLAKE_ABORT_REASON, CIConstants.EFD_ABORT_REASON_FAULTY);
+        setTag(Tags.TEST_EARLY_FLAKE_ABORT_REASON, Constants.EFD_ABORT_REASON_FAULTY);
       }
     }
 

dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/domain/headless/HeadlessTestSession.java

@@ -2,7 +2,6 @@
 
 import datadog.trace.api.Config;
 import datadog.trace.api.DDTags;
-import datadog.trace.api.civisibility.CIConstants;
 import datadog.trace.api.civisibility.config.LibraryCapability;
 import datadog.trace.api.civisibility.coverage.CoverageStore;
 import datadog.trace.api.civisibility.telemetry.CiVisibilityMetricCollector;
@@ -11,6 +10,7 @@
 import datadog.trace.api.civisibility.telemetry.tag.Provider;
 import datadog.trace.bootstrap.instrumentation.api.AgentSpan;
 import datadog.trace.bootstrap.instrumentation.api.Tags;
+import datadog.trace.civisibility.Constants;
 import datadog.trace.civisibility.codeowners.Codeowners;
 import datadog.trace.civisibility.decorator.TestDecorator;
 import datadog.trace.civisibility.domain.AbstractTestSession;
@@ -102,8 +102,7 @@ private void propagateModuleTags(AgentSpan moduleSpan) {
 
   @Override
   protected Collection<TagValue> additionalTelemetryTags() {
-    if (CIConstants.EFD_ABORT_REASON_FAULTY.equals(
-        span.getTag(Tags.TEST_EARLY_FLAKE_ABORT_REASON))) {
+    if (Constants.EFD_ABORT_REASON_FAULTY.equals(span.getTag(Tags.TEST_EARLY_FLAKE_ABORT_REASON))) {
       return Collections.singleton(EarlyFlakeDetectionAbortReason.FAULTY);
     }
     return Collections.emptySet();

internal-api/src/main/java/datadog/trace/api/civisibility/CIConstants.java

@@ -1,16 +1,9 @@
 package datadog.trace.api.civisibility;
 
 public interface CIConstants {
-  /**
-   * Indicates that early flakiness detection feature was aborted in a test session because too many
-   * test cases were considered new.
-   */
-  String EFD_ABORT_REASON_FAULTY = "faulty";
 
   String SELENIUM_BROWSER_DRIVER = "selenium";
 
-  String CI_VISIBILITY_INSTRUMENTATION_NAME = "civisibility";
-
   String FAIL_FAST_TEST_ORDER = "FAILFAST";
 
   String CIAPP_TEST_ORIGIN = "ciapp-test";