Add the ability to configure logger for git functions (#57)

* Add the ability to configure logger for git functions

* Configure logger only when nonnil

* Fix test

Author: yorinasub17

git/auth.go

@@ -5,12 +5,16 @@ import (
 
 	"github.com/gruntwork-io/go-commons/shell"
 	"github.com/hashicorp/go-multierror"
+	"github.com/sirupsen/logrus"
 )
 
 // ConfigureForceHTTPS configures git to force usage of https endpoints instead of SSH based endpoints for the three
 // primary VCS platforms (GitHub, GitLab, BitBucket).
-func ConfigureForceHTTPS() error {
+func ConfigureForceHTTPS(logger *logrus.Logger) error {
 	opts := shell.NewShellOptions()
+	if logger != nil {
+		opts.Logger = logger
+	}
 
 	var allErr error
 
@@ -40,8 +44,12 @@ func ConfigureForceHTTPS() error {
 // with git over HTTPS. This uses the cache credentials store to configure the credentials. Refer to the git
 // documentation on credentials storage for more information:
 // https://git-scm.com/book/en/v2/Git-Tools-Credential-Storage
-func ConfigureHTTPSAuth(gitUsername string, gitOauthToken string, vcsHost string) error {
+func ConfigureHTTPSAuth(logger *logrus.Logger, gitUsername string, gitOauthToken string, vcsHost string) error {
 	opts := shell.NewShellOptions()
+	if logger != nil {
+		opts.Logger = logger
+	}
+
 	if err := shell.RunShellCommand(
 		opts,
 		"git", "config", "--global",

git/git.go

@@ -3,25 +3,32 @@ package git
 import (
 	"github.com/gruntwork-io/go-commons/files"
 	"github.com/gruntwork-io/go-commons/shell"
+	"github.com/sirupsen/logrus"
 )
 
 // Clone runs git clone to clone the specified repository into the given target directory.
-func Clone(repo string, targetDir string) error {
+func Clone(logger *logrus.Logger, repo string, targetDir string) error {
 	if !files.IsDir(targetDir) {
 		return TargetDirectoryNotExistsErr{dirPath: targetDir}
 	}
 
 	opts := shell.NewShellOptions()
+	if logger != nil {
+		opts.Logger = logger
+	}
 	return shell.RunShellCommand(opts, "git", "clone", repo, targetDir)
 }
 
 // Checkout checks out the given ref for the repo cloned in the target directory.
-func Checkout(ref string, targetDir string) error {
+func Checkout(logger *logrus.Logger, ref string, targetDir string) error {
 	if !files.IsDir(targetDir) {
 		return TargetDirectoryNotExistsErr{dirPath: targetDir}
 	}
 
 	opts := shell.NewShellOptions()
+	if logger != nil {
+		opts.Logger = logger
+	}
 	opts.WorkingDir = targetDir
 	return shell.RunShellCommand(opts, "git", "checkout", ref)
 }

git/git_test.go

@@ -6,6 +6,7 @@ import (
 	"testing"
 
 	"github.com/gruntwork-io/go-commons/files"
+	"github.com/gruntwork-io/go-commons/logging"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
@@ -15,7 +16,7 @@ func TestGitClone(t *testing.T) {
 
 	tmpDir, err := ioutil.TempDir("", "git-test")
 	require.NoError(t, err)
-	require.NoError(t, Clone("https://github.com/gruntwork-io/go-commons.git", tmpDir))
+	require.NoError(t, Clone(logging.GetLogger(t.Name()), "https://github.com/gruntwork-io/go-commons.git", tmpDir))
 	assert.True(t, files.FileExists(filepath.Join(tmpDir, "LICENSE.txt")))
 }
 
@@ -24,7 +25,7 @@ func TestGitCheckout(t *testing.T) {
 
 	tmpDir, err := ioutil.TempDir("", "git-test")
 	require.NoError(t, err)
-	require.NoError(t, Clone("https://github.com/gruntwork-io/go-commons.git", tmpDir))
-	require.NoError(t, Checkout("v0.10.0", tmpDir))
+	require.NoError(t, Clone(logging.GetLogger(t.Name()), "https://github.com/gruntwork-io/go-commons.git", tmpDir))
+	require.NoError(t, Checkout(logging.GetLogger(t.Name()), "v0.10.0", tmpDir))
 	assert.False(t, files.FileExists(filepath.Join(tmpDir, "git", "git_test.go")))
 }

git/test/auth_test.go

@@ -10,6 +10,7 @@ import (
 
 	"github.com/gruntwork-io/go-commons/files"
 	"github.com/gruntwork-io/go-commons/git"
+	"github.com/gruntwork-io/go-commons/logging"
 	"github.com/gruntwork-io/terratest/modules/environment"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
@@ -19,6 +20,10 @@ const (
 	gitPATEnvName = "GITHUB_OAUTH_TOKEN"
 )
 
+var (
+	logger = logging.GetLogger("testlogger")
+)
+
 // NOTE: All these tests should be run in the provided docker environment to avoid polluting the local git configuration
 // settings. The tests will assert that it is running in the docker environment, and will fail if it is not.
 
@@ -31,11 +36,11 @@ func TestHTTPSAuth(t *testing.T) {
 
 	environment.RequireEnvVar(t, gitPATEnvName)
 	gitPAT := os.Getenv(gitPATEnvName)
-	require.NoError(t, git.ConfigureHTTPSAuth("git", gitPAT, "github.com"))
+	require.NoError(t, git.ConfigureHTTPSAuth(logger, "git", gitPAT, "github.com"))
 
 	tmpDir, err := ioutil.TempDir("", "git-test")
 	require.NoError(t, err)
-	require.NoError(t, git.Clone("https://github.com/gruntwork-io/terraform-aws-lambda.git", tmpDir))
+	require.NoError(t, git.Clone(logger, "https://github.com/gruntwork-io/terraform-aws-lambda.git", tmpDir))
 	assert.True(t, files.IsDir(filepath.Join(tmpDir, "modules/lambda")))
 }
 
@@ -48,11 +53,11 @@ func TestForceHTTPS(t *testing.T) {
 
 	environment.RequireEnvVar(t, gitPATEnvName)
 	gitPAT := os.Getenv(gitPATEnvName)
-	require.NoError(t, git.ConfigureHTTPSAuth("git", gitPAT, "github.com"))
-	require.NoError(t, git.ConfigureForceHTTPS())
+	require.NoError(t, git.ConfigureHTTPSAuth(logger, "git", gitPAT, "github.com"))
+	require.NoError(t, git.ConfigureForceHTTPS(logger))
 
 	tmpDir, err := ioutil.TempDir("", "git-test")
 	require.NoError(t, err)
-	require.NoError(t, git.Clone("git@github.com:gruntwork-io/terraform-aws-lambda.git", tmpDir))
+	require.NoError(t, git.Clone(logger, "git@github.com:gruntwork-io/terraform-aws-lambda.git", tmpDir))
 	assert.True(t, files.IsDir(filepath.Join(tmpDir, "modules/lambda")))
 }