Test helpers for the requests library
Install the package requtests version 1.2+ from PyPI.
The recommended requirements.txt line is requtests~=1.2.
Creates an adapter intended for use with request.Session.
Returns the passed Response instance when the adapter's send method is called. If the assertions function has been specified, it will be called with the request before returning the response.
The faked adapter can be mounted using the standard mount method on an instance of Session with a suitable URL prefix. Use multiple faked adapters, specifically mounted for some URL:s, to simulate a chain of requests and responses being made.
from requests import Session
from requtests import FakeAdapter, fake_response
class Client:
def __init__(self):
self.session = Session()
def create_user(self, username):
return self.session.post(
"https://example.com/users",
params={"action": "create"},
json={"username": username},
headers={"Authorization": "Bearer token"},
)
def test_create_user():
user_created_response = fake_response(json={"message": "User created!"}, status_code=201)
adapter = FakeAdapter(user_created_response, assertions=_create_user_assertions)
prefix = "https://example.com/users"
client = Client()
client.session.mount(prefix, adapter)
actual_response = client.create_user("my_username")
assert actual_response.status_code == 201
assert actual_response.json() == {"message": "User created!"}
def _create_user_assertions(prepared_request, **kwargs):
assert prepared_request.method == "POST"
assert prepared_request.url == "https://example.com/users?action=create"
assert prepared_request.headers["Authorization"] == "Bearer token"
assert prepared_request.body == b'{"username": "my_username"}'Returns a function behaving as requests.request, except that it returns a different response each time it is called. Useful to test e.g. pagination.
Convenience functions returning partially applied fake_request functions with the HTTP method filled in.
Similar to fake_request, except that it instantiates a single Response object and returns it based on its arguments.
import requests
from requtests import fake_request_with_response
def login(username, password, request_func=requests.request):
response = request_func("POST", "https://example.com/login", data={"username": username, "password": password})
response.raise_for_status()
return response.json()["token"]
def test_login():
username = "my-username"
password = "my-password"
request_func = fake_request_with_response(json={"token": "my-login-token"})
assert login(username, password, request_func=request_func) == "my-login-token"Returns a requests.Response object with either the return value of its json() method set to a python data structure or its text property set.
A test helper object wrapping a PreparedRequest object to make it easier to write assertions. In addition to wrapping the PreparedRequest's body, headers, method, and url properties, it also provides the following convenience properties.
endpoint- the URL without any query parameters.query- any query parameters, parsed and decoded.json- the body parsed as JSON.text- the body decoded as a string.
from requtests import ParsedRequest
def _create_user_assertions(prepared_request, **kwargs):
parsed_request = ParsedRequest(prepared_request)
assert parsed_request.method == "POST"
assert parsed_request.url == "https://example.com/users?action=create"
assert parsed_request.endpoint == "https://example.com/users"
assert parsed_request.query == {"action": "create"}
assert parsed_request.headers["Authorization"] == "Bearer token"
assert parsed_request.body == b'{"username": "my_username"}'
assert parsed_request.json == {"username": "my_username"}
assert parsed_request.text == '{"username": "my_username"}'