Skip to content

feat(agent): implement recreate for devcontainers #17308

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 13 commits into from
Apr 10, 2025
Merged

feat(agent): implement recreate for devcontainers #17308

Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
6d18522
feat(agent): implement recreate for devcontainers
mafredri Apr 9, 2025
6b08fd1
remove ai comments from test
mafredri Apr 9, 2025
db6157e
update comments
mafredri Apr 9, 2025
c214476
oopsie
mafredri Apr 9, 2025
486bb3f
consistent var naming
mafredri Apr 9, 2025
379b262
restructure test
mafredri Apr 9, 2025
ca791d6
wait medium just in case
mafredri Apr 9, 2025
2692e55
mark testdata as generated
mafredri Apr 9, 2025
2687bfd
allow paralleltest
mafredri Apr 10, 2025
b850b07
rename log writer
mafredri Apr 10, 2025
6b8ad8c
fixup! allow paralleltest
mafredri Apr 10, 2025
1d937a0
fixup! fixup! allow paralleltest
mafredri Apr 10, 2025
f5e2328
fixup! fixup! fixup! allow paralleltest
mafredri Apr 10, 2025
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
restructure test
  • Loading branch information
@mafredri
mafredri committed Apr 9, 2025
commit 379b26240461e9dbb31454bd7c0a9b9c35995f10
173 changes: 87 additions & 86 deletions agent/agentcontainers/devcontainercli_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,101 +26,102 @@ import (
"github.com/coder/coder/v2/testutil"
)

