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
|
import asyncio
import contextlib
import os
import pathlib
import socket
import sys
import typing
import unittest.mock
import pytest
import asyncio_dgram
if typing.TYPE_CHECKING:
from socket import _Address
else:
_Address = None
if sys.version_info < (3, 9):
from typing import Generator
else:
from collections.abc import Generator
@contextlib.contextmanager
def loop_exception_handler() -> Generator["asyncio.base_events._Context", None, None]:
"""
Replace the current event loop exception handler with one that
simply stores exceptions in the returned dictionary.
@return - dictionary that is updated with the last loop exception
"""
context = {}
def handler(
loop: asyncio.AbstractEventLoop, c: "asyncio.base_events._Context"
) -> None:
context.update(c)
loop = asyncio.get_event_loop()
orig_handler = loop.get_exception_handler()
loop.set_exception_handler(handler)
yield context
loop.set_exception_handler(orig_handler)
@pytest.mark.asyncio
@pytest.mark.parametrize(
"addr,family",
[
(("127.0.0.1", 0), socket.AF_INET),
(("::1", 0), socket.AF_INET6),
("socket", socket.AF_UNIX),
],
ids=["INET", "INET6", "UNIX"],
)
async def test_connect_sync(
addr: typing.Union[_Address, str],
family: socket.AddressFamily,
tmp_path: pathlib.Path,
) -> None:
# Bind a regular socket, asyncio_dgram connect, then check asyncio send and
# receive.
if family == socket.AF_UNIX:
assert isinstance(addr, str)
addr = str(tmp_path / addr)
with socket.socket(family, socket.SOCK_DGRAM) as sock:
sock.bind(addr)
dest = addr if family == socket.AF_UNIX else sock.getsockname()[:2]
client = await asyncio_dgram.connect(dest)
assert client.peername == sock.getsockname()
await client.send(b"hi")
got, client_addr = sock.recvfrom(4)
assert got == b"hi"
assert client.peername == sock.getsockname()
if family == socket.AF_UNIX:
assert isinstance(addr, str)
# AF_UNIX doesn't automatically bind
assert client_addr is None
os.unlink(addr)
else:
assert client_addr == client.sockname
sock.sendto(b"bye", client.sockname)
got, server_addr = await client.recv()
assert got == b"bye"
assert server_addr == sock.getsockname()
with pytest.raises(asyncio.TimeoutError):
await asyncio.wait_for(client.recv(), 0.05)
client.close()
# Same as above but reversing the flow. Bind a regular socket, asyncio_dgram
# connect, then check asyncio receive and send.
with socket.socket(family, socket.SOCK_DGRAM) as sock:
sock.bind(addr)
dest = addr if family == socket.AF_UNIX else sock.getsockname()[:2]
client = await asyncio_dgram.connect(dest)
with pytest.raises(asyncio.TimeoutError):
await asyncio.wait_for(client.recv(), 0.05)
assert client.peername == sock.getsockname()
if family != socket.AF_UNIX:
# AF_UNIX doesn't automatically bind
sock.sendto(b"hi", client.sockname)
got, server_addr = await client.recv()
assert got == b"hi"
assert server_addr == sock.getsockname()
await client.send(b"bye")
got, client_addr = sock.recvfrom(4)
assert got == b"bye"
assert client_addr == client.sockname
client.close()
@pytest.mark.asyncio
@pytest.mark.parametrize(
"addr,family",
[
(("127.0.0.1", 0), socket.AF_INET),
(("::1", 0), socket.AF_INET6),
("socket", socket.AF_UNIX),
],
ids=["INET", "INET6", "UNIX"],
)
async def test_bind_sync(
addr: typing.Union[_Address, str],
family: socket.AddressFamily,
tmp_path: pathlib.Path,
) -> None:
# Bind an asyncio_dgram, regular socket connect, then check asyncio send and
# receive.
if family == socket.AF_UNIX:
assert isinstance(addr, str)
addr = str(tmp_path / addr)
with socket.socket(family, socket.SOCK_DGRAM) as sock:
server = await asyncio_dgram.bind(addr)
sock.connect(server.sockname)
assert server.peername is None
if family != socket.AF_UNIX:
await server.send(b"hi", sock.getsockname())
got, server_addr = sock.recvfrom(4)
assert got == b"hi"
assert server_addr == server.sockname
sock.sendto(b"bye", server.sockname)
got, client_addr = await server.recv()
assert got == b"bye"
if family == socket.AF_UNIX:
assert client_addr is None
os.unlink(addr)
else:
assert client_addr == sock.getsockname()
with pytest.raises(asyncio.TimeoutError):
await asyncio.wait_for(server.recv(), 0.05)
server.close()
# Same as above but reversing the flow. Bind an asyncio_dgram, regular
# socket connect, then check asyncio receive and send.
with socket.socket(family, socket.SOCK_DGRAM) as sock:
server = await asyncio_dgram.bind(addr)
sock.connect(server.sockname)
assert server.peername is None
with pytest.raises(asyncio.TimeoutError):
await asyncio.wait_for(server.recv(), 0.05)
sock.sendto(b"hi", server.sockname)
got, client_addr = await server.recv()
assert got == b"hi"
if family == socket.AF_UNIX:
# AF_UNIX doesn't automatically bind
assert client_addr is None
else:
assert client_addr == sock.getsockname()
await server.send(b"bye", sock.getsockname())
got, server_addr = sock.recvfrom(4)
assert got == b"bye"
assert server_addr == server.sockname
server.close()
@pytest.mark.asyncio
@pytest.mark.parametrize(
"addr,family",
[
(("127.0.0.1", 0), socket.AF_INET),
(("::1", 0), socket.AF_INET6),
("socket", socket.AF_UNIX),
],
ids=["INET", "INET6", "UNIX"],
)
async def test_from_socket_streamtype(
addr: typing.Union[_Address, str],
family: socket.AddressFamily,
tmp_path: pathlib.Path,
) -> None:
if family == socket.AF_UNIX:
assert isinstance(addr, str)
addr = str(tmp_path / addr)
with socket.socket(family, socket.SOCK_DGRAM) as sock:
sock.bind(addr)
stream = await asyncio_dgram.from_socket(sock)
assert stream.sockname is not None
assert sock.getsockname() == stream.sockname
assert stream.peername is None
assert stream.socket.fileno() == sock.fileno()
assert isinstance(stream, asyncio_dgram.aio.DatagramServer)
with socket.socket(family, socket.SOCK_DGRAM) as sock:
if family == socket.AF_UNIX:
assert isinstance(addr, str)
os.unlink(addr)
sock.bind(addr)
with socket.socket(family, socket.SOCK_DGRAM) as tsock:
tsock.connect(sock.getsockname())
stream = await asyncio_dgram.from_socket(tsock)
if family == socket.AF_UNIX:
assert stream.sockname is None
assert tsock.getsockname() == ""
else:
assert stream.sockname is not None
assert stream.sockname == tsock.getsockname()
assert isinstance(stream, asyncio_dgram.aio.DatagramClient)
assert stream.peername == sock.getsockname()
assert stream.socket.fileno() == tsock.fileno()
# Make sure that the transport stored the peername
with loop_exception_handler() as context:
await stream.send(b"abc")
assert context == {}
@pytest.mark.asyncio
async def test_from_socket_bad_socket(monkeypatch: pytest.MonkeyPatch) -> None:
class MockSocket:
family = socket.AF_PACKET
with monkeypatch.context() as m:
m.setattr(socket, "socket", lambda _, __: MockSocket())
sock = socket.socket(socket.AF_UNIX, socket.SOCK_DGRAM)
with pytest.raises(TypeError, match="socket family not one of"):
await asyncio_dgram.from_socket(sock)
with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as sock:
if sys.version_info < (3, 11):
msg = "must be SocketKind.SOCK_DGRAM"
else:
msg = "socket type must be 2"
with pytest.raises(TypeError, match=msg):
await asyncio_dgram.from_socket(sock)
@pytest.mark.asyncio
@pytest.mark.parametrize(
"addr,family",
[(("127.0.0.1", 0), socket.AF_INET), (("::1", 0), socket.AF_INET6)],
ids=["INET", "INET6"],
)
async def test_no_server(addr: _Address, family: socket.AddressFamily) -> None:
with socket.socket(family, socket.SOCK_DGRAM) as sock:
sock.bind(addr)
free_addr = sock.getsockname()
client = await asyncio_dgram.connect(free_addr[:2])
await client.send(b"hi")
for _ in range(20):
try:
await client.send(b"hi")
except ConnectionRefusedError:
break
await asyncio.sleep(0.01)
else:
pytest.fail("ConnectionRefusedError not raised")
assert client.peername == free_addr
client.close()
@pytest.mark.asyncio
@pytest.mark.parametrize("addr", [("127.0.0.1", 0), ("::1", 0)], ids=["INET", "INET6"])
async def test_echo(addr: _Address) -> None:
server = await asyncio_dgram.bind(addr)
client = await asyncio_dgram.connect(server.sockname[:2])
await client.send(b"hi")
data, client_addr = await server.recv()
assert data == b"hi"
assert client_addr == client.sockname
await server.send(b"bye", client_addr)
data, server_addr = await client.recv()
assert data == b"bye"
assert server_addr == server.sockname
assert server.peername is None
assert client.peername == server.sockname
server.close()
client.close()
@pytest.mark.asyncio
@pytest.mark.parametrize(
"addr,family",
[
(("127.0.0.1", 0), socket.AF_INET),
(("::1", 0), socket.AF_INET6),
(None, socket.AF_UNIX),
],
ids=["INET", "INET6", "UNIX"],
)
async def test_echo_bind(
addr: typing.Optional[_Address],
family: socket.AddressFamily,
tmp_path: pathlib.Path,
) -> None:
if family == socket.AF_UNIX:
server = await asyncio_dgram.bind(tmp_path / "socket1")
client = await asyncio_dgram.bind(tmp_path / "socket2")
else:
assert addr is not None
server = await asyncio_dgram.bind(addr)
client = await asyncio_dgram.bind(addr)
await client.send(b"hi", server.sockname)
data, client_addr = await server.recv()
assert data == b"hi"
assert client_addr == client.sockname
await server.send(b"bye", client_addr)
data, server_addr = await client.recv()
assert data == b"bye"
assert server_addr == server.sockname
assert server.peername is None
assert client.peername is None
server.close()
client.close()
@pytest.mark.asyncio
@pytest.mark.parametrize("addr", [("127.0.0.1", 0), ("::1", 0)], ids=["INET", "INET6"])
async def test_unconnected_sender(addr: _Address) -> None:
# Bind two endpoints and connect to one. Ensure that only the endpoint
# that was connected to can send.
ep1 = await asyncio_dgram.bind(addr)
ep2 = await asyncio_dgram.bind(addr)
connected = await asyncio_dgram.connect(ep1.sockname[:2])
await ep1.send(b"from-ep1", connected.sockname)
await ep2.send(b"from-ep2", connected.sockname)
data, server_addr = await connected.recv()
assert data == b"from-ep1"
assert server_addr == ep1.sockname
with pytest.raises(asyncio.TimeoutError):
await asyncio.wait_for(connected.recv(), 0.05)
ep1.close()
ep2.close()
connected.close()
@pytest.mark.skipif(
(3, 13) <= sys.version_info < (3, 13, 6)
or (3, 14) <= sys.version_info < (3, 14, 1),
reason="https://github.com/python/cpython/issues/135444",
)
@pytest.mark.asyncio
async def test_protocol_pause_resume(
monkeypatch: pytest.MonkeyPatch,
tmp_path: pathlib.Path,
) -> None:
# This is a little involved, but necessary to make sure that the Protocol
# is correctly noticing when writing as been paused and resumed. In
# summary:
#
# - Mock the Protocol with one that sets the write buffer limits to 0 and
# records when pause and resume writing are called.
#
# - Use a mock socket so that we can inject a BlockingIOError on send.
# Ideally we'd mock method itself, but it's read-only the entire object
# needs to be mocked. Due to this, we need to use a temporary file that we
# can write to in order to kick the event loop to consider it ready for
# writing.
class TestableProtocol(asyncio_dgram.aio.Protocol):
pause_writing_called = 0
resume_writing_called = 0
instance = None
def __init__(self, *args, **kwds) -> None: # type: ignore
TestableProtocol.instance = self
super().__init__(*args, **kwds)
def connection_made(self, transport: asyncio.BaseTransport) -> None:
assert isinstance(transport, asyncio.WriteTransport)
transport.set_write_buffer_limits(low=0, high=0)
super().connection_made(transport)
def pause_writing(self) -> None:
self.pause_writing_called += 1
super().pause_writing()
def resume_writing(self) -> None:
self.resume_writing_called += 1
super().resume_writing()
async def passthrough() -> None:
"""
Used to mock the wait method on the asyncio.Event tracking if the write
buffer is past the high water mark or not. Given we're testing how
that case is handled, we know it's safe locally to mock it.
"""
pass
with (
monkeypatch.context() as ctx,
socket.socket(socket.AF_INET, socket.SOCK_DGRAM) as sock,
):
sock.setblocking(False)
ctx.setattr(asyncio_dgram.aio, "Protocol", TestableProtocol)
mock_socket = unittest.mock.create_autospec(socket.socket)
mock_socket.family = socket.AF_INET
mock_socket.type = socket.SOCK_DGRAM
mock_socket.fileno.return_value = sock.fileno()
client = await asyncio_dgram.from_socket(mock_socket)
assert isinstance(client, asyncio_dgram.aio.DatagramClient)
assert TestableProtocol.instance is not None
mock_socket.send.side_effect = BlockingIOError
with monkeypatch.context() as ctx2:
ctx2.setattr(client._drained, "wait", passthrough)
await client.send(b"foo")
assert TestableProtocol.instance.pause_writing_called == 1
assert TestableProtocol.instance.resume_writing_called == 0
assert not TestableProtocol.instance._drained.is_set()
mock_socket.send.side_effect = None
with monkeypatch.context() as ctx2:
ctx2.setattr(client._drained, "wait", passthrough)
await client.send(b"foo")
await asyncio.sleep(0.1)
assert TestableProtocol.instance.pause_writing_called == 1
assert TestableProtocol.instance.resume_writing_called == 1
assert TestableProtocol.instance._drained.is_set()
@pytest.mark.asyncio
async def test_transport_closed() -> None:
stream = await asyncio_dgram.bind(("127.0.0.1", 0))
# Two tasks, both receiving. This is a bit weird and we don't handle it at
# this level on purpose. The test is here to make that clear. If having
# multiple recv() calls racing against each other on a single event loop is
# desired, one can wrap the DatagramStream with some sort of
# dispatcher/adapter.
recv = asyncio.create_task(stream.recv())
recv_hung = asyncio.create_task(stream.recv())
# Make sure both tasks get past the initial check for
# transport.is_closing()
await asyncio.sleep(0.1)
stream.close()
# Recv scheduled before transport closed
with pytest.raises(asyncio_dgram.TransportClosed):
await recv
# This task isn't going to finish.
with pytest.raises(asyncio.TimeoutError):
await asyncio.wait_for(recv_hung, timeout=0.01)
assert recv_hung.cancelled()
# No recv after transport closed
with pytest.raises(asyncio_dgram.TransportClosed):
await stream.recv()
# No send after transport closed
with pytest.raises(asyncio_dgram.TransportClosed):
await stream.send(b"junk", ("127.0.0.1", 0))
@pytest.mark.asyncio
async def test_bind_reuse_port() -> None:
async def use_socket(
addr: _Address, reuse_port: typing.Optional[bool] = None
) -> None:
sock = await asyncio_dgram.bind(addr, reuse_port=reuse_port)
# give gather time to move to the other uses after the bind
await asyncio.sleep(0.1)
sock.close()
addr = ("127.0.0.1", 53001)
clients_count = 10
with pytest.raises(OSError, match="Address already in use"):
await asyncio.gather(*[use_socket(addr) for _ in range(clients_count)])
# We use another port in case the prev socket is still active (/ is still closing)
addr_2 = ("127.0.0.1", 53002)
await asyncio.gather(
*[use_socket(addr_2, reuse_port=True) for _ in range(clients_count)]
)
|