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
|
import asyncio
import json
import sys
from typing import Dict, Mapping
import pytest
from gql import Client, gql
from gql.transport.exceptions import (
TransportAlreadyConnected,
TransportClosed,
TransportQueryError,
TransportServerError,
)
from .conftest import MS, WebSocketServerHelper, get_localhost_ssl_context_client
# Marking all tests in this file with the aiohttp AND websockets marker
pytestmark = pytest.mark.aiohttp
query1_str = """
query getContinents {
continents {
code
name
}
}
"""
query1_server_answer_data = (
'{"continents":['
'{"code":"AF","name":"Africa"},{"code":"AN","name":"Antarctica"},'
'{"code":"AS","name":"Asia"},{"code":"EU","name":"Europe"},'
'{"code":"NA","name":"North America"},{"code":"OC","name":"Oceania"},'
'{"code":"SA","name":"South America"}]}'
)
query1_server_answer = (
'{{"type":"data","id":"{query_id}","payload":{{"data":{{"continents":['
'{{"code":"AF","name":"Africa"}},{{"code":"AN","name":"Antarctica"}},'
'{{"code":"AS","name":"Asia"}},{{"code":"EU","name":"Europe"}},'
'{{"code":"NA","name":"North America"}},{{"code":"OC","name":"Oceania"}},'
'{{"code":"SA","name":"South America"}}]}}}}}}'
)
server1_answers = [
query1_server_answer,
]
@pytest.mark.asyncio
@pytest.mark.parametrize("aiohttp_ws_server", [server1_answers], indirect=True)
async def test_aiohttp_websocket_starting_client_in_context_manager(
event_loop, aiohttp_ws_server
):
server = aiohttp_ws_server
from gql.transport.aiohttp_websockets import AIOHTTPWebsocketsTransport
url = f"ws://{server.hostname}:{server.port}/graphql"
print(f"url = {url}")
transport = AIOHTTPWebsocketsTransport(url=url, websocket_close_timeout=10)
async with Client(transport=transport) as session:
query1 = gql(query1_str)
result = await session.execute(query1)
print("Client received:", result)
# Verify result
assert isinstance(result, Dict)
continents = result["continents"]
africa = continents[0]
assert africa["code"] == "AF"
# Checking response headers are saved in the transport
assert hasattr(transport, "response_headers")
assert isinstance(transport.response_headers, Mapping)
assert transport.response_headers["dummy"] == "test1234"
# Check client is disconnect here
assert transport.websocket is None
@pytest.mark.asyncio
@pytest.mark.websockets
@pytest.mark.parametrize("ws_ssl_server", [server1_answers], indirect=True)
@pytest.mark.parametrize("ssl_close_timeout", [0, 10])
@pytest.mark.parametrize("verify_https", ["disabled", "cert_provided"])
async def test_aiohttp_websocket_using_ssl_connection(
event_loop, ws_ssl_server, ssl_close_timeout, verify_https
):
from gql.transport.aiohttp_websockets import AIOHTTPWebsocketsTransport
server = ws_ssl_server
url = f"wss://{server.hostname}:{server.port}/graphql"
print(f"url = {url}")
extra_args = {}
if verify_https == "cert_provided":
_, ssl_context = get_localhost_ssl_context_client()
extra_args["ssl"] = ssl_context
elif verify_https == "disabled":
extra_args["ssl"] = False
transport = AIOHTTPWebsocketsTransport(
url=url,
ssl_close_timeout=ssl_close_timeout,
**extra_args,
)
async with Client(transport=transport) as session:
query1 = gql(query1_str)
result = await session.execute(query1)
print("Client received:", result)
# Verify result
assert isinstance(result, Dict)
continents = result["continents"]
africa = continents[0]
assert africa["code"] == "AF"
# Check client is disconnect here
assert transport.websocket is None
@pytest.mark.asyncio
@pytest.mark.websockets
@pytest.mark.parametrize("ws_ssl_server", [server1_answers], indirect=True)
@pytest.mark.parametrize("ssl_close_timeout", [10])
@pytest.mark.parametrize("verify_https", ["explicitely_enabled", "default"])
async def test_aiohttp_websocket_using_ssl_connection_self_cert_fail(
event_loop, ws_ssl_server, ssl_close_timeout, verify_https
):
from aiohttp.client_exceptions import ClientConnectorCertificateError
from gql.transport.aiohttp_websockets import AIOHTTPWebsocketsTransport
server = ws_ssl_server
url = f"wss://{server.hostname}:{server.port}/graphql"
print(f"url = {url}")
extra_args = {}
if verify_https == "explicitely_enabled":
extra_args["ssl"] = True
transport = AIOHTTPWebsocketsTransport(
url=url,
ssl_close_timeout=ssl_close_timeout,
**extra_args,
)
with pytest.raises(ClientConnectorCertificateError) as exc_info:
async with Client(transport=transport) as session:
query1 = gql(query1_str)
await session.execute(query1)
expected_error = "certificate verify failed: self-signed certificate"
assert expected_error in str(exc_info.value)
# Check client is disconnect here
assert transport.websocket is None
@pytest.mark.asyncio
@pytest.mark.websockets
@pytest.mark.parametrize("server", [server1_answers], indirect=True)
@pytest.mark.parametrize("query_str", [query1_str])
async def test_aiohttp_websocket_simple_query(
event_loop, aiohttp_client_and_server, query_str
):
session, server = aiohttp_client_and_server
query = gql(query_str)
result = await session.execute(query)
print("Client received:", result)
server1_two_answers_in_series = [
query1_server_answer,
query1_server_answer,
]
@pytest.mark.asyncio
@pytest.mark.parametrize(
"aiohttp_ws_server", [server1_two_answers_in_series], indirect=True
)
@pytest.mark.parametrize("query_str", [query1_str])
async def test_aiohttp_websocket_two_queries_in_series(
event_loop, aiohttp_client_and_aiohttp_ws_server, query_str
):
session, server = aiohttp_client_and_aiohttp_ws_server
query = gql(query_str)
result1 = await session.execute(query)
print("Query1 received:", result1)
result2 = await session.execute(query)
print("Query2 received:", result2)
assert result1 == result2
async def server1_two_queries_in_parallel(ws):
await WebSocketServerHelper.send_connection_ack(ws)
result = await ws.recv()
print(f"Server received: {result}", file=sys.stderr)
result = await ws.recv()
print(f"Server received: {result}", file=sys.stderr)
await ws.send(query1_server_answer.format(query_id=1))
await ws.send(query1_server_answer.format(query_id=2))
await WebSocketServerHelper.send_complete(ws, 1)
await WebSocketServerHelper.send_complete(ws, 2)
await WebSocketServerHelper.wait_connection_terminate(ws)
await ws.wait_closed()
@pytest.mark.asyncio
@pytest.mark.websockets
@pytest.mark.parametrize("server", [server1_two_queries_in_parallel], indirect=True)
@pytest.mark.parametrize("query_str", [query1_str])
async def test_aiohttp_websocket_two_queries_in_parallel(
event_loop, aiohttp_client_and_server, query_str
):
session, server = aiohttp_client_and_server
query = gql(query_str)
result1 = None
result2 = None
async def task1_coro():
nonlocal result1
result1 = await session.execute(query)
async def task2_coro():
nonlocal result2
result2 = await session.execute(query)
task1 = asyncio.ensure_future(task1_coro())
task2 = asyncio.ensure_future(task2_coro())
await asyncio.gather(task1, task2)
print("Query1 received:", result1)
print("Query2 received:", result2)
assert result1 == result2
async def server_closing_while_we_are_doing_something_else(ws):
await WebSocketServerHelper.send_connection_ack(ws)
result = await ws.recv()
print(f"Server received: {result}", file=sys.stderr)
await ws.send(query1_server_answer.format(query_id=1))
await WebSocketServerHelper.send_complete(ws, 1)
await asyncio.sleep(1 * MS)
# Closing server after first query
await ws.close()
@pytest.mark.asyncio
@pytest.mark.websockets
@pytest.mark.parametrize(
"server", [server_closing_while_we_are_doing_something_else], indirect=True
)
@pytest.mark.parametrize("query_str", [query1_str])
async def test_aiohttp_websocket_server_closing_after_first_query(
event_loop, aiohttp_client_and_server, query_str
):
session, server = aiohttp_client_and_server
query = gql(query_str)
# First query is working
await session.execute(query)
# Then we do other things
await asyncio.sleep(1000 * MS)
# Now the server is closed but we don't know it yet, we have to send a query
# to notice it and to receive the exception
with pytest.raises(TransportClosed):
await session.execute(query)
ignore_invalid_id_answers = [
query1_server_answer,
'{"type":"complete","id": "55"}',
query1_server_answer,
]
@pytest.mark.asyncio
@pytest.mark.parametrize(
"aiohttp_ws_server", [ignore_invalid_id_answers], indirect=True
)
@pytest.mark.parametrize("query_str", [query1_str])
async def test_aiohttp_websocket_ignore_invalid_id(
event_loop, aiohttp_client_and_aiohttp_ws_server, query_str
):
session, server = aiohttp_client_and_aiohttp_ws_server
query = gql(query_str)
# First query is working
await session.execute(query)
# Second query gets no answer -> raises
with pytest.raises(TransportQueryError):
await session.execute(query)
# Third query is working
await session.execute(query)
async def assert_client_is_working(session):
query1 = gql(query1_str)
result = await session.execute(query1)
print("Client received:", result)
# Verify result
assert isinstance(result, Dict)
continents = result["continents"]
africa = continents[0]
assert africa["code"] == "AF"
@pytest.mark.asyncio
@pytest.mark.parametrize("aiohttp_ws_server", [server1_answers], indirect=True)
async def test_aiohttp_websocket_multiple_connections_in_series(
event_loop, aiohttp_ws_server
):
server = aiohttp_ws_server
from gql.transport.aiohttp_websockets import AIOHTTPWebsocketsTransport
url = f"ws://{server.hostname}:{server.port}/graphql"
print(f"url = {url}")
transport = AIOHTTPWebsocketsTransport(url=url)
async with Client(transport=transport) as session:
await assert_client_is_working(session)
# Check client is disconnect here
assert transport.websocket is None
async with Client(transport=transport) as session:
await assert_client_is_working(session)
# Check client is disconnect here
assert transport.websocket is None
@pytest.mark.asyncio
@pytest.mark.parametrize("aiohttp_ws_server", [server1_answers], indirect=True)
async def test_aiohttp_websocket_multiple_connections_in_parallel(
event_loop, aiohttp_ws_server
):
server = aiohttp_ws_server
from gql.transport.aiohttp_websockets import AIOHTTPWebsocketsTransport
url = f"ws://{server.hostname}:{server.port}/graphql"
print(f"url = {url}")
async def task_coro():
transport = AIOHTTPWebsocketsTransport(url=url)
async with Client(transport=transport) as session:
await assert_client_is_working(session)
task1 = asyncio.ensure_future(task_coro())
task2 = asyncio.ensure_future(task_coro())
await asyncio.gather(task1, task2)
@pytest.mark.asyncio
@pytest.mark.parametrize("aiohttp_ws_server", [server1_answers], indirect=True)
async def test_aiohttp_websocket_trying_to_connect_to_already_connected_transport(
event_loop, aiohttp_ws_server
):
server = aiohttp_ws_server
from gql.transport.aiohttp_websockets import AIOHTTPWebsocketsTransport
url = f"ws://{server.hostname}:{server.port}/graphql"
print(f"url = {url}")
transport = AIOHTTPWebsocketsTransport(url=url)
async with Client(transport=transport) as session:
await assert_client_is_working(session)
with pytest.raises(TransportAlreadyConnected):
async with Client(transport=transport):
pass
async def server_with_authentication_in_connection_init_payload(ws):
# Wait the connection_init message
init_message_str = await ws.recv()
init_message = json.loads(init_message_str)
payload = init_message["payload"]
if "Authorization" in payload:
if payload["Authorization"] == 12345:
await ws.send('{"type":"connection_ack"}')
result = await ws.recv()
print(f"Server received: {result}", file=sys.stderr)
await ws.send(query1_server_answer.format(query_id=1))
await WebSocketServerHelper.send_complete(ws, 1)
else:
await ws.send(
'{"type":"connection_error", "payload": "Invalid Authorization token"}'
)
else:
await ws.send(
'{"type":"connection_error", "payload": "No Authorization token"}'
)
await ws.close()
@pytest.mark.asyncio
@pytest.mark.websockets
@pytest.mark.parametrize(
"server", [server_with_authentication_in_connection_init_payload], indirect=True
)
@pytest.mark.parametrize("query_str", [query1_str])
async def test_aiohttp_websocket_connect_success_with_authentication_in_connection_init(
event_loop, server, query_str
):
from gql.transport.aiohttp_websockets import AIOHTTPWebsocketsTransport
url = f"ws://{server.hostname}:{server.port}/graphql"
print(f"url = {url}")
init_payload = {"Authorization": 12345}
transport = AIOHTTPWebsocketsTransport(url=url, init_payload=init_payload)
async with Client(transport=transport) as session:
query1 = gql(query_str)
result = await session.execute(query1)
print("Client received:", result)
# Verify result
assert isinstance(result, Dict)
continents = result["continents"]
africa = continents[0]
assert africa["code"] == "AF"
@pytest.mark.asyncio
@pytest.mark.websockets
@pytest.mark.parametrize(
"server", [server_with_authentication_in_connection_init_payload], indirect=True
)
@pytest.mark.parametrize("query_str", [query1_str])
@pytest.mark.parametrize("init_payload", [{}, {"Authorization": "invalid_code"}])
async def test_aiohttp_websocket_connect_failed_with_authentication_in_connection_init(
event_loop, server, query_str, init_payload
):
from gql.transport.aiohttp_websockets import AIOHTTPWebsocketsTransport
url = f"ws://{server.hostname}:{server.port}/graphql"
print(f"url = {url}")
transport = AIOHTTPWebsocketsTransport(url=url, init_payload=init_payload)
for _ in range(2):
with pytest.raises(TransportServerError):
async with Client(transport=transport) as session:
query1 = gql(query_str)
await session.execute(query1)
assert transport.session is None
assert transport.websocket is None
@pytest.mark.parametrize("aiohttp_ws_server", [server1_answers], indirect=True)
def test_aiohttp_websocket_execute_sync(aiohttp_ws_server):
server = aiohttp_ws_server
from gql.transport.aiohttp_websockets import AIOHTTPWebsocketsTransport
url = f"ws://{server.hostname}:{server.port}/graphql"
print(f"url = {url}")
transport = AIOHTTPWebsocketsTransport(url=url)
client = Client(transport=transport)
query1 = gql(query1_str)
result = client.execute(query1)
print("Client received:", result)
# Verify result
assert isinstance(result, Dict)
continents = result["continents"]
africa = continents[0]
assert africa["code"] == "AF"
# Execute sync a second time
result = client.execute(query1)
print("Client received:", result)
# Verify result
assert isinstance(result, Dict)
continents = result["continents"]
africa = continents[0]
assert africa["code"] == "AF"
# Check client is disconnect here
assert transport.websocket is None
@pytest.mark.asyncio
@pytest.mark.parametrize("aiohttp_ws_server", [server1_answers], indirect=True)
async def test_aiohttp_websocket_add_extra_parameters_to_connect(
event_loop, aiohttp_ws_server
):
server = aiohttp_ws_server
from gql.transport.aiohttp_websockets import AIOHTTPWebsocketsTransport
url = f"ws://{server.hostname}:{server.port}/graphql"
# Increase max payload size
transport = AIOHTTPWebsocketsTransport(
url=url,
connect_args={
"max_msg_size": 2**21,
},
)
query = gql(query1_str)
async with Client(transport=transport) as session:
await session.execute(query)
async def server_sending_keep_alive_before_connection_ack(ws):
await WebSocketServerHelper.send_keepalive(ws)
await WebSocketServerHelper.send_keepalive(ws)
await WebSocketServerHelper.send_keepalive(ws)
await WebSocketServerHelper.send_keepalive(ws)
await WebSocketServerHelper.send_connection_ack(ws)
result = await ws.recv()
print(f"Server received: {result}", file=sys.stderr)
await ws.send(query1_server_answer.format(query_id=1))
await WebSocketServerHelper.send_complete(ws, 1)
await ws.wait_closed()
@pytest.mark.asyncio
@pytest.mark.websockets
@pytest.mark.parametrize(
"server", [server_sending_keep_alive_before_connection_ack], indirect=True
)
@pytest.mark.parametrize("query_str", [query1_str])
async def test_aiohttp_websocket_non_regression_bug_108(
event_loop, aiohttp_client_and_server, query_str
):
# This test will check that we now ignore keepalive message
# arriving before the connection_ack
# See bug #108
session, server = aiohttp_client_and_server
query = gql(query_str)
result = await session.execute(query)
print("Client received:", result)
continents = result["continents"]
africa = continents[0]
assert africa["code"] == "AF"
@pytest.mark.asyncio
@pytest.mark.parametrize("aiohttp_ws_server", [server1_answers], indirect=True)
@pytest.mark.parametrize("transport_arg", [[], ["--transport=aiohttp_websockets"]])
async def test_aiohttp_websocket_using_cli(
event_loop, aiohttp_ws_server, transport_arg, monkeypatch, capsys
):
"""
Note: depending on the transport_arg parameter, if there is no transport argument,
then we will use WebsocketsTransport if the websockets dependency is installed,
or AIOHTTPWebsocketsTransport if that is not the case.
"""
server = aiohttp_ws_server
url = f"ws://{server.hostname}:{server.port}/graphql"
print(f"url = {url}")
import io
import json
from gql.cli import get_parser, main
parser = get_parser(with_examples=True)
args = parser.parse_args([url, *transport_arg])
# Monkeypatching sys.stdin to simulate getting the query
# via the standard input
monkeypatch.setattr("sys.stdin", io.StringIO(query1_str))
# Flush captured output
captured = capsys.readouterr()
exit_code = await main(args)
assert exit_code == 0
# Check that the result has been printed on stdout
captured = capsys.readouterr()
captured_out = str(captured.out).strip()
expected_answer = json.loads(query1_server_answer_data)
print(f"Captured: {captured_out}")
received_answer = json.loads(captured_out)
assert received_answer == expected_answer
query1_server_answer_with_extensions = (
'{{"type":"data","id":"{query_id}","payload":{{"data":{{"continents":['
'{{"code":"AF","name":"Africa"}},{{"code":"AN","name":"Antarctica"}},'
'{{"code":"AS","name":"Asia"}},{{"code":"EU","name":"Europe"}},'
'{{"code":"NA","name":"North America"}},{{"code":"OC","name":"Oceania"}},'
'{{"code":"SA","name":"South America"}}]}},'
'"extensions": {{"key1": "val1"}}}}}}'
)
server1_answers_with_extensions = [
query1_server_answer_with_extensions,
]
@pytest.mark.asyncio
@pytest.mark.parametrize(
"aiohttp_ws_server", [server1_answers_with_extensions], indirect=True
)
@pytest.mark.parametrize("query_str", [query1_str])
async def test_aiohttp_websocket_simple_query_with_extensions(
event_loop, aiohttp_client_and_aiohttp_ws_server, query_str
):
session, server = aiohttp_client_and_aiohttp_ws_server
query = gql(query_str)
execution_result = await session.execute(query, get_execution_result=True)
assert execution_result.extensions["key1"] == "val1"
@pytest.mark.asyncio
@pytest.mark.parametrize("aiohttp_ws_server", [server1_answers], indirect=True)
async def test_aiohttp_websocket_connector_owner_false(event_loop, aiohttp_ws_server):
server = aiohttp_ws_server
from aiohttp import TCPConnector
from gql.transport.aiohttp_websockets import AIOHTTPWebsocketsTransport
url = f"ws://{server.hostname}:{server.port}/graphql"
print(f"url = {url}")
connector = TCPConnector()
transport = AIOHTTPWebsocketsTransport(
url=url,
client_session_args={
"connector": connector,
"connector_owner": False,
},
)
for _ in range(2):
async with Client(transport=transport) as session:
query1 = gql(query1_str)
result = await session.execute(query1)
print("Client received:", result)
assert isinstance(result, Dict)
continents = result["continents"]
africa = continents[0]
assert africa["code"] == "AF"
# Check client is disconnect here
assert transport.websocket is None
await connector.close()
|