test_apistar_request_id.py

import pytest

from apistar import App, Route, TestClient, exceptions
from apistar_request_id import RequestId, RequestIdHooks


def index() -> dict:
    return {}


def fail() -> dict:
    raise exceptions.BadRequest("fail")


def fail_2() -> dict:
    raise RuntimeError("fail")


routes = [
    Route("/", method="GET", handler=index),
    Route("/fail", method="GET", handler=fail),
    Route("/fail-2", method="GET", handler=fail_2),
]

event_hooks = [
    RequestIdHooks()
]


@pytest.fixture(scope="session")
def app():
    return App(routes=routes, event_hooks=event_hooks)


@pytest.fixture
def client(app):
    return TestClient(app)


def test_request_id_can_be_autogenerated(client):
    # Given that I don't have an existing request id
    # When I make a request to the app
    response = client.get("/")

    # Then my response should contain an autogenerated request id
    assert response.headers["x-request-id"]

    # And the request id for the current thread should be cleared
    assert RequestId.get_request_id() is None


def test_request_id_can_be_set_from_request_headers(client):
    # Given that I have an existing request id
    # When I make a request to the app
    response = client.get("/", headers={"x-request-id": "a-request-id"})

    # Then that same request id should appear in the response headers
    assert response.headers["x-request-id"] == "a-request-id"

    # And the request id for the current thread should be cleared
    assert RequestId.get_request_id() is None


def test_request_id_can_be_set_on_error(client):
    # Given that I have an existing request id
    # When I make a request to the app
    response = client.get("/fail", headers={"x-request-id": "a-request-id"})

    # Then that same request id should appear in the response headers
    assert response.headers["x-request-id"] == "a-request-id"

    # And the request id for the current thread should be cleared
    assert RequestId.get_request_id() is None


def test_request_id_can_be_set_on_internal_error(client):
    # Given that I have an existing request id
    # When I make a request to the app
    with pytest.raises(RuntimeError):
        client.get("/fail-2", headers={"x-request-id": "a-request-id"})

    # Then the request id should be set and subsequently cleared
    assert RequestId.get_request_id() is None