compose/pkg/e2e/compose_exec_test.go
Nicolas De Loof 7af58e3626 test(e2e): gate the e2e suite behind the build tag the docs already promise
AGENTS.md documents 'Test unit: go test ./pkg/...' and 'E2E tests:
go test -tags e2e ./pkg/e2e/'. Both statements were false: no file in
pkg/e2e carried an e2e build constraint, so the -tags flag was a no-op
and the 'unit' command actually launched the full e2e suite — requiring
a Docker daemon and the locally built binary, creating and destroying
containers, for up to 20 minutes. CI only avoided this by grepping e2e
out of the package list (Dockerfile).

Every *_test.go in pkg/e2e now carries //go:build e2e (merged with the
existing !windows constraints), and the Makefile e2e targets pass the
tag. The documented commands become true:
- go test ./pkg/...          -> pkg/e2e reports [no test files]
- go test -tags e2e ./pkg/e2e -> runs the suite

AGENTS.md now also states the daemon/binary prerequisites explicitly.

Part of #14074 (A: the code misdescribes its own structure).

Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
2026-08-27 11:02:07 +02:00

55 lines
2.1 KiB
Go

//go:build e2e
/*
Copyright 2020 Docker Compose CLI authors
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package e2e
import (
"testing"
)
func TestLocalComposeExec(t *testing.T) {
NewScenario(t, "exec must run in the service container, propagate the exit code and pass only requested env").
Step("up starts the service",
ComposeCmd("up", "-d"),
ServiceState("simple", "running")).
Step("a successful command exits 0",
ComposeCmd("exec", "simple", "/bin/true")).
Step("a failing command's exit code is propagated",
ComposeCmd("exec", "simple", "/bin/false").MayFail(),
ExitCode(1)).
Step("exec -e forwards the variable when set on the caller",
ComposeCmd("exec", "-e", "FOO", "simple", "/usr/bin/env").WithEnv("FOO=BAR"),
OutputContains("FOO=BAR")).
Step("exec -e without a value does not leak an empty variable",
ComposeCmd("exec", "-e", "FOO", "simple", "/usr/bin/env"),
OutputNotContains("FOO="))
}
func TestLocalComposeExecOneOff(t *testing.T) {
NewScenario(t, "exec must reach a one-off container, but --index must only match numbered replicas").
Step("run starts a detached one-off",
ComposeCmd("run", "-d", "simple", "top"),
OneOffState("simple", "running")).
Step("exec lands in the one-off container",
ComposeCmd("exec", "-e", "FOO", "simple", "/usr/bin/env"),
OutputNotContains("FOO=")).
Step("exec --index rejects a one-off: it is not replica #1",
ComposeCmd("exec", "--index", "1", "-e", "FOO", "simple", "/usr/bin/env").MayFail(),
ExitCode(1),
OutputContains(`service "simple" is not running container #1`))
}