Skip to content

feat(ctrl): improve template errors and GitHub URL handling #873

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(ctrl): improve template errors and GitHub URL handling #873

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 45 additions & 45 deletions cyclops-ctrl/pkg/template/git.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,20 +74,20 @@ func (r Repo) LoadTemplate(repoURL, path, commit, resolvedVersion string) (*mode
}

// region read files
filesFs, err := fs.Chroot(path)
if err != nil {
return nil, errors.Wrap(err, "could not find 'templates' dir; it should be placed in the repo/path you provided; make sure 'templates' directory exists")
}
filesFs, err := fs.Chroot(path)
if err != nil {
return nil, errors.Wrap(err, "invalid path: set path to the Helm chart folder (contains Chart.yaml and templates/). Do not point to a file or the templates/ subfolder.")
}

files, err := readFiles("", filesFs)
if err != nil {
return nil, errors.Wrap(err, "failed to read template files")
}
// endregion

if len(files) == 0 {
return nil, errors.Errorf("no files found in repo %v on path %v; make sure the repo, path and version are correct", repoURL, path)
}
if len(files) == 0 {
return nil, errors.Errorf("no files found at path %v in repo %v. Path must be a chart root containing Chart.yaml and templates/. Check repo URL (avoid trailing .git), path, and version/commit.", path, repoURL)
}

// region map files to template
metadataBytes := []byte{}
Expand Down Expand Up @@ -310,13 +310,13 @@ func resolveRef(repo, version string, creds *auth.Credentials) (string, error) {
})

// We can then use every Remote functions to retrieve wanted information
refs, err := rem.List(&git.ListOptions{
PeelingOption: git.AppendPeeled,
Auth: httpBasicAuthCredentials(creds),
})
if err != nil {
return "", errors.Wrap(err, fmt.Sprintf("repo %s was not cloned successfully; authentication might be required; check if repository exists and you referenced it correctly", repo))
}
refs, err := rem.List(&git.ListOptions{
PeelingOption: git.AppendPeeled,
Auth: httpBasicAuthCredentials(creds),
})
if err != nil {
return "", errors.Wrap(err, fmt.Sprintf("failed to list refs for %s. Hint: use repo URL without trailing .git for GitHub; ensure repo exists and auth is configured for private repos.", repo))
}

// Filters the references list and only keeps tags
for _, ref := range refs {
Expand All @@ -335,13 +335,13 @@ func resolveDefaultBranchRef(repo string, creds *auth.Credentials) (string, erro
})

// We can then use every Remote functions to retrieve wanted information
refs, err := rem.List(&git.ListOptions{
PeelingOption: git.AppendPeeled,
Auth: httpBasicAuthCredentials(creds),
})
if err != nil {
return "", errors.Wrap(err, fmt.Sprintf("repo %s was not cloned successfully; authentication might be required; check if repository exists and you referenced it correctly", repo))
}
refs, err := rem.List(&git.ListOptions{
PeelingOption: git.AppendPeeled,
Auth: httpBasicAuthCredentials(creds),
})
if err != nil {
return "", errors.Wrap(err, fmt.Sprintf("failed to list refs for %s. Hint: ensure repo URL is correct and accessible; for GitHub avoid trailing .git.", repo))
}

// Filters the references list and only keeps tags
for _, r := range refs {
Expand Down Expand Up @@ -384,14 +384,14 @@ func clone(repoURL, commit string, creds *auth.Credentials) (billy.Filesystem, e
}
}

repo, err := git.Clone(memory.NewStorage(), memfs.New(), &git.CloneOptions{
URL: repoURL,
Tags: git.AllTags,
Auth: httpBasicAuthCredentials(creds),
})
if err != nil {
return nil, errors.Wrap(err, fmt.Sprintf("repo %s was not cloned successfully; authentication might be required; check if repository exists and you referenced it correctly", repoURL))
}
repo, err := git.Clone(memory.NewStorage(), memfs.New(), &git.CloneOptions{
URL: repoURL,
Tags: git.AllTags,
Auth: httpBasicAuthCredentials(creds),
})
if err != nil {
return nil, errors.Wrap(err, fmt.Sprintf("failed to clone %s. Check repo URL (avoid trailing .git for GitHub), network/auth, and that the repo exists.", repoURL))
}

