Coverage for tests/test_ws_router.py: 100%

1import functools 6 ctx1abcdef

2 

3import pytest 6 ctx1abcdef

4from fastapi import ( 6 ctx1abcdef

5 APIRouter, 

6 Depends, 

7 FastAPI, 

8 Header, 

9 WebSocket, 

10 WebSocketDisconnect, 

11 status, 

12) 

13from fastapi.middleware import Middleware 6 ctx1abcdef

14from fastapi.testclient import TestClient 6 ctx1abcdef

15 

16router = APIRouter() 6 ctx1abcdef

17prefix_router = APIRouter() 6 ctx1abcdef

18native_prefix_route = APIRouter(prefix="/native") 6 ctx1abcdef

19app = FastAPI() 6 ctx1abcdef

20 

21 

22@app.websocket_route("/") 6 ctx1abcdef

23async def index(websocket: WebSocket): 6 ctx1abcdef

24 await websocket.accept() 6 ctx1EFGHIJ

25 await websocket.send_text("Hello, world!") 6 ctx1EFGHIJ

26 await websocket.close() 6 ctx1EFGHIJ

27 

28 

29@router.websocket_route("/router") 6 ctx1abcdef

30async def routerindex(websocket: WebSocket): 6 ctx1abcdef

31 await websocket.accept() 6 ctx1KLMNOP

32 await websocket.send_text("Hello, router!") 6 ctx1KLMNOP

33 await websocket.close() 6 ctx1KLMNOP

34 

35 

36@prefix_router.websocket_route("/") 6 ctx1abcdef

37async def routerprefixindex(websocket: WebSocket): 6 ctx1abcdef

38 await websocket.accept() 6 ctx1QRSTUV

39 await websocket.send_text("Hello, router with prefix!") 6 ctx1QRSTUV

40 await websocket.close() 6 ctx1QRSTUV

41 

42 

43@router.websocket("/router2") 6 ctx1abcdef

44async def routerindex2(websocket: WebSocket): 6 ctx1abcdef

45 await websocket.accept() 6 ctx1WXYZ01

46 await websocket.send_text("Hello, router!") 6 ctx1WXYZ01

47 await websocket.close() 6 ctx1WXYZ01

48 

49 

50@router.websocket("/router/{pathparam:path}") 6 ctx1abcdef

51async def routerindexparams(websocket: WebSocket, pathparam: str, queryparam: str): 6 ctx1abcdef

52 await websocket.accept() 6 ctx1yzABCD

53 await websocket.send_text(pathparam) 6 ctx1yzABCD

54 await websocket.send_text(queryparam) 6 ctx1yzABCD

55 await websocket.close() 6 ctx1yzABCD

56 

57 

58async def ws_dependency(): 6 ctx1abcdef

59 return "Socket Dependency" 6 ctx1234567

60 

61 

62@router.websocket("/router-ws-depends/") 6 ctx1abcdef

63async def router_ws_decorator_depends( 6 ctx1abcdef

64 websocket: WebSocket, data=Depends(ws_dependency) 

65): 

66 await websocket.accept() 12 ctx128394!5#6$7%

67 await websocket.send_text(data) 12 ctx128394!5#6$7%

68 await websocket.close() 12 ctx128394!5#6$7%

69 

70 

71@native_prefix_route.websocket("/") 6 ctx1abcdef

72async def router_native_prefix_ws(websocket: WebSocket): 6 ctx1abcdef

73 await websocket.accept() 6 ctx1'()*+,

74 await websocket.send_text("Hello, router with native prefix!") 6 ctx1'()*+,

75 await websocket.close() 6 ctx1'()*+,

76 

77 

78async def ws_dependency_err(): 6 ctx1abcdef

79 raise NotImplementedError() 6 ctx1hgijkl

80 

81 

82@router.websocket("/depends-err/") 6 ctx1abcdef

83async def router_ws_depends_err(websocket: WebSocket, data=Depends(ws_dependency_err)): 6 ctx1abcdef

84 pass # pragma: no cover 

85 

86 

87async def ws_dependency_validate(x_missing: str = Header()): 6 ctx1abcdef

88 pass # pragma: no cover 

89 

90 

91@router.websocket("/depends-validate/") 6 ctx1abcdef

92async def router_ws_depends_validate( 6 ctx1abcdef

93 websocket: WebSocket, data=Depends(ws_dependency_validate) 

94): 

