podman/test/system
Paul Holzinger 6069cdda00
healthcheck: do not leak statup service
The startup service is special because we have to transition from
startup to the normal unit. And in order to do so we kill ourselves (as
we are run as part of the service). This means we always exited 1 which
causes systemd to keep us failure and not remove the transient unit
unless "reset-failed" is called. As there is no process around to do
that we cannot really do this, thus make us exit(0) which makes more
sense.

Of course we could try to reset-failed the unit later but the code for
that seems more complicated than that.

Add a new test from Ed that ensures we check for all healthcheck units
not just the timer to avoid leaks. I slightly modified it to provide a
better error on leaks.

Fixes: 0bbef4b830 ("libpod: rework shutdown handler flow")
Fixes: #24351

Signed-off-by: Paul Holzinger <pholzing@redhat.com>
2024-10-25 13:47:59 +02:00
..
000-TEMPLATE CI: system tests: minor documentation on parallel 2024-09-18 11:32:36 -06:00
001-basic.bats libpod: cleanup store at shutdown 2024-07-15 11:41:28 +02:00
005-info.bats CI: require and test CI_DESIRED_NETWORK on RHEL 2024-10-01 10:44:07 -06:00
010-images.bats Try to repair c/storage after removing an additional image store 2024-10-22 19:36:03 +02:00
011-image.bats system tests: add and use _prefetch 2023-06-26 06:51:01 -06:00
012-manifest.bats CI: make 012-manifest parallel-safe 2024-09-17 10:35:01 -06:00
015-help.bats CI: system tests: parallelize low-hanging fruit 2024-09-03 14:22:01 -06:00
020-tag.bats CI: make 020-tag parallel-safe 2024-09-09 13:37:57 -06:00
030-run.bats test: set soft ulimit 2024-10-22 12:05:07 +02:00
032-sig-proxy.bats System tests: add test tags 2023-07-26 13:50:33 -06:00
035-logs.bats CI: parallelize logs test as much as possible 2024-09-23 13:46:00 -06:00
037-runlabel.bats Also substitute $HOME in runlabel with user's homedir 2024-05-03 14:00:20 +02:00
040-ps.bats CI: system tests: instrument to allow failure analysis 2024-07-23 12:58:58 -06:00
045-start.bats test/system: fix up many tests that do not cleanup 2024-06-18 11:06:49 +02:00
050-stop.bats CI: 050-stop.bats: make parallel-safe 2024-08-12 12:00:09 -06:00
055-rm.bats 055-rm test: clean up a test, and document 2024-10-07 15:22:49 -06:00
060-mount.bats Add workaround for buildah parallel bug 2024-09-17 11:19:37 -06:00
065-cp.bats CI: system tests: parallelize low-hanging fruit 2024-09-03 14:22:01 -06:00
070-build.bats Merge pull request #22967 from rhatdan/build 2024-06-21 19:27:36 +00:00
075-exec.bats CI: system tests: parallelize low-hanging fruit 2024-09-03 14:22:01 -06:00
080-pause.bats CI: 080-pause.bats: make parallel-safe 2024-08-12 12:05:27 -06:00
085-top.bats Fix output of podman --remote top 2023-10-16 17:25:10 -04:00
090-events.bats CI: fix changing-rootFsSize flake 2024-10-15 05:14:49 -06:00
110-history.bats CI: make 110-history parallel-safe 2024-09-03 14:41:46 -06:00
120-load.bats Improve "podman load - from URL" 2024-10-22 19:36:14 +02:00
125-import.bats CI: make 125-import parallel-safe 2024-09-03 14:44:27 -06:00
130-kill.bats CI: make 130-kill parallel-safe 2024-09-03 14:46:55 -06:00
140-diff.bats Replace egrep/fgrep with grep -E/-F 2023-05-03 07:32:42 -06:00
150-login.bats Use the config digest to compare images loaded/pulled using different methods 2024-10-22 19:36:02 +02:00
160-volumes.bats Run codespell on source 2024-07-23 07:28:23 -04:00
170-run-userns.bats libpod: hasCurrentUserMapped checks for gid too 2024-10-04 16:17:04 +02:00
180-blkio.bats CI: reenable tests that are working again 2024-01-16 10:07:48 -07:00
190-run-ipcns.bats System tests: add test tags 2023-07-26 13:50:33 -06:00
195-run-namespaces.bats CI: parallel-safe namespaces system test 2024-08-21 05:36:04 -06:00
200-pod.bats CI: make 200-pod parallel-safe 2024-09-18 06:25:18 -06:00
220-healthcheck.bats healthcheck: do not leak statup service 2024-10-25 13:47:59 +02:00
250-systemd.bats CI: make systemd tests parallel-safe (*) 2024-09-24 06:13:50 -06:00
251-system-service.bats Add test for legacy address without two slashes 2023-09-12 10:42:27 +02:00
252-quadlet.bats quadlet: ensure user units wait for the network 2024-10-18 11:43:48 +02:00
255-auto-update.bats test/system: fix up many tests that do not cleanup 2024-06-18 11:06:49 +02:00
260-sdnotify.bats System tests: sdnotify: wait for socket file creation 2024-10-01 14:50:16 -06:00
270-socket-activation.bats Vendor latest c/common and fix tests 2024-02-29 12:16:51 -05:00
271-tcp-cors-server.bats CORS system test: clean up 2024-09-25 07:46:07 -06:00
272-system-connection.bats remote: fix incorrect CONTAINER_CONNECTION parsing 2024-06-21 14:01:22 +02:00
280-update.bats System test fixes 2024-07-04 06:13:02 -06:00
300-cli-parsing.bats Run codespell on code 2024-01-28 07:30:52 -05:00
320-system-df.bats pasta udp tests: new bytecheck helper 2024-10-16 10:15:19 -06:00
330-corrupt-images.bats Fix 330-corrupt-images.bats in composefs test runs 2024-10-18 23:44:04 +02:00
331-system-check.bats System tests: add `podman system check` tests 2024-06-04 10:00:37 -04:00
400-unprivileged-access.bats CI: test overlay and vfs 2023-11-17 05:48:50 -07:00
410-selinux.bats CI: make 410-selinux parallel-safe 2024-09-09 13:09:37 -06:00
420-cgroups.bats CI: system tests: parallelize low-hanging fruit 2024-09-03 14:22:01 -06:00
450-interactive.bats test/system: fix up many tests that do not cleanup 2024-06-18 11:06:49 +02:00
500-networking.bats Misc minor test fixes 2024-09-17 11:19:37 -06:00
505-networking-pasta.bats test/system: Fix spurious "duplicate tests" failures in pasta tests 2024-10-23 14:02:53 +11:00
520-checkpoint.bats restore: fix missing network setup 2024-06-24 18:52:02 +02:00
550-pause-process.bats System tests: set a default XDG_RUNTIME_DIR 2024-09-25 12:45:17 -06:00
600-completion.bats CI: system tests: parallelize low-hanging fruit 2024-09-03 14:22:01 -06:00
610-format.bats CI: format test: use local registry if available 2024-09-23 07:48:35 -06:00
620-option-conflicts.bats CI: system tests: parallelize low-hanging fruit 2024-09-03 14:22:01 -06:00
700-play.bats CI: make 700-play parallel-safe 2024-09-23 05:27:45 -06:00
710-kube.bats CI: make 710-kube parallel-safe 2024-09-10 14:49:14 -06:00
750-trust.bats system tests: add assert(), and start using it 2022-04-20 16:14:42 -06:00
760-system-renumber.bats sqlite_state: Fix RewriteVolumeConfig 2024-06-20 11:39:44 +02:00
800-config.bats podman wait: allow waiting for removal of containers 2024-08-16 15:44:02 +02:00
850-compose.bats podman compose: only trim path suffix when ssh protocol 2024-02-27 13:44:26 +01:00
900-ssh.bats ssh system test: skip until it becomes a test 2022-11-21 08:02:00 -07:00
950-preexec-hooks.bats Add file swith for pre-exec 2023-04-26 10:20:10 -04:00
999-final.bats systests: add a last-minute check for db backend 2023-11-06 14:15:28 -07:00
README.md Update system test template and README 2024-09-17 11:19:37 -06:00
build-systemd-image new testimage and systemd-image 2024-02-09 05:26:07 -07:00
build-testimage pasta udp tests: new bytecheck helper 2024-10-16 10:15:19 -06:00
helpers.bash Use the config digest to compare images loaded/pulled using different methods 2024-10-22 19:36:02 +02:00
helpers.network.bash CI: system tests: make random_free_port() parallel-safe 2024-08-15 10:04:51 -06:00
helpers.registry.bash CI: system test registry: use --net=host 2024-09-19 05:17:15 -06:00
helpers.sig-proxy.bash pkg/rootless: correctly handle proxy signals on reexec 2023-05-25 16:48:15 +02:00
helpers.systemd.bash System tests: set a default XDG_RUNTIME_DIR 2024-09-25 12:45:17 -06:00
helpers.t CI: system tests: make random_free_port() parallel-safe 2024-08-15 10:04:51 -06:00
setup_suite.bash test/system: netns leak check for rootless as well 2024-09-18 12:07:11 +02:00

README.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 000-TEMPLATE for a simple starting point. This introduces the basic set of helper functions:

  • setup (implicit) - establishes a test environment.

  • parse_table - you can define tables of inputs and expected results, then read those in a while loop. This makes it easy to add new tests. Because bash is not a programming language, the caller of parse_table sometimes needs to massage the returned values; 030-run.bats offers 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.

  • assert - 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 testing podman-remote

  • safename - generates a pseudorandom lower-case string suitable for use in names for containers, images, volumes, any object. String includes the BATS test number, making it possible to identify the source of leaks (failure to clean up) at the end of tests.

  • random_string - returns a pseudorandom alphanumeric string suitable for verifying I/O.

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 using hack/bats is recommend, check hack/bats --help for info about usage.

To run the entire suite use make localsystem or make remotesystem for podman-remote testing.

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 assert 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

  • bats
  • jq
  • skopeo
  • nmap-ncat
  • httpd-tools
  • openssl
  • socat
  • buildah
  • gnupg

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.