mirror of
https://github.com/docker/compose.git
synced 2026-11-17 13:45:39 +00:00
test(e2e): lock pre_start's streamed output and tighten the foreground up scenarios
A foreground up does stream a pre_start hook's output into the session since the hook's log stream is opened once it is started. The hook scenario had stopped asserting it on the belief it never did; its fixture only wrote to a file, so nothing could reach stdout. The pre_start now also prints a marker the service never logs, asserted on stdout, and the scenario states a single intent covering both hooks. Also tighten the scenarios after review: - assert a container's printed output on stdout rather than on the whole output, and add the state or negative checks that were missing (ContainerEnv after a recreation, web exited once its dependency was healthy, no output of the replaced container); - the dependency timeout scenario carries the "deadline exceeded" guard of its detached counterpart, with a fixture aligned on it; - drop the abort message and the useless wait from the immediate-exit scenario: up only returns once the application is stopped; - rename the dry-run scenario after the others, minimize its fixture and stop coupling it to the dry-run end-of-output wording; - explain the sleeps of the fixtures, and give the hook one a larger margin; - build tag e2e only: nothing here is Unix-specific. Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
This commit is contained in:
parent
b9aedc5384
commit
34cae9461c
6 changed files with 31 additions and 31 deletions
|
|
@ -1,5 +0,0 @@
|
|||
services:
|
||||
app:
|
||||
image: alpine
|
||||
command: sleep infinity
|
||||
init: true
|
||||
|
|
@ -2,11 +2,9 @@ services:
|
|||
db:
|
||||
image: alpine
|
||||
command: sleep infinity
|
||||
init: true
|
||||
healthcheck:
|
||||
test: ["CMD", "false"]
|
||||
interval: 1s
|
||||
timeout: 1s
|
||||
retries: 100
|
||||
web:
|
||||
image: alpine
|
||||
|
|
|
|||
3
pkg/e2e/testdata/TestUpInteractiveDryRun/compose.yaml
vendored
Normal file
3
pkg/e2e/testdata/TestUpInteractiveDryRun/compose.yaml
vendored
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
services:
|
||||
app:
|
||||
image: alpine
|
||||
|
|
@ -1,12 +1,16 @@
|
|||
services:
|
||||
app:
|
||||
image: alpine
|
||||
command: sh -c 'echo "app-read:$(cat /shared/init.txt)"; sleep 3'
|
||||
# the sleep keeps the container running while post_start execs into it and
|
||||
# the session streams its output
|
||||
command: sh -c 'echo "app-read:$(cat /shared/init.txt)"; sleep 5'
|
||||
volumes:
|
||||
- data:/shared
|
||||
pre_start:
|
||||
- image: alpine
|
||||
command: sh -c 'echo "pre-start-file-content" > /shared/init.txt'
|
||||
# prints a marker the service never logs, so its presence in the
|
||||
# session can only come from the hook's own output stream
|
||||
command: sh -c 'echo pre-start-hook-stdout; echo "pre-start-file-content" > /shared/init.txt'
|
||||
post_start:
|
||||
- command: echo post-start-hook-ran
|
||||
volumes:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
services:
|
||||
app:
|
||||
image: alpine
|
||||
# the sleep keeps the container running while the session attaches to it
|
||||
command: sh -c 'echo "value=$VALUE"; sleep 2'
|
||||
environment:
|
||||
VALUE: ${VALUE:-one}
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
//go:build e2e && !windows
|
||||
//go:build e2e
|
||||
|
||||
/*
|
||||
Copyright 2026 Docker Compose CLI authors
|
||||
|
|
@ -23,20 +23,16 @@ import (
|
|||
"time"
|
||||
)
|
||||
|
||||
// The scenarios below lock the observable behavior of the foreground
|
||||
// (non-detached) `compose up`, whose create and start phases are driven by two
|
||||
// separate code paths today. They exist so a change of the machinery behind
|
||||
// it (epic #14081, lot 2) can be reviewed against a fixed specification.
|
||||
// Most e2e coverage of the start phase runs detached; these do not.
|
||||
// Scenarios locking the observable behavior of the foreground (non-detached)
|
||||
// `compose up`. Most e2e coverage of the start phase runs detached.
|
||||
|
||||
// pre_start output is not asserted: a foreground up does not stream it into the
|
||||
// session today, only post_start's. What is locked for pre_start is its effect.
|
||||
func TestUpInteractiveHookLogs(t *testing.T) {
|
||||
NewScenario(t, "a foreground up must run pre_start before the service starts and stream post_start output into its session").
|
||||
Step("up shows post_start's output, and the service reads what pre_start wrote before it started",
|
||||
NewScenario(t, "a foreground up must run the hooks around the service and stream their output into its session").
|
||||
Step("up shows both hooks' output, and the service reads what pre_start wrote before it started",
|
||||
ComposeCmd("up", "--menu=false").Within(120*time.Second),
|
||||
OutputContains("app-read:pre-start-file-content"),
|
||||
OutputContains("post-start-hook-ran"),
|
||||
StdoutContains("pre-start-hook-stdout"),
|
||||
StdoutContains("app-read:pre-start-file-content"),
|
||||
StdoutContains("post-start-hook-ran"),
|
||||
ServiceState("app", "exited"))
|
||||
}
|
||||
|
||||
|
|
@ -45,9 +41,8 @@ func TestUpInteractiveImmediateExit(t *testing.T) {
|
|||
Step("up aborts on the instantly exiting container instead of waiting for the long-running one",
|
||||
ComposeCmd("up", "--menu=false", "--abort-on-container-exit").Within(60*time.Second),
|
||||
OutputContains("quick-1 exited with code 0"),
|
||||
OutputContains("Aborting on container exit"),
|
||||
ServiceState("quick", "exited"),
|
||||
Eventually(ServiceState("long", "exited"), 10*time.Second))
|
||||
ServiceState("long", "exited"))
|
||||
}
|
||||
|
||||
func TestUpInteractiveRestartsExitedContainer(t *testing.T) {
|
||||
|
|
@ -58,7 +53,7 @@ func TestUpInteractiveRestartsExitedContainer(t *testing.T) {
|
|||
Step("a foreground up runs the same container a second time",
|
||||
ComposeCmd("up", "--menu=false").Within(60*time.Second),
|
||||
NotRecreated("app"),
|
||||
OutputContains("second-run"),
|
||||
StdoutContains("second-run"),
|
||||
ServiceState("app", "exited"))
|
||||
}
|
||||
|
||||
|
|
@ -66,8 +61,9 @@ func TestUpInteractiveWaitsForHealthy(t *testing.T) {
|
|||
NewScenario(t, "a foreground up must not start a service before its service_healthy dependency is healthy").
|
||||
Step("up starts web only once db reports healthy",
|
||||
ComposeCmd("up", "--menu=false", "--abort-on-container-exit").Within(120*time.Second),
|
||||
OutputContains("web-saw-ready"),
|
||||
OutputNotContains("web-too-early"))
|
||||
StdoutContains("web-saw-ready"),
|
||||
OutputNotContains("web-too-early"),
|
||||
ServiceState("web", "exited"))
|
||||
}
|
||||
|
||||
func TestUpInteractiveRecreateStreamsNewContainer(t *testing.T) {
|
||||
|
|
@ -78,15 +74,18 @@ func TestUpInteractiveRecreateStreamsNewContainer(t *testing.T) {
|
|||
Step("a foreground up with another value recreates it and shows the new output",
|
||||
ComposeCmd("up", "--menu=false").WithEnv("VALUE=two").Within(60*time.Second),
|
||||
Recreated("app"),
|
||||
OutputContains("value=two"))
|
||||
ContainerEnv("app", "VALUE", "two"),
|
||||
StdoutContains("value=two"),
|
||||
OutputNotContains("value=one"))
|
||||
}
|
||||
|
||||
func TestUpInteractiveDependencyTimeout(t *testing.T) {
|
||||
NewScenario(t, "a foreground up with --wait-timeout must fail once a dependency stays unhealthy, without starting the dependent").
|
||||
Step("up fails on the dependency timeout; web is created but never started",
|
||||
Step("up fails on the dependency timeout; web exists but was never started",
|
||||
ComposeCmd("up", "--menu=false", "--wait-timeout", "3").MayFail().Within(60*time.Second),
|
||||
ExitCode(1),
|
||||
OutputContains("timeout waiting for dependencies"),
|
||||
OutputNotContains("deadline exceeded"),
|
||||
OutputNotContains("web-started"),
|
||||
ServiceState("db", "running"),
|
||||
// web's container is created in the create phase, before the start
|
||||
|
|
@ -95,12 +94,12 @@ func TestUpInteractiveDependencyTimeout(t *testing.T) {
|
|||
ServiceState("web", "created"))
|
||||
}
|
||||
|
||||
func TestUpDryRunCreatesNothing(t *testing.T) {
|
||||
s := NewScenario(t, "a foreground up --dry-run must plan the create phase only, never the start phase")
|
||||
func TestUpInteractiveDryRun(t *testing.T) {
|
||||
// the progress lines name the container after the project
|
||||
s := NewScenario(t, "a foreground up --dry-run must report the container creation, never start it and leave nothing behind")
|
||||
s.Step("up --dry-run reports the creation, no start, and leaves no container behind",
|
||||
ComposeCmd("up", "--menu=false", "--dry-run").Within(60*time.Second),
|
||||
OutputContains("Container "+s.Project()+"-app-1 Created"),
|
||||
OutputNotContains(s.Project()+"-app-1 Start"),
|
||||
OutputContains("interactive run is not supported in dry-run mode"),
|
||||
ServiceNotCreated("app"))
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue