Coverage for tests / test_ws_router.py: 100%

1import functools 4 ctx1abcd

2 

3import pytest 4 ctx1abcd

4from fastapi import ( 4 ctx1abcd

5 APIRouter, 

6 Depends, 

7 FastAPI, 

8 Header, 

9 WebSocket, 

10 WebSocketDisconnect, 

11 status, 

12) 

13from fastapi.middleware import Middleware 4 ctx1abcd

14from fastapi.testclient import TestClient 4 ctx1abcd

15 

16router = APIRouter() 4 ctx1abcd

17prefix_router = APIRouter() 4 ctx1abcd

18native_prefix_route = APIRouter(prefix="/native") 4 ctx1abcd

19app = FastAPI() 4 ctx1abcd

20 

21 

22@app.websocket_route("/") 4 ctx1abcd

23async def index(websocket: WebSocket): 4 ctx1abcd

24 await websocket.accept() 4 ctx1uvwx

25 await websocket.send_text("Hello, world!") 4 ctx1uvwx

26 await websocket.close() 4 ctx1uvwx

27 

28 

29@router.websocket_route("/router") 4 ctx1abcd

30async def routerindex(websocket: WebSocket): 4 ctx1abcd

31 await websocket.accept() 4 ctx1yzAB

32 await websocket.send_text("Hello, router!") 4 ctx1yzAB

33 await websocket.close() 4 ctx1yzAB

34 

35 

36@prefix_router.websocket_route("/") 4 ctx1abcd

37async def routerprefixindex(websocket: WebSocket): 4 ctx1abcd

38 await websocket.accept() 4 ctx1CDEF

39 await websocket.send_text("Hello, router with prefix!") 4 ctx1CDEF

40 await websocket.close() 4 ctx1CDEF

41 

42 

43@router.websocket("/router2") 4 ctx1abcd

44async def routerindex2(websocket: WebSocket): 4 ctx1abcd

45 await websocket.accept() 4 ctx1GHIJ

46 await websocket.send_text("Hello, router!") 4 ctx1GHIJ

47 await websocket.close() 4 ctx1GHIJ

48 

49 

50@router.websocket("/router/{pathparam:path}") 4 ctx1abcd

51async def routerindexparams(websocket: WebSocket, pathparam: str, queryparam: str): 4 ctx1abcd

52 await websocket.accept() 4 ctx1pqrs

53 await websocket.send_text(pathparam) 4 ctx1pqrs

54 await websocket.send_text(queryparam) 4 ctx1pqrs

55 await websocket.close() 4 ctx1pqrs

56 

57 

58async def ws_dependency(): 4 ctx1abcd

59 return "Socket Dependency" 4 ctx1KLMN

60 

61 

62@router.websocket("/router-ws-depends/") 4 ctx1abcd

63async def router_ws_decorator_depends( 4 ctx1abcd

64 websocket: WebSocket, data=Depends(ws_dependency) 

65): 

66 await websocket.accept() 8 ctx1OKPLQMRN

67 await websocket.send_text(data) 8 ctx1OKPLQMRN

68 await websocket.close() 8 ctx1OKPLQMRN

69 

70 

71@native_prefix_route.websocket("/") 4 ctx1abcd

72async def router_native_prefix_ws(websocket: WebSocket): 4 ctx1abcd

73 await websocket.accept() 4 ctx1STUV

74 await websocket.send_text("Hello, router with native prefix!") 4 ctx1STUV

75 await websocket.close() 4 ctx1STUV

76 

77 

78async def ws_dependency_err(): 4 ctx1abcd

79 raise NotImplementedError() 4 ctx1ekfg

80 

81 

82@router.websocket("/depends-err/") 4 ctx1abcd

83async def router_ws_depends_err(websocket: WebSocket, data=Depends(ws_dependency_err)): 4 ctx1abcd

84 pass # pragma: no cover 

85 

86 

87async def ws_dependency_validate(x_missing: str = Header()): 4 ctx1abcd

88 pass # pragma: no cover 

89 

90 

91@router.websocket("/depends-validate/") 4 ctx1abcd

92async def router_ws_depends_validate( 4 ctx1abcd

93 websocket: WebSocket, data=Depends(ws_dependency_validate) 

94): 

95 pass # pragma: no cover 

96 

