Package: pytest_httpserver
pytest_httpserverHTTP server for pytestNutshellThis library is designed to help to test http clients without contacting the real http server.
In other words, it is a fake http server which is accessible via localhost can be started with
the pre-defined expected http requests and their responses.ExampleHandling a simple GET requestdeftest_my_client(httpserver,):# httpserver is a pytest fixture which starts the server# set up the server to serve /foobar with the jsonhttpserver.expect_request("/foobar").respond_with_json({"foo":"bar"})# check that the request is servedassertrequests.get(httpserver.url_for("/foobar")).json()=={"foo":"bar"}Handing a POST request with an expected json bodydeftest_json_request(httpserver,):# httpserver is a pytest fixture which starts the server# set up the server to serve /foobar with the jsonhttpserver.expect_request("/foobar",method="POST",json={"id":12,"name":"foo"}).respond_with_json({"foo":"bar"})# check that the request is servedassertrequests.post(httpserver.url_for("/foobar"),json={"id":12,"name":"foo"}).json()=={"foo":"bar"}You can also use the library without pytest. There's a with statement to ensure that the server is stopped.withHTTPServer()ashttpserver:# set up the server to serve /foobar with the jsonhttpserver.expect_request("/foobar").respond_with_json({"foo":"bar"})# check that the request is servedprint(requests.get(httpserver.url_for("/foobar")).json())DocumentationPlease find the API documentation athttps://pytest-httpserver.readthedocs.io/en/latest/.FeaturesYou can set up a dozen of expectations for the requests, and also what response should be sent by the server to the client.RequestsThere are three different types:permanent: this will be always served when there's match for this request, you can make as many HTTP requests as you wantoneshot: this will be served only once when there's a match for this request, you can only make 1 HTTP requestordered: same as oneshot but the order must be strictly matched to the order of setting upYou can also fine-tune the expected request. The following can be specified:URI (this is a must)HTTP methodheadersquery stringdata (HTTP body of the request)JSON (HTTP body loaded as JSON)ResponsesOnce you have the expectations for the request set up, you should also define the response you want to send back.
The following is supported currently:respond arbitrary data (string or bytearray)respond a json (a python dict converted in-place to json)respond a Response object of werkzeuguse your own functionSimilar to requests, you can fine-tune what response you want to send:HTTP statusheadersdataBehave supportUsing theBlockingHTTPServerclass, the assertion for a request and the
response can be performed in real order. For more info, see thetest, thehowtoand theAPI
documentation.Missing featuresHTTP/2KeepaliveTLSDonationCurrently, this project is based heavily on werkzeug and pytest.Werkzeug does all the heavy lifting behind the scenes, parsing HTTP request and
defining Request and Response objects, which are currently transparent in the
API.If you wish to donate to werkzeug:https://palletsprojects.com/donatePytest is the de-facto test library for python.If you wish to donate to pytest:https://opencollective.com/pytest