Coverage for tests/test_ws_router.py: 100%

1import functools 5 ctx1bacde

2 

3import pytest 5 ctx1bacde

4from fastapi import ( 5 ctx1bacde

5 APIRouter, 

6 Depends, 

7 FastAPI, 

8 Header, 

9 WebSocket, 

10 WebSocketDisconnect, 

11 status, 

12) 

13from fastapi.middleware import Middleware 5 ctx1bacde

14from fastapi.testclient import TestClient 5 ctx1bacde

15 

16router = APIRouter() 5 ctx1bacde

17prefix_router = APIRouter() 5 ctx1bacde

18native_prefix_route = APIRouter(prefix="/native") 5 ctx1bacde

19app = FastAPI() 5 ctx1bacde

20 

21 

22@app.websocket_route("/") 5 ctx1bacde

23async def index(websocket: WebSocket): 5 ctx1bacde

24 await websocket.accept() 5 ctx1bacde

25 await websocket.send_text("Hello, world!") 5 ctx1bacde

26 await websocket.close() 5 ctx1bacde

27 

28 

29@router.websocket_route("/router") 5 ctx1bacde

30async def routerindex(websocket: WebSocket): 5 ctx1bacde

31 await websocket.accept() 5 ctx1bacde

32 await websocket.send_text("Hello, router!") 5 ctx1bacde

33 await websocket.close() 5 ctx1bacde

34 

35 

36@prefix_router.websocket_route("/") 5 ctx1bacde

37async def routerprefixindex(websocket: WebSocket): 5 ctx1bacde

38 await websocket.accept() 5 ctx1bacde

39 await websocket.send_text("Hello, router with prefix!") 5 ctx1bacde

40 await websocket.close() 5 ctx1bacde

41 

42 

43@router.websocket("/router2") 5 ctx1bacde

44async def routerindex2(websocket: WebSocket): 5 ctx1bacde

45 await websocket.accept() 5 ctx1bacde

46 await websocket.send_text("Hello, router!") 5 ctx1bacde

47 await websocket.close() 5 ctx1bacde

48 

49 

50@router.websocket("/router/{pathparam:path}") 5 ctx1bacde

51async def routerindexparams(websocket: WebSocket, pathparam: str, queryparam: str): 5 ctx1bacde

52 await websocket.accept() 5 ctx1bacde

53 await websocket.send_text(pathparam) 5 ctx1bacde

54 await websocket.send_text(queryparam) 5 ctx1bacde

55 await websocket.close() 5 ctx1bacde

56 

57 

58async def ws_dependency(): 5 ctx1bacde

59 return "Socket Dependency" 5 ctx1bacde

60 

61 

62@router.websocket("/router-ws-depends/") 5 ctx1bacde

63async def router_ws_decorator_depends( 5 ctx1bacde

64 websocket: WebSocket, data=Depends(ws_dependency) 

65): 

66 await websocket.accept() 5 ctx1bacde

67 await websocket.send_text(data) 5 ctx1bacde

68 await websocket.close() 5 ctx1bacde

69 

70 

71@native_prefix_route.websocket("/") 5 ctx1bacde

72async def router_native_prefix_ws(websocket: WebSocket): 5 ctx1bacde

73 await websocket.accept() 5 ctx1bacde

74 await websocket.send_text("Hello, router with native prefix!") 5 ctx1bacde

75 await websocket.close() 5 ctx1bacde

76 

77 

78async def ws_dependency_err(): 5 ctx1bacde

79 raise NotImplementedError() 5 ctx1bacde

80 

81 

82@router.websocket("/depends-err/") 5 ctx1bacde

83async def router_ws_depends_err(websocket: WebSocket, data=Depends(ws_dependency_err)): 5 ctx1bacde

84 pass # pragma: no cover 

85 

86 

87async def ws_dependency_validate(x_missing: str = Header()): 5 ctx1bacde

88 pass # pragma: no cover 

89 

90 

