Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
15 changes: 10 additions & 5 deletions pkg/driver/docker/lifecycle.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ import (

const containerRestartAttempts = 3

const containerStatusRunning = "running"

// snapshotImageLabel marks a committed image as a devsy workspace snapshot,
// so it's identifiable via `docker inspect`/`docker images --filter` by
// anyone who pulls or lists it outside `devsy snapshot` tooling — the
Expand Down Expand Up @@ -72,7 +74,7 @@ func (d *dockerDriver) ensureContainerRunning(
status,
)
}
if status == "running" {
if status == containerStatusRunning {
return nil
}

Expand Down Expand Up @@ -189,6 +191,8 @@ func (d *dockerDriver) CommitContainer(ctx context.Context, workspaceID, tag str
return nil
}

// DeleteDevContainer stops a still-running container before removing it,
// since podman/docker refuse to `rm` a running container.
func (d *dockerDriver) DeleteDevContainer(ctx context.Context, workspaceId string) error {
container, err := d.FindDevContainer(ctx, workspaceId)
if err != nil {
Expand All @@ -197,12 +201,13 @@ func (d *dockerDriver) DeleteDevContainer(ctx context.Context, workspaceId strin
return nil
}

err = d.Docker.Remove(ctx, container.ID)
if err != nil {
return err
if strings.ToLower(container.State.Status) == containerStatusRunning {
if err := d.Docker.Stop(ctx, container.ID); err != nil {
log.Warnf("stop before delete failed for %s: %v", container.ID, err)
}
}

return nil
return d.Docker.Remove(ctx, container.ID)
}

func (d *dockerDriver) StartDevContainer(ctx context.Context, workspaceId string) error {
Expand Down
34 changes: 33 additions & 1 deletion pkg/driver/docker/lifecycle_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ func TestEnsureContainerRunning_AlreadyRunning(t *testing.T) {
d := &dockerDriver{Docker: &docker.DockerHelper{DockerCommand: testDockerCmd}}
container := &config.ContainerDetails{
ID: "c1",
State: config.ContainerDetailsState{Status: "running"},
State: config.ContainerDetailsState{Status: containerStatusRunning},
}

require.NoError(t, d.ensureContainerRunning(context.Background(), container))
Expand Down Expand Up @@ -326,3 +326,35 @@ esac
require.Error(t, err)
assert.ErrorIs(t, err, context.Canceled)
}

func TestDeleteDevContainer_StopsRunningContainerBeforeRemove(t *testing.T) {
dir := t.TempDir()
calls := filepath.Join(dir, "calls")
script := `#!/bin/sh
echo "$1" >> "` + calls + `"
case "$1" in
inspect)
echo '[{"ID":"c1","State":{"Status":"running"}}]'
;;
stop) ;;
rm)
if ! grep -q '^stop$' "` + calls + `"; then
echo "cannot remove running container" >&2
exit 1
fi
;;
esac
`
bin := filepath.Join(dir, "docker-fake")
require.NoError(t, os.WriteFile(bin, []byte(script), 0o755)) //nolint:gosec

d := &dockerDriver{Docker: &docker.DockerHelper{DockerCommand: bin, ContainerID: "c1"}}

err := d.DeleteDevContainer(context.Background(), "ws1")
require.NoError(t, err)

logged, readErr := os.ReadFile(calls) //nolint:gosec // G304: test-controlled path
require.NoError(t, readErr)
assert.Contains(t, string(logged), "stop\n")
assert.Contains(t, string(logged), "rm\n")
}
Loading