Coverage for tests/test_router_events.py: 100%

1from contextlib import asynccontextmanager 6 ctx1mnopqr

2from typing import AsyncGenerator, Dict, Union 6 ctx1mnopqr

3 

4import pytest 6 ctx1mnopqr

5from fastapi import APIRouter, FastAPI, Request 6 ctx1mnopqr

6from fastapi.testclient import TestClient 6 ctx1mnopqr

7from pydantic import BaseModel 6 ctx1mnopqr

8 

9 

10class State(BaseModel): 6 ctx1mnopqr

11 app_startup: bool = False 6 ctx1mnopqr

12 app_shutdown: bool = False 6 ctx1mnopqr

13 router_startup: bool = False 6 ctx1mnopqr

14 router_shutdown: bool = False 6 ctx1mnopqr

15 sub_router_startup: bool = False 6 ctx1mnopqr

16 sub_router_shutdown: bool = False 6 ctx1mnopqr

17 

18 

19@pytest.fixture 6 ctx1mnopqr

20def state() -> State: 6 ctx1mnopqr

21 return State() 6 ctx1mnopqr

22 

23 

24@pytest.mark.filterwarnings( 6 ctx1mnopqr

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

26) 

27def test_router_events(state: State) -> None: 6 ctx1mnopqr

28 app = FastAPI() 6 ctx1abcdef

29 

30 @app.get("/") 6 ctx1abcdef

31 def main() -> Dict[str, str]: 6 ctx1abcdef

32 return {"message": "Hello World"} 6 ctx1abcdef

33 

34 @app.on_event("startup") 6 ctx1abcdef

35 def app_startup() -> None: 6 ctx1abcdef

36 state.app_startup = True 6 ctx1abcdef

37 

38 @app.on_event("shutdown") 6 ctx1abcdef

39 def app_shutdown() -> None: 6 ctx1abcdef

40 state.app_shutdown = True 6 ctx1abcdef

41 

42 router = APIRouter() 6 ctx1abcdef

43 

44 @router.on_event("startup") 6 ctx1abcdef

45 def router_startup() -> None: 6 ctx1abcdef

46 state.router_startup = True 6 ctx1abcdef

47 

48 @router.on_event("shutdown") 6 ctx1abcdef

49 def router_shutdown() -> None: 6 ctx1abcdef

50 state.router_shutdown = True 6 ctx1abcdef

51 

52 sub_router = APIRouter() 6 ctx1abcdef

53 

54 @sub_router.on_event("startup") 6 ctx1abcdef

55 def sub_router_startup() -> None: 6 ctx1abcdef

56 state.sub_router_startup = True 6 ctx1abcdef

57 

58 @sub_router.on_event("shutdown") 6 ctx1abcdef

59 def sub_router_shutdown() -> None: 6 ctx1abcdef

60 state.sub_router_shutdown = True 6 ctx1abcdef

61 

62 router.include_router(sub_router) 6 ctx1abcdef

63 app.include_router(router) 6 ctx1abcdef

64 

65 assert state.app_startup is False 6 ctx1abcdef

66 assert state.router_startup is False 6 ctx1abcdef

67 assert state.sub_router_startup is False 6 ctx1abcdef

68 assert state.app_shutdown is False 6 ctx1abcdef

69 assert state.router_shutdown is False 6 ctx1abcdef

70 assert state.sub_router_shutdown is False 6 ctx1abcdef

71 with TestClient(app) as client: 6 ctx1abcdef

72 assert state.app_startup is True 6 ctx1abcdef

73 assert state.router_startup is True 6 ctx1abcdef

74 assert state.sub_router_startup is True 6 ctx1abcdef

75 assert state.app_shutdown is False 6 ctx1abcdef

76 assert state.router_shutdown is False 6 ctx1abcdef

77 assert state.sub_router_shutdown is False 6 ctx1abcdef

78 response = client.get("/") 6 ctx1abcdef

79 assert response.status_code == 200, response.text 6 ctx1abcdef