91@router.websocket("/depends-validate/") 5 ctx1bacde

92async def router_ws_depends_validate( 5 ctx1bacde

93 websocket: WebSocket, data=Depends(ws_dependency_validate) 

94): 

95 pass # pragma: no cover 

96 

97 

98class CustomError(Exception): 5 ctx1bacde

99 pass 5 ctx1bacde

100 

101 

102@router.websocket("/custom_error/") 5 ctx1bacde

103async def router_ws_custom_error(websocket: WebSocket): 5 ctx1bacde

104 raise CustomError() 5 ctx1bacde

105 

106 

107def make_app(app=None, **kwargs): 5 ctx1bacde

108 app = app or FastAPI(**kwargs) 5 ctx1bacde

109 app.include_router(router) 5 ctx1bacde

110 app.include_router(prefix_router, prefix="/prefix") 5 ctx1bacde

111 app.include_router(native_prefix_route) 5 ctx1bacde

112 return app 5 ctx1bacde

113 

114 

115app = make_app(app) 5 ctx1bacde

116 

117 

118def test_app(): 5 ctx1bacde

119 client = TestClient(app) 5 ctx1bacde

120 with client.websocket_connect("/") as websocket: 5 ctx1bacde

121 data = websocket.receive_text() 5 ctx1bacde

122 assert data == "Hello, world!" 5 ctx1bacde

123 

124 

125def test_router(): 5 ctx1bacde

126 client = TestClient(app) 5 ctx1bacde

127 with client.websocket_connect("/router") as websocket: 5 ctx1bacde

128 data = websocket.receive_text() 5 ctx1bacde

129 assert data == "Hello, router!" 5 ctx1bacde

130 

131 

132def test_prefix_router(): 5 ctx1bacde

133 client = TestClient(app) 5 ctx1bacde

134 with client.websocket_connect("/prefix/") as websocket: 5 ctx1bacde

135 data = websocket.receive_text() 5 ctx1bacde

136 assert data == "Hello, router with prefix!" 5 ctx1bacde

137 

138 

139def test_native_prefix_router(): 5 ctx1bacde

140 client = TestClient(app) 5 ctx1bacde

141 with client.websocket_connect("/native/") as websocket: 5 ctx1bacde

142 data = websocket.receive_text() 5 ctx1bacde

143 assert data == "Hello, router with native prefix!" 5 ctx1bacde

144 

145 

146def test_router2(): 5 ctx1bacde

147 client = TestClient(app) 5 ctx1bacde

148 with client.websocket_connect("/router2") as websocket: 5 ctx1bacde

149 data = websocket.receive_text() 5 ctx1bacde

150 assert data == "Hello, router!" 5 ctx1bacde

151 

152 

153def test_router_ws_depends(): 5 ctx1bacde

154 client = TestClient(app) 5 ctx1bacde

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

156 assert websocket.receive_text() == "Socket Dependency" 5 ctx1bacde

157 

158 

159def test_router_ws_depends_with_override(): 5 ctx1bacde

160 client = TestClient(app) 5 ctx1bacde

161 app.dependency_overrides[ws_dependency] = lambda: "Override" # noqa: E731 5 ctx1bacde

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

163 assert websocket.receive_text() == "Override" 5 ctx1bacde

164 

165 

166def test_router_with_params(): 5 ctx1bacde

167 client = TestClient(app) 5 ctx1bacde

168 with client.websocket_connect( 5 ctx1bacde

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

170 ) as websocket: 

171 data = websocket.receive_text() 5 ctx1bacde

172 assert data == "path/to/file" 5 ctx1bacde

173 data = websocket.receive_text() 5 ctx1bacde

174 assert data == "a_query_param" 5 ctx1bacde

175 

176 

177def test_wrong_uri(): 5 ctx1bacde

178 """ 

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

180 """ 

181 client = TestClient(app) 5 ctx1bacde

182 with pytest.raises(WebSocketDisconnect) as e: 5 ctx1bacde

