Skip to content

Commit afe2421

Browse files
committed
Improved header comment explaining the relationship between the makefile targets, test config and test environment docker compose file.
1 parent a3f5df6 commit afe2421

1 file changed

Lines changed: 6 additions & 5 deletions

File tree

src/tests/multi-server/all.mk

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
11
#
22
# all.mk for multi-server tests
33
#
4-
# Test targets map to a test YAML of the same name, and to a Docker Compose "env" YAML.
4+
# Test targets map testcase variants to a common environment compose file.
5+
#
6+
# For example, the test target "test-5hs-autoaccept", "test-5hs-autoaccept-5min" or
7+
# "test-5hs-autoaccept-variant3" all map to the same compose environment. This is
8+
# done on purpose to allow multiple test variants to share the same base docker compose
9+
# environment, while still having unique test YAML files.
510
#
611
# Examples:
712
# make test-5hs-autoaccept
@@ -21,10 +26,6 @@
2126
# - Convert "test-..." to "environments/docker-compose/env-....yml".
2227
# - If that env file does not exist, strip the last "-suffix" segment and try again,
2328
# repeating until a matching env file is found.
24-
#
25-
# This lets you create any number of variant tests (e.g. -5min, -variant3, -foo-bar-baz)
26-
# that reuse the same base compose environment, while still keeping a unique test YAML
27-
# per variant.
2829

2930
# Find ENV compose file by stripping trailing "-suffix" chunks until a match exists.
3031
# Returns: environments/docker-compose/env-<base-without-test->.yml

0 commit comments

Comments
 (0)