97 

98class CustomError(Exception): 4 ctx1abcd

99 pass 4 ctx1abcd

100 

101 

102@router.websocket("/custom_error/") 4 ctx1abcd

103async def router_ws_custom_error(websocket: WebSocket): 4 ctx1abcd

104 raise CustomError() 4 ctx1mtno

105 

106 

107def make_app(app=None, **kwargs): 4 ctx1abcd

108 app = app or FastAPI(**kwargs) 13 ctx1amehbcnfidogj

109 app.include_router(router) 13 ctx1amehbcnfidogj

110 app.include_router(prefix_router, prefix="/prefix") 13 ctx1amehbcnfidogj

111 app.include_router(native_prefix_route) 13 ctx1amehbcnfidogj

112 return app 13 ctx1amehbcnfidogj

113 

114 

115app = make_app(app) 4 ctx1abcd

116 

117 

118def test_app(): 4 ctx1abcd

119 client = TestClient(app) 4 ctx1uvwx

120 with client.websocket_connect("/") as websocket: 4 ctx1uvwx

121 data = websocket.receive_text() 4 ctx1uvwx

122 assert data == "Hello, world!" 4 ctx1uvwx

123 

124 

125def test_router(): 4 ctx1abcd

126 client = TestClient(app) 4 ctx1yzAB

127 with client.websocket_connect("/router") as websocket: 4 ctx1yzAB

128 data = websocket.receive_text() 4 ctx1yzAB

129 assert data == "Hello, router!" 4 ctx1yzAB

130 

131 

132def test_prefix_router(): 4 ctx1abcd

133 client = TestClient(app) 4 ctx1CDEF

134 with client.websocket_connect("/prefix/") as websocket: 4 ctx1CDEF

135 data = websocket.receive_text() 4 ctx1CDEF

136 assert data == "Hello, router with prefix!" 4 ctx1CDEF

137 

138 

139def test_native_prefix_router(): 4 ctx1abcd

140 client = TestClient(app) 4 ctx1STUV

141 with client.websocket_connect("/native/") as websocket: 4 ctx1STUV

142 data = websocket.receive_text() 4 ctx1STUV

143 assert data == "Hello, router with native prefix!" 4 ctx1STUV

144 

145 

146def test_router2(): 4 ctx1abcd

147 client = TestClient(app) 4 ctx1GHIJ

148 with client.websocket_connect("/router2") as websocket: 4 ctx1GHIJ

149 data = websocket.receive_text() 4 ctx1GHIJ

150 assert data == "Hello, router!" 4 ctx1GHIJ

151 

152 

153def test_router_ws_depends(): 4 ctx1abcd

154 client = TestClient(app) 4 ctx1KLMN

155 with client.websocket_connect("/router-ws-depends/") as websocket: 4 ctx1KLMN

156 assert websocket.receive_text() == "Socket Dependency" 4 ctx1KLMN

157 

158 

159def test_router_ws_depends_with_override(): 4 ctx1abcd

160 client = TestClient(app) 4 ctx1OPQR

161 app.dependency_overrides[ws_dependency] = lambda: "Override" # noqa: E731 4 ctx1OPQR

162 with client.websocket_connect("/router-ws-depends/") as websocket: 4 ctx1OPQR

163 assert websocket.receive_text() == "Override" 4 ctx1OPQR

164 

165 

166def test_router_with_params(): 4 ctx1abcd

167 client = TestClient(app) 4 ctx1pqrs

168 with client.websocket_connect( 4 ctx1pqrs

169 "/router/path/to/file?queryparam=a_query_param" 

170 ) as websocket: 

171 data = websocket.receive_text() 4 ctx1pqrs

172 assert data == "path/to/file" 4 ctx1pqrs

173 data = websocket.receive_text() 4 ctx1pqrs

174 assert data == "a_query_param" 4 ctx1pqrs

175 

176 

177def test_wrong_uri(): 4 ctx1abcd

178 """ 

179 Verify that a websocket connection to a non-existent endpoing returns in a shutdown 

180 """ 

181 client = TestClient(app) 4 ctx1WXYZ

182 with pytest.raises(WebSocketDisconnect) as e: 4 ctx1WXYZ

183 with client.websocket_connect("/no-router/"): 4 ctx1WXYZ

