Merge pull request #58 from devtron-labs/shallow-clone

feat: integration test cases added and refactoring around gitContext

Author: prakash100198

pkg/RepoManages.go

@@ -343,7 +343,11 @@ func (impl RepoManagerImpl) checkoutMaterial(material *sql.GitMaterial) (*sql.Gi
 	if err != nil {
 		return material, err
 	}
-	err = impl.repositoryManager.Add(material.GitProviderId, checkoutPath, material.Url, userName, password, gitProvider.AuthMode, gitProvider.SshPrivateKey)
+	gitContext := &git.GitContext{
+		Username: userName,
+		Password: password,
+	}
+	err = impl.repositoryManager.Add(material.GitProviderId, checkoutPath, material.Url, gitContext, gitProvider.AuthMode, gitProvider.SshPrivateKey)
 	if err == nil {
 		material.CheckoutLocation = checkoutPath
 		material.CheckoutStatus = true
@@ -618,7 +622,11 @@ func (impl RepoManagerImpl) GetLatestCommitForBranch(pipelineMaterialId int, bra
 	}()
 
 	userName, password, err := git.GetUserNamePassword(gitMaterial.GitProvider)
-	updated, repo, err := impl.repositoryManager.Fetch(userName, password, gitMaterial.Url, gitMaterial.CheckoutLocation)
+	gitContext := &git.GitContext{
+		Username: userName,
+		Password: password,
+	}
+	updated, repo, err := impl.repositoryManager.Fetch(gitContext, gitMaterial.Url, gitMaterial.CheckoutLocation)
 
 	if err != nil {
 		impl.logger.Errorw("error in fetching the repository ", "err", err)

pkg/git/GitCliUtil.go

@@ -1,6 +1,7 @@
 package git
 
 import (
+	"context"
 	"fmt"
 	"go.uber.org/zap"
 	"gopkg.in/src-d/go-git.v4"
@@ -10,6 +11,13 @@ import (
 	"strings"
 )
 
+type GitContext struct {
+	context.Context // Embedding original Go context
+	Username        string
+	Password        string
+	CloningMode     string
+}
+
 type GitUtil struct {
 	logger *zap.SugaredLogger
 }
@@ -22,10 +30,10 @@ func NewGitUtil(logger *zap.SugaredLogger) *GitUtil {
 
 const GIT_ASK_PASS = "/git-ask-pass.sh"
 
-func (impl *GitUtil) Fetch(rootDir string, username string, password string) (response, errMsg string, err error) {
+func (impl *GitUtil) Fetch(gitContext *GitContext, rootDir string) (response, errMsg string, err error) {
 	impl.logger.Debugw("git fetch ", "location", rootDir)
 	cmd := exec.Command("git", "-C", rootDir, "fetch", "origin", "--tags", "--force")
-	output, errMsg, err := impl.runCommandWithCred(cmd, username, password)
+	output, errMsg, err := impl.runCommandWithCred(cmd, gitContext.Username, gitContext.Password)
 	impl.logger.Debugw("fetch output", "root", rootDir, "opt", output, "errMsg", errMsg, "error", err)
 	return output, errMsg, err
 }

pkg/git/RepositoryManager.go

@@ -37,8 +37,8 @@ import (
 )
 
 type RepositoryManager interface {
-	Fetch(userName, password string, url string, location string) (updated bool, repo *git.Repository, err error)
-	Add(gitProviderId int, location, url string, userName, password string, authMode sql.AuthMode, sshPrivateKeyContent string) error
+	Fetch(gitContext *GitContext, url string, location string) (updated bool, repo *git.Repository, err error)
+	Add(gitProviderId int, location, url string, gitContext *GitContext, authMode sql.AuthMode, sshPrivateKeyContent string) error
 	Clean(cloneDir string) error
 	ChangesSince(checkoutPath string, branch string, from string, to string, count int) ([]*GitCommit, error)
 	ChangesSinceByRepository(repository *git.Repository, branch string, from string, to string, count int) ([]*GitCommit, error)
@@ -58,7 +58,7 @@ func NewRepositoryManagerImpl(logger *zap.SugaredLogger, gitUtil *GitUtil, confi
 	return &RepositoryManagerImpl{logger: logger, gitUtil: gitUtil, configuration: configuration}
 }
 
-func (impl RepositoryManagerImpl) Add(gitProviderId int, location string, url string, userName, password string, authMode sql.AuthMode, sshPrivateKeyContent string) error {
+func (impl RepositoryManagerImpl) Add(gitProviderId int, location string, url string, gitContext *GitContext, authMode sql.AuthMode, sshPrivateKeyContent string) error {
 	var err error
 	start := time.Now()
 	defer func() {
@@ -83,7 +83,7 @@ func (impl RepositoryManagerImpl) Add(gitProviderId int, location string, url st
 		}
 	}
 
-	opt, errorMsg, err := impl.gitUtil.Fetch(location, userName, password)
+	opt, errorMsg, err := impl.gitUtil.Fetch(gitContext, location)
 	if err != nil {
 		impl.logger.Errorw("error in cloning repo", "errorMsg", errorMsg, "err", err)
 		return err
@@ -117,7 +117,7 @@ func (impl RepositoryManagerImpl) clone(auth transport.AuthMethod, cloneDir stri
 	return repo, err
 }
 
-func (impl RepositoryManagerImpl) Fetch(userName, password string, url string, location string) (updated bool, repo *git.Repository, err error) {
+func (impl RepositoryManagerImpl) Fetch(gitContext *GitContext, url string, location string) (updated bool, repo *git.Repository, err error) {
 	start := time.Now()
 	defer func() {
 		util.TriggerGitOperationMetrics("fetch", start, err)
@@ -127,7 +127,7 @@ func (impl RepositoryManagerImpl) Fetch(userName, password string, url string, l
 	if err != nil {
 		return false, nil, err
 	}
-	res, errorMsg, err := impl.gitUtil.Fetch(location, userName, password)
+	res, errorMsg, err := impl.gitUtil.Fetch(gitContext, location)
 	if err == nil && len(res) > 0 {
 		impl.logger.Infow("repository updated", "location", url)
 		//updated