mirror of
https://github.com/coder/coder.git
synced 2025-07-12 00:14:10 +00:00
feat(cli): support opening devcontainers in vscode (#17189)
Closes https://github.com/coder/coder/issues/16427 Adds the option `-c,--container` to `open vscode` that allows opening VSCode into a running devcontainer.
This commit is contained in:
Danielle Maywood
GitHub
342
cli/open_test.go
342
cli/open_test.go
@ -8,12 +8,17 @@ import (
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/google/uuid"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
"go.uber.org/mock/gomock"
|
||||
|
||||
"github.com/coder/coder/v2/agent"
|
||||
"github.com/coder/coder/v2/agent/agentcontainers/acmock"
|
||||
"github.com/coder/coder/v2/agent/agenttest"
|
||||
"github.com/coder/coder/v2/cli/clitest"
|
||||
"github.com/coder/coder/v2/coderd/coderdtest"
|
||||
"github.com/coder/coder/v2/coderd/database/dbtime"
|
||||
"github.com/coder/coder/v2/codersdk"
|
||||
"github.com/coder/coder/v2/provisionersdk/proto"
|
||||
"github.com/coder/coder/v2/pty/ptytest"
|
||||
@ -285,6 +290,343 @@ func TestOpenVSCode_NoAgentDirectory(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestOpenVSCodeDevContainer(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
if runtime.GOOS != "linux" {
|
||||
t.Skip("DevContainers are only supported for agents on Linux")
|
||||
}
|
||||
|
||||
agentName := "agent1"
|
||||
agentDir, err := filepath.Abs(filepath.FromSlash("/tmp"))
|
||||
require.NoError(t, err)
|
||||
|
||||
containerName := testutil.GetRandomName(t)
|
||||
containerFolder := "/workspace/coder"
|
||||
|
||||
ctrl := gomock.NewController(t)
|
||||
mcl := acmock.NewMockLister(ctrl)
|
||||
mcl.EXPECT().List(gomock.Any()).Return(
|
||||
codersdk.WorkspaceAgentListContainersResponse{
|
||||
Containers: []codersdk.WorkspaceAgentContainer{
|
||||
{
|
||||
ID: uuid.NewString(),
|
||||
CreatedAt: dbtime.Now(),
|
||||
FriendlyName: containerName,
|
||||
Image: "busybox:latest",
|
||||
Labels: map[string]string{
|
||||
"devcontainer.local_folder": "/home/coder/coder",
|
||||
},
|
||||
Running: true,
|
||||
Status: "running",
|
||||
Volumes: map[string]string{
|
||||
"/home/coder/coder": containerFolder,
|
||||
},
|
||||
},
|
||||
},
|
||||
}, nil,
|
||||
)
|
||||
|
||||
client, workspace, agentToken := setupWorkspaceForAgent(t, func(agents []*proto.Agent) []*proto.Agent {
|
||||
agents[0].Directory = agentDir
|
||||
agents[0].Name = agentName
|
||||
agents[0].OperatingSystem = runtime.GOOS
|
||||
return agents
|
||||
})
|
||||
|
||||
_ = agenttest.New(t, client.URL, agentToken, func(o *agent.Options) {
|
||||
o.ContainerLister = mcl
|
||||
})
|
||||
_ = coderdtest.NewWorkspaceAgentWaiter(t, client, workspace.ID).Wait()
|
||||
|
||||
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
|
||||
env map[string]string
|
||||
args []string
|
||||
wantDir string
|
||||
wantError bool
|
||||
wantToken bool
|
||||
}{
|
||||
{
|
||||
name: "nonexistent container",
|
||||
args: []string{"--test.open-error", workspace.Name, "--container", containerName + "bad"},
|
||||
wantError: true,
|
||||
},
|
||||
{
|
||||
name: "ok",
|
||||
args: []string{"--test.open-error", workspace.Name, "--container", containerName},
|
||||
wantDir: containerFolder,
|
||||
wantError: false,
|
||||
},
|
||||
{
|
||||
name: "ok with absolute path",
|
||||
args: []string{"--test.open-error", workspace.Name, "--container", containerName, containerFolder},
|
||||
wantDir: containerFolder,
|
||||
wantError: false,
|
||||
},
|
||||
{
|
||||
name: "ok with relative path",
|
||||
args: []string{"--test.open-error", workspace.Name, "--container", containerName, "my/relative/path"},
|
||||
wantDir: filepath.Join(agentDir, filepath.FromSlash("my/relative/path")),
|
||||
wantError: false,
|
||||
},
|
||||
{
|
||||
name: "ok with token",
|
||||
args: []string{"--test.open-error", workspace.Name, "--container", containerName, "--generate-token"},
|
||||
wantDir: containerFolder,
|
||||
wantError: false,
|
||||
wantToken: true,
|
||||
},
|
||||
// Inside workspace, does not require --test.open-error
|
||||
{
|
||||
name: "ok inside workspace",
|
||||
env: insideWorkspaceEnv,
|
||||
args: []string{workspace.Name, "--container", containerName},
|
||||
wantDir: containerFolder,
|
||||
},
|
||||
{
|
||||
name: "ok inside workspace relative path",
|
||||
env: insideWorkspaceEnv,
|
||||
args: []string{workspace.Name, "--container", containerName, "foo"},
|
||||
wantDir: filepath.Join(wd, "foo"),
|
||||
},
|
||||
{
|
||||
name: "ok inside workspace token",
|
||||
env: insideWorkspaceEnv,
|
||||
args: []string{workspace.Name, "--container", containerName, "--generate-token"},
|
||||
wantDir: containerFolder,
|
||||
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"))
|
||||
assert.Equal(t, containerName, qp.Get("devContainerName"))
|
||||
|
||||
if tt.wantDir != "" {
|
||||
assert.Equal(t, tt.wantDir, qp.Get("devContainerFolder"))
|
||||
} else {
|
||||
assert.Equal(t, containerFolder, qp.Get("devContainerFolder"))
|
||||
}
|
||||
|
||||
if tt.wantToken {
|
||||
assert.NotEmpty(t, qp.Get("token"))
|
||||
} else {
|
||||
assert.Empty(t, qp.Get("token"))
|
||||
}
|
||||
|
||||
w.RequireSuccess()
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestOpenVSCodeDevContainer_NoAgentDirectory(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
if runtime.GOOS != "linux" {
|
||||
t.Skip("DevContainers are only supported for agents on Linux")
|
||||
}
|
||||
|
||||
agentName := "agent1"
|
||||
|
||||
containerName := testutil.GetRandomName(t)
|
||||
containerFolder := "/workspace/coder"
|
||||
|
||||
ctrl := gomock.NewController(t)
|
||||
mcl := acmock.NewMockLister(ctrl)
|
||||
mcl.EXPECT().List(gomock.Any()).Return(
|
||||
codersdk.WorkspaceAgentListContainersResponse{
|
||||
Containers: []codersdk.WorkspaceAgentContainer{
|
||||
{
|
||||
ID: uuid.NewString(),
|
||||
CreatedAt: dbtime.Now(),
|
||||
FriendlyName: containerName,
|
||||
Image: "busybox:latest",
|
||||
Labels: map[string]string{
|
||||
"devcontainer.local_folder": "/home/coder/coder",
|
||||
},
|
||||
Running: true,
|
||||
Status: "running",
|
||||
Volumes: map[string]string{
|
||||
"/home/coder/coder": containerFolder,
|
||||
},
|
||||
},
|
||||
},
|
||||
}, nil,
|
||||
)
|
||||
|
||||
client, workspace, agentToken := setupWorkspaceForAgent(t, func(agents []*proto.Agent) []*proto.Agent {
|
||||
agents[0].Name = agentName
|
||||
agents[0].OperatingSystem = runtime.GOOS
|
||||
return agents
|
||||
})
|
||||
|
||||
_ = agenttest.New(t, client.URL, agentToken, func(o *agent.Options) {
|
||||
o.ContainerLister = mcl
|
||||
})
|
||||
_ = coderdtest.NewWorkspaceAgentWaiter(t, client, workspace.ID).Wait()
|
||||
|
||||
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
|
||||
env map[string]string
|
||||
args []string
|
||||
wantDir string
|
||||
wantError bool
|
||||
wantToken bool
|
||||
}{
|
||||
{
|
||||
name: "ok",
|
||||
args: []string{"--test.open-error", workspace.Name, "--container", containerName},
|
||||
},
|
||||
{
|
||||
name: "no agent dir error relative path",
|
||||
args: []string{"--test.open-error", workspace.Name, "--container", containerName, "my/relative/path"},
|
||||
wantDir: filepath.FromSlash("my/relative/path"),
|
||||
wantError: true,
|
||||
},
|
||||
{
|
||||
name: "ok with absolute path",
|
||||
args: []string{"--test.open-error", workspace.Name, "--container", containerName, "/home/coder"},
|
||||
wantDir: "/home/coder",
|
||||
},
|
||||
{
|
||||
name: "ok with token",
|
||||
args: []string{"--test.open-error", workspace.Name, "--container", containerName, "--generate-token"},
|
||||
wantToken: true,
|
||||
},
|
||||
// Inside workspace, does not require --test.open-error
|
||||
{
|
||||
name: "ok inside workspace",
|
||||
env: insideWorkspaceEnv,
|
||||
args: []string{workspace.Name, "--container", containerName},
|
||||
},
|
||||
{
|
||||
name: "ok inside workspace relative path",
|
||||
env: insideWorkspaceEnv,
|
||||
args: []string{workspace.Name, "--container", containerName, "foo"},
|
||||
wantDir: filepath.Join(wd, "foo"),
|
||||
},
|
||||
{
|
||||
name: "ok inside workspace token",
|
||||
env: insideWorkspaceEnv,
|
||||
args: []string{workspace.Name, "--container", containerName, "--generate-token"},
|
||||
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"))
|
||||
assert.Equal(t, containerName, qp.Get("devContainerName"))
|
||||
|
||||
if tt.wantDir != "" {
|
||||
assert.Equal(t, tt.wantDir, qp.Get("devContainerFolder"))
|
||||
} else {
|
||||
assert.Equal(t, containerFolder, qp.Get("devContainerFolder"))
|
||||
}
|
||||
|
||||
if tt.wantToken {
|
||||
assert.NotEmpty(t, qp.Get("token"))
|
||||
} else {
|
||||
assert.Empty(t, qp.Get("token"))
|
||||
}
|
||||
|
||||
w.RequireSuccess()
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestOpenApp(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
|
||||
Reference in New Issue
Block a user