History

Ed Santiago 2d5a2a7640 BATS and APIv2: more tests and tweaks - (minor): apiv2 tests: check for full ID Observation made while reviewing #6461: tests were checking only for a 12-character container/image ID in return value. It's actually 64, and we should test for that. This should also minimize confusion in a future maintainer. - podman pause/unpause: new test Runs a 'date/sleep' loop, pauses container, sleeps 3s, restarts, then confirms that there's a 3- to 6-second gap in the logs for the container. - podman healthcheck: new test run a container with healthcheck, test both healthy and unhealthy conditions - podman pod: check '{{.Pod}}' field in podman ps Hey, as long as we have a pod with two running containers, might as well confirm that 'podman ps' returns the expected pod ID. Signed-off-by: Ed Santiago <santiago@redhat.com>		2020-06-03 16:13:33 -06:00
..
rest_api	V2 verify JSON output is consistent and doesn't drift	2020-05-28 16:20:29 -07:00
00-TEMPLATE	Tests for API v2	2020-01-17 09:59:22 -07:00
01-basic.at	V2 API Version Support	2020-05-20 10:21:30 -07:00
10-images.at	V2 verify JSON output is consistent and doesn't drift	2020-05-28 16:20:29 -07:00
20-containers.at	BATS and APIv2: more tests and tweaks	2020-06-03 16:13:33 -06:00
22-stop.at	APIv2 tests: add tests for stop	2020-03-03 06:40:27 -07:00
30-volumes.at	Tests for API v2	2020-01-17 09:59:22 -07:00
40-pods.at	V2 verify JSON output is consistent and doesn't drift	2020-05-28 16:20:29 -07:00
README.md	Tests for API v2	2020-01-17 09:59:22 -07:00
test-apiv2	test.apiv2: add testing for image and deal with API returning binary	2020-05-28 10:00:13 +00:00

README.md

API v2 tests

This directory contains tests for the podman version 2 API (HTTP).

Tests themselves are in files of the form 'NN-NAME.at' where NN is a two-digit number, NAME is a descriptive name, and '.at' is just an extension I picked.

Running Tests

The main test runner is test-apiv2. Usage is:

$ sudo ./test-apiv2 [NAME [...]]

...where NAME is one or more optional test names, e.g. 'image' or 'pod' or both. By default, test-apiv2 will invoke all *.at tests.

test-apiv2 connects to localhost only and via TCP. There is no support here for remote hosts or for UNIX sockets. This is a framework for testing the API, not all possible protocols.

test-apiv2 will start the service if it isn't already running.

Writing Tests

The main test function is t. It runs curl against the server, with POST parameters if present, and compares return status and (optionally) string results from the server:

t GET /_ping 200 OK
  ^^^ ^^^^^^ ^^^ ^^
  |   |      |   +--- expected string result
  |   |      +------- expected return code
  |   +-------------- endpoint to access
  +------------------ method (GET, POST, DELETE, HEAD)


t POST libpod/volumes/create name=foo 201 .ID~[0-9a-f]\\{12\\}
       ^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^ ^^^ ^^^^^^^^^^^^^^^^^^^^
       |                     |        |   JSON '.ID': expect 12-char hex
       |                     |        +-- expected code
       |                     +----------- POST params
       +--------------------------------- note the missing slash

Notes:

If the endpoint has a leading slash (/_ping), t leaves it unchanged. If there's no leading slash, t prepends /v1.40. This is a simple convenience for simplicity of writing tests.
When method is POST, the argument after the endpoint must be a series of POST arguments in the form 'key=value', separated by commas. t will convert those to JSON form for passing to the server.
The final arguments are one or more expected string results. If an argument starts with a dot, t will invoke jq on the output to fetch that field, and will compare it to the right-hand side of the argument. If the separator is = (equals), t will require an exact match; if ~ (tilde), t will use expr to compare.