Skip to content

fix: extract folder correctly from repo URLs with trailing slash #381

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

Merged
merged 4 commits into from
Oct 4, 2024
Merged

fix: extract folder correctly from repo URLs with trailing slash #381

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0525768
fix: extract folder correctly from repo URLs with trailing slash
mafredri Oct 4, 2024
2504314
add review suggestion
mafredri Oct 4, 2024
381bf73
fix when base is .
mafredri Oct 4, 2024
09f57b7
handle one more edge case of path.Base
mafredri Oct 4, 2024
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
8 changes: 5 additions & 3 deletions integration/integration_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -844,15 +844,17 @@ func TestContainerEnv(t *testing.T) {
require.NoError(t, err)

output := execContainer(t, ctr, "cat /env")
require.Contains(t, strings.TrimSpace(output),
`DEVCONTAINER=true
want := `DEVCONTAINER=true
DEVCONTAINER_CONFIG=/workspaces/empty/.devcontainer/devcontainer.json
ENVBUILDER=true
FROM_CONTAINER_ENV=bar
FROM_DOCKERFILE=foo
FROM_REMOTE_ENV=baz
PATH=/usr/local/bin:/bin:/go/bin:/opt
REMOTE_BAR=bar`)
REMOTE_BAR=bar`
if diff := cmp.Diff(want, strings.TrimSpace(output)); diff != "" {
require.Failf(t, "env mismatch", "diff (-want +got):\n%s", diff)
}
}

func TestUnsetOptionsEnv(t *testing.T) {
Expand Down
11 changes: 7 additions & 4 deletions options/defaults.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package options

import (
"fmt"
"path"
"strings"

"github.com/go-git/go-billy/v5/osfs"
Expand All @@ -25,12 +26,14 @@ func DefaultWorkspaceFolder(repoURL string) string {
if err != nil {
return EmptyWorkspaceDir
}
name := strings.Split(parsed.Path, "/")
hasOwnerAndRepo := len(name) >= 2
if !hasOwnerAndRepo {
repo := path.Base(parsed.Path)
// Giturls parsing never actually fails since ParseLocal never
// errors and places the entire URL in the Path field. This check
// ensures it's at least a Unix path containing forwardslash.
if repo == repoURL || repo == "/" || repo == "." || repo == "" {
return EmptyWorkspaceDir
}
repo := strings.TrimSuffix(name[len(name)-1], ".git")
repo = strings.TrimSuffix(repo, ".git")
return fmt.Sprintf("/workspaces/%s", repo)
}

Expand Down
57 changes: 57 additions & 0 deletions options/defaults_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,56 @@ func TestDefaultWorkspaceFolder(t *testing.T) {
gitURL: "https://username:[email protected]/coder/envbuilder.git",
expected: "/workspaces/envbuilder",
},
{
name: "trailing",
gitURL: "https://github.com/coder/envbuilder.git/",
expected: "/workspaces/envbuilder",
},
{
name: "trailing-x2",
gitURL: "https://github.com/coder/envbuilder.git//",
expected: "/workspaces/envbuilder",
},
{
name: "no .git",
gitURL: "https://github.com/coder/envbuilder",
expected: "/workspaces/envbuilder",
},
{
name: "trailing no .git",
gitURL: "https://github.com/coder/envbuilder/",
expected: "/workspaces/envbuilder",
},
{
name: "fragment",
gitURL: "https://github.com/coder/envbuilder.git#feature-branch",
expected: "/workspaces/envbuilder",
},
{
name: "fragment-trailing",
gitURL: "https://github.com/coder/envbuilder.git/#refs/heads/feature-branch",
expected: "/workspaces/envbuilder",
},
{
name: "fragment-trailing no .git",
gitURL: "https://github.com/coder/envbuilder/#refs/heads/feature-branch",
expected: "/workspaces/envbuilder",
},
{
name: "space",
gitURL: "https://github.com/coder/env%20builder.git",
expected: "/workspaces/env builder",
},
{
name: "Unix path",
gitURL: "/repo",
expected: "/workspaces/repo",
},
{
name: "Unix subpath",
gitURL: "/path/to/repo",
expected: "/workspaces/repo",
},
{
name: "empty",
gitURL: "",
Expand All @@ -65,6 +110,18 @@ func TestDefaultWorkspaceFolder(t *testing.T) {
name: "website URL",
invalidURL: "www.google.com",
},
{
name: "Unix root",
invalidURL: "/",
},
{
name: "Path consists entirely of slash",
invalidURL: "//",
},
{
name: "Git URL with no path",
invalidURL: "http://127.0.0.1:41073",
},
}
for _, tt := range invalidTests {
t.Run(tt.name, func(t *testing.T) {
Expand Down