Coverage for tests/test_router_events.py: 100%

1from contextlib import asynccontextmanager 5 ctx1klmno

2from typing import AsyncGenerator, Dict, Union 5 ctx1klmno

3 

4import pytest 5 ctx1klmno

5from fastapi import APIRouter, FastAPI, Request 5 ctx1klmno

6from fastapi.testclient import TestClient 5 ctx1klmno

7from pydantic import BaseModel 5 ctx1klmno

8 

9 

10class State(BaseModel): 5 ctx1klmno

11 app_startup: bool = False 5 ctx1klmno

12 app_shutdown: bool = False 5 ctx1klmno

13 router_startup: bool = False 5 ctx1klmno

14 router_shutdown: bool = False 5 ctx1klmno

15 sub_router_startup: bool = False 5 ctx1klmno

16 sub_router_shutdown: bool = False 5 ctx1klmno

17 

18 

19@pytest.fixture 5 ctx1klmno

20def state() -> State: 5 ctx1klmno

21 return State() 5 ctx1klmno

22 

23 

24@pytest.mark.filterwarnings( 5 ctx1klmno

25 r"ignore:\s*on_event is deprecated, use lifespan event handlers instead.*:DeprecationWarning" 

26) 

27def test_router_events(state: State) -> None: 5 ctx1klmno

28 app = FastAPI() 5 ctx1abcde

29 

30 @app.get("/") 5 ctx1abcde

31 def main() -> Dict[str, str]: 5 ctx1abcde

32 return {"message": "Hello World"} 5 ctx1abcde

33 

34 @app.on_event("startup") 5 ctx1abcde

35 def app_startup() -> None: 5 ctx1abcde

36 state.app_startup = True 5 ctx1abcde

37 

38 @app.on_event("shutdown") 5 ctx1abcde

39 def app_shutdown() -> None: 5 ctx1abcde

40 state.app_shutdown = True 5 ctx1abcde

41 

42 router = APIRouter() 5 ctx1abcde

43 

44 @router.on_event("startup") 5 ctx1abcde

45 def router_startup() -> None: 5 ctx1abcde

46 state.router_startup = True 5 ctx1abcde

47 

48 @router.on_event("shutdown") 5 ctx1abcde

49 def router_shutdown() -> None: 5 ctx1abcde

50 state.router_shutdown = True 5 ctx1abcde

51 

52 sub_router = APIRouter() 5 ctx1abcde

53 

54 @sub_router.on_event("startup") 5 ctx1abcde

55 def sub_router_startup() -> None: 5 ctx1abcde

56 state.sub_router_startup = True 5 ctx1abcde

57 

58 @sub_router.on_event("shutdown") 5 ctx1abcde

59 def sub_router_shutdown() -> None: 5 ctx1abcde

60 state.sub_router_shutdown = True 5 ctx1abcde

61 

62 router.include_router(sub_router) 5 ctx1abcde

63 app.include_router(router) 5 ctx1abcde

64 

65 assert state.app_startup is False 5 ctx1abcde

66 assert state.router_startup is False 5 ctx1abcde

67 assert state.sub_router_startup is False 5 ctx1abcde

68 assert state.app_shutdown is False 5 ctx1abcde

69 assert state.router_shutdown is False 5 ctx1abcde

70 assert state.sub_router_shutdown is False 5 ctx1abcde

71 with TestClient(app) as client: 5 ctx1abcde

72 assert state.app_startup is True 5 ctx1abcde

73 assert state.router_startup is True 5 ctx1abcde

74 assert state.sub_router_startup is True 5 ctx1abcde

75 assert state.app_shutdown is False 5 ctx1abcde

76 assert state.router_shutdown is False 5 ctx1abcde

77 assert state.sub_router_shutdown is False 5 ctx1abcde

78 response = client.get("/") 5 ctx1abcde

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

80 assert response.json() == {"message": "Hello World"} 5 ctx1abcde

81 assert state.app_startup is True 5 ctx1abcde

82 assert state.router_startup is True 5 ctx1abcde

83 assert state.sub_router_startup is True 5 ctx1abcde

84 assert state.app_shutdown is True 5 ctx1abcde

85 assert state.router_shutdown is True 5 ctx1abcde