95 pass # pragma: no cover 

96 

97 

98class CustomError(Exception): 6 ctx1abcdef

99 pass 6 ctx1abcdef

100 

101 

102@router.websocket("/custom_error/") 6 ctx1abcdef

103async def router_ws_custom_error(websocket: WebSocket): 6 ctx1abcdef

104 raise CustomError() 6 ctx1tsuvwx

105 

106 

107def make_app(app=None, **kwargs): 6 ctx1abcdef

108 app = app or FastAPI(**kwargs) 24 ctx1athnbsgmcuiodvjpewkqfxlr

109 app.include_router(router) 24 ctx1athnbsgmcuiodvjpewkqfxlr

110 app.include_router(prefix_router, prefix="/prefix") 24 ctx1athnbsgmcuiodvjpewkqfxlr

111 app.include_router(native_prefix_route) 24 ctx1athnbsgmcuiodvjpewkqfxlr

112 return app 24 ctx1athnbsgmcuiodvjpewkqfxlr

113 

114 

115app = make_app(app) 6 ctx1abcdef

116 

117 

118def test_app(): 6 ctx1abcdef

119 client = TestClient(app) 6 ctx1EFGHIJ

120 with client.websocket_connect("/") as websocket: 6 ctx1EFGHIJ

121 data = websocket.receive_text() 6 ctx1EFGHIJ

122 assert data == "Hello, world!" 6 ctx1EFGHIJ

123 

124 

125def test_router(): 6 ctx1abcdef

126 client = TestClient(app) 6 ctx1KLMNOP

127 with client.websocket_connect("/router") as websocket: 6 ctx1KLMNOP

128 data = websocket.receive_text() 6 ctx1KLMNOP

129 assert data == "Hello, router!" 6 ctx1KLMNOP

130 

131 

132def test_prefix_router(): 6 ctx1abcdef

133 client = TestClient(app) 6 ctx1QRSTUV

134 with client.websocket_connect("/prefix/") as websocket: 6 ctx1QRSTUV

135 data = websocket.receive_text() 6 ctx1QRSTUV

136 assert data == "Hello, router with prefix!" 6 ctx1QRSTUV

137 

138 

139def test_native_prefix_router(): 6 ctx1abcdef

140 client = TestClient(app) 6 ctx1'()*+,

141 with client.websocket_connect("/native/") as websocket: 6 ctx1'()*+,

142 data = websocket.receive_text() 6 ctx1'()*+,

143 assert data == "Hello, router with native prefix!" 6 ctx1'()*+,

144 

145 

146def test_router2(): 6 ctx1abcdef

147 client = TestClient(app) 6 ctx1WXYZ01

148 with client.websocket_connect("/router2") as websocket: 6 ctx1WXYZ01

149 data = websocket.receive_text() 6 ctx1WXYZ01

150 assert data == "Hello, router!" 6 ctx1WXYZ01

151 

152 

153def test_router_ws_depends(): 6 ctx1abcdef

154 client = TestClient(app) 6 ctx1234567

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

156 assert websocket.receive_text() == "Socket Dependency" 6 ctx1234567

157 

158 

159def test_router_ws_depends_with_override(): 6 ctx1abcdef

160 client = TestClient(app) 6 ctx189!#$%

161 app.dependency_overrides[ws_dependency] = lambda: "Override" # noqa: E731 6 ctx189!#$%

162 with client.websocket_connect("/router-ws-depends/") as websocket: 6 ctx189!#$%

163 assert websocket.receive_text() == "Override" 6 ctx189!#$%

164 

165 

166def test_router_with_params(): 6 ctx1abcdef

167 client = TestClient(app) 6 ctx1yzABCD

168 with client.websocket_connect( 6 ctx1yzABCD

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

170 ) as websocket: 

171 data = websocket.receive_text() 6 ctx1yzABCD

172 assert data == "path/to/file" 6 ctx1yzABCD

173 data = websocket.receive_text() 6 ctx1yzABCD

174 assert data == "a_query_param" 6 ctx1yzABCD

175 

176 

177def test_wrong_uri(): 6 ctx1abcdef

178 """ 

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

180 """ 

181 client = TestClient(app) 6 ctx1.-/:;=

182 with pytest.raises(WebSocketDisconnect) as e: 6 ctx1.-/:;=

