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
|
"""
Protocol level tests.
"""
import asyncio
import gc
import os
import socket
import ssl
import pytest
from aiosmtplib import SMTPResponseException, SMTPServerDisconnected, SMTPTimeoutError
from aiosmtplib.protocol import FlowControlMixin, SMTPProtocol
from .compat import cleanup_server
async def test_protocol_connect(hostname: str, echo_server_port: int) -> None:
event_loop = asyncio.get_running_loop()
connect_future = event_loop.create_connection(
SMTPProtocol, host=hostname, port=echo_server_port
)
transport, protocol = await asyncio.wait_for(connect_future, timeout=1.0)
assert getattr(protocol, "transport", None) is transport
assert not transport.is_closing()
transport.close()
async def test_protocol_read_limit_overrun(
bind_address: str,
hostname: str,
monkeypatch: pytest.MonkeyPatch,
) -> None:
event_loop = asyncio.get_running_loop()
async def client_connected(
reader: asyncio.StreamReader, writer: asyncio.StreamWriter
) -> None:
await reader.read(1000)
long_response = (
b"220 At vero eos et accusamus et iusto odio dignissimos ducimus qui "
b"blanditiis praesentium voluptatum deleniti atque corruptis qui "
b"blanditiis praesentium voluptatum\n"
)
writer.write(long_response)
await writer.drain()
server = await asyncio.start_server(
client_connected, host=bind_address, port=0, family=socket.AF_INET
)
server_port = server.sockets[0].getsockname()[1] if server.sockets else 0
connect_future = event_loop.create_connection(
SMTPProtocol, host=hostname, port=server_port
)
_, protocol = await asyncio.wait_for(connect_future, timeout=1.0)
monkeypatch.setattr("aiosmtplib.protocol.MAX_LINE_LENGTH", 128)
with pytest.raises(SMTPResponseException) as exc_info:
await protocol.execute_command(b"TEST\n", timeout=1.0) # type: ignore
assert exc_info.value.code == 500
assert "Response too long" in exc_info.value.message
server.close()
await cleanup_server(server)
async def test_protocol_connected_check_on_read_response(
monkeypatch: pytest.MonkeyPatch,
) -> None:
protocol = SMTPProtocol()
monkeypatch.setattr(protocol, "transport", None)
with pytest.raises(SMTPServerDisconnected):
await protocol.read_response(timeout=1.0)
async def test_protocol_read_only_transport_error() -> None:
event_loop = asyncio.get_running_loop()
read_descriptor, _ = os.pipe()
read_pipe = os.fdopen(read_descriptor, "rb", buffering=0)
connect_future = event_loop.connect_read_pipe(SMTPProtocol, read_pipe)
transport, protocol = await asyncio.wait_for(connect_future, timeout=1.0)
assert getattr(protocol, "transport", None) is transport
with pytest.raises(RuntimeError, match="does not support writing"):
protocol.write(b"TEST\n")
transport.close()
async def test_protocol_connected_check_on_start_tls(
client_tls_context: ssl.SSLContext,
) -> None:
smtp_protocol = SMTPProtocol()
with pytest.raises(SMTPServerDisconnected):
await smtp_protocol.start_tls(client_tls_context, timeout=1.0)
async def test_protocol_already_over_tls_check_on_start_tls(
client_tls_context: ssl.SSLContext,
) -> None:
smtp_protocol = SMTPProtocol()
smtp_protocol._over_ssl = True
with pytest.raises(RuntimeError, match="Already using TLS"):
await smtp_protocol.start_tls(client_tls_context)
async def test_protocol_connection_reset_on_starttls(
hostname: str,
smtpd_server_port: int,
client_tls_context: ssl.SSLContext,
monkeypatch: pytest.MonkeyPatch,
) -> None:
event_loop = asyncio.get_running_loop()
connect_future = event_loop.create_connection(
SMTPProtocol, host=hostname, port=smtpd_server_port
)
transport, protocol = await asyncio.wait_for(connect_future, timeout=1.0)
def mock_start_tls(*args, **kwargs) -> None:
raise ConnectionResetError("Connection was reset")
monkeypatch.setattr(event_loop, "start_tls", mock_start_tls)
with pytest.raises(SMTPServerDisconnected):
await protocol.start_tls(client_tls_context)
transport.close()
async def test_protocol_timeout_on_starttls(
hostname: str,
smtpd_server_port: int,
client_tls_context: ssl.SSLContext,
monkeypatch: pytest.MonkeyPatch,
) -> None:
event_loop = asyncio.get_running_loop()
connect_future = event_loop.create_connection(
SMTPProtocol, host=hostname, port=smtpd_server_port
)
transport, protocol = await asyncio.wait_for(connect_future, timeout=1.0)
def mock_start_tls(*args, **kwargs) -> None:
raise TimeoutError("Timed out")
monkeypatch.setattr(event_loop, "start_tls", mock_start_tls)
with pytest.raises(SMTPTimeoutError, match="Timed out while upgrading transport"):
await protocol.start_tls(client_tls_context)
transport.close()
async def test_error_on_readline_with_partial_line(
bind_address: str, hostname: str
) -> None:
event_loop = asyncio.get_running_loop()
partial_response = b"499 incomplete response\\"
async def client_connected(
reader: asyncio.StreamReader, writer: asyncio.StreamWriter
) -> None:
writer.write(partial_response)
writer.write_eof()
await writer.drain()
server = await asyncio.start_server(
client_connected, host=bind_address, port=0, family=socket.AF_INET
)
server_port = server.sockets[0].getsockname()[1] if server.sockets else 0
connect_future = event_loop.create_connection(
SMTPProtocol, host=hostname, port=server_port
)
_, protocol = await asyncio.wait_for(connect_future, timeout=1.0)
with pytest.raises(SMTPServerDisconnected):
await protocol.read_response(timeout=1.0) # type: ignore
server.close()
await cleanup_server(server)
async def test_protocol_error_on_readline_with_malformed_response(
bind_address: str, hostname: str
) -> None:
event_loop = asyncio.get_running_loop()
response = b"ERROR\n"
async def client_connected(
reader: asyncio.StreamReader, writer: asyncio.StreamWriter
) -> None:
writer.write(response)
writer.write_eof()
await writer.drain()
server = await asyncio.start_server(
client_connected, host=bind_address, port=0, family=socket.AF_INET
)
server_port = server.sockets[0].getsockname()[1] if server.sockets else 0
connect_future = event_loop.create_connection(
SMTPProtocol, host=hostname, port=server_port
)
_, protocol = await asyncio.wait_for(connect_future, timeout=1.0)
with pytest.raises(
SMTPResponseException, match="Malformed SMTP response line: ERROR"
):
await protocol.read_response(timeout=1.0) # type: ignore
server.close()
await cleanup_server(server)
async def test_protocol_response_waiter_unset(
bind_address: str,
hostname: str,
monkeypatch: pytest.MonkeyPatch,
) -> None:
event_loop = asyncio.get_running_loop()
async def client_connected(
reader: asyncio.StreamReader, writer: asyncio.StreamWriter
) -> None:
await reader.read(1000)
writer.write(b"220 Hi\r\n")
await writer.drain()
server = await asyncio.start_server(
client_connected, host=bind_address, port=0, family=socket.AF_INET
)
server_port = server.sockets[0].getsockname()[1] if server.sockets else 0
connect_future = event_loop.create_connection(
SMTPProtocol, host=hostname, port=server_port
)
_, protocol = await asyncio.wait_for(connect_future, timeout=1.0)
monkeypatch.setattr(protocol, "_response_waiter", None)
with pytest.raises(SMTPServerDisconnected):
await protocol.execute_command(b"TEST\n", timeout=1.0) # type: ignore
server.close()
await cleanup_server(server)
async def test_protocol_data_received_called_twice(
bind_address: str,
hostname: str,
) -> None:
event_loop = asyncio.get_running_loop()
async def client_connected(
reader: asyncio.StreamReader, writer: asyncio.StreamWriter
) -> None:
await reader.read(1000)
writer.write(b"220 Hi\r\n")
await writer.drain()
await asyncio.sleep(0)
writer.write(b"221 Hi again!\r\n")
await writer.drain()
server = await asyncio.start_server(
client_connected, host=bind_address, port=0, family=socket.AF_INET
)
server_port = server.sockets[0].getsockname()[1] if server.sockets else 0
connect_future = event_loop.create_connection(
SMTPProtocol, host=hostname, port=server_port
)
_, protocol = await asyncio.wait_for(connect_future, timeout=1.0)
response = await protocol.execute_command(b"TEST\n", timeout=1.0) # type: ignore
assert response.code == 220
assert response.message == "Hi"
server.close()
await cleanup_server(server)
async def test_protocol_eof_response(bind_address: str, hostname: str) -> None:
event_loop = asyncio.get_running_loop()
async def client_connected(
reader: asyncio.StreamReader, writer: asyncio.StreamWriter
) -> None:
writer.transport.abort() # type: ignore
server = await asyncio.start_server(
client_connected, host=bind_address, port=0, family=socket.AF_INET
)
server_port = server.sockets[0].getsockname()[1] if server.sockets else 0
connect_future = event_loop.create_connection(
SMTPProtocol, host=hostname, port=server_port
)
await asyncio.wait_for(connect_future, timeout=1.0)
server.close()
await cleanup_server(server)
@pytest.mark.skip_if_uvloop(reason="flaky on uvloop")
async def test_protocol_exception_cleanup_warning(
caplog: pytest.LogCaptureFixture,
debug_event_loop: asyncio.AbstractEventLoop,
bind_address: str,
hostname: str,
) -> None:
async def client_connected(
reader: asyncio.StreamReader, writer: asyncio.StreamWriter
) -> None:
await reader.read(1000)
writer.write(b"220 Hi\r\n")
await writer.drain()
await reader.read(1000)
writer.write(b"221 Bye\r\n")
await writer.drain()
writer.transport.close()
server = await asyncio.start_server(
client_connected, host=bind_address, port=0, family=socket.AF_INET
)
server_port = server.sockets[0].getsockname()[1] if server.sockets else 0
connect_future = debug_event_loop.create_connection(
SMTPProtocol, host=hostname, port=server_port
)
_, protocol = await asyncio.wait_for(connect_future, timeout=1.0)
await protocol.execute_command(b"HELO\n", timeout=1.0)
await protocol.execute_command(b"QUIT\n", timeout=1.0)
del protocol
# Force garbage collection
gc.collect()
server.close()
await cleanup_server(server)
assert "Future exception was never retrieved" not in caplog.text
async def test_protocol_get_close_waiter() -> None:
event_loop = asyncio.get_running_loop()
protocol = SMTPProtocol(event_loop)
close_waiter = protocol._get_close_waiter(None) # type: ignore
assert close_waiter is not None
async def test_protocol_missing_command_lock_disconnected() -> None:
event_loop = asyncio.get_running_loop()
protocol = SMTPProtocol(event_loop)
with pytest.raises(SMTPServerDisconnected):
await protocol.execute_command(b"TEST\n")
with pytest.raises(SMTPServerDisconnected):
await protocol.execute_data_command(b"TEST\n")
async def test_flow_control_mixin_drain():
event_loop = asyncio.get_running_loop()
# Adapted from stdlib
drained = 0
async def drainer(stream):
nonlocal drained
await stream._drain_helper()
drained += 1
stream = FlowControlMixin(event_loop)
stream.pause_writing()
event_loop.call_later(0.1, stream.resume_writing)
await asyncio.gather(*[drainer(stream) for _ in range(10)])
assert drained == 10
async def test_flow_control_mixin_drain_incomplete():
event_loop = asyncio.get_running_loop()
flow_control = FlowControlMixin(event_loop)
flow_control.pause_writing()
waiter = event_loop.create_future()
flow_control._drain_waiters.append(waiter)
waiter.set_result("test")
flow_control.resume_writing()
assert waiter.done()
assert not waiter.cancelled()
def test_flow_control_mixin_connection_lost_exception(
event_loop: asyncio.AbstractEventLoop,
) -> None:
flow_control = FlowControlMixin(event_loop)
flow_control.pause_writing()
waiter = event_loop.create_future()
flow_control._drain_waiters.append(waiter)
exc = ConnectionAbortedError("boom")
flow_control.connection_lost(exc)
assert waiter.done()
assert not waiter.cancelled()
assert waiter.exception() is exc
def test_flow_control_mixin_connection_lost_no_exception(
event_loop: asyncio.AbstractEventLoop,
) -> None:
flow_control = FlowControlMixin(event_loop)
flow_control.pause_writing()
waiter = event_loop.create_future()
flow_control._drain_waiters.append(waiter)
flow_control.connection_lost(None)
assert waiter.done()
assert not waiter.cancelled()
assert waiter.exception() is None
def test_flow_control_mixin_connection_lost_done(
event_loop: asyncio.AbstractEventLoop,
) -> None:
flow_control = FlowControlMixin(event_loop)
flow_control.pause_writing()
waiter = event_loop.create_future()
flow_control._drain_waiters.append(waiter)
exc = ConnectionResetError("boom")
waiter.set_exception(exc)
flow_control.connection_lost(None)
assert waiter.done()
assert not waiter.cancelled()
assert waiter.exception() is exc
async def test_flow_control_mixin_drain_helper() -> None:
loop = asyncio.get_running_loop()
flow_control = FlowControlMixin(loop)
await flow_control._drain_helper()
async def test_flow_control_mixin_drain_helper_connection_lost() -> None:
loop = asyncio.get_running_loop()
flow_control = FlowControlMixin(loop)
flow_control.pause_writing()
flow_control.connection_lost(None)
with pytest.raises(ConnectionResetError):
await flow_control._drain_helper()
|