184 pass # pragma: no cover 

185 assert e.value.code == status.WS_1000_NORMAL_CLOSURE 4 ctx1WXYZ

186 

187 

188def websocket_middleware(middleware_func): 4 ctx1abcd

189 """ 

190 Helper to create a Starlette pure websocket middleware 

191 """ 

192 

193 def middleware_constructor(app): 8 ctx1ehklfigj

194 @functools.wraps(app) 8 ctx1ehklfigj

195 async def wrapped_app(scope, receive, send): 8 ctx1ehklfigj

196 if scope["type"] != "websocket": 8 ctx1ehklfigj

197 return await app(scope, receive, send) # pragma: no cover 

198 

199 async def call_next(): 8 ctx1ehklfigj

200 return await app(scope, receive, send) 8 ctx1ehklfigj

201 

202 websocket = WebSocket(scope, receive=receive, send=send) 8 ctx1ehklfigj

203 return await middleware_func(websocket, call_next) 8 ctx1ehklfigj

204 

205 return wrapped_app 8 ctx1ehklfigj

206 

207 return middleware_constructor 8 ctx1ehklfigj

208 

209 

210def test_depend_validation(): 4 ctx1abcd

211 """ 

212 Verify that a validation in a dependency invokes the correct exception handler 

213 """ 

214 caught = [] 4 ctx1hlij

215 

216 @websocket_middleware 4 ctx1hlij

217 async def catcher(websocket, call_next): 4 ctx1hlij

218 try: 4 ctx1hlij

219 return await call_next() 4 ctx1hlij

220 except Exception as e: # pragma: no cover 

221 caught.append(e) 

222 raise 

223 

224 myapp = make_app(middleware=[Middleware(catcher)]) 4 ctx1hlij

225 

226 client = TestClient(myapp) 4 ctx1hlij

227 with pytest.raises(WebSocketDisconnect) as e: 4 ctx1hlij

228 with client.websocket_connect("/depends-validate/"): 4 ctx1hlij

229 pass # pragma: no cover 

230 # the validation error does produce a close message 

231 assert e.value.code == status.WS_1008_POLICY_VIOLATION 4 ctx1hlij

232 # and no error is leaked 

233 assert caught == [] 4 ctx1hlij

234 

235 

236def test_depend_err_middleware(): 4 ctx1abcd

237 """ 

238 Verify that it is possible to write custom WebSocket middleware to catch errors 

239 """ 

240 

241 @websocket_middleware 4 ctx1ekfg

242 async def errorhandler(websocket: WebSocket, call_next): 4 ctx1ekfg

243 try: 4 ctx1ekfg

244 return await call_next() 4 ctx1ekfg

245 except Exception as e: 4 ctx1ekfg

246 await websocket.close(code=status.WS_1006_ABNORMAL_CLOSURE, reason=repr(e)) 4 ctx1ekfg

247 

248 myapp = make_app(middleware=[Middleware(errorhandler)]) 4 ctx1ekfg

249 client = TestClient(myapp) 4 ctx1ekfg

250 with pytest.raises(WebSocketDisconnect) as e: 4 ctx1ekfg

251 with client.websocket_connect("/depends-err/"): 4 ctx1ekfg

252 pass # pragma: no cover 

253 assert e.value.code == status.WS_1006_ABNORMAL_CLOSURE 4 ctx1ekfg

254 assert "NotImplementedError" in e.value.reason 4 ctx1ekfg

255 

256 

257def test_depend_err_handler(): 4 ctx1abcd

258 """ 

259 Verify that it is possible to write custom WebSocket middleware to catch errors 

260 """ 

261 

262 async def custom_handler(websocket: WebSocket, exc: CustomError) -> None: 4 ctx1mtno

263 await websocket.close(1002, "foo") 4 ctx1mtno

264 

265 myapp = make_app(exception_handlers={CustomError: custom_handler}) 4 ctx1mtno

266 client = TestClient(myapp) 4 ctx1mtno

267 with pytest.raises(WebSocketDisconnect) as e: 4 ctx1mtno

268 with client.websocket_connect("/custom_error/"): 4 ctx1mtno

269 pass # pragma: no cover 

270 assert e.value.code == 1002 4 ctx1mtno

271 assert "foo" in e.value.reason 4 ctx1mtno