adds tests for checking between tags

Author: barelyhuman

log/log.go

@@ -210,13 +210,14 @@ func CommitLog(currentRepository *git.Repository, startCommitString string, endC
 		key = strings.SplitN(strings.TrimSpace(key), ":", 2)[0]
 		normalizedHash := c.Hash.String() + " - " + normalizeCommit(c.Message, scopedKey)
 
-		logContainer.AddCommit(key, normalizedHash, skipClassification)
-
 		if endHash == nil && previousTag != nil && previousTag.Hash == c.Hash {
 			break
 		} else if endHash != nil && c.Hash == endHash.Hash {
 			break
 		}
+
+		logContainer.AddCommit(key, normalizedHash, skipClassification)
+
 	}
 	return logContainer.ToMarkdown(skipClassification), ErrMessage{}
 }

log/log_test.go

@@ -126,7 +126,6 @@ func TestCommitLogStartHash(t *testing.T) {
 	t.Log("Commits: ", expectedCommits)
 	t.Log("Start At:", startCommitHash)
 
-	// include only feature commits
 	log, _ := CommitLog(repo, startCommitHash, "", SupportedKeys, true)
 	if log == "" {
 		t.Fail()
@@ -151,12 +150,11 @@ func TestCommitLogEndHash(t *testing.T) {
 
 	endCommitHash := expectedCommits[1]
 	firstCommit := expectedCommits[0]
-	acceptedCommitHashes := expectedCommits[1:]
+	acceptedCommitHashes := expectedCommits[2:]
 
 	t.Log("Commits: ", expectedCommits)
 	t.Log("End At:", endCommitHash)
 
-	// include only feature commits
 	log, _ := CommitLog(repo, "", endCommitHash, SupportedKeys, true)
 	if log == "" {
 		t.Fail()
@@ -176,8 +174,3 @@ func TestCommitLogEndHash(t *testing.T) {
 
 	t.Log("\n", log)
 }
-
-// TODO:
-// - Tests for checking between tags
-// - Variation of the above to check between 2 tags
-// - Another variation where one tag points to the head of the repo

log/tag_test.go

@@ -0,0 +1,146 @@
+package commitlog
+
+import (
+	"strings"
+	"testing"
+
+	"github.com/go-git/go-git/v5"
+	"github.com/go-git/go-git/v5/plumbing"
+)
+
+func TestCommitLogSingleTag(t *testing.T) {
+	secondCommit := expectedCommits[1]
+	acceptedCommits := expectedCommits[2:]
+
+	t.Log("Commits:", expectedCommits)
+	t.Log("Tagged:", secondCommit)
+
+	hash, err := repo.ResolveRevision(plumbing.Revision(secondCommit))
+	bail(err)
+
+	_, err = repo.CreateTag("0.0.0", *hash, &git.CreateTagOptions{
+		Message: "0.0.0",
+	})
+	bail(err)
+
+	log, _ := CommitLog(repo, "", "", SupportedKeys, true)
+	if log == "" {
+		t.Fail()
+	}
+
+	if strings.Contains(log, expectedCommits[0]) {
+		t.Fail()
+	}
+
+	for _, commit := range acceptedCommits {
+		if !strings.Contains(log, commit) {
+			t.Fail()
+		}
+	}
+
+	t.Log(log)
+
+	// clean-up
+	bail(repo.DeleteTag("0.0.0"))
+
+}
+
+// Test with 2 tags, one on the second commit and one on the 2nd last commit,
+// should only have the last commit in the log
+func TestCommitLogDualTag(t *testing.T) {
+	secondCommit := expectedCommits[1]
+	secondLastCommit := expectedCommits[len(expectedCommits)-2]
+	acceptedCommit := expectedCommits[len(expectedCommits)-1]
+
+	t.Log("Commits:", expectedCommits)
+	t.Log("Tagged:", secondCommit, secondLastCommit)
+
+	secondHash, err := repo.ResolveRevision(plumbing.Revision(secondCommit))
+	bail(err)
+
+	secondLastHash, err := repo.ResolveRevision(plumbing.Revision(secondLastCommit))
+	bail(err)
+
+	_, err = repo.CreateTag("0.0.0", *secondHash, &git.CreateTagOptions{
+		Message: "0.0.0",
+	})
+	bail(err)
+
+	_, err = repo.CreateTag("0.0.1", *secondLastHash, &git.CreateTagOptions{
+		Message: "0.0.1",
+	})
+	bail(err)
+
+	log, _ := CommitLog(repo, "", "", SupportedKeys, true)
+	if log == "" {
+		t.Fail()
+	}
+
+	for _, commit := range expectedCommits {
+		if commit == acceptedCommit {
+			if !strings.Contains(log, acceptedCommit) {
+				t.Fail()
+			}
+		} else {
+			if strings.Contains(log, commit) {
+				t.Fail()
+			}
+		}
+
+	}
+
+	t.Log(log)
+
+	// clean-up
+	bail(repo.DeleteTag("0.0.0"))
+	bail(repo.DeleteTag("0.0.1"))
+}
+
+// Test with 2 tags, one on the second commit and one on the last commit,
+// should give all commits till the 1st tag
+func TestCommitLogHeadTag(t *testing.T) {
+	secondCommit := expectedCommits[1]
+	lastCommit := expectedCommits[len(expectedCommits)-1]
+
+	t.Log("Commits:", expectedCommits)
+	t.Log("Tagged:", secondCommit, lastCommit)
+
+	secondHash, err := repo.ResolveRevision(plumbing.Revision(secondCommit))
+	bail(err)
+
+	lastHash, err := repo.ResolveRevision(plumbing.Revision(lastCommit))
+	bail(err)
+
+	_, err = repo.CreateTag("0.0.0", *secondHash, &git.CreateTagOptions{
+		Message: "0.0.0",
+	})
+	bail(err)
+
+	_, err = repo.CreateTag("0.0.1", *lastHash, &git.CreateTagOptions{
+		Message: "0.0.1",
+	})
+	bail(err)
+
+	log, _ := CommitLog(repo, "", "", SupportedKeys, true)
+	if log == "" {
+		t.Fail()
+	}
+
+	for index, commit := range expectedCommits {
+		if index <= 1 {
+			if strings.Contains(log, commit) {
+				t.Fail()
+			}
+		}
+		if index > 1 && !strings.Contains(log, commit) {
+			t.Fail()
+		}
+
+	}
+
+	t.Log(log)
+
+	// clean-up
+	bail(repo.DeleteTag("0.0.0"))
+	bail(repo.DeleteTag("0.0.1"))
+}