fix: fix git describe tag selection, if multiple tags point to head

Author: qoomon

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 6.1.3
+
+##### Fixes
+- fix git describe tag selection, if multiple tags point to head
+
+
 ## 6.1.1
 
 ##### Fixes

build.gradle

@@ -12,7 +12,7 @@ plugins {
 }
 
 group 'me.qoomon'
-version '6.1.2'
+version '6.1.3'
 sourceCompatibility = JavaVersion.VERSION_1_8
 targetCompatibility = JavaVersion.VERSION_1_8
 

src/main/java/me/qoomon/gitversioning/commons/GitUtil.java

@@ -54,7 +54,7 @@ public static List<String> tagsPointAt(Repository repository, ObjectId revObject
     public static List<String> tagsPointAt(Repository repository, ObjectId revObjectId,
                                            Map<ObjectId, List<Ref>> reverseTagRefMap) {
         return reverseTagRefMap.getOrDefault(revObjectId, emptyList()).stream()
-                .sorted(new RefNameComparator(repository))
+                .sorted(new TagComparator(repository))
                 .map(ref -> shortenRefName(ref.getName()))
                 .collect(toList());
     }
@@ -82,7 +82,7 @@ public static GitDescription describe(Repository repository, ObjectId revObjectI
                 depth++;
 
                 Optional<Ref> matchingTag = reverseTagRefMap.getOrDefault(rev, emptyList()).stream()
-                        .sorted(new RefNameComparator(repository))
+                        .sorted(new TagComparator(repository))
                         .filter(tag -> tagPattern.matcher(shortenRefName(tag.getName())).matches())
                         .findFirst();
 

src/main/java/me/qoomon/gitversioning/commons/RefNameComparator.java

@@ -0,0 +1,51 @@
+package me.qoomon.gitversioning.commons;
+
+import org.eclipse.jgit.lib.Ref;
+import org.eclipse.jgit.lib.Repository;
+import org.eclipse.jgit.revwalk.*;
+
+import java.io.IOException;
+import java.util.Comparator;
+import java.util.Date;
+
+import static org.eclipse.jgit.lib.Constants.OBJ_TAG;
+
+public class TagComparator implements Comparator<Ref> {
+
+    private final RevWalk revWalk;
+
+    public TagComparator(Repository repository) {
+        this.revWalk = new RevWalk(repository);
+    }
+
+    @Override
+    public int compare(Ref ref1, Ref ref2) {
+        try {
+            RevTag revTag1 = revWalk.parseTag(ref1.getObjectId());
+            RevTag revTag2 = revWalk.parseTag(ref2.getObjectId());
+
+            // both tags are annotated tags
+            if (revTag1.getType() == OBJ_TAG && revTag2.getType() == OBJ_TAG) {
+                Date revTag1Date = revTag1.getTaggerIdent().getWhen();
+                Date revTag2Date = revTag2.getTaggerIdent().getWhen();
+                // most recent tags first
+                return -revTag1Date.compareTo(revTag2Date);
+            }
+
+            // only ref1 is annotated tag
+            if (revTag1.getType() == OBJ_TAG) {
+                return -1;
+            }
+
+            // only ref2 is annotated tag
+            if (revTag2.getType() == OBJ_TAG) {
+                return 1;
+            }
+
+            // both tags are lightweight tags
+            return revTag1.name().compareTo(revTag1.getName());
+        } catch (IOException e) {
+            throw new RuntimeException(e);
+        }
+    }
+}

src/main/java/me/qoomon/gitversioning/commons/TagComparator.java

@@ -4,6 +4,7 @@
 import org.eclipse.jgit.api.Git;
 import org.eclipse.jgit.api.Status;
 import org.eclipse.jgit.api.errors.GitAPIException;
+import org.eclipse.jgit.api.errors.InvalidRefNameException;
 import org.eclipse.jgit.lib.ObjectId;
 import org.eclipse.jgit.revwalk.RevCommit;
 import org.junit.jupiter.api.Test;
@@ -13,6 +14,7 @@
 import java.io.IOException;
 import java.nio.file.Path;
 import java.util.List;
+import java.util.regex.Pattern;
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.eclipse.jgit.lib.Constants.HEAD;
@@ -88,7 +90,7 @@ void tagsPointAt_emptyRepo() throws GitAPIException, IOException {
         // given
         Git git = Git.init().setInitialBranch(MASTER).setDirectory(tempDir.toFile()).call();
         // when
-        
+
         List<String> tags = GitUtil.tagsPointAt(git.getRepository(), head(git));
 
         // then
@@ -167,10 +169,33 @@ void tagsPointAt_lightweightTag() throws GitAPIException, IOException {
         assertThat(tags).containsExactlyInAnyOrder(givenTagName);
     }
 
+    private static ObjectId head(Git git) throws IOException {
+        return git.getRepository().resolve(HEAD);
+    }
+
     @Test
+    void describe() throws Exception {
+        // given
+        Git git = Git.init().setInitialBranch(MASTER).setDirectory(tempDir.toFile()).call();
 
+        RevCommit givenCommit = git.commit().setMessage("initial commit").setAllowEmpty(true).call();
 
-    private static ObjectId head(Git git) throws IOException {
-        return git.getRepository().resolve(HEAD);
+        git.tag().setName("v2.1").setAnnotated(true).setObjectId(givenCommit).setMessage(".").call();
+        git.tag().setName("v1.2").setAnnotated(true).setObjectId(givenCommit).setMessage(".").call();
+        git.tag().setName("v2.3").setAnnotated(true).setObjectId(givenCommit).setMessage(".").call();
+        Thread.sleep(1000);
+        String givenTagName = "v1.3";
+        git.tag().setName(givenTagName).setAnnotated(true).setObjectId(givenCommit).setMessage(".").call();
+
+        // when
+        GitDescription description = GitUtil.describe(git.getRepository(), head(git), Pattern.compile("v.+"));
+
+        // then
+        assertThat(description).satisfies(it -> {
+            assertThat(it.getCommit()).isEqualTo(givenCommit.getName());
+            assertThat(it.getDistance()).isEqualTo(0);
+            assertThat(it.getTag()).isEqualTo(givenTagName);
+        });
     }
+
 }