80 assert response.json() == {"message": "Hello World"} 6 ctx1abcdef

81 assert state.app_startup is True 6 ctx1abcdef

82 assert state.router_startup is True 6 ctx1abcdef

83 assert state.sub_router_startup is True 6 ctx1abcdef

84 assert state.app_shutdown is True 6 ctx1abcdef

85 assert state.router_shutdown is True 6 ctx1abcdef

86 assert state.sub_router_shutdown is True 6 ctx1abcdef

87 

88 

89def test_app_lifespan_state(state: State) -> None: 6 ctx1mnopqr

90 @asynccontextmanager 6 ctx1stuvwx

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

92 state.app_startup = True 6 ctx1stuvwx

93 yield 6 ctx1stuvwx

94 state.app_shutdown = True 6 ctx1stuvwx

95 

96 app = FastAPI(lifespan=lifespan) 6 ctx1stuvwx

97 

98 @app.get("/") 6 ctx1stuvwx

99 def main() -> Dict[str, str]: 6 ctx1stuvwx

100 return {"message": "Hello World"} 6 ctx1stuvwx

101 

102 assert state.app_startup is False 6 ctx1stuvwx

103 assert state.app_shutdown is False 6 ctx1stuvwx

104 with TestClient(app) as client: 6 ctx1stuvwx

105 assert state.app_startup is True 6 ctx1stuvwx

106 assert state.app_shutdown is False 6 ctx1stuvwx

107 response = client.get("/") 6 ctx1stuvwx

108 assert response.status_code == 200, response.text 6 ctx1stuvwx

109 assert response.json() == {"message": "Hello World"} 6 ctx1stuvwx

110 assert state.app_startup is True 6 ctx1stuvwx

111 assert state.app_shutdown is True 6 ctx1stuvwx

112 

113 

114def test_router_nested_lifespan_state(state: State) -> None: 6 ctx1mnopqr

115 @asynccontextmanager 6 ctx1ghijkl

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

117 state.app_startup = True 6 ctx1ghijkl

118 yield {"app": True} 6 ctx1ghijkl

119 state.app_shutdown = True 6 ctx1ghijkl

120 

121 @asynccontextmanager 6 ctx1ghijkl

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

123 state.router_startup = True 6 ctx1ghijkl

124 yield {"router": True} 6 ctx1ghijkl

125 state.router_shutdown = True 6 ctx1ghijkl

126 

127 @asynccontextmanager 6 ctx1ghijkl

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

129 state.sub_router_startup = True 6 ctx1ghijkl

130 yield {"sub_router": True} 6 ctx1ghijkl

131 state.sub_router_shutdown = True 6 ctx1ghijkl

132 

133 sub_router = APIRouter(lifespan=subrouter_lifespan) 6 ctx1ghijkl

134 

135 router = APIRouter(lifespan=router_lifespan) 6 ctx1ghijkl

136 router.include_router(sub_router) 6 ctx1ghijkl

137 

138 app = FastAPI(lifespan=lifespan) 6 ctx1ghijkl

139 app.include_router(router) 6 ctx1ghijkl

140 

141 @app.get("/") 6 ctx1ghijkl

142 def main(request: Request) -> Dict[str, str]: 6 ctx1ghijkl

143 assert request.state.app 6 ctx1ghijkl

144 assert request.state.router 6 ctx1ghijkl

145 assert request.state.sub_router 6 ctx1ghijkl

146 return {"message": "Hello World"} 6 ctx1ghijkl

147 

148 assert state.app_startup is False 6 ctx1ghijkl

149 assert state.router_startup is False 6 ctx1ghijkl

150 assert state.sub_router_startup is False 6 ctx1ghijkl

151 assert state.app_shutdown is False 6 ctx1ghijkl

152 assert state.router_shutdown is False 6 ctx1ghijkl

153 assert state.sub_router_shutdown is False 6 ctx1ghijkl

154 

155 with TestClient(app) as client: 6 ctx1ghijkl

