play requests¶
pytest-play plugin driving the famous python requests library for making HTTP calls
More info and examples on:
- pytest-play, documentation
- cookiecutter-qa, see
pytest-playin action with a working example if you want to start hacking
Features¶
This pytest-play command provider let you drive a Python requests HTTP library using a json configuration file containing a set of pytest-play commands.
you can see a pytest-play script powered by a command provided by the play_requests plugin:
{
"steps": [{
"provider": "play_requests",
"type": "GET",
"assert": "'pytest-play' in response.json()",
"url": "https://www.google.it/complete/search",
"parameters": {
"headers": {
"Host": "www.google.it",
"User-Agent": "Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:57.0) Gecko/20100101 Firefox/57.0",
"Accept": "*/*",
"Accept-Language": "en-US,en;q=0.5",
"Referer": "https://www.google.it/",
"Connection": "keep-alive"
},
"params": [
["client", "psy-ab"],
["hl", "it"],
["gs_rn", "64"],
["gs_ri", "psy-ab"],
["gs_mss", "pytest-"],
["cp", "11"],
["gs_id", "172"],
["q", "pytest-play"],
["xhr", "t"]
],
"timeout": 2.5
}
}]
}
The above example:
- performs a GET call to https://www.google.it/complete/search?client=psy-ab&hl=it&… with the provided headers, a timeout (if it takes more than 2.5 seconds a timeout exception will be raised) and an assertion expression that verifies that the response meets the expected value
play_requests supports all the HTTP verbs supported by the requests library:
- OPTIONS
- HEAD
- GET
- POST
- PUT
- PATCH
- DELETE
NOTES: cookies and auth implementations supported by requests are not yet implemented because this package is still under development.
You’ll find other play_requests command examples in the following sections.
Condition¶
{
"provider": "play_requests",
"type": "POST",
"url": "http://something/1",
"condition": "1 > 0",
"parameters": {
"json": {
"foo": "bar",
},
"timeout": 2.5
}
}
the condition option let you execute Python expressions thanks to the play_python plugin.
Other condition examples:
"$myvar" == 'dev'variables["myvar"] == 'dev'
Upload files¶
Post a csv file:
{"provider": "play_requests",
"type": "POST",
"url": "http://something/1",
"parameters": {
"files": {
"filecsv": [
"report.csv",
"some,data"
]
}
}
}
Post a csv file with custom headers:
{"provider": "play_requests",
"type": "POST",
"url": "http://something/1",
"parameters": {
"files": {
"filecsv": [
"report.csv",
"some,data",
"application/csv",
{"Expires": "0"}
]}
}
}
Post a file providing the path:
{
"provider": "play_requests",
"type": "POST",
"url": "http://something/1",
"parameters": {
"files": {
"filecsv": [
"file.csv",
"path:$base_path/file.csv"
]
}
}
}
assuming that you have a $base_path variable.
Save the response to a variable¶
You can save a response elaboration to a pytest-play variable and reuse in the following commands:
{
"provider": "play_requests",
"type": "POST",
"url": "http://something/1",
"variable": "myvar",
"variable_expression": "response.json()",
"assertion": "variables["myvar"]["status"] == "ok"",
"parameters": {
"json": {
"foo": "bar",
},
"timeout": 2.5
}
}
It the endpoint returns a non JSON response, use response.text instead.
Default payload¶
If all your requests have a common payload it might be annoying but thanks to play_requests you can avoid repetitions.
You can set variables in many ways programatically using the pytest-play
execute command or execute commands. You can also update variables using
the play_python exec command:
{
"steps": [{
"provider": "python",
"type": "store_variable",
"name": "bearer",
"expression": "'BEARER'"
},
{
"provider": "python",
"type": "exec",
"expression": "variables.update({'play_requests': {'parameters': {'headers': {'Authorization': '$bearer'}}}})"
},
{
"provider": "play_requests",
"type": "GET",
"url": "$base_url"
}
}
and all the following HTTP calls will be performed with the authorization bearer provided in the default payload.
We suggest to define variables and update play_requests defaults programmatically, use json only for trivial examples.
Merging rules:
- if a play_requests command provides any other header value, the resulting HTTP call will be performed
with merged header values (eg:
Authorization+Host) - if a play_requests command provides a conflicting header value or any other default option,
the
Authorizationheader provided by the command will win and it will override just for the current call the default conflicting header value
Assert response status code¶
{
"provider": "play_requests",
"type": "POST",
"url": "http://something/1",
"variable": "myvar",
"variable_expression": "response.json()",
"assertion": "response.status_code == 200",
"parameters": {
"json": {
"foo": "bar",
}
}
}
of if you want you can use the expression response.raise_for_status() instead of
checking the exact match of status code.
The raise_for_status call will raise an HTTPError if the HTTP request
returned an unsuccessful status code.
Redirections¶
By default requests will perform location redirection for all verbs except HEAD:
You can disable or enable redirects playing with the allow_redirects option:
{
"provider": "play_requests",
"type": "POST",
"url": "http://something/1",
"variable": "myvar",
"variable_expression": "response.json()",
"assertion": "response.status_code == 200",
"parameters": {
"allow_redirects": false,
"json": {
"foo": "bar",
}
}
}
Credits¶
This package was created with Cookiecutter and the cookiecutter-play-plugin (based on audreyr/cookiecutter-pypackage project template).