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
|
from enum import Enum
from textwrap import dedent
from typing import Annotated
import pytest
import strawberry
from strawberry.types.lazy_type import lazy
def test_enum_resolver():
@strawberry.enum
class IceCreamFlavour(Enum):
VANILLA = "vanilla"
STRAWBERRY = "strawberry"
CHOCOLATE = "chocolate"
@strawberry.type
class Query:
@strawberry.field
def best_flavour(self) -> IceCreamFlavour:
return IceCreamFlavour.STRAWBERRY
schema = strawberry.Schema(query=Query)
query = "{ bestFlavour }"
result = schema.execute_sync(query)
assert not result.errors
assert result.data["bestFlavour"] == "STRAWBERRY"
@strawberry.type
class Cone:
flavour: IceCreamFlavour
@strawberry.type
class Query:
@strawberry.field
def cone(self) -> Cone:
return Cone(flavour=IceCreamFlavour.STRAWBERRY)
schema = strawberry.Schema(query=Query)
query = "{ cone { flavour } }"
result = schema.execute_sync(query)
assert not result.errors
assert result.data["cone"]["flavour"] == "STRAWBERRY"
def test_enum_arguments():
@strawberry.enum
class IceCreamFlavour(Enum):
VANILLA = "vanilla"
STRAWBERRY = "strawberry"
CHOCOLATE = "chocolate"
@strawberry.type
class Query:
@strawberry.field
def flavour_available(self, flavour: IceCreamFlavour) -> bool:
return flavour == IceCreamFlavour.STRAWBERRY
@strawberry.input
class ConeInput:
flavour: IceCreamFlavour
@strawberry.type
class Mutation:
@strawberry.mutation
def eat_cone(self, input: ConeInput) -> bool:
return input.flavour == IceCreamFlavour.STRAWBERRY
schema = strawberry.Schema(query=Query, mutation=Mutation)
query = "{ flavourAvailable(flavour: VANILLA) }"
result = schema.execute_sync(query)
assert not result.errors
assert result.data["flavourAvailable"] is False
query = "{ flavourAvailable(flavour: STRAWBERRY) }"
result = schema.execute_sync(query)
assert not result.errors
assert result.data["flavourAvailable"] is True
query = "mutation { eatCone(input: { flavour: VANILLA }) }"
result = schema.execute_sync(query)
assert not result.errors
assert result.data["eatCone"] is False
query = "mutation { eatCone(input: { flavour: STRAWBERRY }) }"
result = schema.execute_sync(query)
assert not result.errors
assert result.data["eatCone"] is True
def test_lazy_enum_arguments():
LazyEnum = Annotated[
"LazyEnum", lazy("tests.schema.test_lazy_types.test_lazy_enums")
]
@strawberry.type
class Query:
@strawberry.field
def something(self, enum: LazyEnum) -> LazyEnum:
return enum
schema = strawberry.Schema(query=Query)
query = "{ something(enum: BREAD) }"
result = schema.execute_sync(query)
assert not result.errors
assert result.data["something"] == "BREAD"
def test_enum_falsy_values():
@strawberry.enum
class IceCreamFlavour(Enum):
VANILLA = ""
STRAWBERRY = 0
@strawberry.input
class Input:
flavour: IceCreamFlavour
optional_flavour: IceCreamFlavour | None = None
@strawberry.type
class Query:
@strawberry.field
def print_flavour(self, input: Input) -> str:
return f"{input.flavour.value}"
schema = strawberry.Schema(query=Query)
query = "{ printFlavour(input: { flavour: VANILLA }) }"
result = schema.execute_sync(query)
assert not result.errors
assert not result.data["printFlavour"]
query = "{ printFlavour(input: { flavour: STRAWBERRY }) }"
result = schema.execute_sync(query)
assert not result.errors
assert result.data["printFlavour"] == "0"
def test_enum_in_list():
@strawberry.enum
class IceCreamFlavour(Enum):
VANILLA = "vanilla"
STRAWBERRY = "strawberry"
CHOCOLATE = "chocolate"
PISTACHIO = "pistachio"
@strawberry.type
class Query:
@strawberry.field
def best_flavours(self) -> list[IceCreamFlavour]:
return [IceCreamFlavour.STRAWBERRY, IceCreamFlavour.PISTACHIO]
schema = strawberry.Schema(query=Query)
query = "{ bestFlavours }"
result = schema.execute_sync(query)
assert not result.errors
assert result.data["bestFlavours"] == ["STRAWBERRY", "PISTACHIO"]
def test_enum_in_optional_list():
@strawberry.enum
class IceCreamFlavour(Enum):
VANILLA = "vanilla"
STRAWBERRY = "strawberry"
CHOCOLATE = "chocolate"
PISTACHIO = "pistachio"
@strawberry.type
class Query:
@strawberry.field
def best_flavours(self) -> list[IceCreamFlavour] | None:
return None
schema = strawberry.Schema(query=Query)
query = "{ bestFlavours }"
result = schema.execute_sync(query)
assert not result.errors
assert result.data["bestFlavours"] is None
@pytest.mark.asyncio
async def test_enum_resolver_async():
@strawberry.enum
class IceCreamFlavour(Enum):
VANILLA = "vanilla"
STRAWBERRY = "strawberry"
CHOCOLATE = "chocolate"
@strawberry.type
class Query:
@strawberry.field
async def best_flavour(self) -> IceCreamFlavour:
return IceCreamFlavour.STRAWBERRY
schema = strawberry.Schema(query=Query)
query = "{ bestFlavour }"
result = await schema.execute(query)
assert not result.errors
assert result.data["bestFlavour"] == "STRAWBERRY"
@pytest.mark.asyncio
async def test_enum_in_list_async():
@strawberry.enum
class IceCreamFlavour(Enum):
VANILLA = "vanilla"
STRAWBERRY = "strawberry"
CHOCOLATE = "chocolate"
PISTACHIO = "pistachio"
@strawberry.type
class Query:
@strawberry.field
async def best_flavours(self) -> list[IceCreamFlavour]:
return [IceCreamFlavour.STRAWBERRY, IceCreamFlavour.PISTACHIO]
schema = strawberry.Schema(query=Query)
query = "{ bestFlavours }"
result = await schema.execute(query)
assert not result.errors
assert result.data["bestFlavours"] == ["STRAWBERRY", "PISTACHIO"]
def test_enum_as_argument():
@strawberry.enum
class IceCreamFlavour(Enum):
VANILLA = "vanilla"
STRAWBERRY = "strawberry"
CHOCOLATE = "chocolate"
PISTACHIO = "pistachio"
@strawberry.type
class Query:
@strawberry.field
def create_flavour(self, flavour: IceCreamFlavour) -> str:
return f"{flavour.name}"
schema = strawberry.Schema(query=Query)
expected = dedent(
"""
enum IceCreamFlavour {
VANILLA
STRAWBERRY
CHOCOLATE
PISTACHIO
}
type Query {
createFlavour(flavour: IceCreamFlavour!): String!
}
"""
).strip()
assert str(schema) == expected
query = "{ createFlavour(flavour: CHOCOLATE) }"
result = schema.execute_sync(query)
assert not result.errors
assert result.data["createFlavour"] == "CHOCOLATE"
# Explicitly using `variable_values` now so that the enum is parsed using
# `CustomGraphQLEnumType.parse_value()` instead of `.parse_literal`
query = "query ($flavour: IceCreamFlavour!) { createFlavour(flavour: $flavour) }"
result = schema.execute_sync(query, variable_values={"flavour": "VANILLA"})
assert not result.errors
assert result.data["createFlavour"] == "VANILLA"
def test_enum_as_default_argument():
@strawberry.enum
class IceCreamFlavour(Enum):
VANILLA = "vanilla"
STRAWBERRY = "strawberry"
CHOCOLATE = "chocolate"
PISTACHIO = "pistachio"
@strawberry.type
class Query:
@strawberry.field
def create_flavour(
self, flavour: IceCreamFlavour = IceCreamFlavour.STRAWBERRY
) -> str:
return f"{flavour.name}"
schema = strawberry.Schema(query=Query)
expected = dedent(
"""
enum IceCreamFlavour {
VANILLA
STRAWBERRY
CHOCOLATE
PISTACHIO
}
type Query {
createFlavour(flavour: IceCreamFlavour! = STRAWBERRY): String!
}
"""
).strip()
assert str(schema) == expected
query = "{ createFlavour }"
result = schema.execute_sync(query)
assert not result.errors
assert result.data["createFlavour"] == "STRAWBERRY"
def test_enum_resolver_plain_value():
@strawberry.enum
class IceCreamFlavour(Enum):
VANILLA = "vanilla"
STRAWBERRY = "strawberry"
CHOCOLATE = "chocolate"
@strawberry.type
class Query:
@strawberry.field
def best_flavour(self) -> IceCreamFlavour:
return "strawberry" # type: ignore
schema = strawberry.Schema(query=Query)
query = "{ bestFlavour }"
result = schema.execute_sync(query)
assert not result.errors
assert result.data["bestFlavour"] == "STRAWBERRY"
def test_enum_deprecated_value():
@strawberry.enum
class IceCreamFlavour(Enum):
VANILLA = "vanilla"
STRAWBERRY = strawberry.enum_value(
"strawberry", deprecation_reason="We ran out"
)
CHOCOLATE = strawberry.enum_value("chocolate")
@strawberry.type
class Query:
@strawberry.field
def best_flavour(self) -> IceCreamFlavour:
return IceCreamFlavour.STRAWBERRY
schema = strawberry.Schema(query=Query)
query = """
{
__type(name: "IceCreamFlavour") {
enumValues(includeDeprecated: true) {
name
isDeprecated
deprecationReason
}
}
}
"""
result = schema.execute_sync(query)
assert not result.errors
assert result.data
assert result.data["__type"]["enumValues"] == [
{"deprecationReason": None, "isDeprecated": False, "name": "VANILLA"},
{"deprecationReason": "We ran out", "isDeprecated": True, "name": "STRAWBERRY"},
{"deprecationReason": None, "isDeprecated": False, "name": "CHOCOLATE"},
]
def test_can_use_enum_values_in_input():
@strawberry.enum
class TestEnum(Enum):
A = "A"
B = strawberry.enum_value("B")
C = strawberry.enum_value("Coconut", deprecation_reason="We ran out")
@strawberry.type
class Query:
@strawberry.field
def receive_enum(self, test: TestEnum) -> str:
return str(test)
schema = strawberry.Schema(query=Query)
query = """
query {
a: receiveEnum(test: A)
b: receiveEnum(test: B)
c: receiveEnum(test: C)
}
"""
result = schema.execute_sync(query)
assert not result.errors
assert result.data
assert result.data["a"] == "TestEnum.A"
assert result.data["b"] == "TestEnum.B"
assert result.data["c"] == "TestEnum.C"
def test_can_give_custom_name_to_enum_value():
@strawberry.enum
class IceCreamFlavour(Enum):
VANILLA = "vanilla"
CHOCOLATE_COOKIE = strawberry.enum_value("chocolate", name="chocolateCookie")
@strawberry.type
class Query:
@strawberry.field
def best_flavour(self) -> IceCreamFlavour:
return IceCreamFlavour.CHOCOLATE_COOKIE
schema = strawberry.Schema(query=Query)
assert (
str(schema)
== dedent(
"""
enum IceCreamFlavour {
VANILLA
chocolateCookie
}
type Query {
bestFlavour: IceCreamFlavour!
}
"""
).strip()
)
query = """
{
bestFlavour
}
"""
result = schema.execute_sync(query)
assert not result.errors
assert result.data
assert result.data["bestFlavour"] == "chocolateCookie"
def test_can_use_enum_with_custom_name_as_input():
@strawberry.enum
class IceCreamFlavour(Enum):
VANILLA = "vanilla"
CHOCOLATE_COOKIE = strawberry.enum_value("chocolate", name="chocolateCookie")
@strawberry.type
class Query:
@strawberry.field
def get_flavour(self, flavour: IceCreamFlavour) -> str:
return flavour.name
schema = strawberry.Schema(query=Query)
assert (
str(schema)
== dedent(
"""
enum IceCreamFlavour {
VANILLA
chocolateCookie
}
type Query {
getFlavour(flavour: IceCreamFlavour!): String!
}
"""
).strip()
)
query = """
{
getFlavour(flavour: chocolateCookie)
}
"""
result = schema.execute_sync(query)
assert not result.errors
assert result.data
assert result.data["getFlavour"] == "CHOCOLATE_COOKIE"
|