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 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278
|
from graphql.type import (
GraphQLSchema,
GraphQLDeprecatedDirective,
GraphQLIncludeDirective,
GraphQLSkipDirective,
GraphQLSpecifiedByDirective,
)
from graphql.utilities import (
BreakingChangeType,
DangerousChangeType,
build_schema,
find_breaking_changes,
find_dangerous_changes,
)
def describe_find_breaking_changes():
def should_detect_if_a_type_was_removed_or_not():
old_schema = build_schema(
"""
type Type1
type Type2
"""
)
new_schema = build_schema(
"""
type Type2
"""
)
assert find_breaking_changes(old_schema, new_schema) == [
(BreakingChangeType.TYPE_REMOVED, "Type1 was removed.")
]
assert find_breaking_changes(old_schema, old_schema) == []
def should_detect_if_a_standard_scalar_was_removed():
old_schema = build_schema(
"""
type Query {
foo: Float
}
"""
)
new_schema = build_schema(
"""
type Query {
foo: String
}
"""
)
assert find_breaking_changes(old_schema, new_schema) == [
(
BreakingChangeType.TYPE_REMOVED,
"Standard scalar Float was removed"
" because it is not referenced anymore.",
),
(
BreakingChangeType.FIELD_CHANGED_KIND,
"Query.foo changed type from Float to String.",
),
]
def should_detect_if_a_type_changed_its_type():
old_schema = build_schema(
"""
scalar TypeWasScalarBecomesEnum
interface TypeWasInterfaceBecomesUnion
type TypeWasObjectBecomesInputObject
"""
)
new_schema = build_schema(
"""
enum TypeWasScalarBecomesEnum
union TypeWasInterfaceBecomesUnion
input TypeWasObjectBecomesInputObject
"""
)
assert find_breaking_changes(old_schema, new_schema) == [
(
BreakingChangeType.TYPE_CHANGED_KIND,
"TypeWasScalarBecomesEnum changed from a Scalar type to an Enum type.",
),
(
BreakingChangeType.TYPE_CHANGED_KIND,
"TypeWasInterfaceBecomesUnion changed"
" from an Interface type to a Union type.",
),
(
BreakingChangeType.TYPE_CHANGED_KIND,
"TypeWasObjectBecomesInputObject changed"
" from an Object type to an Input type.",
),
]
def should_detect_if_a_field_on_type_was_deleted_or_changed_type():
old_schema = build_schema(
"""
type TypeA
type TypeB
interface Type1 {
field1: TypeA
field2: String
field3: String
field4: TypeA
field6: String
field7: [String]
field8: Int
field9: Int!
field10: [Int]!
field11: Int
field12: [Int]
field13: [Int!]
field14: [Int]
field15: [[Int]]
field16: Int!
field17: [Int]
field18: [[Int!]!]
}
"""
)
new_schema = build_schema(
"""
type TypeA
type TypeB
interface Type1 {
field1: TypeA
field3: Boolean
field4: TypeB
field5: String
field6: [String]
field7: String
field8: Int!
field9: Int
field10: [Int]
field11: [Int]!
field12: [Int!]
field13: [Int]
field14: [[Int]]
field15: [Int]
field16: [Int]!
field17: [Int]!
field18: [[Int!]]
}
"""
)
assert find_breaking_changes(old_schema, new_schema) == [
(BreakingChangeType.FIELD_REMOVED, "Type1.field2 was removed."),
(
BreakingChangeType.FIELD_CHANGED_KIND,
"Type1.field3 changed type from String to Boolean.",
),
(
BreakingChangeType.FIELD_CHANGED_KIND,
"Type1.field4 changed type from TypeA to TypeB.",
),
(
BreakingChangeType.FIELD_CHANGED_KIND,
"Type1.field6 changed type from String to [String].",
),
(
BreakingChangeType.FIELD_CHANGED_KIND,
"Type1.field7 changed type from [String] to String.",
),
(
BreakingChangeType.FIELD_CHANGED_KIND,
"Type1.field9 changed type from Int! to Int.",
),
(
BreakingChangeType.FIELD_CHANGED_KIND,
"Type1.field10 changed type from [Int]! to [Int].",
),
(
BreakingChangeType.FIELD_CHANGED_KIND,
"Type1.field11 changed type from Int to [Int]!.",
),
(
BreakingChangeType.FIELD_CHANGED_KIND,
"Type1.field13 changed type from [Int!] to [Int].",
),
(
BreakingChangeType.FIELD_CHANGED_KIND,
"Type1.field14 changed type from [Int] to [[Int]].",
),
(
BreakingChangeType.FIELD_CHANGED_KIND,
"Type1.field15 changed type from [[Int]] to [Int].",
),
(
BreakingChangeType.FIELD_CHANGED_KIND,
"Type1.field16 changed type from Int! to [Int]!.",
),
(
BreakingChangeType.FIELD_CHANGED_KIND,
"Type1.field18 changed type from [[Int!]!] to [[Int!]].",
),
]
def should_detect_if_fields_on_input_types_changed_kind_or_were_removed():
old_schema = build_schema(
"""
input InputType1 {
field1: String
field2: Boolean
field3: [String]
field4: String!
field5: String
field6: [Int]
field7: [Int]!
field8: Int
field9: [Int]
field10: [Int!]
field11: [Int]
field12: [[Int]]
field13: Int!
field14: [[Int]!]
field15: [[Int]!]
}
"""
)
new_schema = build_schema(
"""
input InputType1 {
field1: Int
field3: String
field4: String
field5: String!
field6: [Int]!
field7: [Int]
field8: [Int]!
field9: [Int!]
field10: [Int]
field11: [[Int]]
field12: [Int]
field13: [Int]!
field14: [[Int]]
field15: [[Int!]!]
}
"""
)
assert find_breaking_changes(old_schema, new_schema) == [
(BreakingChangeType.FIELD_REMOVED, "InputType1.field2 was removed."),
(
BreakingChangeType.FIELD_CHANGED_KIND,
"InputType1.field1 changed type from String to Int.",
),
(
BreakingChangeType.FIELD_CHANGED_KIND,
"InputType1.field3 changed type from [String] to String.",
),
(
BreakingChangeType.FIELD_CHANGED_KIND,
"InputType1.field5 changed type from String to String!.",
),
(
BreakingChangeType.FIELD_CHANGED_KIND,
"InputType1.field6 changed type from [Int] to [Int]!.",
),
(
BreakingChangeType.FIELD_CHANGED_KIND,
"InputType1.field8 changed type from Int to [Int]!.",
),
(
BreakingChangeType.FIELD_CHANGED_KIND,
"InputType1.field9 changed type from [Int] to [Int!].",
),
(
BreakingChangeType.FIELD_CHANGED_KIND,
"InputType1.field11 changed type from [Int] to [[Int]].",
),
(
BreakingChangeType.FIELD_CHANGED_KIND,
"InputType1.field12 changed type from [[Int]] to [Int].",
),
(
BreakingChangeType.FIELD_CHANGED_KIND,
"InputType1.field13 changed type from Int! to [Int]!.",
),
(
BreakingChangeType.FIELD_CHANGED_KIND,
"InputType1.field15 changed type from [[Int]!] to [[Int!]!].",
),
]
def should_detect_if_a_required_field_is_added_to_an_input_type():
old_schema = build_schema(
"""
input InputType1 {
field1: String
}
"""
)
new_schema = build_schema(
"""
input InputType1 {
field1: String
requiredField: Int!
optionalField1: Boolean
optionalField2: Boolean! = false
}
"""
)
assert find_breaking_changes(old_schema, new_schema) == [
(
BreakingChangeType.REQUIRED_INPUT_FIELD_ADDED,
"A required field requiredField on input type InputType1 was added.",
)
]
def should_detect_if_a_type_was_removed_from_a_union_type():
old_schema = build_schema(
"""
type Type1
type Type2
type Type3
union UnionType1 = Type1 | Type2
"""
)
new_schema = build_schema(
"""
type Type1
type Type2
type Type3
union UnionType1 = Type1 | Type3
"""
)
assert find_breaking_changes(old_schema, new_schema) == [
(
BreakingChangeType.TYPE_REMOVED_FROM_UNION,
"Type2 was removed from union type UnionType1.",
)
]
def should_detect_if_a_value_was_removed_from_an_enum_type():
old_schema = build_schema(
"""
enum EnumType1 {
VALUE0
VALUE1
VALUE2
}
"""
)
new_schema = build_schema(
"""
enum EnumType1 {
VALUE0
VALUE2
VALUE3
}
"""
)
assert find_breaking_changes(old_schema, new_schema) == [
(
BreakingChangeType.VALUE_REMOVED_FROM_ENUM,
"VALUE1 was removed from enum type EnumType1.",
)
]
def should_detect_if_a_field_argument_was_removed():
old_schema = build_schema(
"""
interface Interface1 {
field1(arg1: Boolean, objectArg: String): String
}
type Type1 {
field1(name: String): String
}
"""
)
new_schema = build_schema(
"""
interface Interface1 {
field1: String
}
type Type1 {
field1: String
}
"""
)
assert find_breaking_changes(old_schema, new_schema) == [
(BreakingChangeType.ARG_REMOVED, "Interface1.field1 arg arg1 was removed."),
(
BreakingChangeType.ARG_REMOVED,
"Interface1.field1 arg objectArg was removed.",
),
(BreakingChangeType.ARG_REMOVED, "Type1.field1 arg name was removed."),
]
def should_detect_if_a_field_argument_has_changed_type():
old_schema = build_schema(
"""
type Type1 {
field1(
arg1: String
arg2: String
arg3: [String]
arg4: String
arg5: String!
arg6: String!
arg7: [Int]!
arg8: Int
arg9: [Int]
arg10: [Int!]
arg11: [Int]
arg12: [[Int]]
arg13: Int!
arg14: [[Int]!]
arg15: [[Int]!]
): String
}
"""
)
new_schema = build_schema(
"""
type Type1 {
field1(
arg1: Int
arg2: [String]
arg3: String
arg4: String!
arg5: Int
arg6: Int!
arg7: [Int]
arg8: [Int]!
arg9: [Int!]
arg10: [Int]
arg11: [[Int]]
arg12: [Int]
arg13: [Int]!
arg14: [[Int]]
arg15: [[Int!]!]
): String
}
"""
)
assert find_breaking_changes(old_schema, new_schema) == [
(
BreakingChangeType.ARG_CHANGED_KIND,
"Type1.field1 arg arg1 has changed type from String to Int.",
),
(
BreakingChangeType.ARG_CHANGED_KIND,
"Type1.field1 arg arg2 has changed type from String to [String].",
),
(
BreakingChangeType.ARG_CHANGED_KIND,
"Type1.field1 arg arg3 has changed type from [String] to String.",
),
(
BreakingChangeType.ARG_CHANGED_KIND,
"Type1.field1 arg arg4 has changed type from String to String!.",
),
(
BreakingChangeType.ARG_CHANGED_KIND,
"Type1.field1 arg arg5 has changed type from String! to Int.",
),
(
BreakingChangeType.ARG_CHANGED_KIND,
"Type1.field1 arg arg6 has changed type from String! to Int!.",
),
(
BreakingChangeType.ARG_CHANGED_KIND,
"Type1.field1 arg arg8 has changed type from Int to [Int]!.",
),
(
BreakingChangeType.ARG_CHANGED_KIND,
"Type1.field1 arg arg9 has changed type from [Int] to [Int!].",
),
(
BreakingChangeType.ARG_CHANGED_KIND,
"Type1.field1 arg arg11 has changed type from [Int] to [[Int]].",
),
(
BreakingChangeType.ARG_CHANGED_KIND,
"Type1.field1 arg arg12 has changed type from [[Int]] to [Int].",
),
(
BreakingChangeType.ARG_CHANGED_KIND,
"Type1.field1 arg arg13 has changed type from Int! to [Int]!.",
),
(
BreakingChangeType.ARG_CHANGED_KIND,
"Type1.field1 arg arg15 has changed type from [[Int]!] to [[Int!]!].",
),
]
def should_detect_if_a_required_field_argument_was_added():
old_schema = build_schema(
"""
type Type1 {
field1(arg1: String): String
}
"""
)
new_schema = build_schema(
"""
type Type1 {
field1(
arg1: String,
newRequiredArg: String!
newOptionalArg1: Int
newOptionalArg2: Int! = 0
): String
}
"""
)
assert find_breaking_changes(old_schema, new_schema) == [
(
BreakingChangeType.REQUIRED_ARG_ADDED,
"A required arg newRequiredArg on Type1.field1 was added.",
)
]
def should_not_flag_args_with_the_same_type_signature_as_breaking():
old_schema = build_schema(
"""
input InputType1 {
field1: String
}
type Type1 {
field1(arg1: Int!, arg2: InputType1): Int
}
"""
)
new_schema = build_schema(
"""
input InputType1 {
field1: String
}
type Type1 {
field1(arg1: Int!, arg2: InputType1): Int
}
"""
)
assert find_breaking_changes(old_schema, new_schema) == []
def should_consider_args_that_move_away_from_non_null_as_non_breaking():
old_schema = build_schema(
"""
type Type1 {
field1(name: String!): String
}
"""
)
new_schema = build_schema(
"""
type Type1 {
field1(name: String): String
}
"""
)
assert find_breaking_changes(old_schema, new_schema) == []
def should_detect_interfaces_removed_from_types():
old_schema = build_schema(
"""
interface Interface1
type Type1 implements Interface1
"""
)
new_schema = build_schema(
"""
interface Interface1
type Type1
"""
)
assert find_breaking_changes(old_schema, new_schema) == [
(
BreakingChangeType.IMPLEMENTED_INTERFACE_REMOVED,
"Type1 no longer implements interface Interface1.",
)
]
def should_detect_intrefaces_removed_from_interfaces():
old_schema = build_schema(
"""
interface Interface1
interface Interface2 implements Interface1
"""
)
new_schema = build_schema(
"""
interface Interface1
interface Interface2
"""
)
assert find_breaking_changes(old_schema, new_schema) == [
(
BreakingChangeType.IMPLEMENTED_INTERFACE_REMOVED,
"Interface2 no longer implements interface Interface1.",
)
]
def should_ignore_changes_in_order_of_interfaces():
old_schema = build_schema(
"""
interface FirstInterface
interface SecondInterface
type Type1 implements FirstInterface & SecondInterface
"""
)
new_schema = build_schema(
"""
interface FirstInterface
interface SecondInterface
type Type1 implements SecondInterface & FirstInterface
"""
)
assert find_breaking_changes(old_schema, new_schema) == []
def should_detect_all_breaking_changes():
old_schema = build_schema(
"""
directive @DirectiveThatIsRemoved on FIELD_DEFINITION
directive @DirectiveThatRemovesArg(arg1: String) on FIELD_DEFINITION
directive @NonNullDirectiveAdded on FIELD_DEFINITION
directive @DirectiveThatWasRepeatable repeatable on FIELD_DEFINITION
directive @DirectiveName on FIELD_DEFINITION | QUERY
type ArgThatChanges {
field1(id: Float): String
}
enum EnumTypeThatLosesAValue {
VALUE0
VALUE1
VALUE2
}
interface Interface1
type TypeThatLoosesInterface1 implements Interface1
type TypeInUnion1
type TypeInUnion2
union UnionTypeThatLosesAType = TypeInUnion1 | TypeInUnion2
type TypeThatChangesType
type TypeThatGetsRemoved
interface TypeThatHasBreakingFieldChanges {
field1: String
field2: String
}
"""
)
new_schema = build_schema(
"""
directive @DirectiveThatRemovesArg on FIELD_DEFINITION
directive @NonNullDirectiveAdded(arg1: Boolean!) on FIELD_DEFINITION
directive @DirectiveThatWasRepeatable on FIELD_DEFINITION
directive @DirectiveName on FIELD_DEFINITION
type ArgThatChanges {
field1(id: String): String
}
enum EnumTypeThatLosesAValue {
VALUE1
VALUE2
}
interface Interface1
type TypeThatLoosesInterface1
type TypeInUnion1
type TypeInUnion2
union UnionTypeThatLosesAType = TypeInUnion1
interface TypeThatChangesType
interface TypeThatHasBreakingFieldChanges {
field2: Boolean
}
"""
)
assert find_breaking_changes(old_schema, new_schema) == [
(
BreakingChangeType.TYPE_REMOVED,
"Standard scalar Float was removed"
" because it is not referenced anymore.",
),
(BreakingChangeType.TYPE_REMOVED, "TypeThatGetsRemoved was removed."),
(
BreakingChangeType.ARG_CHANGED_KIND,
"ArgThatChanges.field1 arg id has changed type from Float to String.",
),
(
BreakingChangeType.VALUE_REMOVED_FROM_ENUM,
"VALUE0 was removed from enum type EnumTypeThatLosesAValue.",
),
(
BreakingChangeType.IMPLEMENTED_INTERFACE_REMOVED,
"TypeThatLoosesInterface1 no longer implements interface Interface1.",
),
(
BreakingChangeType.TYPE_REMOVED_FROM_UNION,
"TypeInUnion2 was removed from union type UnionTypeThatLosesAType.",
),
(
BreakingChangeType.TYPE_CHANGED_KIND,
"TypeThatChangesType changed from an Object type to an"
" Interface type.",
),
(
BreakingChangeType.FIELD_REMOVED,
"TypeThatHasBreakingFieldChanges.field1 was removed.",
),
(
BreakingChangeType.FIELD_CHANGED_KIND,
"TypeThatHasBreakingFieldChanges.field2 changed type"
" from String to Boolean.",
),
(
BreakingChangeType.DIRECTIVE_REMOVED,
"DirectiveThatIsRemoved was removed.",
),
(
BreakingChangeType.DIRECTIVE_ARG_REMOVED,
"arg1 was removed from DirectiveThatRemovesArg.",
),
(
BreakingChangeType.REQUIRED_DIRECTIVE_ARG_ADDED,
"A required arg arg1 on directive NonNullDirectiveAdded was added.",
),
(
BreakingChangeType.DIRECTIVE_REPEATABLE_REMOVED,
"Repeatable flag was removed from DirectiveThatWasRepeatable.",
),
(
BreakingChangeType.DIRECTIVE_LOCATION_REMOVED,
"QUERY was removed from DirectiveName.",
),
]
def should_detect_if_a_directive_was_explicitly_removed():
old_schema = build_schema(
"""
directive @DirectiveThatIsRemoved on FIELD_DEFINITION
directive @DirectiveThatStays on FIELD_DEFINITION
"""
)
new_schema = build_schema(
"""
directive @DirectiveThatStays on FIELD_DEFINITION
"""
)
assert find_breaking_changes(old_schema, new_schema) == [
(
BreakingChangeType.DIRECTIVE_REMOVED,
"DirectiveThatIsRemoved was removed.",
)
]
def should_detect_if_a_directive_was_implicitly_removed():
old_schema = GraphQLSchema()
new_schema = GraphQLSchema(
directives=[
GraphQLSkipDirective,
GraphQLIncludeDirective,
GraphQLSpecifiedByDirective,
]
)
assert find_breaking_changes(old_schema, new_schema) == [
(
BreakingChangeType.DIRECTIVE_REMOVED,
f"{GraphQLDeprecatedDirective.name} was removed.",
)
]
def should_detect_if_a_directive_argument_was_removed():
old_schema = build_schema(
"""
directive @DirectiveWithArg(arg1: String) on FIELD_DEFINITION
"""
)
new_schema = build_schema(
"""
directive @DirectiveWithArg on FIELD_DEFINITION
"""
)
assert find_breaking_changes(old_schema, new_schema) == [
(
BreakingChangeType.DIRECTIVE_ARG_REMOVED,
"arg1 was removed from DirectiveWithArg.",
)
]
def should_detect_if_an_optional_directive_argument_was_added():
old_schema = build_schema(
"""
directive @DirectiveName on FIELD_DEFINITION
"""
)
new_schema = build_schema(
"""
directive @DirectiveName(
newRequiredArg: String!
newOptionalArg1: Int
newOptionalArg2: Int! = 0
) on FIELD_DEFINITION
"""
)
assert find_breaking_changes(old_schema, new_schema) == [
(
BreakingChangeType.REQUIRED_DIRECTIVE_ARG_ADDED,
"A required arg newRequiredArg on directive DirectiveName was added.",
)
]
def should_detect_removal_of_repeatable_flag():
old_schema = build_schema(
"""
directive @DirectiveName repeatable on OBJECT
"""
)
new_schema = build_schema(
"""
directive @DirectiveName on OBJECT
"""
)
assert find_breaking_changes(old_schema, new_schema) == [
(
BreakingChangeType.DIRECTIVE_REPEATABLE_REMOVED,
"Repeatable flag was removed from DirectiveName.",
)
]
def should_detect_locations_removed_from_a_directive():
old_schema = build_schema(
"""
directive @DirectiveName on FIELD_DEFINITION | QUERY
"""
)
new_schema = build_schema(
"""
directive @DirectiveName on FIELD_DEFINITION
"""
)
assert find_breaking_changes(old_schema, new_schema) == [
(
BreakingChangeType.DIRECTIVE_LOCATION_REMOVED,
"QUERY was removed from DirectiveName.",
)
]
def describe_find_dangerous_changes():
def should_detect_if_a_default_value_changed_on_an_argument():
old_sdl = """
input Input1 {
innerInputArray: [Input2]
}
input Input2 {
arrayField: [Int]
}
type Type1 {
field1(
withDefaultValue: String = "TO BE DELETED"
stringArg: String = "test"
emptyArray: [Int!] = []
valueArray: [[String]] = [["a", "b"], ["c"]]
complexObject: Input1 = {
innerInputArray: [{ arrayField: [1, 2, 3] }]
}
): String
}
"""
old_schema = build_schema(old_sdl)
copy_of_old_schema = build_schema(old_sdl)
assert find_dangerous_changes(old_schema, copy_of_old_schema) == []
new_schema = build_schema(
"""
input Input1 {
innerInputArray: [Input2]
}
input Input2 {
arrayField: [Int]
}
type Type1 {
field1(
withDefaultValue: String
stringArg: String = "Test"
emptyArray: [Int!] = [7]
valueArray: [[String]] = [["b", "a"], ["d"]]
complexObject: Input1 = {
innerInputArray: [{ arrayField: [3, 2, 1] }]
}
): String
}
"""
)
assert find_dangerous_changes(old_schema, new_schema) == [
(
DangerousChangeType.ARG_DEFAULT_VALUE_CHANGE,
"Type1.field1 arg withDefaultValue defaultValue was removed.",
),
(
DangerousChangeType.ARG_DEFAULT_VALUE_CHANGE,
"Type1.field1 arg stringArg has changed defaultValue"
' from "test" to "Test".',
),
(
DangerousChangeType.ARG_DEFAULT_VALUE_CHANGE,
"Type1.field1 arg emptyArray has changed defaultValue from [] to [7].",
),
(
DangerousChangeType.ARG_DEFAULT_VALUE_CHANGE,
"Type1.field1 arg valueArray has changed defaultValue"
' from [["a", "b"], ["c"]] to [["b", "a"], ["d"]].',
),
(
DangerousChangeType.ARG_DEFAULT_VALUE_CHANGE,
"Type1.field1 arg complexObject has changed defaultValue"
" from {innerInputArray: [{arrayField: [1, 2, 3]}]}"
" to {innerInputArray: [{arrayField: [3, 2, 1]}]}.",
),
]
def should_ignore_changes_in_field_order_of_default_value():
old_schema = build_schema(
"""
input Input1 {
a: String
b: String
c: String
}
type Type1 {
field1(
arg1: Input1 = { a: "a", b: "b", c: "c" }
): String
}
"""
)
new_schema = build_schema(
"""
input Input1 {
a: String
b: String
c: String
}
type Type1 {
field1(
arg1: Input1 = { c: "c", b: "b", a: "a" }
): String
}
"""
)
assert find_dangerous_changes(old_schema, new_schema) == []
def should_ignore_changes_in_field_definitions_order():
old_schema = build_schema(
"""
input Input1 {
a: String
b: String
c: String
}
type Type1 {
field1(
arg1: Input1 = { a: "a", b: "b", c: "c" }
): String
}
"""
)
new_schema = build_schema(
"""
input Input1 {
c: String
b: String
a: String
}
type Type1 {
field1(
arg1: Input1 = { a: "a", b: "b", c: "c" }
): String
}
"""
)
assert find_dangerous_changes(old_schema, new_schema) == []
def should_detect_if_a_value_was_added_to_an_enum_type():
old_schema = build_schema(
"""
enum EnumType1 {
VALUE0
VALUE1
}
"""
)
new_schema = build_schema(
"""
enum EnumType1 {
VALUE0
VALUE1
VALUE2
}
"""
)
assert find_dangerous_changes(old_schema, new_schema) == [
(
DangerousChangeType.VALUE_ADDED_TO_ENUM,
"VALUE2 was added to enum type EnumType1.",
)
]
def should_detect_interfaces_added_to_types():
old_schema = build_schema(
"""
interface OldInterface
interface NewInterface
type Type1 implements OldInterface
"""
)
new_schema = build_schema(
"""
interface OldInterface
interface NewInterface
type Type1 implements OldInterface & NewInterface
"""
)
assert find_dangerous_changes(old_schema, new_schema) == [
(
DangerousChangeType.IMPLEMENTED_INTERFACE_ADDED,
"NewInterface added to interfaces implemented by Type1.",
)
]
def should_detect_interfaces_added_to_interfaces():
old_schema = build_schema(
"""
interface OldInterface
interface NewInterface
interface Interface1 implements OldInterface
"""
)
new_schema = build_schema(
"""
interface OldInterface
interface NewInterface
interface Interface1 implements OldInterface & NewInterface
"""
)
assert find_dangerous_changes(old_schema, new_schema) == [
(
DangerousChangeType.IMPLEMENTED_INTERFACE_ADDED,
"NewInterface added to interfaces implemented by Interface1.",
)
]
def should_detect_if_a_type_was_added_to_a_union_type():
old_schema = build_schema(
"""
type Type1
type Type2
union UnionType1 = Type1
"""
)
new_schema = build_schema(
"""
type Type1
type Type2
union UnionType1 = Type1 | Type2
"""
)
assert find_dangerous_changes(old_schema, new_schema) == [
(
DangerousChangeType.TYPE_ADDED_TO_UNION,
"Type2 was added to union type UnionType1.",
)
]
def should_detect_if_an_optional_field_was_added_to_an_input():
old_schema = build_schema(
"""
input InputType1 {
field1: String
}
"""
)
new_schema = build_schema(
"""
input InputType1 {
field1: String
field2: Int
}
"""
)
assert find_dangerous_changes(old_schema, new_schema) == [
(
DangerousChangeType.OPTIONAL_INPUT_FIELD_ADDED,
"An optional field field2 on input type InputType1 was added.",
)
]
def should_find_all_dangerous_changes():
old_schema = build_schema(
"""
enum EnumType1 {
VALUE0
VALUE1
}
type Type1 {
field1(argThatChangesDefaultValue: String = "test"): String
}
interface Interface1
type TypeThatGainsInterface1
type TypeInUnion1
union UnionTypeThatGainsAType = TypeInUnion1
"""
)
new_schema = build_schema(
"""
enum EnumType1 {
VALUE0
VALUE1
VALUE2
}
type Type1 {
field1(argThatChangesDefaultValue: String = "Test"): String
}
interface Interface1
type TypeThatGainsInterface1 implements Interface1
type TypeInUnion1
type TypeInUnion2
union UnionTypeThatGainsAType = TypeInUnion1 | TypeInUnion2
"""
)
assert find_dangerous_changes(old_schema, new_schema) == [
(
DangerousChangeType.VALUE_ADDED_TO_ENUM,
"VALUE2 was added to enum type EnumType1.",
),
(
DangerousChangeType.ARG_DEFAULT_VALUE_CHANGE,
"Type1.field1 arg argThatChangesDefaultValue has changed defaultValue"
' from "test" to "Test".',
),
(
DangerousChangeType.IMPLEMENTED_INTERFACE_ADDED,
"Interface1 added to interfaces implemented"
" by TypeThatGainsInterface1.",
),
(
DangerousChangeType.TYPE_ADDED_TO_UNION,
"TypeInUnion2 was added to union type UnionTypeThatGainsAType.",
),
]
def should_detect_if_an_optional_field_argument_was_added():
old_schema = build_schema(
"""
type Type1 {
field1(arg1: String): String
}
"""
)
new_schema = build_schema(
"""
type Type1 {
field1(arg1: String, arg2: String): String
}
"""
)
assert find_dangerous_changes(old_schema, new_schema) == [
(
DangerousChangeType.OPTIONAL_ARG_ADDED,
"An optional arg arg2 on Type1.field1 was added.",
)
]
|