File size: 33,862 Bytes
065fee7 |
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 |
import asyncio
import contextlib
import gc
import io
import json
from http.cookies import SimpleCookie
from typing import Any, Awaitable, Callable, List
from unittest import mock
from uuid import uuid4
import pytest
from multidict import CIMultiDict, MultiDict
from re_assert import Matches
from yarl import URL
import aiohttp
from aiohttp import client, hdrs, web
from aiohttp.client import ClientSession
from aiohttp.client_proto import ResponseHandler
from aiohttp.client_reqrep import ClientRequest
from aiohttp.connector import BaseConnector, Connection, TCPConnector, UnixConnector
from aiohttp.helpers import DEBUG
from aiohttp.test_utils import make_mocked_coro
from aiohttp.tracing import Trace
@pytest.fixture
def connector(loop):
async def make_conn():
return BaseConnector(loop=loop)
conn = loop.run_until_complete(make_conn())
proto = mock.Mock()
conn._conns["a"] = [(proto, 123)]
yield conn
loop.run_until_complete(conn.close())
@pytest.fixture
def create_session(loop):
session = None
async def maker(*args, **kwargs):
nonlocal session
session = ClientSession(*args, loop=loop, **kwargs)
return session
yield maker
if session is not None:
loop.run_until_complete(session.close())
@pytest.fixture
def session(create_session, loop):
return loop.run_until_complete(create_session())
@pytest.fixture
def params():
return dict(
headers={"Authorization": "Basic ..."},
max_redirects=2,
encoding="latin1",
version=aiohttp.HttpVersion10,
compress="deflate",
chunked=True,
expect100=True,
read_until_eof=False,
)
async def test_close_coro(create_session) -> None:
session = await create_session()
await session.close()
async def test_init_headers_simple_dict(create_session) -> None:
session = await create_session(headers={"h1": "header1", "h2": "header2"})
assert sorted(session.headers.items()) == ([("h1", "header1"), ("h2", "header2")])
async def test_init_headers_list_of_tuples(create_session) -> None:
session = await create_session(
headers=[("h1", "header1"), ("h2", "header2"), ("h3", "header3")]
)
assert session.headers == CIMultiDict(
[("h1", "header1"), ("h2", "header2"), ("h3", "header3")]
)
async def test_init_headers_MultiDict(create_session) -> None:
session = await create_session(
headers=MultiDict([("h1", "header1"), ("h2", "header2"), ("h3", "header3")])
)
assert session.headers == CIMultiDict(
[("H1", "header1"), ("H2", "header2"), ("H3", "header3")]
)
async def test_init_headers_list_of_tuples_with_duplicates(create_session) -> None:
session = await create_session(
headers=[("h1", "header11"), ("h2", "header21"), ("h1", "header12")]
)
assert session.headers == CIMultiDict(
[("H1", "header11"), ("H2", "header21"), ("H1", "header12")]
)
async def test_init_cookies_with_simple_dict(create_session) -> None:
session = await create_session(cookies={"c1": "cookie1", "c2": "cookie2"})
cookies = session.cookie_jar.filter_cookies()
assert set(cookies) == {"c1", "c2"}
assert cookies["c1"].value == "cookie1"
assert cookies["c2"].value == "cookie2"
async def test_init_cookies_with_list_of_tuples(create_session) -> None:
session = await create_session(cookies=[("c1", "cookie1"), ("c2", "cookie2")])
cookies = session.cookie_jar.filter_cookies()
assert set(cookies) == {"c1", "c2"}
assert cookies["c1"].value == "cookie1"
assert cookies["c2"].value == "cookie2"
async def test_merge_headers(create_session) -> None:
# Check incoming simple dict
session = await create_session(headers={"h1": "header1", "h2": "header2"})
headers = session._prepare_headers({"h1": "h1"})
assert isinstance(headers, CIMultiDict)
assert headers == {"h1": "h1", "h2": "header2"}
async def test_merge_headers_with_multi_dict(create_session) -> None:
session = await create_session(headers={"h1": "header1", "h2": "header2"})
headers = session._prepare_headers(MultiDict([("h1", "h1")]))
assert isinstance(headers, CIMultiDict)
assert headers == {"h1": "h1", "h2": "header2"}
async def test_merge_headers_with_list_of_tuples(create_session) -> None:
session = await create_session(headers={"h1": "header1", "h2": "header2"})
headers = session._prepare_headers([("h1", "h1")])
assert isinstance(headers, CIMultiDict)
assert headers == {"h1": "h1", "h2": "header2"}
async def test_merge_headers_with_list_of_tuples_duplicated_names(
create_session,
) -> None:
session = await create_session(headers={"h1": "header1", "h2": "header2"})
headers = session._prepare_headers([("h1", "v1"), ("h1", "v2")])
assert isinstance(headers, CIMultiDict)
assert list(sorted(headers.items())) == [
("h1", "v1"),
("h1", "v2"),
("h2", "header2"),
]
def test_http_GET(session, params) -> None:
with mock.patch(
"aiohttp.client.ClientSession._request", new_callable=mock.MagicMock
) as patched:
session.get("http://test.example.com", params={"x": 1}, **params)
assert patched.called, "`ClientSession._request` not called"
assert list(patched.call_args) == [
(
"GET",
"http://test.example.com",
),
dict(params={"x": 1}, allow_redirects=True, **params),
]
def test_http_OPTIONS(session, params) -> None:
with mock.patch(
"aiohttp.client.ClientSession._request", new_callable=mock.MagicMock
) as patched:
session.options("http://opt.example.com", params={"x": 2}, **params)
assert patched.called, "`ClientSession._request` not called"
assert list(patched.call_args) == [
(
"OPTIONS",
"http://opt.example.com",
),
dict(params={"x": 2}, allow_redirects=True, **params),
]
def test_http_HEAD(session, params) -> None:
with mock.patch(
"aiohttp.client.ClientSession._request", new_callable=mock.MagicMock
) as patched:
session.head("http://head.example.com", params={"x": 2}, **params)
assert patched.called, "`ClientSession._request` not called"
assert list(patched.call_args) == [
(
"HEAD",
"http://head.example.com",
),
dict(params={"x": 2}, allow_redirects=False, **params),
]
def test_http_POST(session, params) -> None:
with mock.patch(
"aiohttp.client.ClientSession._request", new_callable=mock.MagicMock
) as patched:
session.post(
"http://post.example.com", params={"x": 2}, data="Some_data", **params
)
assert patched.called, "`ClientSession._request` not called"
assert list(patched.call_args) == [
(
"POST",
"http://post.example.com",
),
dict(params={"x": 2}, data="Some_data", **params),
]
def test_http_PUT(session, params) -> None:
with mock.patch(
"aiohttp.client.ClientSession._request", new_callable=mock.MagicMock
) as patched:
session.put(
"http://put.example.com", params={"x": 2}, data="Some_data", **params
)
assert patched.called, "`ClientSession._request` not called"
assert list(patched.call_args) == [
(
"PUT",
"http://put.example.com",
),
dict(params={"x": 2}, data="Some_data", **params),
]
def test_http_PATCH(session, params) -> None:
with mock.patch(
"aiohttp.client.ClientSession._request", new_callable=mock.MagicMock
) as patched:
session.patch(
"http://patch.example.com", params={"x": 2}, data="Some_data", **params
)
assert patched.called, "`ClientSession._request` not called"
assert list(patched.call_args) == [
(
"PATCH",
"http://patch.example.com",
),
dict(params={"x": 2}, data="Some_data", **params),
]
def test_http_DELETE(session, params) -> None:
with mock.patch(
"aiohttp.client.ClientSession._request", new_callable=mock.MagicMock
) as patched:
session.delete("http://delete.example.com", params={"x": 2}, **params)
assert patched.called, "`ClientSession._request` not called"
assert list(patched.call_args) == [
(
"DELETE",
"http://delete.example.com",
),
dict(params={"x": 2}, **params),
]
async def test_close(create_session, connector) -> None:
session = await create_session(connector=connector)
await session.close()
assert session.connector is None
assert connector.closed
async def test_closed(session) -> None:
assert not session.closed
await session.close()
assert session.closed
async def test_connector(create_session, loop, mocker) -> None:
connector = TCPConnector(loop=loop)
mocker.spy(connector, "close")
session = await create_session(connector=connector)
assert session.connector is connector
await session.close()
assert connector.close.called
await connector.close()
async def test_create_connector(create_session, loop, mocker) -> None:
session = await create_session()
connector = session.connector
mocker.spy(session.connector, "close")
await session.close()
assert connector.close.called
def test_connector_loop(loop) -> None:
with contextlib.ExitStack() as stack:
another_loop = asyncio.new_event_loop()
stack.enter_context(contextlib.closing(another_loop))
async def make_connector():
return TCPConnector()
connector = another_loop.run_until_complete(make_connector())
with pytest.raises(RuntimeError) as ctx:
async def make_sess():
return ClientSession(connector=connector, loop=loop)
loop.run_until_complete(make_sess())
assert (
Matches("Session and connector has to use same event loop")
== str(ctx.value).strip()
)
another_loop.run_until_complete(connector.close())
def test_detach(loop, session) -> None:
conn = session.connector
try:
assert not conn.closed
session.detach()
assert session.connector is None
assert session.closed
assert not conn.closed
finally:
loop.run_until_complete(conn.close())
async def test_request_closed_session(session) -> None:
await session.close()
with pytest.raises(RuntimeError):
await session.request("get", "/")
def test_close_flag_for_closed_connector(loop, session) -> None:
conn = session.connector
assert not session.closed
loop.run_until_complete(conn.close())
assert session.closed
async def test_double_close(connector, create_session) -> None:
session = await create_session(connector=connector)
await session.close()
assert session.connector is None
await session.close()
assert session.closed
assert connector.closed
async def test_del(connector, loop) -> None:
loop.set_debug(False)
# N.B. don't use session fixture, it stores extra reference internally
session = ClientSession(connector=connector, loop=loop)
logs = []
loop.set_exception_handler(lambda loop, ctx: logs.append(ctx))
with pytest.warns(ResourceWarning):
del session
gc.collect()
assert len(logs) == 1
expected = {"client_session": mock.ANY, "message": "Unclosed client session"}
assert logs[0] == expected
async def test_del_debug(connector, loop) -> None:
loop.set_debug(True)
# N.B. don't use session fixture, it stores extra reference internally
session = ClientSession(connector=connector, loop=loop)
logs = []
loop.set_exception_handler(lambda loop, ctx: logs.append(ctx))
with pytest.warns(ResourceWarning):
del session
gc.collect()
assert len(logs) == 1
expected = {
"client_session": mock.ANY,
"message": "Unclosed client session",
"source_traceback": mock.ANY,
}
assert logs[0] == expected
async def test_session_context_manager(connector, loop) -> None:
with pytest.raises(TypeError):
with ClientSession(loop=loop, connector=connector) as session:
pass
assert session.closed
async def test_borrow_connector_loop(connector, create_session, loop) -> None:
session = ClientSession(connector=connector, loop=None)
try:
assert session._loop, loop
finally:
await session.close()
async def test_reraise_os_error(create_session) -> None:
err = OSError(1, "permission error")
req = mock.Mock()
req_factory = mock.Mock(return_value=req)
req.send = mock.Mock(side_effect=err)
session = await create_session(request_class=req_factory)
async def create_connection(req, traces, timeout):
# return self.transport, self.protocol
return mock.Mock()
session._connector._create_connection = create_connection
session._connector._release = mock.Mock()
with pytest.raises(aiohttp.ClientOSError) as ctx:
await session.request("get", "http://example.com")
e = ctx.value
assert e.errno == err.errno
assert e.strerror == err.strerror
async def test_close_conn_on_error(create_session) -> None:
class UnexpectedException(BaseException):
pass
err = UnexpectedException("permission error")
req = mock.Mock()
req_factory = mock.Mock(return_value=req)
req.send = mock.Mock(side_effect=err)
session = await create_session(request_class=req_factory)
connections = []
original_connect = session._connector.connect
async def connect(req, traces, timeout):
conn = await original_connect(req, traces, timeout)
connections.append(conn)
return conn
async def create_connection(req, traces, timeout):
# return self.transport, self.protocol
conn = mock.Mock()
return conn
session._connector.connect = connect
session._connector._create_connection = create_connection
session._connector._release = mock.Mock()
with pytest.raises(UnexpectedException):
async with session.request("get", "http://example.com") as resp:
await resp.text()
# normally called during garbage collection. triggers an exception
# if the connection wasn't already closed
for c in connections:
c.__del__()
@pytest.mark.parametrize("protocol", ["http", "https", "ws", "wss"])
async def test_ws_connect_allowed_protocols(
create_session: Any,
create_mocked_conn: Any,
protocol: str,
ws_key: Any,
key_data: Any,
) -> None:
resp = mock.create_autospec(aiohttp.ClientResponse)
resp.status = 101
resp.headers = {
hdrs.UPGRADE: "websocket",
hdrs.CONNECTION: "upgrade",
hdrs.SEC_WEBSOCKET_ACCEPT: ws_key,
}
resp.url = URL(f"{protocol}://example")
resp.cookies = SimpleCookie()
resp.start = mock.AsyncMock()
req = mock.create_autospec(aiohttp.ClientRequest, spec_set=True)
req_factory = mock.Mock(return_value=req)
req.send = mock.AsyncMock(return_value=resp)
# BaseConnector allows all high level protocols by default
connector = BaseConnector()
session = await create_session(connector=connector, request_class=req_factory)
connections = []
original_connect = session._connector.connect
async def connect(req, traces, timeout):
conn = await original_connect(req, traces, timeout)
connections.append(conn)
return conn
async def create_connection(req, traces, timeout):
return create_mocked_conn()
connector = session._connector
with mock.patch.object(connector, "connect", connect), mock.patch.object(
connector, "_create_connection", create_connection
), mock.patch.object(connector, "_release"), mock.patch(
"aiohttp.client.os"
) as m_os:
m_os.urandom.return_value = key_data
await session.ws_connect(f"{protocol}://example")
# normally called during garbage collection. triggers an exception
# if the connection wasn't already closed
for c in connections:
c.close()
c.__del__()
await session.close()
@pytest.mark.parametrize("protocol", ["http", "https", "ws", "wss", "unix"])
async def test_ws_connect_unix_socket_allowed_protocols(
create_session: Callable[..., Awaitable[ClientSession]],
create_mocked_conn: Callable[[], ResponseHandler],
protocol: str,
ws_key: bytes,
key_data: bytes,
) -> None:
resp = mock.create_autospec(aiohttp.ClientResponse)
resp.status = 101
resp.headers = {
hdrs.UPGRADE: "websocket",
hdrs.CONNECTION: "upgrade",
hdrs.SEC_WEBSOCKET_ACCEPT: ws_key,
}
resp.url = URL(f"{protocol}://example")
resp.cookies = SimpleCookie()
resp.start = mock.AsyncMock()
req = mock.create_autospec(aiohttp.ClientRequest, spec_set=True)
req_factory = mock.Mock(return_value=req)
req.send = mock.AsyncMock(return_value=resp)
# UnixConnector allows all high level protocols by default and unix sockets
session = await create_session(
connector=UnixConnector(path=""), request_class=req_factory
)
connections = []
assert session._connector is not None
original_connect = session._connector.connect
async def connect(
req: ClientRequest, traces: List[Trace], timeout: aiohttp.ClientTimeout
) -> Connection:
conn = await original_connect(req, traces, timeout)
connections.append(conn)
return conn
async def create_connection(
req: object, traces: object, timeout: object
) -> ResponseHandler:
return create_mocked_conn()
connector = session._connector
with mock.patch.object(connector, "connect", connect), mock.patch.object(
connector, "_create_connection", create_connection
), mock.patch.object(connector, "_release"), mock.patch(
"aiohttp.client.os"
) as m_os:
m_os.urandom.return_value = key_data
await session.ws_connect(f"{protocol}://example")
# normally called during garbage collection. triggers an exception
# if the connection wasn't already closed
for c in connections:
c.close()
c.__del__()
await session.close()
async def test_cookie_jar_usage(loop: Any, aiohttp_client: Any) -> None:
req_url = None
jar = mock.Mock()
jar.filter_cookies.return_value = None
async def handler(request):
nonlocal req_url
req_url = "http://%s/" % request.host
resp = web.Response()
resp.set_cookie("response", "resp_value")
return resp
app = web.Application()
app.router.add_route("GET", "/", handler)
session = await aiohttp_client(
app, cookies={"request": "req_value"}, cookie_jar=jar
)
# Updating the cookie jar with initial user defined cookies
jar.update_cookies.assert_called_with({"request": "req_value"})
jar.update_cookies.reset_mock()
resp = await session.get("/")
await resp.release()
# Filtering the cookie jar before sending the request,
# getting the request URL as only parameter
jar.filter_cookies.assert_called_with(URL(req_url))
# Updating the cookie jar with the response cookies
assert jar.update_cookies.called
resp_cookies = jar.update_cookies.call_args[0][0]
assert isinstance(resp_cookies, SimpleCookie)
assert "response" in resp_cookies
assert resp_cookies["response"].value == "resp_value"
async def test_session_default_version(loop) -> None:
session = aiohttp.ClientSession(loop=loop)
assert session.version == aiohttp.HttpVersion11
await session.close()
async def test_session_loop(loop) -> None:
session = aiohttp.ClientSession(loop=loop)
with pytest.warns(DeprecationWarning):
assert session.loop is loop
await session.close()
def test_proxy_str(session, params) -> None:
with mock.patch(
"aiohttp.client.ClientSession._request", new_callable=mock.MagicMock
) as patched:
session.get("http://test.example.com", proxy="http://proxy.com", **params)
assert patched.called, "`ClientSession._request` not called"
assert list(patched.call_args) == [
(
"GET",
"http://test.example.com",
),
dict(allow_redirects=True, proxy="http://proxy.com", **params),
]
async def test_request_tracing(loop, aiohttp_client) -> None:
async def handler(request):
return web.json_response({"ok": True})
app = web.Application()
app.router.add_post("/", handler)
trace_config_ctx = mock.Mock()
trace_request_ctx = {}
body = "This is request body"
gathered_req_headers = CIMultiDict()
on_request_start = mock.Mock(side_effect=make_mocked_coro(mock.Mock()))
on_request_redirect = mock.Mock(side_effect=make_mocked_coro(mock.Mock()))
on_request_end = mock.Mock(side_effect=make_mocked_coro(mock.Mock()))
with io.BytesIO() as gathered_req_body, io.BytesIO() as gathered_res_body:
async def on_request_chunk_sent(session, context, params):
gathered_req_body.write(params.chunk)
async def on_response_chunk_received(session, context, params):
gathered_res_body.write(params.chunk)
async def on_request_headers_sent(session, context, params):
gathered_req_headers.extend(**params.headers)
trace_config = aiohttp.TraceConfig(
trace_config_ctx_factory=mock.Mock(return_value=trace_config_ctx)
)
trace_config.on_request_start.append(on_request_start)
trace_config.on_request_end.append(on_request_end)
trace_config.on_request_chunk_sent.append(on_request_chunk_sent)
trace_config.on_response_chunk_received.append(on_response_chunk_received)
trace_config.on_request_redirect.append(on_request_redirect)
trace_config.on_request_headers_sent.append(on_request_headers_sent)
headers = CIMultiDict({"Custom-Header": "Custom value"})
session = await aiohttp_client(
app, trace_configs=[trace_config], headers=headers
)
async with session.post(
"/", data=body, trace_request_ctx=trace_request_ctx
) as resp:
await resp.json()
on_request_start.assert_called_once_with(
session.session,
trace_config_ctx,
aiohttp.TraceRequestStartParams(
hdrs.METH_POST, session.make_url("/"), headers
),
)
on_request_end.assert_called_once_with(
session.session,
trace_config_ctx,
aiohttp.TraceRequestEndParams(
hdrs.METH_POST, session.make_url("/"), headers, resp
),
)
assert not on_request_redirect.called
assert gathered_req_body.getvalue() == body.encode("utf8")
assert gathered_res_body.getvalue() == json.dumps({"ok": True}).encode(
"utf8"
)
assert gathered_req_headers["Custom-Header"] == "Custom value"
async def test_request_tracing_url_params(loop: Any, aiohttp_client: Any) -> None:
async def root_handler(request):
return web.Response()
async def redirect_handler(request):
raise web.HTTPFound("/")
app = web.Application()
app.router.add_get("/", root_handler)
app.router.add_get("/redirect", redirect_handler)
mocks = [mock.Mock(side_effect=make_mocked_coro(mock.Mock())) for _ in range(7)]
(
on_request_start,
on_request_redirect,
on_request_end,
on_request_exception,
on_request_chunk_sent,
on_response_chunk_received,
on_request_headers_sent,
) = mocks
trace_config = aiohttp.TraceConfig(
trace_config_ctx_factory=mock.Mock(return_value=mock.Mock())
)
trace_config.on_request_start.append(on_request_start)
trace_config.on_request_redirect.append(on_request_redirect)
trace_config.on_request_end.append(on_request_end)
trace_config.on_request_exception.append(on_request_exception)
trace_config.on_request_chunk_sent.append(on_request_chunk_sent)
trace_config.on_response_chunk_received.append(on_response_chunk_received)
trace_config.on_request_headers_sent.append(on_request_headers_sent)
session = await aiohttp_client(app, trace_configs=[trace_config])
def reset_mocks() -> None:
for m in mocks:
m.reset_mock()
def to_trace_urls(mock_func: mock.Mock) -> List[URL]:
return [call_args[0][-1].url for call_args in mock_func.call_args_list]
def to_url(path: str) -> URL:
return session.make_url(path)
# Standard
for req in [
lambda: session.get("/?x=0"),
lambda: session.get("/", params=dict(x=0)),
]:
reset_mocks()
async with req() as resp:
await resp.text()
assert to_trace_urls(on_request_start) == [to_url("/?x=0")]
assert to_trace_urls(on_request_redirect) == []
assert to_trace_urls(on_request_end) == [to_url("/?x=0")]
assert to_trace_urls(on_request_exception) == []
assert to_trace_urls(on_request_chunk_sent) == [to_url("/?x=0")]
assert to_trace_urls(on_response_chunk_received) == [to_url("/?x=0")]
assert to_trace_urls(on_request_headers_sent) == [to_url("/?x=0")]
# Redirect
for req in [
lambda: session.get("/redirect?x=0"),
lambda: session.get("/redirect", params=dict(x=0)),
]:
reset_mocks()
async with req() as resp:
await resp.text()
assert to_trace_urls(on_request_start) == [to_url("/redirect?x=0")]
assert to_trace_urls(on_request_redirect) == [to_url("/redirect?x=0")]
assert to_trace_urls(on_request_end) == [to_url("/")]
assert to_trace_urls(on_request_exception) == []
assert to_trace_urls(on_request_chunk_sent) == [
to_url("/redirect?x=0"),
to_url("/"),
]
assert to_trace_urls(on_response_chunk_received) == [to_url("/")]
assert to_trace_urls(on_request_headers_sent) == [
to_url("/redirect?x=0"),
to_url("/"),
]
# Exception
with mock.patch("aiohttp.client.TCPConnector.connect") as connect_patched:
connect_patched.side_effect = Exception()
for req in [
lambda: session.get("/?x=0"),
lambda: session.get("/", params=dict(x=0)),
]:
reset_mocks()
with contextlib.suppress(Exception):
await req()
assert to_trace_urls(on_request_start) == [to_url("/?x=0")]
assert to_trace_urls(on_request_redirect) == []
assert to_trace_urls(on_request_end) == []
assert to_trace_urls(on_request_exception) == [to_url("?x=0")]
assert to_trace_urls(on_request_chunk_sent) == []
assert to_trace_urls(on_response_chunk_received) == []
assert to_trace_urls(on_request_headers_sent) == []
async def test_request_tracing_exception() -> None:
loop = asyncio.get_event_loop()
on_request_end = mock.Mock(side_effect=make_mocked_coro(mock.Mock()))
on_request_exception = mock.Mock(side_effect=make_mocked_coro(mock.Mock()))
trace_config = aiohttp.TraceConfig()
trace_config.on_request_end.append(on_request_end)
trace_config.on_request_exception.append(on_request_exception)
with mock.patch("aiohttp.client.TCPConnector.connect") as connect_patched:
error = Exception()
connect_patched.side_effect = error
session = aiohttp.ClientSession(loop=loop, trace_configs=[trace_config])
try:
await session.get("http://example.com")
except Exception:
pass
on_request_exception.assert_called_once_with(
session,
mock.ANY,
aiohttp.TraceRequestExceptionParams(
hdrs.METH_GET, URL("http://example.com"), CIMultiDict(), error
),
)
assert not on_request_end.called
await session.close()
async def test_request_tracing_interpose_headers(loop, aiohttp_client) -> None:
async def handler(request):
return web.Response()
app = web.Application()
app.router.add_get("/", handler)
class MyClientRequest(ClientRequest):
headers = None
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
MyClientRequest.headers = self.headers
async def new_headers(session, trace_config_ctx, data):
data.headers["foo"] = "bar"
trace_config = aiohttp.TraceConfig()
trace_config.on_request_start.append(new_headers)
session = await aiohttp_client(
app, request_class=MyClientRequest, trace_configs=[trace_config]
)
await session.get("/")
assert MyClientRequest.headers["foo"] == "bar"
def test_client_session_inheritance() -> None:
with pytest.warns(DeprecationWarning):
class A(ClientSession):
pass
@pytest.mark.skipif(not DEBUG, reason="The check is applied in DEBUG mode only")
async def test_client_session_custom_attr(loop) -> None:
session = ClientSession(loop=loop)
with pytest.warns(DeprecationWarning):
session.custom = None
await session.close()
async def test_client_session_timeout_args(loop) -> None:
session1 = ClientSession(loop=loop)
assert session1._timeout == client.DEFAULT_TIMEOUT
with pytest.warns(DeprecationWarning):
session2 = ClientSession(loop=loop, read_timeout=20 * 60, conn_timeout=30 * 60)
assert session2._timeout == client.ClientTimeout(total=20 * 60, connect=30 * 60)
with pytest.raises(ValueError):
ClientSession(
loop=loop, timeout=client.ClientTimeout(total=10 * 60), read_timeout=20 * 60
)
with pytest.raises(ValueError):
ClientSession(
loop=loop, timeout=client.ClientTimeout(total=10 * 60), conn_timeout=30 * 60
)
await session1.close()
await session2.close()
async def test_client_session_timeout_default_args(loop) -> None:
session1 = ClientSession()
assert session1.timeout == client.DEFAULT_TIMEOUT
await session1.close()
async def test_client_session_timeout_zero() -> None:
timeout = client.ClientTimeout(total=10, connect=0, sock_connect=0, sock_read=0)
try:
async with ClientSession(timeout=timeout) as session:
await session.get("http://example.com")
except asyncio.TimeoutError:
pytest.fail("0 should disable timeout.")
async def test_client_session_timeout_bad_argument() -> None:
with pytest.raises(ValueError):
ClientSession(timeout="test_bad_argumnet")
with pytest.raises(ValueError):
ClientSession(timeout=100)
async def test_requote_redirect_url_default() -> None:
session = ClientSession()
assert session.requote_redirect_url
await session.close()
async def test_requote_redirect_url_default_disable() -> None:
session = ClientSession(requote_redirect_url=False)
assert not session.requote_redirect_url
await session.close()
async def test_requote_redirect_setter() -> None:
session = ClientSession()
assert session.requote_redirect_url
with pytest.warns(DeprecationWarning):
session.requote_redirect_url = False
assert not session.requote_redirect_url
await session.close()
@pytest.mark.parametrize(
("base_url", "url", "expected_url"),
[
pytest.param(
None,
"http://example.com/test",
URL("http://example.com/test"),
id="base_url=None url='http://example.com/test'",
),
pytest.param(
None,
URL("http://example.com/test"),
URL("http://example.com/test"),
id="base_url=None url=URL('http://example.com/test')",
),
pytest.param(
"http://example.com",
"/test",
URL("http://example.com/test"),
id="base_url='http://example.com' url='/test'",
),
pytest.param(
URL("http://example.com"),
"/test",
URL("http://example.com/test"),
id="base_url=URL('http://example.com') url='/test'",
),
],
)
async def test_build_url_returns_expected_url(
create_session, base_url, url, expected_url
) -> None:
session = await create_session(base_url)
assert session._build_url(url) == expected_url
async def test_instantiation_with_invalid_timeout_value(loop):
loop.set_debug(False)
logs = []
loop.set_exception_handler(lambda loop, ctx: logs.append(ctx))
with pytest.raises(ValueError, match="timeout parameter cannot be .*"):
ClientSession(timeout=1)
# should not have "Unclosed client session" warning
assert not logs
@pytest.mark.parametrize(
("outer_name", "inner_name"),
[
("skip_auto_headers", "_skip_auto_headers"),
("auth", "_default_auth"),
("json_serialize", "_json_serialize"),
("connector_owner", "_connector_owner"),
("raise_for_status", "_raise_for_status"),
("trust_env", "_trust_env"),
("trace_configs", "_trace_configs"),
],
)
async def test_properties(
session: ClientSession, outer_name: str, inner_name: str
) -> None:
value = uuid4()
setattr(session, inner_name, value)
assert value == getattr(session, outer_name)
|