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
|
# ruff: noqa: B904, BLE001, F811, PT012, A001
from enum import Enum
from typing import Annotated, Any, Optional, cast
import pytest
import strawberry
from django.db.models import Case, Count, Q, QuerySet, Value, When
from strawberry import auto
from strawberry.exceptions import MissingArgumentsAnnotationsError
from strawberry.relay import GlobalID
from strawberry.types import ExecutionResult, get_object_definition
from strawberry.types.base import WithStrawberryObjectDefinition, get_object_definition
from typing_extensions import Self
import strawberry_django
from strawberry_django.exceptions import (
ForbiddenFieldArgumentError,
MissingFieldArgumentError,
)
from strawberry_django.fields import filter_types
from strawberry_django.fields.field import StrawberryDjangoField
from strawberry_django.fields.filter_order import (
FilterOrderField,
FilterOrderFieldResolver,
filter_field,
)
from strawberry_django.filters import process_filters, resolve_value
from tests import models, utils
from tests.types import Fruit, FruitType, Vegetable
@strawberry.enum
class Version(Enum):
ONE = "first"
TWO = "second"
THREE = "third"
@strawberry_django.filter_type(models.Vegetable, lookups=True)
class VegetableFilter:
id: auto
name: auto
AND: Optional[list[Self]] = strawberry.UNSET
OR: Optional[list[Self]] = strawberry.UNSET
NOT: Optional[list[Self]] = strawberry.UNSET
@strawberry_django.filter_type(models.Color, lookups=True)
class ColorFilter:
id: auto
name: auto
@strawberry_django.filter_field
def name_simple(self, prefix: str, value: str):
return Q(**{f"{prefix}name": value})
@strawberry_django.filter_type(models.FruitType, lookups=True)
class FruitTypeFilter:
name: auto
fruits: Optional[
Annotated["FruitFilter", strawberry.lazy("tests.filters.test_filters_v2")]
]
@strawberry_django.filter_type(models.Fruit, lookups=True)
class FruitFilter:
color_id: auto
name: auto
sweetness: auto
types: Optional[FruitTypeFilter]
color: Optional[ColorFilter] = filter_field(filter_none=True)
@strawberry_django.filter_field
def types_number(
self,
info,
queryset: QuerySet,
prefix,
value: filter_types.ComparisonFilterLookup[int],
):
return process_filters(
cast("WithStrawberryObjectDefinition", value),
queryset.annotate(
count=Count(f"{prefix}types__id"),
count_nulls=Case(
When(count=0, then=Value(None)),
default="count",
),
),
info,
"count_nulls__",
)
@strawberry_django.filter_field
def double(
self,
queryset: QuerySet,
prefix,
value: bool,
):
return queryset.union(queryset, all=True), Q()
@strawberry_django.filter_field
def filter(self, info, queryset: QuerySet, prefix):
return process_filters(
cast("WithStrawberryObjectDefinition", self),
queryset.filter(~Q(**{f"{prefix}name": "DARK_BERRY"})),
info,
prefix,
skip_object_filter_method=True,
)
@strawberry.type
class Query:
types: list[FruitType] = strawberry_django.field(filters=FruitTypeFilter)
fruits: list[Fruit] = strawberry_django.field(filters=FruitFilter)
vegetables: list[Vegetable] = strawberry_django.field(filters=VegetableFilter)
@pytest.fixture
def query():
return utils.generate_query(Query)
@pytest.mark.parametrize(
("value", "resolved"),
[
(2, 2),
("something", "something"),
(GlobalID("", "24"), "24"),
(Version.ONE, Version.ONE.value),
(
[1, "str", GlobalID("", "24"), Version.THREE],
[1, "str", "24", Version.THREE.value],
),
],
)
def test_resolve_value(value, resolved):
assert resolve_value(value) == resolved
def test_filter_field_missing_prefix():
with pytest.raises(
MissingFieldArgumentError, match=r".*\"prefix\".*\"field_method\".*"
):
@strawberry_django.filter_field
def field_method():
pass
def test_filter_field_missing_value():
with pytest.raises(
MissingFieldArgumentError, match=r".*\"value\".*\"field_method\".*"
):
@strawberry_django.filter_field
def field_method(prefix):
pass
def test_filter_field_missing_value_annotation():
with pytest.raises(
MissingArgumentsAnnotationsError,
match=r"Missing annotation.*\"value\".*\"field_method\".*",
):
@strawberry_django.filter_field
def field_method(prefix, value):
pass
def test_filter_field():
try:
@strawberry_django.filter_field
def field_method(self, root, info, prefix, value: str, queryset):
pass
except Exception as exc:
raise pytest.fail(f"DID RAISE {exc}")
def test_filter_field_sequence():
with pytest.raises(
ForbiddenFieldArgumentError,
match=r".*\"sequence\".*\"field_method\".*",
):
@strawberry_django.filter_field
def field_method(prefix, value: auto, sequence, queryset):
pass
def test_filter_field_forbidden_param_annotation():
with pytest.raises(
MissingArgumentsAnnotationsError,
match=r".*\"forbidden_param\".*\"field_method\".*",
):
@strawberry_django.filter_field
def field_method(prefix, value: auto, queryset, forbidden_param):
pass
def test_filter_field_forbidden_param():
with pytest.raises(
ForbiddenFieldArgumentError,
match=r".*\"forbidden_param\".*\"field_method\".*",
):
@strawberry_django.filter_field
def field_method(prefix, value: auto, queryset, forbidden_param: str):
pass
def test_filter_field_missing_queryset():
with pytest.raises(
MissingFieldArgumentError, match=r".*\"queryset\".*\"filter\".*"
):
@strawberry_django.filter_field
def filter(prefix):
pass
def test_filter_field_value_forbidden_on_object():
with pytest.raises(ForbiddenFieldArgumentError, match=r".*\"value\".*\"filter\".*"):
@strawberry_django.filter_field
def field_method(prefix, queryset, value: auto):
pass
@strawberry_django.filter_field
def filter(prefix, queryset, value: auto):
pass
def test_filter_field_on_object():
try:
@strawberry_django.filter_field
def filter(self, root, info, prefix, queryset):
pass
except Exception as exc:
raise pytest.fail(f"DID RAISE {exc}")
def test_filter_field_method():
@strawberry_django.filter_type(models.Fruit)
class Filter:
@strawberry_django.order_field
def custom_filter(self, root, info, prefix, value: auto, queryset):
assert self == filter_, "Unexpected self passed"
assert root == filter_, "Unexpected root passed"
assert info == fake_info, "Unexpected info passed"
assert prefix == "ROOT", "Unexpected prefix passed"
assert value == "SOMETHING", "Unexpected value passed"
assert queryset == qs, "Unexpected queryset passed"
return Q(name=1)
filter_: Any = Filter(custom_filter="SOMETHING") # type: ignore
fake_info: Any = object()
qs: Any = object()
q_object = process_filters(filter_, qs, fake_info, prefix="ROOT")[1]
assert q_object, "Filter was not called"
def test_filter_object_method():
@strawberry_django.filters.filter_type(models.Fruit)
class Filter:
@strawberry_django.filter_field
def field_filter(self, value: str, prefix):
raise AssertionError("Never called due to object filter override")
@strawberry_django.filter_field
def filter(self, root, info, prefix, queryset):
assert self == filter_, "Unexpected self passed"
assert root == filter_, "Unexpected root passed"
assert info == fake_info, "Unexpected info passed"
assert prefix == "ROOT", "Unexpected prefix passed"
assert queryset == qs, "Unexpected queryset passed"
return queryset, Q(name=1)
filter_: Any = Filter()
fake_info: Any = object()
qs: Any = object()
q_object = process_filters(filter_, qs, fake_info, prefix="ROOT")[1]
assert q_object, "Filter was not called"
def test_filter_value_resolution():
@strawberry_django.filters.filter_type(models.Fruit)
class Filter:
id: Optional[strawberry_django.ComparisonFilterLookup[GlobalID]]
gid = GlobalID("FruitNode", "125")
filter_: Any = Filter(
id=strawberry_django.ComparisonFilterLookup(
exact=gid, range=strawberry_django.RangeLookup(start=gid, end=gid)
)
)
object_: Any = object()
q = process_filters(filter_, object_, object_)[1]
assert q == Q(id__exact="125", id__range=["125", "125"])
def test_filter_method_value_resolution():
@strawberry_django.filters.filter_type(models.Fruit)
class Filter:
@strawberry_django.filter_field(resolve_value=True)
def field_filter_resolved(self, value: GlobalID, prefix):
assert isinstance(value, str)
return Q()
@strawberry_django.filter_field
def field_filter_skip_resolved(self, value: GlobalID, prefix):
assert isinstance(value, GlobalID)
return Q()
gid = GlobalID("FruitNode", "125")
filter_: Any = Filter(field_filter_resolved=gid, field_filter_skip_resolved=gid) # type: ignore
object_: Any = object()
process_filters(filter_, object_, object_)
def test_filter_type():
@strawberry_django.filter_type(models.Fruit, lookups=True)
class FruitOrder:
id: auto
name: auto
sweetness: auto
@strawberry_django.filter_field
def custom_filter(self, value: str, prefix: str):
pass
@strawberry_django.filter_field
def custom_filter2(
self, value: filter_types.BaseFilterLookup[str], prefix: str
):
pass
assert [
(
f.name,
f.__class__,
f.type.of_type.__name__, # type: ignore
f.base_resolver.__class__ if f.base_resolver else None,
)
for f in get_object_definition(FruitOrder, strict=True).fields
if f.name not in {"NOT", "AND", "OR", "DISTINCT"}
] == [
("id", StrawberryDjangoField, "BaseFilterLookup", None),
("name", StrawberryDjangoField, "FilterLookup", None),
("sweetness", StrawberryDjangoField, "ComparisonFilterLookup", None),
(
"custom_filter",
FilterOrderField,
"str",
FilterOrderFieldResolver,
),
(
"custom_filter2",
FilterOrderField,
"BaseFilterLookup",
FilterOrderFieldResolver,
),
]
def test_filter_methods(query, db, fruits):
t1 = models.FruitType.objects.create(name="Type1")
t2 = models.FruitType.objects.create(name="Type2")
f1, f2, f3 = models.Fruit.objects.all()
_ = models.Fruit.objects.create(name="DARK_BERRY")
f2.types.add(t1)
f3.types.add(t1, t2)
result = query("""
{
fruits(filters: {
typesNumber: { gt: 1 }
NOT: { color: { nameSimple: "sample" } }
OR: {
typesNumber: { isNull: true }
}
}) { id } }
""")
assert not result.errors
assert result.data["fruits"] == [
{"id": str(f1.id)},
{"id": str(f3.id)},
]
def test_filter_distinct(query, db, fruits):
t1 = models.FruitType.objects.create(name="type_1")
t2 = models.FruitType.objects.create(name="type_2")
f1 = models.Fruit.objects.all()[0]
f1.types.add(t1, t2)
result = query("""
{
fruits(
filters: {types: { name: { iContains: "type" } } }
) { id name }
}
""")
assert not result.errors
assert len(result.data["fruits"]) == 2
result = query("""
{
fruits(
filters: {
DISTINCT: true,
types: { name: { iContains: "type" } }
}
) { id name }
}
""")
assert not result.errors
assert len(result.data["fruits"]) == 1
def test_filter_and_or_not(query, db):
v1 = models.Vegetable.objects.create(
name="v1", description="d1", world_production=100
)
v2 = models.Vegetable.objects.create(
name="v2", description="d2", world_production=200
)
v3 = models.Vegetable.objects.create(
name="v3", description="d3", world_production=300
)
# Test impossible AND
result = query("""
{
vegetables(filters: { AND: [{ name: { exact: "v1" } }, { name: { exact: "v2" } }] }) { id }
}
""")
assert not result.errors
assert len(result.data["vegetables"]) == 0
# Test AND with contains
result = query("""
{
vegetables(filters: { AND: [{ name: { contains: "v" } }, { name: { contains: "2" } }] }) { id }
}
""")
assert not result.errors
assert len(result.data["vegetables"]) == 1
assert result.data["vegetables"][0]["id"] == str(v2.pk)
# Test OR
result = query("""
{
vegetables(filters: { OR: [{ name: { exact: "v1" } }, { name: { exact: "v3" } }] }) { id }
}
""")
assert not result.errors
assert len(result.data["vegetables"]) == 2
assert {
result.data["vegetables"][0]["id"],
result.data["vegetables"][1]["id"],
} == {str(v1.pk), str(v3.pk)}
# Test NOT
result = query("""
{
vegetables(filters: { NOT: [{ name: { exact: "v1" } }, { name: { exact: "v2" } }] }) { id }
}
""")
assert not result.errors
assert len(result.data["vegetables"]) == 1
assert result.data["vegetables"][0]["id"] == str(v3.pk)
# Test interaction with simple filters. No matches due to AND logic relative to simple filters.
result = query(
"""
{
vegetables(filters: { id: { exact: """
+ str(v1.pk)
+ """ }, AND: [{ name: { exact: "v2" } }] }) { id }
}
"""
)
assert not result.errors
assert len(result.data["vegetables"]) == 0
# Test interaction with simple filters. Match on same record
result = query(
"""
{
vegetables(filters: { id: { exact: """
+ str(v1.pk)
+ """ }, AND: [{ name: { exact: "v1" } }] }) { id }
}
"""
)
assert not result.errors
assert len(result.data["vegetables"]) == 1
assert result.data["vegetables"][0]["id"] == str(v1.pk)
def test_filter_none(query, db):
yellow = models.Color.objects.create(name="yellow")
models.Fruit.objects.create(name="banana", color=yellow)
f1 = models.Fruit.objects.create(name="unknown")
f2 = models.Fruit.objects.create(name="unknown2")
result = query("""
{
fruits(filters: {color: null}) { id }
}
""")
assert not result.errors
assert result.data["fruits"] == [
{"id": str(f1.id)},
{"id": str(f2.id)},
]
def test_empty_resolver_filter():
@strawberry.type
class Query:
@strawberry.field
def fruits(self, filters: FruitFilter) -> list[Fruit]:
queryset = models.Fruit.objects.none()
info: Any = object()
return cast(
"list[Fruit]", strawberry_django.filters.apply(filters, queryset, info)
)
query = utils.generate_query(Query)
result = query('{ fruits(filters: { name: { exact: "strawberry" } }) { name } }')
assert isinstance(result, ExecutionResult)
assert not result.errors
assert result.data is not None
assert result.data["fruits"] == []
@pytest.mark.asyncio
@pytest.mark.django_db(transaction=True)
async def test_async_resolver_filter(fruits):
@strawberry.type
class Query:
@strawberry.field
async def fruits(self, filters: FruitFilter) -> list[Fruit]:
queryset = models.Fruit.objects.all()
info: Any = object()
queryset = strawberry_django.filters.apply(filters, queryset, info)
# cast fixes funny typing issue between list and List
return cast("list[Fruit]", [fruit async for fruit in queryset])
query = utils.generate_query(Query)
result = await query( # type: ignore
'{ fruits(filters: { name: { exact: "strawberry" } }) { name } }'
)
assert isinstance(result, ExecutionResult)
assert not result.errors
assert result.data is not None
assert result.data["fruits"] == [
{"name": "strawberry"},
]
|