0b5136c7ce
Amongst other things 030-run.bats checks for sensible error messages when
attempting a "podman run" with a non-existent or inaccessible path. It
checks for these messages, which come from the low-level runtime, in a lot
of detail, including separate versions for runc and crun. This is fragile
in several ways:
* It's likely to fail if using a runtime other than crun or runc
* It relies on detecting whether the runtime is crun vs. runc using the
path, which could fail if the binary has been named something unusual
* It will break if crun or runc ever alter their error message (even if
it's just changing case)
This replaces the checked versions with a much more accepting regex which
will work for both the runc and crun messages, while still looking for the
essential pieces. This isn't guaranteed to work with other runtimes, but
it's much more likely to.
Signed-off-by: David Gibson <david@gibson.dropbear.id.au>
|
||
|---|---|---|
| .. | ||
| 000-TEMPLATE | ||
| 001-basic.bats | ||
| 005-info.bats | ||
| 010-images.bats | ||
| 011-image.bats | ||
| 015-help.bats | ||
| 020-tag.bats | ||
| 030-run.bats | ||
| 035-logs.bats | ||
| 037-runlabel.bats | ||
| 040-ps.bats | ||
| 045-start.bats | ||
| 050-stop.bats | ||
| 055-rm.bats | ||
| 060-mount.bats | ||
| 065-cp.bats | ||
| 070-build.bats | ||
| 075-exec.bats | ||
| 080-pause.bats | ||
| 090-events.bats | ||
| 110-history.bats | ||
| 120-load.bats | ||
| 125-import.bats | ||
| 130-kill.bats | ||
| 140-diff.bats | ||
| 150-login.bats | ||
| 160-volumes.bats | ||
| 170-run-userns.bats | ||
| 180-blkio.bats | ||
| 200-pod.bats | ||
| 220-healthcheck.bats | ||
| 250-systemd.bats | ||
| 255-auto-update.bats | ||
| 260-sdnotify.bats | ||
| 270-socket-activation.bats | ||
| 271-tcp-cors-server.bats | ||
| 272-system-connection.bats | ||
| 300-cli-parsing.bats | ||
| 320-system-df.bats | ||
| 330-corrupt-images.bats | ||
| 400-unprivileged-access.bats | ||
| 410-selinux.bats | ||
| 420-cgroups.bats | ||
| 450-interactive.bats | ||
| 500-networking.bats | ||
| 520-checkpoint.bats | ||
| 600-completion.bats | ||
| 700-play.bats | ||
| build-testimage | ||
| helpers.bash | ||
| helpers.systemd.bash | ||
| helpers.t | ||
| README.md | ||
| TODO.md | ||
Quick overview of podman system tests. The idea is to use BATS, but with a framework for making it easy to add new tests and to debug failures.
Quick Start
Look at 030-run.bats for a simple but packed example. This introduces the basic set of helper functions:
-
setup(implicit) - resets container storage so there's one and only one (standard) image, and no running containers. -
parse_table- you can define tables of inputs and expected results, then read those in awhileloop. This makes it easy to add new tests. Because bash is not a programming language, the caller ofparse_tablesometimes needs to massage the returned values;015-run.batsoffers examples of how to deal with the more typical such issues. -
run_podman- runs command defined in$PODMAN(default: 'podman' but could also be './bin/podman' or 'podman-remote'), with a timeout. Checks its exit status. -
is- compare actual vs expected output. Emits a useful diagnostic on failure. -
die- output a properly-formatted message to stderr, and fail test -
skip_if_rootless- if rootless, skip this test with a helpful message. -
skip_if_remote- like the above, but skip if testingpodman-remote -
random_string- returns a pseudorandom alphanumeric string
Test files are of the form NNN-name.bats where NNN is a three-digit
number. Please preserve this convention, it simplifies viewing the
directory and understanding test order. In particular, 00x tests
should be reserved for a first-pass fail-fast subset of tests:
bats test/system/00*.bats || exit 1
bats test/system
...the goal being to provide quick feedback on catastrophic failures without having to wait for the entire test suite.
Running tests
To run the tests locally in your sandbox, you can use one of these methods:
- make;PODMAN=./bin/podman bats ./test/system/070-build.bats # runs just the specified test
- make;PODMAN=./bin/podman bats ./test/system # runs all
To test as root:
- $ PODMAN=./bin/podman sudo --preserve-env=PODMAN bats test/system
Analyzing test failures
The top priority for this scheme is to make it easy to diagnose
what went wrong. To that end, podman_run always logs all invoked
commands, their output and exit codes. In a normal run you will never
see this, but BATS will display it on failure. The goal here is to
give you everything you need to diagnose without having to rerun tests.
The is comparison function is designed to emit useful diagnostics,
in particular, the actual and expected strings. Please do not use
the horrible BATS standard of [ x = y ]; that's nearly useless
for tracking down failures.
If the above are not enough to help you track down a failure:
Debugging tests
Some functions have dprint statements. To see the output of these,
set PODMAN_TEST_DEBUG="funcname" where funcname is the name of
the function or perhaps just a substring.
Requirements
The jq tool is needed for parsing JSON output.
Further Details
TBD. For now, look in helpers.bash; each helper function
has (what are intended to be) helpful header comments. For even more
examples, see and/or run helpers.t; that's a regression test
and provides a thorough set of examples of how the helpers work.