Git Audit - Add scm providers

commands/git/audit/gitaudit.go

@@ -12,9 +12,9 @@ import (
 
 	sourceAudit "github.com/jfrog/jfrog-cli-security/commands/audit"
 	"github.com/jfrog/jfrog-cli-security/utils"
-	"github.com/jfrog/jfrog-cli-security/utils/gitutils"
 	"github.com/jfrog/jfrog-cli-security/utils/results"
 	"github.com/jfrog/jfrog-cli-security/utils/results/output"
+	"github.com/jfrog/jfrog-cli-security/utils/scm"
 	"github.com/jfrog/jfrog-cli-security/utils/xsc"
 )
 
@@ -46,7 +46,7 @@ func (gaCmd *GitAuditCommand) Run() (err error) {
 	// Detect git info
 	gitInfo, err := DetectGitInfo(gaCmd.repositoryLocalPath)
 	if err != nil {
-		return fmt.Errorf("failed to get git context: %v", err)
+		return fmt.Errorf("failed to get source control context: %v", err)
 	}
 	if gitInfo == nil {
 		// No Error but no git info = project working tree is dirty
@@ -65,11 +65,11 @@ func (gaCmd *GitAuditCommand) Run() (err error) {
 }
 
 func DetectGitInfo(wd string) (gitInfo *services.XscGitInfoContext, err error) {
-	gitManager, err := gitutils.NewGitManager(wd)
+	scmManager, err := scm.DetectScmInProject(wd)
 	if err != nil {
 		return
 	}
-	return gitManager.GetGitContext()
+	return scmManager.GetSourceControlContext()
 }
 
 func toAuditParams(params GitAuditParams) *sourceAudit.AuditParams {

utils/gitutils/gitmanager.go → utils/scm/gitmanager.go

@@ -1,4 +1,4 @@
-package gitutils
+package scm
 
 import (
 	"fmt"
@@ -10,32 +10,6 @@ import (
 	"github.com/jfrog/jfrog-client-go/xsc/services"
 )
 
-const (
-	Github    GitProvider = "github"
-	Gitlab    GitProvider = "gitlab"
-	Bitbucket GitProvider = "bitbucket"
-	Azure     GitProvider = "azure"
-
-	// TODO: Add support for other git providers
-
-	// git clone https://sourceforge.net/projects/svn-sample-repo/
-	SourceForge GitProvider = "sourceforge"
-	// git clone https://git-codecommit.{region}.amazonaws.com/v1/repos/{repository_name}
-	AWSCodeCommit GitProvider = "codecommit"
-	// git clone https://gerrit.googlesource.com/git-repo
-	Gerrit GitProvider = "gerrit"
-	// git clone https://gitea.com/gitea/helm-chart.git
-	Gitea GitProvider = "gitea"
-
-	Unknown GitProvider = ""
-)
-
-type GitProvider string
-
-func (gp GitProvider) String() string {
-	return string(gp)
-}
-
 type GitManager struct {
 	// repository represents a git repository as a .git dir.
 	localGitRepository *goGit.Repository
@@ -109,7 +83,7 @@ func getRemoteNames(remotes ...*goGit.Remote) []string {
 }
 
 // IsClean returns true if all the files are in Unmodified status.
-func (gm *GitManager) IsClean() (bool, error) {
+func (gm *GitManager) isClean() (bool, error) {
 	worktree, err := gm.localGitRepository.Worktree()
 	if err != nil {
 		return false, err
@@ -118,12 +92,15 @@ func (gm *GitManager) IsClean() (bool, error) {
 	if err != nil {
 		return false, err
 	}
-
-	return status.IsClean(), nil
+	isClean := status.IsClean()
+	if !isClean {
+		log.Debug(fmt.Sprintf("Git status:\n%v", status))
+	}
+	return isClean, nil
 }
 
 // Detect git information
-func (gm *GitManager) GetGitContext() (gitInfo *services.XscGitInfoContext, err error) {
+func (gm *GitManager) GetSourceControlContext() (gitInfo *services.XscGitInfoContext, err error) {
 	remoteUrl, err := getRemoteUrl(gm.remote)
 	if err != nil {
 		return nil, err
@@ -150,7 +127,7 @@ func (gm *GitManager) GetGitContext() (gitInfo *services.XscGitInfoContext, err
 		LastCommitMessage: strings.TrimSpace(lastCommit.Message),
 		LastCommitAuthor:  lastCommit.Author.Name,
 	}
-	isClean, err := gm.IsClean()
+	isClean, err := gm.isClean()
 	if err != nil {
 		return nil, err
 	}
@@ -173,59 +150,3 @@ func getRemoteUrl(remote *goGit.Remote) (remoteUrl string, err error) {
 	}
 	return remote.Config().URLs[0], nil
 }
-
-// Normalize the URL by removing protocol prefix and any trailing ".git"
-func normalizeGitUrl(url string) string {
-	// jfrog-ignore - false positive, not used for communication
-	url = strings.TrimPrefix(url, "http://")
-	url = strings.TrimPrefix(url, "https://")
-	url = strings.TrimPrefix(url, "ssh://")
-	return strings.TrimSuffix(url, ".git")
-}
-
-func getGitRepoName(url string) string {
-	urlParts := strings.Split(normalizeGitUrl(url), "/")
-	return urlParts[len(urlParts)-1]
-}
-
-func getGitProject(url string) string {
-	// First part after base Url is the owner or the organization name.
-	urlParts := strings.Split(normalizeGitUrl(url), "/")
-	if len(urlParts) < 2 {
-		log.Debug(fmt.Sprintf("Failed to get project name from URL: %s", url))
-		return ""
-	}
-	if len(urlParts) > 2 && urlParts[1] == "scm" {
-		// In BB https clone url looks like this: https://git.id.info/scm/repo-name/repo-name.git --> ['git.id.info', 'scm', 'repo-name', 'repo-name']
-		return urlParts[2]
-	}
-	return urlParts[1]
-}
-
-func getGitProvider(url string) GitProvider {
-	if strings.Contains(url, Github.String()) {
-		return Github
-	}
-	if strings.Contains(url, Gitlab.String()) {
-		return Gitlab
-	}
-	if isBitbucketProvider(url) {
-		return Bitbucket
-	}
-	if strings.Contains(url, Azure.String()) {
-		return Azure
-	}
-	// Unknown for self-hosted git providers
-	log.Debug(fmt.Sprintf("Unknown git provider for URL: %s", url))
-	return Unknown
-}
-
-func isBitbucketProvider(url string) bool {
-	if urlParts := strings.Split(normalizeGitUrl(url), "/"); len(urlParts) > 2 && urlParts[1] == "scm" {
-		return true
-	}
-	if projectName := getGitProject(url); strings.Contains(projectName, "~") {
-		return true
-	}
-	return strings.Contains(url, Bitbucket.String())
-}

utils/gitutils/gitmanager_test.go → utils/scm/gitmanager_test.go

@@ -1,4 +1,4 @@
-package gitutils
+package scm
 
 import (
 	"path/filepath"
@@ -62,14 +62,28 @@ func TestGetGitContext(t *testing.T) {
 			gitInfo: &services.XscGitInfoContext{
 				GitRepoHttpsCloneUrl: "https://gitlab.com/attiasas/test-group/test-security-git.git",
 				GitRepoName:          "test-security-git",
-				GitProject:           "attiasas",
+				GitProject:           "attiasas/test-group",
 				GitProvider:          "gitlab",
 				BranchName:           "main",
 				LastCommitHash:       "ada14e9f525d8cbfb3c8c31ebe345d85ec342480",
 				LastCommitMessage:    "add npm",
 				LastCommitAuthor:     "attiasas",
 			},
 		},
+		{
+			name:                  "Gerrit Project (no owner)",
+			testProjectZipDirPath: filepath.Join(basePath, "gerrit"),
+			gitInfo: &services.XscGitInfoContext{
+				GitRepoHttpsCloneUrl: "https://gerrit.googlesource.com/git-repo",
+				GitRepoName:          "git-repo",
+				GitProject:           "git-repo",
+				GitProvider:          "gerrit",
+				BranchName:           "main",
+				LastCommitHash:       "0533dc46c6521837bb7f222e311a86017781f8f3",
+				LastCommitMessage:    `add to ignore`,
+				LastCommitAuthor:     "attiasas",
+			},
+		},
 		{
 			name:                  "Forked Project (multiple remotes)",
 			testProjectZipDirPath: filepath.Join(basePath, "forked"),
@@ -115,7 +129,7 @@ func TestGetGitContext(t *testing.T) {
 			}
 			assert.NoError(t, err)
 			assert.NotNil(t, gitManager)
-			gitInfo, err := gitManager.GetGitContext()
+			gitInfo, err := gitManager.GetSourceControlContext()
 
 			if testCase.gitInfo == nil {
 				// Dirty project, we can't assert the git info
@@ -134,7 +148,7 @@ func TestGetGitProvider(t *testing.T) {
 	testCases := []struct {
 		name     string
 		url      string
-		provider GitProvider
+		provider ScProvider
 	}{
 		{
 			name:     "Github",
@@ -161,6 +175,21 @@ func TestGetGitProvider(t *testing.T) {
 			url:      "https://dev.azure.com/attiasas/test-security-git/_git/test-security-git",
 			provider: Azure,
 		},
+		{
+			name:     "Gerrit",
+			url:      "https://gerrit.googlesource.com/git-repo",
+			provider: Gerrit,
+		},
+		{
+			name:     "Gitea",
+			url:      "https://gitea.com/gitea/helm-chart.git",
+			provider: Gitea,
+		},
+		{
+			name:     "AWS CodeCommit",
+			url:      "https://git-codecommit.us-west-2.amazonaws.com/v1/repos/test-repo",
+			provider: AWSCodeCommit,
+		},
 		{
 			name:     "Unknown",
 			url:      "ssh://[email protected]/assafa/test-security-git.git",
@@ -197,11 +226,26 @@ func TestGetGitProject(t *testing.T) {
 			url:     "https://git.id.info/scm/repo-name/repo-name.git",
 			project: "repo-name",
 		},
+		{
+			name:    "Gitlab Project (group tree structure)",
+			url:     "https://gitlab.com/attiasas/test-group/test-security-git.git",
+			project: "attiasas/test-group",
+		},
 		{
 			name:    "Bitbucket SSH",
 			url:     "ssh://[email protected]/~assafa/test-security-git.git",
 			project: "~assafa",
 		},
+		{
+			name:    "Gerrit - No project name",
+			url:     "https://gerrit.googlesource.com/git-repo",
+			project: "git-repo",
+		},
+		{
+			name:    "codecommit",
+			url:     "https://git-codecommit.us-west-2.amazonaws.com/v1/repos/test-repo",
+			project: "test-repo",
+		},
 	}
 	for _, testCase := range testCases {
 		t.Run(testCase.name, func(t *testing.T) {