remove jgit (#685)

Author: yiweny

build.gradle

@@ -41,7 +41,6 @@ sourceSets {
 
 dependencies {
     implementation gradleApi()
-    implementation 'org.eclipse.jgit:org.eclipse.jgit'
     implementation 'com.google.guava:guava'
 
     groovyImplementation localGroovy()

changelog/@unreleased/pr-685.v2.yml

@@ -0,0 +1,7 @@
+type: break
+break:
+  description: |-
+    The PR removes all usage of jgit and use native git. The native git binary is now required for this plugin to work.
+    There are two major benefits: 1. Only calls git describe once now so the gitVersion() task is much faster. 2. The plugin current supports git worktree.
+  links:
+  - https://github.com/palantir/gradle-git-version/pull/685

src/main/java/com/palantir/gradle/gitversion/NativeGitDescribe.java renamed to src/main/java/com/palantir/gradle/gitversion/Git.java

@@ -16,6 +16,7 @@
 
 package com.palantir.gradle.gitversion;
 
+import com.google.common.annotations.VisibleForTesting;
 import com.google.common.base.Preconditions;
 import com.google.common.base.Splitter;
 import java.io.BufferedReader;
@@ -25,33 +26,52 @@
 import java.nio.charset.StandardCharsets;
 import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.HashMap;
 import java.util.HashSet;
 import java.util.List;
+import java.util.Map;
 import java.util.Set;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 /**
  * Mimics git describe by using rev-list to support versions of git < 1.8.4.
  */
-class NativeGitDescribe implements GitDescribe {
-    private static final Logger log = LoggerFactory.getLogger(NativeGitDescribe.class);
+class Git {
+    private static final Logger log = LoggerFactory.getLogger(Git.class);
 
     private static final Splitter LINE_SPLITTER =
             Splitter.on(System.getProperty("line.separator")).omitEmptyStrings();
     private static final Splitter WORD_SPLITTER = Splitter.on(" ").omitEmptyStrings();
 
     private final File directory;
 
-    NativeGitDescribe(File directory) {
+    Git(File directory) {
+        this(directory, false);
+    }
+
+    @VisibleForTesting
+    Git(File directory, boolean testing) {
+        if (!gitCommandExists()) {
+            throw new RuntimeException("Git not found in project");
+        }
         this.directory = directory;
+        if (testing && !checkIfUserIsSet()) {
+            setGitUser();
+        }
     }
 
     private String runGitCmd(String... commands) throws IOException, InterruptedException {
+        return runGitCmd(new HashMap<>(), commands);
+    }
+
+    private String runGitCmd(Map<String, String> envvars, String... commands) throws IOException, InterruptedException {
         List<String> cmdInput = new ArrayList<>();
         cmdInput.add("git");
         cmdInput.addAll(Arrays.asList(commands));
         ProcessBuilder pb = new ProcessBuilder(cmdInput);
+        Map<String, String> environment = pb.environment();
+        environment.putAll(envvars);
         pb.directory(directory);
         pb.redirectErrorStream(true);
 
@@ -74,12 +94,77 @@ private String runGitCmd(String... commands) throws IOException, InterruptedExce
         return builder.toString().trim();
     }
 
-    @Override
-    public String describe(String prefix) {
-        if (!gitCommandExists()) {
+    public String runGitCommand(Map<String, String> envvar, String... command) {
+        try {
+            return runGitCmd(envvar, command);
+        } catch (IOException | InterruptedException | RuntimeException e) {
+            log.debug("Native git command {} failed.\n", command, e);
+            return null;
+        }
+    }
+
+    public String runGitCommand(String... command) {
+        return runGitCommand(new HashMap<>(), command);
+    }
+
+    private boolean checkIfUserIsSet() {
+        try {
+            String userEmail = runGitCmd("config", "user.email");
+            if (userEmail.isEmpty()) {
+                return false;
+            }
+            return true;
+        } catch (IOException | InterruptedException | RuntimeException e) {
+            log.debug("Native git config user.email failed", e);
+            return false;
+        }
+    }
+
+    private void setGitUser() {
+        try {
+            runGitCommand("config", "--global", "user.email", "[email protected]");
+            runGitCommand("config", "--global", "user.name", "name");
+        } catch (RuntimeException e) {
+            log.debug("Native git set user failed", e);
+        }
+    }
+
+    public String getCurrentBranch() {
+        try {
+            String branch = runGitCmd("branch", "--show-current");
+            if (branch.isEmpty()) {
+                return null;
+            }
+            return branch;
+        } catch (IOException | InterruptedException | RuntimeException e) {
+            log.debug("Native git branch --show-current failed", e);
+            return null;
+        }
+    }
+
+    public String getCurrentHeadFullHash() {
+        try {
+            return runGitCmd("rev-parse", "HEAD");
+        } catch (IOException | InterruptedException | RuntimeException e) {
+            log.debug("Native git rev-parse HEAD failed", e);
+            return null;
+        }
+    }
+
+    public Boolean isClean() {
+        try {
+            String result = runGitCmd("status", "--porcelain");
+            if (result.isEmpty()) {
+                return true;
+            }
+            return false;
+        } catch (IOException | InterruptedException | RuntimeException e) {
+            log.debug("Native git status --porcelain failed", e);
             return null;
         }
+    }
 
+    public String describe(String prefix) {
         try {
             // Get SHAs of all tags, we only need to search for these later on
             Set<String> tagRefs = new HashSet<>();

src/main/java/com/palantir/gradle/gitversion/GitDescribe.java

@@ -16,7 +16,6 @@
 package com.palantir.gradle.gitversion;
 
 import java.io.File;
-import java.io.IOException;
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.ConcurrentMap;
 import org.gradle.api.Project;
@@ -53,12 +52,7 @@ public final VersionDetails getVersionDetails(File project, Object args) {
     }
 
     private VersionDetails createVersionDetails(File gitDir, GitVersionArgs args) {
-        try {
-            return TimingVersionDetails.wrap(timer, new VersionDetailsImpl(gitDir, args));
-        } catch (IOException e) {
-            log.debug("Cannot compute version details", e);
-            return null;
-        }
+        return TimingVersionDetails.wrap(timer, new VersionDetailsImpl(gitDir, args));
     }
 
     public final Timer timer() {