diff options
author | Ed Santiago <santiago@redhat.com> | 2021-03-08 15:32:26 -0700 |
---|---|---|
committer | Ed Santiago <santiago@redhat.com> | 2021-03-10 05:24:44 -0700 |
commit | 258749e43dc8c2e842f96f8672823b0fa4e5a147 (patch) | |
tree | 672f13c9d214589833dce044b5982cba74c4abc0 /test/apiv2/README.md | |
parent | 5331096b3882cd5c8e587200560e44ef1eb990a3 (diff) | |
download | podman-258749e43dc8c2e842f96f8672823b0fa4e5a147.tar.gz podman-258749e43dc8c2e842f96f8672823b0fa4e5a147.tar.bz2 podman-258749e43dc8c2e842f96f8672823b0fa4e5a147.zip |
apiv2 tests: finally fix POST as originally intended
When I originally wrote this code I had no idea what POST
would look like so I did a sloppy job, deferring making it
usable. Now that we have some real-world examples in place,
I have a better understanding of what params look like and
how to make tests more readable/maintainable. (Deferring isn't
always bad: one of my early ideas was to separate params using
commas; that would've been a disaster because some JSON values,
such as arrays, include commas).
This commit implements a better way of dealing with POST:
* The main concept is still 'key=value'
* When value is a JSON object (dictionary, array), it
can be quoted.
* Multiple params are simply separated by spaces.
The 3-digit HTTP code is a prominent, readable separator
between POST params and expected results. The parsing
code is a little uglier, but test developers need
never see that. The important thing is that writing
tests is now easier.
* POST params can be empty (this removes the need for a
useless '')
I snuck in one unrelated change: one of the newly-added
tests, .NetworkSettings, was failing when run rootless
(which is how I test on my setup). I made it conditional.
Signed-off-by: Ed Santiago <santiago@redhat.com>
Diffstat (limited to 'test/apiv2/README.md')
-rw-r--r-- | test/apiv2/README.md | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/test/apiv2/README.md b/test/apiv2/README.md index 252d6454e..19727cec7 100644 --- a/test/apiv2/README.md +++ b/test/apiv2/README.md @@ -52,9 +52,14 @@ Notes: 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. +* When method is POST, the argument(s) after the endpoint may be a series +of POST parameters in the form 'key=value', separated by spaces: + t POST myentrypoint 200 ! no params + t POST myentrypoint id=$id 200 ! just one + t POST myentrypoint id=$id filter='{"foo":"bar"}' 200 ! two, with json + t POST myentrypoint name=$name badparam='["foo","bar"]' 500 ! etc... +`t` will convert the param list to JSON form for passing to the server. +A numeric status code terminates processing of POST parameters. * 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 |