Skip to content

Commit

Permalink
Fixed unit test and url parsing in lib install via git
Browse files Browse the repository at this point in the history 
Previously go-git accepted urls in the format:

  https://github.com/author/repo#ref

but now it refuses to fetch if the "#ref" suffix is present.
The new parsing utility returns the URL cleaned up of the reference.
  • Loading branch information
@cmaglie
cmaglie committed Dec 20, 2024
1 parent 409d77f commit 763145c
Show file tree
Hide file tree
Showing 2 changed files with 111 additions and 73 deletions.
59 changes: 39 additions & 20 deletions internal/arduino/libraries/librariesmanager/install.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -201,8 +201,8 @@ func (lmi *Installer) InstallZipLib(ctx context.Context, archivePath *paths.Path
}

// InstallGitLib installs a library hosted on a git repository on the specified path.
func (lmi *Installer) InstallGitLib(gitURL string, overwrite bool) error {
gitLibraryName, ref, err := parseGitURL(gitURL)
func (lmi *Installer) InstallGitLib(argURL string, overwrite bool) error {
libraryName, gitURL, ref, err := parseGitArgURL(argURL)
if err != nil {
return err
}
Expand All @@ -213,7 +213,7 @@ func (lmi *Installer) InstallGitLib(gitURL string, overwrite bool) error {
return err
}
defer tmp.RemoveAll()
tmpInstallPath := tmp.Join(gitLibraryName)
tmpInstallPath := tmp.Join(libraryName)

depth := 1
if ref != "" {
Expand Down Expand Up @@ -249,25 +249,44 @@ func (lmi *Installer) InstallGitLib(gitURL string, overwrite bool) error {
return nil
}

// parseGitURL tries to recover a library name from a git URL.
// parseGitArgURL tries to recover a library name from a git URL.
// Returns an error in case the URL is not a valid git URL.
func parseGitURL(gitURL string) (string, plumbing.Revision, error) {
var res string
var rev plumbing.Revision
if strings.HasPrefix(gitURL, "git@") {
func parseGitArgURL(argURL string) (string, string, plumbing.Revision, error) {
// On Windows handle paths with backslashes in the form C:\Path\to\library
if path := paths.New(argURL); path != nil && path.Exist() {
return path.Base(), argURL, "", nil
}

// Handle github-specific address in the form "git@github.com:arduino-libraries/SigFox.git"
if strings.HasPrefix(argURL, "git@github.com:") {
// We can't parse these as URLs
i := strings.LastIndex(gitURL, "/")
res = strings.TrimSuffix(gitURL[i+1:], ".git")
} else if path := paths.New(gitURL); path != nil && path.Exist() {
res = path.Base()
} else if parsed, err := url.Parse(gitURL); parsed.String() != "" && err == nil {
i := strings.LastIndex(parsed.Path, "/")
res = strings.TrimSuffix(parsed.Path[i+1:], ".git")
rev = plumbing.Revision(parsed.Fragment)
} else {
return "", "", errors.New(i18n.Tr("invalid git url"))
}
return res, rev, nil
argURL = "https://github.com/" + strings.TrimPrefix(argURL, "git@github.com:")
}

parsedURL, err := url.Parse(argURL)
if err != nil {
return "", "", "", fmt.Errorf("%s: %w", i18n.Tr("invalid git url"), err)
}
if parsedURL.String() == "" {
return "", "", "", errors.New(i18n.Tr("invalid git url"))
}

// Extract lib name from "https://github.com/arduino-libraries/SigFox.git#1.0.3"
// path == "/arduino-libraries/SigFox.git"
slash := strings.LastIndex(parsedURL.Path, "/")
if slash == -1 {
return "", "", "", errors.New(i18n.Tr("invalid git url"))
}
libName := strings.TrimSuffix(parsedURL.Path[slash+1:], ".git")
if libName == "" {
return "", "", "", errors.New(i18n.Tr("invalid git url"))
}
// fragment == "1.0.3"
rev := plumbing.Revision(parsedURL.Fragment)
// gitURL == "https://github.com/arduino-libraries/SigFox.git"
parsedURL.Fragment = ""
gitURL := parsedURL.String()
return libName, gitURL, rev, nil
}

// validateLibrary verifies the dir contains a valid library, meaning it has either
Expand Down
125 changes: 72 additions & 53 deletions internal/arduino/libraries/librariesmanager/install_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,59 +23,78 @@ import (
)

func TestParseGitURL(t *testing.T) {
gitURL := ""
libraryName, ref, err := parseGitURL(gitURL)
require.Equal(t, "", libraryName)
require.EqualValues(t, "", ref)
require.Errorf(t, err, "invalid git url")

gitURL = "https://github.com/arduino/arduino-lib.git"
libraryName, ref, err = parseGitURL(gitURL)
require.Equal(t, "arduino-lib", libraryName)
require.EqualValues(t, "", ref)
require.NoError(t, err)

gitURL = "https://github.com/arduino/arduino-lib.git#0.1.2"
libraryName, ref, err = parseGitURL(gitURL)
require.Equal(t, "arduino-lib", libraryName)
require.EqualValues(t, "0.1.2", ref)
require.NoError(t, err)

gitURL = "git@github.com:arduino/arduino-lib.git"
libraryName, ref, err = parseGitURL(gitURL)
require.Equal(t, "arduino-lib", libraryName)
require.EqualValues(t, "", ref)
require.NoError(t, err)

gitURL = "file:///path/to/arduino-lib"
libraryName, ref, err = parseGitURL(gitURL)
require.Equal(t, "arduino-lib", libraryName)
require.EqualValues(t, "", ref)
require.NoError(t, err)

gitURL = "file:///path/to/arduino-lib.git"
libraryName, ref, err = parseGitURL(gitURL)
require.Equal(t, "arduino-lib", libraryName)
require.EqualValues(t, "", ref)
require.NoError(t, err)

gitURL = "/path/to/arduino-lib"
libraryName, ref, err = parseGitURL(gitURL)
require.Equal(t, "arduino-lib", libraryName)
require.EqualValues(t, "", ref)
require.NoError(t, err)

gitURL = "/path/to/arduino-lib.git"
libraryName, ref, err = parseGitURL(gitURL)
require.Equal(t, "arduino-lib", libraryName)
require.EqualValues(t, "", ref)
require.NoError(t, err)

gitURL = "file:///path/to/arduino-lib"
libraryName, ref, err = parseGitURL(gitURL)
require.Equal(t, "arduino-lib", libraryName)
require.EqualValues(t, "", ref)
require.NoError(t, err)
{
_, _, _, err := parseGitArgURL("")
require.EqualError(t, err, "invalid git url")
}
{
libraryName, gitURL, ref, err := parseGitArgURL("https://github.com/arduino/arduino-lib.git")
require.NoError(t, err)
require.Equal(t, "arduino-lib", libraryName)
require.Equal(t, "https://github.com/arduino/arduino-lib.git", gitURL)
require.EqualValues(t, "", ref)
}
{
libraryName, gitURL, ref, err := parseGitArgURL("https://github.com/arduino/arduino-lib.git#0.1.2")
require.NoError(t, err)
require.Equal(t, "arduino-lib", libraryName)
require.Equal(t, "https://github.com/arduino/arduino-lib.git", gitURL)
require.EqualValues(t, "0.1.2", ref)
}
{
libraryName, gitURL, ref, err := parseGitArgURL("git@github.com:arduino/arduino-lib.git")
require.NoError(t, err)
require.Equal(t, "arduino-lib", libraryName)
require.Equal(t, "https://github.com/arduino/arduino-lib.git", gitURL)
require.EqualValues(t, "", ref)
}
{
libraryName, gitURL, ref, err := parseGitArgURL("git@github.com:arduino/arduino-lib.git#0.1.2")
require.NoError(t, err)
require.Equal(t, "arduino-lib", libraryName)
require.Equal(t, "https://github.com/arduino/arduino-lib.git", gitURL)
require.EqualValues(t, "0.1.2", ref)
}
{
libraryName, gitURL, ref, err := parseGitArgURL("file:///path/to/arduino-lib")
require.NoError(t, err)
require.Equal(t, "arduino-lib", libraryName)
require.Equal(t, "file:///path/to/arduino-lib", gitURL)
require.EqualValues(t, "", ref)
}
{
libraryName, gitURL, ref, err := parseGitArgURL("file:///path/to/arduino-lib.git")
require.NoError(t, err)
require.Equal(t, "arduino-lib", libraryName)
require.Equal(t, "file:///path/to/arduino-lib.git", gitURL)
require.EqualValues(t, "", ref)
}
{
libraryName, gitURL, ref, err := parseGitArgURL("/path/to/arduino-lib")
require.NoError(t, err)
require.Equal(t, "arduino-lib", libraryName)
require.Equal(t, "/path/to/arduino-lib", gitURL)
require.EqualValues(t, "", ref)
}
{
libraryName, gitURL, ref, err := parseGitArgURL("/path/to/arduino-lib.git")
require.NoError(t, err)
require.Equal(t, "arduino-lib", libraryName)
require.Equal(t, "/path/to/arduino-lib.git", gitURL)
require.EqualValues(t, "", ref)
}
{
_, _, _, err := parseGitArgURL("https://arduino.cc")
require.EqualError(t, err, "invalid git url")
}
{
_, _, _, err := parseGitArgURL("https://arduino.cc/")
require.EqualError(t, err, "invalid git url")
}
{
_, _, _, err := parseGitArgURL("://not@a@url")
require.EqualError(t, err, "invalid git url: parse \"://not@a@url\": missing protocol scheme")
}
}

func TestValidateLibrary(t *testing.T) {
Expand Down

0 comments on commit 763145c

Please sign in to comment.