-
-
Notifications
You must be signed in to change notification settings - Fork 6.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
🐛 Fix preserving route_class when calling include_router (#538)
- Loading branch information
Showing
2 changed files
with
118 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,114 @@ | ||
import pytest | ||
from fastapi import APIRouter, FastAPI | ||
from fastapi.routing import APIRoute | ||
from starlette.testclient import TestClient | ||
|
||
app = FastAPI() | ||
|
||
|
||
class APIRouteA(APIRoute): | ||
x_type = "A" | ||
|
||
|
||
class APIRouteB(APIRoute): | ||
x_type = "B" | ||
|
||
|
||
class APIRouteC(APIRoute): | ||
x_type = "C" | ||
|
||
|
||
router_a = APIRouter(route_class=APIRouteA) | ||
router_b = APIRouter(route_class=APIRouteB) | ||
router_c = APIRouter(route_class=APIRouteC) | ||
|
||
|
||
@router_a.get("/") | ||
def get_a(): | ||
return {"msg": "A"} | ||
|
||
|
||
@router_b.get("/") | ||
def get_b(): | ||
return {"msg": "B"} | ||
|
||
|
||
@router_c.get("/") | ||
def get_c(): | ||
return {"msg": "C"} | ||
|
||
|
||
router_b.include_router(router=router_c, prefix="/c") | ||
router_a.include_router(router=router_b, prefix="/b") | ||
app.include_router(router=router_a, prefix="/a") | ||
|
||
|
||
client = TestClient(app) | ||
|
||
openapi_schema = { | ||
"openapi": "3.0.2", | ||
"info": {"title": "Fast API", "version": "0.1.0"}, | ||
"paths": { | ||
"/a/": { | ||
"get": { | ||
"responses": { | ||
"200": { | ||
"description": "Successful Response", | ||
"content": {"application/json": {"schema": {}}}, | ||
} | ||
}, | ||
"summary": "Get A", | ||
"operationId": "get_a_a__get", | ||
} | ||
}, | ||
"/a/b/": { | ||
"get": { | ||
"responses": { | ||
"200": { | ||
"description": "Successful Response", | ||
"content": {"application/json": {"schema": {}}}, | ||
} | ||
}, | ||
"summary": "Get B", | ||
"operationId": "get_b_a_b__get", | ||
} | ||
}, | ||
"/a/b/c/": { | ||
"get": { | ||
"responses": { | ||
"200": { | ||
"description": "Successful Response", | ||
"content": {"application/json": {"schema": {}}}, | ||
} | ||
}, | ||
"summary": "Get C", | ||
"operationId": "get_c_a_b_c__get", | ||
} | ||
}, | ||
}, | ||
} | ||
|
||
|
||
@pytest.mark.parametrize( | ||
"path,expected_status,expected_response", | ||
[ | ||
("/a", 200, {"msg": "A"}), | ||
("/a/b", 200, {"msg": "B"}), | ||
("/a/b/c", 200, {"msg": "C"}), | ||
("/openapi.json", 200, openapi_schema), | ||
], | ||
) | ||
def test_get_path(path, expected_status, expected_response): | ||
response = client.get(path) | ||
assert response.status_code == expected_status | ||
assert response.json() == expected_response | ||
|
||
|
||
def test_route_classes(): | ||
routes = {} | ||
r: APIRoute | ||
for r in app.router.routes: | ||
routes[r.path] = r | ||
assert routes["/a/"].x_type == "A" | ||
assert routes["/a/b/"].x_type == "B" | ||
assert routes["/a/b/c/"].x_type == "C" |