Collect pull request info for GitHub and Gitlab

nikita-tkachenko-datadog · nikita-tkachenko-datadog · commit 8aa46015db44 · 2025-01-20T17:07:57.000+01:00
diff --git a/dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/CiVisibilityRepoServices.java b/dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/CiVisibilityRepoServices.java
@@ -8,6 +8,7 @@
 import datadog.trace.civisibility.ci.CIInfo;
 import datadog.trace.civisibility.ci.CIProviderInfo;
 import datadog.trace.civisibility.ci.CITagsProvider;
+import datadog.trace.civisibility.ci.PullRequestInfo;
 import datadog.trace.civisibility.codeowners.Codeowners;
 import datadog.trace.civisibility.codeowners.CodeownersProvider;
 import datadog.trace.civisibility.codeowners.NoCodeowners;
@@ -59,9 +60,10 @@ public class CiVisibilityRepoServices {
     ciProvider = ciProviderInfo.getProvider();
 
     CIInfo ciInfo = ciProviderInfo.buildCIInfo();
+    PullRequestInfo pullRequestInfo = ciProviderInfo.buildPullRequestInfo();
     repoRoot = ciInfo.getNormalizedCiWorkspace();
     moduleName = getModuleName(services.config, path, ciInfo);
-    ciTags = new CITagsProvider().getCiTags(ciInfo);
+    ciTags = new CITagsProvider().getCiTags(ciInfo, pullRequestInfo);
 
     gitDataUploader =
         buildGitDataUploader(
diff --git a/dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/ci/AppVeyorInfo.java b/dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/ci/AppVeyorInfo.java
@@ -79,6 +79,11 @@ public CIInfo buildCIInfo() {
         .build();
   }
 
+  @Override
+  public PullRequestInfo buildPullRequestInfo() {
+    return PullRequestInfo.EMPTY;
+  }
+
   private String buildGitBranch(final String repoProvider) {
     if ("github".equals(repoProvider)) {
       String branch = environment.get(APPVEYOR_PULL_REQUEST_HEAD_REPO_BRANCH);
diff --git a/dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/ci/AwsCodePipelineInfo.java b/dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/ci/AwsCodePipelineInfo.java
@@ -35,6 +35,11 @@ public CIInfo buildCIInfo() {
         .build();
   }
 
+  @Override
+  public PullRequestInfo buildPullRequestInfo() {
+    return PullRequestInfo.EMPTY;
+  }
+
   @Override
   public Provider getProvider() {
     return Provider.AWS;
diff --git a/dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/ci/AzurePipelinesInfo.java b/dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/ci/AzurePipelinesInfo.java
@@ -81,6 +81,11 @@ public CIInfo buildCIInfo() {
         .build();
   }
 
+  @Override
+  public PullRequestInfo buildPullRequestInfo() {
+    return PullRequestInfo.EMPTY;
+  }
+
   private String buildGitBranch() {
     String gitBranchOrTag = getGitBranchOrTag();
     if (!isTagReference(gitBranchOrTag)) {
diff --git a/dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/ci/BitBucketInfo.java b/dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/ci/BitBucketInfo.java
@@ -70,6 +70,11 @@ public CIInfo buildCIInfo() {
         .build();
   }
 
+  @Override
+  public PullRequestInfo buildPullRequestInfo() {
+    return PullRequestInfo.EMPTY;
+  }
+
   private String buildPipelineUrl(final String repo, final String number) {
     return String.format(
         "https://bitbucket.org/%s/addon/pipelines/home#!/results/%s", repo, number);
diff --git a/dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/ci/BitriseInfo.java b/dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/ci/BitriseInfo.java
@@ -66,6 +66,11 @@ public CIInfo buildCIInfo() {
         .build();
   }
 
+  @Override
+  public PullRequestInfo buildPullRequestInfo() {
+    return PullRequestInfo.EMPTY;
+  }
+
   private String buildGitCommit() {
     final String fromCommit = environment.get(BITRISE_GIT_PR_COMMIT);
     if (fromCommit != null && !fromCommit.isEmpty()) {
diff --git a/dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/ci/BuddyInfo.java b/dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/ci/BuddyInfo.java
@@ -58,6 +58,11 @@ public CIInfo buildCIInfo() {
         .build();
   }
 
+  @Override
+  public PullRequestInfo buildPullRequestInfo() {
+    return PullRequestInfo.EMPTY;
+  }
+
   private String getPipelineId(String pipelineNumber) {
     String pipelineId = environment.get(BUDDY_PIPELINE_ID);
     if (pipelineId == null) {
diff --git a/dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/ci/BuildkiteInfo.java b/dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/ci/BuildkiteInfo.java
@@ -74,6 +74,11 @@ public CIInfo buildCIInfo() {
         .build();
   }
 
+  @Override
+  public PullRequestInfo buildPullRequestInfo() {
+    return PullRequestInfo.EMPTY;
+  }
+
   private String buildCiNodeLabels() {
     List<String> labels = new ArrayList<>();
     for (Map.Entry<String, String> e : environment.get().entrySet()) {
diff --git a/dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/ci/CIProviderInfo.java b/dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/ci/CIProviderInfo.java
@@ -9,5 +9,7 @@ public interface CIProviderInfo {
 
   CIInfo buildCIInfo();
 
+  PullRequestInfo buildPullRequestInfo();
+
   Provider getProvider();
 }
diff --git a/dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/ci/CITagsProvider.java b/dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/ci/CITagsProvider.java
@@ -21,7 +21,7 @@ public CITagsProvider() {
     this.gitInfoProvider = gitInfoProvider;
   }
 
-  public Map<String, String> getCiTags(CIInfo ciInfo) {
+  public Map<String, String> getCiTags(CIInfo ciInfo, PullRequestInfo pullRequestInfo) {
     String repoRoot = ciInfo.getNormalizedCiWorkspace();
     GitInfo gitInfo = gitInfoProvider.getGitInfo(repoRoot);
 
@@ -39,6 +39,9 @@ public Map<String, String> getCiTags(CIInfo ciInfo) {
         .withCiNodeLabels(ciInfo.getCiNodeLabels())
         .withCiEnvVars(ciInfo.getCiEnvVars())
         .withAdditionalTags(ciInfo.getAdditionalTags())
+        .withPullRequestBaseBranch(pullRequestInfo)
+        .withPullRequestBaseBranchSha(pullRequestInfo)
+        .withGitCommitHeadSha(pullRequestInfo)
         .withGitRepositoryUrl(gitInfo)
         .withGitCommit(gitInfo)
         .withGitBranch(gitInfo)
@@ -118,6 +121,20 @@ public CITagsBuilder withAdditionalTags(final Map<String, String> additionalTags
       return this;
     }
 
+    public CITagsBuilder withPullRequestBaseBranch(final PullRequestInfo pullRequestInfo) {
+      return putTagValue(
+          Tags.GIT_PULL_REQUEST_BASE_BRANCH, pullRequestInfo.getPullRequestBaseBranch());
+    }
+
+    public CITagsBuilder withPullRequestBaseBranchSha(final PullRequestInfo pullRequestInfo) {
+      return putTagValue(
+          Tags.GIT_PULL_REQUEST_BASE_BRANCH_SHA, pullRequestInfo.getPullRequestBaseBranchSha());
+    }
+
+    public CITagsBuilder withGitCommitHeadSha(final PullRequestInfo pullRequestInfo) {
+      return putTagValue(Tags.GIT_COMMIT_HEAD_SHA, pullRequestInfo.getGitCommitHeadSha());
+    }
+
     public CITagsBuilder withGitRepositoryUrl(final GitInfo gitInfo) {
       return putTagValue(Tags.GIT_REPOSITORY_URL, gitInfo.getRepositoryURL());
     }
diff --git a/dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/ci/CircleCIInfo.java b/dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/ci/CircleCIInfo.java
@@ -56,6 +56,11 @@ public CIInfo buildCIInfo() {
         .build();
   }
 
+  @Override
+  public PullRequestInfo buildPullRequestInfo() {
+    return PullRequestInfo.EMPTY;
+  }
+
   private String buildPipelineUrl(final String pipelineId) {
     if (pipelineId == null) {
       return null;
diff --git a/dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/ci/CodefreshInfo.java b/dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/ci/CodefreshInfo.java
@@ -40,6 +40,11 @@ public GitInfo buildCIGitInfo() {
             environment.get(CF_COMMIT_MESSAGE)));
   }
 
+  @Override
+  public PullRequestInfo buildPullRequestInfo() {
+    return PullRequestInfo.EMPTY;
+  }
+
   private String buildGitBranch() {
     String gitBranchOrTag = getGitBranchOrTag();
     if (!isTagReference(gitBranchOrTag)) {
diff --git a/dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/ci/GitLabInfo.java b/dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/ci/GitLabInfo.java
@@ -38,6 +38,12 @@ class GitLabInfo implements CIProviderInfo {
   public static final String GITLAB_GIT_COMMIT_TIMESTAMP = "CI_COMMIT_TIMESTAMP";
   public static final String GITLAB_CI_RUNNER_ID = "CI_RUNNER_ID";
   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";
 
   private final CiEnvironment environment;
 
@@ -76,6 +82,14 @@ public CIInfo buildCIInfo() {
         .build();
   }
 
+  @Override
+  public PullRequestInfo buildPullRequestInfo() {
+    return new PullRequestInfo(
+        environment.get(GITLAB_PULL_REQUEST_BASE_BRANCH),
+        environment.get(GITLAB_PULL_REQUEST_BASE_BRANCH_SHA),
+        environment.get(GITLAB_PULL_REQUEST_COMMIT_HEAD_SHA));
+  }
+
   private PersonInfo buildGitCommitAuthor() {
     final String gitAuthor = environment.get(GITLAB_GIT_COMMIT_AUTHOR);
     if (gitAuthor == null || gitAuthor.isEmpty()) {
diff --git a/dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/ci/GithubActionsInfo.java b/dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/ci/GithubActionsInfo.java
@@ -18,7 +18,6 @@
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
-import java.util.HashMap;
 import java.util.Map;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -44,10 +43,6 @@ class GithubActionsInfo implements CIProviderInfo {
   public static final String GITHUB_BASE_REF = "GITHUB_BASE_REF";
   public static final String GITHUB_EVENT_PATH = "GITHUB_EVENT_PATH";
 
-  public static final String GIT_PULL_REQUEST_BASE_BRANCH = "git.pull_request.base_branch";
-  public static final String GIT_PULL_REQUEST_BASE_BRANCH_SHA = "git.pull_request.base_branch_sha";
-  public static final String GIT_COMMIT_HEAD_SHA = "git.commit.head_sha";
-
   private final CiEnvironment environment;
 
   GithubActionsInfo(CiEnvironment environment) {
@@ -80,9 +75,6 @@ public CIInfo buildCIInfo() {
             environment.get(GHACTIONS_SHA));
 
     CIInfo.Builder builder = CIInfo.builder(environment);
-
-    setAdditionalTagsIfApplicable(builder);
-
     return builder
         .ciProviderName(GHACTIONS_PROVIDER_NAME)
         .ciPipelineId(environment.get(GHACTIONS_PIPELINE_ID))
@@ -97,16 +89,14 @@ public CIInfo buildCIInfo() {
         .build();
   }
 
-  private void setAdditionalTagsIfApplicable(CIInfo.Builder builder) {
+  @Override
+  public PullRequestInfo buildPullRequestInfo() {
     String baseRef = environment.get(GITHUB_BASE_REF);
     if (!Strings.isNotBlank(baseRef)) {
-      return;
+      return PullRequestInfo.EMPTY;
     }
 
     try {
-      Map<String, String> additionalTags = new HashMap<>();
-      additionalTags.put(GIT_PULL_REQUEST_BASE_BRANCH, baseRef);
-
       Path eventPath = Paths.get(environment.get(GITHUB_EVENT_PATH));
       String event = new String(Files.readAllBytes(eventPath), StandardCharsets.UTF_8);
 
@@ -115,25 +105,27 @@ private void setAdditionalTagsIfApplicable(CIInfo.Builder builder) {
           moshi.adapter(Types.newParameterizedType(Map.class, String.class, Object.class));
       Map<String, Object> eventJson = mapJsonAdapter.fromJson(event);
 
+      String baseSha = null;
+      String headSha = null;
+
       Map<String, Object> pullRequest = (Map<String, Object>) eventJson.get("pull_request");
       if (pullRequest != null) {
         Map<String, Object> head = (Map<String, Object>) pullRequest.get("head");
         if (head != null) {
-          String headSha = (String) head.get("sha");
-          additionalTags.put(GIT_COMMIT_HEAD_SHA, headSha);
+          headSha = (String) head.get("sha");
         }
 
         Map<String, Object> base = (Map<String, Object>) pullRequest.get("base");
         if (base != null) {
-          String baseSha = (String) base.get("sha");
-          additionalTags.put(GIT_PULL_REQUEST_BASE_BRANCH_SHA, baseSha);
+          baseSha = (String) base.get("sha");
         }
       }
 
-      builder.additionalTags(additionalTags);
+      return new PullRequestInfo(baseRef, baseSha, headSha);
 
     } catch (Exception e) {
       LOGGER.warn("Error while parsing GitHub event", e);
+      return PullRequestInfo.EMPTY;
     }
   }
 
diff --git a/dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/ci/JenkinsInfo.java b/dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/ci/JenkinsInfo.java
@@ -68,6 +68,11 @@ public CIInfo buildCIInfo() {
         .build();
   }
 
+  @Override
+  public PullRequestInfo buildPullRequestInfo() {
+    return PullRequestInfo.EMPTY;
+  }
+
   private String buildCiNodeLabels() {
     String labels = environment.get(JENKINS_NODE_LABELS);
     if (labels == null || labels.isEmpty()) {
diff --git a/dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/ci/PullRequestInfo.java b/dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/ci/PullRequestInfo.java
@@ -0,0 +1,65 @@
+package datadog.trace.civisibility.ci;
+
+import java.util.Objects;
+
+public class PullRequestInfo {
+
+  public static final PullRequestInfo EMPTY = new PullRequestInfo(null, null, null);
+
+  private final String pullRequestBaseBranch;
+  private final String pullRequestBaseBranchSha;
+  private final String gitCommitHeadSha;
+
+  public PullRequestInfo(
+      String pullRequestBaseBranch, String pullRequestBaseBranchSha, String gitCommitHeadSha) {
+    this.pullRequestBaseBranch = pullRequestBaseBranch;
+    this.pullRequestBaseBranchSha = pullRequestBaseBranchSha;
+    this.gitCommitHeadSha = gitCommitHeadSha;
+  }
+
+  public String getPullRequestBaseBranch() {
+    return pullRequestBaseBranch;
+  }
+
+  public String getPullRequestBaseBranchSha() {
+    return pullRequestBaseBranchSha;
+  }
+
+  public String getGitCommitHeadSha() {
+    return gitCommitHeadSha;
+  }
+
+  @Override
+  public boolean equals(Object o) {
+    if (this == o) {
+      return true;
+    }
+    if (o == null || getClass() != o.getClass()) {
+      return false;
+    }
+    PullRequestInfo that = (PullRequestInfo) o;
+    return Objects.equals(pullRequestBaseBranch, that.pullRequestBaseBranch)
+        && Objects.equals(pullRequestBaseBranchSha, that.pullRequestBaseBranchSha)
+        && Objects.equals(gitCommitHeadSha, that.gitCommitHeadSha);
+  }
+
+  @Override
+  public int hashCode() {
+    return Objects.hash(pullRequestBaseBranch, pullRequestBaseBranchSha, gitCommitHeadSha);
+  }
+
+  @Override
+  public String toString() {
+    return "PullRequestInfo{"
+        + "pullRequestBaseBranch='"
+        + pullRequestBaseBranch
+        + '\''
+        + ", pullRequestBaseBranchSha='"
+        + pullRequestBaseBranchSha
+        + '\''
+        + ", gitCommitHeadSha='"
+        + gitCommitHeadSha
+        + '\''
+        + '}';
+  }
+}
diff --git a/dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/ci/TeamcityInfo.java b/dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/ci/TeamcityInfo.java
@@ -31,6 +31,11 @@ public CIInfo buildCIInfo() {
         .build();
   }
 
+  @Override
+  public PullRequestInfo buildPullRequestInfo() {
+    return PullRequestInfo.EMPTY;
+  }
+
   @Override
   public Provider getProvider() {
     return Provider.TEAMCITY;
diff --git a/dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/ci/TravisInfo.java b/dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/ci/TravisInfo.java
@@ -60,6 +60,11 @@ public CIInfo buildCIInfo() {
         .build();
   }
 
+  @Override
+  public PullRequestInfo buildPullRequestInfo() {
+    return PullRequestInfo.EMPTY;
+  }
+
   private String buildGitBranch() {
     final String fromBranch = environment.get(TRAVIS_GIT_PR_BRANCH);
     if (fromBranch != null && !fromBranch.isEmpty()) {
diff --git a/dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/ci/UnknownCIInfo.java b/dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/ci/UnknownCIInfo.java
@@ -60,6 +60,11 @@ public CIInfo buildCIInfo() {
     return CIInfo.builder(environment).ciWorkspace(workspace.toAbsolutePath().toString()).build();
   }
 
+  @Override
+  public PullRequestInfo buildPullRequestInfo() {
+    return PullRequestInfo.EMPTY;
+  }
+
   protected String getTargetFolder() {
     return targetFolder;
   }
diff --git a/dd-java-agent/agent-ci-visibility/src/test/groovy/datadog/trace/civisibility/ci/CITagsProviderTest.groovy b/dd-java-agent/agent-ci-visibility/src/test/groovy/datadog/trace/civisibility/ci/CITagsProviderTest.groovy
diff --git a/dd-java-agent/agent-ci-visibility/src/test/groovy/datadog/trace/civisibility/ci/GithubActionsInfoTest.groovy b/dd-java-agent/agent-ci-visibility/src/test/groovy/datadog/trace/civisibility/ci/GithubActionsInfoTest.groovy
diff --git a/dd-java-agent/agent-ci-visibility/src/test/groovy/datadog/trace/civisibility/ci/UnknownCIInfoTest.groovy b/dd-java-agent/agent-ci-visibility/src/test/groovy/datadog/trace/civisibility/ci/UnknownCIInfoTest.groovy
diff --git a/internal-api/src/main/java/datadog/trace/bootstrap/instrumentation/api/Tags.java b/internal-api/src/main/java/datadog/trace/bootstrap/instrumentation/api/Tags.java

Original file line number	Diff line number	Diff line change
`@@ -9,5 +9,7 @@ public interface CIProviderInfo {`
`9`	`9`
`10`	`10`	`CIInfo buildCIInfo();`
`11`	`11`
	`12`	`+ PullRequestInfo buildPullRequestInfo();`
	`13`	`+`
`12`	`14`	`Provider getProvider();`
`13`	`15`	`}`