Skip to main content

Pytest plugin with server for catching HTTP requests.

Project description

Pytest Catch Server

PyPI version Python versions Build status Code style: Black

Pytest plugin with server fixture for catching HTTP requests. It's handy for integration tests or for testing 3rd party packages which have network side effects like reporting to 3rd party services (DataDog APM, Sentry, ...).


You can install "pytest-catch-server" via pip:

pip install pytest-catch-server


This plugin comes with three fixtures. The main catch_server is for use in your tests:

def test_something(catch_server):
    url = f"http://{}:{catch_server.port}/something"
    assert catch_server.requests == [
        {"method": "GET", "path": "/something", "data": b""}

In more real world examples you may need to patch global module (like some tracer).

It will flush list of catched requests between each test.

Catching these methods: GET, POST, PUT, PATCH, DELETE

You may want to setup your app fixture with catch server as dependency. You can use session scoped fixture background_catch_server for that:

def app(background_catch_server):
    tracer_dsn = f"http://{}:{background_catch_server.port}"
    return create_app(tracer_dsn=tracer_dsn)

def test_tracing(app, catch_server):
    assert catch_server.requests == [
        {"method": "PUT", "path": "/trace", "data": b"..."}

Port for catch server is a random free port. If you want to use specific port, you can override catch_server_port fixture in your tests which is returning free port number.

If you encounter any problems, please file an issue along with a detailed description.


Contributions are very welcome. Tests can be run with tox, please ensure the coverage at least stays the same before you submit a pull request.

Pre-commit hooks are set up for this project. Please make sure you have pre-commit installed and set up on this repo.


Distributed under the terms of the MIT license, "pytest-catch-server" is free and open source software.


This pytest plugin was generated with Cookiecutter along with @hackebrot's cookiecutter-pytest-plugin template.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pytest-catch-server-1.0.0.tar.gz (4.5 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page