feat: add single command to obtain full commit info

Author: daniel-mohedano

dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/git/tree/GitClient.java

@@ -1,5 +1,6 @@
 package datadog.trace.civisibility.git.tree;
 
+import datadog.trace.api.git.CommitInfo;
 import datadog.trace.civisibility.diff.LineDiff;
 import java.io.IOException;
 import java.nio.file.Path;
@@ -62,6 +63,10 @@ String getCommitterEmail(String commit)
   @Nullable
   String getCommitterDate(String commit) throws IOException, TimeoutException, InterruptedException;
 
+  @Nonnull
+  CommitInfo getCommitInfo(String commit)
+      throws IOException, TimeoutException, InterruptedException;
+
   @Nonnull
   List<String> getLatestCommits() throws IOException, TimeoutException, InterruptedException;
 

dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/git/tree/NoOpGitClient.java

@@ -1,5 +1,6 @@
 package datadog.trace.civisibility.git.tree;
 
+import datadog.trace.api.git.CommitInfo;
 import datadog.trace.civisibility.diff.LineDiff;
 import java.nio.file.Path;
 import java.util.Collection;
@@ -108,6 +109,12 @@ public String getCommitterDate(String commit) {
     return null;
   }
 
+  @Nonnull
+  @Override
+  public CommitInfo getCommitInfo(String commit) {
+    return CommitInfo.NOOP;
+  }
+
   @Nonnull
   @Override
   public List<String> getLatestCommits() {

dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/git/tree/ShellGitClient.java

@@ -6,7 +6,9 @@
 import datadog.trace.api.civisibility.telemetry.CiVisibilityDistributionMetric;
 import datadog.trace.api.civisibility.telemetry.CiVisibilityMetricCollector;
 import datadog.trace.api.civisibility.telemetry.tag.Command;
+import datadog.trace.api.git.CommitInfo;
 import datadog.trace.api.git.GitUtils;
+import datadog.trace.api.git.PersonInfo;
 import datadog.trace.civisibility.diff.LineDiff;
 import datadog.trace.civisibility.utils.ShellCommandExecutor;
 import datadog.trace.util.Strings;
@@ -43,6 +45,7 @@ public class ShellGitClient implements GitClient {
       Arrays.asList("release/", "hotfix/");
   private static final Pattern WHITESPACE_PATTERN = Pattern.compile("\\s+");
   private static final String ORIGIN = "origin";
+  private static final Pattern COMMIT_INFO_SPLIT = Pattern.compile("\",\"");
 
   private final CiVisibilityMetricCollector metricCollector;
   private final String repoRoot;
@@ -499,6 +502,49 @@ public String getCommitterDate(String commit)
                 .trim());
   }
 
+  /**
+   * Returns commit information for the provided commit
+   *
+   * @param commit Commit SHA or reference (HEAD, branch name, etc) to check
+   * @return commit info (sha, author info, committer info, full message)
+   * @throws IOException If an error was encountered while writing command input or reading output
+   * @throws TimeoutException If timeout was reached while waiting for Git command to finish
+   * @throws InterruptedException If current thread was interrupted while waiting for Git command to
+   *     finish
+   */
+  @Nonnull
+  @Override
+  public CommitInfo getCommitInfo(String commit)
+      throws IOException, InterruptedException, TimeoutException {
+    if (GitUtils.isNotValidCommit(commit)) {
+      return CommitInfo.NOOP;
+    }
+    return executeCommand(
+        Command.OTHER,
+        () -> {
+          String info =
+              commandExecutor
+                  .executeCommand(
+                      IOUtils::readFully,
+                      "git",
+                      "show",
+                      commit,
+                      "-s",
+                      "--format=%H\",\"%an\",\"%ae\",\"%aI\",\"%cn\",\"%ce\",\"%cI\",\"%B")
+                  .trim();
+          String[] fields = COMMIT_INFO_SPLIT.split(info);
+          if (fields.length < 8) {
+            LOGGER.error("Could not parse commit info: {}", info);
+            return CommitInfo.NOOP;
+          }
+          return new CommitInfo(
+              fields[0],
+              new PersonInfo(fields[1], fields[2], fields[3]),
+              new PersonInfo(fields[4], fields[5], fields[6]),
+              fields[7]);
+        });
+  }
+
   /**
    * Returns SHAs of the latest commits in the current branch. Maximum number of commits and how far
    * into the past to look are configured when the client is created.

dd-java-agent/agent-ci-visibility/src/test/groovy/datadog/trace/civisibility/git/tree/GitClientTest.groovy

@@ -94,10 +94,10 @@ class GitClientTest extends Specification {
 
     where:
     remoteSha      | parentOnly | isShallow | numCommits
-    GitClient.HEAD | false      | false      | 10
-    null           | false      | false      | 10
-    GitClient.HEAD | true       | true     | 2
-    null           | true       | true     | 2
+    GitClient.HEAD | false      | false     | 10
+    null           | false      | false     | 10
+    GitClient.HEAD | true       | true      | 2
+    null           | true       | true      | 2
   }
 
   def "test get git folder"() {
@@ -247,6 +247,28 @@ class GitClientTest extends Specification {
     authorDate == "2021-02-26T19:32:13+01:00"
   }
 
+  def "test get commit info"() {
+    given:
+    givenGitRepo()
+
+    when:
+    def gitClient = givenGitClient()
+    def commitInfo = gitClient.getCommitInfo(GitClient.HEAD)
+
+    then:
+    commitInfo.sha == "5b6f3a6dab5972d73a56dff737bd08d995255c08"
+    commitInfo.author.name == "Tony Redondo"
+    commitInfo.author.email == "[email protected]"
+    commitInfo.author.iso8601Date == "2021-02-26T19:32:13+01:00"
+    commitInfo.committer.name == "GitHub"
+    commitInfo.committer.email == "[email protected]"
+    commitInfo.committer.iso8601Date == "2021-02-26T19:32:13+01:00"
+    commitInfo.fullMessage == "Adding Git information to test spans (#1242)\n\n" +
+    "* Initial basic GitInfo implementation.\r\n\r\n" +
+    "* Adds Author, Committer and Message git parser.\r\n\r\n" +
+    "* Changes based on the review."
+  }
+
   def "test get latest commits"() {
     given:
     givenGitRepo()