Enable to make git URLs #594
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| // Copyright 2020 The PipeCD Authors. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package git | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "net/url" | ||
| "regexp" | ||
| "strings" | ||
| ) | ||
|
|
||
| // MakeCommitURL builds a link to the HTML page of the commit, using the given repoURL and hash. | ||
| func MakeCommitURL(repoURL, hash string) (string, error) { | ||
| u, err := parseGitURL(repoURL) | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
|
|
||
| scheme := "https" | ||
| if u.Scheme != "ssh" { | ||
| scheme = u.Scheme | ||
| } | ||
|
|
||
| repoPath := strings.Trim(u.Path, "/") | ||
| repoPath = strings.TrimSuffix(repoPath, ".git") | ||
|
|
||
| subPath := "" | ||
| switch u.Host { | ||
| case "github.com", "gitlab.com": | ||
| subPath = "commit" | ||
| case "bitbucket.org": | ||
| subPath = "commits" | ||
| default: | ||
| // TODO: Allow users to specify git host | ||
| // Currently, the same subPath as Github is applied for all of unsupported hosts, | ||
| // to support GHE where its host could be customized | ||
| subPath = "commit" | ||
| } | ||
|
|
||
| return fmt.Sprintf("%s://%s/%s/%s/%s", scheme, u.Host, repoPath, subPath, hash), nil | ||
| } | ||
|
|
||
| // MakeDirURL builds a link to the HTML page of the directory. | ||
| func MakeDirURL(repoURL, dir, branch string) (string, error) { | ||
| if branch == "" { | ||
| return "", fmt.Errorf("no branch given") | ||
| } | ||
| u, err := parseGitURL(repoURL) | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
|
|
||
| scheme := "https" | ||
| if u.Scheme != "ssh" { | ||
| scheme = u.Scheme | ||
| } | ||
|
|
||
| repoPath := strings.Trim(u.Path, "/") | ||
| repoPath = strings.TrimSuffix(repoPath, ".git") | ||
|
|
||
| subPath := "" | ||
| switch u.Host { | ||
| // TODO: Support more git host | ||
| case "github.com": | ||
| subPath = "tree" | ||
| default: | ||
| // TODO: Allow users to specify git host | ||
| subPath = "tree" | ||
| } | ||
|
|
||
| dir = strings.Trim(dir, "/") | ||
|
|
||
| return fmt.Sprintf("%s://%s/%s/%s/%s/%s", scheme, u.Host, repoPath, subPath, branch, dir), nil | ||
| } | ||
|
|
||
| var ( | ||
| knownSchemes = map[string]interface{}{ | ||
| "ssh": struct{}{}, | ||
| "git": struct{}{}, | ||
| "git+ssh": struct{}{}, | ||
| "http": struct{}{}, | ||
| "https": struct{}{}, | ||
| "rsync": struct{}{}, | ||
| "file": struct{}{}, | ||
|
Member
There was a problem hiding this comment. https://git-scm.com/docs/git-clone#_git_urls
Because
Member
Author
There was a problem hiding this comment. Oh, I was not sure that. Thanks. |
||
| } | ||
| scpRegex = regexp.MustCompile(`^([a-zA-Z0-9_]+@)?([a-zA-Z0-9._-]+):(.*)$`) | ||
| ) | ||
|
|
||
| // parseGitURL parses git url into a URL structure. | ||
| func parseGitURL(rawURL string) (u *url.URL, err error) { | ||
| u, err = parseTransport(rawURL) | ||
| if err == nil { | ||
| return | ||
| } | ||
| return parseScp(rawURL) | ||
| } | ||
|
|
||
| // Return a structured URL only when scheme is a known Git transport. | ||
| func parseTransport(rawURL string) (*url.URL, error) { | ||
| u, err := url.Parse(rawURL) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to parse git url: %w", err) | ||
| } | ||
| if _, ok := knownSchemes[u.Scheme]; !ok { | ||
| return nil, fmt.Errorf("unknown scheme %q", u.Scheme) | ||
| } | ||
| return u, nil | ||
| } | ||
|
|
||
| // Return a structured URL only when the rawURL is an SCP-like URL. | ||
| func parseScp(rawURL string) (*url.URL, error) { | ||
| match := scpRegex.FindAllStringSubmatch(rawURL, -1) | ||
| if len(match) == 0 { | ||
| return nil, fmt.Errorf("no scp URL found in %q", rawURL) | ||
| } | ||
| m := match[0] | ||
| user := strings.TrimRight(m[1], "@") | ||
| var userinfo *url.Userinfo | ||
| if user != "" { | ||
| userinfo = url.User(user) | ||
| } | ||
| return &url.URL{ | ||
| Scheme: "ssh", | ||
| User: userinfo, | ||
| Host: m[2], | ||
| Path: m[3], | ||
| }, nil | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Better than panic, let's add a check for the existence of
Repofield and return an error if it was nil.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Instead of returning an error, I decided to ignore if it's nil