mirror of
https://github.com/coder/coder.git
synced 2026-09-24 15:04:27 +08:00
Mathias Fredriksson
3ac844ad3d
This is to free up the devcontainer name space for more targeted structs. Updates #16423
840 lines
28 KiB
Go
840 lines
28 KiB
Go
package agentcontainers
|
|
|
|
import (
|
|
"fmt"
|
|
"math/rand"
|
|
"os"
|
|
"path/filepath"
|
|
"slices"
|
|
"strconv"
|
|
"strings"
|
|
"testing"
|
|
"time"
|
|
|
|
"go.uber.org/mock/gomock"
|
|
|
|
"github.com/google/go-cmp/cmp"
|
|
"github.com/google/uuid"
|
|
"github.com/ory/dockertest/v3"
|
|
"github.com/ory/dockertest/v3/docker"
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"github.com/coder/coder/v2/agent/agentcontainers/acmock"
|
|
"github.com/coder/coder/v2/agent/agentexec"
|
|
"github.com/coder/coder/v2/codersdk"
|
|
"github.com/coder/coder/v2/pty"
|
|
"github.com/coder/coder/v2/testutil"
|
|
"github.com/coder/quartz"
|
|
)
|
|
|
|
// TestIntegrationDocker tests agentcontainers functionality using a real
|
|
// Docker container. It starts a container with a known
|
|
// label, lists the containers, and verifies that the expected container is
|
|
// returned. It also executes a sample command inside the container.
|
|
// The container is deleted after the test is complete.
|
|
// As this test creates containers, it is skipped by default.
|
|
// It can be run manually as follows:
|
|
//
|
|
// CODER_TEST_USE_DOCKER=1 go test ./agent/agentcontainers -run TestDockerCLIContainerLister
|
|
//
|
|
//nolint:paralleltest // This test tends to flake when lots of containers start and stop in parallel.
|
|
func TestIntegrationDocker(t *testing.T) {
|
|
if ctud, ok := os.LookupEnv("CODER_TEST_USE_DOCKER"); !ok || ctud != "1" {
|
|
t.Skip("Set CODER_TEST_USE_DOCKER=1 to run this test")
|
|
}
|
|
|
|
pool, err := dockertest.NewPool("")
|
|
require.NoError(t, err, "Could not connect to docker")
|
|
testLabelValue := uuid.New().String()
|
|
// Create a temporary directory to validate that we surface mounts correctly.
|
|
testTempDir := t.TempDir()
|
|
// Pick a random port to expose for testing port bindings.
|
|
testRandPort := testutil.RandomPortNoListen(t)
|
|
ct, err := pool.RunWithOptions(&dockertest.RunOptions{
|
|
Repository: "busybox",
|
|
Tag: "latest",
|
|
Cmd: []string{"sleep", "infnity"},
|
|
Labels: map[string]string{
|
|
"com.coder.test": testLabelValue,
|
|
"devcontainer.metadata": `[{"remoteEnv": {"FOO": "bar", "MULTILINE": "foo\nbar\nbaz"}}]`,
|
|
},
|
|
Mounts: []string{testTempDir + ":" + testTempDir},
|
|
ExposedPorts: []string{fmt.Sprintf("%d/tcp", testRandPort)},
|
|
PortBindings: map[docker.Port][]docker.PortBinding{
|
|
docker.Port(fmt.Sprintf("%d/tcp", testRandPort)): {
|
|
{
|
|
HostIP: "0.0.0.0",
|
|
HostPort: strconv.FormatInt(int64(testRandPort), 10),
|
|
},
|
|
},
|
|
},
|
|
}, func(config *docker.HostConfig) {
|
|
config.AutoRemove = true
|
|
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)
|
|
})
|
|
// Wait for container to start
|
|
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")
|
|
|
|
dcl := NewDocker(agentexec.DefaultExecer)
|
|
ctx := testutil.Context(t, testutil.WaitShort)
|
|
actual, err := dcl.List(ctx)
|
|
require.NoError(t, err, "Could not list containers")
|
|
require.Empty(t, actual.Warnings, "Expected no warnings")
|
|
var found bool
|
|
for _, foundContainer := range actual.Containers {
|
|
if foundContainer.ID == ct.Container.ID {
|
|
found = true
|
|
assert.Equal(t, ct.Container.Created, foundContainer.CreatedAt)
|
|
// ory/dockertest pre-pends a forward slash to the container name.
|
|
assert.Equal(t, strings.TrimPrefix(ct.Container.Name, "/"), foundContainer.FriendlyName)
|
|
// ory/dockertest returns the sha256 digest of the image.
|
|
assert.Equal(t, "busybox:latest", foundContainer.Image)
|
|
assert.Equal(t, ct.Container.Config.Labels, foundContainer.Labels)
|
|
assert.True(t, foundContainer.Running)
|
|
assert.Equal(t, "running", foundContainer.Status)
|
|
if assert.Len(t, foundContainer.Ports, 1) {
|
|
assert.Equal(t, testRandPort, foundContainer.Ports[0].Port)
|
|
assert.Equal(t, "tcp", foundContainer.Ports[0].Network)
|
|
}
|
|
if assert.Len(t, foundContainer.Volumes, 1) {
|
|
assert.Equal(t, testTempDir, foundContainer.Volumes[testTempDir])
|
|
}
|
|
// Test that EnvInfo is able to correctly modify a command to be
|
|
// executed inside the container.
|
|
dei, err := EnvInfo(ctx, agentexec.DefaultExecer, ct.Container.ID, "")
|
|
require.NoError(t, err, "Expected no error from DockerEnvInfo()")
|
|
ptyWrappedCmd, ptyWrappedArgs := dei.ModifyCommand("/bin/sh", "--norc")
|
|
ptyCmd, ptyPs, err := pty.Start(agentexec.DefaultExecer.PTYCommandContext(ctx, ptyWrappedCmd, ptyWrappedArgs...))
|
|
require.NoError(t, err, "failed to start pty command")
|
|
t.Cleanup(func() {
|
|
_ = ptyPs.Kill()
|
|
_ = ptyCmd.Close()
|
|
})
|
|
tr := testutil.NewTerminalReader(t, ptyCmd.OutputReader())
|
|
matchPrompt := func(line string) bool {
|
|
return strings.Contains(line, "#")
|
|
}
|
|
matchHostnameCmd := func(line string) bool {
|
|
return strings.Contains(strings.TrimSpace(line), "hostname")
|
|
}
|
|
matchHostnameOuput := func(line string) bool {
|
|
return strings.Contains(strings.TrimSpace(line), ct.Container.Config.Hostname)
|
|
}
|
|
matchEnvCmd := func(line string) bool {
|
|
return strings.Contains(strings.TrimSpace(line), "env")
|
|
}
|
|
matchEnvOutput := func(line string) bool {
|
|
return strings.Contains(line, "FOO=bar") || strings.Contains(line, "MULTILINE=foo")
|
|
}
|
|
require.NoError(t, tr.ReadUntil(ctx, matchPrompt), "failed to match prompt")
|
|
t.Logf("Matched prompt")
|
|
_, err = ptyCmd.InputWriter().Write([]byte("hostname\r\n"))
|
|
require.NoError(t, err, "failed to write to pty")
|
|
t.Logf("Wrote hostname command")
|
|
require.NoError(t, tr.ReadUntil(ctx, matchHostnameCmd), "failed to match hostname command")
|
|
t.Logf("Matched hostname command")
|
|
require.NoError(t, tr.ReadUntil(ctx, matchHostnameOuput), "failed to match hostname output")
|
|
t.Logf("Matched hostname output")
|
|
_, err = ptyCmd.InputWriter().Write([]byte("env\r\n"))
|
|
require.NoError(t, err, "failed to write to pty")
|
|
t.Logf("Wrote env command")
|
|
require.NoError(t, tr.ReadUntil(ctx, matchEnvCmd), "failed to match env command")
|
|
t.Logf("Matched env command")
|
|
require.NoError(t, tr.ReadUntil(ctx, matchEnvOutput), "failed to match env output")
|
|
t.Logf("Matched env output")
|
|
break
|
|
}
|
|
}
|
|
assert.True(t, found, "Expected to find container with label 'com.coder.test=%s'", testLabelValue)
|
|
}
|
|
|
|
func TestWrapDockerExec(t *testing.T) {
|
|
t.Parallel()
|
|
tests := []struct {
|
|
name string
|
|
containerUser string
|
|
cmdArgs []string
|
|
wantCmd []string
|
|
}{
|
|
{
|
|
name: "cmd with no args",
|
|
containerUser: "my-user",
|
|
cmdArgs: []string{"my-cmd"},
|
|
wantCmd: []string{"docker", "exec", "--interactive", "--user", "my-user", "my-container", "my-cmd"},
|
|
},
|
|
{
|
|
name: "cmd with args",
|
|
containerUser: "my-user",
|
|
cmdArgs: []string{"my-cmd", "arg1", "--arg2", "arg3", "--arg4"},
|
|
wantCmd: []string{"docker", "exec", "--interactive", "--user", "my-user", "my-container", "my-cmd", "arg1", "--arg2", "arg3", "--arg4"},
|
|
},
|
|
{
|
|
name: "no user specified",
|
|
containerUser: "",
|
|
cmdArgs: []string{"my-cmd"},
|
|
wantCmd: []string{"docker", "exec", "--interactive", "my-container", "my-cmd"},
|
|
},
|
|
}
|
|
for _, tt := range tests {
|
|
tt := tt // appease the linter even though this isn't needed anymore
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
t.Parallel()
|
|
actualCmd, actualArgs := wrapDockerExec("my-container", tt.containerUser, tt.cmdArgs[0], tt.cmdArgs[1:]...)
|
|
assert.Equal(t, tt.wantCmd[0], actualCmd)
|
|
assert.Equal(t, tt.wantCmd[1:], actualArgs)
|
|
})
|
|
}
|
|
}
|
|
|
|
// TestContainersHandler tests the containersHandler.getContainers method using
|
|
// a mock implementation. It specifically tests caching behavior.
|
|
func TestContainersHandler(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
t.Run("list", func(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
fakeCt := fakeContainer(t)
|
|
fakeCt2 := fakeContainer(t)
|
|
makeResponse := func(cts ...codersdk.WorkspaceAgentContainer) codersdk.WorkspaceAgentListContainersResponse {
|
|
return codersdk.WorkspaceAgentListContainersResponse{Containers: cts}
|
|
}
|
|
|
|
// Each test case is called multiple times to ensure idempotency
|
|
for _, tc := range []struct {
|
|
name string
|
|
// data to be stored in the handler
|
|
cacheData codersdk.WorkspaceAgentListContainersResponse
|
|
// duration of cache
|
|
cacheDur time.Duration
|
|
// relative age of the cached data
|
|
cacheAge time.Duration
|
|
// function to set up expectations for the mock
|
|
setupMock func(*acmock.MockLister)
|
|
// expected result
|
|
expected codersdk.WorkspaceAgentListContainersResponse
|
|
// expected error
|
|
expectedErr string
|
|
}{
|
|
{
|
|
name: "no cache",
|
|
setupMock: func(mcl *acmock.MockLister) {
|
|
mcl.EXPECT().List(gomock.Any()).Return(makeResponse(fakeCt), nil).AnyTimes()
|
|
},
|
|
expected: makeResponse(fakeCt),
|
|
},
|
|
{
|
|
name: "no data",
|
|
cacheData: makeResponse(),
|
|
cacheAge: 2 * time.Second,
|
|
cacheDur: time.Second,
|
|
setupMock: func(mcl *acmock.MockLister) {
|
|
mcl.EXPECT().List(gomock.Any()).Return(makeResponse(fakeCt), nil).AnyTimes()
|
|
},
|
|
expected: makeResponse(fakeCt),
|
|
},
|
|
{
|
|
name: "cached data",
|
|
cacheAge: time.Second,
|
|
cacheData: makeResponse(fakeCt),
|
|
cacheDur: 2 * time.Second,
|
|
expected: makeResponse(fakeCt),
|
|
},
|
|
{
|
|
name: "lister error",
|
|
setupMock: func(mcl *acmock.MockLister) {
|
|
mcl.EXPECT().List(gomock.Any()).Return(makeResponse(), assert.AnError).AnyTimes()
|
|
},
|
|
expectedErr: assert.AnError.Error(),
|
|
},
|
|
{
|
|
name: "stale cache",
|
|
cacheAge: 2 * time.Second,
|
|
cacheData: makeResponse(fakeCt),
|
|
cacheDur: time.Second,
|
|
setupMock: func(mcl *acmock.MockLister) {
|
|
mcl.EXPECT().List(gomock.Any()).Return(makeResponse(fakeCt2), nil).AnyTimes()
|
|
},
|
|
expected: makeResponse(fakeCt2),
|
|
},
|
|
} {
|
|
tc := tc
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
t.Parallel()
|
|
var (
|
|
ctx = testutil.Context(t, testutil.WaitShort)
|
|
clk = quartz.NewMock(t)
|
|
ctrl = gomock.NewController(t)
|
|
mockLister = acmock.NewMockLister(ctrl)
|
|
now = time.Now().UTC()
|
|
ch = devcontainersHandler{
|
|
cacheDuration: tc.cacheDur,
|
|
cl: mockLister,
|
|
clock: clk,
|
|
containers: &tc.cacheData,
|
|
lockCh: make(chan struct{}, 1),
|
|
}
|
|
)
|
|
if tc.cacheAge != 0 {
|
|
ch.mtime = now.Add(-tc.cacheAge)
|
|
}
|
|
if tc.setupMock != nil {
|
|
tc.setupMock(mockLister)
|
|
}
|
|
|
|
clk.Set(now).MustWait(ctx)
|
|
|
|
// Repeat the test to ensure idempotency
|
|
for i := 0; i < 2; i++ {
|
|
actual, err := ch.getContainers(ctx)
|
|
if tc.expectedErr != "" {
|
|
require.Empty(t, actual, "expected no data (attempt %d)", i)
|
|
require.ErrorContains(t, err, tc.expectedErr, "expected error (attempt %d)", i)
|
|
} else {
|
|
require.NoError(t, err, "expected no error (attempt %d)", i)
|
|
require.Equal(t, tc.expected, actual, "expected containers to be equal (attempt %d)", i)
|
|
}
|
|
}
|
|
})
|
|
}
|
|
})
|
|
}
|
|
|
|
func TestConvertDockerPort(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
//nolint:paralleltest // variable recapture no longer required
|
|
for _, tc := range []struct {
|
|
name string
|
|
in string
|
|
expectPort uint16
|
|
expectNetwork string
|
|
expectError string
|
|
}{
|
|
{
|
|
name: "empty port",
|
|
in: "",
|
|
expectError: "invalid port",
|
|
},
|
|
{
|
|
name: "valid tcp port",
|
|
in: "8080/tcp",
|
|
expectPort: 8080,
|
|
expectNetwork: "tcp",
|
|
},
|
|
{
|
|
name: "valid udp port",
|
|
in: "8080/udp",
|
|
expectPort: 8080,
|
|
expectNetwork: "udp",
|
|
},
|
|
{
|
|
name: "valid port no network",
|
|
in: "8080",
|
|
expectPort: 8080,
|
|
expectNetwork: "tcp",
|
|
},
|
|
{
|
|
name: "invalid port",
|
|
in: "invalid/tcp",
|
|
expectError: "invalid port",
|
|
},
|
|
{
|
|
name: "invalid port no network",
|
|
in: "invalid",
|
|
expectError: "invalid port",
|
|
},
|
|
{
|
|
name: "multiple network",
|
|
in: "8080/tcp/udp",
|
|
expectError: "invalid port",
|
|
},
|
|
} {
|
|
//nolint: paralleltest // variable recapture no longer required
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
t.Parallel()
|
|
actualPort, actualNetwork, actualErr := convertDockerPort(tc.in)
|
|
if tc.expectError != "" {
|
|
assert.Zero(t, actualPort, "expected no port")
|
|
assert.Empty(t, actualNetwork, "expected no network")
|
|
assert.ErrorContains(t, actualErr, tc.expectError)
|
|
} else {
|
|
assert.NoError(t, actualErr, "expected no error")
|
|
assert.Equal(t, tc.expectPort, actualPort, "expected port to match")
|
|
assert.Equal(t, tc.expectNetwork, actualNetwork, "expected network to match")
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestConvertDockerVolume(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
for _, tc := range []struct {
|
|
name string
|
|
in string
|
|
expectHostPath string
|
|
expectContainerPath string
|
|
expectError string
|
|
}{
|
|
{
|
|
name: "empty volume",
|
|
in: "",
|
|
expectError: "invalid volume",
|
|
},
|
|
{
|
|
name: "length 1 volume",
|
|
in: "/path/to/something",
|
|
expectHostPath: "/path/to/something",
|
|
expectContainerPath: "/path/to/something",
|
|
},
|
|
{
|
|
name: "length 2 volume",
|
|
in: "/path/to/something=/path/to/something/else",
|
|
expectHostPath: "/path/to/something",
|
|
expectContainerPath: "/path/to/something/else",
|
|
},
|
|
{
|
|
name: "invalid length volume",
|
|
in: "/path/to/something=/path/to/something/else=/path/to/something/else/else",
|
|
expectError: "invalid volume",
|
|
},
|
|
} {
|
|
tc := tc
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
t.Parallel()
|
|
})
|
|
}
|
|
}
|
|
|
|
// TestConvertDockerInspect tests the convertDockerInspect function using
|
|
// fixtures from ./testdata.
|
|
func TestConvertDockerInspect(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
//nolint:paralleltest // variable recapture no longer required
|
|
for _, tt := range []struct {
|
|
name string
|
|
expect []codersdk.WorkspaceAgentContainer
|
|
expectWarns []string
|
|
expectError string
|
|
}{
|
|
{
|
|
name: "container_simple",
|
|
expect: []codersdk.WorkspaceAgentContainer{
|
|
{
|
|
CreatedAt: time.Date(2025, 3, 11, 17, 55, 58, 91280203, time.UTC),
|
|
ID: "6b539b8c60f5230b8b0fde2502cd2332d31c0d526a3e6eb6eef1cc39439b3286",
|
|
FriendlyName: "eloquent_kowalevski",
|
|
Image: "debian:bookworm",
|
|
Labels: map[string]string{},
|
|
Running: true,
|
|
Status: "running",
|
|
Ports: []codersdk.WorkspaceAgentContainerPort{},
|
|
Volumes: map[string]string{},
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: "container_labels",
|
|
expect: []codersdk.WorkspaceAgentContainer{
|
|
{
|
|
CreatedAt: time.Date(2025, 3, 11, 20, 3, 28, 71706536, time.UTC),
|
|
ID: "bd8818e670230fc6f36145b21cf8d6d35580355662aa4d9fe5ae1b188a4c905f",
|
|
FriendlyName: "fervent_bardeen",
|
|
Image: "debian:bookworm",
|
|
Labels: map[string]string{"baz": "zap", "foo": "bar"},
|
|
Running: true,
|
|
Status: "running",
|
|
Ports: []codersdk.WorkspaceAgentContainerPort{},
|
|
Volumes: map[string]string{},
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: "container_binds",
|
|
expect: []codersdk.WorkspaceAgentContainer{
|
|
{
|
|
CreatedAt: time.Date(2025, 3, 11, 17, 58, 43, 522505027, time.UTC),
|
|
ID: "fdc75ebefdc0243c0fce959e7685931691ac7aede278664a0e2c23af8a1e8d6a",
|
|
FriendlyName: "silly_beaver",
|
|
Image: "debian:bookworm",
|
|
Labels: map[string]string{},
|
|
Running: true,
|
|
Status: "running",
|
|
Ports: []codersdk.WorkspaceAgentContainerPort{},
|
|
Volumes: map[string]string{
|
|
"/tmp/test/a": "/var/coder/a",
|
|
"/tmp/test/b": "/var/coder/b",
|
|
},
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: "container_sameport",
|
|
expect: []codersdk.WorkspaceAgentContainer{
|
|
{
|
|
CreatedAt: time.Date(2025, 3, 11, 17, 56, 34, 842164541, time.UTC),
|
|
ID: "4eac5ce199d27b2329d0ff0ce1a6fc595612ced48eba3669aadb6c57ebef3fa2",
|
|
FriendlyName: "modest_varahamihira",
|
|
Image: "debian:bookworm",
|
|
Labels: map[string]string{},
|
|
Running: true,
|
|
Status: "running",
|
|
Ports: []codersdk.WorkspaceAgentContainerPort{
|
|
{
|
|
Network: "tcp",
|
|
Port: 12345,
|
|
HostPort: 12345,
|
|
HostIP: "0.0.0.0",
|
|
},
|
|
},
|
|
Volumes: map[string]string{},
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: "container_differentport",
|
|
expect: []codersdk.WorkspaceAgentContainer{
|
|
{
|
|
CreatedAt: time.Date(2025, 3, 11, 17, 57, 8, 862545133, time.UTC),
|
|
ID: "3090de8b72b1224758a94a11b827c82ba2b09c45524f1263dc4a2d83e19625ea",
|
|
FriendlyName: "boring_ellis",
|
|
Image: "debian:bookworm",
|
|
Labels: map[string]string{},
|
|
Running: true,
|
|
Status: "running",
|
|
Ports: []codersdk.WorkspaceAgentContainerPort{
|
|
{
|
|
Network: "tcp",
|
|
Port: 23456,
|
|
HostPort: 12345,
|
|
HostIP: "0.0.0.0",
|
|
},
|
|
},
|
|
Volumes: map[string]string{},
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: "container_sameportdiffip",
|
|
expect: []codersdk.WorkspaceAgentContainer{
|
|
{
|
|
CreatedAt: time.Date(2025, 3, 11, 17, 56, 34, 842164541, time.UTC),
|
|
ID: "a",
|
|
FriendlyName: "a",
|
|
Image: "debian:bookworm",
|
|
Labels: map[string]string{},
|
|
Running: true,
|
|
Status: "running",
|
|
Ports: []codersdk.WorkspaceAgentContainerPort{
|
|
{
|
|
Network: "tcp",
|
|
Port: 8001,
|
|
HostPort: 8000,
|
|
HostIP: "0.0.0.0",
|
|
},
|
|
},
|
|
Volumes: map[string]string{},
|
|
},
|
|
{
|
|
CreatedAt: time.Date(2025, 3, 11, 17, 56, 34, 842164541, time.UTC),
|
|
ID: "b",
|
|
FriendlyName: "b",
|
|
Image: "debian:bookworm",
|
|
Labels: map[string]string{},
|
|
Running: true,
|
|
Status: "running",
|
|
Ports: []codersdk.WorkspaceAgentContainerPort{
|
|
{
|
|
Network: "tcp",
|
|
Port: 8001,
|
|
HostPort: 8000,
|
|
HostIP: "::",
|
|
},
|
|
},
|
|
Volumes: map[string]string{},
|
|
},
|
|
},
|
|
expectWarns: []string{"host port 8000 is mapped to multiple containers on different interfaces: a, b"},
|
|
},
|
|
{
|
|
name: "container_volume",
|
|
expect: []codersdk.WorkspaceAgentContainer{
|
|
{
|
|
CreatedAt: time.Date(2025, 3, 11, 17, 59, 42, 39484134, time.UTC),
|
|
ID: "b3688d98c007f53402a55e46d803f2f3ba9181d8e3f71a2eb19b392cf0377b4e",
|
|
FriendlyName: "upbeat_carver",
|
|
Image: "debian:bookworm",
|
|
Labels: map[string]string{},
|
|
Running: true,
|
|
Status: "running",
|
|
Ports: []codersdk.WorkspaceAgentContainerPort{},
|
|
Volumes: map[string]string{
|
|
"/var/lib/docker/volumes/testvol/_data": "/testvol",
|
|
},
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: "devcontainer_simple",
|
|
expect: []codersdk.WorkspaceAgentContainer{
|
|
{
|
|
CreatedAt: time.Date(2025, 3, 11, 17, 1, 5, 751972661, time.UTC),
|
|
ID: "0b2a9fcf5727d9562943ce47d445019f4520e37a2aa7c6d9346d01af4f4f9aed",
|
|
FriendlyName: "optimistic_hopper",
|
|
Image: "debian:bookworm",
|
|
Labels: map[string]string{
|
|
"devcontainer.config_file": "/home/coder/src/coder/coder/agent/agentcontainers/testdata/devcontainer_simple.json",
|
|
"devcontainer.metadata": "[]",
|
|
},
|
|
Running: true,
|
|
Status: "running",
|
|
Ports: []codersdk.WorkspaceAgentContainerPort{},
|
|
Volumes: map[string]string{},
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: "devcontainer_forwardport",
|
|
expect: []codersdk.WorkspaceAgentContainer{
|
|
{
|
|
CreatedAt: time.Date(2025, 3, 11, 17, 3, 55, 22053072, time.UTC),
|
|
ID: "4a16af2293fb75dc827a6949a3905dd57ea28cc008823218ce24fab1cb66c067",
|
|
FriendlyName: "serene_khayyam",
|
|
Image: "debian:bookworm",
|
|
Labels: map[string]string{
|
|
"devcontainer.config_file": "/home/coder/src/coder/coder/agent/agentcontainers/testdata/devcontainer_forwardport.json",
|
|
"devcontainer.metadata": "[]",
|
|
},
|
|
Running: true,
|
|
Status: "running",
|
|
Ports: []codersdk.WorkspaceAgentContainerPort{},
|
|
Volumes: map[string]string{},
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: "devcontainer_appport",
|
|
expect: []codersdk.WorkspaceAgentContainer{
|
|
{
|
|
CreatedAt: time.Date(2025, 3, 11, 17, 2, 42, 613747761, time.UTC),
|
|
ID: "52d23691f4b954d083f117358ea763e20f69af584e1c08f479c5752629ee0be3",
|
|
FriendlyName: "suspicious_margulis",
|
|
Image: "debian:bookworm",
|
|
Labels: map[string]string{
|
|
"devcontainer.config_file": "/home/coder/src/coder/coder/agent/agentcontainers/testdata/devcontainer_appport.json",
|
|
"devcontainer.metadata": "[]",
|
|
},
|
|
Running: true,
|
|
Status: "running",
|
|
Ports: []codersdk.WorkspaceAgentContainerPort{
|
|
{
|
|
Network: "tcp",
|
|
Port: 8080,
|
|
HostPort: 32768,
|
|
HostIP: "0.0.0.0",
|
|
},
|
|
},
|
|
Volumes: map[string]string{},
|
|
},
|
|
},
|
|
},
|
|
} {
|
|
// nolint:paralleltest // variable recapture no longer required
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
t.Parallel()
|
|
bs, err := os.ReadFile(filepath.Join("testdata", tt.name, "docker_inspect.json"))
|
|
require.NoError(t, err, "failed to read testdata file")
|
|
actual, warns, err := convertDockerInspect(bs)
|
|
if len(tt.expectWarns) > 0 {
|
|
assert.Len(t, warns, len(tt.expectWarns), "expected warnings")
|
|
for _, warn := range tt.expectWarns {
|
|
assert.Contains(t, warns, warn)
|
|
}
|
|
}
|
|
if tt.expectError != "" {
|
|
assert.Empty(t, actual, "expected no data")
|
|
assert.ErrorContains(t, err, tt.expectError)
|
|
return
|
|
}
|
|
require.NoError(t, err, "expected no error")
|
|
if diff := cmp.Diff(tt.expect, actual); diff != "" {
|
|
t.Errorf("unexpected diff (-want +got):\n%s", diff)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
// TestDockerEnvInfoer tests the ability of EnvInfo to extract information from
|
|
// running containers. Containers are deleted after the test is complete.
|
|
// As this test creates containers, it is skipped by default.
|
|
// It can be run manually as follows:
|
|
//
|
|
// CODER_TEST_USE_DOCKER=1 go test ./agent/agentcontainers -run TestDockerEnvInfoer
|
|
//
|
|
//nolint:paralleltest // This test tends to flake when lots of containers start and stop in parallel.
|
|
func TestDockerEnvInfoer(t *testing.T) {
|
|
if ctud, ok := os.LookupEnv("CODER_TEST_USE_DOCKER"); !ok || ctud != "1" {
|
|
t.Skip("Set CODER_TEST_USE_DOCKER=1 to run this test")
|
|
}
|
|
|
|
pool, err := dockertest.NewPool("")
|
|
require.NoError(t, err, "Could not connect to docker")
|
|
// nolint:paralleltest // variable recapture no longer required
|
|
for idx, tt := range []struct {
|
|
image string
|
|
labels map[string]string
|
|
expectedEnv []string
|
|
containerUser string
|
|
expectedUsername string
|
|
expectedUserShell string
|
|
}{
|
|
{
|
|
image: "busybox:latest",
|
|
labels: map[string]string{`devcontainer.metadata`: `[{"remoteEnv": {"FOO": "bar", "MULTILINE": "foo\nbar\nbaz"}}]`},
|
|
|
|
expectedEnv: []string{"FOO=bar", "MULTILINE=foo\nbar\nbaz"},
|
|
expectedUsername: "root",
|
|
expectedUserShell: "/bin/sh",
|
|
},
|
|
{
|
|
image: "busybox:latest",
|
|
labels: map[string]string{`devcontainer.metadata`: `[{"remoteEnv": {"FOO": "bar", "MULTILINE": "foo\nbar\nbaz"}}]`},
|
|
expectedEnv: []string{"FOO=bar", "MULTILINE=foo\nbar\nbaz"},
|
|
containerUser: "root",
|
|
expectedUsername: "root",
|
|
expectedUserShell: "/bin/sh",
|
|
},
|
|
{
|
|
image: "codercom/enterprise-minimal:ubuntu",
|
|
labels: map[string]string{`devcontainer.metadata`: `[{"remoteEnv": {"FOO": "bar", "MULTILINE": "foo\nbar\nbaz"}}]`},
|
|
expectedEnv: []string{"FOO=bar", "MULTILINE=foo\nbar\nbaz"},
|
|
expectedUsername: "coder",
|
|
expectedUserShell: "/bin/bash",
|
|
},
|
|
{
|
|
image: "codercom/enterprise-minimal:ubuntu",
|
|
labels: map[string]string{`devcontainer.metadata`: `[{"remoteEnv": {"FOO": "bar", "MULTILINE": "foo\nbar\nbaz"}}]`},
|
|
expectedEnv: []string{"FOO=bar", "MULTILINE=foo\nbar\nbaz"},
|
|
containerUser: "coder",
|
|
expectedUsername: "coder",
|
|
expectedUserShell: "/bin/bash",
|
|
},
|
|
{
|
|
image: "codercom/enterprise-minimal:ubuntu",
|
|
labels: map[string]string{`devcontainer.metadata`: `[{"remoteEnv": {"FOO": "bar", "MULTILINE": "foo\nbar\nbaz"}}]`},
|
|
expectedEnv: []string{"FOO=bar", "MULTILINE=foo\nbar\nbaz"},
|
|
containerUser: "root",
|
|
expectedUsername: "root",
|
|
expectedUserShell: "/bin/bash",
|
|
},
|
|
{
|
|
image: "codercom/enterprise-minimal:ubuntu",
|
|
labels: map[string]string{`devcontainer.metadata`: `[{"remoteEnv": {"FOO": "bar"}},{"remoteEnv": {"MULTILINE": "foo\nbar\nbaz"}}]`},
|
|
expectedEnv: []string{"FOO=bar", "MULTILINE=foo\nbar\nbaz"},
|
|
containerUser: "root",
|
|
expectedUsername: "root",
|
|
expectedUserShell: "/bin/bash",
|
|
},
|
|
} {
|
|
//nolint:paralleltest // variable recapture no longer required
|
|
t.Run(fmt.Sprintf("#%d", idx), func(t *testing.T) {
|
|
// Start a container with the given image
|
|
// and environment variables
|
|
image := strings.Split(tt.image, ":")[0]
|
|
tag := strings.Split(tt.image, ":")[1]
|
|
ct, err := pool.RunWithOptions(&dockertest.RunOptions{
|
|
Repository: image,
|
|
Tag: tag,
|
|
Cmd: []string{"sleep", "infinity"},
|
|
Labels: tt.labels,
|
|
}, func(config *docker.HostConfig) {
|
|
config.AutoRemove = true
|
|
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)
|
|
})
|
|
|
|
ctx := testutil.Context(t, testutil.WaitShort)
|
|
dei, err := EnvInfo(ctx, agentexec.DefaultExecer, ct.Container.ID, tt.containerUser)
|
|
require.NoError(t, err, "Expected no error from DockerEnvInfo()")
|
|
|
|
u, err := dei.User()
|
|
require.NoError(t, err, "Expected no error from CurrentUser()")
|
|
require.Equal(t, tt.expectedUsername, u.Username, "Expected username to match")
|
|
|
|
hd, err := dei.HomeDir()
|
|
require.NoError(t, err, "Expected no error from UserHomeDir()")
|
|
require.NotEmpty(t, hd, "Expected user homedir to be non-empty")
|
|
|
|
sh, err := dei.Shell(tt.containerUser)
|
|
require.NoError(t, err, "Expected no error from UserShell()")
|
|
require.Equal(t, tt.expectedUserShell, sh, "Expected user shell to match")
|
|
|
|
// We don't need to test the actual environment variables here.
|
|
environ := dei.Environ()
|
|
require.NotEmpty(t, environ, "Expected environ to be non-empty")
|
|
|
|
// Test that the environment variables are present in modified command
|
|
// output.
|
|
envCmd, envArgs := dei.ModifyCommand("env")
|
|
for _, env := range tt.expectedEnv {
|
|
require.Subset(t, envArgs, []string{"--env", env})
|
|
}
|
|
// Run the command in the container and check the output
|
|
// HACK: we remove the --tty argument because we're not running in a tty
|
|
envArgs = slices.DeleteFunc(envArgs, func(s string) bool { return s == "--tty" })
|
|
stdout, stderr, err := run(ctx, agentexec.DefaultExecer, envCmd, envArgs...)
|
|
require.Empty(t, stderr, "Expected no stderr output")
|
|
require.NoError(t, err, "Expected no error from running command")
|
|
for _, env := range tt.expectedEnv {
|
|
require.Contains(t, stdout, env)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func fakeContainer(t *testing.T, mut ...func(*codersdk.WorkspaceAgentContainer)) codersdk.WorkspaceAgentContainer {
|
|
t.Helper()
|
|
ct := codersdk.WorkspaceAgentContainer{
|
|
CreatedAt: time.Now().UTC(),
|
|
ID: uuid.New().String(),
|
|
FriendlyName: testutil.GetRandomName(t),
|
|
Image: testutil.GetRandomName(t) + ":" + strings.Split(uuid.New().String(), "-")[0],
|
|
Labels: map[string]string{
|
|
testutil.GetRandomName(t): testutil.GetRandomName(t),
|
|
},
|
|
Running: true,
|
|
Ports: []codersdk.WorkspaceAgentContainerPort{
|
|
{
|
|
Network: "tcp",
|
|
Port: testutil.RandomPortNoListen(t),
|
|
HostPort: testutil.RandomPortNoListen(t),
|
|
//nolint:gosec // this is a test
|
|
HostIP: []string{"127.0.0.1", "[::1]", "localhost", "0.0.0.0", "[::]", testutil.GetRandomName(t)}[rand.Intn(6)],
|
|
},
|
|
},
|
|
Status: testutil.MustRandString(t, 10),
|
|
Volumes: map[string]string{testutil.GetRandomName(t): testutil.GetRandomName(t)},
|
|
}
|
|
for _, m := range mut {
|
|
m(&ct)
|
|
}
|
|
return ct
|
|
}
|