156 assert state.app_startup is True 6 ctx1ghijkl

157 assert state.router_startup is True 6 ctx1ghijkl

158 assert state.sub_router_startup is True 6 ctx1ghijkl

159 assert state.app_shutdown is False 6 ctx1ghijkl

160 assert state.router_shutdown is False 6 ctx1ghijkl

161 assert state.sub_router_shutdown is False 6 ctx1ghijkl

162 response = client.get("/") 6 ctx1ghijkl

163 assert response.status_code == 200, response.text 6 ctx1ghijkl

164 assert response.json() == {"message": "Hello World"} 6 ctx1ghijkl

165 

166 assert state.app_startup is True 6 ctx1ghijkl

167 assert state.router_startup is True 6 ctx1ghijkl

168 assert state.sub_router_startup is True 6 ctx1ghijkl

169 assert state.app_shutdown is True 6 ctx1ghijkl

170 assert state.router_shutdown is True 6 ctx1ghijkl

171 assert state.sub_router_shutdown is True 6 ctx1ghijkl

172 

173 

174def test_router_nested_lifespan_state_overriding_by_parent() -> None: 6 ctx1mnopqr

175 @asynccontextmanager 6 ctx1EFGHIJ

176 async def lifespan( 6 ctx1EFGHIJ

177 app: FastAPI, 

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

179 yield { 6 ctx1EFGHIJ

180 "app_specific": True, 

181 "overridden": "app", 

182 } 

183 

184 @asynccontextmanager 6 ctx1EFGHIJ

185 async def router_lifespan( 6 ctx1EFGHIJ

186 app: FastAPI, 

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

188 yield { 6 ctx1EFGHIJ

189 "router_specific": True, 

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

191 } 

192 

193 router = APIRouter(lifespan=router_lifespan) 6 ctx1EFGHIJ

194 app = FastAPI(lifespan=lifespan) 6 ctx1EFGHIJ

195 app.include_router(router) 6 ctx1EFGHIJ

196 

197 with TestClient(app) as client: 6 ctx1EFGHIJ

198 assert client.app_state == { 6 ctx1EFGHIJ

199 "app_specific": True, 

200 "router_specific": True, 

201 "overridden": "app", 

202 } 

203 

204 

205def test_merged_no_return_lifespans_return_none() -> None: 6 ctx1mnopqr

206 @asynccontextmanager 6 ctx1KLMNOP

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

208 yield 6 ctx1KLMNOP

209 

210 @asynccontextmanager 6 ctx1KLMNOP

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

212 yield 6 ctx1KLMNOP

213 

214 router = APIRouter(lifespan=router_lifespan) 6 ctx1KLMNOP

215 app = FastAPI(lifespan=lifespan) 6 ctx1KLMNOP

216 app.include_router(router) 6 ctx1KLMNOP

217 

218 with TestClient(app) as client: 6 ctx1KLMNOP

219 assert not client.app_state 6 ctx1KLMNOP

220 

221 

222def test_merged_mixed_state_lifespans() -> None: 6 ctx1mnopqr

223 @asynccontextmanager 6 ctx1yzABCD

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

225 yield 6 ctx1yzABCD

226 

227 @asynccontextmanager 6 ctx1yzABCD

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

229 yield {"router": True} 6 ctx1yzABCD

230 

231 @asynccontextmanager 6 ctx1yzABCD

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

233 yield 6 ctx1yzABCD

234 

235 sub_router = APIRouter(lifespan=sub_router_lifespan) 6 ctx1yzABCD

236 router = APIRouter(lifespan=router_lifespan) 6 ctx1yzABCD

237 app = FastAPI(lifespan=lifespan) 6 ctx1yzABCD

238 router.include_router(sub_router) 6 ctx1yzABCD

239 app.include_router(router) 6 ctx1yzABCD

240 

241 with TestClient(app) as client: 6 ctx1yzABCD

242 assert client.app_state == {"router": True} 6 ctx1yzABCD