86 assert state.sub_router_shutdown is True 5 ctx1abcde

87 

88 

89def test_app_lifespan_state(state: State) -> None: 5 ctx1klmno

90 @asynccontextmanager 5 ctx1pqrst

91 async def lifespan(app: FastAPI) -> AsyncGenerator[None, None]: 5 ctx1pqrst

92 state.app_startup = True 5 ctx1pqrst

93 yield 5 ctx1pqrst

94 state.app_shutdown = True 5 ctx1pqrst

95 

96 app = FastAPI(lifespan=lifespan) 5 ctx1pqrst

97 

98 @app.get("/") 5 ctx1pqrst

99 def main() -> Dict[str, str]: 5 ctx1pqrst

100 return {"message": "Hello World"} 5 ctx1pqrst

101 

102 assert state.app_startup is False 5 ctx1pqrst

103 assert state.app_shutdown is False 5 ctx1pqrst

104 with TestClient(app) as client: 5 ctx1pqrst

105 assert state.app_startup is True 5 ctx1pqrst

106 assert state.app_shutdown is False 5 ctx1pqrst

107 response = client.get("/") 5 ctx1pqrst

108 assert response.status_code == 200, response.text 5 ctx1pqrst

109 assert response.json() == {"message": "Hello World"} 5 ctx1pqrst

110 assert state.app_startup is True 5 ctx1pqrst

111 assert state.app_shutdown is True 5 ctx1pqrst

112 

113 

114def test_router_nested_lifespan_state(state: State) -> None: 5 ctx1klmno

115 @asynccontextmanager 5 ctx1fghij

116 async def lifespan(app: FastAPI) -> AsyncGenerator[Dict[str, bool], None]: 5 ctx1fghij

117 state.app_startup = True 5 ctx1fghij

118 yield {"app": True} 5 ctx1fghij

119 state.app_shutdown = True 5 ctx1fghij

120 

121 @asynccontextmanager 5 ctx1fghij

122 async def router_lifespan(app: FastAPI) -> AsyncGenerator[Dict[str, bool], None]: 5 ctx1fghij

123 state.router_startup = True 5 ctx1fghij

124 yield {"router": True} 5 ctx1fghij

125 state.router_shutdown = True 5 ctx1fghij

126 

127 @asynccontextmanager 5 ctx1fghij

128 async def subrouter_lifespan(app: FastAPI) -> AsyncGenerator[Dict[str, bool], None]: 5 ctx1fghij

129 state.sub_router_startup = True 5 ctx1fghij

130 yield {"sub_router": True} 5 ctx1fghij

131 state.sub_router_shutdown = True 5 ctx1fghij

132 

133 sub_router = APIRouter(lifespan=subrouter_lifespan) 5 ctx1fghij

134 

135 router = APIRouter(lifespan=router_lifespan) 5 ctx1fghij

136 router.include_router(sub_router) 5 ctx1fghij

137 

138 app = FastAPI(lifespan=lifespan) 5 ctx1fghij

139 app.include_router(router) 5 ctx1fghij

140 

141 @app.get("/") 5 ctx1fghij

142 def main(request: Request) -> Dict[str, str]: 5 ctx1fghij

143 assert request.state.app 5 ctx1fghij

144 assert request.state.router 5 ctx1fghij

145 assert request.state.sub_router 5 ctx1fghij

146 return {"message": "Hello World"} 5 ctx1fghij

147 

148 assert state.app_startup is False 5 ctx1fghij

149 assert state.router_startup is False 5 ctx1fghij

150 assert state.sub_router_startup is False 5 ctx1fghij

151 assert state.app_shutdown is False 5 ctx1fghij

152 assert state.router_shutdown is False 5 ctx1fghij

153 assert state.sub_router_shutdown is False 5 ctx1fghij

154 

155 with TestClient(app) as client: 5 ctx1fghij

156 assert state.app_startup is True 5 ctx1fghij

157 assert state.router_startup is True 5 ctx1fghij

158 assert state.sub_router_startup is True 5 ctx1fghij

159 assert state.app_shutdown is False 5 ctx1fghij

160 assert state.router_shutdown is False 5 ctx1fghij

161 assert state.sub_router_shutdown is False 5 ctx1fghij

