feat(agent): support deleting dev containers (#21247)
Add logic to the agent, and an endpoint, to allow requesting and then deleting a Dev Container and its related agent.
This commit is contained in:
Generated
+28
@@ -106,6 +106,34 @@ func (mr *MockContainerCLIMockRecorder) List(ctx any) *gomock.Call {
|
||||
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "List", reflect.TypeOf((*MockContainerCLI)(nil).List), ctx)
|
||||
}
|
||||
|
||||
// Remove mocks base method.
|
||||
func (m *MockContainerCLI) Remove(ctx context.Context, containerName string) error {
|
||||
m.ctrl.T.Helper()
|
||||
ret := m.ctrl.Call(m, "Remove", ctx, containerName)
|
||||
ret0, _ := ret[0].(error)
|
||||
return ret0
|
||||
}
|
||||
|
||||
// Remove indicates an expected call of Remove.
|
||||
func (mr *MockContainerCLIMockRecorder) Remove(ctx, containerName any) *gomock.Call {
|
||||
mr.mock.ctrl.T.Helper()
|
||||
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Remove", reflect.TypeOf((*MockContainerCLI)(nil).Remove), ctx, containerName)
|
||||
}
|
||||
|
||||
// Stop mocks base method.
|
||||
func (m *MockContainerCLI) Stop(ctx context.Context, containerName string) error {
|
||||
m.ctrl.T.Helper()
|
||||
ret := m.ctrl.Call(m, "Stop", ctx, containerName)
|
||||
ret0, _ := ret[0].(error)
|
||||
return ret0
|
||||
}
|
||||
|
||||
// Stop indicates an expected call of Stop.
|
||||
func (mr *MockContainerCLIMockRecorder) Stop(ctx, containerName any) *gomock.Call {
|
||||
mr.mock.ctrl.T.Helper()
|
||||
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Stop", reflect.TypeOf((*MockContainerCLI)(nil).Stop), ctx, containerName)
|
||||
}
|
||||
|
||||
// MockDevcontainerCLI is a mock of DevcontainerCLI interface.
|
||||
type MockDevcontainerCLI struct {
|
||||
ctrl *gomock.Controller
|
||||
|
||||
+165
-16
@@ -32,6 +32,7 @@ import (
|
||||
"github.com/coder/coder/v2/agent/agentexec"
|
||||
"github.com/coder/coder/v2/agent/usershell"
|
||||
"github.com/coder/coder/v2/coderd/httpapi"
|
||||
"github.com/coder/coder/v2/coderd/httpapi/httperror"
|
||||
"github.com/coder/coder/v2/codersdk"
|
||||
"github.com/coder/coder/v2/codersdk/agentsdk"
|
||||
"github.com/coder/coder/v2/provisioner"
|
||||
@@ -743,11 +744,14 @@ func (api *API) Routes() http.Handler {
|
||||
// /-route was dropped. We can drop the /devcontainers prefix here too.
|
||||
r.Route("/devcontainers/{devcontainer}", func(r chi.Router) {
|
||||
r.Post("/recreate", api.handleDevcontainerRecreate)
|
||||
r.Delete("/", api.handleDevcontainerDelete)
|
||||
})
|
||||
|
||||
return r
|
||||
}
|
||||
|
||||
// broadcastUpdatesLocked sends the current state to any listening clients.
|
||||
// This method assumes that api.mu is held.
|
||||
func (api *API) broadcastUpdatesLocked() {
|
||||
// Broadcast state changes to WebSocket listeners.
|
||||
for _, ch := range api.updateChans {
|
||||
@@ -1019,6 +1023,12 @@ func (api *API) processUpdatedContainersLocked(ctx context.Context, updated code
|
||||
case dc.Status == codersdk.WorkspaceAgentDevcontainerStatusStarting:
|
||||
continue // This state is handled by the recreation routine.
|
||||
|
||||
case dc.Status == codersdk.WorkspaceAgentDevcontainerStatusStopping:
|
||||
continue // This state is handled by the stopping routine.
|
||||
|
||||
case dc.Status == codersdk.WorkspaceAgentDevcontainerStatusDeleting:
|
||||
continue // This state is handled by the delete routine.
|
||||
|
||||
case dc.Status == codersdk.WorkspaceAgentDevcontainerStatusError && (dc.Container == nil || dc.Container.CreatedAt.Before(api.recreateErrorTimes[dc.WorkspaceFolder])):
|
||||
continue // The devcontainer needs to be recreated.
|
||||
|
||||
@@ -1224,6 +1234,155 @@ func (api *API) getContainers() (codersdk.WorkspaceAgentListContainersResponse,
|
||||
}, nil
|
||||
}
|
||||
|
||||
// devcontainerByIDLocked attempts to find a devcontainer by its ID.
|
||||
// This method assumes that api.mu is held.
|
||||
func (api *API) devcontainerByIDLocked(devcontainerID string) (codersdk.WorkspaceAgentDevcontainer, error) {
|
||||
for _, knownDC := range api.knownDevcontainers {
|
||||
if knownDC.ID.String() == devcontainerID {
|
||||
return knownDC, nil
|
||||
}
|
||||
}
|
||||
|
||||
return codersdk.WorkspaceAgentDevcontainer{}, httperror.NewResponseError(http.StatusNotFound, codersdk.Response{
|
||||
Message: "Devcontainer not found.",
|
||||
Detail: fmt.Sprintf("Could not find devcontainer with ID: %q", devcontainerID),
|
||||
})
|
||||
}
|
||||
|
||||
func (api *API) handleDevcontainerDelete(w http.ResponseWriter, r *http.Request) {
|
||||
var (
|
||||
ctx = r.Context()
|
||||
devcontainerID = chi.URLParam(r, "devcontainer")
|
||||
)
|
||||
|
||||
if devcontainerID == "" {
|
||||
httpapi.Write(ctx, w, http.StatusBadRequest, codersdk.Response{
|
||||
Message: "Missing devcontainer ID",
|
||||
Detail: "Devcontainer ID is required to delete a devcontainer.",
|
||||
})
|
||||
return
|
||||
}
|
||||
|
||||
api.mu.Lock()
|
||||
|
||||
dc, err := api.devcontainerByIDLocked(devcontainerID)
|
||||
if err != nil {
|
||||
api.mu.Unlock()
|
||||
httperror.WriteResponseError(ctx, w, err)
|
||||
return
|
||||
}
|
||||
|
||||
// NOTE(DanielleMaywood):
|
||||
// We currently do not support canceling the startup of a dev container.
|
||||
if dc.Status.Transitioning() {
|
||||
api.mu.Unlock()
|
||||
|
||||
httpapi.Write(ctx, w, http.StatusConflict, codersdk.Response{
|
||||
Message: "Unable to delete transitioning devcontainer",
|
||||
Detail: fmt.Sprintf("Devcontainer %q is currently %s and cannot be deleted.", dc.Name, dc.Status),
|
||||
})
|
||||
return
|
||||
}
|
||||
|
||||
var (
|
||||
containerID string
|
||||
subAgentID uuid.UUID
|
||||
)
|
||||
if dc.Container != nil {
|
||||
containerID = dc.Container.ID
|
||||
}
|
||||
if proc, hasSubAgent := api.injectedSubAgentProcs[dc.WorkspaceFolder]; hasSubAgent && proc.agent.ID != uuid.Nil {
|
||||
subAgentID = proc.agent.ID
|
||||
proc.stop()
|
||||
}
|
||||
|
||||
dc.Status = codersdk.WorkspaceAgentDevcontainerStatusStopping
|
||||
dc.Error = ""
|
||||
api.knownDevcontainers[dc.WorkspaceFolder] = dc
|
||||
api.broadcastUpdatesLocked()
|
||||
api.mu.Unlock()
|
||||
|
||||
// Stop and remove the container if it exists.
|
||||
if containerID != "" {
|
||||
if err := api.ccli.Stop(ctx, containerID); err != nil {
|
||||
api.logger.Error(ctx, "unable to stop container", slog.Error(err))
|
||||
|
||||
api.mu.Lock()
|
||||
dc.Status = codersdk.WorkspaceAgentDevcontainerStatusError
|
||||
dc.Error = err.Error()
|
||||
api.knownDevcontainers[dc.WorkspaceFolder] = dc
|
||||
api.broadcastUpdatesLocked()
|
||||
api.mu.Unlock()
|
||||
|
||||
httpapi.Write(ctx, w, http.StatusInternalServerError, codersdk.Response{
|
||||
Message: "An error occurred stopping the container",
|
||||
Detail: err.Error(),
|
||||
})
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
api.mu.Lock()
|
||||
dc.Status = codersdk.WorkspaceAgentDevcontainerStatusDeleting
|
||||
dc.Error = ""
|
||||
api.knownDevcontainers[dc.WorkspaceFolder] = dc
|
||||
api.broadcastUpdatesLocked()
|
||||
api.mu.Unlock()
|
||||
|
||||
if containerID != "" {
|
||||
if err := api.ccli.Remove(ctx, containerID); err != nil {
|
||||
api.logger.Error(ctx, "unable to remove container", slog.Error(err))
|
||||
|
||||
api.mu.Lock()
|
||||
dc.Status = codersdk.WorkspaceAgentDevcontainerStatusError
|
||||
dc.Error = err.Error()
|
||||
api.knownDevcontainers[dc.WorkspaceFolder] = dc
|
||||
api.broadcastUpdatesLocked()
|
||||
api.mu.Unlock()
|
||||
|
||||
httpapi.Write(ctx, w, http.StatusInternalServerError, codersdk.Response{
|
||||
Message: "An error occurred removing the container",
|
||||
Detail: err.Error(),
|
||||
})
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
// Delete the subagent if it exists.
|
||||
if subAgentID != uuid.Nil {
|
||||
client := *api.subAgentClient.Load()
|
||||
if err := client.Delete(ctx, subAgentID); err != nil {
|
||||
api.logger.Error(ctx, "unable to delete agent", slog.Error(err))
|
||||
|
||||
api.mu.Lock()
|
||||
dc.Status = codersdk.WorkspaceAgentDevcontainerStatusError
|
||||
dc.Error = err.Error()
|
||||
api.knownDevcontainers[dc.WorkspaceFolder] = dc
|
||||
api.broadcastUpdatesLocked()
|
||||
api.mu.Unlock()
|
||||
|
||||
httpapi.Write(ctx, w, http.StatusInternalServerError, codersdk.Response{
|
||||
Message: "An error occurred deleting the agent",
|
||||
Detail: err.Error(),
|
||||
})
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
api.mu.Lock()
|
||||
delete(api.devcontainerNames, dc.Name)
|
||||
delete(api.knownDevcontainers, dc.WorkspaceFolder)
|
||||
delete(api.devcontainerLogSourceIDs, dc.WorkspaceFolder)
|
||||
delete(api.recreateSuccessTimes, dc.WorkspaceFolder)
|
||||
delete(api.recreateErrorTimes, dc.WorkspaceFolder)
|
||||
delete(api.usingWorkspaceFolderName, dc.WorkspaceFolder)
|
||||
delete(api.injectedSubAgentProcs, dc.WorkspaceFolder)
|
||||
api.broadcastUpdatesLocked()
|
||||
api.mu.Unlock()
|
||||
|
||||
httpapi.Write(ctx, w, http.StatusNoContent, nil)
|
||||
}
|
||||
|
||||
// handleDevcontainerRecreate handles the HTTP request to recreate a
|
||||
// devcontainer by referencing the container.
|
||||
func (api *API) handleDevcontainerRecreate(w http.ResponseWriter, r *http.Request) {
|
||||
@@ -1240,28 +1399,18 @@ func (api *API) handleDevcontainerRecreate(w http.ResponseWriter, r *http.Reques
|
||||
|
||||
api.mu.Lock()
|
||||
|
||||
var dc codersdk.WorkspaceAgentDevcontainer
|
||||
for _, knownDC := range api.knownDevcontainers {
|
||||
if knownDC.ID.String() == devcontainerID {
|
||||
dc = knownDC
|
||||
break
|
||||
}
|
||||
}
|
||||
if dc.ID == uuid.Nil {
|
||||
dc, err := api.devcontainerByIDLocked(devcontainerID)
|
||||
if err != nil {
|
||||
api.mu.Unlock()
|
||||
|
||||
httpapi.Write(ctx, w, http.StatusNotFound, codersdk.Response{
|
||||
Message: "Devcontainer not found.",
|
||||
Detail: fmt.Sprintf("Could not find devcontainer with ID: %q", devcontainerID),
|
||||
})
|
||||
httperror.WriteResponseError(ctx, w, err)
|
||||
return
|
||||
}
|
||||
if dc.Status == codersdk.WorkspaceAgentDevcontainerStatusStarting {
|
||||
if dc.Status.Transitioning() {
|
||||
api.mu.Unlock()
|
||||
|
||||
httpapi.Write(ctx, w, http.StatusConflict, codersdk.Response{
|
||||
Message: "Devcontainer recreation already in progress",
|
||||
Detail: fmt.Sprintf("Recreation for devcontainer %q is already underway.", dc.Name),
|
||||
Message: "Unable to recreate transitioning devcontainer",
|
||||
Detail: fmt.Sprintf("Devcontainer %q is currently %s and cannot be restarted.", dc.Name, dc.Status),
|
||||
})
|
||||
return
|
||||
}
|
||||
|
||||
@@ -34,6 +34,7 @@ import (
|
||||
"github.com/coder/coder/v2/agent/agentcontainers/acmock"
|
||||
"github.com/coder/coder/v2/agent/agentcontainers/watcher"
|
||||
"github.com/coder/coder/v2/agent/usershell"
|
||||
"github.com/coder/coder/v2/coderd/util/slice"
|
||||
"github.com/coder/coder/v2/codersdk"
|
||||
"github.com/coder/coder/v2/pty"
|
||||
"github.com/coder/coder/v2/testutil"
|
||||
@@ -44,12 +45,15 @@ import (
|
||||
// fakeContainerCLI implements the agentcontainers.ContainerCLI interface for
|
||||
// testing.
|
||||
type fakeContainerCLI struct {
|
||||
mu sync.Mutex
|
||||
containers codersdk.WorkspaceAgentListContainersResponse
|
||||
listErr error
|
||||
arch string
|
||||
archErr error
|
||||
copyErr error
|
||||
execErr error
|
||||
stopErr error
|
||||
removeErr error
|
||||
}
|
||||
|
||||
func (f *fakeContainerCLI) List(_ context.Context) (codersdk.WorkspaceAgentListContainersResponse, error) {
|
||||
@@ -68,6 +72,32 @@ func (f *fakeContainerCLI) ExecAs(ctx context.Context, name, user string, args .
|
||||
return nil, f.execErr
|
||||
}
|
||||
|
||||
func (f *fakeContainerCLI) Stop(ctx context.Context, name string) error {
|
||||
f.mu.Lock()
|
||||
defer f.mu.Unlock()
|
||||
|
||||
f.containers.Devcontainers = slice.Filter(f.containers.Devcontainers, func(dc codersdk.WorkspaceAgentDevcontainer) bool {
|
||||
return dc.Container.ID == name
|
||||
})
|
||||
for i, container := range f.containers.Containers {
|
||||
container.Running = false
|
||||
f.containers.Containers[i] = container
|
||||
}
|
||||
|
||||
return f.stopErr
|
||||
}
|
||||
|
||||
func (f *fakeContainerCLI) Remove(ctx context.Context, name string) error {
|
||||
f.mu.Lock()
|
||||
defer f.mu.Unlock()
|
||||
|
||||
f.containers.Containers = slice.Filter(f.containers.Containers, func(container codersdk.WorkspaceAgentContainer) bool {
|
||||
return container.ID == name
|
||||
})
|
||||
|
||||
return f.removeErr
|
||||
}
|
||||
|
||||
// fakeDevcontainerCLI implements the agentcontainers.DevcontainerCLI
|
||||
// interface for testing.
|
||||
type fakeDevcontainerCLI struct {
|
||||
@@ -115,6 +145,62 @@ func (f *fakeDevcontainerCLI) Exec(ctx context.Context, _, _ string, cmd string,
|
||||
return f.execErr
|
||||
}
|
||||
|
||||
// newFakeDevcontainerCLI returns a `fakeDevcontainerCLI` with the common
|
||||
// channel-based controls initialized, plus a cleanup function.
|
||||
func newFakeDevcontainerCLI(t testing.TB, cfg agentcontainers.DevcontainerConfig) (*fakeDevcontainerCLI, func()) {
|
||||
t.Helper()
|
||||
|
||||
cli := &fakeDevcontainerCLI{
|
||||
readConfig: cfg,
|
||||
execErrC: make(chan func(cmd string, args ...string) error, 1),
|
||||
readConfigErrC: make(chan func(envs []string) error, 1),
|
||||
}
|
||||
|
||||
var once sync.Once
|
||||
cleanup := func() {
|
||||
once.Do(func() {
|
||||
close(cli.execErrC)
|
||||
close(cli.readConfigErrC)
|
||||
})
|
||||
}
|
||||
|
||||
return cli, cleanup
|
||||
}
|
||||
|
||||
// requireDevcontainerExec ensures the devcontainer CLI Exec behaves like a
|
||||
// running process: it signals started by closing `started`, then blocks until
|
||||
// `stop` is closed or ctx is canceled.
|
||||
func requireDevcontainerExec(
|
||||
ctx context.Context,
|
||||
t testing.TB,
|
||||
cli *fakeDevcontainerCLI,
|
||||
started chan struct{},
|
||||
stop <-chan struct{},
|
||||
) {
|
||||
t.Helper()
|
||||
|
||||
require.NotNil(t, cli, "developer error: devcontainerCLI is nil")
|
||||
require.NotNil(t, started, "developer error: started channel is nil")
|
||||
require.NotNil(t, stop, "developer error: stop channel is nil")
|
||||
|
||||
if cli.execErrC == nil {
|
||||
cli.execErrC = make(chan func(cmd string, args ...string) error, 1)
|
||||
t.Cleanup(func() {
|
||||
close(cli.execErrC)
|
||||
})
|
||||
}
|
||||
|
||||
testutil.RequireSend(ctx, t, cli.execErrC, func(_ string, _ ...string) error {
|
||||
close(started)
|
||||
select {
|
||||
case <-stop:
|
||||
return nil
|
||||
case <-ctx.Done():
|
||||
return ctx.Err()
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
func (f *fakeDevcontainerCLI) ReadConfig(ctx context.Context, _, configPath string, envs []string, _ ...agentcontainers.DevcontainerCLIReadConfigOptions) (agentcontainers.DevcontainerConfig, error) {
|
||||
if f.configMap != nil {
|
||||
if v, found := f.configMap[configPath]; found {
|
||||
@@ -231,6 +317,58 @@ func (w *fakeWatcher) sendEventWaitNextCalled(ctx context.Context, event fsnotif
|
||||
w.waitNext(ctx)
|
||||
}
|
||||
|
||||
// newFakeSubAgentClient returns a `fakeSubAgentClient` with the common
|
||||
// channel-based controls initialized, plus a cleanup function.
|
||||
func newFakeSubAgentClient(t testing.TB, logger slog.Logger) (*fakeSubAgentClient, func()) {
|
||||
t.Helper()
|
||||
|
||||
sac := &fakeSubAgentClient{
|
||||
logger: logger,
|
||||
agents: make(map[uuid.UUID]agentcontainers.SubAgent),
|
||||
createErrC: make(chan error, 1),
|
||||
deleteErrC: make(chan error, 1),
|
||||
}
|
||||
|
||||
var once sync.Once
|
||||
cleanup := func() {
|
||||
once.Do(func() {
|
||||
close(sac.createErrC)
|
||||
close(sac.deleteErrC)
|
||||
})
|
||||
}
|
||||
|
||||
return sac, cleanup
|
||||
}
|
||||
|
||||
func allowSubAgentCreate(ctx context.Context, t testing.TB, sac *fakeSubAgentClient) {
|
||||
t.Helper()
|
||||
require.NotNil(t, sac, "developer error: subAgentClient is nil")
|
||||
require.NotNil(t, sac.createErrC, "developer error: createErrC is nil")
|
||||
testutil.RequireSend(ctx, t, sac.createErrC, nil)
|
||||
}
|
||||
|
||||
func allowSubAgentDelete(ctx context.Context, t testing.TB, sac *fakeSubAgentClient) {
|
||||
t.Helper()
|
||||
require.NotNil(t, sac, "developer error: subAgentClient is nil")
|
||||
require.NotNil(t, sac.deleteErrC, "developer error: deleteErrC is nil")
|
||||
testutil.RequireSend(ctx, t, sac.deleteErrC, nil)
|
||||
}
|
||||
|
||||
func expectSubAgentInjection(
|
||||
mCCLI *acmock.MockContainerCLI,
|
||||
containerID string,
|
||||
arch string,
|
||||
coderBin string,
|
||||
) {
|
||||
gomock.InOrder(
|
||||
mCCLI.EXPECT().DetectArchitecture(gomock.Any(), containerID).Return(arch, nil),
|
||||
mCCLI.EXPECT().ExecAs(gomock.Any(), containerID, "root", "mkdir", "-p", "/.coder-agent").Return(nil, nil),
|
||||
mCCLI.EXPECT().Copy(gomock.Any(), containerID, coderBin, "/.coder-agent/coder").Return(nil),
|
||||
mCCLI.EXPECT().ExecAs(gomock.Any(), containerID, "root", "chmod", "0755", "/.coder-agent", "/.coder-agent/coder").Return(nil, nil),
|
||||
mCCLI.EXPECT().ExecAs(gomock.Any(), containerID, "root", "/bin/sh", "-c", "chown $(id -u):$(id -g) /.coder-agent/coder").Return(nil, nil),
|
||||
)
|
||||
}
|
||||
|
||||
// fakeSubAgentClient implements SubAgentClient for testing purposes.
|
||||
type fakeSubAgentClient struct {
|
||||
logger slog.Logger
|
||||
@@ -872,7 +1010,7 @@ func TestAPI(t *testing.T) {
|
||||
upErr: xerrors.New("devcontainer CLI error"),
|
||||
},
|
||||
wantStatus: []int{http.StatusAccepted, http.StatusConflict},
|
||||
wantBody: []string{"Devcontainer recreation initiated", "Devcontainer recreation already in progress"},
|
||||
wantBody: []string{"Devcontainer recreation initiated", "is currently starting and cannot be restarted"},
|
||||
},
|
||||
{
|
||||
name: "OK",
|
||||
@@ -895,7 +1033,7 @@ func TestAPI(t *testing.T) {
|
||||
},
|
||||
devcontainerCLI: &fakeDevcontainerCLI{},
|
||||
wantStatus: []int{http.StatusAccepted, http.StatusConflict},
|
||||
wantBody: []string{"Devcontainer recreation initiated", "Devcontainer recreation already in progress"},
|
||||
wantBody: []string{"Devcontainer recreation initiated", "is currently starting and cannot be restarted"},
|
||||
},
|
||||
}
|
||||
|
||||
@@ -1035,6 +1173,357 @@ func TestAPI(t *testing.T) {
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("Delete", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
if runtime.GOOS == "windows" {
|
||||
t.Skip("Dev Container tests are not supported on Windows (this test uses mocks but fails due to Windows paths)")
|
||||
}
|
||||
|
||||
devcontainerID1 := uuid.New()
|
||||
workspaceFolder1 := "/workspace/test1"
|
||||
configPath1 := "/workspace/test1/.devcontainer/devcontainer.json"
|
||||
|
||||
// Create a container that represents an existing devcontainer.
|
||||
devContainer1 := codersdk.WorkspaceAgentContainer{
|
||||
ID: "container-1",
|
||||
FriendlyName: "test-container-1",
|
||||
Running: true,
|
||||
Labels: map[string]string{
|
||||
agentcontainers.DevcontainerLocalFolderLabel: workspaceFolder1,
|
||||
agentcontainers.DevcontainerConfigFileLabel: configPath1,
|
||||
},
|
||||
}
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
devcontainerID string
|
||||
setupDevcontainers []codersdk.WorkspaceAgentDevcontainer
|
||||
lister *fakeContainerCLI
|
||||
devcontainerCLI *fakeDevcontainerCLI
|
||||
wantStatus int
|
||||
wantBody string
|
||||
wantSubAgentDeleted bool
|
||||
}{
|
||||
{
|
||||
name: "Missing devcontainer ID",
|
||||
devcontainerID: "",
|
||||
lister: &fakeContainerCLI{},
|
||||
devcontainerCLI: &fakeDevcontainerCLI{},
|
||||
wantStatus: http.StatusBadRequest,
|
||||
wantBody: "Missing devcontainer ID",
|
||||
},
|
||||
{
|
||||
name: "Devcontainer not found",
|
||||
devcontainerID: uuid.NewString(),
|
||||
lister: &fakeContainerCLI{
|
||||
arch: "<none>",
|
||||
},
|
||||
devcontainerCLI: &fakeDevcontainerCLI{},
|
||||
wantStatus: http.StatusNotFound,
|
||||
wantBody: "Devcontainer not found",
|
||||
},
|
||||
{
|
||||
name: "Devcontainer is starting",
|
||||
devcontainerID: devcontainerID1.String(),
|
||||
setupDevcontainers: []codersdk.WorkspaceAgentDevcontainer{
|
||||
{
|
||||
ID: devcontainerID1,
|
||||
Name: "test-devcontainer-1",
|
||||
WorkspaceFolder: workspaceFolder1,
|
||||
ConfigPath: configPath1,
|
||||
Status: codersdk.WorkspaceAgentDevcontainerStatusStarting,
|
||||
Container: &devContainer1,
|
||||
},
|
||||
},
|
||||
lister: &fakeContainerCLI{
|
||||
containers: codersdk.WorkspaceAgentListContainersResponse{
|
||||
Containers: []codersdk.WorkspaceAgentContainer{devContainer1},
|
||||
},
|
||||
arch: "<none>",
|
||||
},
|
||||
devcontainerCLI: &fakeDevcontainerCLI{},
|
||||
wantStatus: http.StatusConflict,
|
||||
wantBody: "is currently starting and cannot be deleted",
|
||||
},
|
||||
{
|
||||
name: "Devcontainer is stopping",
|
||||
devcontainerID: devcontainerID1.String(),
|
||||
setupDevcontainers: []codersdk.WorkspaceAgentDevcontainer{
|
||||
{
|
||||
ID: devcontainerID1,
|
||||
Name: "test-devcontainer-1",
|
||||
WorkspaceFolder: workspaceFolder1,
|
||||
ConfigPath: configPath1,
|
||||
Status: codersdk.WorkspaceAgentDevcontainerStatusDeleting,
|
||||
Container: &devContainer1,
|
||||
},
|
||||
},
|
||||
lister: &fakeContainerCLI{
|
||||
containers: codersdk.WorkspaceAgentListContainersResponse{
|
||||
Containers: []codersdk.WorkspaceAgentContainer{devContainer1},
|
||||
},
|
||||
arch: "<none>",
|
||||
},
|
||||
devcontainerCLI: &fakeDevcontainerCLI{},
|
||||
wantStatus: http.StatusConflict,
|
||||
wantBody: "is currently deleting and cannot be deleted.",
|
||||
},
|
||||
{
|
||||
name: "Container stop fails",
|
||||
devcontainerID: devcontainerID1.String(),
|
||||
setupDevcontainers: []codersdk.WorkspaceAgentDevcontainer{
|
||||
{
|
||||
ID: devcontainerID1,
|
||||
Name: "test-devcontainer-1",
|
||||
WorkspaceFolder: workspaceFolder1,
|
||||
ConfigPath: configPath1,
|
||||
Status: codersdk.WorkspaceAgentDevcontainerStatusRunning,
|
||||
Container: &devContainer1,
|
||||
},
|
||||
},
|
||||
lister: &fakeContainerCLI{
|
||||
containers: codersdk.WorkspaceAgentListContainersResponse{
|
||||
Containers: []codersdk.WorkspaceAgentContainer{devContainer1},
|
||||
},
|
||||
arch: "<none>",
|
||||
stopErr: xerrors.New("stop error"),
|
||||
},
|
||||
devcontainerCLI: &fakeDevcontainerCLI{},
|
||||
wantStatus: http.StatusInternalServerError,
|
||||
wantBody: "An error occurred stopping the container",
|
||||
},
|
||||
{
|
||||
name: "Container remove fails",
|
||||
devcontainerID: devcontainerID1.String(),
|
||||
setupDevcontainers: []codersdk.WorkspaceAgentDevcontainer{
|
||||
{
|
||||
ID: devcontainerID1,
|
||||
Name: "test-devcontainer-1",
|
||||
WorkspaceFolder: workspaceFolder1,
|
||||
ConfigPath: configPath1,
|
||||
Status: codersdk.WorkspaceAgentDevcontainerStatusRunning,
|
||||
Container: &devContainer1,
|
||||
},
|
||||
},
|
||||
lister: &fakeContainerCLI{
|
||||
containers: codersdk.WorkspaceAgentListContainersResponse{
|
||||
Containers: []codersdk.WorkspaceAgentContainer{devContainer1},
|
||||
},
|
||||
arch: "<none>",
|
||||
removeErr: xerrors.New("remove error"),
|
||||
},
|
||||
devcontainerCLI: &fakeDevcontainerCLI{},
|
||||
wantStatus: http.StatusInternalServerError,
|
||||
wantBody: "An error occurred removing the container",
|
||||
},
|
||||
{
|
||||
name: "OK with container",
|
||||
devcontainerID: devcontainerID1.String(),
|
||||
setupDevcontainers: []codersdk.WorkspaceAgentDevcontainer{
|
||||
{
|
||||
ID: devcontainerID1,
|
||||
Name: "test-devcontainer-1",
|
||||
WorkspaceFolder: workspaceFolder1,
|
||||
ConfigPath: configPath1,
|
||||
Status: codersdk.WorkspaceAgentDevcontainerStatusRunning,
|
||||
Container: &devContainer1,
|
||||
},
|
||||
},
|
||||
lister: &fakeContainerCLI{
|
||||
containers: codersdk.WorkspaceAgentListContainersResponse{
|
||||
Containers: []codersdk.WorkspaceAgentContainer{devContainer1},
|
||||
},
|
||||
arch: "<none>",
|
||||
},
|
||||
devcontainerCLI: &fakeDevcontainerCLI{},
|
||||
wantStatus: http.StatusNoContent,
|
||||
wantBody: "",
|
||||
},
|
||||
{
|
||||
name: "OK without container",
|
||||
devcontainerID: devcontainerID1.String(),
|
||||
setupDevcontainers: []codersdk.WorkspaceAgentDevcontainer{
|
||||
{
|
||||
ID: devcontainerID1,
|
||||
Name: "test-devcontainer-1",
|
||||
WorkspaceFolder: workspaceFolder1,
|
||||
ConfigPath: configPath1,
|
||||
Status: codersdk.WorkspaceAgentDevcontainerStatusStopped,
|
||||
Container: nil,
|
||||
},
|
||||
},
|
||||
lister: &fakeContainerCLI{
|
||||
arch: "<none>",
|
||||
},
|
||||
devcontainerCLI: &fakeDevcontainerCLI{},
|
||||
wantStatus: http.StatusNoContent,
|
||||
wantBody: "",
|
||||
},
|
||||
{
|
||||
name: "OK with container and subagent",
|
||||
devcontainerID: devcontainerID1.String(),
|
||||
setupDevcontainers: []codersdk.WorkspaceAgentDevcontainer{
|
||||
{
|
||||
ID: devcontainerID1,
|
||||
Name: "test-devcontainer-1",
|
||||
WorkspaceFolder: workspaceFolder1,
|
||||
ConfigPath: configPath1,
|
||||
Status: codersdk.WorkspaceAgentDevcontainerStatusStopped,
|
||||
Container: &devContainer1,
|
||||
},
|
||||
},
|
||||
lister: &fakeContainerCLI{
|
||||
containers: codersdk.WorkspaceAgentListContainersResponse{
|
||||
Containers: []codersdk.WorkspaceAgentContainer{devContainer1},
|
||||
},
|
||||
arch: "amd64",
|
||||
},
|
||||
devcontainerCLI: &fakeDevcontainerCLI{
|
||||
readConfig: agentcontainers.DevcontainerConfig{
|
||||
Workspace: agentcontainers.DevcontainerWorkspace{
|
||||
WorkspaceFolder: workspaceFolder1,
|
||||
},
|
||||
},
|
||||
},
|
||||
wantStatus: http.StatusNoContent,
|
||||
wantBody: "",
|
||||
wantSubAgentDeleted: true,
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
var (
|
||||
ctx = testutil.Context(t, testutil.WaitShort)
|
||||
logger = slogtest.Make(t, &slogtest.Options{IgnoreErrors: true}).Leveled(slog.LevelDebug)
|
||||
mClock = quartz.NewMock(t)
|
||||
withSubAgent = tt.wantSubAgentDeleted
|
||||
)
|
||||
|
||||
mClock.Set(time.Now()).MustWait(ctx)
|
||||
tickerTrap := mClock.Trap().TickerFunc("updaterLoop")
|
||||
|
||||
var (
|
||||
fakeSAC *fakeSubAgentClient
|
||||
mCCLI *acmock.MockContainerCLI
|
||||
containerCLI agentcontainers.ContainerCLI
|
||||
)
|
||||
if withSubAgent {
|
||||
var cleanupSAC func()
|
||||
fakeSAC, cleanupSAC = newFakeSubAgentClient(t, logger.Named("fakeSubAgentClient"))
|
||||
defer cleanupSAC()
|
||||
|
||||
mCCLI = acmock.NewMockContainerCLI(gomock.NewController(t))
|
||||
containerCLI = mCCLI
|
||||
|
||||
coderBin, err := os.Executable()
|
||||
require.NoError(t, err)
|
||||
coderBin, err = filepath.EvalSymlinks(coderBin)
|
||||
require.NoError(t, err)
|
||||
|
||||
mCCLI.EXPECT().List(gomock.Any()).Return(codersdk.WorkspaceAgentListContainersResponse{
|
||||
Containers: tt.lister.containers.Containers,
|
||||
}, nil).AnyTimes()
|
||||
expectSubAgentInjection(mCCLI, devContainer1.ID, runtime.GOARCH, coderBin)
|
||||
|
||||
mCCLI.EXPECT().Stop(gomock.Any(), devContainer1.ID).Return(nil).Times(1)
|
||||
mCCLI.EXPECT().Remove(gomock.Any(), devContainer1.ID).Return(nil).Times(1)
|
||||
} else {
|
||||
containerCLI = tt.lister
|
||||
}
|
||||
|
||||
apiOpts := []agentcontainers.Option{
|
||||
agentcontainers.WithClock(mClock),
|
||||
agentcontainers.WithContainerCLI(containerCLI),
|
||||
agentcontainers.WithDevcontainerCLI(tt.devcontainerCLI),
|
||||
agentcontainers.WithWatcher(watcher.NewNoop()),
|
||||
agentcontainers.WithDevcontainers(tt.setupDevcontainers, nil),
|
||||
}
|
||||
if withSubAgent {
|
||||
apiOpts = append(apiOpts,
|
||||
agentcontainers.WithSubAgentClient(fakeSAC),
|
||||
agentcontainers.WithSubAgentURL("test-subagent-url"),
|
||||
)
|
||||
}
|
||||
|
||||
api := agentcontainers.NewAPI(logger, apiOpts...)
|
||||
|
||||
api.Start()
|
||||
defer api.Close()
|
||||
|
||||
r := chi.NewRouter()
|
||||
r.Mount("/", api.Routes())
|
||||
|
||||
var (
|
||||
agentRunningCh chan struct{}
|
||||
stopAgentCh chan struct{}
|
||||
)
|
||||
if withSubAgent {
|
||||
agentRunningCh = make(chan struct{})
|
||||
stopAgentCh = make(chan struct{})
|
||||
defer close(stopAgentCh)
|
||||
|
||||
allowSubAgentCreate(ctx, t, fakeSAC)
|
||||
|
||||
if tt.devcontainerCLI != nil {
|
||||
requireDevcontainerExec(ctx, t, tt.devcontainerCLI, agentRunningCh, stopAgentCh)
|
||||
}
|
||||
}
|
||||
|
||||
tickerTrap.MustWait(ctx).MustRelease(ctx)
|
||||
tickerTrap.Close()
|
||||
|
||||
if tt.wantSubAgentDeleted {
|
||||
err := api.RefreshContainers(ctx)
|
||||
require.NoError(t, err, "refresh containers should not fail")
|
||||
|
||||
select {
|
||||
case <-agentRunningCh:
|
||||
case <-ctx.Done():
|
||||
t.Fatal("timeout waiting for agent to start")
|
||||
}
|
||||
|
||||
require.Len(t, fakeSAC.created, 1, "subagent should be created")
|
||||
require.Empty(t, fakeSAC.deleted, "no subagent should be deleted yet")
|
||||
|
||||
allowSubAgentDelete(ctx, t, fakeSAC)
|
||||
}
|
||||
|
||||
req := httptest.NewRequest(http.MethodDelete, "/devcontainers/"+tt.devcontainerID+"/", nil).
|
||||
WithContext(ctx)
|
||||
rec := httptest.NewRecorder()
|
||||
r.ServeHTTP(rec, req)
|
||||
|
||||
require.Equal(t, tt.wantStatus, rec.Code, "status code mismatch")
|
||||
if tt.wantBody != "" {
|
||||
assert.Contains(t, rec.Body.String(), tt.wantBody, "response body mismatch")
|
||||
}
|
||||
|
||||
// For successful deletes, verify the devcontainer is removed from the list.
|
||||
if tt.wantStatus == http.StatusNoContent {
|
||||
req = httptest.NewRequest(http.MethodGet, "/", nil).
|
||||
WithContext(ctx)
|
||||
rec = httptest.NewRecorder()
|
||||
r.ServeHTTP(rec, req)
|
||||
|
||||
require.Equal(t, http.StatusOK, rec.Code, "status code mismatch on list")
|
||||
var resp codersdk.WorkspaceAgentListContainersResponse
|
||||
err := json.NewDecoder(rec.Body).Decode(&resp)
|
||||
require.NoError(t, err, "unmarshal response failed")
|
||||
assert.Empty(t, resp.Devcontainers, "devcontainer should be removed after delete")
|
||||
|
||||
if tt.wantSubAgentDeleted {
|
||||
require.Len(t, fakeSAC.deleted, 1, "subagent should be deleted")
|
||||
assert.Equal(t, fakeSAC.created[0].ID, fakeSAC.deleted[0], "correct subagent should be deleted")
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("List devcontainers", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
@@ -1720,25 +2209,17 @@ func TestAPI(t *testing.T) {
|
||||
}
|
||||
|
||||
var (
|
||||
ctx = testutil.Context(t, testutil.WaitMedium)
|
||||
errTestTermination = xerrors.New("test termination")
|
||||
logger = slogtest.Make(t, &slogtest.Options{IgnoredErrorIs: []error{errTestTermination}}).Leveled(slog.LevelDebug)
|
||||
mClock = quartz.NewMock(t)
|
||||
mCCLI = acmock.NewMockContainerCLI(gomock.NewController(t))
|
||||
fakeSAC = &fakeSubAgentClient{
|
||||
logger: logger.Named("fakeSubAgentClient"),
|
||||
createErrC: make(chan error, 1),
|
||||
deleteErrC: make(chan error, 1),
|
||||
}
|
||||
fakeDCCLI = &fakeDevcontainerCLI{
|
||||
readConfig: agentcontainers.DevcontainerConfig{
|
||||
Workspace: agentcontainers.DevcontainerWorkspace{
|
||||
WorkspaceFolder: "/workspaces/coder",
|
||||
},
|
||||
ctx = testutil.Context(t, testutil.WaitMedium)
|
||||
errTestTermination = xerrors.New("test termination")
|
||||
logger = slogtest.Make(t, &slogtest.Options{IgnoredErrorIs: []error{errTestTermination}}).Leveled(slog.LevelDebug)
|
||||
mClock = quartz.NewMock(t)
|
||||
mCCLI = acmock.NewMockContainerCLI(gomock.NewController(t))
|
||||
fakeSAC, cleanupSAC = newFakeSubAgentClient(t, logger.Named("fakeSubAgentClient"))
|
||||
fakeDCCLI, cleanupDCCLI = newFakeDevcontainerCLI(t, agentcontainers.DevcontainerConfig{
|
||||
Workspace: agentcontainers.DevcontainerWorkspace{
|
||||
WorkspaceFolder: "/workspaces/coder",
|
||||
},
|
||||
execErrC: make(chan func(cmd string, args ...string) error, 1),
|
||||
readConfigErrC: make(chan func(envs []string) error, 1),
|
||||
}
|
||||
})
|
||||
|
||||
testContainer = codersdk.WorkspaceAgentContainer{
|
||||
ID: "test-container-id",
|
||||
@@ -1761,18 +2242,11 @@ func TestAPI(t *testing.T) {
|
||||
mCCLI.EXPECT().List(gomock.Any()).Return(codersdk.WorkspaceAgentListContainersResponse{
|
||||
Containers: []codersdk.WorkspaceAgentContainer{testContainer},
|
||||
}, nil).Times(3) // 1 initial call + 2 updates.
|
||||
gomock.InOrder(
|
||||
mCCLI.EXPECT().DetectArchitecture(gomock.Any(), "test-container-id").Return(runtime.GOARCH, nil),
|
||||
mCCLI.EXPECT().ExecAs(gomock.Any(), "test-container-id", "root", "mkdir", "-p", "/.coder-agent").Return(nil, nil),
|
||||
mCCLI.EXPECT().Copy(gomock.Any(), "test-container-id", coderBin, "/.coder-agent/coder").Return(nil),
|
||||
mCCLI.EXPECT().ExecAs(gomock.Any(), "test-container-id", "root", "chmod", "0755", "/.coder-agent", "/.coder-agent/coder").Return(nil, nil),
|
||||
mCCLI.EXPECT().ExecAs(gomock.Any(), "test-container-id", "root", "/bin/sh", "-c", "chown $(id -u):$(id -g) /.coder-agent/coder").Return(nil, nil),
|
||||
)
|
||||
expectSubAgentInjection(mCCLI, "test-container-id", runtime.GOARCH, coderBin)
|
||||
|
||||
mClock.Set(time.Now()).MustWait(ctx)
|
||||
tickerTrap := mClock.Trap().TickerFunc("updaterLoop")
|
||||
|
||||
var closeOnce sync.Once
|
||||
api := agentcontainers.NewAPI(logger,
|
||||
agentcontainers.WithClock(mClock),
|
||||
agentcontainers.WithContainerCLI(mCCLI),
|
||||
@@ -1783,21 +2257,15 @@ func TestAPI(t *testing.T) {
|
||||
agentcontainers.WithManifestInfo("test-user", "test-workspace", "test-parent-agent", "/parent-agent"),
|
||||
)
|
||||
api.Start()
|
||||
apiClose := func() {
|
||||
closeOnce.Do(func() {
|
||||
// Close before api.Close() defer to avoid deadlock after test.
|
||||
close(fakeSAC.createErrC)
|
||||
close(fakeSAC.deleteErrC)
|
||||
close(fakeDCCLI.execErrC)
|
||||
close(fakeDCCLI.readConfigErrC)
|
||||
defer func() {
|
||||
cleanupSAC()
|
||||
cleanupDCCLI()
|
||||
|
||||
_ = api.Close()
|
||||
})
|
||||
}
|
||||
defer apiClose()
|
||||
_ = api.Close()
|
||||
}()
|
||||
|
||||
// Allow initial agent creation and injection to succeed.
|
||||
testutil.RequireSend(ctx, t, fakeSAC.createErrC, nil)
|
||||
allowSubAgentCreate(ctx, t, fakeSAC)
|
||||
testutil.RequireSend(ctx, t, fakeDCCLI.readConfigErrC, func(envs []string) error {
|
||||
assert.Contains(t, envs, "CODER_WORKSPACE_AGENT_NAME=coder")
|
||||
assert.Contains(t, envs, "CODER_WORKSPACE_NAME=test-workspace")
|
||||
@@ -1850,13 +2318,7 @@ func TestAPI(t *testing.T) {
|
||||
t.Log("Waiting for agent reinjection...")
|
||||
|
||||
// Expect the agent to be reinjected.
|
||||
gomock.InOrder(
|
||||
mCCLI.EXPECT().DetectArchitecture(gomock.Any(), "test-container-id").Return(runtime.GOARCH, nil),
|
||||
mCCLI.EXPECT().ExecAs(gomock.Any(), "test-container-id", "root", "mkdir", "-p", "/.coder-agent").Return(nil, nil),
|
||||
mCCLI.EXPECT().Copy(gomock.Any(), "test-container-id", coderBin, "/.coder-agent/coder").Return(nil),
|
||||
mCCLI.EXPECT().ExecAs(gomock.Any(), "test-container-id", "root", "chmod", "0755", "/.coder-agent", "/.coder-agent/coder").Return(nil, nil),
|
||||
mCCLI.EXPECT().ExecAs(gomock.Any(), "test-container-id", "root", "/bin/sh", "-c", "chown $(id -u):$(id -g) /.coder-agent/coder").Return(nil, nil),
|
||||
)
|
||||
expectSubAgentInjection(mCCLI, "test-container-id", runtime.GOARCH, coderBin)
|
||||
|
||||
// Verify that the agent has started.
|
||||
agentStarted := make(chan struct{})
|
||||
@@ -1965,7 +2427,12 @@ func TestAPI(t *testing.T) {
|
||||
|
||||
t.Log("Agent deleted and recreated successfully.")
|
||||
|
||||
apiClose()
|
||||
// Allow API shutdown to delete the currently active agent record.
|
||||
allowSubAgentDelete(ctx, t, fakeSAC)
|
||||
|
||||
err = api.Close()
|
||||
require.NoError(t, err)
|
||||
|
||||
require.Len(t, fakeSAC.created, 2, "API close should not create more agents")
|
||||
require.Len(t, fakeSAC.deleted, 2, "API close should delete the agent")
|
||||
assert.Equal(t, fakeSAC.created[1].ID, fakeSAC.deleted[1], "the second created agent should be deleted on API close")
|
||||
@@ -3025,12 +3492,8 @@ func TestAPI(t *testing.T) {
|
||||
},
|
||||
}
|
||||
|
||||
fakeSAC := &fakeSubAgentClient{
|
||||
logger: slogtest.Make(t, nil).Named("fakeSubAgentClient"),
|
||||
agents: make(map[uuid.UUID]agentcontainers.SubAgent),
|
||||
createErrC: make(chan error, 1),
|
||||
deleteErrC: make(chan error, 1),
|
||||
}
|
||||
fakeSAC, cleanupSAC := newFakeSubAgentClient(t, slogtest.Make(t, nil).Named("fakeSubAgentClient"))
|
||||
defer cleanupSAC()
|
||||
|
||||
mClock := quartz.NewMock(t)
|
||||
mClock.Set(startTime)
|
||||
@@ -3047,9 +3510,7 @@ func TestAPI(t *testing.T) {
|
||||
)
|
||||
api.Start()
|
||||
defer func() {
|
||||
close(fakeSAC.createErrC)
|
||||
close(fakeSAC.deleteErrC)
|
||||
api.Close()
|
||||
_ = api.Close()
|
||||
}()
|
||||
|
||||
err := api.RefreshContainers(ctx)
|
||||
@@ -3097,7 +3558,7 @@ func TestAPI(t *testing.T) {
|
||||
return nil
|
||||
}
|
||||
testutil.RequireSend(ctx, t, fDCCLI.execErrC, execSubAgent)
|
||||
testutil.RequireSend(ctx, t, fakeSAC.createErrC, nil)
|
||||
allowSubAgentCreate(ctx, t, fakeSAC)
|
||||
|
||||
fWatcher.sendEventWaitNextCalled(ctx, fsnotify.Event{
|
||||
Name: configPath,
|
||||
@@ -3137,7 +3598,7 @@ func TestAPI(t *testing.T) {
|
||||
|
||||
t.Log("Phase 3: Change back to ignore=true and test sub agent deletion")
|
||||
fDCCLI.readConfig.Configuration.Customizations.Coder.Ignore = true
|
||||
testutil.RequireSend(ctx, t, fakeSAC.deleteErrC, nil)
|
||||
allowSubAgentDelete(ctx, t, fakeSAC)
|
||||
|
||||
fWatcher.sendEventWaitNextCalled(ctx, fsnotify.Event{
|
||||
Name: configPath,
|
||||
|
||||
@@ -17,6 +17,10 @@ type ContainerCLI interface {
|
||||
Copy(ctx context.Context, containerName, src, dst string) error
|
||||
// ExecAs executes a command in a container as a specific user.
|
||||
ExecAs(ctx context.Context, containerName, user string, args ...string) ([]byte, error)
|
||||
// Stop terminates the container
|
||||
Stop(ctx context.Context, containerName string) error
|
||||
// Remove removes the container
|
||||
Remove(ctx context.Context, containerName string) error
|
||||
}
|
||||
|
||||
// noopContainerCLI is a ContainerCLI that does nothing.
|
||||
@@ -35,3 +39,5 @@ func (noopContainerCLI) Copy(_ context.Context, _ string, _ string, _ string) er
|
||||
func (noopContainerCLI) ExecAs(_ context.Context, _ string, _ string, _ ...string) ([]byte, error) {
|
||||
return nil, nil
|
||||
}
|
||||
func (noopContainerCLI) Stop(_ context.Context, _ string) error { return nil }
|
||||
func (noopContainerCLI) Remove(_ context.Context, _ string) error { return nil }
|
||||
|
||||
@@ -583,6 +583,22 @@ func (dcli *dockerCLI) ExecAs(ctx context.Context, containerName, uid string, ar
|
||||
return stdout, nil
|
||||
}
|
||||
|
||||
func (dcli *dockerCLI) Stop(ctx context.Context, containerName string) error {
|
||||
_, stderr, err := runCmd(ctx, dcli.execer, "docker", "stop", containerName)
|
||||
if err != nil {
|
||||
return xerrors.Errorf("stop %s: %w: %s", containerName, err, stderr)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (dcli *dockerCLI) Remove(ctx context.Context, containerName string) error {
|
||||
_, stderr, err := runCmd(ctx, dcli.execer, "docker", "rm", containerName)
|
||||
if err != nil {
|
||||
return xerrors.Errorf("remove %s: %w: %s", containerName, err, stderr)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// runCmd is a helper function that runs a command with the given
|
||||
// arguments and returns the stdout and stderr output.
|
||||
func runCmd(ctx context.Context, execer agentexec.Execer, cmd string, args ...string) (stdout, stderr []byte, err error) {
|
||||
|
||||
@@ -126,3 +126,99 @@ func TestIntegrationDockerCLI(t *testing.T) {
|
||||
t.Logf("Successfully executed commands in container %s", containerName)
|
||||
})
|
||||
}
|
||||
|
||||
// TestIntegrationDockerCLIStop tests the Stop method using a real
|
||||
// Docker container.
|
||||
//
|
||||
// Run manually with: CODER_TEST_USE_DOCKER=1 go test ./agent/agentcontainers -run TestIntegrationDockerCLIStop
|
||||
//
|
||||
//nolint:tparallel,paralleltest // Docker integration tests don't run in parallel to avoid flakiness.
|
||||
func TestIntegrationDockerCLIStop(t *testing.T) {
|
||||
if os.Getenv("CODER_TEST_USE_DOCKER") != "1" {
|
||||
t.Skip("Set CODER_TEST_USE_DOCKER=1 to run this test")
|
||||
}
|
||||
|
||||
ctx := testutil.Context(t, testutil.WaitLong)
|
||||
|
||||
pool, err := dockertest.NewPool("")
|
||||
require.NoError(t, err, "Could not connect to docker")
|
||||
|
||||
// Given: A simple busybox container
|
||||
ct, err := pool.RunWithOptions(&dockertest.RunOptions{
|
||||
Repository: "busybox",
|
||||
Tag: "latest",
|
||||
Cmd: []string{"sleep", "infinity"},
|
||||
}, func(config *docker.HostConfig) {
|
||||
config.RestartPolicy = docker.RestartPolicy{Name: "no"}
|
||||
})
|
||||
require.NoError(t, err, "Could not start test docker container")
|
||||
t.Logf("Created container %q", ct.Container.Name)
|
||||
t.Cleanup(func() {
|
||||
assert.NoError(t, pool.Purge(ct), "Could not purge resource %q", ct.Container.Name)
|
||||
t.Logf("Purged container %q", ct.Container.Name)
|
||||
})
|
||||
|
||||
// Given: The container is running
|
||||
require.Eventually(t, func() bool {
|
||||
ct, ok := pool.ContainerByName(ct.Container.Name)
|
||||
return ok && ct.Container.State.Running
|
||||
}, testutil.WaitShort, testutil.IntervalSlow, "Container did not start in time")
|
||||
|
||||
dcli := agentcontainers.NewDockerCLI(agentexec.DefaultExecer)
|
||||
containerName := strings.TrimPrefix(ct.Container.Name, "/")
|
||||
|
||||
// When: We attempt to stop the container
|
||||
err = dcli.Stop(ctx, containerName)
|
||||
require.NoError(t, err)
|
||||
|
||||
// Then: We expect the container to be stopped.
|
||||
ct, ok := pool.ContainerByName(ct.Container.Name)
|
||||
require.True(t, ok)
|
||||
require.False(t, ct.Container.State.Running)
|
||||
require.Equal(t, "exited", ct.Container.State.Status)
|
||||
}
|
||||
|
||||
// TestIntegrationDockerCLIRemove tests the Remove method using a real
|
||||
// Docker container.
|
||||
//
|
||||
// Run manually with: CODER_TEST_USE_DOCKER=1 go test ./agent/agentcontainers -run TestIntegrationDockerCLIRemove
|
||||
//
|
||||
//nolint:tparallel,paralleltest // Docker integration tests don't run in parallel to avoid flakiness.
|
||||
func TestIntegrationDockerCLIRemove(t *testing.T) {
|
||||
if os.Getenv("CODER_TEST_USE_DOCKER") != "1" {
|
||||
t.Skip("Set CODER_TEST_USE_DOCKER=1 to run this test")
|
||||
}
|
||||
|
||||
ctx := testutil.Context(t, testutil.WaitLong)
|
||||
|
||||
pool, err := dockertest.NewPool("")
|
||||
require.NoError(t, err, "Could not connect to docker")
|
||||
|
||||
// Given: A simple busybox container that exits immediately.
|
||||
ct, err := pool.RunWithOptions(&dockertest.RunOptions{
|
||||
Repository: "busybox",
|
||||
Tag: "latest",
|
||||
Cmd: []string{"true"},
|
||||
}, func(config *docker.HostConfig) {
|
||||
config.RestartPolicy = docker.RestartPolicy{Name: "no"}
|
||||
})
|
||||
require.NoError(t, err, "Could not start test docker container")
|
||||
t.Logf("Created container %q", ct.Container.Name)
|
||||
containerName := strings.TrimPrefix(ct.Container.Name, "/")
|
||||
|
||||
// Wait for the container to exit.
|
||||
require.Eventually(t, func() bool {
|
||||
ct, ok := pool.ContainerByName(ct.Container.Name)
|
||||
return ok && !ct.Container.State.Running
|
||||
}, testutil.WaitShort, testutil.IntervalSlow, "Container did not stop in time")
|
||||
|
||||
dcli := agentcontainers.NewDockerCLI(agentexec.DefaultExecer)
|
||||
|
||||
// When: We attempt to remove the container.
|
||||
err = dcli.Remove(ctx, containerName)
|
||||
require.NoError(t, err)
|
||||
|
||||
// Then: We expect the container to be removed.
|
||||
_, ok := pool.ContainerByName(ct.Container.Name)
|
||||
require.False(t, ok, "Container should be removed")
|
||||
}
|
||||
|
||||
@@ -311,6 +311,14 @@ func (*fakeContainerCLI) ExecAs(ctx context.Context, containerID, user string, a
|
||||
return nil, nil
|
||||
}
|
||||
|
||||
func (*fakeContainerCLI) Stop(ctx context.Context, containerID string) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
func (*fakeContainerCLI) Remove(ctx context.Context, containerID string) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
type fakeDevcontainerCLI struct {
|
||||
config agentcontainers.DevcontainerConfig
|
||||
execAgent func(ctx context.Context, token string) error
|
||||
|
||||
Generated
+4
@@ -20411,12 +20411,16 @@ const docTemplate = `{
|
||||
"running",
|
||||
"stopped",
|
||||
"starting",
|
||||
"stopping",
|
||||
"deleting",
|
||||
"error"
|
||||
],
|
||||
"x-enum-varnames": [
|
||||
"WorkspaceAgentDevcontainerStatusRunning",
|
||||
"WorkspaceAgentDevcontainerStatusStopped",
|
||||
"WorkspaceAgentDevcontainerStatusStarting",
|
||||
"WorkspaceAgentDevcontainerStatusStopping",
|
||||
"WorkspaceAgentDevcontainerStatusDeleting",
|
||||
"WorkspaceAgentDevcontainerStatusError"
|
||||
]
|
||||
},
|
||||
|
||||
Generated
+10
-1
@@ -18757,11 +18757,20 @@
|
||||
},
|
||||
"codersdk.WorkspaceAgentDevcontainerStatus": {
|
||||
"type": "string",
|
||||
"enum": ["running", "stopped", "starting", "error"],
|
||||
"enum": [
|
||||
"running",
|
||||
"stopped",
|
||||
"starting",
|
||||
"stopping",
|
||||
"deleting",
|
||||
"error"
|
||||
],
|
||||
"x-enum-varnames": [
|
||||
"WorkspaceAgentDevcontainerStatusRunning",
|
||||
"WorkspaceAgentDevcontainerStatusStopped",
|
||||
"WorkspaceAgentDevcontainerStatusStarting",
|
||||
"WorkspaceAgentDevcontainerStatusStopping",
|
||||
"WorkspaceAgentDevcontainerStatusDeleting",
|
||||
"WorkspaceAgentDevcontainerStatusError"
|
||||
]
|
||||
},
|
||||
|
||||
@@ -401,9 +401,22 @@ const (
|
||||
WorkspaceAgentDevcontainerStatusRunning WorkspaceAgentDevcontainerStatus = "running"
|
||||
WorkspaceAgentDevcontainerStatusStopped WorkspaceAgentDevcontainerStatus = "stopped"
|
||||
WorkspaceAgentDevcontainerStatusStarting WorkspaceAgentDevcontainerStatus = "starting"
|
||||
WorkspaceAgentDevcontainerStatusStopping WorkspaceAgentDevcontainerStatus = "stopping"
|
||||
WorkspaceAgentDevcontainerStatusDeleting WorkspaceAgentDevcontainerStatus = "deleting"
|
||||
WorkspaceAgentDevcontainerStatusError WorkspaceAgentDevcontainerStatus = "error"
|
||||
)
|
||||
|
||||
func (s WorkspaceAgentDevcontainerStatus) Transitioning() bool {
|
||||
switch s {
|
||||
case WorkspaceAgentDevcontainerStatusStarting,
|
||||
WorkspaceAgentDevcontainerStatusStopping,
|
||||
WorkspaceAgentDevcontainerStatusDeleting:
|
||||
return true
|
||||
default:
|
||||
return false
|
||||
}
|
||||
}
|
||||
|
||||
// WorkspaceAgentDevcontainer defines the location of a devcontainer
|
||||
// configuration in a workspace that is visible to the workspace agent.
|
||||
type WorkspaceAgentDevcontainer struct {
|
||||
|
||||
Generated
+2
@@ -10851,6 +10851,8 @@ If the schedule is empty, the user will be updated to use the default schedule.|
|
||||
| `running` |
|
||||
| `stopped` |
|
||||
| `starting` |
|
||||
| `stopping` |
|
||||
| `deleting` |
|
||||
| `error` |
|
||||
|
||||
## codersdk.WorkspaceAgentHealth
|
||||
|
||||
Generated
+4
-2
@@ -6127,13 +6127,15 @@ export interface WorkspaceAgentDevcontainerAgent {
|
||||
|
||||
// From codersdk/workspaceagents.go
|
||||
export type WorkspaceAgentDevcontainerStatus =
|
||||
| "deleting"
|
||||
| "error"
|
||||
| "running"
|
||||
| "starting"
|
||||
| "stopped";
|
||||
| "stopped"
|
||||
| "stopping";
|
||||
|
||||
export const WorkspaceAgentDevcontainerStatuses: WorkspaceAgentDevcontainerStatus[] =
|
||||
["error", "running", "starting", "stopped"];
|
||||
["deleting", "error", "running", "starting", "stopped", "stopping"];
|
||||
|
||||
// From codersdk/workspaceagents.go
|
||||
export interface WorkspaceAgentHealth {
|
||||
|
||||
Reference in New Issue
Block a user