183 with client.websocket_connect("/no-router/"): 5 ctx1bacde

184 pass # pragma: no cover 1 ctx1a

185 assert e.value.code == status.WS_1000_NORMAL_CLOSURE 5 ctx1bacde

186 

187 

188def websocket_middleware(middleware_func): 5 ctx1bacde

189 """ 

190 Helper to create a Starlette pure websocket middleware 

191 """ 

192 

193 def middleware_constructor(app): 5 ctx1bacde

194 @functools.wraps(app) 5 ctx1bacde

195 async def wrapped_app(scope, receive, send): 5 ctx1bacde

196 if scope["type"] != "websocket": 5 ctx1bacde

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

198 

199 async def call_next(): 5 ctx1bacde

200 return await app(scope, receive, send) 5 ctx1bacde

201 

202 websocket = WebSocket(scope, receive=receive, send=send) 5 ctx1bacde

203 return await middleware_func(websocket, call_next) 5 ctx1bacde

204 

205 return wrapped_app 5 ctx1bacde

206 

207 return middleware_constructor 5 ctx1bacde

208 

209 

210def test_depend_validation(): 5 ctx1bacde

211 """ 

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

213 """ 

214 caught = [] 5 ctx1bacde

215 

216 @websocket_middleware 5 ctx1bacde

217 async def catcher(websocket, call_next): 5 ctx1bacde

218 try: 5 ctx1bacde

219 return await call_next() 5 ctx1bacde

220 except Exception as e: # pragma: no cover 

221 caught.append(e) 

222 raise 

223 

224 myapp = make_app(middleware=[Middleware(catcher)]) 5 ctx1bacde

225 

226 client = TestClient(myapp) 5 ctx1bacde

227 with pytest.raises(WebSocketDisconnect) as e: 5 ctx1bacde

228 with client.websocket_connect("/depends-validate/"): 5 ctx1bacde

229 pass # pragma: no cover 1 ctx1a

230 # the validation error does produce a close message 

231 assert e.value.code == status.WS_1008_POLICY_VIOLATION 5 ctx1bacde

232 # and no error is leaked 

233 assert caught == [] 5 ctx1bacde

234 

235 

236def test_depend_err_middleware(): 5 ctx1bacde

237 """ 

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

239 """ 

240 

241 @websocket_middleware 5 ctx1bacde

242 async def errorhandler(websocket: WebSocket, call_next): 5 ctx1bacde

243 try: 5 ctx1bacde

244 return await call_next() 5 ctx1bacde

245 except Exception as e: 5 ctx1bacde

246 await websocket.close(code=status.WS_1006_ABNORMAL_CLOSURE, reason=repr(e)) 5 ctx1bacde

247 

248 myapp = make_app(middleware=[Middleware(errorhandler)]) 5 ctx1bacde

249 client = TestClient(myapp) 5 ctx1bacde

250 with pytest.raises(WebSocketDisconnect) as e: 5 ctx1bacde

251 with client.websocket_connect("/depends-err/"): 5 ctx1bacde

252 pass # pragma: no cover 1 ctx1a

253 assert e.value.code == status.WS_1006_ABNORMAL_CLOSURE 5 ctx1bacde

254 assert "NotImplementedError" in e.value.reason 5 ctx1bacde

255 

256 

257def test_depend_err_handler(): 5 ctx1bacde

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: 5 ctx1bacde

263 await websocket.close(1002, "foo") 5 ctx1bacde

264 

265 myapp = make_app(exception_handlers={CustomError: custom_handler}) 5 ctx1bacde

266 client = TestClient(myapp) 5 ctx1bacde

267 with pytest.raises(WebSocketDisconnect) as e: 5 ctx1bacde

268 with client.websocket_connect("/custom_error/"): 5 ctx1bacde

269 pass # pragma: no cover 1 ctx1a

270 assert e.value.code == 1002 5 ctx1bacde

271 assert "foo" in e.value.reason 5 ctx1bacde