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 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213
|
from collections import namedtuple
from typing import Union
from pytest import mark, raises
from graphql import graphql_sync
from graphql.language import DocumentNode, InterfaceTypeDefinitionNode, parse, print_ast
from graphql.type import (
GraphQLArgument,
GraphQLBoolean,
GraphQLDeprecatedDirective,
GraphQLEnumType,
GraphQLEnumValue,
GraphQLField,
GraphQLFloat,
GraphQLID,
GraphQLIncludeDirective,
GraphQLInputField,
GraphQLInt,
GraphQLNamedType,
GraphQLSchema,
GraphQLSkipDirective,
GraphQLSpecifiedByDirective,
GraphQLString,
assert_directive,
assert_enum_type,
assert_input_object_type,
assert_interface_type,
assert_object_type,
assert_scalar_type,
assert_union_type,
introspection_types,
validate_schema,
)
from graphql.utilities import build_ast_schema, build_schema, print_schema, print_type
from ..fixtures import big_schema_sdl # noqa: F401
from ..utils import dedent
def cycle_sdl(sdl: str) -> str:
"""Full cycle test.
This function does a full cycle of going from a string with the contents of the SDL,
parsed in a schema AST, materializing that schema AST into an in-memory
GraphQLSchema, and then finally printing that GraphQL into the SDL.
"""
ast = parse(sdl)
schema = build_ast_schema(ast)
return print_schema(schema)
TypeWithAstNode = Union[
GraphQLArgument, GraphQLEnumValue, GraphQLField, GraphQLInputField, GraphQLNamedType
]
TypeWithExtensionAstNodes = GraphQLNamedType
def expect_ast_node(obj: TypeWithAstNode, expected: str) -> None:
assert obj is not None and obj.ast_node is not None
assert print_ast(obj.ast_node) == expected
def expect_extension_ast_nodes(obj: TypeWithExtensionAstNodes, expected: str) -> None:
assert obj is not None and obj.extension_ast_nodes is not None
assert "\n\n".join(print_ast(node) for node in obj.extension_ast_nodes) == expected
def describe_schema_builder():
def can_use_built_schema_for_limited_execution():
schema = build_ast_schema(
parse(
"""
type Query {
str: String
}
"""
)
)
root_value = namedtuple("Data", "str")(123) # type: ignore
result = graphql_sync(schema=schema, source="{ str }", root_value=root_value)
assert result == ({"str": "123"}, None)
def can_build_a_schema_directly_from_the_source():
schema = build_schema(
"""
type Query {
add(x: Int, y: Int): Int
}
"""
)
source = "{ add(x: 34, y: 55) }"
# noinspection PyMethodMayBeStatic
class RootValue:
def add(self, _info, x, y):
return x + y
assert graphql_sync(schema=schema, source=source, root_value=RootValue()) == (
{"add": 89},
None,
)
def ignores_non_type_system_definitions():
sdl = """
type Query {
str: String
}
fragment SomeFragment on Query {
str
}
"""
build_schema(sdl)
def match_order_of_default_types_and_directives():
schema = GraphQLSchema()
sdl_schema = build_ast_schema(DocumentNode(definitions=[]))
assert sdl_schema.directives == schema.directives
assert sdl_schema.type_map == schema.type_map
def empty_type():
sdl = dedent(
"""
type EmptyType
"""
)
assert cycle_sdl(sdl) == sdl
def simple_type():
sdl = dedent(
"""
type Query {
str: String
int: Int
float: Float
id: ID
bool: Boolean
}
"""
)
assert cycle_sdl(sdl) == sdl
schema = build_schema(sdl)
# Built-ins are used
assert schema.get_type("Int") is GraphQLInt
assert schema.get_type("Float") is GraphQLFloat
assert schema.get_type("String") is GraphQLString
assert schema.get_type("Boolean") is GraphQLBoolean
assert schema.get_type("ID") is GraphQLID
def include_standard_type_only_if_it_is_used():
schema = build_schema("type Query")
# Only String and Boolean are used by introspection types
assert schema.get_type("Int") is None
assert schema.get_type("Float") is None
assert schema.get_type("String") is GraphQLString
assert schema.get_type("Boolean") is GraphQLBoolean
assert schema.get_type("ID") is None
def with_directives():
sdl = dedent(
"""
directive @foo(arg: Int) on FIELD
directive @repeatableFoo(arg: Int) repeatable on FIELD
"""
)
assert cycle_sdl(sdl) == sdl
def supports_descriptions():
sdl = dedent(
'''
"""Do you agree that this is the most creative schema ever?"""
schema {
query: Query
}
"""This is a directive"""
directive @foo(
"""It has an argument"""
arg: Int
) on FIELD
"""Who knows what's inside this scalar?"""
scalar MysteryScalar
"""This is an input object type"""
input FooInput {
"""It has a field"""
field: Int
}
"""This is an interface type"""
interface Energy {
"""It also has a field"""
str: String
}
"""There is nothing inside!"""
union BlackHole
"""With an enum"""
enum Color {
RED
"""Not a creative color"""
GREEN
BLUE
}
"""What a great type"""
type Query {
"""And a field to boot"""
str: String
}
'''
)
assert cycle_sdl(sdl) == sdl
def maintains_include_skip_and_specified_by_url_directives():
schema = build_schema("type Query")
assert len(schema.directives) == 4
assert schema.get_directive("skip") is GraphQLSkipDirective
assert schema.get_directive("include") is GraphQLIncludeDirective
assert schema.get_directive("deprecated") is GraphQLDeprecatedDirective
assert schema.get_directive("specifiedBy") is GraphQLSpecifiedByDirective
def overriding_directives_excludes_specified():
schema = build_schema(
"""
directive @skip on FIELD
directive @include on FIELD
directive @deprecated on FIELD_DEFINITION
directive @specifiedBy on FIELD_DEFINITION
"""
)
assert len(schema.directives) == 4
get_directive = schema.get_directive
assert get_directive("skip") is not GraphQLSkipDirective
assert get_directive("skip") is not None
assert get_directive("include") is not GraphQLIncludeDirective
assert get_directive("include") is not None
assert get_directive("deprecated") is not GraphQLDeprecatedDirective
assert get_directive("deprecated") is not None
assert get_directive("specifiedBy") is not GraphQLSpecifiedByDirective
assert get_directive("specifiedBy") is not None
def adding_directives_maintains_include_skip_and_specified_by_directives():
schema = build_schema(
"""
directive @foo(arg: Int) on FIELD
"""
)
assert len(schema.directives) == 5
assert schema.get_directive("skip") is GraphQLSkipDirective
assert schema.get_directive("include") is GraphQLIncludeDirective
assert schema.get_directive("deprecated") is GraphQLDeprecatedDirective
assert schema.get_directive("specifiedBy") is GraphQLSpecifiedByDirective
assert schema.get_directive("foo") is not None
def type_modifiers():
sdl = dedent(
"""
type Query {
nonNullStr: String!
listOfStrings: [String]
listOfNonNullStrings: [String!]
nonNullListOfStrings: [String]!
nonNullListOfNonNullStrings: [String!]!
}
"""
)
assert cycle_sdl(sdl) == sdl
def recursive_type():
sdl = dedent(
"""
type Query {
str: String
recurse: Query
}
"""
)
assert cycle_sdl(sdl) == sdl
def two_types_circular():
sdl = dedent(
"""
type TypeOne {
str: String
typeTwo: TypeTwo
}
type TypeTwo {
str: String
typeOne: TypeOne
}
"""
)
assert cycle_sdl(sdl) == sdl
def single_argument_field():
sdl = dedent(
"""
type Query {
str(int: Int): String
floatToStr(float: Float): String
idToStr(id: ID): String
booleanToStr(bool: Boolean): String
strToStr(bool: String): String
}
"""
)
assert cycle_sdl(sdl) == sdl
def simple_type_with_multiple_arguments():
sdl = dedent(
"""
type Query {
str(int: Int, bool: Boolean): String
}
"""
)
assert cycle_sdl(sdl) == sdl
def empty_interface():
sdl = dedent(
"""
interface EmptyInterface
"""
)
definition = parse(sdl).definitions[0]
assert isinstance(definition, InterfaceTypeDefinitionNode)
assert definition.interfaces == ()
assert cycle_sdl(sdl) == sdl
def simple_type_with_interface():
sdl = dedent(
"""
type Query implements WorldInterface {
str: String
}
interface WorldInterface {
str: String
}
"""
)
assert cycle_sdl(sdl) == sdl
def simple_interface_hierarchy():
sdl = dedent(
"""
schema {
query: Child
}
interface Child implements Parent {
str: String
}
type Hello implements Parent & Child {
str: String
}
interface Parent {
str: String
}
"""
)
assert cycle_sdl(sdl) == sdl
def empty_enum():
sdl = dedent(
"""
enum EmptyEnum
"""
)
assert cycle_sdl(sdl) == sdl
def simple_output_enum():
sdl = dedent(
"""
enum Hello {
WORLD
}
type Query {
hello: Hello
}
"""
)
assert cycle_sdl(sdl) == sdl
def simple_input_enum():
sdl = dedent(
"""
enum Hello {
WORLD
}
type Query {
str(hello: Hello): String
}
"""
)
assert cycle_sdl(sdl) == sdl
def multiple_value_enum():
sdl = dedent(
"""
enum Hello {
WO
RLD
}
type Query {
hello: Hello
}
"""
)
assert cycle_sdl(sdl) == sdl
# check that the internal values are the same as the names
schema = build_schema(sdl)
enum_type = schema.get_type("Hello")
assert isinstance(enum_type, GraphQLEnumType)
assert [value.value for value in enum_type.values.values()] == ["WO", "RLD"]
def empty_union():
sdl = dedent(
"""
union EmptyUnion
"""
)
assert cycle_sdl(sdl) == sdl
def simple_union():
sdl = dedent(
"""
union Hello = World
type Query {
hello: Hello
}
type World {
str: String
}
"""
)
assert cycle_sdl(sdl) == sdl
def multiple_union():
sdl = dedent(
"""
union Hello = WorldOne | WorldTwo
type Query {
hello: Hello
}
type WorldOne {
str: String
}
type WorldTwo {
str: String
}
"""
)
assert cycle_sdl(sdl) == sdl
def can_build_recursive_union():
# invalid schema cannot be built with Python
with raises(TypeError) as exc_info:
build_schema(
"""
union Hello = Hello
type Query {
hello: Hello
}
"""
)
assert (
str(exc_info.value) == "Hello types must be specified"
" as a collection of GraphQLObjectType instances."
)
def custom_scalar():
sdl = dedent(
"""
scalar CustomScalar
type Query {
customScalar: CustomScalar
}
"""
)
assert cycle_sdl(sdl) == sdl
def empty_input_object():
sdl = dedent(
"""
input EmptyInputObject
"""
)
assert cycle_sdl(sdl) == sdl
def simple_input_object():
sdl = dedent(
"""
input Input {
int: Int
}
type Query {
field(in: Input): String
}
"""
)
assert cycle_sdl(sdl) == sdl
def simple_argument_field_with_default():
sdl = dedent(
"""
type Query {
str(int: Int = 2): String
}
"""
)
assert cycle_sdl(sdl) == sdl
def custom_scalar_argument_field_with_default():
sdl = dedent(
"""
scalar CustomScalar
type Query {
str(int: CustomScalar = 2): String
}
"""
)
assert cycle_sdl(sdl) == sdl
def simple_type_with_mutation():
sdl = dedent(
"""
schema {
query: HelloScalars
mutation: Mutation
}
type HelloScalars {
str: String
int: Int
bool: Boolean
}
type Mutation {
addHelloScalars(str: String, int: Int, bool: Boolean): HelloScalars
}
"""
)
assert cycle_sdl(sdl) == sdl
def simple_type_with_subscription():
sdl = dedent(
"""
schema {
query: HelloScalars
subscription: Subscription
}
type HelloScalars {
str: String
int: Int
bool: Boolean
}
type Subscription {
subscribeHelloScalars(str: String, int: Int, bool: Boolean): HelloScalars
}
"""
)
assert cycle_sdl(sdl) == sdl
def unreferenced_type_implementing_referenced_interface():
sdl = dedent(
"""
type Concrete implements Interface {
key: String
}
interface Interface {
key: String
}
type Query {
interface: Interface
}
"""
)
assert cycle_sdl(sdl) == sdl
def unreferenced_interface_implementing_referenced_interface():
sdl = dedent(
"""
interface Child implements Parent {
key: String
}
interface Parent {
key: String
}
type Query {
interfaceField: Parent
}
"""
)
assert cycle_sdl(sdl) == sdl
def unreferenced_type_implementing_referenced_union():
sdl = dedent(
"""
type Concrete {
key: String
}
type Query {
union: Union
}
union Union = Concrete
"""
)
assert cycle_sdl(sdl) == sdl
def supports_deprecated_directive():
sdl = dedent(
"""
enum MyEnum {
VALUE
OLD_VALUE @deprecated
OTHER_VALUE @deprecated(reason: "Terrible reasons")
}
input MyInput {
oldInput: String @deprecated
otherInput: String @deprecated(reason: "Use newInput")
newInput: String
}
type Query {
field1: String @deprecated
field2: Int @deprecated(reason: "Because I said so")
enum: MyEnum
field3(oldArg: String @deprecated, arg: String): String
field4(oldArg: String @deprecated(reason: "Why not?"), arg: String): String
field5(arg: MyInput): String
}
""" # noqa: E501
)
assert cycle_sdl(sdl) == sdl
schema = build_schema(sdl)
my_enum = assert_enum_type(schema.get_type("MyEnum"))
value = my_enum.values["VALUE"]
assert value.deprecation_reason is None
old_value = my_enum.values["OLD_VALUE"]
assert old_value.deprecation_reason == "No longer supported"
other_value = my_enum.values["OTHER_VALUE"]
assert other_value.deprecation_reason == "Terrible reasons"
root_fields = assert_object_type(schema.get_type("Query")).fields
field1 = root_fields["field1"]
assert field1.deprecation_reason == "No longer supported"
field2 = root_fields["field2"]
assert field2.deprecation_reason == "Because I said so"
input_fields = assert_input_object_type(schema.get_type("MyInput")).fields
new_input = input_fields["newInput"]
assert new_input.deprecation_reason is None
old_input = input_fields["oldInput"]
assert old_input.deprecation_reason == "No longer supported"
other_input = input_fields["otherInput"]
assert other_input.deprecation_reason == "Use newInput"
field3_old_arg = root_fields["field3"].args["oldArg"]
assert field3_old_arg.deprecation_reason == "No longer supported"
field4_old_arg = root_fields["field4"].args["oldArg"]
assert field4_old_arg.deprecation_reason == "Why not?"
def supports_specified_by_directives():
sdl = dedent(
"""
scalar Foo @specifiedBy(url: "https://example.com/foo_spec")
type Query {
foo: Foo @deprecated
}
"""
)
assert cycle_sdl(sdl) == sdl
schema = build_schema(sdl)
foo_scalar = assert_scalar_type(schema.get_type("Foo"))
assert foo_scalar.specified_by_url == "https://example.com/foo_spec"
def correctly_extend_scalar_type():
schema = build_schema(
"""
scalar SomeScalar
extend scalar SomeScalar @foo
extend scalar SomeScalar @bar
directive @foo on SCALAR
directive @bar on SCALAR
"""
)
some_scalar = assert_scalar_type(schema.get_type("SomeScalar"))
assert print_type(some_scalar) == dedent(
"""
scalar SomeScalar
"""
)
expect_ast_node(some_scalar, "scalar SomeScalar")
expect_extension_ast_nodes(
some_scalar,
dedent(
"""
extend scalar SomeScalar @foo
extend scalar SomeScalar @bar
"""
),
)
def correctly_extend_object_type():
schema = build_schema(
"""
type SomeObject implements Foo {
first: String
}
extend type SomeObject implements Bar {
second: Int
}
extend type SomeObject implements Baz {
third: Float
}
interface Foo
interface Bar
interface Baz
"""
)
some_object = assert_object_type(schema.get_type("SomeObject"))
assert print_type(some_object) == dedent(
"""
type SomeObject implements Foo & Bar & Baz {
first: String
second: Int
third: Float
}
"""
)
expect_ast_node(
some_object,
dedent(
"""
type SomeObject implements Foo {
first: String
}
"""
),
)
expect_extension_ast_nodes(
some_object,
dedent(
"""
extend type SomeObject implements Bar {
second: Int
}
extend type SomeObject implements Baz {
third: Float
}
"""
),
)
def correctly_extend_interface_type():
schema = build_schema(
"""
interface SomeInterface {
first: String
}
extend interface SomeInterface {
second: Int
}
extend interface SomeInterface {
third: Float
}
"""
)
some_interface = assert_interface_type(schema.get_type("SomeInterface"))
assert print_type(some_interface) == dedent(
"""
interface SomeInterface {
first: String
second: Int
third: Float
}
"""
)
expect_ast_node(
some_interface,
dedent(
"""
interface SomeInterface {
first: String
}
"""
),
)
expect_extension_ast_nodes(
some_interface,
dedent(
"""
extend interface SomeInterface {
second: Int
}
extend interface SomeInterface {
third: Float
}
"""
),
)
def correctly_extend_union_type():
schema = build_schema(
"""
union SomeUnion = FirstType
extend union SomeUnion = SecondType
extend union SomeUnion = ThirdType
type FirstType
type SecondType
type ThirdType
"""
)
some_union = assert_union_type(schema.get_type("SomeUnion"))
assert print_type(some_union) == dedent(
"""
union SomeUnion = FirstType | SecondType | ThirdType
"""
)
expect_ast_node(some_union, "union SomeUnion = FirstType")
expect_extension_ast_nodes(
some_union,
dedent(
"""
extend union SomeUnion = SecondType
extend union SomeUnion = ThirdType
"""
),
)
def correctly_extend_enum_type():
schema = build_schema(
"""
enum SomeEnum {
FIRST
}
extend enum SomeEnum {
SECOND
}
extend enum SomeEnum {
THIRD
}
"""
)
some_enum = assert_enum_type(schema.get_type("SomeEnum"))
assert print_type(some_enum) == dedent(
"""
enum SomeEnum {
FIRST
SECOND
THIRD
}
"""
)
expect_ast_node(
some_enum,
dedent(
"""
enum SomeEnum {
FIRST
}
"""
),
)
expect_extension_ast_nodes(
some_enum,
dedent(
"""
extend enum SomeEnum {
SECOND
}
extend enum SomeEnum {
THIRD
}
"""
),
)
def correctly_extend_input_object_type():
schema = build_schema(
"""
input SomeInput {
first: String
}
extend input SomeInput {
second: Int
}
extend input SomeInput {
third: Float
}
"""
)
some_input = assert_input_object_type(schema.get_type("SomeInput"))
assert print_type(some_input) == dedent(
"""
input SomeInput {
first: String
second: Int
third: Float
}
"""
)
expect_ast_node(
some_input,
dedent(
"""
input SomeInput {
first: String
}
"""
),
)
expect_extension_ast_nodes(
some_input,
dedent(
"""
extend input SomeInput {
second: Int
}
extend input SomeInput {
third: Float
}
"""
),
)
def correctly_assign_ast_nodes():
sdl = dedent(
"""
schema {
query: Query
}
type Query {
testField(testArg: TestInput): TestUnion
}
input TestInput {
testInputField: TestEnum
}
enum TestEnum {
TEST_VALUE
}
union TestUnion = TestType
interface TestInterface {
interfaceField: String
}
type TestType implements TestInterface {
interfaceField: String
}
scalar TestScalar
directive @test(arg: TestScalar) on FIELD
"""
)
ast = parse(sdl, no_location=True)
schema = build_ast_schema(ast)
query = assert_object_type(schema.get_type("Query"))
test_input = assert_input_object_type(schema.get_type("TestInput"))
test_enum = assert_enum_type(schema.get_type("TestEnum"))
test_union = assert_union_type(schema.get_type("TestUnion"))
test_interface = assert_interface_type(schema.get_type("TestInterface"))
test_type = assert_object_type(schema.get_type("TestType"))
test_scalar = assert_scalar_type(schema.get_type("TestScalar"))
test_directive = assert_directive(schema.get_directive("test"))
assert (
schema.ast_node,
query.ast_node,
test_input.ast_node,
test_enum.ast_node,
test_union.ast_node,
test_interface.ast_node,
test_type.ast_node,
test_scalar.ast_node,
test_directive.ast_node,
) == ast.definitions
test_field = query.fields["testField"]
expect_ast_node(test_field, "testField(testArg: TestInput): TestUnion")
expect_ast_node(test_field.args["testArg"], "testArg: TestInput")
expect_ast_node(test_input.fields["testInputField"], "testInputField: TestEnum")
test_enum_value = test_enum.values["TEST_VALUE"]
expect_ast_node(test_enum_value, "TEST_VALUE")
expect_ast_node(
test_interface.fields["interfaceField"], "interfaceField: String"
)
expect_ast_node(test_directive.args["arg"], "arg: TestScalar")
def root_operation_types_with_custom_names():
schema = build_schema(
"""
schema {
query: SomeQuery
mutation: SomeMutation
subscription: SomeSubscription
}
type SomeQuery
type SomeMutation
type SomeSubscription
"""
)
assert schema.query_type
assert schema.query_type.name == "SomeQuery"
assert schema.mutation_type
assert schema.mutation_type.name == "SomeMutation"
assert schema.subscription_type
assert schema.subscription_type.name == "SomeSubscription"
def default_root_operation_type_names():
schema = build_schema(
"""
type Query
type Mutation
type Subscription
"""
)
assert schema.query_type
assert schema.query_type.name == "Query"
assert schema.mutation_type
assert schema.mutation_type.name == "Mutation"
assert schema.subscription_type
assert schema.subscription_type.name == "Subscription"
def can_build_invalid_schema():
# Invalid schema, because it is missing query root type
schema = build_schema("type Mutation")
errors = validate_schema(schema)
assert errors
def do_not_override_standard_types():
# Note: not sure it's desired behavior to just silently ignore override
# attempts so just documenting it here.
schema = build_schema(
"""
scalar ID
scalar __Schema
"""
)
assert schema.get_type("ID") is GraphQLID
assert schema.get_type("__Schema") is introspection_types["__Schema"]
def allows_to_reference_introspection_types():
schema = build_schema(
"""
type Query {
introspectionField: __EnumValue
}
"""
)
query_type = assert_object_type(schema.get_type("Query"))
__EnumValue = introspection_types["__EnumValue"]
assert query_type.fields["introspectionField"].type is __EnumValue
assert schema.get_type("__EnumValue") is introspection_types["__EnumValue"]
def rejects_invalid_sdl():
sdl = """
type Query {
foo: String @unknown
}
"""
with raises(TypeError) as exc_info:
build_schema(sdl)
assert str(exc_info.value) == "Unknown directive '@unknown'."
def allows_to_disable_sdl_validation():
sdl = """
type Query {
foo: String @unknown
}
"""
build_schema(sdl, assume_valid=True)
build_schema(sdl, assume_valid_sdl=True)
def throws_on_unknown_types():
sdl = """
type Query {
unknown: UnknownType
}
"""
with raises(TypeError) as exc_info:
build_schema(sdl, assume_valid_sdl=True)
assert str(exc_info.value).endswith("Unknown type: 'UnknownType'.")
def rejects_invalid_ast():
with raises(TypeError) as exc_info:
build_ast_schema(None) # type: ignore
assert str(exc_info.value) == "Must provide valid Document AST."
with raises(TypeError) as exc_info:
build_ast_schema({}) # type: ignore
assert str(exc_info.value) == "Must provide valid Document AST."
# This currently does not work because of how extend_schema is implemented
@mark.skip(reason="pickling of schemas is not yet supported")
def can_pickle_and_unpickle_big_schema(
big_schema_sdl, # noqa: F811
): # pragma: no cover
import pickle
# create a schema from the kitchen sink SDL
schema = build_schema(big_schema_sdl, assume_valid_sdl=True)
# check that the schema can be pickled
# (particularly, there should be no recursion error,
# or errors because of trying to pickle lambdas or local functions)
dumped = pickle.dumps(schema)
# check that the pickle size is reasonable
assert len(dumped) < 50 * len(big_schema_sdl)
loaded = pickle.loads(dumped)
# check that the un-pickled schema is still the same
assert loaded == schema
# check that pickling again creates the same result
dumped_again = pickle.dumps(schema)
assert dumped_again == dumped
# check that printing the unpickled schema gives the same SDL
assert cycle_sdl(print_schema(schema)) == cycle_sdl(big_schema_sdl)
|