pytest fixture for HTTPX
Project description
pytest fixture for HTTPX
Notice: This module is still under development, versions prior to 1.0.0 are subject to breaking changes without notice.
Use pytest_httpx.httpx_mock
pytest
fixture to mock httpx
requests.
Add responses
You can register responses for both sync and async httpx
requests.
import pytest
import httpx
from pytest_httpx import httpx_mock, HTTPXMock
def test_something(httpx_mock: HTTPXMock):
httpx_mock.add_response("http://test_url")
with httpx.Client() as client:
response = client.get("http://test_url")
@pytest.mark.asyncio
async def test_something_async(httpx_mock: HTTPXMock):
httpx_mock.add_response("http://test_url")
async with httpx.AsyncClient() as client:
response = await client.get("http://test_url")
If all responses are not sent back during test execution, the test case will fail at teardown.
Default response is a 200 (OK) without any body for a GET request on the provided URL using HTTP/1.1 protocol version.
How response is selected
Default matching is performed on the full URL, query parameters included and the HTTP method.
Registration order is kept while checking what response to send.
In case more than one response match request, the first one not yet sent will be sent.
In case all matching responses have been sent, the last registered one will be sent.
Providing URL
URL can either be a string, a python re.Pattern instance or a httpx.URL instance.
Add JSON response
Use json
parameter to add a JSON response using python values.
import httpx
from pytest_httpx import httpx_mock, HTTPXMock
def test_json(httpx_mock: HTTPXMock):
httpx_mock.add_response("http://test_url", json=[{"key1": "value1", "key2": "value2"}])
with httpx.Client() as client:
assert client.get("http://test_url").json() == [{"key1": "value1", "key2": "value2"}]
Reply with custom body
Use data
parameter to reply with a custom body by providing bytes or UTF-8 encoded string.
import httpx
from pytest_httpx import httpx_mock, HTTPXMock
def test_str_body(httpx_mock: HTTPXMock):
httpx_mock.add_response("http://test_url", data="This is my UTF-8 content")
with httpx.Client() as client:
assert client.get("http://test_url").text == "This is my UTF-8 content"
def test_bytes_body(httpx_mock: HTTPXMock):
httpx_mock.add_response("http://test_url", data=b"This is my bytes content")
with httpx.Client() as client:
assert client.get("http://test_url").content == b"This is my bytes content"
Add multipart response
Use data
parameter as a dictionary or files
parameter (or both) to send multipart response.
You can specify boundary
parameter to specify the multipart boundary to use.
import httpx
from pytest_httpx import httpx_mock, HTTPXMock
def test_multipart_body(httpx_mock: HTTPXMock):
httpx_mock.add_response("http://test_url", data={"key1": "value1"}, files={"file1": "content of file 1"}, boundary=b"2256d3a36d2a61a1eba35a22bee5c74a")
with httpx.Client() as client:
assert client.get("http://test_url").text == '''--2256d3a36d2a61a1eba35a22bee5c74a\r
Content-Disposition: form-data; name="key1"\r
\r
value1\r
--2256d3a36d2a61a1eba35a22bee5c74a\r
Content-Disposition: form-data; name="file1"; filename="upload"\r
Content-Type: application/octet-stream\r
\r
content of file 1\r
--2256d3a36d2a61a1eba35a22bee5c74a--\r
'''
Add non GET response
Use method
parameter to specify the HTTP method (POST, PUT, DELETE, PATCH, HEAD) to reply to on provided URL.
import httpx
from pytest_httpx import httpx_mock, HTTPXMock
def test_post(httpx_mock: HTTPXMock):
httpx_mock.add_response("http://test_url", method="POST")
with httpx.Client() as client:
response = client.post("http://test_url")
def test_put(httpx_mock: HTTPXMock):
httpx_mock.add_response("http://test_url", method="PUT")
with httpx.Client() as client:
response = client.put("http://test_url")
def test_delete(httpx_mock: HTTPXMock):
httpx_mock.add_response("http://test_url", method="DELETE")
with httpx.Client() as client:
response = client.delete("http://test_url")
def test_patch(httpx_mock: HTTPXMock):
httpx_mock.add_response("http://test_url", method="PATCH")
with httpx.Client() as client:
response = client.patch("http://test_url")
def test_head(httpx_mock: HTTPXMock):
httpx_mock.add_response("http://test_url", method="HEAD")
with httpx.Client() as client:
response = client.head("http://test_url")
Add non 200 response
Use status_code
parameter to specify the HTTP status code of the response.
import httpx
from pytest_httpx import httpx_mock, HTTPXMock
def test_status_code(httpx_mock: HTTPXMock):
httpx_mock.add_response("http://test_url", status_code=404)
with httpx.Client() as client:
assert client.get("http://test_url").status_code == 404
Reply with custom headers
Use headers
parameter to specify the extra headers of the response.
import httpx
from pytest_httpx import httpx_mock, HTTPXMock
def test_headers(httpx_mock: HTTPXMock):
httpx_mock.add_response("http://test_url", headers={"X-Header1": "Test value"})
with httpx.Client() as client:
assert client.get("http://test_url").headers["x-header1"] == "Test value"
Add HTTP/2.0 response
Use http_version
parameter to specify the HTTP protocol version of the response.
import httpx
from pytest_httpx import httpx_mock, HTTPXMock
def test_http_version(httpx_mock: HTTPXMock):
httpx_mock.add_response("http://test_url", http_version="HTTP/2.0")
with httpx.Client() as client:
assert client.get("http://test_url").http_version == "HTTP/2.0"
Add callbacks
You can perform custom manipulation upon request reception by registering callbacks.
Callback should expect at least two parameters:
- request: The received request.
- timeout: The timeout linked to the request.
If all callbacks are not executed during test execution, the test case will fail at teardown.
Default callback is for a GET request on the provided URL.
Dynamic responses
Callback should return a httpx.Response instance.
import httpx
from httpx import content_streams
from pytest_httpx import httpx_mock, HTTPXMock
def test_dynamic_response(httpx_mock: HTTPXMock):
def custom_response(request: httpx.Request, *args, **kwargs) -> httpx.Response:
return httpx.Response(
status_code=200,
http_version="HTTP/1.1",
headers=[],
stream=content_streams.JSONStream({"url": str(request.url)}),
request=request,
)
httpx_mock.add_callback(custom_response, "http://test_url")
with httpx.Client() as client:
response = client.get("http://test_url")
assert response.json() == {"url": "http://test_url"}
Raising exceptions
You can simulate httpx exception throwing by raising an exception in your callback.
This can be useful if you want to assert that your code handles httpx exceptions properly.
import httpx
import pytest
from pytest_httpx import httpx_mock, HTTPXMock
def test_exception_raising(httpx_mock: HTTPXMock):
def raise_timeout(*args, **kwargs) -> httpx.Response:
raise httpx.exceptions.TimeoutException()
httpx_mock.add_callback(raise_timeout, "http://test_url")
with httpx.Client() as client:
with pytest.raises(httpx.exceptions.TimeoutException):
client.get("http://test_url")
How callback is selected
Default matching is performed on the full URL, query parameters included and the HTTP method.
Registration order is kept while checking what callback to execute.
In case more than one callback match request, the first one not yet executed will be sent.
In case all matching callbacks have been sent, the last registered one will be sent.
Providing URL
URL can either be a string, a python re.Pattern instance or a httpx.URL instance.
Check sent requests
import httpx
from pytest_httpx import httpx_mock, HTTPXMock
def test_many_requests(httpx_mock: HTTPXMock):
httpx_mock.add_response("http://test_url")
with httpx.Client() as client:
response1 = client.get("http://test_url")
response2 = client.get("http://test_url")
requests = httpx_mock.get_requests("http://test_url")
def test_single_request(httpx_mock: HTTPXMock):
httpx_mock.add_response("http://test_url")
with httpx.Client() as client:
response = client.get("http://test_url")
request = httpx_mock.get_request("http://test_url")
How requests are selected
Default matching is performed on the full URL, query parameters included and the HTTP method.
Request original order is kept while appending to the list.
Providing URL
URL can either be a string, a python re.Pattern instance or a httpx.URL instance.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pytest_httpx-0.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8ed70f37dd6ef0c28c374bfdc71b759b31fa61dd164a4ff2b6258dcb4e8ec9fd |
|
MD5 | 731b00ff461bf2c2120e77e10c37f1f2 |
|
BLAKE2b-256 | 994c154c0626828169bd19b6b49ad0f7979f121025e0b72776a35385b68e4b0a |