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 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651
|
import asyncio
import time
from typing import Any
from unittest import mock
import aiosignal
import pytest
from multidict import CIMultiDict
from aiohttp import WSMessage, WSMessageTypeError, WSMsgType, web
from aiohttp.http import WS_CLOSED_MESSAGE
from aiohttp.streams import EofStream
from aiohttp.test_utils import make_mocked_coro, make_mocked_request
from aiohttp.web import HTTPBadRequest, WebSocketResponse
from aiohttp.web_ws import WebSocketReady
@pytest.fixture
def app(loop):
ret = mock.Mock()
ret.loop = loop
ret._debug = False
ret.on_response_prepare = aiosignal.Signal(ret)
ret.on_response_prepare.freeze()
return ret
@pytest.fixture
def protocol():
ret = mock.Mock()
ret.set_parser.return_value = ret
return ret
@pytest.fixture
def make_request(app, protocol):
def maker(method, path, headers=None, protocols=False):
if headers is None:
headers = CIMultiDict(
{
"HOST": "server.example.com",
"UPGRADE": "websocket",
"CONNECTION": "Upgrade",
"SEC-WEBSOCKET-KEY": "dGhlIHNhbXBsZSBub25jZQ==",
"ORIGIN": "http://example.com",
"SEC-WEBSOCKET-VERSION": "13",
}
)
if protocols:
headers["SEC-WEBSOCKET-PROTOCOL"] = "chat, superchat"
return make_mocked_request(
method, path, headers, app=app, protocol=protocol, loop=app.loop
)
return maker
async def test_nonstarted_ping() -> None:
ws = WebSocketResponse()
with pytest.raises(RuntimeError):
await ws.ping()
async def test_nonstarted_pong() -> None:
ws = WebSocketResponse()
with pytest.raises(RuntimeError):
await ws.pong()
async def test_nonstarted_send_frame() -> None:
ws = WebSocketResponse()
with pytest.raises(RuntimeError):
await ws.send_frame(b"string", WSMsgType.TEXT)
async def test_nonstarted_send_str() -> None:
ws = WebSocketResponse()
with pytest.raises(RuntimeError):
await ws.send_str("string")
async def test_nonstarted_send_bytes() -> None:
ws = WebSocketResponse()
with pytest.raises(RuntimeError):
await ws.send_bytes(b"bytes")
async def test_nonstarted_send_json() -> None:
ws = WebSocketResponse()
with pytest.raises(RuntimeError):
await ws.send_json({"type": "json"})
async def test_nonstarted_close() -> None:
ws = WebSocketResponse()
with pytest.raises(RuntimeError):
await ws.close()
async def test_nonstarted_receive_str() -> None:
ws = WebSocketResponse()
with pytest.raises(RuntimeError):
await ws.receive_str()
async def test_nonstarted_receive_bytes() -> None:
ws = WebSocketResponse()
with pytest.raises(RuntimeError):
await ws.receive_bytes()
async def test_nonstarted_receive_json() -> None:
ws = WebSocketResponse()
with pytest.raises(RuntimeError):
await ws.receive_json()
async def test_receive_str_nonstring(make_request) -> None:
req = make_request("GET", "/")
ws = WebSocketResponse()
await ws.prepare(req)
async def receive():
return WSMessage(WSMsgType.BINARY, b"data", b"")
ws.receive = receive
with pytest.raises(TypeError):
await ws.receive_str()
async def test_receive_bytes_nonsbytes(make_request) -> None:
req = make_request("GET", "/")
ws = WebSocketResponse()
await ws.prepare(req)
async def receive():
return WSMessage(WSMsgType.TEXT, "data", b"")
ws.receive = receive
with pytest.raises(TypeError):
await ws.receive_bytes()
async def test_send_str_nonstring(make_request) -> None:
req = make_request("GET", "/")
ws = WebSocketResponse()
await ws.prepare(req)
with pytest.raises(TypeError):
await ws.send_str(b"bytes")
async def test_send_bytes_nonbytes(make_request) -> None:
req = make_request("GET", "/")
ws = WebSocketResponse()
await ws.prepare(req)
with pytest.raises(TypeError):
await ws.send_bytes("string")
async def test_send_json_nonjson(make_request) -> None:
req = make_request("GET", "/")
ws = WebSocketResponse()
await ws.prepare(req)
with pytest.raises(TypeError):
await ws.send_json(set())
async def test_write_non_prepared() -> None:
ws = WebSocketResponse()
with pytest.raises(RuntimeError):
await ws.write(b"data")
async def test_heartbeat_timeout(make_request: Any) -> None:
"""Verify the transport is closed when the heartbeat timeout is reached."""
loop = asyncio.get_running_loop()
future = loop.create_future()
req = make_request("GET", "/")
lowest_time = time.get_clock_info("monotonic").resolution
req._protocol._timeout_ceil_threshold = lowest_time
ws = WebSocketResponse(heartbeat=lowest_time, timeout=lowest_time)
await ws.prepare(req)
ws._req.transport.close.side_effect = lambda: future.set_result(None)
await future
assert ws.closed
def test_websocket_ready() -> None:
websocket_ready = WebSocketReady(True, "chat")
assert websocket_ready.ok is True
assert websocket_ready.protocol == "chat"
def test_websocket_not_ready() -> None:
websocket_ready = WebSocketReady(False, None)
assert websocket_ready.ok is False
assert websocket_ready.protocol is None
def test_websocket_ready_unknown_protocol() -> None:
websocket_ready = WebSocketReady(True, None)
assert websocket_ready.ok is True
assert websocket_ready.protocol is None
def test_bool_websocket_ready() -> None:
websocket_ready = WebSocketReady(True, None)
assert bool(websocket_ready) is True
def test_bool_websocket_not_ready() -> None:
websocket_ready = WebSocketReady(False, None)
assert bool(websocket_ready) is False
def test_can_prepare_ok(make_request) -> None:
req = make_request("GET", "/", protocols=True)
ws = WebSocketResponse(protocols=("chat",))
assert WebSocketReady(True, "chat") == ws.can_prepare(req)
def test_can_prepare_unknown_protocol(make_request) -> None:
req = make_request("GET", "/")
ws = WebSocketResponse()
assert WebSocketReady(True, None) == ws.can_prepare(req)
def test_can_prepare_without_upgrade(make_request) -> None:
req = make_request("GET", "/", headers=CIMultiDict({}))
ws = WebSocketResponse()
assert WebSocketReady(False, None) == ws.can_prepare(req)
async def test_can_prepare_started(make_request) -> None:
req = make_request("GET", "/")
ws = WebSocketResponse()
await ws.prepare(req)
with pytest.raises(RuntimeError) as ctx:
ws.can_prepare(req)
assert "Already started" in str(ctx.value)
def test_closed_after_ctor() -> None:
ws = WebSocketResponse()
assert not ws.closed
assert ws.close_code is None
async def test_raise_writer_limit(make_request) -> None:
"""Test the writer limit can be adjusted."""
req = make_request("GET", "/")
ws = WebSocketResponse(writer_limit=1234567)
await ws.prepare(req)
assert ws._reader is not None
assert ws._writer is not None
assert ws._writer._limit == 1234567
ws._reader.feed_data(WS_CLOSED_MESSAGE, 0)
await ws.close()
async def test_send_str_closed(make_request) -> None:
req = make_request("GET", "/")
ws = WebSocketResponse()
await ws.prepare(req)
ws._reader.feed_data(WS_CLOSED_MESSAGE, 0)
await ws.close()
assert len(ws._req.transport.close.mock_calls) == 1
with pytest.raises(ConnectionError):
await ws.send_str("string")
async def test_recv_str_closed(make_request) -> None:
req = make_request("GET", "/")
ws = web.WebSocketResponse()
await ws.prepare(req)
assert ws._reader is not None
ws._reader.feed_data(WS_CLOSED_MESSAGE, 0)
await ws.close()
with pytest.raises(
WSMessageTypeError,
match=f"Received message {WSMsgType.CLOSED}:.+ is not WSMsgType.TEXT",
):
await ws.receive_str()
async def test_send_bytes_closed(make_request) -> None:
req = make_request("GET", "/")
ws = WebSocketResponse()
await ws.prepare(req)
ws._reader.feed_data(WS_CLOSED_MESSAGE, 0)
await ws.close()
with pytest.raises(ConnectionError):
await ws.send_bytes(b"bytes")
async def test_recv_bytes_closed(make_request) -> None:
req = make_request("GET", "/")
ws = web.WebSocketResponse()
await ws.prepare(req)
assert ws._reader is not None
ws._reader.feed_data(WS_CLOSED_MESSAGE, 0)
await ws.close()
with pytest.raises(
WSMessageTypeError,
match=f"Received message {WSMsgType.CLOSED}:.+ is not WSMsgType.BINARY",
):
await ws.receive_bytes()
async def test_send_json_closed(make_request) -> None:
req = make_request("GET", "/")
ws = WebSocketResponse()
await ws.prepare(req)
ws._reader.feed_data(WS_CLOSED_MESSAGE, 0)
await ws.close()
with pytest.raises(ConnectionError):
await ws.send_json({"type": "json"})
async def test_send_frame_closed(make_request) -> None:
req = make_request("GET", "/")
ws = WebSocketResponse()
await ws.prepare(req)
assert ws._reader is not None
ws._reader.feed_data(WS_CLOSED_MESSAGE, 0)
await ws.close()
with pytest.raises(ConnectionError):
await ws.send_frame(b'{"type": "json"}', WSMsgType.TEXT)
async def test_ping_closed(make_request) -> None:
req = make_request("GET", "/")
ws = WebSocketResponse()
await ws.prepare(req)
ws._reader.feed_data(WS_CLOSED_MESSAGE, 0)
await ws.close()
with pytest.raises(ConnectionError):
await ws.ping()
async def test_pong_closed(make_request, mocker) -> None:
req = make_request("GET", "/")
ws = WebSocketResponse()
await ws.prepare(req)
ws._reader.feed_data(WS_CLOSED_MESSAGE, 0)
await ws.close()
with pytest.raises(ConnectionError):
await ws.pong()
async def test_close_idempotent(make_request) -> None:
req = make_request("GET", "/")
ws = WebSocketResponse()
await ws.prepare(req)
ws._reader.feed_data(WS_CLOSED_MESSAGE, 0)
assert await ws.close(code=1, message="message1")
assert ws.closed
assert len(ws._req.transport.close.mock_calls) == 1
assert not (await ws.close(code=2, message="message2"))
async def test_prepare_post_method_ok(make_request) -> None:
req = make_request("POST", "/")
ws = WebSocketResponse()
await ws.prepare(req)
assert ws.prepared
async def test_prepare_without_upgrade(make_request) -> None:
req = make_request("GET", "/", headers=CIMultiDict({}))
ws = WebSocketResponse()
with pytest.raises(HTTPBadRequest):
await ws.prepare(req)
async def test_wait_closed_before_start() -> None:
ws = WebSocketResponse()
with pytest.raises(RuntimeError):
await ws.close()
async def test_write_eof_not_started() -> None:
ws = WebSocketResponse()
with pytest.raises(RuntimeError):
await ws.write_eof()
async def test_write_eof_idempotent(make_request) -> None:
req = make_request("GET", "/")
ws = WebSocketResponse()
await ws.prepare(req)
assert len(ws._req.transport.close.mock_calls) == 0
ws._reader.feed_data(WS_CLOSED_MESSAGE, 0)
await ws.close()
await ws.write_eof()
await ws.write_eof()
await ws.write_eof()
assert len(ws._req.transport.close.mock_calls) == 1
async def test_receive_eofstream_in_reader(make_request, loop) -> None:
req = make_request("GET", "/")
ws = WebSocketResponse()
await ws.prepare(req)
ws._reader = mock.Mock()
exc = EofStream()
res = loop.create_future()
res.set_exception(exc)
ws._reader.read = make_mocked_coro(res)
ws._payload_writer.drain = mock.Mock()
ws._payload_writer.drain.return_value = loop.create_future()
ws._payload_writer.drain.return_value.set_result(True)
msg = await ws.receive()
assert msg.type == WSMsgType.CLOSED
assert ws.closed
async def test_receive_exception_in_reader(make_request: Any, loop: Any) -> None:
req = make_request("GET", "/")
ws = WebSocketResponse()
await ws.prepare(req)
ws._reader = mock.Mock()
exc = Exception()
res = loop.create_future()
res.set_exception(exc)
ws._reader.read = make_mocked_coro(res)
ws._payload_writer.drain = mock.Mock()
ws._payload_writer.drain.return_value = loop.create_future()
ws._payload_writer.drain.return_value.set_result(True)
msg = await ws.receive()
assert msg.type == WSMsgType.ERROR
assert ws.closed
assert len(ws._req.transport.close.mock_calls) == 1
async def test_receive_close_but_left_open(make_request: Any, loop: Any) -> None:
req = make_request("GET", "/")
ws = WebSocketResponse()
await ws.prepare(req)
close_message = WSMessage(WSMsgType.CLOSE, 1000, "close")
ws._reader = mock.Mock()
ws._reader.read = mock.AsyncMock(return_value=close_message)
ws._payload_writer.drain = mock.Mock()
ws._payload_writer.drain.return_value = loop.create_future()
ws._payload_writer.drain.return_value.set_result(True)
msg = await ws.receive()
assert msg.type == WSMsgType.CLOSE
assert ws.closed
assert len(ws._req.transport.close.mock_calls) == 1
async def test_receive_closing(make_request: Any, loop: Any) -> None:
req = make_request("GET", "/")
ws = WebSocketResponse()
await ws.prepare(req)
closing_message = WSMessage(WSMsgType.CLOSING, 1000, "closing")
ws._reader = mock.Mock()
read_mock = mock.AsyncMock(return_value=closing_message)
ws._reader.read = read_mock
ws._payload_writer.drain = mock.Mock()
ws._payload_writer.drain.return_value = loop.create_future()
ws._payload_writer.drain.return_value.set_result(True)
msg = await ws.receive()
assert msg.type == WSMsgType.CLOSING
assert not ws.closed
msg = await ws.receive()
assert msg.type == WSMsgType.CLOSING
assert not ws.closed
ws._cancel(ConnectionResetError("Connection lost"))
msg = await ws.receive()
assert msg.type == WSMsgType.CLOSING
async def test_close_after_closing(make_request: Any, loop: Any) -> None:
req = make_request("GET", "/")
ws = WebSocketResponse()
await ws.prepare(req)
closing_message = WSMessage(WSMsgType.CLOSING, 1000, "closing")
ws._reader = mock.Mock()
ws._reader.read = mock.AsyncMock(return_value=closing_message)
ws._payload_writer.drain = mock.Mock()
ws._payload_writer.drain.return_value = loop.create_future()
ws._payload_writer.drain.return_value.set_result(True)
msg = await ws.receive()
assert msg.type == WSMsgType.CLOSING
assert not ws.closed
assert len(ws._req.transport.close.mock_calls) == 0
await ws.close()
assert ws.closed
assert len(ws._req.transport.close.mock_calls) == 1
async def test_receive_timeouterror(make_request: Any, loop: Any) -> None:
req = make_request("GET", "/")
ws = WebSocketResponse()
await ws.prepare(req)
assert len(ws._req.transport.close.mock_calls) == 0
ws._reader = mock.Mock()
res = loop.create_future()
res.set_exception(asyncio.TimeoutError())
ws._reader.read = make_mocked_coro(res)
with pytest.raises(asyncio.TimeoutError):
await ws.receive()
# Should not close the connection on timeout
assert len(ws._req.transport.close.mock_calls) == 0
async def test_multiple_receive_on_close_connection(make_request) -> None:
req = make_request("GET", "/")
ws = WebSocketResponse()
await ws.prepare(req)
ws._reader.feed_data(WS_CLOSED_MESSAGE, 0)
await ws.close()
await ws.receive()
await ws.receive()
await ws.receive()
await ws.receive()
with pytest.raises(RuntimeError):
await ws.receive()
async def test_concurrent_receive(make_request) -> None:
req = make_request("GET", "/")
ws = WebSocketResponse()
await ws.prepare(req)
ws._waiting = True
with pytest.raises(RuntimeError):
await ws.receive()
async def test_close_exc(make_request) -> None:
req = make_request("GET", "/")
ws = WebSocketResponse()
await ws.prepare(req)
assert len(ws._req.transport.close.mock_calls) == 0
exc = ValueError()
ws._writer = mock.Mock()
ws._writer.close.side_effect = exc
await ws.close()
assert ws.closed
assert ws.exception() is exc
assert len(ws._req.transport.close.mock_calls) == 1
ws._closed = False
ws._writer.close.side_effect = asyncio.CancelledError()
with pytest.raises(asyncio.CancelledError):
await ws.close()
async def test_prepare_twice_idempotent(make_request) -> None:
req = make_request("GET", "/")
ws = WebSocketResponse()
impl1 = await ws.prepare(req)
impl2 = await ws.prepare(req)
assert impl1 is impl2
async def test_send_with_per_message_deflate(make_request, mocker) -> None:
req = make_request("GET", "/")
ws = WebSocketResponse()
await ws.prepare(req)
with mock.patch.object(ws._writer, "send_frame", autospec=True, spec_set=True) as m:
await ws.send_str("string", compress=15)
m.assert_called_with(b"string", WSMsgType.TEXT, compress=15)
await ws.send_bytes(b"bytes", compress=0)
m.assert_called_with(b"bytes", WSMsgType.BINARY, compress=0)
await ws.send_json("[{}]", compress=9)
m.assert_called_with(b'"[{}]"', WSMsgType.TEXT, compress=9)
await ws.send_frame(b"[{}]", WSMsgType.TEXT, compress=9)
m.assert_called_with(b"[{}]", WSMsgType.TEXT, compress=9)
async def test_no_transfer_encoding_header(make_request, mocker) -> None:
req = make_request("GET", "/")
ws = WebSocketResponse()
await ws._start(req)
assert "Transfer-Encoding" not in ws.headers
@pytest.mark.parametrize(
"ws_transport, expected_result",
[
(
mock.MagicMock(
transport=mock.MagicMock(
get_extra_info=lambda name, default=None: {"test": "existent"}.get(
name, default
)
)
),
"existent",
),
(None, "default"),
(mock.MagicMock(transport=None), "default"),
],
)
async def test_get_extra_info(
make_request, mocker, ws_transport, expected_result
) -> None:
valid_key = "test"
default_value = "default"
req = make_request("GET", "/")
ws = WebSocketResponse()
await ws.prepare(req)
ws._writer = ws_transport
assert ws.get_extra_info(valid_key, default_value) == expected_result
|