Files
argo-cd/util/git/git.go
2025-07-01 16:33:04 +00:00

108 lines
3.4 KiB
Go

package git
import (
"fmt"
"net/url"
"regexp"
"strings"
)
// EnsurePrefix idempotently ensures that a base string has a given prefix.
func ensurePrefix(s, prefix string) string {
if !strings.HasPrefix(s, prefix) {
s = prefix + s
}
return s
}
var (
commitSHARegex = regexp.MustCompile("^[0-9A-Fa-f]{40}$")
sshURLRegex = regexp.MustCompile("^(ssh://)?([^/:]*?)@[^@]+$")
httpsURLRegex = regexp.MustCompile("^(https://).*")
httpURLRegex = regexp.MustCompile("^(http://).*")
)
// IsCommitSHA returns whether or not a string is a 40 character SHA-1
func IsCommitSHA(sha string) bool {
return commitSHARegex.MatchString(sha)
}
var truncatedCommitSHARegex = regexp.MustCompile("^[0-9A-Fa-f]{7,}$")
// IsTruncatedCommitSHA returns whether or not a string is a truncated SHA-1
func IsTruncatedCommitSHA(sha string) bool {
return truncatedCommitSHARegex.MatchString(sha)
}
// SameURL returns whether or not the two repository URLs are equivalent in location
func SameURL(leftRepo, rightRepo string) bool {
normalLeft := NormalizeGitURLAllowInvalid(leftRepo)
normalRight := NormalizeGitURLAllowInvalid(rightRepo)
return normalLeft != "" && normalRight != "" && normalLeft == normalRight
}
// NormalizeGitURLAllowInvalid is similar to NormalizeGitURL, except returning an original url if the url is invalid.
// Needed to allow a deletion of repos with invalid urls. See https://github.com/argoproj/argo-cd/issues/20921.
func NormalizeGitURLAllowInvalid(repo string) string {
normalized := NormalizeGitURL(repo)
if normalized == "" {
return repo
}
return normalized
}
// NormalizeGitURL normalizes a git URL for purposes of comparison, as well as preventing redundant
// local clones (by normalizing various forms of a URL to a consistent location).
// Prefer using SameURL() over this function when possible. This algorithm may change over time
// and should not be considered stable from release to release
func NormalizeGitURL(repo string) string {
repo = strings.ToLower(strings.TrimSpace(repo))
if yes, _ := IsSSHURL(repo); yes {
if !strings.HasPrefix(repo, "ssh://") {
// We need to replace the first colon in git@server... style SSH URLs with a slash, otherwise
// net/url.Parse will interpret it incorrectly as the port.
repo = strings.Replace(repo, ":", "/", 1)
repo = ensurePrefix(repo, "ssh://")
}
}
repo = strings.TrimSuffix(repo, ".git")
repoURL, err := url.Parse(repo)
if err != nil {
return ""
}
normalized := repoURL.String()
return strings.TrimPrefix(normalized, "ssh://")
}
// IsSSHURL returns true if supplied URL is SSH URL
func IsSSHURL(url string) (bool, string) {
matches := sshURLRegex.FindStringSubmatch(url)
if len(matches) > 2 {
return true, matches[2]
}
return false, ""
}
// IsHTTPSURL returns true if supplied URL is HTTPS URL
func IsHTTPSURL(url string) bool {
return httpsURLRegex.MatchString(url)
}
// IsHTTPURL returns true if supplied URL is HTTP URL
func IsHTTPURL(url string) bool {
return httpURLRegex.MatchString(url)
}
// TestRepo tests if a repo exists and is accessible with the given credentials
func TestRepo(repo string, creds Creds, insecure bool, enableLfs bool, proxy string, noProxy string) error {
client, err := NewClient(repo, creds, insecure, enableLfs, proxy, noProxy)
if err != nil {
return fmt.Errorf("unable to initialize git client: %w", err)
}
_, err = client.LsRemote("HEAD")
if err != nil {
return fmt.Errorf("unable to ls-remote HEAD on repository: %w", err)
}
return nil
}