mirror of
https://github.com/docker/compose.git
synced 2026-10-12 02:13:08 +00:00
Nicolas De Loof
7af58e3626
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 <[email protected]>
58 lines
1.7 KiB
Go
58 lines
1.7 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 (
|
|
"os"
|
|
"path/filepath"
|
|
"regexp"
|
|
"testing"
|
|
|
|
"gotest.tools/v3/assert"
|
|
)
|
|
|
|
// TestTestdataDirsAreOwned enforces the testdata convention: every top-level
|
|
// testdata/<Name>/ directory belongs to exactly one test function of this
|
|
// package, resolved by name. This is what keeps testdata from degrading into
|
|
// a catch-all fixtures directory: a renamed or removed test cannot leave its
|
|
// files behind, and files cannot be shared between tests.
|
|
func TestTestdataDirsAreOwned(t *testing.T) {
|
|
declared := map[string]bool{}
|
|
testFn := regexp.MustCompile(`(?m)^func (Test\w+)\(`)
|
|
sources, err := filepath.Glob("*_test.go")
|
|
assert.NilError(t, err)
|
|
for _, src := range sources {
|
|
data, err := os.ReadFile(src)
|
|
assert.NilError(t, err)
|
|
for _, m := range testFn.FindAllStringSubmatch(string(data), -1) {
|
|
declared[m[1]] = true
|
|
}
|
|
}
|
|
|
|
entries, err := os.ReadDir("testdata")
|
|
assert.NilError(t, err)
|
|
for _, e := range entries {
|
|
if !e.IsDir() {
|
|
continue
|
|
}
|
|
assert.Assert(t, declared[e.Name()],
|
|
"testdata/%s is owned by no test of this package: name it after its test, or delete it", e.Name())
|
|
}
|
|
}
|