podman/test/apiv2
baude 91ea3fabd6 add network prune
add the ability to prune unused cni networks.  filters are not implemented
but included both compat and podman api endpoints.

Fixes :#8673

Signed-off-by: baude <bbaude@redhat.com>
2021-02-06 07:37:29 -06:00
..
rest_api add network prune 2021-02-06 07:37:29 -06:00
00-TEMPLATE Tests for API v2 2020-01-17 09:59:22 -07:00
01-basic.at Bump remote API version to 3.0.0 2021-02-04 16:42:29 -05:00
10-images.at Fix panic in libpod images exists endpoint 2020-12-10 14:35:17 +01:00
12-imagesMore.at move from docker.io 2020-10-28 13:16:37 -06:00
20-containers.at Ensure the Volumes field in Compat Create is honored 2021-01-26 14:38:25 -05:00
22-stop.at APIv2 tests: add tests for stop 2020-03-03 06:40:27 -07:00
23-containersArchive.at test resource cleanup 2020-11-19 21:21:00 +01:00
25-containersMore.at Merge pull request #8581 from baude/kubegen 2020-12-07 16:16:15 -05:00
26-containersWait.at Add test for Docker APIv2 wait 2021-02-03 22:10:27 +01:00
30-volumes.at Initial implementation of volume plugins 2021-01-14 15:35:33 -05:00
35-networks.at Fix some network compat api problems 2020-12-11 14:16:05 +01:00
40-pods.at APIv2 tests: get them passing again 2020-10-12 08:45:39 -06:00
45-system.at Initial implementation of volume plugins 2021-01-14 15:35:33 -05:00
README.md Tests for API v2 2020-01-17 09:59:22 -07:00
test-apiv2 Tests: Fix common flakes, and improve apiv2 test log 2020-10-20 11:32:49 -06: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.