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
|
import os
from contextlib import suppress
from typing import Any
from unittest import mock
import pytest
from graphql import ExecutionResult, build_ast_schema, parse
from gql import Client, GraphQLRequest, gql
from gql.transport import Transport
from gql.transport.exceptions import TransportQueryError
with suppress(ModuleNotFoundError):
from urllib3.exceptions import NewConnectionError
@pytest.fixture
def http_transport_query():
return gql(
"""
query getContinents {
continents {
code
name
}
}
"""
)
def test_request_transport_not_implemented(http_transport_query):
class RandomTransport(Transport):
pass
with pytest.raises(TypeError) as exc_info:
RandomTransport() # type: ignore
assert "Can't instantiate abstract class RandomTransport" in str(exc_info.value)
class RandomTransport2(Transport):
def execute(
self,
request: GraphQLRequest,
*args: Any,
**kwargs: Any,
) -> ExecutionResult:
return ExecutionResult()
with pytest.raises(NotImplementedError) as exc_info2:
RandomTransport2().execute_batch([])
assert "This Transport has not implemented the execute_batch method" == str(
exc_info2.value
)
@pytest.mark.requests
@mock.patch("urllib3.connection.HTTPConnection._new_conn")
def test_retries_on_transport(execute_mock):
"""Testing retries on the transport level
This forces us to override low-level APIs because the retry mechanism on the urllib3
(which uses requests) is pretty low-level itself.
"""
from gql.transport.requests import RequestsHTTPTransport
expected_retries = 3
execute_mock.side_effect = NewConnectionError(
"Should be HTTPConnection", "Fake connection error" # type: ignore
)
transport = RequestsHTTPTransport(
url="http://127.0.0.1:8000/graphql",
retries=expected_retries,
)
client = Client(transport=transport)
query = gql(
"""
{
myFavoriteFilm: film(id:"RmlsbToz") {
id
title
episodeId
}
}
"""
)
with client as session: # We're using the client as context manager
with pytest.raises(Exception):
session.execute(query)
# This might look strange compared to the previous test, but making 3 retries
# means you're actually doing 4 calls.
assert execute_mock.call_count == expected_retries + 1
execute_mock.reset_mock()
queries = [query, query, query]
with client as session: # We're using the client as context manager
with pytest.raises(Exception):
session.execute_batch(queries)
# This might look strange compared to the previous test, but making 3 retries
# means you're actually doing 4 calls.
assert execute_mock.call_count == expected_retries + 1
def test_no_schema_no_transport_exception():
with pytest.raises(AssertionError) as exc_info:
Client()
assert "You need to provide either a transport or a schema to the Client." in str(
exc_info.value
)
@pytest.mark.online
@pytest.mark.requests
def test_execute_result_error():
from gql.transport.requests import RequestsHTTPTransport
client = Client(
transport=RequestsHTTPTransport(url="https://countries.trevorblades.com/"),
)
failing_query = gql(
"""
query getContinents {
continents {
code
name
id
}
}
"""
)
with pytest.raises(TransportQueryError) as exc_info:
client.execute(failing_query)
assert 'Cannot query field "id" on type "Continent".' in str(exc_info.value)
"""
Batching is not supported anymore on countries backend
with pytest.raises(TransportQueryError) as exc_info:
client.execute_batch([GraphQLRequest(failing_query)])
assert 'Cannot query field "id" on type "Continent".' in str(exc_info.value)
"""
@pytest.mark.online
@pytest.mark.requests
def test_http_transport_verify_error(http_transport_query):
from gql.transport.requests import RequestsHTTPTransport
with Client(
transport=RequestsHTTPTransport(
url="https://countries.trevorblades.com/",
verify=False,
)
) as client:
with pytest.warns(Warning) as record:
client.execute(http_transport_query)
assert len(record) == 1
assert "Unverified HTTPS request is being made to host" in str(
record[0].message
)
"""
Batching is not supported anymore on countries backend
with pytest.warns(Warning) as record:
client.execute_batch([GraphQLRequest(http_transport_query)])
assert len(record) == 1
assert "Unverified HTTPS request is being made to host" in str(
record[0].message
)
"""
@pytest.mark.online
@pytest.mark.requests
def test_http_transport_specify_method_valid(http_transport_query):
from gql.transport.requests import RequestsHTTPTransport
with Client(
transport=RequestsHTTPTransport(
url="https://countries.trevorblades.com/",
method="POST",
)
) as client:
result = client.execute(http_transport_query)
assert result is not None
"""
Batching is not supported anymore on countries backend
result = client.execute_batch([GraphQLRequest(http_transport_query)])
assert result is not None
"""
def test_gql():
sample_path = os.path.join(
os.path.dirname(os.path.abspath(__file__)),
"fixtures",
"graphql",
"sample.graphql",
)
with open(sample_path) as source:
document = parse(source.read())
schema = build_ast_schema(document)
query = gql(
"""
query getUser {
user(id: "1000") {
id
username
}
}
"""
)
client = Client(schema=schema)
result = client.execute(query)
assert result["user"] is None
@pytest.mark.requests
def test_sync_transport_close_on_schema_retrieval_failure():
"""
Ensure that the transport session is closed if an error occurs when
entering the context manager (e.g., because schema retrieval fails)
"""
from gql.transport.requests import RequestsHTTPTransport
transport = RequestsHTTPTransport(url="http://localhost/")
client = Client(transport=transport, fetch_schema_from_transport=True)
try:
with client:
pass
except Exception:
# we don't care what exception is thrown, we just want to check if the
# transport is closed afterwards
pass
assert isinstance(client.transport, RequestsHTTPTransport)
assert client.transport.session is None
@pytest.mark.aiohttp
@pytest.mark.asyncio
async def test_async_transport_close_on_schema_retrieval_failure():
"""
Ensure that the transport session is closed if an error occurs when
entering the context manager (e.g., because schema retrieval fails)
"""
from gql.transport.aiohttp import AIOHTTPTransport
transport = AIOHTTPTransport(url="http://localhost/")
client = Client(transport=transport, fetch_schema_from_transport=True)
try:
async with client:
pass
except Exception:
# we don't care what exception is thrown, we just want to check if the
# transport is closed afterwards
pass
assert isinstance(client.transport, AIOHTTPTransport)
assert client.transport.session is None
import asyncio
await asyncio.sleep(1)
|