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 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650
|
import asyncio
import contextlib
import functools
import http
import logging
import platform
import random
import re
import socket
import ssl
import sys
import unittest
import urllib.error
import urllib.request
import warnings
from unittest.mock import patch
from websockets.asyncio.compatibility import asyncio_timeout
from websockets.datastructures import Headers
from websockets.exceptions import (
ConnectionClosed,
InvalidHandshake,
InvalidHeader,
NegotiationError,
)
from websockets.extensions.permessage_deflate import (
ClientPerMessageDeflateFactory,
PerMessageDeflate,
ServerPerMessageDeflateFactory,
)
from websockets.frames import CloseCode
from websockets.http11 import USER_AGENT
from websockets.legacy.client import *
from websockets.legacy.exceptions import InvalidStatusCode
from websockets.legacy.handshake import build_response
from websockets.legacy.http import read_response
from websockets.legacy.server import *
from websockets.protocol import State
from websockets.uri import parse_uri
from ..extensions.utils import (
ClientNoOpExtensionFactory,
NoOpExtension,
ServerNoOpExtensionFactory,
)
from ..utils import CERTIFICATE, MS, temp_unix_socket_path
from .utils import AsyncioTestCase
async def default_handler(ws):
if ws.path == "/deprecated_attributes":
await ws.recv() # delay that allows catching warnings
await ws.send(repr((ws.host, ws.port, ws.secure)))
elif ws.path == "/close_timeout":
await ws.send(repr(ws.close_timeout))
elif ws.path == "/path":
await ws.send(str(ws.path))
elif ws.path == "/headers":
await ws.send(repr(ws.request_headers))
await ws.send(repr(ws.response_headers))
elif ws.path == "/extensions":
await ws.send(repr(ws.extensions))
elif ws.path == "/subprotocol":
await ws.send(repr(ws.subprotocol))
elif ws.path == "/slow_stop":
await ws.wait_closed()
await asyncio.sleep(2 * MS)
else:
await ws.send(await ws.recv())
async def redirect_request(path, headers, test, status):
if path == "/absolute_redirect":
location = get_server_uri(test.server, test.secure, "/")
elif path == "/relative_redirect":
location = "/"
elif path == "/infinite":
location = get_server_uri(test.server, test.secure, "/infinite")
elif path == "/force_secure":
location = get_server_uri(test.server, True, "/")
elif path == "/force_insecure":
location = get_server_uri(test.server, False, "/")
elif path == "/missing_location":
return status, {}, b""
else:
return None
return status, {"Location": location}, b""
@contextlib.contextmanager
def temp_test_server(test, **kwargs):
test.start_server(**kwargs)
try:
yield
finally:
test.stop_server()
def temp_test_redirecting_server(test, status=http.HTTPStatus.FOUND, **kwargs):
process_request = functools.partial(redirect_request, test=test, status=status)
return temp_test_server(test, process_request=process_request, **kwargs)
@contextlib.contextmanager
def temp_test_client(test, *args, **kwargs):
test.start_client(*args, **kwargs)
try:
yield
finally:
test.stop_client()
def with_manager(manager, *args, **kwargs):
"""
Return a decorator that wraps a function with a context manager.
"""
def decorate(func):
@functools.wraps(func)
def _decorate(self, *_args, **_kwargs):
with manager(self, *args, **kwargs):
return func(self, *_args, **_kwargs)
return _decorate
return decorate
def with_server(**kwargs):
"""
Return a decorator for TestCase methods that starts and stops a server.
"""
return with_manager(temp_test_server, **kwargs)
def with_client(*args, **kwargs):
"""
Return a decorator for TestCase methods that starts and stops a client.
"""
return with_manager(temp_test_client, *args, **kwargs)
def get_server_address(server):
"""
Return an address on which the given server listens.
"""
# Pick a random socket in order to test both IPv4 and IPv6 on systems
# where both are available. Randomizing tests is usually a bad idea. If
# needed, either use the first socket, or test separately IPv4 and IPv6.
server_socket = random.choice(server.sockets)
if server_socket.family == socket.AF_INET6: # pragma: no cover
return server_socket.getsockname()[:2] # (no IPv6 on CI)
elif server_socket.family == socket.AF_INET:
return server_socket.getsockname()
else: # pragma: no cover
raise ValueError("expected an IPv6, IPv4, or Unix socket")
def get_server_uri(server, secure=False, resource_name="/", user_info=None):
"""
Return a WebSocket URI for connecting to the given server.
"""
proto = "wss" if secure else "ws"
user_info = ":".join(user_info) + "@" if user_info else ""
host, port = get_server_address(server)
if ":" in host: # IPv6 address
host = f"[{host}]"
return f"{proto}://{user_info}{host}:{port}{resource_name}"
class UnauthorizedServerProtocol(WebSocketServerProtocol):
async def process_request(self, path, request_headers):
# Test returning headers as a Headers instance (1/3)
return http.HTTPStatus.UNAUTHORIZED, Headers([("X-Access", "denied")]), b""
class ForbiddenServerProtocol(WebSocketServerProtocol):
async def process_request(self, path, request_headers):
# Test returning headers as a dict (2/3)
return http.HTTPStatus.FORBIDDEN, {"X-Access": "denied"}, b""
class HealthCheckServerProtocol(WebSocketServerProtocol):
async def process_request(self, path, request_headers):
# Test returning headers as a list of pairs (3/3)
if path == "/__health__/":
return http.HTTPStatus.OK, [("X-Access", "OK")], b"status = green\n"
class ProcessRequestReturningIntProtocol(WebSocketServerProtocol):
async def process_request(self, path, request_headers):
assert path == "/__health__/"
return 200, [], b"OK\n"
class SlowOpeningHandshakeProtocol(WebSocketServerProtocol):
async def process_request(self, path, request_headers):
await asyncio.sleep(10 * MS)
class FooClientProtocol(WebSocketClientProtocol):
pass
class BarClientProtocol(WebSocketClientProtocol):
pass
class ClientServerTestsMixin:
secure = False
def setUp(self):
super().setUp()
self.server = None
def start_server(self, deprecation_warnings=None, **kwargs):
handler = kwargs.pop("handler", default_handler)
# Disable compression by default in tests.
kwargs.setdefault("compression", None)
# Disable pings by default in tests.
kwargs.setdefault("ping_interval", None)
# This logic is encapsulated in a coroutine to prevent it from executing
# before the event loop is running which causes asyncio.get_event_loop()
# to raise a DeprecationWarning on Python ≥ 3.10.
async def start_server():
return await serve(handler, "localhost", 0, **kwargs)
with warnings.catch_warnings(record=True) as recorded_warnings:
warnings.simplefilter("always")
self.server = self.loop.run_until_complete(start_server())
expected_warnings = [] if deprecation_warnings is None else deprecation_warnings
self.assertDeprecationWarnings(recorded_warnings, expected_warnings)
def start_client(
self, resource_name="/", user_info=None, deprecation_warnings=None, **kwargs
):
# Disable compression by default in tests.
kwargs.setdefault("compression", None)
# Disable pings by default in tests.
kwargs.setdefault("ping_interval", None)
secure = kwargs.get("ssl") is not None
try:
server_uri = kwargs.pop("uri")
except KeyError:
server_uri = get_server_uri(self.server, secure, resource_name, user_info)
# This logic is encapsulated in a coroutine to prevent it from executing
# before the event loop is running which causes asyncio.get_event_loop()
# to raise a DeprecationWarning on Python ≥ 3.10.
async def start_client():
return await connect(server_uri, **kwargs)
with warnings.catch_warnings(record=True) as recorded_warnings:
warnings.simplefilter("always")
self.client = self.loop.run_until_complete(start_client())
expected_warnings = [] if deprecation_warnings is None else deprecation_warnings
self.assertDeprecationWarnings(recorded_warnings, expected_warnings)
def stop_client(self):
self.loop.run_until_complete(
asyncio.wait_for(self.client.close_connection_task, timeout=1)
)
def stop_server(self):
self.server.close()
self.loop.run_until_complete(
asyncio.wait_for(self.server.wait_closed(), timeout=1)
)
@contextlib.contextmanager
def temp_server(self, **kwargs):
with temp_test_server(self, **kwargs):
yield
@contextlib.contextmanager
def temp_client(self, *args, **kwargs):
with temp_test_client(self, *args, **kwargs):
yield
def make_http_request(self, path="/", headers=None):
if headers is None:
headers = {}
# Set url to 'https?://<host>:<port><path>'.
url = get_server_uri(
self.server, resource_name=path, secure=self.secure
).replace("ws", "http")
request = urllib.request.Request(url=url, headers=headers)
if self.secure:
open_health_check = functools.partial(
urllib.request.urlopen, request, context=self.client_context
)
else:
open_health_check = functools.partial(urllib.request.urlopen, request)
return self.loop.run_in_executor(None, open_health_check)
class SecureClientServerTestsMixin(ClientServerTestsMixin):
secure = True
@property
def server_context(self):
ssl_context = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
ssl_context.load_cert_chain(CERTIFICATE)
return ssl_context
@property
def client_context(self):
ssl_context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
ssl_context.load_verify_locations(CERTIFICATE)
return ssl_context
def start_server(self, **kwargs):
kwargs.setdefault("ssl", self.server_context)
super().start_server(**kwargs)
def start_client(self, path="/", **kwargs):
kwargs.setdefault("ssl", self.client_context)
super().start_client(path, **kwargs)
class CommonClientServerTests:
"""
Mixin that defines most tests but doesn't inherit unittest.TestCase.
Tests are run by the ClientServerTests and SecureClientServerTests subclasses.
"""
@with_server()
@with_client()
def test_basic(self):
self.loop.run_until_complete(self.client.send("Hello!"))
reply = self.loop.run_until_complete(self.client.recv())
self.assertEqual(reply, "Hello!")
def test_redirect(self):
redirect_statuses = [
http.HTTPStatus.MOVED_PERMANENTLY,
http.HTTPStatus.FOUND,
http.HTTPStatus.SEE_OTHER,
http.HTTPStatus.TEMPORARY_REDIRECT,
http.HTTPStatus.PERMANENT_REDIRECT,
]
for status in redirect_statuses:
with temp_test_redirecting_server(self, status):
with self.temp_client("/absolute_redirect"):
self.loop.run_until_complete(self.client.send("Hello!"))
reply = self.loop.run_until_complete(self.client.recv())
self.assertEqual(reply, "Hello!")
def test_redirect_relative_location(self):
with temp_test_redirecting_server(self):
with self.temp_client("/relative_redirect"):
self.loop.run_until_complete(self.client.send("Hello!"))
reply = self.loop.run_until_complete(self.client.recv())
self.assertEqual(reply, "Hello!")
def test_infinite_redirect(self):
with temp_test_redirecting_server(self):
with self.assertRaises(InvalidHandshake):
with self.temp_client("/infinite"):
self.fail("did not raise")
def test_redirect_missing_location(self):
with temp_test_redirecting_server(self):
with self.assertRaises(InvalidHeader):
with self.temp_client("/missing_location"):
self.fail("did not raise")
def test_loop_backwards_compatibility(self):
with self.temp_server(
loop=self.loop,
deprecation_warnings=["remove loop argument"],
):
with self.temp_client(
loop=self.loop,
deprecation_warnings=["remove loop argument"],
):
self.loop.run_until_complete(self.client.send("Hello!"))
reply = self.loop.run_until_complete(self.client.recv())
self.assertEqual(reply, "Hello!")
@with_server()
def test_explicit_host_port(self):
uri = get_server_uri(self.server, self.secure)
wsuri = parse_uri(uri)
# Change host and port to invalid values.
scheme = "wss" if wsuri.secure else "ws"
port = 65535 - wsuri.port
changed_uri = f"{scheme}://example.com:{port}/"
with self.temp_client(uri=changed_uri, host=wsuri.host, port=wsuri.port):
self.loop.run_until_complete(self.client.send("Hello!"))
reply = self.loop.run_until_complete(self.client.recv())
self.assertEqual(reply, "Hello!")
@with_server()
def test_explicit_socket(self):
class TrackedSocket(socket.socket):
def __init__(self, *args, **kwargs):
self.used_for_read = False
self.used_for_write = False
super().__init__(*args, **kwargs)
def recv(self, *args, **kwargs):
self.used_for_read = True
return super().recv(*args, **kwargs)
def recv_into(self, *args, **kwargs):
self.used_for_read = True
return super().recv_into(*args, **kwargs)
def send(self, *args, **kwargs):
self.used_for_write = True
return super().send(*args, **kwargs)
server_socket = [
sock for sock in self.server.sockets if sock.family == socket.AF_INET
][0]
client_socket = TrackedSocket(socket.AF_INET, socket.SOCK_STREAM)
client_socket.connect(server_socket.getsockname())
try:
self.assertFalse(client_socket.used_for_read)
self.assertFalse(client_socket.used_for_write)
with self.temp_client(sock=client_socket):
self.loop.run_until_complete(self.client.send("Hello!"))
reply = self.loop.run_until_complete(self.client.recv())
self.assertEqual(reply, "Hello!")
self.assertTrue(client_socket.used_for_read)
self.assertTrue(client_socket.used_for_write)
finally:
client_socket.close()
@unittest.skipUnless(hasattr(socket, "AF_UNIX"), "this test requires Unix sockets")
def test_unix_socket(self):
with temp_unix_socket_path() as path:
# Like self.start_server() but with unix_serve().
async def start_server():
return await unix_serve(default_handler, path)
self.server = self.loop.run_until_complete(start_server())
try:
# Like self.start_client() but with unix_connect()
async def start_client():
return await unix_connect(path)
self.client = self.loop.run_until_complete(start_client())
try:
self.loop.run_until_complete(self.client.send("Hello!"))
reply = self.loop.run_until_complete(self.client.recv())
self.assertEqual(reply, "Hello!")
finally:
self.stop_client()
finally:
self.stop_server()
def test_ws_handler_argument_backwards_compatibility(self):
async def handler_with_path(ws, path):
await ws.send(path)
with self.temp_server(
handler=handler_with_path,
deprecation_warnings=["remove second argument of ws_handler"],
):
with self.temp_client("/path"):
self.assertEqual(
self.loop.run_until_complete(self.client.recv()),
"/path",
)
def test_ws_handler_argument_backwards_compatibility_partial(self):
async def handler_with_path(ws, path, extra):
await ws.send(path)
bound_handler_with_path = functools.partial(handler_with_path, extra=None)
with self.temp_server(
handler=bound_handler_with_path,
deprecation_warnings=["remove second argument of ws_handler"],
):
with self.temp_client("/path"):
self.assertEqual(
self.loop.run_until_complete(self.client.recv()),
"/path",
)
async def process_request_OK(path, request_headers):
return http.HTTPStatus.OK, [], b"OK\n"
@with_server(process_request=process_request_OK)
def test_process_request_argument(self):
response = self.loop.run_until_complete(self.make_http_request("/"))
with contextlib.closing(response):
self.assertEqual(response.code, 200)
def legacy_process_request_OK(path, request_headers):
return http.HTTPStatus.OK, [], b"OK\n"
@with_server(process_request=legacy_process_request_OK)
def test_process_request_argument_backwards_compatibility(self):
with warnings.catch_warnings(record=True) as recorded_warnings:
warnings.simplefilter("always")
response = self.loop.run_until_complete(self.make_http_request("/"))
with contextlib.closing(response):
self.assertEqual(response.code, 200)
self.assertDeprecationWarnings(
recorded_warnings, ["declare process_request as a coroutine"]
)
class ProcessRequestOKServerProtocol(WebSocketServerProtocol):
async def process_request(self, path, request_headers):
return http.HTTPStatus.OK, [], b"OK\n"
@with_server(create_protocol=ProcessRequestOKServerProtocol)
def test_process_request_override(self):
response = self.loop.run_until_complete(self.make_http_request("/"))
with contextlib.closing(response):
self.assertEqual(response.code, 200)
class LegacyProcessRequestOKServerProtocol(WebSocketServerProtocol):
def process_request(self, path, request_headers):
return http.HTTPStatus.OK, [], b"OK\n"
@with_server(create_protocol=LegacyProcessRequestOKServerProtocol)
def test_process_request_override_backwards_compatibility(self):
with warnings.catch_warnings(record=True) as recorded_warnings:
warnings.simplefilter("always")
response = self.loop.run_until_complete(self.make_http_request("/"))
with contextlib.closing(response):
self.assertEqual(response.code, 200)
self.assertDeprecationWarnings(
recorded_warnings, ["declare process_request as a coroutine"]
)
def select_subprotocol_chat(client_subprotocols, server_subprotocols):
return "chat"
@with_server(
subprotocols=["superchat", "chat"], select_subprotocol=select_subprotocol_chat
)
@with_client("/subprotocol", subprotocols=["superchat", "chat"])
def test_select_subprotocol_argument(self):
server_subprotocol = self.loop.run_until_complete(self.client.recv())
self.assertEqual(server_subprotocol, repr("chat"))
self.assertEqual(self.client.subprotocol, "chat")
class SelectSubprotocolChatServerProtocol(WebSocketServerProtocol):
def select_subprotocol(self, client_subprotocols, server_subprotocols):
return "chat"
@with_server(
subprotocols=["superchat", "chat"],
create_protocol=SelectSubprotocolChatServerProtocol,
)
@with_client("/subprotocol", subprotocols=["superchat", "chat"])
def test_select_subprotocol_override(self):
server_subprotocol = self.loop.run_until_complete(self.client.recv())
self.assertEqual(server_subprotocol, repr("chat"))
self.assertEqual(self.client.subprotocol, "chat")
@with_server()
@with_client("/deprecated_attributes")
def test_protocol_deprecated_attributes(self):
# The test could be connecting with IPv6 or IPv4.
expected_client_attrs = [
server_socket.getsockname()[:2] + (self.secure,)
for server_socket in self.server.sockets
]
with warnings.catch_warnings(record=True) as recorded_warnings:
warnings.simplefilter("always")
client_attrs = (self.client.host, self.client.port, self.client.secure)
self.assertDeprecationWarnings(
recorded_warnings,
[
"use remote_address[0] instead of host",
"use remote_address[1] instead of port",
"don't use secure",
],
)
self.assertIn(client_attrs, expected_client_attrs)
expected_server_attrs = ("localhost", 0, self.secure)
with warnings.catch_warnings(record=True) as recorded_warnings:
warnings.simplefilter("always")
self.loop.run_until_complete(self.client.send(""))
server_attrs = self.loop.run_until_complete(self.client.recv())
self.assertDeprecationWarnings(
recorded_warnings,
[
"use local_address[0] instead of host",
"use local_address[1] instead of port",
"don't use secure",
],
)
self.assertEqual(server_attrs, repr(expected_server_attrs))
@with_server()
@with_client("/path")
def test_protocol_path(self):
client_path = self.client.path
self.assertEqual(client_path, "/path")
server_path = self.loop.run_until_complete(self.client.recv())
self.assertEqual(server_path, "/path")
@with_server()
@with_client("/headers")
def test_protocol_headers(self):
client_req = self.client.request_headers
client_resp = self.client.response_headers
self.assertEqual(client_req["User-Agent"], USER_AGENT)
self.assertEqual(client_resp["Server"], USER_AGENT)
server_req = self.loop.run_until_complete(self.client.recv())
server_resp = self.loop.run_until_complete(self.client.recv())
self.assertEqual(server_req, repr(client_req))
self.assertEqual(server_resp, repr(client_resp))
@with_server()
@with_client("/headers", extra_headers={"X-Spam": "Eggs"})
def test_protocol_custom_request_headers(self):
req_headers = self.loop.run_until_complete(self.client.recv())
self.loop.run_until_complete(self.client.recv())
self.assertIn("('X-Spam', 'Eggs')", req_headers)
@with_server()
@with_client("/headers", extra_headers={"User-Agent": "websockets"})
def test_protocol_custom_user_agent_header_legacy(self):
req_headers = self.loop.run_until_complete(self.client.recv())
self.loop.run_until_complete(self.client.recv())
self.assertEqual(req_headers.count("User-Agent"), 1)
self.assertIn("('User-Agent', 'websockets')", req_headers)
@with_server()
@with_client("/headers", user_agent_header=None)
def test_protocol_no_user_agent_header(self):
req_headers = self.loop.run_until_complete(self.client.recv())
self.loop.run_until_complete(self.client.recv())
self.assertNotIn("User-Agent", req_headers)
@with_server()
@with_client("/headers", user_agent_header="websockets")
def test_protocol_custom_user_agent_header(self):
req_headers = self.loop.run_until_complete(self.client.recv())
self.loop.run_until_complete(self.client.recv())
self.assertEqual(req_headers.count("User-Agent"), 1)
self.assertIn("('User-Agent', 'websockets')", req_headers)
@with_server(extra_headers=lambda p, r: {"X-Spam": "Eggs"})
@with_client("/headers")
def test_protocol_custom_response_headers_callable(self):
self.loop.run_until_complete(self.client.recv())
resp_headers = self.loop.run_until_complete(self.client.recv())
self.assertIn("('X-Spam', 'Eggs')", resp_headers)
@with_server(extra_headers=lambda p, r: None)
@with_client("/headers")
def test_protocol_custom_response_headers_callable_none(self):
self.loop.run_until_complete(self.client.recv()) # doesn't crash
self.loop.run_until_complete(self.client.recv()) # nothing to check
@with_server(extra_headers={"X-Spam": "Eggs"})
@with_client("/headers")
def test_protocol_custom_response_headers(self):
self.loop.run_until_complete(self.client.recv())
resp_headers = self.loop.run_until_complete(self.client.recv())
self.assertIn("('X-Spam', 'Eggs')", resp_headers)
@with_server(extra_headers={"Server": "websockets"})
@with_client("/headers")
def test_protocol_custom_server_header_legacy(self):
self.loop.run_until_complete(self.client.recv())
resp_headers = self.loop.run_until_complete(self.client.recv())
self.assertEqual(resp_headers.count("Server"), 1)
self.assertIn("('Server', 'websockets')", resp_headers)
@with_server(server_header=None)
@with_client("/headers")
def test_protocol_no_server_header(self):
self.loop.run_until_complete(self.client.recv())
resp_headers = self.loop.run_until_complete(self.client.recv())
self.assertNotIn("Server", resp_headers)
@with_server(server_header="websockets")
@with_client("/headers")
def test_protocol_custom_server_header(self):
self.loop.run_until_complete(self.client.recv())
resp_headers = self.loop.run_until_complete(self.client.recv())
self.assertEqual(resp_headers.count("Server"), 1)
self.assertIn("('Server', 'websockets')", resp_headers)
@with_server(create_protocol=HealthCheckServerProtocol)
def test_http_request_http_endpoint(self):
# Making an HTTP request to an HTTP endpoint succeeds.
response = self.loop.run_until_complete(self.make_http_request("/__health__/"))
with contextlib.closing(response):
self.assertEqual(response.code, 200)
self.assertEqual(response.read(), b"status = green\n")
@with_server(create_protocol=HealthCheckServerProtocol)
def test_http_request_ws_endpoint(self):
# Making an HTTP request to a WS endpoint fails.
with self.assertRaises(urllib.error.HTTPError) as raised:
self.loop.run_until_complete(self.make_http_request())
self.assertEqual(raised.exception.code, 426)
self.assertEqual(raised.exception.headers["Upgrade"], "websocket")
@with_server(create_protocol=HealthCheckServerProtocol)
def test_ws_connection_http_endpoint(self):
# Making a WS connection to an HTTP endpoint fails.
with self.assertRaises(InvalidStatusCode) as raised:
self.start_client("/__health__/")
self.assertEqual(raised.exception.status_code, 200)
@with_server(create_protocol=HealthCheckServerProtocol)
def test_ws_connection_ws_endpoint(self):
# Making a WS connection to a WS endpoint succeeds.
self.start_client()
self.loop.run_until_complete(self.client.send("Hello!"))
self.loop.run_until_complete(self.client.recv())
self.stop_client()
@with_server(create_protocol=HealthCheckServerProtocol, server_header=None)
def test_http_request_no_server_header(self):
response = self.loop.run_until_complete(self.make_http_request("/__health__/"))
with contextlib.closing(response):
self.assertNotIn("Server", response.headers)
@with_server(create_protocol=HealthCheckServerProtocol, server_header="websockets")
def test_http_request_custom_server_header(self):
response = self.loop.run_until_complete(self.make_http_request("/__health__/"))
with contextlib.closing(response):
self.assertEqual(response.headers["Server"], "websockets")
@with_server(create_protocol=ProcessRequestReturningIntProtocol)
def test_process_request_returns_int_status(self):
response = self.loop.run_until_complete(self.make_http_request("/__health__/"))
with contextlib.closing(response):
self.assertEqual(response.code, 200)
self.assertEqual(response.read(), b"OK\n")
def assert_client_raises_code(self, status_code):
with self.assertRaises(InvalidStatusCode) as raised:
self.start_client()
self.assertEqual(raised.exception.status_code, status_code)
@with_server(create_protocol=UnauthorizedServerProtocol)
def test_server_create_protocol(self):
self.assert_client_raises_code(401)
def create_unauthorized_server_protocol(*args, **kwargs):
return UnauthorizedServerProtocol(*args, **kwargs)
@with_server(create_protocol=create_unauthorized_server_protocol)
def test_server_create_protocol_function(self):
self.assert_client_raises_code(401)
@with_server(
klass=UnauthorizedServerProtocol,
deprecation_warnings=["rename klass to create_protocol"],
)
def test_server_klass_backwards_compatibility(self):
self.assert_client_raises_code(401)
@with_server(
create_protocol=ForbiddenServerProtocol,
klass=UnauthorizedServerProtocol,
deprecation_warnings=["rename klass to create_protocol"],
)
def test_server_create_protocol_over_klass(self):
self.assert_client_raises_code(403)
@with_server()
@with_client("/path", create_protocol=FooClientProtocol)
def test_client_create_protocol(self):
self.assertIsInstance(self.client, FooClientProtocol)
@with_server()
@with_client(
"/path",
create_protocol=(lambda *args, **kwargs: FooClientProtocol(*args, **kwargs)),
)
def test_client_create_protocol_function(self):
self.assertIsInstance(self.client, FooClientProtocol)
@with_server()
@with_client(
"/path",
klass=FooClientProtocol,
deprecation_warnings=["rename klass to create_protocol"],
)
def test_client_klass(self):
self.assertIsInstance(self.client, FooClientProtocol)
@with_server()
@with_client(
"/path",
create_protocol=BarClientProtocol,
klass=FooClientProtocol,
deprecation_warnings=["rename klass to create_protocol"],
)
def test_client_create_protocol_over_klass(self):
self.assertIsInstance(self.client, BarClientProtocol)
@with_server(close_timeout=7)
@with_client("/close_timeout")
def test_server_close_timeout(self):
close_timeout = self.loop.run_until_complete(self.client.recv())
self.assertEqual(eval(close_timeout), 7)
@with_server(timeout=6, deprecation_warnings=["rename timeout to close_timeout"])
@with_client("/close_timeout")
def test_server_timeout_backwards_compatibility(self):
close_timeout = self.loop.run_until_complete(self.client.recv())
self.assertEqual(eval(close_timeout), 6)
@with_server(
close_timeout=7,
timeout=6,
deprecation_warnings=["rename timeout to close_timeout"],
)
@with_client("/close_timeout")
def test_server_close_timeout_over_timeout(self):
close_timeout = self.loop.run_until_complete(self.client.recv())
self.assertEqual(eval(close_timeout), 7)
@with_server()
@with_client("/close_timeout", close_timeout=7)
def test_client_close_timeout(self):
self.assertEqual(self.client.close_timeout, 7)
@with_server()
@with_client(
"/close_timeout",
timeout=6,
deprecation_warnings=["rename timeout to close_timeout"],
)
def test_client_timeout_backwards_compatibility(self):
self.assertEqual(self.client.close_timeout, 6)
@with_server()
@with_client(
"/close_timeout",
close_timeout=7,
timeout=6,
deprecation_warnings=["rename timeout to close_timeout"],
)
def test_client_close_timeout_over_timeout(self):
self.assertEqual(self.client.close_timeout, 7)
@with_server()
@with_client("/extensions")
def test_no_extension(self):
server_extensions = self.loop.run_until_complete(self.client.recv())
self.assertEqual(server_extensions, repr([]))
self.assertEqual(repr(self.client.extensions), repr([]))
@with_server(extensions=[ServerNoOpExtensionFactory()])
@with_client("/extensions", extensions=[ClientNoOpExtensionFactory()])
def test_extension(self):
server_extensions = self.loop.run_until_complete(self.client.recv())
self.assertEqual(server_extensions, repr([NoOpExtension()]))
self.assertEqual(repr(self.client.extensions), repr([NoOpExtension()]))
@with_server()
@with_client("/extensions", extensions=[ClientNoOpExtensionFactory()])
def test_extension_not_accepted(self):
server_extensions = self.loop.run_until_complete(self.client.recv())
self.assertEqual(server_extensions, repr([]))
self.assertEqual(repr(self.client.extensions), repr([]))
@with_server(extensions=[ServerNoOpExtensionFactory()])
@with_client("/extensions")
def test_extension_not_requested(self):
server_extensions = self.loop.run_until_complete(self.client.recv())
self.assertEqual(server_extensions, repr([]))
self.assertEqual(repr(self.client.extensions), repr([]))
@with_server(extensions=[ServerNoOpExtensionFactory([("foo", None)])])
def test_extension_client_rejection(self):
with self.assertRaises(NegotiationError):
self.start_client("/extensions", extensions=[ClientNoOpExtensionFactory()])
@with_server(
extensions=[
# No match because the client doesn't send client_max_window_bits.
ServerPerMessageDeflateFactory(
client_max_window_bits=10,
require_client_max_window_bits=True,
),
ServerPerMessageDeflateFactory(),
]
)
@with_client(
"/extensions",
extensions=[
ClientPerMessageDeflateFactory(client_max_window_bits=None),
],
)
def test_extension_no_match_then_match(self):
# The order requested by the client has priority.
server_extensions = self.loop.run_until_complete(self.client.recv())
self.assertEqual(
server_extensions, repr([PerMessageDeflate(False, False, 15, 15)])
)
self.assertEqual(
repr(self.client.extensions),
repr([PerMessageDeflate(False, False, 15, 15)]),
)
@with_server(extensions=[ServerPerMessageDeflateFactory()])
@with_client("/extensions", extensions=[ClientNoOpExtensionFactory()])
def test_extension_mismatch(self):
server_extensions = self.loop.run_until_complete(self.client.recv())
self.assertEqual(server_extensions, repr([]))
self.assertEqual(repr(self.client.extensions), repr([]))
@with_server(
extensions=[ServerNoOpExtensionFactory(), ServerPerMessageDeflateFactory()]
)
@with_client(
"/extensions",
extensions=[ClientPerMessageDeflateFactory(), ClientNoOpExtensionFactory()],
)
def test_extension_order(self):
# The order requested by the client has priority.
server_extensions = self.loop.run_until_complete(self.client.recv())
self.assertEqual(
server_extensions,
repr([PerMessageDeflate(False, False, 15, 15), NoOpExtension()]),
)
self.assertEqual(
repr(self.client.extensions),
repr([PerMessageDeflate(False, False, 15, 15), NoOpExtension()]),
)
@with_server(extensions=[ServerNoOpExtensionFactory()])
@patch.object(WebSocketServerProtocol, "process_extensions")
def test_extensions_error(self, _process_extensions):
_process_extensions.return_value = "x-no-op", [NoOpExtension()]
with self.assertRaises(NegotiationError):
self.start_client(
"/extensions", extensions=[ClientPerMessageDeflateFactory()]
)
@with_server(extensions=[ServerNoOpExtensionFactory()])
@patch.object(WebSocketServerProtocol, "process_extensions")
def test_extensions_error_no_extensions(self, _process_extensions):
_process_extensions.return_value = "x-no-op", [NoOpExtension()]
with self.assertRaises(InvalidHandshake):
self.start_client("/extensions")
@with_server(compression="deflate")
@with_client("/extensions", compression="deflate")
def test_compression_deflate(self):
server_extensions = self.loop.run_until_complete(self.client.recv())
self.assertEqual(
server_extensions, repr([PerMessageDeflate(False, False, 12, 12)])
)
self.assertEqual(
repr(self.client.extensions),
repr([PerMessageDeflate(False, False, 12, 12)]),
)
def test_compression_unsupported_server(self):
with self.assertRaises(ValueError):
self.start_server(compression="xz")
@with_server()
def test_compression_unsupported_client(self):
with self.assertRaises(ValueError):
self.start_client(compression="xz")
@with_server()
@with_client("/subprotocol")
def test_no_subprotocol(self):
server_subprotocol = self.loop.run_until_complete(self.client.recv())
self.assertEqual(server_subprotocol, repr(None))
self.assertEqual(self.client.subprotocol, None)
@with_server(subprotocols=["superchat", "chat"])
@with_client("/subprotocol", subprotocols=["otherchat", "chat"])
def test_subprotocol(self):
server_subprotocol = self.loop.run_until_complete(self.client.recv())
self.assertEqual(server_subprotocol, repr("chat"))
self.assertEqual(self.client.subprotocol, "chat")
def test_invalid_subprotocol_server(self):
with self.assertRaises(TypeError):
self.start_server(subprotocols="sip")
@with_server()
def test_invalid_subprotocol_client(self):
with self.assertRaises(TypeError):
self.start_client(subprotocols="sip")
@with_server(subprotocols=["superchat"])
@with_client("/subprotocol", subprotocols=["otherchat"])
def test_subprotocol_not_accepted(self):
server_subprotocol = self.loop.run_until_complete(self.client.recv())
self.assertEqual(server_subprotocol, repr(None))
self.assertEqual(self.client.subprotocol, None)
@with_server()
@with_client("/subprotocol", subprotocols=["otherchat", "chat"])
def test_subprotocol_not_offered(self):
server_subprotocol = self.loop.run_until_complete(self.client.recv())
self.assertEqual(server_subprotocol, repr(None))
self.assertEqual(self.client.subprotocol, None)
@with_server(subprotocols=["superchat", "chat"])
@with_client("/subprotocol")
def test_subprotocol_not_requested(self):
server_subprotocol = self.loop.run_until_complete(self.client.recv())
self.assertEqual(server_subprotocol, repr(None))
self.assertEqual(self.client.subprotocol, None)
@with_server(subprotocols=["superchat"])
@patch.object(WebSocketServerProtocol, "process_subprotocol")
def test_subprotocol_error(self, _process_subprotocol):
_process_subprotocol.return_value = "superchat"
with self.assertRaises(NegotiationError):
self.start_client("/subprotocol", subprotocols=["otherchat"])
self.run_loop_once()
@with_server(subprotocols=["superchat"])
@patch.object(WebSocketServerProtocol, "process_subprotocol")
def test_subprotocol_error_no_subprotocols(self, _process_subprotocol):
_process_subprotocol.return_value = "superchat"
with self.assertRaises(InvalidHandshake):
self.start_client("/subprotocol")
self.run_loop_once()
@with_server(subprotocols=["superchat", "chat"])
@patch.object(WebSocketServerProtocol, "process_subprotocol")
def test_subprotocol_error_two_subprotocols(self, _process_subprotocol):
_process_subprotocol.return_value = "superchat, chat"
with self.assertRaises(InvalidHandshake):
self.start_client("/subprotocol", subprotocols=["superchat", "chat"])
self.run_loop_once()
@with_server()
@patch("websockets.legacy.server.read_request")
def test_server_receives_malformed_request(self, _read_request):
_read_request.side_effect = ValueError("read_request failed")
with self.assertRaises(InvalidHandshake):
self.start_client()
@with_server()
@patch("websockets.legacy.client.read_response")
def test_client_receives_malformed_response(self, _read_response):
_read_response.side_effect = ValueError("read_response failed")
with self.assertRaises(InvalidHandshake):
self.start_client()
self.run_loop_once()
@with_server()
@patch("websockets.legacy.client.build_request")
def test_client_sends_invalid_handshake_request(self, _build_request):
def wrong_build_request(headers):
return "42"
_build_request.side_effect = wrong_build_request
with self.assertRaises(InvalidHandshake):
self.start_client()
@with_server()
@patch("websockets.legacy.server.build_response")
def test_server_sends_invalid_handshake_response(self, _build_response):
def wrong_build_response(headers, key):
return build_response(headers, "42")
_build_response.side_effect = wrong_build_response
with self.assertRaises(InvalidHandshake):
self.start_client()
@with_server()
@patch("websockets.legacy.client.read_response")
def test_server_does_not_switch_protocols(self, _read_response):
async def wrong_read_response(stream):
status_code, reason, headers = await read_response(stream)
return 400, "Bad Request", headers
_read_response.side_effect = wrong_read_response
with self.assertRaises(InvalidStatusCode):
self.start_client()
self.run_loop_once()
@with_server()
@patch("websockets.legacy.server.WebSocketServerProtocol.process_request")
def test_server_error_in_handshake(self, _process_request):
_process_request.side_effect = Exception("process_request crashed")
with self.assertRaises(InvalidHandshake):
self.start_client()
@with_server(create_protocol=SlowOpeningHandshakeProtocol)
def test_client_connect_canceled_during_handshake(self):
sock = socket.create_connection(get_server_address(self.server))
sock.send(b"") # socket is connected
async def cancelled_client():
start_client = connect(get_server_uri(self.server), sock=sock)
async with asyncio_timeout(5 * MS):
await start_client
with self.assertRaises(asyncio.TimeoutError):
self.loop.run_until_complete(cancelled_client())
with self.assertRaises(OSError):
sock.send(b"") # socket is closed
@with_server()
@patch("websockets.legacy.server.WebSocketServerProtocol.send")
def test_server_handler_crashes(self, send):
send.side_effect = ValueError("send failed")
with self.temp_client():
self.loop.run_until_complete(self.client.send("Hello!"))
with self.assertRaises(ConnectionClosed):
self.loop.run_until_complete(self.client.recv())
# Connection ends with an unexpected error.
self.assertEqual(self.client.close_code, CloseCode.INTERNAL_ERROR)
@with_server()
@patch("websockets.legacy.server.WebSocketServerProtocol.close")
def test_server_close_crashes(self, close):
close.side_effect = ValueError("close failed")
with self.temp_client():
self.loop.run_until_complete(self.client.send("Hello!"))
reply = self.loop.run_until_complete(self.client.recv())
self.assertEqual(reply, "Hello!")
# Connection ends with an abnormal closure.
self.assertEqual(self.client.close_code, CloseCode.ABNORMAL_CLOSURE)
@with_server()
@with_client()
@patch.object(WebSocketClientProtocol, "handshake")
def test_client_closes_connection_before_handshake(self, handshake):
# We have mocked the handshake() method to prevent the client from
# performing the opening handshake. Force it to close the connection.
self.client.transport.close()
# The server should stop properly anyway. It used to hang because the
# task handling the connection was waiting for the opening handshake.
@with_server(create_protocol=SlowOpeningHandshakeProtocol)
def test_server_shuts_down_during_opening_handshake(self):
self.loop.call_later(5 * MS, self.server.close)
with self.assertRaises(InvalidStatusCode) as raised:
self.start_client()
exception = raised.exception
self.assertEqual(
str(exception), "server rejected WebSocket connection: HTTP 503"
)
self.assertEqual(exception.status_code, 503)
@with_server()
def test_server_shuts_down_during_connection_handling(self):
with self.temp_client():
server_ws = next(iter(self.server.websockets))
self.server.close()
with self.assertRaises(ConnectionClosed):
self.loop.run_until_complete(self.client.send("Hello!"))
self.loop.run_until_complete(self.client.recv())
# Server closed the connection with 1001 Going Away.
self.assertEqual(self.client.close_code, CloseCode.GOING_AWAY)
self.assertEqual(server_ws.close_code, CloseCode.GOING_AWAY)
@with_server()
def test_server_shuts_down_gracefully_during_connection_handling(self):
with self.temp_client():
server_ws = next(iter(self.server.websockets))
self.server.close(close_connections=False)
self.loop.run_until_complete(self.client.send("Hello!"))
self.loop.run_until_complete(self.client.recv())
# Client closed the connection with 1000 OK.
self.assertEqual(self.client.close_code, CloseCode.NORMAL_CLOSURE)
self.assertEqual(server_ws.close_code, CloseCode.NORMAL_CLOSURE)
@with_server()
def test_server_shuts_down_and_waits_until_handlers_terminate(self):
# This handler waits a bit after the connection is closed in order
# to test that wait_closed() really waits for handlers to complete.
self.start_client("/slow_stop")
server_ws = next(iter(self.server.websockets))
# Test that the handler task keeps running after close().
self.server.close()
self.loop.run_until_complete(asyncio.sleep(MS))
self.assertFalse(server_ws.handler_task.done())
# Test that the handler task terminates before wait_closed() returns.
self.loop.run_until_complete(self.server.wait_closed())
self.assertTrue(server_ws.handler_task.done())
@with_server(create_protocol=ForbiddenServerProtocol)
def test_invalid_status_error_during_client_connect(self):
with self.assertRaises(InvalidStatusCode) as raised:
self.start_client()
exception = raised.exception
self.assertEqual(
str(exception), "server rejected WebSocket connection: HTTP 403"
)
self.assertEqual(exception.status_code, 403)
@with_server()
@patch("websockets.legacy.server.WebSocketServerProtocol.write_http_response")
@patch("websockets.legacy.server.WebSocketServerProtocol.read_http_request")
def test_connection_error_during_opening_handshake(
self, _read_http_request, _write_http_response
):
_read_http_request.side_effect = ConnectionError
# This exception is currently platform-dependent. It was observed to
# be ConnectionResetError on Linux in the non-TLS case, and
# InvalidMessage otherwise (including both Linux and macOS). This
# doesn't matter though since this test is primarily for testing a
# code path on the server side.
with self.assertRaises(Exception):
self.start_client()
# No response must not be written if the network connection is broken.
_write_http_response.assert_not_called()
@with_server()
@patch("websockets.legacy.server.WebSocketServerProtocol.close")
def test_connection_error_during_closing_handshake(self, close):
close.side_effect = ConnectionError
with self.temp_client():
self.loop.run_until_complete(self.client.send("Hello!"))
reply = self.loop.run_until_complete(self.client.recv())
self.assertEqual(reply, "Hello!")
# Connection ends with an abnormal closure.
self.assertEqual(self.client.close_code, CloseCode.ABNORMAL_CLOSURE)
class ClientServerTests(
CommonClientServerTests, ClientServerTestsMixin, AsyncioTestCase
):
def test_redirect_secure(self):
with temp_test_redirecting_server(self):
# websockets doesn't support serving non-TLS and TLS connections
# from the same server and this test suite makes it difficult to
# run two servers. Therefore, we expect the redirect to create a
# TLS client connection to a non-TLS server, which will fail.
with self.assertRaises(ssl.SSLError):
with self.temp_client("/force_secure"):
self.fail("did not raise")
class SecureClientServerTests(
CommonClientServerTests, SecureClientServerTestsMixin, AsyncioTestCase
):
# The implementation of this test makes it hard to run it over TLS.
test_client_connect_canceled_during_handshake = None
# TLS over Unix sockets doesn't make sense.
test_unix_socket = None
# This test fails under PyPy due to a difference with CPython.
if platform.python_implementation() == "PyPy": # pragma: no cover
test_http_request_ws_endpoint = None
@with_server()
def test_ws_uri_is_rejected(self):
with self.assertRaises(ValueError):
self.start_client(
uri=get_server_uri(self.server, secure=False), ssl=self.client_context
)
def test_redirect_insecure(self):
with temp_test_redirecting_server(self):
with self.assertRaises(InvalidHandshake):
with self.temp_client("/force_insecure"):
self.fail("did not raise")
class ClientServerOriginTests(ClientServerTestsMixin, AsyncioTestCase):
@with_server(origins=["http://localhost"])
@with_client(origin="http://localhost")
def test_checking_origin_succeeds(self):
self.loop.run_until_complete(self.client.send("Hello!"))
self.assertEqual(self.loop.run_until_complete(self.client.recv()), "Hello!")
@with_server(origins=["http://localhost"])
def test_checking_origin_fails(self):
with self.assertRaises(InvalidHandshake) as raised:
self.start_client(origin="http://otherhost")
self.assertEqual(
str(raised.exception),
"server rejected WebSocket connection: HTTP 403",
)
@with_server(origins=["http://localhost"])
def test_checking_origins_fails_with_multiple_headers(self):
with self.assertRaises(InvalidHandshake) as raised:
self.start_client(
origin="http://localhost",
extra_headers=[("Origin", "http://otherhost")],
)
self.assertEqual(
str(raised.exception),
"server rejected WebSocket connection: HTTP 400",
)
@with_server(origins=[None])
@with_client()
def test_checking_lack_of_origin_succeeds(self):
self.loop.run_until_complete(self.client.send("Hello!"))
self.assertEqual(self.loop.run_until_complete(self.client.recv()), "Hello!")
@with_server(origins=[""])
# The deprecation warning is raised when a client connects to the server.
@with_client(deprecation_warnings=["use None instead of '' in origins"])
def test_checking_lack_of_origin_succeeds_backwards_compatibility(self):
self.loop.run_until_complete(self.client.send("Hello!"))
self.assertEqual(self.loop.run_until_complete(self.client.recv()), "Hello!")
@unittest.skipIf(
sys.version_info[:2] >= (3, 11), "asyncio.coroutine has been removed in Python 3.11"
)
class YieldFromTests(ClientServerTestsMixin, AsyncioTestCase): # pragma: no cover
@with_server()
def test_client(self):
# @asyncio.coroutine is deprecated on Python ≥ 3.8
with warnings.catch_warnings():
warnings.simplefilter("ignore")
@asyncio.coroutine
def run_client():
# Yield from connect.
client = yield from connect(get_server_uri(self.server))
self.assertEqual(client.state, State.OPEN)
yield from client.close()
self.assertEqual(client.state, State.CLOSED)
self.loop.run_until_complete(run_client())
def test_server(self):
# @asyncio.coroutine is deprecated on Python ≥ 3.8
with warnings.catch_warnings():
warnings.simplefilter("ignore")
@asyncio.coroutine
def run_server():
# Yield from serve.
server = yield from serve(default_handler, "localhost", 0)
self.assertTrue(server.sockets)
server.close()
yield from server.wait_closed()
self.assertFalse(server.sockets)
self.loop.run_until_complete(run_server())
class AsyncAwaitTests(ClientServerTestsMixin, AsyncioTestCase):
@with_server()
def test_client(self):
async def run_client():
# Await connect.
client = await connect(get_server_uri(self.server))
self.assertEqual(client.state, State.OPEN)
await client.close()
self.assertEqual(client.state, State.CLOSED)
self.loop.run_until_complete(run_client())
def test_server(self):
async def run_server():
# Await serve.
server = await serve(default_handler, "localhost", 0)
self.assertTrue(server.sockets)
server.close()
await server.wait_closed()
self.assertFalse(server.sockets)
self.loop.run_until_complete(run_server())
class ContextManagerTests(ClientServerTestsMixin, AsyncioTestCase):
@with_server()
def test_client(self):
async def run_client():
# Use connect as an asynchronous context manager.
async with connect(get_server_uri(self.server)) as client:
self.assertEqual(client.state, State.OPEN)
# Check that exiting the context manager closed the connection.
self.assertEqual(client.state, State.CLOSED)
self.loop.run_until_complete(run_client())
def test_server(self):
async def run_server():
# Use serve as an asynchronous context manager.
async with serve(default_handler, "localhost", 0) as server:
self.assertTrue(server.sockets)
# Check that exiting the context manager closed the server.
self.assertFalse(server.sockets)
self.loop.run_until_complete(run_server())
@unittest.skipUnless(hasattr(socket, "AF_UNIX"), "this test requires Unix sockets")
def test_unix_server(self):
async def run_server(path):
async with unix_serve(default_handler, path) as server:
self.assertTrue(server.sockets)
# Check that exiting the context manager closed the server.
self.assertFalse(server.sockets)
with temp_unix_socket_path() as path:
self.loop.run_until_complete(run_server(path))
class AsyncIteratorTests(ClientServerTestsMixin, AsyncioTestCase):
# This is a protocol-level feature, but since it's a high-level API, it is
# much easier to exercise at the client or server level.
MESSAGES = ["3", "2", "1", "Fire!"]
async def echo_handler(ws):
for message in AsyncIteratorTests.MESSAGES:
await ws.send(message)
@with_server(handler=echo_handler)
def test_iterate_on_messages(self):
messages = []
async def run_client():
nonlocal messages
async with connect(get_server_uri(self.server)) as ws:
async for message in ws:
messages.append(message)
self.loop.run_until_complete(run_client())
self.assertEqual(messages, self.MESSAGES)
async def echo_handler_going_away(ws):
for message in AsyncIteratorTests.MESSAGES:
await ws.send(message)
await ws.close(CloseCode.GOING_AWAY)
@with_server(handler=echo_handler_going_away)
def test_iterate_on_messages_going_away_exit_ok(self):
messages = []
async def run_client():
nonlocal messages
async with connect(get_server_uri(self.server)) as ws:
async for message in ws:
messages.append(message)
self.loop.run_until_complete(run_client())
self.assertEqual(messages, self.MESSAGES)
async def echo_handler_internal_error(ws):
for message in AsyncIteratorTests.MESSAGES:
await ws.send(message)
await ws.close(CloseCode.INTERNAL_ERROR)
@with_server(handler=echo_handler_internal_error)
def test_iterate_on_messages_internal_error_exit_not_ok(self):
messages = []
async def run_client():
nonlocal messages
async with connect(get_server_uri(self.server)) as ws:
async for message in ws:
messages.append(message)
with self.assertRaises(ConnectionClosed):
self.loop.run_until_complete(run_client())
self.assertEqual(messages, self.MESSAGES)
class ReconnectionTests(ClientServerTestsMixin, AsyncioTestCase):
async def echo_handler(ws):
async for msg in ws:
await ws.send(msg)
service_available = True
async def maybe_service_unavailable(path, headers):
if not ReconnectionTests.service_available:
return http.HTTPStatus.SERVICE_UNAVAILABLE, [], b""
async def disable_server(self, duration):
ReconnectionTests.service_available = False
await asyncio.sleep(duration)
ReconnectionTests.service_available = True
@with_server(handler=echo_handler, process_request=maybe_service_unavailable)
def test_reconnect(self):
# Big, ugly integration test :-(
async def run_client():
iteration = 0
connect_inst = connect(get_server_uri(self.server))
connect_inst.BACKOFF_MIN = 10 * MS
connect_inst.BACKOFF_MAX = 99 * MS
connect_inst.BACKOFF_INITIAL = 0
# coverage has a hard time dealing with this code - I give up.
async for ws in connect_inst: # pragma: no cover
await ws.send("spam")
msg = await ws.recv()
self.assertEqual(msg, "spam")
iteration += 1
if iteration == 1:
# Exit block normally.
pass
elif iteration == 2:
# Disable server for a little bit
asyncio.create_task(self.disable_server(50 * MS))
await asyncio.sleep(0)
elif iteration == 3:
# Exit block after catching connection error.
server_ws = next(iter(self.server.websockets))
await server_ws.close()
with self.assertRaises(ConnectionClosed):
await ws.recv()
else:
# Exit block with an exception.
raise Exception("BOOM")
with self.assertLogs("websockets", logging.INFO) as logs:
with self.assertRaises(Exception) as raised:
self.loop.run_until_complete(run_client())
self.assertEqual(str(raised.exception), "BOOM")
# Iteration 1
self.assertEqual(
[record.getMessage() for record in logs.records][:2],
[
"connection open",
"connection closed",
],
)
# Iteration 2
self.assertEqual(
[record.getMessage() for record in logs.records][2:4],
[
"connection open",
"connection closed",
],
)
# Iteration 3
exc = (
"websockets.legacy.exceptions.InvalidStatusCode: "
"server rejected WebSocket connection: HTTP 503"
)
self.assertEqual(
[
re.sub(r"[0-9\.]+ seconds", "X seconds", record.getMessage())
for record in logs.records
][4:-1],
[
"connection rejected (503 Service Unavailable)",
"connection closed",
f"connect failed; reconnecting in X seconds: {exc}",
]
+ [
"connection rejected (503 Service Unavailable)",
"connection closed",
f"connect failed again; retrying in X seconds: {exc}",
]
* ((len(logs.records) - 8) // 3)
+ [
"connection open",
"connection closed",
],
)
# Iteration 4
self.assertEqual(
[record.getMessage() for record in logs.records][-1:],
[
"connection open",
],
)
class LoggerTests(ClientServerTestsMixin, AsyncioTestCase):
def test_logger_client(self):
with self.assertLogs("test.server", logging.DEBUG) as server_logs:
self.start_server(logger=logging.getLogger("test.server"))
with self.assertLogs("test.client", logging.DEBUG) as client_logs:
self.start_client(logger=logging.getLogger("test.client"))
self.loop.run_until_complete(self.client.send("Hello!"))
self.loop.run_until_complete(self.client.recv())
self.stop_client()
self.stop_server()
self.assertGreater(len(server_logs.records), 0)
self.assertGreater(len(client_logs.records), 0)
|