podman/test/system
Chris Evich 80e807a191
Flake Fix: Wait before connecting container port
It was observed during periodic testing, this test can fail due to the
container process being not fully running and listening on the expected
port:

```
[+1069s] not ok 220 podman networking: port with --userns=keep-id
[+1069s] # (in test file test/system/500-networking.bats, line 144)
[+1069s] #   `echo "$teststring" | nc 127.0.0.1 $myport' failed
[+1069s] # # /var/tmp/go/src/github.com/containers/podman/bin/podman rm
--all --force
[+1069s] # # /var/tmp/go/src/github.com/containers/podman/bin/podman ps
--all --external --format {{.ID}} {{.Names}}
[+1069s] # # /var/tmp/go/src/github.com/containers/podman/bin/podman
images --all --format {{.Repository}}:{{.Tag}} {{.ID}}
[+1069s] # quay.io/libpod/testimage:20210610 9f9ec7f2fdef
[+1069s] # # /var/tmp/go/src/github.com/containers/podman/bin/podman run
-d --userns=keep-id -p 127.0.0.1:54322:54322
quay.io/libpod/testimage:20210610 nc -l -n -v -p 54322
[+1069s] #
252c562c9a3c96892d867d1d72fb52b2efdfe62855ebedbccd2d281c472c2988
[+1069s] # Ncat: No route to host.
```

Fix this by using a new `wait_for_port()` function (thanks @edsantiago)
before attempting to communicate with the service.

Signed-off-by: Chris Evich <cevich@redhat.com>
2021-07-19 15:36:13 -04:00
..
000-TEMPLATE BATS: new tests, and improvements to existing ones 2019-03-18 15:21:52 -06:00
001-basic.bats support tag@digest notation 2021-05-31 14:38:43 +02:00
005-info.bats Clear the storage-options from the graphdriver if users specifies --root 2021-05-19 15:35:59 -04:00
010-images.bats Scrub podman commands to use report package 2021-06-16 16:53:48 -07:00
015-help.bats Add system test for shell completion 2020-12-09 19:13:28 +01:00
020-tag.bats migrate Podman to containers/common/libimage 2021-05-05 11:30:12 +02:00
030-run.bats System tests: add :Z to volume mounts 2021-06-01 15:26:18 -06:00
035-logs.bats journald logger: fix race condition 2021-05-26 14:51:58 +02:00
037-runlabel.bats Fix handling of $NAME and $IMAGE in runlabel 2021-04-12 08:41:08 -04:00
040-ps.bats Add --noheading flag to all list commands 2021-04-21 05:22:29 -04:00
045-start.bats Restart all containers with restart-policy=always on boot 2021-06-13 15:04:34 +03:00
050-stop.bats Fixes from make codespell 2021-04-21 13:16:33 -04:00
055-rm.bats container removal: handle already removed containers 2021-02-23 13:02:35 +01:00
060-mount.bats migrate Podman to containers/common/libimage 2021-05-05 11:30:12 +02:00
065-cp.bats Implement --archive flag for podman cp 2021-07-01 12:01:46 +02:00
070-build.bats System tests: fix a multiarch problem 2021-07-15 11:29:58 -06:00
075-exec.bats Perform a one-sided close of HTTP attach conn on EOF 2021-07-13 16:26:53 -04:00
080-pause.bats System tests: reenable some skipped tests 2020-09-28 13:59:42 -06:00
090-events.bats Merge pull request #10561 from vrothberg/fix-remote-events-label 2021-06-07 00:05:42 +02:00
110-history.bats Migrate away from docker.io 2020-09-08 06:06:06 -06:00
120-load.bats System tests: fix a multiarch problem 2021-07-15 11:29:58 -06:00
130-kill.bats journald logger: fix race condition 2021-05-26 14:51:58 +02:00
140-diff.bats Gating tests: diff test: workaround for RHEL8 failure 2021-02-02 15:23:48 -07:00
150-login.bats Clear the storage-options from the graphdriver if users specifies --root 2021-05-19 15:35:59 -04:00
160-volumes.bats System tests: honor $OCI_RUNTIME (for CI) 2021-05-03 20:15:21 -06:00
170-run-userns.bats System tests: honor $OCI_RUNTIME (for CI) 2021-05-03 20:15:21 -06:00
200-pod.bats --infra-name command line argument 2021-07-15 21:27:51 -03:00
220-healthcheck.bats System tests: reenable a bunch of skipped tests 2021-03-20 08:21:46 -06:00
250-systemd.bats auto-update: make output more user friendly 2021-07-14 16:23:51 +02:00
255-auto-update.bats systemd: require network*-online*.target 2021-07-16 14:58:08 +02:00
260-sdnotify.bats System tests: honor $OCI_RUNTIME (for CI) 2021-05-03 20:15:21 -06:00
270-socket-activation.bats Move socket activation check into init() and set global condition. 2021-04-05 17:43:11 +08:00
300-cli-parsing.bats Handle podman-remote run --rm 2020-08-04 20:26:34 -04:00
320-system-df.bats fix podman system df format error 2020-07-31 01:40:42 +08:00
330-corrupt-images.bats Clear the storage-options from the graphdriver if users specifies --root 2021-05-19 15:35:59 -04:00
400-unprivileged-access.bats System tests: cover gaps from the last month 2021-01-25 13:34:26 -07:00
410-selinux.bats System tests: deal with crun 0.20.1 2021-06-09 10:15:12 -06:00
420-cgroups.bats cgroup: do not set cgroup parent when rootless and cgroupfs 2021-04-12 16:55:55 +02:00
450-interactive.bats disable tty-size exec checks in system tests 2021-06-23 10:10:19 +02:00
500-networking.bats Flake Fix: Wait before connecting container port 2021-07-19 15:36:13 -04:00
600-completion.bats Add shell completion tests for secrets 2021-02-10 10:41:51 +01:00
700-play.bats Handle advanced --network options in podman play kube 2021-06-30 13:32:27 -04:00
build-testimage System tests: the continuing multiarch saga 2021-06-10 13:33:20 -06:00
helpers.bash Flake Fix: Wait before connecting container port 2021-07-19 15:36:13 -04:00
helpers.t system tests: helpers: safer parse_table 2020-09-23 16:38:05 -06:00
README.md implement 'make remotesystem' 2019-08-08 11:44:55 -06:00
TODO.md Switch all references to github.com/containers/libpod -> podman 2020-07-28 08:23:45 -04:00

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 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; 015-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.

  • 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 testing podman-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.