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
|
import textwrap
from dataclasses import InitVar, dataclass
from enum import Enum
import pytest
import strawberry
from strawberry import ID
from strawberry.scalars import Base64
from strawberry.schema_directive import Location
from strawberry.types.base import StrawberryList
def test_raises_exception_with_unsupported_types():
class SomeType: ...
@strawberry.type
class Query:
example: SomeType
with pytest.raises(
TypeError, match=r"Query fields cannot be resolved. Unexpected type '.*'"
):
strawberry.Schema(query=Query)
def test_basic_schema():
@strawberry.type
class Query:
example: str = "Example"
schema = strawberry.Schema(query=Query)
query = "{ example }"
result = schema.execute_sync(query, root_value=Query())
assert not result.errors
assert result.data["example"] == "Example"
def test_basic_schema_optional():
@strawberry.type
class Query:
example: str | None = None
schema = strawberry.Schema(query=Query)
query = "{ example }"
result = schema.execute_sync(query, root_value=Query())
assert not result.errors
assert result.data["example"] is None
def test_basic_schema_types():
@strawberry.type
class User:
name: str
@strawberry.type
class Query:
user: User | None = None
schema = strawberry.Schema(query=Query)
query = "{ user { name } }"
result = schema.execute_sync(query, root_value=Query())
assert not result.errors
assert result.data["user"] is None
def test_does_camel_case_conversion():
@strawberry.type
class Query:
@strawberry.field
def hello_world(self, query_param: str) -> str:
return query_param
schema = strawberry.Schema(query=Query)
query = """{
helloWorld(queryParam: "hi")
}"""
result = schema.execute_sync(query)
assert not result.errors
assert result.data["helloWorld"] == "hi"
def test_can_rename_fields():
@strawberry.type
class Hello:
value: str | None = strawberry.field(name="name")
@strawberry.type
class Query:
@strawberry.field
def hello(self) -> Hello:
return Hello(value="hi")
@strawberry.field(name="example1")
def example(self, query_param: str) -> str:
return query_param
schema = strawberry.Schema(query=Query)
query = """{
hello { name }
example1(queryParam: "hi")
}"""
result = schema.execute_sync(query)
assert not result.errors
assert result.data["hello"]["name"] == "hi"
assert result.data["example1"] == "hi"
def test_type_description():
@strawberry.type(description="Decorator argument description")
class TypeA:
a: str
@strawberry.type
class Query:
a: TypeA
schema = strawberry.Schema(query=Query)
query = """{
__type(name: "TypeA") {
name
description
}
}"""
result = schema.execute_sync(query)
assert not result.errors
assert result.data["__type"] == {
"name": "TypeA",
"description": "Decorator argument description",
}
def test_field_description():
@strawberry.type
class Query:
a: str = strawberry.field(description="Example")
@strawberry.field
def b(self, id: int) -> str:
return "I'm a resolver"
@strawberry.field(description="Example C")
def c(self, id: int) -> str:
return "I'm a resolver"
schema = strawberry.Schema(query=Query)
query = """{
__type(name: "Query") {
fields {
name
description
}
}
}"""
result = schema.execute_sync(query)
assert not result.errors
assert result.data["__type"]["fields"] == [
{"name": "a", "description": "Example"},
{"name": "b", "description": None},
{"name": "c", "description": "Example C"},
]
def test_field_deprecated_reason():
@strawberry.type
class Query:
a: str = strawberry.field(deprecation_reason="Deprecated A")
@strawberry.field
def b(self, id: int) -> str:
return "I'm a resolver"
@strawberry.field(deprecation_reason="Deprecated B")
def c(self, id: int) -> str:
return "I'm a resolver"
schema = strawberry.Schema(query=Query)
query = """{
__type(name: "Query") {
fields(includeDeprecated: true) {
name
deprecationReason
}
}
}"""
result = schema.execute_sync(query)
assert not result.errors
assert result.data["__type"]["fields"] == [
{"name": "a", "deprecationReason": "Deprecated A"},
{"name": "b", "deprecationReason": None},
{"name": "c", "deprecationReason": "Deprecated B"},
]
def test_field_deprecated_reason_subscription():
@strawberry.type
class Query:
a: str
@strawberry.type
class Subscription:
@strawberry.subscription(deprecation_reason="Deprecated A")
def a(self) -> str:
return "A"
schema = strawberry.Schema(query=Query, subscription=Subscription)
query = """{
__type(name: "Subscription") {
fields(includeDeprecated: true) {
name
deprecationReason
}
}
}"""
result = schema.execute_sync(query)
assert not result.errors
assert result.data["__type"]["fields"] == [
{"name": "a", "deprecationReason": "Deprecated A"},
]
def test_enum_description():
@strawberry.enum(description="We love ice-creams")
class IceCreamFlavour(Enum):
VANILLA = "vanilla"
STRAWBERRY = "strawberry"
CHOCOLATE = "chocolate"
@strawberry.enum
class PizzaType(Enum):
MARGHERITA = "margherita"
@strawberry.type
class Query:
favorite_ice_cream: IceCreamFlavour = IceCreamFlavour.STRAWBERRY
pizza: PizzaType = PizzaType.MARGHERITA
schema = strawberry.Schema(query=Query)
query = """{
iceCreamFlavour: __type(name: "IceCreamFlavour") {
description
enumValues {
name
description
}
}
pizzas: __type(name: "PizzaType") {
description
}
}"""
result = schema.execute_sync(query)
assert not result.errors
assert result.data["iceCreamFlavour"]["description"] == "We love ice-creams"
assert result.data["iceCreamFlavour"]["enumValues"] == [
{"name": "VANILLA", "description": None},
{"name": "STRAWBERRY", "description": None},
{"name": "CHOCOLATE", "description": None},
]
assert result.data["pizzas"]["description"] is None
def test_enum_value_description():
@strawberry.enum
class IceCreamFlavour(Enum):
VANILLA = "vainilla"
STRAWBERRY = strawberry.enum_value("strawberry", description="Our favourite.")
CHOCOLATE = "chocolate"
@strawberry.type
class Query:
favorite_ice_cream: IceCreamFlavour = IceCreamFlavour.STRAWBERRY
schema = strawberry.Schema(query=Query)
query = """{
iceCreamFlavour: __type(name: "IceCreamFlavour") {
enumValues {
name
description
}
}
}"""
result = schema.execute_sync(query)
assert not result.errors
assert result.data["iceCreamFlavour"]["enumValues"] == [
{"name": "VANILLA", "description": None},
{"name": "STRAWBERRY", "description": "Our favourite."},
{"name": "CHOCOLATE", "description": None},
]
def test_parent_class_fields_are_inherited():
@strawberry.type
class Parent:
cheese: str = "swiss"
@strawberry.field
def friend(self) -> str:
return "food"
@strawberry.type
class Schema(Parent):
cake: str = "made_in_switzerland"
@strawberry.field
def hello_this_is(self) -> str:
return "patrick"
@strawberry.type
class Query:
@strawberry.field
def example(self) -> Schema:
return Schema()
schema = strawberry.Schema(query=Query)
query = "{ example { cheese, cake, friend, helloThisIs } }"
result = schema.execute_sync(query)
assert not result.errors
assert result.data["example"]["cheese"] == "swiss"
assert result.data["example"]["cake"] == "made_in_switzerland"
assert result.data["example"]["friend"] == "food"
assert result.data["example"]["helloThisIs"] == "patrick"
def test_can_return_compatible_type():
"""Test that we can return a different type that has the same fields,
for example when returning a Django Model.
"""
@dataclass
class Example:
name: str
@strawberry.type
class Cheese:
name: str
@strawberry.type
class Query:
@strawberry.field
def assortment(self) -> Cheese:
return Example(name="Asiago") # type: ignore
schema = strawberry.Schema(query=Query)
query = """{
assortment {
name
}
}"""
result = schema.execute_sync(query)
assert not result.errors
assert result.data["assortment"]["name"] == "Asiago"
def test_init_var():
@strawberry.type
class Category:
name: str
id: InitVar[str]
@strawberry.type
class Query:
@strawberry.field
def category(self) -> Category:
return Category(name="example", id="123")
schema = strawberry.Schema(query=Query)
query = "{ category { name } }"
result = schema.execute_sync(query)
assert not result.errors
assert result.data["category"]["name"] == "example"
def test_nested_types():
@strawberry.type
class User:
name: str
@strawberry.type
class Query:
@strawberry.field
def user(self) -> User:
return User(name="Patrick")
schema = strawberry.Schema(query=Query)
query = "{ user { name } }"
result = schema.execute_sync(query)
assert not result.errors
assert result.data["user"]["name"] == "Patrick"
def test_multiple_fields_with_same_type():
@strawberry.type
class User:
name: str
@strawberry.type
class Query:
me: User | None = None
you: User | None = None
schema = strawberry.Schema(query=Query)
query = "{ me { name } you { name } }"
result = schema.execute_sync(query, root_value=Query())
assert not result.errors
assert result.data["me"] is None
assert result.data["you"] is None
def test_str_magic_method_prints_schema_sdl():
@strawberry.type
class Query:
example_bool: bool
example_str: str = "Example"
example_int: int = 1
schema = strawberry.Schema(query=Query)
expected = """
type Query {
exampleBool: Boolean!
exampleStr: String!
exampleInt: Int!
}
"""
assert str(schema) == textwrap.dedent(expected).strip()
assert "<strawberry.schema.schema.Schema object" in repr(schema), (
"Repr should not be affected"
)
def test_field_with_default():
@strawberry.type
class Query:
a: str = strawberry.field(default="Example")
schema = strawberry.Schema(query=Query)
query = "{ a }"
result = schema.execute_sync(query, root_value=Query())
assert not result.errors
assert result.data == {"a": "Example"}
def test_with_types():
# Ensures Schema(types=[...]) works with all data types
@strawberry.type
class Type:
foo: int
@strawberry.interface
class Interface:
foo: int
@strawberry.input
class Input:
foo: int
@strawberry.type
class Query:
foo: int
@strawberry.schema_directive(locations=[Location.SCALAR], name="specifiedBy")
class SpecifiedBy:
name: str
schema = strawberry.Schema(
query=Query, types=[Type, Interface, Input, Base64, ID, str, int, SpecifiedBy]
)
expected = '''
directive @specifiedBy(name: String!) on SCALAR
"""
Represents binary data as Base64-encoded strings, using the standard alphabet.
"""
scalar Base64 @specifiedBy(url: "https://datatracker.ietf.org/doc/html/rfc4648.html#section-4")
input Input {
foo: Int!
}
interface Interface {
foo: Int!
}
type Query {
foo: Int!
}
type Type {
foo: Int!
}
'''
assert str(schema) == textwrap.dedent(expected).strip()
def test_with_types_non_named():
@strawberry.type
class Query:
foo: int
with pytest.raises(TypeError, match=r"\[Int!\] is not a named GraphQL Type"):
strawberry.Schema(query=Query, types=[StrawberryList(int)])
def test_kw_only():
@strawberry.type
class FooBar1:
foo: int = 1
bar: int
@strawberry.type
class FooBar2:
foo: int = strawberry.field(default=1)
bar: int = strawberry.field()
for FooBar in (FooBar1, FooBar2):
with pytest.raises(
TypeError, match="missing 1 required keyword-only argument: 'bar'"
):
FooBar()
with pytest.raises(
TypeError, match="missing 1 required keyword-only argument: 'bar'"
):
FooBar(foo=1)
FooBar(bar=2)
FooBar(foo=1, bar=2)
|