// TestDevcontainerCLIUp tests the Up method of the DevcontainerCLI implementation.
//
//nolint:paralleltest // This test is not parallel-safe due to t.Setenv.
func TestDevcontainerCLI_Up_ArgsAndParsing(t *testing.T) {
func TestDevcontainerCLI_ArgsAndParsing(t *testing.T) {
testExePath, err := os.Executable()
require.NoError(t, err, "get test executable path")

logger := slogtest.Make(t, &slogtest.Options{IgnoreErrors: true}).Leveled(slog.LevelDebug)
testExecer := &testDevcontainerExecer{testExePath: testExePath}

tests := []struct {
name string
logFile string
workspace string
config string
opts []agentcontainers.DevcontainerCLIUpOptions
wantArgs string
wantError bool
}{
{
name: "success",
logFile: "up.log",
workspace: "/test/workspace",
wantArgs: "up --log-format json --workspace-folder /test/workspace",
wantError: false,
},
{
name: "success with config",
logFile: "up.log",
workspace: "/test/workspace",
config: "/test/config.json",
wantArgs: "up --log-format json --workspace-folder /test/workspace --config /test/config.json",
wantError: false,
},
{
name: "already exists",
logFile: "up-already-exists.log",
workspace: "/test/workspace",
wantArgs: "up --log-format json --workspace-folder /test/workspace",
wantError: false,
},
{
name: "docker error",
logFile: "up-error-docker.log",
workspace: "/test/workspace",
wantArgs: "up --log-format json --workspace-folder /test/workspace",
wantError: true,
},
{
name: "bad outcome",
logFile: "up-error-bad-outcome.log",
workspace: "/test/workspace",
wantArgs: "up --log-format json --workspace-folder /test/workspace",
wantError: true,
},
{
name: "does not exist",
logFile: "up-error-does-not-exist.log",
workspace: "/test/workspace",
wantArgs: "up --log-format json --workspace-folder /test/workspace",
wantError: true,
},
{
name: "with remove existing container",
logFile: "up.log",
workspace: "/test/workspace",
opts: []agentcontainers.DevcontainerCLIUpOptions{
agentcontainers.WithRemoveExistingContainer(),
//nolint:paralleltest // This test is not parallel-safe due to t.Setenv.
t.Run("Up", func(t *testing.T) {
tests := []struct {
name string
logFile string
workspace string
config string
opts []agentcontainers.DevcontainerCLIUpOptions
wantArgs string
wantError bool
}{
{
name: "success",
logFile: "up.log",
workspace: "/test/workspace",
wantArgs: "up --log-format json --workspace-folder /test/workspace",
wantError: false,
},
wantArgs: "up --log-format json --workspace-folder /test/workspace --remove-existing-container",
wantError: false,
},
}
{
name: "success with config",
logFile: "up.log",
workspace: "/test/workspace",
config: "/test/config.json",
wantArgs: "up --log-format json --workspace-folder /test/workspace --config /test/config.json",
wantError: false,
},
{
name: "already exists",
logFile: "up-already-exists.log",
workspace: "/test/workspace",
wantArgs: "up --log-format json --workspace-folder /test/workspace",
wantError: false,
},
{
name: "docker error",
logFile: "up-error-docker.log",
workspace: "/test/workspace",
wantArgs: "up --log-format json --workspace-folder /test/workspace",
wantError: true,
},
{
name: "bad outcome",
logFile: "up-error-bad-outcome.log",
workspace: "/test/workspace",
wantArgs: "up --log-format json --workspace-folder /test/workspace",
wantError: true,
},
{
name: "does not exist",
logFile: "up-error-does-not-exist.log",
workspace: "/test/workspace",
wantArgs: "up --log-format json --workspace-folder /test/workspace",
wantError: true,
},
{
name: "with remove existing container",
logFile: "up.log",
workspace: "/test/workspace",
opts: []agentcontainers.DevcontainerCLIUpOptions{
agentcontainers.WithRemoveExistingContainer(),
},
wantArgs: "up --log-format json --workspace-folder /test/workspace --remove-existing-container",
wantError: false,
},
}

for _, tt := range tests {
//nolint:paralleltest // This test is not parallel-safe due t.Setenv.
t.Run(tt.name, func(t *testing.T) {
ctx := testutil.Context(t, testutil.WaitShort)

// Set environment variables for the test helper.
t.Setenv("TEST_DEVCONTAINER_WANT_ARGS", tt.wantArgs)
t.Setenv("TEST_DEVCONTAINER_WANT_ERROR", fmt.Sprintf("%v", tt.wantError))
t.Setenv("TEST_DEVCONTAINER_LOG_FILE", filepath.Join("testdata", "devcontainercli", "parse", tt.logFile))

dccli := agentcontainers.NewDevcontainerCLI(logger, testExecer)
containerID, err := dccli.Up(ctx, tt.workspace, tt.config, tt.opts...)
if tt.wantError {
assert.Error(t, err, "want error")
assert.Empty(t, containerID, "expected empty container ID")
} else {
assert.NoError(t, err, "want no error")
assert.NotEmpty(t, containerID, "expected non-empty container ID")
}
})
}
for _, tt := range tests {
//nolint:paralleltest // This test is not parallel-safe due t.Setenv.
t.Run(tt.name, func(t *testing.T) {
ctx := testutil.Context(t, testutil.WaitShort)

// Set environment variables for the test helper.
t.Setenv("TEST_DEVCONTAINER_WANT_ARGS", tt.wantArgs)
t.Setenv("TEST_DEVCONTAINER_WANT_ERROR", fmt.Sprintf("%v", tt.wantError))
t.Setenv("TEST_DEVCONTAINER_LOG_FILE", filepath.Join("testdata", "devcontainercli", "parse", tt.logFile))

dccli := agentcontainers.NewDevcontainerCLI(logger, testExecer)
containerID, err := dccli.Up(ctx, tt.workspace, tt.config, tt.opts...)
if tt.wantError {
assert.Error(t, err, "want error")
assert.Empty(t, containerID, "expected empty container ID")
} else {
assert.NoError(t, err, "want no error")
assert.NotEmpty(t, containerID, "expected non-empty container ID")
}
})
}
})
}

// testDevcontainerExecer implements the agentexec.Execer interface for testing.
Expand Down