refactor!: replace debuglogger with apex

BREAKING CHANGE: this commit replaces the previous overly verbose logging solution with apex. All consumers will need to be able to use apex in order to control the log level. Overall it should however improve the usage of this package.

Mitigation: Remove debugLogger from the init of this package. If you want to control the log level import the apex log package into your project and set it there.

Author: fallion

commit_test.go

@@ -1,8 +1,6 @@
 package git
 
 import (
-	"io/ioutil"
-	"log"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
@@ -12,7 +10,7 @@ func TestCommit(t *testing.T) {
 	repo := setupRepo()
 	createTestHistory(repo)
 
-	testGit := &Git{repo: repo, DebugLogger: log.New(ioutil.Discard, "", 0)}
+	testGit := &Git{repo: repo}
 
 	head, _ := testGit.CurrentCommit()
 

commits_between_test.go

@@ -1,8 +1,6 @@
 package git
 
 import (
-	"io/ioutil"
-	"log"
 	"testing"
 
 	"github.com/go-git/go-git/v5"
@@ -12,7 +10,7 @@ import (
 
 func TestCommitsBetween(t *testing.T) {
 	repo, _ := git.PlainOpen("./testdata/git_tags")
-	testGit := &Git{repo: repo, DebugLogger: log.New(ioutil.Discard, "", 0)}
+	testGit := &Git{repo: repo}
 
 	head, err := repo.Head()
 
@@ -42,7 +40,7 @@ func TestNoToCommit(t *testing.T) {
 
 	head, _ := repo.Head()
 
-	testGit := &Git{repo: repo, DebugLogger: log.New(ioutil.Discard, "", 0)}
+	testGit := &Git{repo: repo}
 
 	commits, err := testGit.CommitsBetween(head.Hash(), plumbing.Hash{})
 

commits_on_branch.go

@@ -3,6 +3,7 @@ package git
 import (
 	"errors"
 
+	"github.com/apex/log"
 	"github.com/go-git/go-git/v5"
 	"github.com/go-git/go-git/v5/plumbing"
 	"github.com/go-git/go-git/v5/plumbing/object"
@@ -32,7 +33,7 @@ func (g *Git) CommitsOnBranch(
 	})
 
 	if branchIterErr != nil {
-		g.DebugLogger.Printf("Stopped getting commits on branch: %v", branchIterErr)
+		log.Debugf("Stopped getting commits on branch: %v", branchIterErr)
 	}
 
 	return branchCommits, nil

commits_on_branch_simple.go

@@ -1,11 +1,13 @@
 package git
 
 import (
+	"github.com/apex/log"
 	"github.com/go-git/go-git/v5"
 	"github.com/go-git/go-git/v5/plumbing"
 	"github.com/go-git/go-git/v5/plumbing/object"
 )
 
+// SimpleCommit is a slimed down commit object of just Hash and Message
 type SimpleCommit struct {
 	Hash    [20]byte
 	Message string
@@ -35,7 +37,7 @@ func (g *Git) CommitsOnBranchSimple(
 	})
 
 	if branchIterErr != nil {
-		g.DebugLogger.Printf("Stopped getting commits on branch: %v", branchIterErr)
+		log.Debugf("Stopped getting commits on branch: %v", branchIterErr)
 	}
 
 	return branchCommits, nil

current_commit.go

@@ -1,6 +1,7 @@
 package git
 
 import (
+	"github.com/apex/log"
 	"github.com/go-git/go-git/v5/plumbing/object"
 )
 
@@ -14,7 +15,7 @@ func (g *Git) CurrentCommit() (*object.Commit, error) {
 
 	currentCommitHash := head.Hash()
 
-	g.DebugLogger.Printf("current commitHash: %v \n", currentCommitHash)
+	log.Debugf("current commitHash: %v \n", currentCommitHash)
 
 	commitObject, err := g.repo.CommitObject(currentCommitHash)
 

current_commit_test.go

@@ -1,8 +1,6 @@
 package git
 
 import (
-	"io/ioutil"
-	"log"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
@@ -12,7 +10,7 @@ func TestCurrentCommit(t *testing.T) {
 	repo := setupRepo()
 	createTestHistory(repo)
 
-	testGit := &Git{repo: repo, DebugLogger: log.New(ioutil.Discard, "", 0)}
+	testGit := &Git{repo: repo}
 
 	currentCommit, err := testGit.CurrentCommit()
 

current_tag.go

@@ -2,6 +2,8 @@ package git
 
 import (
 	"errors"
+
+	"github.com/apex/log"
 )
 
 var (
@@ -23,10 +25,10 @@ func (g *Git) CurrentTag() (*Tag, error) {
 		return nil, err
 	}
 
-	g.DebugLogger.Println("head hash: ", head.Hash())
+	log.Debugf("head hash: %s", head.Hash())
 
 	for _, tag := range tags {
-		g.DebugLogger.Printf("tag: %v, hash: %v", tag.Name, tag.Hash)
+		log.Debugf("tag: %v, hash: %v", tag.Name, tag.Hash)
 
 		if tag.Hash == head.Hash() {
 			return tag, nil

current_tag_test.go

@@ -1,15 +1,13 @@
 package git
 
 import (
-	"io/ioutil"
-	"log"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
 )
 
 func TestCurrentTagHappy(t *testing.T) {
-	testGit, err := OpenGit("./testdata/git_tags", nil)
+	testGit, err := OpenGit("./testdata/git_tags")
 
 	assert.NoError(t, err)
 
@@ -20,7 +18,7 @@ func TestCurrentTagHappy(t *testing.T) {
 }
 
 func TestCurrentTagAnnotatedHappy(t *testing.T) {
-	testGit, err := OpenGit("./testdata/annotated_git_tags_mix", nil)
+	testGit, err := OpenGit("./testdata/annotated_git_tags_mix")
 
 	assert.NoError(t, err)
 
@@ -34,7 +32,7 @@ func TestCurrentTagUnhappy(t *testing.T) {
 	repo := setupRepo()
 	createTestHistory(repo)
 
-	testGit := &Git{repo: repo, DebugLogger: log.New(ioutil.Discard, "", 0)}
+	testGit := &Git{repo: repo}
 
 	_, err := testGit.CurrentTag()
 

docs.go

@@ -1,2 +1,2 @@
-// Package history is a wrapper for Git actions. The main purpose is the unify some functionality in this package.
+// Package git is a wrapper for Git actions. The main purpose is the unify some functionality in this package.
 package git

get_tags.go

@@ -3,6 +3,7 @@ package git
 import (
 	"sort"
 
+	"github.com/apex/log"
 	"github.com/go-git/go-git/v5"
 	"github.com/go-git/go-git/v5/plumbing"
 	"github.com/go-git/go-git/v5/plumbing/object"
@@ -23,7 +24,7 @@ func (g *Git) getTags() ([]*Tag, error) {
 		commitDate, err := g.commitDate(t.Hash())
 
 		if err != nil {
-			g.DebugLogger.Printf("tag: %v ignored due to missing commit date: %v", t.Name(), err)
+			log.Debugf("tag: %v ignored due to missing commit date: %v", t.Name(), err)
 			return nil
 		}
 
@@ -50,9 +51,9 @@ func (g *Git) getTags() ([]*Tag, error) {
 	// Tags are alphabetically ordered. We need to sort them by date.
 	sortedTags := sortTags(g.repo, tags)
 
-	g.DebugLogger.Println("Sorted tag output: ")
+	log.Debug("Sorted tag output: ")
 	for _, taginstance := range sortedTags {
-		g.DebugLogger.Printf("hash: %v time: %v", taginstance.Hash, taginstance.Date.UTC())
+		log.Debugf("hash: %v time: %v", taginstance.Hash, taginstance.Date.UTC())
 	}
 
 	return sortedTags, nil