8000 feat(cli): add `coder open vscode` by mafredri · Pull Request #11191 · coder/coder · GitHub
[go: up one dir, main page]
Skip to content

feat(cli): add coder open vscode #11191

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 18 commits into from
Jan 2, 2024
Merged

feat(cli): add coder open vscode #11191

Changes from 1 commit
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
c7dba53
feat(cli): add `coder open vscode`
mafredri Dec 13, 2023
31e21fc
in-workspace detction, explicit api token generation (for printed URIs)
mafredri Dec 15, 2023
2fd2464
handle more abs paths
mafredri Dec 15, 2023
b0c3dce
add todo
mafredri Dec 15, 2023
bc71c63
fix
mafredri Dec 15, 2023
d438c49
win
mafredri Dec 15, 2023
3a69da2
table test
mafredri Dec 15, 2023
8e8e08d
rename
mafredri Dec 15, 2023
9ee8d8f
better path handling
mafredri Dec 15, 2023
257c45f
win
mafredri Dec 15, 2023
3fec654
refactor
mafredri Dec 19, 2023
0d647bd
gen
mafredri Dec 19, 2023
1202b65
allow more abs paths on windows, transform unix
mafredri Dec 19, 2023
7c3f48b
move if to switch
mafredri Dec 19, 2023
747ecad
convert / to \ for abs path check using filepath
mafredri Dec 19, 2023
caf84c5
unixToWindowsPath
mafredri Dec 19, 2023
081a006
remove filepath fallbacks on windows, go abs check is stricter
mafredri Dec 19, 2023
d09546c
yolo, you aint got nothing on me, misspell
mafredri Dec 19, 2023
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
Prev Previous commit
Next Next commit
table test
  • Loading branch information
@mafredri
mafredri committed Jan 2, 2024
commit 3a69da26a775c33eee87f6d4bab0312576ae9d52
229 changes: 134 additions & 95 deletions cli/open_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
package cli_test

