Skip to content

Commit 85caf3f

Browse files
committed
test: update README for system test
Clarify that system test specifc configuration must be done via config files and not via ad hoc environment variables like in test/e2e. Also not that we only run the tests with crun so other runtimes may not work but we accept patches to make them work with runc, e.g. Suse folks currently run them with runc and contribute patches for them. Signed-off-by: Paul Holzinger <[email protected]>
1 parent 4e65ed5 commit 85caf3f

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

test/README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,8 @@ The following environment variables are supported by the test setup:
9191
- `PODMAN_DB`: the database backend `sqlite` (default) or `boltdb`.
9292
- `PODMAN_TEST_IMAGE_CACHE_DIR`: path were the container images should be cached, defaults to `/tmp`.
9393

94+
Note: These variables are used by the integration tests (test/e2e) only not the system tests (test/system).
95+
9496
### Running a single file of integration tests
9597
You can run a single file of integration tests using the go test command:
9698

@@ -143,7 +145,16 @@ System tests are used for testing the *podman* CLI in the context of a complete
143145
requires that *podman*, all dependencies, and configurations are in place. The intention of
144146
system testing is to match as closely as possible with real-world user/developer use-cases
145147
and environments. The orchestration of the environments and tests is left to external
146-
tooling.
148+
tooling. To test a specific oci runtime it should be set in containers.conf.
149+
(Note, upstream only tests with crun, there is no guarantee that tests will pass with another
150+
runtime. We will accept patches to make the tests work with runc, e.g. mostly error message
151+
checks, but not other runtimes due to the high maintenance overhead.)
152+
153+
Only the following env vars are supported:
154+
- `PODMAN`: path to the podman binary, defaults to `podman` in $PATH.
155+
- `QUADLET`: path to the quadlet binary, defaults to `/usr/libexec/podman/quadlet`.
156+
- `PODMAN_TESTING`: path to the podman-testing binary, defaults to `../../bin/podman-testing` from the system test directory.
157+
Note, the binary is used for testing purposes only and is not expected to be shipped to end users.
147158

148159
System tests use Bash Automated Testing System (`bats`) as a testing framework.
149160
Install it via your package manager or get latest stable version

0 commit comments

Comments
 (0)