Files
connexion/tests/test_middleware.py
Robbe Sneyders 15fe2eda8f Fix add_middleware enum comparison (#1698)
Fixes #1697

Because of a wrong comparison against the position `Enum`, middleware
was not actually being added to the stack via `add_middleware`. This PR
fixes this, adds a warning when the middleware position cannot be found,
and adds a test.
2023-04-24 18:09:57 +02:00

84 lines
2.6 KiB
Python

import pytest
from connexion.middleware import ConnexionMiddleware, MiddlewarePosition
from connexion.middleware.swagger_ui import SwaggerUIMiddleware
from starlette.datastructures import MutableHeaders
from conftest import build_app_from_fixture
class TestMiddleware:
"""Middleware to check if operation is accessible on scope."""
__test__ = False
def __init__(self, app):
self.app = app
async def __call__(self, scope, receive, send):
operation_id = scope["extensions"]["connexion_routing"]["operation_id"]
async def patched_send(message):
if message["type"] != "http.response.start":
await send(message)
return
message.setdefault("headers", [])
headers = MutableHeaders(scope=message)
headers["operation_id"] = operation_id
await send(message)
await self.app(scope, receive, patched_send)
@pytest.fixture(scope="session")
def middleware_app(spec, app_class):
middlewares = ConnexionMiddleware.default_middlewares + [TestMiddleware]
return build_app_from_fixture(
"simple", app_class=app_class, spec_file=spec, middlewares=middlewares
)
def test_routing_middleware(middleware_app):
app_client = middleware_app.test_client()
response = app_client.post("/v1.0/greeting/robbe")
assert (
response.headers.get("operation_id") == "fakeapi.hello.post_greeting"
), response.status_code
def test_add_middleware(spec, app_class):
"""Test adding middleware via the `add_middleware` method."""
app = build_app_from_fixture("simple", app_class=app_class, spec_file=spec)
app.add_middleware(TestMiddleware)
app_client = app.test_client()
response = app_client.post("/v1.0/greeting/robbe")
assert (
response.headers.get("operation_id") == "fakeapi.hello.post_greeting"
), response.status_code
def test_position(spec, app_class):
"""Test adding middleware via the `add_middleware` method."""
middlewares = [
middleware
for middleware in ConnexionMiddleware.default_middlewares
if middleware != SwaggerUIMiddleware
]
app = build_app_from_fixture(
"simple", app_class=app_class, spec_file=spec, middlewares=middlewares
)
with pytest.raises(ValueError) as exc_info:
app.add_middleware(TestMiddleware, position=MiddlewarePosition.BEFORE_SWAGGER)
assert (
exc_info.value.args[0]
== f"Could not insert middleware at position BEFORE_SWAGGER. "
f"Please make sure you have a {SwaggerUIMiddleware} in your stack."
)