import (
"context"
"net/url"
"os"
"path/filepath"
"runtime"
"strings"
"testing"

"github.com/stretchr/testify/assert"
Expand All @@ -20,101 +23,137 @@ import (
func TestOpen(t *testing.T) {
t.Parallel()

t.Run("VS Code Local", func(t *testing.T) {
t.Parallel()

client, workspace, agentToken := setupWorkspaceForAgent(t, func(agents []*proto.Agent) []*proto.Agent {
agents[0].Directory = "/tmp"
agents[0].Name = "agent1"
return agents
})

_ = agenttest.New(t, client.URL, agentToken)
_ = coderdtest.AwaitWorkspaceAgents(t, client, workspace.ID)

inv, root := clitest.New(t, "open", "vscode", "--test.no-open", workspace.Name)
clitest.SetupConfig(t, client, root)
pty := ptytest.New(t)
inv.Stdin = pty.Input()
inv.Stdout = pty.Output()

ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
defer cancel()

cmdDone := tGo(t, func() {
err := inv.WithContext(ctx).Run()
assert.NoError(t, err)
})

me, err := client.User(ctx, codersdk.Me)
require.NoError(t, err)

// --test.no-open forces the command to print the URI.
line := pty.ReadLine(ctx)
u, err := url.ParseRequestURI(line)
require.NoError(t, err, "line: %q", line)

qp := u.Query()
assert.Equal(t, client.URL.String(), qp.Get("url"))
assert.Equal(t, me.Username, qp.Get("owner"))
assert.Equal(t, workspace.Name, qp.Get("workspace"))
assert.Equal(t, "agent1", qp.Get("agent"))
assert.Contains(t, "tmp", qp.Get("folder")) // Soft check for windows compat.
assert.Equal(t, "", qp.Get("token"))

<-cmdDone
agentName := "agent1"
agentDir := "/tmp"
client, workspace, agentToken := setupWorkspaceForAgent(t, func(agents []*proto.Agent) []*proto.Agent {
agents[0].Directory = agentDir
agents[0].Name = agentName
return agents
})
t.Run("VS Code Inside Workspace Prints URI", func(t *testing.T) {
t.Parallel()

agentName := "agent1"
client, workspace, agentToken := setupWorkspaceForAgent(t, func(agents []*proto.Agent) []*proto.Agent {
agents[0].Directory = "/tmp"
agents[0].Name = agentName
return agents
})

_ = agenttest.New(t, client.URL, agentToken)
_ = coderdtest.AwaitWorkspaceAgents(t, client, workspace.ID)

t.Log(client.SessionToken())

inv, root := clitest.New(t, "open", "vscode", "--generate-token", workspace.Name)
clitest.SetupConfig(t, client, root)

t.Log(root.Session().Read())

pty := ptytest.New(t)
inv.Stdin = pty.Input()
inv.Stdout = pty.Output()

inv.Environ.Set("CODER", "true")
inv.Environ.Set("CODER_WORKSPACE_NAME", workspace.Name)
inv.Environ.Set("CODER_WORKSPACE_AGENT_NAME", agentName)

ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
defer cancel()

cmdDone := tGo(t, func() {
err := inv.WithContext(ctx).Run()
assert.NoError(t, err)
_ = agenttest.New(t, client.URL, agentToken)
_ = coderdtest.AwaitWorkspaceAgents(t, client, workspace.ID)

insideWorkspaceEnv := map[string]string{
"CODER": "true",
"CODER_WORKSPACE_NAME": workspace.Name,
"CODER_WORKSPACE_AGENT_NAME": agentName,
}

wd, err := os.Getwd()
require.NoError(t, err)

tests := []struct {
name string
args []string
env map[string]string
wantDir string
wantToken bool
wantError bool
}{
{
name: "no args",
wantError: true,
},
{
name: "nonexistent workspace",
args: []string{"--test.no-open", workspace.Name + "bad"},
wantError: true,
},
{
name: "ok",
args: []string{"--test.no-open", workspace.Name},
wantDir: agentDir,
},
{
name: "relative path error",
args: []string{"--test.no-open", workspace.Name, "my/relative/path"},
wantError: true,
},
{
name: "ok with abs path",
args: []string{"--test.no-open", workspace.Name, agentDir},
wantDir: agentDir,
},
{
name: "ok with token",
args: []string{"--test.no-open", workspace.Name, "--generate-token"},
wantDir: agentDir,
wantToken: true,
},
// Inside workspace, does not require --test.no-open.
{
name: "ok inside workspace",
env: insideWorkspaceEnv,
args: []string{workspace.Name},
wantDir: agentDir,
},
{
name: "ok inside workspace relative path",
env: insideWorkspaceEnv,
args: []string{workspace.Name, "foo"},
wantDir: filepath.Join(wd, "foo"),
},
{
name: "ok inside workspace token",
env: insideWorkspaceEnv,
args: []string{workspace.Name, "--generate-token"},
wantDir: agentDir,
wantToken: true,
},
}

for _, tt := range tests {
tt := tt
t.Run(tt.name, func(t *testing.T) {
t.Parallel()

inv, root := clitest.New(t, append([]string{"open", "vscode"}, tt.args...)...)
clitest.SetupConfig(t, client, root)
pty := ptytest.New(t)
inv.Stdin = pty.Input()
inv.Stdout = pty.Output()

ctx := testutil.Context(t, testutil.WaitLong)
inv = inv.WithContext(ctx)
for k, v := range tt.env {
inv.Environ.Set(k, v)
}

w := clitest.StartWithWaiter(t, inv)

if tt.wantError {
w.RequireError()
return
}

me, err := client.User(ctx, codersdk.Me)
require.NoError(t, err)

line := pty.ReadLine(ctx)
u, err := url.ParseRequestURI(line)
require.NoError(t, err, "line: %q", line)

qp := u.Query()
assert.Equal(t, client.URL.String(), qp.Get("url"))
assert.Equal(t, me.Username, qp.Get("owner"))
assert.Equal(t, workspace.Name, qp.Get("workspace"))
assert.Equal(t, agentName, qp.Get("agent"))
if tt.wantDir != "" {
if runtime.GOOS == "windows" {
tt.wantDir = strings.TrimPrefix(tt.wantDir, "/")
}
assert.Contains(t, qp.Get("folder"), tt.wantDir)
} else {
assert.Empty(t, qp.Get("folder"))
}
if tt.wantToken {
assert.NotEmpty(t, qp.Get("token"))
} else {
assert.Empty(t, qp.Get("token"))
}

w.RequireSuccess()
})

me, err := client.User(ctx, codersdk.Me)
require.NoError(t, err)

line := pty.ReadLine(ctx)
u, err := url.ParseRequestURI(line)
require.NoError(t, err, "line: %q", line)

qp := u.Query()
assert.Equal(t, client.URL.String(), qp.Get("url"))
assert.Equal(t, me.Username, qp.Get("owner"))
assert.Equal(t, workspace.Name, qp.Get("workspace"))
assert.Equal(t, "agent1", qp.Get("agent"))
assert.Equal(t, "/tmp", qp.Get("folder"))
assert.NotEmpty(t, qp.Get("token"))

<-cmdDone
})
}
}
0