183 with client.websocket_connect("/no-router/"): 6 ctx1.-/:;=

184 pass # pragma: no cover 1 ctx1-

185 assert e.value.code == status.WS_1000_NORMAL_CLOSURE 6 ctx1.-/:;=

186 

187 

188def websocket_middleware(middleware_func): 6 ctx1abcdef

189 """ 

190 Helper to create a Starlette pure websocket middleware 

191 """ 

192 

193 def middleware_constructor(app): 12 ctx1hngmiojpkqlr

194 @functools.wraps(app) 12 ctx1hngmiojpkqlr

195 async def wrapped_app(scope, receive, send): 12 ctx1hngmiojpkqlr

196 if scope["type"] != "websocket": 12 ctx1hngmiojpkqlr

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

198 

199 async def call_next(): 12 ctx1hngmiojpkqlr

200 return await app(scope, receive, send) 12 ctx1hngmiojpkqlr

201 

202 websocket = WebSocket(scope, receive=receive, send=send) 12 ctx1hngmiojpkqlr

203 return await middleware_func(websocket, call_next) 12 ctx1hngmiojpkqlr

204 

205 return wrapped_app 12 ctx1hngmiojpkqlr

206 

207 return middleware_constructor 12 ctx1hngmiojpkqlr

208 

209 

210def test_depend_validation(): 6 ctx1abcdef

211 """ 

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

213 """ 

214 caught = [] 6 ctx1nmopqr

215 

216 @websocket_middleware 6 ctx1nmopqr

217 async def catcher(websocket, call_next): 6 ctx1nmopqr

218 try: 6 ctx1nmopqr

219 return await call_next() 6 ctx1nmopqr

220 except Exception as e: # pragma: no cover 

221 caught.append(e) 

222 raise 

223 

224 myapp = make_app(middleware=[Middleware(catcher)]) 6 ctx1nmopqr

225 

226 client = TestClient(myapp) 6 ctx1nmopqr

227 with pytest.raises(WebSocketDisconnect) as e: 6 ctx1nmopqr

228 with client.websocket_connect("/depends-validate/"): 6 ctx1nmopqr

229 pass # pragma: no cover 1 ctx1m

230 # the validation error does produce a close message 

231 assert e.value.code == status.WS_1008_POLICY_VIOLATION 6 ctx1nmopqr

232 # and no error is leaked 

233 assert caught == [] 6 ctx1nmopqr

234 

235 

236def test_depend_err_middleware(): 6 ctx1abcdef

237 """ 

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

239 """ 

240 

241 @websocket_middleware 6 ctx1hgijkl

242 async def errorhandler(websocket: WebSocket, call_next): 6 ctx1hgijkl

243 try: 6 ctx1hgijkl

244 return await call_next() 6 ctx1hgijkl

245 except Exception as e: 6 ctx1hgijkl

246 await websocket.close(code=status.WS_1006_ABNORMAL_CLOSURE, reason=repr(e)) 6 ctx1hgijkl

247 

248 myapp = make_app(middleware=[Middleware(errorhandler)]) 6 ctx1hgijkl

249 client = TestClient(myapp) 6 ctx1hgijkl

250 with pytest.raises(WebSocketDisconnect) as e: 6 ctx1hgijkl

251 with client.websocket_connect("/depends-err/"): 6 ctx1hgijkl

252 pass # pragma: no cover 1 ctx1g

253 assert e.value.code == status.WS_1006_ABNORMAL_CLOSURE 6 ctx1hgijkl

254 assert "NotImplementedError" in e.value.reason 6 ctx1hgijkl

255 

256 

257def test_depend_err_handler(): 6 ctx1abcdef

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: 6 ctx1tsuvwx

263 await websocket.close(1002, "foo") 6 ctx1tsuvwx

264 

265 myapp = make_app(exception_handlers={CustomError: custom_handler}) 6 ctx1tsuvwx

266 client = TestClient(myapp) 6 ctx1tsuvwx

267 with pytest.raises(WebSocketDisconnect) as e: 6 ctx1tsuvwx

268 with client.websocket_connect("/custom_error/"): 6 ctx1tsuvwx

269 pass # pragma: no cover 1 ctx1s

270 assert e.value.code == 1002 6 ctx1tsuvwx

271 assert "foo" in e.value.reason 6 ctx1tsuvwx