-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathtest_websocket_handler.py
More file actions
361 lines (285 loc) · 12.4 KB
/
Copy pathtest_websocket_handler.py
File metadata and controls
361 lines (285 loc) · 12.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
import typing as t
import pytest
from ellar.common import Controller, Inject, ModuleRouter, WsBody, ws_route
from ellar.common.constants import CONTROLLER_OPERATION_HANDLER_KEY
from ellar.common.exceptions import (
ImproperConfiguration,
WebSocketRequestValidationError,
)
from ellar.core.routing.websocket import WebSocketExtraHandler
from ellar.reflect import reflect
from ellar.testing import Test
from starlette.websockets import WebSocket, WebSocketState
from .schema import Item
router = ModuleRouter("/router")
@router.ws_route("/ws-with-handler", use_extra_handler=True)
async def websocket_with_handler(
websocket: Inject[WebSocket],
query: str,
items: WsBody[t.List[str]],
data: Item = WsBody(),
):
assert query == "my-query"
await websocket.send_json({**data.model_dump(), "others": items})
await websocket.close()
@router.ws_route.connect(websocket_with_handler)
async def websocket_with_handler_connect(websocket: WebSocket):
await websocket.accept()
@router.ws_route.disconnect(websocket_with_handler)
async def websocket_with_handler_disconnect(websocket: WebSocket, code: int):
# await websocket.close(code=code)
assert websocket.client_state == WebSocketState.DISCONNECTED
@router.ws_route("/ws")
async def websocket_without_handler(websocket: Inject[WebSocket], query: str):
assert query == "my-query"
await websocket.accept()
message = await websocket.receive_text()
await websocket.send_json({"message": f"Thanks. {message}"})
await websocket.close()
@Controller("/controller")
class WebsocketController:
@ws_route("/ws-with-handler", use_extra_handler=True)
async def websocket_with_handler_c(
self,
websocket: Inject[WebSocket],
query: str,
items: WsBody[t.List[str]],
data: Item = WsBody(),
):
assert query == "my-query"
await websocket.send_json({**data.model_dump(), "others": items})
await websocket.close()
@ws_route.connect(websocket_with_handler_c)
async def websocket_with_handler_connect(self, websocket: WebSocket):
await websocket.accept()
@ws_route.disconnect(websocket_with_handler_c)
async def websocket_with_handler_disconnect(self, websocket: WebSocket, code: int):
# await websocket.close(code=code)
assert websocket.client_state == WebSocketState.DISCONNECTED
@ws_route("/ws")
async def websocket_without_handler_c(
self, websocket: Inject[WebSocket], query: str
):
assert query == "my-query"
await websocket.accept()
message = await websocket.receive_text()
await websocket.send_json({"message": f"Thanks. {message}"})
await websocket.close()
tm = Test.create_test_module(routers=[router], controllers=(WebsocketController,))
client = tm.get_test_client()
@pytest.mark.parametrize("prefix", ["/router", "/controller"])
def test_websocket_with_handler_works(prefix):
with client.websocket_connect(
f"{prefix}/ws-with-handler?query=my-query"
) as session:
session.send_json(
{
"data": Item(name="Ellar", price=23.34, tax=1.2).model_dump(),
"items": ["Python", "Ellar"],
}
)
message = session.receive_json()
assert message == {
"description": None,
"name": "Ellar",
"others": ["Python", "Ellar"],
"price": 23.34,
"tax": 1.2,
}
@pytest.mark.parametrize("prefix", ["/router", "/controller"])
def test_websocket_with_handler_fails_for_invalid_input(prefix):
with pytest.raises(AssertionError):
with client.websocket_connect(
f"{prefix}/ws-with-handler?query=my-query"
) as session:
session.send_json({"framework": "Ellar is awesome"})
# message = session.receive_json()
# assert message == {
# "code": 1008,
# "errors": [
# {
# "type": "missing",
# "loc": ["body", "items"],
# "msg": "Field required",
# "input": None,
# "url": pydantic_error_url("missing"),
# },
# {
# "type": "missing",
# "loc": ["body", "data"],
# "msg": "Field required",
# "input": None,
# "url": pydantic_error_url("missing"),
# },
# ],
# }
@pytest.mark.parametrize("prefix", ["/router", "/controller"])
def test_websocket_with_handler_fails_for_missing_route_parameter(prefix):
with pytest.raises(WebSocketRequestValidationError):
with client.websocket_connect(f"{prefix}/ws-with-handler") as session:
session.send_json(Item(name="Ellar", price=23.34, tax=1.2).model_dump())
# message = session.receive_json()
# assert message == {
# "code": 1008,
# "errors": [
# {
# "input": None,
# "loc": ["query", "query"],
# "msg": "Field required",
# "type": "missing",
# "url": pydantic_error_url("missing"),
# }
# ],
# }
@pytest.mark.parametrize("prefix", ["/router", "/controller"])
def test_plain_websocket_route(prefix):
with client.websocket_connect(f"{prefix}/ws?query=my-query") as websocket:
websocket.send_text("Ellar")
message = websocket.receive_json()
assert message == {"message": "Thanks. Ellar"}
def test_websocket_setup_fails_when_using_body_without_handler():
with pytest.raises(
ImproperConfiguration,
match=r"`WsBody` should only be used when `use_extra_handler` flag is set to True in WsRoute",
):
@router.ws_route("/ws-with-handler", use_extra_handler=False)
async def websocket_with_handler(
websocket: Inject[WebSocket], query: str, data: Item = WsBody()
):
pass
Test.create_test_module(routers=[websocket_with_handler]).create_application()
def test_websocket_endpoint_on_connect():
@Controller("/ws")
class WebSocketSample:
@ws_route(use_extra_handler=True)
async def ws(self, websocket: Inject[WebSocket]):
pass
@ws_route.connect(ws)
async def on_connect(self, websocket):
assert websocket["subprotocols"] == ["soap", "wamp"]
await websocket.accept(subprotocol="wamp")
_client = Test.create_test_module(controllers=(WebSocketSample,)).get_test_client()
with _client.websocket_connect("/ws/", subprotocols=["soap", "wamp"]) as websocket:
assert websocket.accepted_subprotocol == "wamp"
def test_websocket_endpoint_on_receive_bytes():
@Controller("/ws")
class WebSocketSample:
@ws_route(use_extra_handler=True, encoding="bytes")
async def ws(self, websocket: Inject[WebSocket], data: bytes = WsBody()):
await websocket.send_bytes(b"Message bytes was: " + data)
_client = Test.create_test_module(controllers=(WebSocketSample,)).get_test_client()
with _client.websocket_connect("/ws/") as websocket:
websocket.send_bytes(b"Hello, world!")
_bytes = websocket.receive_bytes()
assert _bytes == b"Message bytes was: Hello, world!"
with pytest.raises(RuntimeError):
with _client.websocket_connect("/ws/") as websocket:
websocket.send_text("Hello world")
def test_websocket_endpoint_on_receive_json():
@Controller("/ws")
class WebSocketSample:
@ws_route(use_extra_handler=True, encoding="json")
async def ws(self, websocket_: Inject[WebSocket], data=WsBody()):
await websocket_.send_json({"message": data})
_client = Test.create_test_module(controllers=(WebSocketSample,)).get_test_client()
with _client.websocket_connect("/ws/") as websocket:
websocket.send_json({"hello": "world"})
data = websocket.receive_json()
assert data == {"message": {"hello": "world"}}
with pytest.raises(RuntimeError):
with _client.websocket_connect("/ws/") as websocket:
websocket.send_text("Hello world")
def test_websocket_endpoint_on_receive_json_binary():
@Controller("/ws")
class WebSocketSample:
@ws_route(use_extra_handler=True, encoding="json")
async def ws(self, websocket_: Inject[WebSocket], data=WsBody()):
await websocket_.send_json({"message": data}, mode="binary")
_client = Test.create_test_module(controllers=(WebSocketSample,)).get_test_client()
with _client.websocket_connect("/ws/") as websocket:
websocket.send_json({"hello": "world"}, mode="binary")
data = websocket.receive_json(mode="binary")
assert data == {"message": {"hello": "world"}}
def test_websocket_endpoint_on_receive_text():
@Controller("/ws")
class WebSocketSample:
@ws_route(use_extra_handler=True, encoding="text")
async def ws(self, websocket_: Inject[WebSocket], data: str = WsBody()):
await websocket_.send_text(f"Message text was: {data}")
_client = Test.create_test_module(controllers=(WebSocketSample,)).get_test_client()
with _client.websocket_connect("/ws/") as websocket:
websocket.send_text("Hello, world!")
_text = websocket.receive_text()
assert _text == "Message text was: Hello, world!"
with pytest.raises(RuntimeError):
with _client.websocket_connect("/ws/") as websocket:
websocket.send_bytes(b"Hello world")
def test_websocket_endpoint_on_default():
@Controller("/ws")
class WebSocketSample:
@ws_route(use_extra_handler=True, encoding=None)
async def ws(self, websocket_: Inject[WebSocket], data: str = WsBody()):
await websocket_.send_text(f"Message text was: {data}")
_client = Test.create_test_module(controllers=(WebSocketSample,)).get_test_client()
with _client.websocket_connect("/ws/") as websocket:
websocket.send_text("Hello, world!")
_text = websocket.receive_text()
assert _text == "Message text was: Hello, world!"
def test_websocket_endpoint_on_disconnect():
@Controller("/ws")
class WebSocketSample:
@ws_route(use_extra_handler=True, encoding=None)
async def ws(self, websocket_: Inject[WebSocket], data: str = WsBody()):
await websocket_.send_text(f"Message text was: {data}")
@ws_route.disconnect(ws)
async def on_disconnect(self, websocket_: WebSocket, close_code):
assert close_code == 1001
await websocket_.close(code=close_code)
_client = Test.create_test_module(controllers=(WebSocketSample,)).get_test_client()
with _client.websocket_connect("/ws/") as websocket:
websocket.send_text("Hello, world!")
websocket.close(code=1001)
def test_ws_route_connect_raise_exception_for_invalid_type():
with pytest.raises(
Exception,
match="Invalid type. Please make sure you passed the websocket handler.",
):
@router.ws_route.connect(ModuleRouter)
def some_example_connect():
pass
def test_ws_route_connect_raise_exception_for_invalid_operation():
with pytest.raises(
Exception,
match="Invalid type. Please make sure you passed the websocket handler.",
):
@router.ws_route.connect(websocket_with_handler_connect)
def some_example_connect():
pass
def test_add_websocket_handler_raise_exception_for_wrong_handler_name():
websocket_operation = reflect.get_metadata(
CONTROLLER_OPERATION_HANDLER_KEY, websocket_with_handler
)
with pytest.raises(Exception) as ex:
websocket_operation.add_websocket_handler(
handler_name="mycustomname", handler=websocket_with_handler_connect
)
assert (
str(ex.value)
== "Invalid Handler Name. Handler Name must be in ['encoding', 'on_receive', 'on_connect', 'on_disconnect']"
)
websocket_operation.add_websocket_handler(
handler_name="on_receive", handler=websocket_with_handler_connect
)
def test_websocket_handler_fails_for_invalid_handlers():
a_type = type("AType", (), {})
with pytest.raises(ValueError):
@ws_route(extra_handler_type=a_type)
def invalid_ws_route():
pass
with pytest.raises(ValueError):
@ws_route(extra_handler_type=a_type())
def invalid_ws_route_case_2():
pass
@ws_route(extra_handler_type=WebSocketExtraHandler)
def valid_ws_route():
pass