Improve PR information building (#8908)

Author: daniel-mohedano

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

@@ -65,7 +65,8 @@ public class CiVisibilityRepoServices {
     ciProvider = ciProviderInfo.getProvider();
 
     CIInfo ciInfo = ciProviderInfo.buildCIInfo();
-    PullRequestInfo pullRequestInfo = buildPullRequestInfo(services.environment, ciProviderInfo);
+    PullRequestInfo pullRequestInfo =
+        buildPullRequestInfo(services.config, services.environment, ciProviderInfo);
 
     if (pullRequestInfo.isNotEmpty()) {
       LOGGER.info("PR detected: {}", pullRequestInfo);
@@ -110,18 +111,38 @@ public class CiVisibilityRepoServices {
 
   @Nonnull
   private static PullRequestInfo buildPullRequestInfo(
-      CiEnvironment environment, CIProviderInfo ciProviderInfo) {
-    PullRequestInfo ciProviderPrInfo = ciProviderInfo.buildPullRequestInfo();
-    if (ciProviderPrInfo.isNotEmpty()) {
-      return ciProviderPrInfo;
+      Config config, CiEnvironment environment, CIProviderInfo ciProviderInfo) {
+    PullRequestInfo info = buildUserPullRequestInfo(config, environment);
+
+    if (info.isComplete()) {
+      return info;
+    }
+
+    // complete with CI vars if user didn't provide all information
+    return PullRequestInfo.merge(info, ciProviderInfo.buildPullRequestInfo());
+  }
+
+  @Nonnull
+  private static PullRequestInfo buildUserPullRequestInfo(
+      Config config, CiEnvironment environment) {
+    PullRequestInfo userInfo =
+        new PullRequestInfo(
+            config.getGitPullRequestBaseBranch(),
+            config.getGitPullRequestBaseBranchSha(),
+            config.getGitCommitHeadSha());
+
+    if (userInfo.isComplete()) {
+      return userInfo;
     }
 
-    // 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));
+    // logs-backend specific vars
+    PullRequestInfo ddCiInfo =
+        new PullRequestInfo(
+            null,
+            environment.get(Constants.DDCI_PULL_REQUEST_TARGET_SHA),
+            environment.get(Constants.DDCI_PULL_REQUEST_SOURCE_SHA));
+
+    return PullRequestInfo.merge(userInfo, ddCiInfo);
   }
 
   private static String getRepoRoot(CIInfo ciInfo, GitClient.Factory gitClientFactory) {

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

@@ -9,6 +9,7 @@
 import datadog.trace.api.git.GitInfo;
 import datadog.trace.api.git.PersonInfo;
 import datadog.trace.civisibility.ci.env.CiEnvironment;
+import datadog.trace.util.Strings;
 import javax.annotation.Nonnull;
 
 class AppVeyorInfo implements CIProviderInfo {
@@ -25,6 +26,8 @@ class AppVeyorInfo implements CIProviderInfo {
   public static final String APPVEYOR_REPO_BRANCH = "APPVEYOR_REPO_BRANCH";
   public static final String APPVEYOR_PULL_REQUEST_HEAD_REPO_BRANCH =
       "APPVEYOR_PULL_REQUEST_HEAD_REPO_BRANCH";
+  public static final String APPVEYOR_PULL_REQUEST_HEAD_COMMIT =
+      "APPVEYOR_PULL_REQUEST_HEAD_COMMIT";
   public static final String APPVEYOR_REPO_TAG_NAME = "APPVEYOR_REPO_TAG_NAME";
   public static final String APPVEYOR_REPO_COMMIT_MESSAGE_SUBJECT = "APPVEYOR_REPO_COMMIT_MESSAGE";
   public static final String APPVEYOR_REPO_COMMIT_MESSAGE_BODY =
@@ -83,7 +86,15 @@ public CIInfo buildCIInfo() {
   @Nonnull
   @Override
   public PullRequestInfo buildPullRequestInfo() {
-    return PullRequestInfo.EMPTY;
+    // check if PR is detected
+    if (Strings.isNotBlank(environment.get(APPVEYOR_PULL_REQUEST_HEAD_REPO_BRANCH))) {
+      return new PullRequestInfo(
+          normalizeBranch(environment.get(APPVEYOR_REPO_BRANCH)),
+          null,
+          environment.get(APPVEYOR_PULL_REQUEST_HEAD_COMMIT));
+    } else {
+      return PullRequestInfo.EMPTY;
+    }
   }
 
   private String buildGitBranch(final String repoProvider) {

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

@@ -26,6 +26,7 @@ class BitBucketInfo implements CIProviderInfo {
   public static final String BITBUCKET_GIT_COMMIT = "BITBUCKET_COMMIT";
   public static final String BITBUCKET_GIT_BRANCH = "BITBUCKET_BRANCH";
   public static final String BITBUCKET_GIT_TAG = "BITBUCKET_TAG";
+  public static final String BITBUCKET_PR_DESTINATION_BRANCH = "BITBUCKET_PR_DESTINATION_BRANCH";
 
   private final CiEnvironment environment;
 
@@ -74,7 +75,8 @@ public CIInfo buildCIInfo() {
   @Nonnull
   @Override
   public PullRequestInfo buildPullRequestInfo() {
-    return PullRequestInfo.EMPTY;
+    return new PullRequestInfo(
+        normalizeBranch(environment.get(BITBUCKET_PR_DESTINATION_BRANCH)), null, null);
   }
 
   private String buildPipelineUrl(final String repo, final String number) {

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

@@ -14,6 +14,7 @@
 
 class BitriseInfo implements CIProviderInfo {
 
+  // https://devcenter.bitrise.io/en/references/available-environment-variables.html
   public static final String BITRISE = "BITRISE_BUILD_SLUG";
   public static final String BITRISE_PROVIDER_NAME = "bitrise";
   public static final String BITRISE_PIPELINE_ID = "BITRISE_BUILD_SLUG";
@@ -31,6 +32,7 @@ class BitriseInfo implements CIProviderInfo {
   public static final String BITRISE_GIT_AUTHOR_EMAIL = "GIT_CLONE_COMMIT_AUTHOR_EMAIL";
   public static final String BITRISE_GIT_COMMITER_NAME = "GIT_CLONE_COMMIT_COMMITER_NAME";
   public static final String BITRISE_GIT_COMMITER_EMAIL = "GIT_CLONE_COMMIT_COMMITER_EMAIL";
+  public static final String BITRISE_GIT_BRANCH_DEST = "BITRISEIO_GIT_BRANCH_DEST";
 
   private final CiEnvironment environment;
 
@@ -70,7 +72,8 @@ public CIInfo buildCIInfo() {
   @Nonnull
   @Override
   public PullRequestInfo buildPullRequestInfo() {
-    return PullRequestInfo.EMPTY;
+    return new PullRequestInfo(
+        normalizeBranch(environment.get(BITRISE_GIT_BRANCH_DEST)), null, null);
   }
 
   private String buildGitCommit() {

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

@@ -27,6 +27,7 @@ class BuddyInfo implements CIProviderInfo {
   public static final String BUDDY_GIT_COMMIT_MESSAGE = "BUDDY_EXECUTION_REVISION_MESSAGE";
   public static final String BUDDY_GIT_COMMIT_AUTHOR = "BUDDY_EXECUTION_REVISION_COMMITTER_NAME";
   public static final String BUDDY_GIT_COMMIT_EMAIL = "BUDDY_EXECUTION_REVISION_COMMITTER_EMAIL";
+  public static final String BUDDY_RUN_PR_BASE_BRANCH = "BUDDY_RUN_PR_BASE_BRANCH";
 
   private final CiEnvironment environment;
 
@@ -62,7 +63,8 @@ public CIInfo buildCIInfo() {
   @Nonnull
   @Override
   public PullRequestInfo buildPullRequestInfo() {
-    return PullRequestInfo.EMPTY;
+    return new PullRequestInfo(
+        normalizeBranch(environment.get(BUDDY_RUN_PR_BASE_BRANCH)), null, null);
   }
 
   private String getPipelineId(String pipelineNumber) {

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

@@ -37,6 +37,9 @@ class BuildkiteInfo implements CIProviderInfo {
   public static final String BUILDKITE_GIT_AUTHOR_EMAIL = "BUILDKITE_BUILD_AUTHOR_EMAIL";
   public static final String BUILDKITE_AGENT_ID = "BUILDKITE_AGENT_ID";
   private static final String BUILDKITE_CI_NODE_LABEL_PREFIX = "BUILDKITE_AGENT_META_DATA_";
+  private static final String BUILDKITE_PULL_REQUEST = "BUILDKITE_PULL_REQUEST";
+  private static final String BUILDKITE_PULL_REQUEST_BASE_BRANCH =
+      "BUILDKITE_PULL_REQUEST_BASE_BRANCH";
 
   private final CiEnvironment environment;
 
@@ -78,9 +81,18 @@ public CIInfo buildCIInfo() {
   @Nonnull
   @Override
   public PullRequestInfo buildPullRequestInfo() {
+    if (isPullRequest()) {
+      return new PullRequestInfo(
+          normalizeBranch(environment.get(BUILDKITE_PULL_REQUEST_BASE_BRANCH)), null, null);
+    }
     return PullRequestInfo.EMPTY;
   }
 
+  private boolean isPullRequest() {
+    String pullRequest = environment.get(BUILDKITE_PULL_REQUEST);
+    return pullRequest != null && !"false".equals(pullRequest);
+  }
+
   private String buildCiNodeLabels() {
     List<String> labels = new ArrayList<>();
     for (Map.Entry<String, String> e : environment.get().entrySet()) {

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

@@ -57,6 +57,8 @@ public CIProviderInfo createCIProviderInfo(Path currentPath) {
     } else if (environment.get(AwsCodePipelineInfo.AWS_CODEPIPELINE) != null
         && environment.get(AwsCodePipelineInfo.AWS_CODEPIPELINE).startsWith("codepipeline")) {
       return new AwsCodePipelineInfo(environment);
+    } else if (environment.get(DroneInfo.DRONE) != null) {
+      return new DroneInfo(environment);
     } else {
       return new UnknownCIInfo(environment, targetFolder, currentPath);
     }

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

@@ -12,6 +12,8 @@
 import javax.annotation.Nonnull;
 
 public class CodefreshInfo implements CIProviderInfo {
+
+  // https://codefresh.io/docs/docs/pipelines/variables/#system-variables
   public static final String CODEFRESH = "CF_BUILD_ID";
   public static final String CODEFRESH_PROVIDER_NAME = "codefresh";
   public static final String CF_STEP_NAME = "CF_STEP_NAME";

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

@@ -0,0 +1,78 @@
+package datadog.trace.civisibility.ci;
+
+import static datadog.trace.api.git.GitUtils.filterSensitiveInfo;
+import static datadog.trace.api.git.GitUtils.normalizeBranch;
+import static datadog.trace.api.git.GitUtils.normalizeTag;
+import static datadog.trace.civisibility.utils.FileUtils.expandTilde;
+
+import datadog.trace.api.civisibility.telemetry.tag.Provider;
+import datadog.trace.api.git.CommitInfo;
+import datadog.trace.api.git.GitInfo;
+import datadog.trace.api.git.PersonInfo;
+import datadog.trace.civisibility.ci.env.CiEnvironment;
+import javax.annotation.Nonnull;
+
+public class DroneInfo implements CIProviderInfo {
+
+  public static final String DRONE = "DRONE";
+  public static final String DRONE_PROVIDER_NAME = "drone";
+  public static final String DRONE_BUILD_NUMBER = "DRONE_BUILD_NUMBER";
+  public static final String DRONE_BUILD_LINK = "DRONE_BUILD_LINK";
+  public static final String DRONE_STEP_NAME = "DRONE_STEP_NAME";
+  public static final String DRONE_STAGE_NAME = "DRONE_STAGE_NAME";
+  public static final String DRONE_WORKSPACE = "DRONE_WORKSPACE";
+  public static final String DRONE_GIT_HTTP_URL = "DRONE_GIT_HTTP_URL";
+  public static final String DRONE_COMMIT_SHA = "DRONE_COMMIT_SHA";
+  public static final String DRONE_BRANCH = "DRONE_BRANCH";
+  public static final String DRONE_TAG = "DRONE_TAG";
+  public static final String DRONE_COMMIT_AUTHOR_NAME = "DRONE_COMMIT_AUTHOR_NAME";
+  public static final String DRONE_COMMIT_AUTHOR_EMAIL = "DRONE_COMMIT_AUTHOR_EMAIL";
+  public static final String DRONE_COMMIT_MESSAGE = "DRONE_COMMIT_MESSAGE";
+
+  private final CiEnvironment environment;
+
+  DroneInfo(CiEnvironment environment) {
+    this.environment = environment;
+  }
+
+  @Override
+  public GitInfo buildCIGitInfo() {
+    return new GitInfo(
+        filterSensitiveInfo(environment.get(DRONE_GIT_HTTP_URL)),
+        normalizeBranch(environment.get(DRONE_BRANCH)),
+        normalizeTag(environment.get(DRONE_TAG)),
+        new CommitInfo(
+            environment.get(DRONE_COMMIT_SHA),
+            buildGitAuthor(),
+            PersonInfo.NOOP,
+            environment.get(DRONE_COMMIT_MESSAGE)));
+  }
+
+  @Override
+  public CIInfo buildCIInfo() {
+    return CIInfo.builder(environment)
+        .ciProviderName(DRONE_PROVIDER_NAME)
+        .ciPipelineNumber(environment.get(DRONE_BUILD_NUMBER))
+        .ciPipelineUrl(environment.get(DRONE_BUILD_LINK))
+        .ciJobName(environment.get(DRONE_STEP_NAME))
+        .ciStageName(environment.get(DRONE_STAGE_NAME))
+        .ciWorkspace(expandTilde(environment.get(DRONE_WORKSPACE)))
+        .build();
+  }
+
+  @Nonnull
+  @Override
+  public PullRequestInfo buildPullRequestInfo() {
+    return PullRequestInfo.EMPTY;
+  }
+
+  private PersonInfo buildGitAuthor() {
+    return new PersonInfo(
+        environment.get(DRONE_COMMIT_AUTHOR_NAME), environment.get(DRONE_COMMIT_AUTHOR_EMAIL));
+  }
+
+  @Override
+  public Provider getProvider() {
+    return Provider.DRONE;
+  }
+}

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

@@ -41,8 +41,6 @@ class GitLabInfo implements CIProviderInfo {
   public static final String GITLAB_CI_RUNNER_TAGS = "CI_RUNNER_TAGS";
   public static final String GITLAB_PULL_REQUEST_BASE_BRANCH =
       "CI_MERGE_REQUEST_TARGET_BRANCH_NAME";
-  public static final String GITLAB_PULL_REQUEST_BASE_BRANCH_SHA =
-      "CI_MERGE_REQUEST_TARGET_BRANCH_SHA";
   public static final String GITLAB_PULL_REQUEST_COMMIT_HEAD_SHA =
       "CI_MERGE_REQUEST_SOURCE_BRANCH_SHA";
 
@@ -87,8 +85,8 @@ public CIInfo buildCIInfo() {
   @Override
   public PullRequestInfo buildPullRequestInfo() {
     return new PullRequestInfo(
-        environment.get(GITLAB_PULL_REQUEST_BASE_BRANCH),
-        environment.get(GITLAB_PULL_REQUEST_BASE_BRANCH_SHA),
+        normalizeBranch(environment.get(GITLAB_PULL_REQUEST_BASE_BRANCH)),
+        null,
         environment.get(GITLAB_PULL_REQUEST_COMMIT_HEAD_SHA));
   }