wt, err := repo.Worktree()
if err != nil {
Expand Down Expand Up @@ -537,20 +537,20 @@ func readFiles(path string, fs billy.Filesystem) ([]*chart.File, error) {
}

func (r Repo) mapGitHubRepoTemplate(repoURL, path, commitSHA string, creds *auth.Credentials) (*models.Template, error) {
tgzData, err := gitproviders2.GitHubClone(repoURL, commitSHA, creds)
if err != nil {
return nil, err
}
tgzData, err := gitproviders2.GitHubClone(repoURL, commitSHA, creds)
if err != nil {
return nil, err
}

ghRepoFiles, err := unpackTgzInMemory(tgzData)
if err != nil {
return nil, errors.Wrap(err, "failed to clone repo from GitHub: make sure that the version (branch or commit) exist on the specified repo")
}
ghRepoFiles, err := unpackTgzInMemory(tgzData)
if err != nil {
return nil, errors.Wrap(err, "failed to read GitHub tarball. Ensure branch/tag/commit exists and access is allowed (rate limits/private repo). Also verify repo URL is correct and not ending with .git.")
}

ghRepoFiles, exists := gitproviders2.SanitizeGHFiles(ghRepoFiles, path)
if !exists {
return nil, errors.Errorf("provided path %v for repo %v does not exist on version %v", path, repoURL, commitSHA)
}
ghRepoFiles, exists := gitproviders2.SanitizeGHFiles(ghRepoFiles, path)
if !exists {
return nil, errors.Errorf("invalid path '%v' for repo %v at %v. Path must be the chart folder (contains Chart.yaml). Do not set it to a file or to templates/.", path, repoURL, commitSHA)
}

template, err := r.mapHelmChart(path, ghRepoFiles)
if err != nil {
Expand All @@ -571,10 +571,10 @@ func (r Repo) mapGitHubRepoInitialValues(repoURL, path, commitSHA string, creds
return nil, err
}

ghRepoFiles, exists := gitproviders2.SanitizeGHFiles(ghRepoFiles, path)
if !exists {
return nil, errors.Errorf("provided path %v for repo %v does not exist on version %v", path, repoURL, commitSHA)
}
ghRepoFiles, exists := gitproviders2.SanitizeGHFiles(ghRepoFiles, path)
if !exists {
return nil, errors.Errorf("invalid path '%v' for repo %v at %v. Path must be the chart folder (contains Chart.yaml).", path, repoURL, commitSHA)
}

initial, err := r.mapHelmChartInitialValues(ghRepoFiles)
if err != nil {
Expand Down
104 changes: 67 additions & 37 deletions cyclops-ctrl/pkg/template/gitproviders/github.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,46 +23,76 @@ func IsGitHubSource(repoURL string) bool {
}

func GitHubClone(repoURL, commitSHA string, creds *auth.Credentials) ([]byte, error) {
repoURLparsed, err := url.Parse(repoURL)
if err != nil {
return nil, err
}

pathParts := strings.Split(repoURLparsed.Path, "/")
var organization, repository string
if len(pathParts) == 3 {
organization = pathParts[1]
repository = pathParts[2]
} else {
return nil, errors.New("invalid github repo URL; should be https://github.com/<org>/<repo>")
}

return gitHubTarball(organization, repository, commitSHA, creds)
repoURLparsed, err := url.Parse(repoURL)
if err != nil {
return nil, err
}

pathParts := strings.Split(repoURLparsed.Path, "/")
var organization, repository string
if len(pathParts) == 3 {
organization = pathParts[1]
// Normalize repository name: strip trailing .git if present
repoName := pathParts[2]
if strings.HasSuffix(repoName, ".git") {
repoName = strings.TrimSuffix(repoName, ".git")
}
repository = repoName
} else {
return nil, errors.New("invalid github repo URL; should be https://github.com/<org>/<repo>")
}

return gitHubTarball(organization, repository, commitSHA, creds)
}

func gitHubTarball(org, repo, commitSHA string, creds *auth.Credentials) ([]byte, error) {
req, err := http.NewRequest(
http.MethodGet,
fmt.Sprintf("https://api.github.com/repos/%v/%v/tarball/%v", org, repo, commitSHA),
nil,
)
if err != nil {
return nil, err
}

token := authToken(creds)
if len(token) != 0 {
req.Header.Set("Authorization", fmt.Sprintf("Bearer %v", token))
}

client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
return nil, err
}
defer resp.Body.Close()

return ioutil.ReadAll(resp.Body)
req, err := http.NewRequest(
http.MethodGet,
fmt.Sprintf("https://api.github.com/repos/%v/%v/tarball/%v", org, repo, commitSHA),
nil,
)
if err != nil {
return nil, err
}

token := authToken(creds)
if len(token) != 0 {
req.Header.Set("Authorization", fmt.Sprintf("Bearer %v", token))
}
// GitHub API requires a User-Agent; set a JSON Accept per REST v3
req.Header.Set("User-Agent", "cyclops-ctrl")
req.Header.Set("Accept", "application/vnd.github+json")

client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
return nil, err
}
defer resp.Body.Close()

// Provide clearer errors on non-200 responses (rate limits, bad refs, private repos)
if resp.StatusCode != http.StatusOK {
body, _ := ioutil.ReadAll(resp.Body)
// Limit body in error to avoid huge payloads
max := 512
if len(body) > max {
body = body[:max]
}
hint := "ensure the branch/tag/commit exists; for private repos add a token; avoid trailing .git in the URL"
if resp.StatusCode == http.StatusUnsupportedMediaType {
hint = "do not set a custom Accept header; use default media for tarball (controller handles it)"
} else if resp.StatusCode == http.StatusForbidden {
hint = "rate limited or access denied; add a GitHub token via TemplateAuthRule"
} else if resp.StatusCode == http.StatusNotFound {
hint = "repo or ref not found; check org/repo name and commit/branch/tag"
}
return nil, errors.Errorf(
"GitHub tarball fetch failed: status %d. Repo: %s/%s, Ref: %s. Hint: %s. Response: %s",
resp.StatusCode, org, repo, commitSHA, hint, string(body),
)
}

return ioutil.ReadAll(resp.Body)
}

func authToken(creds *auth.Credentials) string {
Expand Down