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
update comments
  • Loading branch information
@mafredri
mafredri committed Apr 9, 2025
commit db6157ed0cca3a053b06ed0934f50f88f1b40fdb
33 changes: 16 additions & 17 deletions agent/agentcontainers/devcontainercli_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,14 +130,14 @@ type testDevcontainerExecer struct {

// CommandContext returns a test binary command that simulates devcontainer responses.
func (e *testDevcontainerExecer) CommandContext(ctx context.Context, name string, args ...string) *exec.Cmd {
// Only handle "devcontainer" commands
// Only handle "devcontainer" commands.
if name != "devcontainer" {
// For non-devcontainer commands, we use a standard execer
// For non-devcontainer commands, use a standard execer.
return agentexec.DefaultExecer.CommandContext(ctx, name, args...)
}

// Create a command that runs the test binary with special flags
// that tell it to simulate a devcontainer command
// that tell it to simulate a devcontainer command.
testArgs := []string{
"-test.run=TestDevcontainerHelperProcess",
"--",
Expand All @@ -147,15 +147,15 @@ func (e *testDevcontainerExecer) CommandContext(ctx context.Context, name string

//nolint:gosec // This is a test binary, so we don't need to worry about command injection.
cmd := exec.CommandContext(ctx, e.testExePath, testArgs...)
// Set this environment variable so the child process knows it's the helper
// Set this environment variable so the child process knows it's the helper.
cmd.Env = append(os.Environ(), "TEST_DEVCONTAINER_WANT_HELPER_PROCESS=1")

return cmd
}

// PTYCommandContext returns a PTY command.
func (*testDevcontainerExecer) PTYCommandContext(_ context.Context, name string, args ...string) *pty.Cmd {
// This method shouldn't be called for our devcontainer tests
// This method shouldn't be called for our devcontainer tests.
panic("PTYCommandContext not expected in devcontainer tests")
}

Expand All @@ -164,7 +164,7 @@ func (*testDevcontainerExecer) PTYCommandContext(_ context.Context, name string,
//
//nolint:revive,paralleltest // This is a test helper function.
func TestDevcontainerHelperProcess(t *testing.T) {
// If not called by the test as a helper process, run normally
// If not called by the test as a helper process, do nothing.
if os.Getenv("TEST_DEVCONTAINER_WANT_HELPER_PROCESS") != "1" {
return
}
Expand All @@ -175,17 +175,15 @@ func TestDevcontainerHelperProcess(t *testing.T) {
os.Exit(2)
}

// Check if it's a devcontainer command
if helperArgs[0] != "devcontainer" {
fmt.Fprintf(os.Stderr, "Unknown command: %s\n", helperArgs[0])
os.Exit(2)
}

// Verify arguments against expected arguments
// Verify arguments against expected arguments and skip
// "devcontainer", it's not included in the input args.
wantArgs := os.Getenv("TEST_DEVCONTAINER_WANT_ARGS")
// Get the actual arguments (skip "devcontainer").
gotArgs := strings.Join(helperArgs[1:], " ")

if gotArgs != wantArgs {
fmt.Fprintf(os.Stderr, "Arguments don't match.\nWant: %q\nGot: %q\n",
wantArgs, gotArgs)
Expand Down Expand Up @@ -270,17 +268,17 @@ func TestDockerDevcontainerCLI(t *testing.T) {
})
}

// setupDevcontainerWorkspace creates a minimal devcontainer.json file
// in the workspace directory and returns its path.
// setupDevcontainerWorkspace prepares a test environment with a minimal
// devcontainer.json configuration and returns the path to the config file.
func setupDevcontainerWorkspace(t *testing.T, workspaceFolder string) string {
t.Helper()

// Create .devcontainer directory.
// Create the devcontainer directory structure.
devcontainerDir := filepath.Join(workspaceFolder, ".devcontainer")
err := os.MkdirAll(devcontainerDir, 0o755)
require.NoError(t, err, "create .devcontainer directory")

// Create a minimal devcontainer.json file with a test-specific label.
// Write a minimal configuration with test labels for identification.
configPath := filepath.Join(devcontainerDir, "devcontainer.json")
content := `{
"image": "alpine:latest",
Expand All @@ -295,8 +293,8 @@ func setupDevcontainerWorkspace(t *testing.T, workspaceFolder string) string {
return configPath
}

// findDevcontainerByID finds a container by ID and returns it along with a boolean
// indicating whether it was found.
// findDevcontainerByID locates a container by its ID and verifies it has our
// test label. Returns the container and whether it was found.
func findDevcontainerByID(t *testing.T, pool *dockertest.Pool, id string) (*docker.Container, bool) {
t.Helper()

Expand All @@ -310,7 +308,8 @@ func findDevcontainerByID(t *testing.T, pool *dockertest.Pool, id string) (*dock
return container, true
}

// removeDevcontainerByID removes the test devcontainer if it exists.
// removeDevcontainerByID safely cleans up a test container by ID, verifying
// it has our test label before removal to prevent accidental deletion.
func removeDevcontainerByID(t *testing.T, pool *dockertest.Pool, id string) {
t.Helper()

Expand Down
Loading