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
|
from functools import partial
from graphql.utilities import build_schema
from graphql.validation import KnownArgumentNamesRule
from graphql.validation.rules.known_argument_names import (
KnownArgumentNamesOnDirectivesRule,
)
from .harness import assert_validation_errors, assert_sdl_validation_errors
assert_errors = partial(assert_validation_errors, KnownArgumentNamesRule)
assert_valid = partial(assert_errors, errors=[])
assert_sdl_errors = partial(
assert_sdl_validation_errors, KnownArgumentNamesOnDirectivesRule
)
assert_sdl_valid = partial(assert_sdl_errors, errors=[])
def describe_validate_known_argument_names():
def single_arg_is_known():
assert_valid(
"""
fragment argOnRequiredArg on Dog {
doesKnowCommand(dogCommand: SIT)
}
"""
)
def multiple_args_are_known():
assert_valid(
"""
fragment multipleArgs on ComplicatedArgs {
multipleReqs(req1: 1, req2: 2)
}
"""
)
def ignore_args_of_unknown_fields():
assert_valid(
"""
fragment argOnUnknownField on Dog {
unknownField(unknownArg: SIT)
}
"""
)
def multiple_args_in_reverse_order_are_known():
assert_valid(
"""
fragment multipleArgsReverseOrder on ComplicatedArgs {
multipleReqs(req2: 2, req1: 1)
}
"""
)
def no_args_on_optional_arg():
assert_valid(
"""
fragment noArgOnOptionalArg on Dog {
isHouseTrained
}
"""
)
def args_are_known_deeply():
assert_valid(
"""
{
dog {
doesKnowCommand(dogCommand: SIT)
}
human {
pet {
... on Dog {
doesKnowCommand(dogCommand: SIT)
}
}
}
}
"""
)
def directive_args_are_known():
assert_valid(
"""
{
dog @skip(if: true)
}
"""
)
def field_args_are_invalid():
assert_errors(
"""
{
dog @skip(unless: true)
}
""",
[
{
"message": "Unknown argument 'unless' on directive '@skip'.",
"locations": [(3, 25)],
}
],
)
def directive_without_args_is_valid():
assert_valid(
"""
{
dog @onField
}
"""
)
def arg_passed_to_directive_without_args_is_reported():
assert_errors(
"""
{
dog @onField(if: true)
}
""",
[
{
"message": "Unknown argument 'if' on directive '@onField'.",
"locations": [(3, 30)],
}
],
)
def misspelled_directive_args_are_reported():
assert_errors(
"""
{
dog @skip(iff: true)
}
""",
[
{
"message": "Unknown argument 'iff' on directive '@skip'."
" Did you mean 'if'?",
"locations": [(3, 25)],
}
],
)
def invalid_arg_name():
assert_errors(
"""
fragment invalidArgName on Dog {
doesKnowCommand(unknown: true)
}
""",
[
{
"message": "Unknown argument 'unknown'"
" on field 'Dog.doesKnowCommand'.",
"locations": [(3, 31)],
},
],
)
def misspelled_arg_name_is_reported():
assert_errors(
"""
fragment invalidArgName on Dog {
doesKnowCommand(DogCommand: true)
}
""",
[
{
"message": "Unknown argument 'DogCommand'"
" on field 'Dog.doesKnowCommand'."
" Did you mean 'dogCommand'?",
"locations": [(3, 31)],
}
],
)
def unknown_args_amongst_known_args():
assert_errors(
"""
fragment oneGoodArgOneInvalidArg on Dog {
doesKnowCommand(whoKnows: 1, dogCommand: SIT, unknown: true)
}
""",
[
{
"message": "Unknown argument 'whoKnows'"
" on field 'Dog.doesKnowCommand'.",
"locations": [(3, 31)],
},
{
"message": "Unknown argument 'unknown'"
" on field 'Dog.doesKnowCommand'.",
"locations": [(3, 61)],
},
],
)
def unknown_args_deeply():
assert_errors(
"""
{
dog {
doesKnowCommand(unknown: true)
}
human {
pet {
... on Dog {
doesKnowCommand(unknown: true)
}
}
}
}
""",
[
{
"message": "Unknown argument 'unknown'"
" on field 'Dog.doesKnowCommand'.",
"locations": [(4, 33)],
},
{
"message": "Unknown argument 'unknown'"
" on field 'Dog.doesKnowCommand'.",
"locations": [(9, 37)],
},
],
)
def describe_within_sdl():
def known_arg_on_directive_inside_sdl():
assert_sdl_valid(
"""
type Query {
foo: String @test(arg: "")
}
directive @test(arg: String) on FIELD_DEFINITION
"""
)
def unknown_arg_on_directive_defined_inside_sdl():
assert_sdl_errors(
"""
type Query {
foo: String @test(unknown: "")
}
directive @test(arg: String) on FIELD_DEFINITION
""",
[
{
"message": "Unknown argument 'unknown' on directive '@test'.",
"locations": [(3, 37)],
},
],
)
def misspelled_arg_name_is_reported_on_directive_defined_inside_sdl():
assert_sdl_errors(
"""
type Query {
foo: String @test(agr: "")
}
directive @test(arg: String) on FIELD_DEFINITION
""",
[
{
"message": "Unknown argument 'agr' on directive '@test'."
" Did you mean 'arg'?",
"locations": [(3, 37)],
},
],
)
def unknown_arg_on_standard_directive():
assert_sdl_errors(
"""
type Query {
foo: String @deprecated(unknown: "")
}
""",
[
{
"message": "Unknown argument 'unknown'"
" on directive '@deprecated'.",
"locations": [(3, 43)],
},
],
)
def unknown_arg_on_overridden_standard_directive():
assert_sdl_errors(
"""
type Query {
foo: String @deprecated(reason: "")
}
directive @deprecated(arg: String) on FIELD
""",
[
{
"message": "Unknown argument 'reason'"
" on directive '@deprecated'.",
"locations": [(3, 43)],
},
],
)
def unknown_arg_on_directive_defined_in_schema_extension():
schema = build_schema(
"""
type Query {
foo: String
}
"""
)
assert_sdl_errors(
"""
directive @test(arg: String) on OBJECT
extend type Query @test(unknown: "")
""",
[
{
"message": "Unknown argument 'unknown' on directive '@test'.",
"locations": [(4, 42)],
},
],
schema,
)
def unknown_arg_on_directive_used_in_schema_extension():
schema = build_schema(
"""
directive @test(arg: String) on OBJECT
type Query {
foo: String
}
"""
)
assert_sdl_errors(
"""
extend type Query @test(unknown: "")
""",
[
{
"message": "Unknown argument 'unknown' on directive '@test'.",
"locations": [(2, 41)],
},
],
schema,
)
|