8000 chore: improve logging around lifecycle scripts by johnstcn · Pull Request #420 · coder/envbuilder · GitHub
[go: up one dir, main page]
Skip to content

chore: improve logging around lifecycle scripts #420

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 3 commits into from
Nov 22, 2024
Merged

chore: improve logging around lifecycle scripts #420

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b2e6052
chore(integration): improve integration tests around lifecycle scripts
johnstcn Nov 22, 2024
b11a22e
chore: improve logging around lifecycle scripts
johnstcn Nov 22, 2024
7079121
address PR comments
johnstcn Nov 22, 2024
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
Next Next commit
chore(integration): improve integration tests around lifecycle scripts
  • Loading branch information
@johnstcn
johnstcn committed Nov 22, 2024
commit b2e60525feaabb4c6631d994fdc9d1eb393f90a9
111 changes: 81 additions & 30 deletions integration/integration_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1188,37 +1188,88 @@ func TestBuildSecrets(t *testing.T) {
func TestLifecycleScripts(t *testing.T) {
t.Parallel()

// Ensures that a Git repository with a devcontainer.json is cloned and built.
srv := gittest.CreateGitServer(t, gittest.Options{
Files: map[string]string{
".devcontainer/devcontainer.json": `{
"name": "Test",
"build": {
"dockerfile": "Dockerfile"
},
"onCreateCommand": "echo create > /tmp/out",
"updateContentCommand": ["sh", "-c", "echo update >> /tmp/out"],
"postCreateCommand": "(echo -n postCreate. ; id -un) >> /tmp/out",
"postStartCommand": {
"parallel1": "echo parallel1 > /tmp/parallel1",
"parallel2": ["sh", "-c", "echo parallel2 > /tmp/parallel2"]
}
}`,
".devcontainer/Dockerfile": "FROM " + testImageAlpine + "\nUSER nobody",
for _, tt := range []struct {
name string
files map[string]string
outputCmd string
expectOutput string
}{
{
name: "build",
files: map[string]string{
".devcontainer/devcontainer.json": `{
"name": "Test",
"build": {
"dockerfile": "Dockerfile"
},
"onCreateCommand": "echo create > /tmp/out",
"updateContentCommand": ["sh", "-c", "echo update >> /tmp/out"],
"postCreateCommand": "(echo -n postCreate. ; id -un) >> /tmp/out",
"postStartCommand": {
"parallel1": "echo parallel1 > /tmp/parallel1",
"parallel2": ["sh", "-c", "echo parallel2 > /tmp/parallel2"]
}
}`,
".devcontainer/Dockerfile": "FROM " + testImageAlpine + "\nUSER nobody",
},
outputCmd: "cat /tmp/out /tmp/parallel1 /tmp/parallel2",
expectOutput: "create\nupdate\npostCreate.nobody\nparallel1\nparallel2",
},
})
ctr, err := runEnvbuilder(t, runOpts{env: []string{
envbuilderEnv("GIT_URL", srv.URL),
}})
require.NoError(t, err)

output := execContainer(t, ctr, "cat /tmp/out /tmp/parallel1 /tmp/parallel2")
require.Equal(t,
`create
update
postCreate.nobody
parallel1
parallel2`, strings.TrimSpace(output))
{
name: "image",
files: map[string]string{
".devcontainer/devcontainer.json": fmt.Sprintf(`{
"name": "Test",
"image": %q,
"containerUser": "nobody",
"onCreateCommand": "echo create > /tmp/out",
"updateContentCommand": ["sh", "-c", "echo update >> /tmp/out"],
"postCreateCommand": "(echo -n postCreate. ; id -un) >> /tmp/out",
"postStartCommand": {
"parallel1": "echo parallel1 > /tmp/parallel1",
"parallel2": ["sh", "-c", "echo parallel2 > /tmp/parallel2"]
}
}`, testImageAlpine),
},
outputCmd: "cat /tmp/out /tmp/parallel1 /tmp/parallel2",
expectOutput: "create\nupdate\npostCreate.nobody\nparallel1\nparallel2",
},
{
name: "label",
files: map[string]string{
".devcontainer/Dockerfile": fmt.Sprintf(`FROM %s
LABEL devcontainer.metadata='[{ \
"onCreateCommand": "echo create > /tmp/out", \
"updateContentCommand": ["sh", "-c", "echo update >> /tmp/out"], \
"postCreateCommand": "(echo -n postCreate. ; id -un) >> /tmp/out", \
"postStartCommand": { \
"parallel1": "echo parallel1 > /tmp/parallel1", \
"parallel2": ["sh", "-c", "echo parallel2 > /tmp/parallel2"] \
} \
}]'
USER nobody`, testImageAlpine),
},
outputCmd: "cat /tmp/out /tmp/parallel1 /tmp/parallel2",
expectOutput: "create\nupdate\npostCreate.nobody\nparallel1\nparallel2",
},
} {
tt := tt
t.Run(tt.name, func(t *testing.T) {
srv := gittest.CreateGitServer(t, gittest.Options{
Files: tt.files,
})
env := []string{
envbuilderEnv("GIT_URL", srv.URL),
}
if _, ok := tt.files[".devcontainer/devcontainer.json"]; !ok {
env = append(env, envbuilderEnv("DOCKERFILE_PATH", ".devcontainer/Dockerfile"))
}
ctr, err := runEnvbuilder(t, runOpts{env: env})
require.NoError(t, err, "failed to run envbuilder")
output := execContainer(t, ctr, tt.outputCmd)
require.Equal(t, tt.expectOutput, strings.TrimSpace(output))
})
}
}

func TestPostStartScript(t *testing.T) {
Expand Down
0