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
|
import asyncio
import socket
from contextlib import suppress
from typing import NoReturn
from unittest import mock
import pytest
from aiohttp import client, web
from aiohttp.http_exceptions import BadHttpMethod, BadStatusLine
from aiohttp.pytest_plugin import AiohttpClient, AiohttpRawServer
async def test_simple_server(aiohttp_raw_server, aiohttp_client) -> None:
async def handler(request):
return web.Response(text=str(request.rel_url))
server = await aiohttp_raw_server(handler)
cli = await aiohttp_client(server)
resp = await cli.get("/path/to")
assert resp.status == 200
txt = await resp.text()
assert txt == "/path/to"
async def test_unsupported_upgrade(aiohttp_raw_server, aiohttp_client) -> None:
# don't fail if a client probes for an unsupported protocol upgrade
# https://github.com/aio-libs/aiohttp/issues/6446#issuecomment-999032039
async def handler(request: web.Request):
return web.Response(body=await request.read())
upgrade_headers = {"Connection": "Upgrade", "Upgrade": "unsupported_proto"}
server = await aiohttp_raw_server(handler)
cli = await aiohttp_client(server)
test_data = b"Test"
resp = await cli.post("/path/to", data=test_data, headers=upgrade_headers)
assert resp.status == 200
data = await resp.read()
assert data == test_data
async def test_raw_server_not_http_exception(aiohttp_raw_server, aiohttp_client):
exc = RuntimeError("custom runtime error")
async def handler(request):
raise exc
logger = mock.Mock()
server = await aiohttp_raw_server(handler, logger=logger, debug=False)
cli = await aiohttp_client(server)
resp = await cli.get("/path/to")
assert resp.status == 500
assert resp.headers["Content-Type"].startswith("text/plain")
txt = await resp.text()
assert txt.startswith("500 Internal Server Error")
assert "Traceback" not in txt
logger.exception.assert_called_with(
"Error handling request from %s", cli.host, exc_info=exc
)
async def test_raw_server_logs_invalid_method_with_loop_debug(
aiohttp_raw_server: AiohttpRawServer,
aiohttp_client: AiohttpClient,
loop: asyncio.AbstractEventLoop,
) -> None:
exc = BadHttpMethod(b"\x16\x03\x03\x01F\x01".decode(), "error")
async def handler(request: web.BaseRequest) -> NoReturn:
raise exc
loop = asyncio.get_event_loop()
loop.set_debug(True)
logger = mock.Mock()
server = await aiohttp_raw_server(handler, logger=logger)
cli = await aiohttp_client(server)
resp = await cli.get("/path/to")
assert resp.status == 500
assert resp.headers["Content-Type"].startswith("text/plain")
txt = await resp.text()
assert "Traceback (most recent call last):\n" in txt
# BadHttpMethod should be logged as debug
# on the first request since the client may
# be probing for TLS/SSL support which is
# expected to fail
logger.debug.assert_called_with(
"Error handling request from %s", cli.host, exc_info=exc
)
logger.debug.reset_mock()
# Now make another connection to the server
# to make sure that the exception is logged
# at debug on a second fresh connection
cli2 = await aiohttp_client(server)
resp = await cli2.get("/path/to")
assert resp.status == 500
assert resp.headers["Content-Type"].startswith("text/plain")
# BadHttpMethod should be logged as debug
# on the first request since the client may
# be probing for TLS/SSL support which is
# expected to fail
logger.debug.assert_called_with(
"Error handling request from %s", cli.host, exc_info=exc
)
async def test_raw_server_logs_invalid_method_without_loop_debug(
aiohttp_raw_server: AiohttpRawServer,
aiohttp_client: AiohttpClient,
loop: asyncio.AbstractEventLoop,
) -> None:
exc = BadHttpMethod(b"\x16\x03\x03\x01F\x01".decode(), "error")
async def handler(request: web.BaseRequest) -> NoReturn:
raise exc
loop = asyncio.get_event_loop()
loop.set_debug(False)
logger = mock.Mock()
server = await aiohttp_raw_server(handler, logger=logger, debug=False)
cli = await aiohttp_client(server)
resp = await cli.get("/path/to")
assert resp.status == 500
assert resp.headers["Content-Type"].startswith("text/plain")
txt = await resp.text()
assert "Traceback (most recent call last):\n" not in txt
# BadHttpMethod should be logged as debug
# on the first request since the client may
# be probing for TLS/SSL support which is
# expected to fail
logger.debug.assert_called_with(
"Error handling request from %s", cli.host, exc_info=exc
)
async def test_raw_server_logs_invalid_method_second_request(
aiohttp_raw_server: AiohttpRawServer,
aiohttp_client: AiohttpClient,
loop: asyncio.AbstractEventLoop,
) -> None:
exc = BadHttpMethod(b"\x16\x03\x03\x01F\x01".decode(), "error")
request_count = 0
async def handler(request: web.BaseRequest) -> web.Response:
nonlocal request_count
request_count += 1
if request_count == 2:
raise exc
return web.Response()
loop = asyncio.get_event_loop()
loop.set_debug(False)
logger = mock.Mock()
server = await aiohttp_raw_server(handler, logger=logger)
cli = await aiohttp_client(server)
resp = await cli.get("/path/to")
assert resp.status == 200
resp = await cli.get("/path/to")
assert resp.status == 500
assert resp.headers["Content-Type"].startswith("text/plain")
# BadHttpMethod should be logged as an exception
# if its not the first request since we know
# that the client already was speaking HTTP
logger.exception.assert_called_with(
"Error handling request from %s", cli.host, exc_info=exc
)
async def test_raw_server_logs_bad_status_line_as_exception(
aiohttp_raw_server: AiohttpRawServer,
aiohttp_client: AiohttpClient,
loop: asyncio.AbstractEventLoop,
) -> None:
exc = BadStatusLine(b"\x16\x03\x03\x01F\x01".decode(), "error")
async def handler(request: web.BaseRequest) -> NoReturn:
raise exc
loop = asyncio.get_event_loop()
loop.set_debug(False)
logger = mock.Mock()
server = await aiohttp_raw_server(handler, logger=logger, debug=False)
cli = await aiohttp_client(server)
resp = await cli.get("/path/to")
assert resp.status == 500
assert resp.headers["Content-Type"].startswith("text/plain")
txt = await resp.text()
assert "Traceback (most recent call last):\n" not in txt
logger.exception.assert_called_with(
"Error handling request from %s", cli.host, exc_info=exc
)
async def test_raw_server_handler_timeout(
aiohttp_raw_server: AiohttpRawServer, aiohttp_client: AiohttpClient
) -> None:
loop = asyncio.get_event_loop()
loop.set_debug(True)
exc = asyncio.TimeoutError("error")
async def handler(request):
raise exc
logger = mock.Mock()
server = await aiohttp_raw_server(handler, logger=logger)
cli = await aiohttp_client(server)
resp = await cli.get("/path/to")
assert resp.status == 504
await resp.text()
logger.debug.assert_called_with("Request handler timed out.", exc_info=exc)
async def test_raw_server_do_not_swallow_exceptions(aiohttp_raw_server, aiohttp_client):
async def handler(request):
raise asyncio.CancelledError()
logger = mock.Mock()
server = await aiohttp_raw_server(handler, logger=logger)
cli = await aiohttp_client(server)
with pytest.raises(client.ServerDisconnectedError):
await cli.get("/path/to")
logger.debug.assert_called_with("Ignored premature client disconnection")
async def test_raw_server_does_not_swallow_base_exceptions(
aiohttp_raw_server: AiohttpRawServer, aiohttp_client: AiohttpClient
) -> None:
class UnexpectedException(BaseException):
"""Dummy base exception."""
async def handler(request: web.BaseRequest) -> NoReturn:
raise UnexpectedException()
loop = asyncio.get_event_loop()
loop.set_debug(True)
server = await aiohttp_raw_server(handler)
cli = await aiohttp_client(server)
with pytest.raises(client.ServerDisconnectedError):
await cli.get("/path/to", timeout=client.ClientTimeout(10))
async def test_raw_server_cancelled_in_write_eof(aiohttp_raw_server, aiohttp_client):
async def handler(request):
resp = web.Response(text=str(request.rel_url))
resp.write_eof = mock.Mock(side_effect=asyncio.CancelledError("error"))
return resp
logger = mock.Mock()
server = await aiohttp_raw_server(handler, logger=logger)
cli = await aiohttp_client(server)
resp = await cli.get("/path/to")
with pytest.raises(client.ClientPayloadError):
await resp.read()
logger.debug.assert_called_with("Ignored premature client disconnection")
async def test_raw_server_not_http_exception_debug(aiohttp_raw_server, aiohttp_client):
exc = RuntimeError("custom runtime error")
async def handler(request):
raise exc
logger = mock.Mock()
server = await aiohttp_raw_server(handler, logger=logger, debug=True)
cli = await aiohttp_client(server)
resp = await cli.get("/path/to")
assert resp.status == 500
assert resp.headers["Content-Type"].startswith("text/plain")
txt = await resp.text()
assert "Traceback (most recent call last):\n" in txt
logger.exception.assert_called_with(
"Error handling request from %s", cli.host, exc_info=exc
)
async def test_raw_server_html_exception(aiohttp_raw_server, aiohttp_client):
exc = RuntimeError("custom runtime error")
async def handler(request):
raise exc
logger = mock.Mock()
server = await aiohttp_raw_server(handler, logger=logger, debug=False)
cli = await aiohttp_client(server)
resp = await cli.get("/path/to", headers={"Accept": "text/html"})
assert resp.status == 500
assert resp.headers["Content-Type"].startswith("text/html")
txt = await resp.text()
assert txt == (
"<html><head><title>500 Internal Server Error</title></head><body>\n"
"<h1>500 Internal Server Error</h1>\n"
"Server got itself in trouble\n"
"</body></html>\n"
)
logger.exception.assert_called_with(
"Error handling request from %s", cli.host, exc_info=exc
)
async def test_raw_server_html_exception_debug(aiohttp_raw_server, aiohttp_client):
exc = RuntimeError("custom runtime error")
async def handler(request):
raise exc
logger = mock.Mock()
server = await aiohttp_raw_server(handler, logger=logger, debug=True)
cli = await aiohttp_client(server)
resp = await cli.get("/path/to", headers={"Accept": "text/html"})
assert resp.status == 500
assert resp.headers["Content-Type"].startswith("text/html")
txt = await resp.text()
assert txt.startswith(
"<html><head><title>500 Internal Server Error</title></head><body>\n"
"<h1>500 Internal Server Error</h1>\n"
"<h2>Traceback:</h2>\n"
"<pre>Traceback (most recent call last):\n"
)
logger.exception.assert_called_with(
"Error handling request from %s", cli.host, exc_info=exc
)
async def test_handler_cancellation(unused_port_socket: socket.socket) -> None:
event = asyncio.Event()
sock = unused_port_socket
port = sock.getsockname()[1]
async def on_request(_: web.Request) -> web.Response:
try:
await asyncio.sleep(10)
except asyncio.CancelledError:
event.set()
raise
else:
raise web.HTTPInternalServerError()
app = web.Application()
app.router.add_route("GET", "/", on_request)
runner = web.AppRunner(app, handler_cancellation=True)
await runner.setup()
site = web.SockSite(runner, sock=sock)
await site.start()
try:
assert runner.server.handler_cancellation, "Flag was not propagated"
async with client.ClientSession(
timeout=client.ClientTimeout(total=0.1)
) as sess:
with pytest.raises(asyncio.TimeoutError):
await sess.get(f"http://127.0.0.1:{port}/")
with suppress(asyncio.TimeoutError):
await asyncio.wait_for(event.wait(), timeout=1)
assert event.is_set(), "Request handler hasn't been cancelled"
finally:
await asyncio.gather(runner.shutdown(), site.stop())
async def test_no_handler_cancellation(unused_port_socket: socket.socket) -> None:
timeout_event = asyncio.Event()
done_event = asyncio.Event()
sock = unused_port_socket
port = sock.getsockname()[1]
started = False
async def on_request(_: web.Request) -> web.Response:
nonlocal started
started = True
await asyncio.wait_for(timeout_event.wait(), timeout=5)
done_event.set()
return web.Response()
app = web.Application()
app.router.add_route("GET", "/", on_request)
runner = web.AppRunner(app)
await runner.setup()
site = web.SockSite(runner, sock=sock)
await site.start()
try:
async with client.ClientSession(
timeout=client.ClientTimeout(total=0.2)
) as sess:
with pytest.raises(asyncio.TimeoutError):
await sess.get(f"http://127.0.0.1:{port}/")
await asyncio.sleep(0.1)
timeout_event.set()
with suppress(asyncio.TimeoutError):
await asyncio.wait_for(done_event.wait(), timeout=1)
assert started
assert done_event.is_set()
finally:
await asyncio.gather(runner.shutdown(), site.stop())
|