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
|
import re
from typing import Any, Awaitable, cast
from pytest import mark
from graphql.execution import execute, execute_sync, ExecutionResult
from graphql.language import parse
from graphql.pyutils import AwaitableOrValue
from graphql.type import (
GraphQLArgument,
GraphQLField,
GraphQLNonNull,
GraphQLObjectType,
GraphQLSchema,
GraphQLString,
)
from graphql.utilities import build_schema
sync_error = RuntimeError("sync")
sync_non_null_error = RuntimeError("syncNonNull")
promise_error = RuntimeError("promise")
promise_non_null_error = RuntimeError("promiseNonNull")
# noinspection PyPep8Naming,PyMethodMayBeStatic
class ThrowingData:
def sync(self, _info):
raise sync_error
def syncNonNull(self, _info):
raise sync_non_null_error
async def promise(self, _info):
raise promise_error
async def promiseNonNull(self, _info):
raise promise_non_null_error
def syncNest(self, _info):
return ThrowingData()
def syncNonNullNest(self, _info):
return ThrowingData()
async def promiseNest(self, _info):
return ThrowingData()
async def promiseNonNullNest(self, _info):
return ThrowingData()
# noinspection PyPep8Naming,PyMethodMayBeStatic
class NullingData:
def sync(self, _info):
return None
def syncNonNull(self, _info):
return None
async def promise(self, _info):
return None
async def promiseNonNull(self, _info):
return None
def syncNest(self, _info):
return NullingData()
def syncNonNullNest(self, _info):
return NullingData()
async def promiseNest(self, _info):
return NullingData()
async def promiseNonNullNest(self, _info):
return NullingData()
schema = build_schema(
"""
type DataType {
sync: String
syncNonNull: String!
promise: String
promiseNonNull: String!
syncNest: DataType
syncNonNullNest: DataType!
promiseNest: DataType
promiseNonNullNest: DataType!
}
schema {
query: DataType
}
"""
)
def execute_query(query: str, root_value: Any) -> AwaitableOrValue[ExecutionResult]:
return execute(schema=schema, document=parse(query), root_value=root_value)
# avoids also doing any nests
def patch(data: str) -> str:
return re.sub(
r"\bsyncNonNull\b", "promiseNonNull", re.sub(r"\bsync\b", "promise", data)
)
async def execute_sync_and_async(query: str, root_value: Any) -> ExecutionResult:
sync_result = execute_sync(schema, parse(query), root_value)
async_result = await cast(
Awaitable[ExecutionResult], execute(schema, parse(patch(query)), root_value)
)
assert repr(async_result) == patch(repr(sync_result))
return sync_result
def describe_execute_handles_non_nullable_types():
def describe_nulls_a_nullable_field():
query = """
{
sync
}
"""
@mark.asyncio
async def returns_null():
result = await execute_sync_and_async(query, NullingData())
assert result == ({"sync": None}, None)
@mark.asyncio
async def throws():
result = await execute_sync_and_async(query, ThrowingData())
assert result == (
{"sync": None},
[
{
"message": str(sync_error),
"path": ["sync"],
"locations": [(3, 15)],
}
],
)
def describe_nulls_a_returned_object_that_contains_a_non_null_field():
query = """
{
syncNest {
syncNonNull,
}
}
"""
@mark.asyncio
async def that_returns_null():
result = await execute_sync_and_async(query, NullingData())
assert result == (
{"syncNest": None},
[
{
"message": "Cannot return null for non-nullable field"
" DataType.syncNonNull.",
"path": ["syncNest", "syncNonNull"],
"locations": [(4, 17)],
}
],
)
@mark.asyncio
async def that_throws():
result = await execute_sync_and_async(query, ThrowingData())
assert result == (
{"syncNest": None},
[
{
"message": str(sync_non_null_error),
"path": ["syncNest", "syncNonNull"],
"locations": [(4, 17)],
}
],
)
def describe_nulls_a_complex_tree_of_nullable_fields_each():
query = """
{
syncNest {
sync
promise
syncNest { sync promise }
promiseNest { sync promise }
}
promiseNest {
sync
promise
syncNest { sync promise }
promiseNest { sync promise }
}
}
"""
data = {
"syncNest": {
"sync": None,
"promise": None,
"syncNest": {"sync": None, "promise": None},
"promiseNest": {"sync": None, "promise": None},
},
"promiseNest": {
"sync": None,
"promise": None,
"syncNest": {"sync": None, "promise": None},
"promiseNest": {"sync": None, "promise": None},
},
}
@mark.asyncio
async def returns_null():
result = await cast(
Awaitable[ExecutionResult], execute_query(query, NullingData())
)
assert result == (data, None)
@mark.asyncio
async def throws():
result = await cast(
Awaitable[ExecutionResult], execute_query(query, ThrowingData())
)
assert result == (
data,
[
{
"message": str(sync_error),
"path": ["syncNest", "sync"],
"locations": [(4, 17)],
},
{
"message": str(promise_error),
"path": ["syncNest", "promise"],
"locations": [(5, 17)],
},
{
"message": str(sync_error),
"path": ["syncNest", "syncNest", "sync"],
"locations": [(6, 28)],
},
{
"message": str(promise_error),
"path": ["syncNest", "syncNest", "promise"],
"locations": [(6, 33)],
},
{
"message": str(sync_error),
"path": ["syncNest", "promiseNest", "sync"],
"locations": [(7, 31)],
},
{
"message": str(promise_error),
"path": ["syncNest", "promiseNest", "promise"],
"locations": [(7, 36)],
},
{
"message": str(sync_error),
"path": ["promiseNest", "sync"],
"locations": [(10, 17)],
},
{
"message": str(promise_error),
"path": ["promiseNest", "promise"],
"locations": [(11, 17)],
},
{
"message": str(sync_error),
"path": ["promiseNest", "syncNest", "sync"],
"locations": [(12, 28)],
},
{
"message": str(promise_error),
"path": ["promiseNest", "syncNest", "promise"],
"locations": [(12, 33)],
},
{
"message": str(sync_error),
"path": ["promiseNest", "promiseNest", "sync"],
"locations": [(13, 31)],
},
{
"message": str(promise_error),
"path": ["promiseNest", "promiseNest", "promise"],
"locations": [(13, 36)],
},
],
)
def describe_nulls_first_nullable_after_long_chain_of_non_null_fields():
query = """
{
syncNest {
syncNonNullNest {
promiseNonNullNest {
syncNonNullNest {
promiseNonNullNest {
syncNonNull
}
}
}
}
}
promiseNest {
syncNonNullNest {
promiseNonNullNest {
syncNonNullNest {
promiseNonNullNest {
syncNonNull
}
}
}
}
}
anotherNest: syncNest {
syncNonNullNest {
promiseNonNullNest {
syncNonNullNest {
promiseNonNullNest {
promiseNonNull
}
}
}
}
}
anotherPromiseNest: promiseNest {
syncNonNullNest {
promiseNonNullNest {
syncNonNullNest {
promiseNonNullNest {
promiseNonNull
}
}
}
}
}
}
"""
data = {
"syncNest": None,
"promiseNest": None,
"anotherNest": None,
"anotherPromiseNest": None,
}
@mark.asyncio
async def returns_null():
result = await cast(
Awaitable[ExecutionResult], execute_query(query, NullingData())
)
assert result == (
data,
[
{
"message": "Cannot return null for non-nullable field"
" DataType.syncNonNull.",
"path": [
"syncNest",
"syncNonNullNest",
"promiseNonNullNest",
"syncNonNullNest",
"promiseNonNullNest",
"syncNonNull",
],
"locations": [(8, 25)],
},
{
"message": "Cannot return null for non-nullable field"
" DataType.syncNonNull.",
"path": [
"promiseNest",
"syncNonNullNest",
"promiseNonNullNest",
"syncNonNullNest",
"promiseNonNullNest",
"syncNonNull",
],
"locations": [(19, 25)],
},
{
"message": "Cannot return null for non-nullable field"
" DataType.promiseNonNull.",
"path": [
"anotherNest",
"syncNonNullNest",
"promiseNonNullNest",
"syncNonNullNest",
"promiseNonNullNest",
"promiseNonNull",
],
"locations": [(30, 25)],
},
{
"message": "Cannot return null for non-nullable field"
" DataType.promiseNonNull.",
"path": [
"anotherPromiseNest",
"syncNonNullNest",
"promiseNonNullNest",
"syncNonNullNest",
"promiseNonNullNest",
"promiseNonNull",
],
"locations": [(41, 25)],
},
],
)
@mark.asyncio
async def throws():
result = await cast(
Awaitable[ExecutionResult], execute_query(query, ThrowingData())
)
assert result == (
data,
[
{
"message": str(sync_non_null_error),
"path": [
"syncNest",
"syncNonNullNest",
"promiseNonNullNest",
"syncNonNullNest",
"promiseNonNullNest",
"syncNonNull",
],
"locations": [(8, 25)],
},
{
"message": str(sync_non_null_error),
"path": [
"promiseNest",
"syncNonNullNest",
"promiseNonNullNest",
"syncNonNullNest",
"promiseNonNullNest",
"syncNonNull",
],
"locations": [(19, 25)],
},
{
"message": str(promise_non_null_error),
"path": [
"anotherNest",
"syncNonNullNest",
"promiseNonNullNest",
"syncNonNullNest",
"promiseNonNullNest",
"promiseNonNull",
],
"locations": [(30, 25)],
},
{
"message": str(promise_non_null_error),
"path": [
"anotherPromiseNest",
"syncNonNullNest",
"promiseNonNullNest",
"syncNonNullNest",
"promiseNonNullNest",
"promiseNonNull",
],
"locations": [(41, 25)],
},
],
)
def describe_nulls_the_top_level_if_non_nullable_field():
query = """
{
syncNonNull
}
"""
@mark.asyncio
async def returns_null():
result = await execute_sync_and_async(query, NullingData())
assert result == (
None,
[
{
"message": "Cannot return null for non-nullable field"
" DataType.syncNonNull.",
"path": ["syncNonNull"],
"locations": [(3, 17)],
}
],
)
@mark.asyncio
async def throws():
result = await execute_sync_and_async(query, ThrowingData())
assert result == (
None,
[
{
"message": str(sync_non_null_error),
"path": ["syncNonNull"],
"locations": [(3, 17)],
}
],
)
def describe_handles_non_null_argument():
# noinspection PyPep8Naming
schema_with_non_null_arg = GraphQLSchema(
GraphQLObjectType(
"Query",
{
"withNonNullArg": GraphQLField(
GraphQLString,
args={
"cannotBeNull": GraphQLArgument(
GraphQLNonNull(GraphQLString)
)
},
resolve=lambda _obj, _info, cannotBeNull: "Passed: "
+ str(cannotBeNull),
)
},
)
)
def succeeds_when_passed_non_null_literal_value():
result = execute_sync(
schema_with_non_null_arg,
parse(
"""
query {
withNonNullArg (cannotBeNull: "literal value")
}
"""
),
)
assert result == ({"withNonNullArg": "Passed: literal value"}, None)
def succeeds_when_passed_non_null_variable_value():
result = execute_sync(
schema_with_non_null_arg,
parse(
"""
query ($testVar: String!) {
withNonNullArg (cannotBeNull: $testVar)
}
"""
),
variable_values={
"testVar": "variable value",
},
)
assert result == ({"withNonNullArg": "Passed: variable value"}, None)
def succeeds_when_missing_variable_has_default_value():
result = execute_sync(
schema_with_non_null_arg,
parse(
"""
query ($testVar: String = "default value") {
withNonNullArg (cannotBeNull: $testVar)
}
"""
),
variable_values={}, # intentionally missing variable
)
assert result == ({"withNonNullArg": "Passed: default value"}, None)
def field_error_when_missing_non_null_arg():
# Note: validation should identify this issue first
# (missing args rule) however execution should still
# protect against this.
result = execute_sync(
schema_with_non_null_arg,
parse(
"""
query {
withNonNullArg
}
"""
),
)
assert result == (
{"withNonNullArg": None},
[
{
"message": "Argument 'cannotBeNull' of required type"
" 'String!' was not provided.",
"locations": [(3, 23)],
"path": ["withNonNullArg"],
}
],
)
def field_error_when_non_null_arg_provided_null():
# Note: validation should identify this issue first
# (values of correct type rule) however execution
# should still protect against this.
result = execute_sync(
schema_with_non_null_arg,
parse(
"""
query {
withNonNullArg(cannotBeNull: null)
}
"""
),
)
assert result == (
{"withNonNullArg": None},
[
{
"message": "Argument 'cannotBeNull' of non-null type"
" 'String!' must not be null.",
"locations": [(3, 52)],
"path": ["withNonNullArg"],
}
],
)
def field_error_when_non_null_arg_not_provided_variable_value():
# Note: validation should identify this issue first
# (variables in allowed position rule) however execution
# should still protect against this.
result = execute_sync(
schema_with_non_null_arg,
parse(
"""
query ($testVar: String) {
withNonNullArg(cannotBeNull: $testVar)
}
"""
),
variable_values={},
) # intentionally missing variable
assert result == (
{"withNonNullArg": None},
[
{
"message": "Argument 'cannotBeNull' of required type"
" 'String!' was provided the variable"
" '$testVar' which was not provided"
" a runtime value.",
"locations": [(3, 52)],
"path": ["withNonNullArg"],
}
],
)
def field_error_when_non_null_arg_provided_explicit_null_variable():
result = execute_sync(
schema_with_non_null_arg,
parse(
"""
query ($testVar: String = "default value") {
withNonNullArg (cannotBeNull: $testVar)
}
"""
),
variable_values={"testVar": None},
)
assert result == (
{"withNonNullArg": None},
[
{
"message": "Argument 'cannotBeNull' of non-null type"
" 'String!' must not be null.",
"locations": [(3, 53)],
"path": ["withNonNullArg"],
}
],
)
|