Coverage for tests/test_custom_route_class.py: 100%

1import pytest 5 ctx1abcde

2from fastapi import APIRouter, FastAPI 5 ctx1abcde

3from fastapi.routing import APIRoute 5 ctx1abcde

4from fastapi.testclient import TestClient 5 ctx1abcde

5from starlette.routing import Route 5 ctx1abcde

6 

7app = FastAPI() 5 ctx1abcde

8 

9 

10class APIRouteA(APIRoute): 5 ctx1abcde

11 x_type = "A" 5 ctx1abcde

12 

13 

14class APIRouteB(APIRoute): 5 ctx1abcde

15 x_type = "B" 5 ctx1abcde

16 

17 

18class APIRouteC(APIRoute): 5 ctx1abcde

19 x_type = "C" 5 ctx1abcde

20 

21 

22router_a = APIRouter(route_class=APIRouteA) 5 ctx1abcde

23router_b = APIRouter(route_class=APIRouteB) 5 ctx1abcde

24router_c = APIRouter(route_class=APIRouteC) 5 ctx1abcde

25 

26 

27@router_a.get("/") 5 ctx1abcde

28def get_a(): 5 ctx1abcde

29 return {"msg": "A"} 5 ctx1abcde

30 

31 

32@router_b.get("/") 5 ctx1abcde

33def get_b(): 5 ctx1abcde

34 return {"msg": "B"} 5 ctx1abcde

35 

36 

37@router_c.get("/") 5 ctx1abcde

38def get_c(): 5 ctx1abcde

39 return {"msg": "C"} 5 ctx1abcde

40 

41 

42router_b.include_router(router=router_c, prefix="/c") 5 ctx1abcde

43router_a.include_router(router=router_b, prefix="/b") 5 ctx1abcde

44app.include_router(router=router_a, prefix="/a") 5 ctx1abcde

45 

46 

47client = TestClient(app) 5 ctx1abcde

48 

49 

50@pytest.mark.parametrize( 5 ctx1abcde

51 "path,expected_status,expected_response", 

52 [ 

53 ("/a", 200, {"msg": "A"}), 

54 ("/a/b", 200, {"msg": "B"}), 

55 ("/a/b/c", 200, {"msg": "C"}), 

56 ], 

57) 

58def test_get_path(path, expected_status, expected_response): 5 ctx1abcde

59 response = client.get(path) 5 ctx1abcde

60 assert response.status_code == expected_status 5 ctx1abcde

61 assert response.json() == expected_response 5 ctx1abcde

62 

63 

64def test_route_classes(): 5 ctx1abcde

65 routes = {} 5 ctx1abcde

66 for r in app.router.routes: 5 ctx1abcde

67 assert isinstance(r, Route) 5 ctx1abcde

68 routes[r.path] = r 5 ctx1abcde

69 assert getattr(routes["/a/"], "x_type") == "A" # noqa: B009 5 ctx1abcde

70 assert getattr(routes["/a/b/"], "x_type") == "B" # noqa: B009 5 ctx1abcde

71 assert getattr(routes["/a/b/c/"], "x_type") == "C" # noqa: B009 5 ctx1abcde

72 

73 

74def test_openapi_schema(): 5 ctx1abcde

75 response = client.get("/openapi.json") 5 ctx1abcde

76 assert response.status_code == 200, response.text 5 ctx1abcde

77 assert response.json() == { 5 ctx1abcde

78 "openapi": "3.1.0", 

79 "info": {"title": "FastAPI", "version": "0.1.0"}, 

80 "paths": { 

81 "/a/": { 

82 "get": { 

83 "responses": { 

84 "200": { 

85 "description": "Successful Response", 

86 "content": {"application/json": {"schema": {}}}, 

87 } 

88 }, 

89 "summary": "Get A", 

90 "operationId": "get_a_a__get", 

91 } 

92 }, 

93 "/a/b/": { 

94 "get": { 

95 "responses": { 

96 "200": { 

97 "description": "Successful Response", 

98 "content": {"application/json": {"schema": {}}}, 

99 } 

100 }, 

101 "summary": "Get B", 

102 "operationId": "get_b_a_b__get", 

103 } 

104 }, 

105 "/a/b/c/": { 

106 "get": { 

107 "responses": { 

108 "200": { 

109 "description": "Successful Response", 

110 "content": {"application/json": {"schema": {}}}, 

111 } 

112 }, 

113 "summary": "Get C", 

114 "operationId": "get_c_a_b_c__get", 

115 } 

116 }, 

117 }, 

118 }