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
|
from typing import cast, List, Union
from pytest import raises
from graphql.error import GraphQLError
from graphql.language import (
parse,
Node,
OperationDefinitionNode,
ObjectTypeDefinitionNode,
Source,
)
from ..utils import dedent
source = Source(
dedent(
"""
{
field
}
"""
)
)
ast = parse(source)
operation_node = ast.definitions[0]
operation_node = cast(OperationDefinitionNode, operation_node)
assert operation_node and operation_node.kind == "operation_definition"
field_node = operation_node.selection_set.selections[0]
assert field_node
def describe_graphql_error():
def is_a_class_and_is_a_subclass_of_exception():
assert type(GraphQLError) is type
assert issubclass(GraphQLError, Exception)
assert isinstance(GraphQLError("str"), Exception)
assert isinstance(GraphQLError("str"), GraphQLError)
def has_a_name_message_extensions_and_stack_trace():
e = GraphQLError("msg")
assert e.__class__.__name__ == "GraphQLError"
assert e.message == "msg"
assert e.extensions == {}
assert e.__traceback__ is None
assert str(e) == "msg"
def can_pass_positional_and_keyword_arguments():
e1 = GraphQLError(
"msg",
[field_node],
source,
[1, 2, 3],
["a", "b", "c"],
Exception("test"),
{"foo": "bar"},
)
e2 = GraphQLError(
message="msg",
nodes=[field_node],
source=source,
positions=[1, 2, 3],
path=["a", "b", "c"],
original_error=Exception("test"),
extensions={"foo": "bar"},
)
assert e1 == e2
def formatted_dict_has_only_keys_prescribed_in_the_spec():
e = GraphQLError(
"msg",
[field_node],
source,
[1, 2, 3],
["a", "b", "c"],
Exception("test"),
{"foo": "bar"},
)
assert set(e.formatted) == {"message", "path", "locations", "extensions"}
def uses_the_stack_of_an_original_error():
try:
raise RuntimeError("original")
except RuntimeError as runtime_error:
original = runtime_error
e = GraphQLError("msg", original_error=original)
assert e.__class__.__name__ == "GraphQLError"
assert e.__traceback__ is original.__traceback__
assert e.message == "msg"
assert e.original_error is original
assert str(e.original_error) == "original"
def passes_the_context_of_an_original_error():
context = ValueError("cause")
try:
raise context
except ValueError:
try:
raise RuntimeError("effect")
except RuntimeError as runtime_error:
original = runtime_error
e = GraphQLError("msg", original_error=original)
assert e.__context__ is context
def passes_the_cause_of_an_original_error():
cause = ValueError("cause")
try:
raise RuntimeError("effect") from cause
except RuntimeError as runtime_error:
original = runtime_error
e = GraphQLError("msg", original_error=original)
assert e.__cause__ is cause
def creates_new_stack_if_original_error_has_no_stack():
try:
raise RuntimeError
except RuntimeError as original_with_traceback:
original_traceback = original_with_traceback.__traceback__
original = RuntimeError("original")
e = GraphQLError("msg", original_error=original)
assert e.__class__.__name__ == "GraphQLError"
assert original.__traceback__ is None
assert original_traceback is not None
assert e.__traceback__ is original_traceback
assert e.message == "msg"
assert e.original_error is original
assert str(e.original_error) == "original"
def converts_nodes_to_positions_and_locations():
e = GraphQLError("msg", [field_node])
assert e.nodes == [field_node]
assert e.source is source
assert e.positions == [4]
assert e.locations == [(2, 3)]
def converts_single_node_to_positions_and_locations():
e = GraphQLError("msg", field_node) # Non-array value.
assert e.nodes == [field_node]
assert e.source is source
assert e.positions == [4]
assert e.locations == [(2, 3)]
def converts_node_with_loc_start_zero_to_positions_and_locations():
e = GraphQLError("msg", operation_node)
assert e.nodes == [operation_node]
assert e.source is source
assert e.positions == [0]
assert e.locations == [(1, 1)]
def converts_node_without_location_to_source_positions_and_locations_as_none():
document_node = parse("{ foo }", no_location=True)
e = GraphQLError("msg", document_node)
assert e.nodes == [document_node]
assert e.source is None
assert e.positions is None
assert e.locations is None
def converts_source_and_positions_to_locations():
e = GraphQLError("msg", None, source, [6])
assert e.nodes is None
assert e.source is source
assert e.positions == [6]
assert e.locations == [(2, 5)]
def defaults_to_original_error_extension_only_if_arg_is_not_passed():
original_extensions = {"original": "extensions"}
original_error = GraphQLError("original", extensions=original_extensions)
inherited_error = GraphQLError("InheritedError", original_error=original_error)
assert inherited_error.message == "InheritedError"
assert inherited_error.original_error is original_error
assert inherited_error.extensions is original_extensions
own_extensions = {"own": "extensions"}
own_error = GraphQLError(
"OwnError", original_error=original_error, extensions=own_extensions
)
assert own_error.message == "OwnError"
assert own_error.original_error is original_error
assert own_error.extensions is own_extensions
own_empty_error = GraphQLError(
"OwnEmptyError", original_error=original_error, extensions={}
)
assert own_empty_error.message == "OwnEmptyError"
assert own_empty_error.original_error is original_error
assert own_empty_error.extensions == {}
def serializes_to_include_message():
e = GraphQLError("msg")
assert str(e) == "msg"
assert repr(e) == "GraphQLError('msg')"
def serializes_to_include_message_and_locations():
e = GraphQLError("msg", field_node)
assert "msg" in str(e)
assert ":2:3" in str(e)
assert repr(e) == (
"GraphQLError('msg', locations=[SourceLocation(line=2, column=3)])"
)
assert e.formatted == {
"locations": [{"column": 3, "line": 2}],
"message": "msg",
}
def serializes_to_include_path():
path: List[Union[int, str]] = ["path", 3, "to", "field"]
e = GraphQLError("msg", path=path)
assert e.path is path
assert repr(e) == "GraphQLError('msg', path=['path', 3, 'to', 'field'])"
assert e.formatted == {
"message": "msg",
"path": ["path", 3, "to", "field"],
}
def serializes_to_include_all_standard_fields():
e_short = GraphQLError("msg")
assert str(e_short) == "msg"
assert repr(e_short) == "GraphQLError('msg')"
path: List[Union[str, int]] = ["path", 2, "field"]
extensions = {"foo": "bar "}
e_full = GraphQLError("msg", field_node, None, None, path, None, extensions)
assert str(e_full) == (
"msg\n\nGraphQL request:2:3\n" "1 | {\n2 | field\n | ^\n3 | }"
)
assert repr(e_full) == (
"GraphQLError('msg', locations=[SourceLocation(line=2, column=3)],"
" path=['path', 2, 'field'], extensions={'foo': 'bar '})"
)
assert e_full.formatted == {
"message": "msg",
"locations": [{"line": 2, "column": 3}],
"path": ["path", 2, "field"],
"extensions": {"foo": "bar "},
}
def repr_includes_extensions():
e = GraphQLError("msg", extensions={"foo": "bar"})
assert repr(e) == "GraphQLError('msg', extensions={'foo': 'bar'})"
def always_stores_path_as_list():
path: List[Union[int, str]] = ["path", 3, "to", "field"]
e = GraphQLError("msg,", path=tuple(path))
assert isinstance(e.path, list)
assert e.path == path
def is_comparable():
e1 = GraphQLError("msg,", path=["field", 1])
assert e1 == e1
assert e1 == e1.formatted
assert not e1 != e1
assert not e1 != e1.formatted
e2 = GraphQLError("msg,", path=["field", 1])
assert e1 == e2
assert not e1 != e2
assert e2.path and e2.path[1] == 1
e2.path[1] = 2
assert not e1 == e2
assert e1 != e2
assert not e1 == e2.formatted
assert e1 != e2.formatted
def is_hashable():
hash(GraphQLError("msg"))
def hashes_are_unique_per_instance():
e1 = GraphQLError("msg")
e2 = GraphQLError("msg")
assert hash(e1) != hash(e2)
def describe_to_string():
def deprecated_prints_an_error_using_print_error():
# noinspection PyProtectedMember
from graphql.error.graphql_error import print_error
error = GraphQLError("Error")
assert print_error(error) == "Error"
with raises(TypeError) as exc_info:
# noinspection PyTypeChecker
print_error(Exception) # type: ignore
assert str(exc_info.value) == "Expected a GraphQLError."
def prints_an_error_without_location():
error = GraphQLError("Error without location")
assert str(error) == "Error without location"
def prints_an_error_using_node_without_location():
error = GraphQLError(
"Error attached to node without location",
parse("{ foo }", no_location=True),
)
assert str(error) == "Error attached to node without location"
def prints_an_error_with_nodes_from_different_sources():
doc_a = parse(
Source(
dedent(
"""
type Foo {
field: String
}
"""
),
"SourceA",
)
)
op_a = doc_a.definitions[0]
op_a = cast(ObjectTypeDefinitionNode, op_a)
assert op_a and op_a.kind == "object_type_definition" and op_a.fields
field_a = op_a.fields[0]
doc_b = parse(
Source(
dedent(
"""
type Foo {
field: Int
}
"""
),
"SourceB",
)
)
op_b = doc_b.definitions[0]
op_b = cast(ObjectTypeDefinitionNode, op_b)
assert op_b and op_b.kind == "object_type_definition" and op_b.fields
field_b = op_b.fields[0]
error = GraphQLError(
"Example error with two nodes", [field_a.type, field_b.type]
)
assert str(error) == dedent(
"""
Example error with two nodes
SourceA:2:10
1 | type Foo {
2 | field: String
| ^
3 | }
SourceB:2:10
1 | type Foo {
2 | field: Int
| ^
3 | }
"""
)
def describe_formatted():
def deprecated_formats_an_error_using_format_error():
# noinspection PyProtectedMember
from graphql.error.graphql_error import format_error
error = GraphQLError("Example Error")
assert format_error(error) == {
"message": "Example Error",
}
with raises(TypeError) as exc_info:
# noinspection PyTypeChecker
format_error(Exception) # type: ignore
assert str(exc_info.value) == "Expected a GraphQLError."
def formats_graphql_error():
path: List[Union[int, str]] = ["one", 2]
extensions = {"ext": None}
error = GraphQLError(
"test message",
Node(),
Source(
"""
query {
something
}
"""
),
[16, 41],
["one", 2],
ValueError("original"),
extensions=extensions,
)
assert error.formatted == {
"message": "test message",
"locations": [{"line": 2, "column": 16}, {"line": 3, "column": 17}],
"path": path,
"extensions": extensions,
}
def uses_default_message():
# noinspection PyTypeChecker
formatted = GraphQLError(None).formatted # type: ignore
assert formatted == {
"message": "An unknown error occurred.",
}
def includes_path():
path: List[Union[int, str]] = ["path", 3, "to", "field"]
error = GraphQLError("msg", path=path)
assert error.formatted == {"message": "msg", "path": path}
def includes_extension_fields():
error = GraphQLError("msg", extensions={"foo": "bar"})
assert error.formatted == {
"message": "msg",
"extensions": {"foo": "bar"},
}
def can_be_created_from_dict():
args = dict(
nodes=[operation_node],
source=source,
positions=[6],
path=["path", 2, "a"],
original_error=Exception("I like turtles"),
extensions=dict(hee="I like turtles"),
)
error = GraphQLError("msg", **args) # type: ignore
assert error.formatted == {
"message": "msg",
"locations": [{"column": 5, "line": 2}],
"path": ["path", 2, "a"],
"extensions": {"hee": "I like turtles"},
}
|