162 response = client.get("/") 5 ctx1fghij

163 assert response.status_code == 200, response.text 5 ctx1fghij

164 assert response.json() == {"message": "Hello World"} 5 ctx1fghij

165 

166 assert state.app_startup is True 5 ctx1fghij

167 assert state.router_startup is True 5 ctx1fghij

168 assert state.sub_router_startup is True 5 ctx1fghij

169 assert state.app_shutdown is True 5 ctx1fghij

170 assert state.router_shutdown is True 5 ctx1fghij

171 assert state.sub_router_shutdown is True 5 ctx1fghij

172 

173 

174def test_router_nested_lifespan_state_overriding_by_parent() -> None: 5 ctx1klmno

175 @asynccontextmanager 5 ctx1zABCD

176 async def lifespan( 5 ctx1zABCD

177 app: FastAPI, 

178 ) -> AsyncGenerator[Dict[str, Union[str, bool]], None]: 

179 yield { 5 ctx1zABCD

180 "app_specific": True, 

181 "overridden": "app", 

182 } 

183 

184 @asynccontextmanager 5 ctx1zABCD

185 async def router_lifespan( 5 ctx1zABCD

186 app: FastAPI, 

187 ) -> AsyncGenerator[Dict[str, Union[str, bool]], None]: 

188 yield { 5 ctx1zABCD

189 "router_specific": True, 

190 "overridden": "router", # should override parent 

191 } 

192 

193 router = APIRouter(lifespan=router_lifespan) 5 ctx1zABCD

194 app = FastAPI(lifespan=lifespan) 5 ctx1zABCD

195 app.include_router(router) 5 ctx1zABCD

196 

197 with TestClient(app) as client: 5 ctx1zABCD

198 assert client.app_state == { 5 ctx1zABCD

199 "app_specific": True, 

200 "router_specific": True, 

201 "overridden": "app", 

202 } 

203 

204 

205def test_merged_no_return_lifespans_return_none() -> None: 5 ctx1klmno

206 @asynccontextmanager 5 ctx1EFGHI

207 async def lifespan(app: FastAPI) -> AsyncGenerator[None, None]: 5 ctx1EFGHI

208 yield 5 ctx1EFGHI

209 

210 @asynccontextmanager 5 ctx1EFGHI

211 async def router_lifespan(app: FastAPI) -> AsyncGenerator[None, None]: 5 ctx1EFGHI

212 yield 5 ctx1EFGHI

213 

214 router = APIRouter(lifespan=router_lifespan) 5 ctx1EFGHI

215 app = FastAPI(lifespan=lifespan) 5 ctx1EFGHI

216 app.include_router(router) 5 ctx1EFGHI

217 

218 with TestClient(app) as client: 5 ctx1EFGHI

219 assert not client.app_state 5 ctx1EFGHI

220 

221 

222def test_merged_mixed_state_lifespans() -> None: 5 ctx1klmno

223 @asynccontextmanager 5 ctx1uvwxy

224 async def lifespan(app: FastAPI) -> AsyncGenerator[None, None]: 5 ctx1uvwxy

225 yield 5 ctx1uvwxy

226 

227 @asynccontextmanager 5 ctx1uvwxy

228 async def router_lifespan(app: FastAPI) -> AsyncGenerator[Dict[str, bool], None]: 5 ctx1uvwxy

229 yield {"router": True} 5 ctx1uvwxy

230 

231 @asynccontextmanager 5 ctx1uvwxy

232 async def sub_router_lifespan(app: FastAPI) -> AsyncGenerator[None, None]: 5 ctx1uvwxy

233 yield 5 ctx1uvwxy

234 

235 sub_router = APIRouter(lifespan=sub_router_lifespan) 5 ctx1uvwxy

236 router = APIRouter(lifespan=router_lifespan) 5 ctx1uvwxy

237 app = FastAPI(lifespan=lifespan) 5 ctx1uvwxy

238 router.include_router(sub_router) 5 ctx1uvwxy

239 app.include_router(router) 5 ctx1uvwxy

240 

241 with TestClient(app) as client: 5 ctx1uvwxy

242 assert client.app_state == {"router": True} 5 ctx1uvwxy