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 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823
|
"""Tests for the DI module."""
from __future__ import annotations
import inspect
import unittest.mock
import uuid
from datetime import datetime, timedelta
from typing import TYPE_CHECKING, Any, cast
from unittest.mock import MagicMock, patch
from litestar import Litestar, get
from litestar.di import Provide
from litestar.openapi.config import OpenAPIConfig
from litestar.testing import TestClient
from sqlalchemy import FromClause, String, select
from sqlalchemy.orm import DeclarativeBase, Mapped, Mapper, mapped_column
from advanced_alchemy.extensions.litestar.plugins.init.plugin import signature_namespace_values
from advanced_alchemy.extensions.litestar.providers import (
DEPENDENCY_DEFAULTS,
DependencyCache,
DependencyDefaults,
FilterConfig,
SingletonMeta,
_create_filter_aggregate_function, # pyright: ignore[reportPrivateUsage]
_create_statement_filters, # pyright: ignore[reportPrivateUsage]
create_filter_dependencies,
create_service_dependencies,
create_service_provider,
dep_cache,
)
from advanced_alchemy.filters import (
BeforeAfter,
CollectionFilter,
FilterTypes,
LimitOffset,
NotInCollectionFilter,
OrderBy,
SearchFilter,
)
from advanced_alchemy.repository import SQLAlchemyAsyncRepository, SQLAlchemySyncRepository
from advanced_alchemy.service import (
SQLAlchemyAsyncRepositoryService,
SQLAlchemySyncRepositoryService,
)
from advanced_alchemy.types.identity import BigIntIdentity
from tests.helpers import anext_
class Base(DeclarativeBase):
"""Base class for models."""
if TYPE_CHECKING:
__name__: str # type: ignore
__table__: FromClause # type: ignore
__mapper__: Mapper[Any] # type: ignore
id: Mapped[int] = mapped_column(BigIntIdentity, primary_key=True)
def to_dict(self, exclude: set[str] | None = None) -> dict[str, Any]:
"""Convert model to dictionary.
Returns:
Dict[str, Any]: A dict representation of the model
"""
exclude = {"sa_orm_sentinel", "_sentinel"}.union(self._sa_instance_state.unloaded).union(exclude or []) # type: ignore[attr-defined]
return {field: getattr(self, field) for field in self.__mapper__.columns.keys() if field not in exclude}
class DITestModel(Base):
"""Test model for use in tests."""
__tablename__ = "di_test_model"
name: Mapped[str] = mapped_column(String)
class TestSyncService(SQLAlchemySyncRepositoryService[DITestModel]):
"""Test sync service class."""
class Repo(SQLAlchemySyncRepository[DITestModel]):
"""Test repo class."""
model_type = DITestModel
repository_type = Repo
class TestAsyncService(SQLAlchemyAsyncRepositoryService[DITestModel]):
"""Test async service class."""
class Repo(SQLAlchemyAsyncRepository[DITestModel]):
"""Test repo class."""
model_type = DITestModel
repository_type = Repo
def test_singleton_pattern() -> None:
"""Test that the SingletonMeta creates singletons."""
class TestClass(metaclass=SingletonMeta):
"""Test class using SingletonMeta."""
def __init__(self) -> None:
self.value = uuid.uuid4().hex
# Instances should be the same
instance1 = TestClass()
instance2 = TestClass()
assert instance1 is instance2
assert instance1.value == instance2.value
def test_multiple_classes() -> None:
"""Test that different classes using SingletonMeta have different instances."""
class TestClass1(metaclass=SingletonMeta):
"""First test class using SingletonMeta."""
def __init__(self) -> None:
self.value = 1
class TestClass2(metaclass=SingletonMeta):
"""Second test class using SingletonMeta."""
def __init__(self) -> None:
self.value = 2
instance1 = TestClass1()
instance2 = TestClass2()
assert instance1 is not instance2 # type: ignore
assert instance1.value != instance2.value
def test_add_get_dependencies() -> None:
"""Test adding and retrieving dependencies from cache."""
# Create a new instance to avoid test interference
with patch.dict(SingletonMeta._instances, {}, clear=True): # pyright: ignore[reportPrivateUsage]
cache = DependencyCache()
# Test with string key
deps1 = {"service": Provide(lambda: "service")}
cache.add_dependencies("key1", deps1)
assert cache.get_dependencies("key1") == deps1
# Test with integer key
deps2 = {"filter": Provide(lambda: "filter")}
cache.add_dependencies(123, deps2)
assert cache.get_dependencies(123) == deps2
# Test retrieving non-existent key
assert cache.get_dependencies("nonexistent") is None
def test_global_instance() -> None:
"""Test that the global dep_cache instance is a singleton."""
# Do not clear SingletonMeta._instances, so that dep_cache remains the global singleton
new_cache = DependencyCache()
assert new_cache is dep_cache
def test_create_sync_service_provider() -> None:
"""Test creating a sync service provider."""
provider = create_service_provider(TestSyncService)
# Ensure the provider is callable
assert callable(provider)
svc = next(provider(db_session=MagicMock()))
assert isinstance(svc, TestSyncService)
def test_create_sync_service_provider_custom() -> None:
"""Test creating a sync service provider."""
provider = create_service_provider(TestSyncService, config=MagicMock(session_dependency_key="testing_session"))
# Ensure the provider is callable
assert callable(provider)
svc = next(provider(testing_session=MagicMock()))
assert isinstance(svc, TestSyncService)
def test_create_sync_service_provider_positional() -> None:
"""Test creating an async service provider."""
provider = create_service_provider(TestSyncService, config=MagicMock(session_dependency_key="testing_session"))
# Ensure the provider is callable
assert callable(provider)
svc = next(provider(MagicMock()))
assert isinstance(svc, TestSyncService)
async def test_create_async_service_provider() -> None:
"""Test creating an async service provider."""
provider = create_service_provider(TestAsyncService)
# Ensure the provider is callable
assert callable(provider)
svc = await anext_(provider(db_session=MagicMock()))
assert isinstance(svc, TestAsyncService)
async def test_create_async_service_provider_custom() -> None:
"""Test creating an async service provider."""
provider = create_service_provider(TestAsyncService, config=MagicMock(session_dependency_key="testing_session"))
# Ensure the provider is callable
assert callable(provider)
svc = await anext_(provider(testing_session=MagicMock()))
assert isinstance(svc, TestAsyncService)
async def test_create_async_service_provider_positional() -> None:
"""Test creating an async service provider."""
provider = create_service_provider(TestAsyncService, config=MagicMock(session_dependency_key="testing_session"))
# Ensure the provider is callable
assert callable(provider)
svc = await anext_(provider(MagicMock()))
assert isinstance(svc, TestAsyncService)
def test_create_async_service_dependencies() -> None:
"""Test creating async service dependencies."""
with patch("advanced_alchemy.extensions.litestar.providers.create_service_provider") as mock_create_provider:
mock_create_provider.return_value = lambda: "async_service"
deps = create_service_dependencies(
TestAsyncService,
key="service",
statement=select(DITestModel),
config=MagicMock(),
)
assert "service" in deps
assert isinstance(deps["service"], Provide)
# Check provider function
assert deps["service"].dependency() == "async_service"
# Verify create_service_provider was called correctly
mock_create_provider.assert_called_once()
def test_create_sync_service_dependencies() -> None:
"""Test creating sync service dependencies."""
with patch("advanced_alchemy.extensions.litestar.providers.create_service_provider") as mock_create_provider:
mock_create_provider.return_value = lambda: "sync_service"
deps = create_service_dependencies(
TestSyncService,
key="service",
statement=select(DITestModel),
config=MagicMock(),
)
assert "service" in deps
assert isinstance(deps["service"], Provide)
# Check provider function
assert deps["service"].dependency() == "sync_service"
# Verify create_service_provider was called correctly
mock_create_provider.assert_called_once()
# Verify sync_to_thread is False for sync services
assert deps["service"].sync_to_thread is False
def test_create_service_dependencies_with_filters() -> None:
"""Test creating service dependencies with filters."""
with patch("advanced_alchemy.extensions.litestar.providers.create_service_provider") as mock_create_provider:
with patch("advanced_alchemy.extensions.litestar.providers.create_filter_dependencies") as mock_create_filters:
mock_create_provider.return_value = lambda: "service"
mock_create_filters.return_value = {"filter1": Provide(lambda: "filter1")}
deps = create_service_dependencies(
TestSyncService,
key="service",
filters={"id_filter": int},
)
assert "service" in deps
assert "filter1" in deps
# Verify create_filter_dependencies was called
mock_create_filters.assert_called_once_with({"id_filter": int}, DEPENDENCY_DEFAULTS)
def test_create_filter_dependencies_cache_hit() -> None:
"""Test create_filter_dependencies with cache hit."""
# Setup cache with a pre-existing entry
mock_deps = {"test": Provide(lambda: "test")}
with patch.object(dep_cache, "get_dependencies", return_value=mock_deps) as mock_get:
with patch.object(dep_cache, "add_dependencies") as mock_add:
config = cast(FilterConfig, {"key1": 1, "key2": 2})
deps = create_filter_dependencies(config)
# Verify cache was checked
mock_get.assert_called_once()
# Verify result is from cache
assert deps == mock_deps
# Verify cache wasn't updated
mock_add.assert_not_called()
def test_create_filter_dependencies_cache_miss() -> None:
"""Test create_filter_dependencies with cache miss."""
# Setup cache to return None (cache miss)
mock_deps = {"test": Provide(lambda: "test")}
with patch.object(dep_cache, "get_dependencies", return_value=None) as mock_get:
with patch.object(dep_cache, "add_dependencies") as mock_add:
with patch(
"advanced_alchemy.extensions.litestar.providers._create_statement_filters", return_value=mock_deps
) as mock_create:
config = cast(FilterConfig, {"key1": 1, "key2": 2})
deps = create_filter_dependencies(config)
# Verify cache was checked
mock_get.assert_called_once()
# Verify _create_statement_filters was called
mock_create.assert_called_once_with(config, DEPENDENCY_DEFAULTS)
# Verify cache was updated
mock_add.assert_called_once()
# Verify return value
assert deps == mock_deps
def test_id_filter() -> None:
"""Test creating ID filter dependency."""
config = cast(FilterConfig, {"id_filter": int})
deps = _create_statement_filters(config)
assert "id_filter" in deps
assert "filters" in deps
# Test the provider function
provider_func = deps["id_filter"].dependency
f = provider_func(ids=["1", "2", "3"])
assert isinstance(f, CollectionFilter)
assert f.field_name == "id"
assert f.values is not None # type: ignore
assert f.values == ["1", "2", "3"] # type: ignore
def test_created_at_filter() -> None:
"""Test creating created_at filter dependency."""
config = cast(FilterConfig, {"created_at": "created_at"})
deps = _create_statement_filters(config)
assert "created_filter" in deps
assert "filters" in deps
# Test the provider function
provider_func = deps["created_filter"].dependency
before = datetime.now()
later = datetime.now() + timedelta(days=1)
f = provider_func(before=before, after=later)
assert isinstance(f, BeforeAfter)
assert f.field_name == "created_at"
assert f.before == before
assert f.after == later
def test_updated_at_filter() -> None:
"""Test creating updated_at filter dependency."""
config = cast(FilterConfig, {"updated_at": "updated_at"})
deps = _create_statement_filters(config)
assert "updated_filter" in deps
assert "filters" in deps
# Test the provider function
provider_func = deps["updated_filter"].dependency
f = provider_func(before=datetime.now(), after=datetime.now())
assert isinstance(f, BeforeAfter)
assert f.field_name == "updated_at"
def test_search_filter() -> None:
"""Test creating search filter dependency."""
config = cast(FilterConfig, {"search": "name", "search_ignore_case": True})
deps = _create_statement_filters(config)
assert "search_filter" in deps
assert "filters" in deps
# Test the provider function
provider_func = deps["search_filter"].dependency
f = provider_func(search_string="test", ignore_case=True)
assert isinstance(f, SearchFilter)
assert f.field_name == "name" or f.field_name == {"name"}
assert f.value == "test"
assert f.ignore_case is True
def test_limit_offset_filter() -> None:
"""Test creating limit_offset filter dependency."""
config = cast(FilterConfig, {"pagination_type": "limit_offset", "default_limit": 10, "max_limit": 100})
deps = _create_statement_filters(config)
assert "limit_offset_filter" in deps
assert "filters" in deps
# Test the provider function
provider_func = deps["limit_offset_filter"].dependency
f = provider_func(current_page=2, page_size=5)
assert isinstance(f, LimitOffset)
assert f.limit == 5
assert f.offset == 5
def test_order_by_filter() -> None:
"""Test creating order_by filter dependency."""
config = cast(FilterConfig, {"sort_field": "name"})
deps = _create_statement_filters(config)
assert "order_by_filter" in deps
assert "filters" in deps
# Test the provider function
provider_func = deps["order_by_filter"].dependency
f = provider_func(field_name="name", sort_order="desc")
assert isinstance(f, OrderBy)
assert f.field_name == "name"
assert f.sort_order == "desc"
def test_not_in_filter() -> None:
"""Test creating not_in filter dependency."""
deps = _create_statement_filters({"not_in_fields": ["status"]})
assert "status_not_in_filter" in deps
assert "filters" in deps
# Test the provider function
provider_func = deps["status_not_in_filter"].dependency
f = provider_func(values=["pending", "failed"])
assert isinstance(f, NotInCollectionFilter)
assert f.field_name == "status"
assert f.values == ["pending", "failed"]
# Test with None
f_none = provider_func(values=None)
assert f_none is None
def test_in_filter() -> None:
"""Test creating in filter dependency."""
deps = _create_statement_filters({"in_fields": ["tag"]})
assert "tag_in_filter" in deps
assert "filters" in deps
# Test the provider function
provider_func = deps["tag_in_filter"].dependency
f = provider_func(values=["python", "litestar"])
assert isinstance(f, CollectionFilter)
assert f.field_name == "tag"
assert f.values == ["python", "litestar"]
# Test with None
f_none = provider_func(values=None)
assert f_none is None
def test_custom_dependency_defaults() -> None:
"""Test using custom dependency defaults."""
class CustomDefaults(DependencyDefaults):
"""Custom dependency defaults."""
LIMIT_OFFSET_FILTER_DEPENDENCY_KEY = "page"
ID_FILTER_DEPENDENCY_KEY = "ids"
DEFAULT_PAGINATION_SIZE = 100
custom_defaults = CustomDefaults()
config = cast(FilterConfig, {"id_filter": int, "id_field": "custom_id", "pagination_type": "limit_offset"})
deps = _create_statement_filters(config, custom_defaults)
assert "ids" in deps
assert "page" in deps
assert "filters" in deps
ids_func = deps["ids"].dependency
f = ids_func(ids=["1", "2", "3"])
assert isinstance(f, CollectionFilter) # type: ignore
assert f.field_name == "custom_id"
assert f.values is not None # type: ignore
assert f.values == ["1", "2", "3"] # type: ignore
page_func = deps["page"].dependency
f: LimitOffset = page_func(current_page=2, page_size=5) # type: ignore
assert isinstance(f, LimitOffset)
assert f.limit == 5
assert f.offset == 5
def test_id_filter_aggregation() -> None:
"""Test aggregation with ID filter."""
config = cast(FilterConfig, {"id_filter": str})
aggregate_func = _create_filter_aggregate_function(config)
# Check signature
sig = inspect.signature(aggregate_func)
assert "id_filter" in sig.parameters
# Simulate calling with filter
mock_filter = MagicMock(spec=CollectionFilter)
result = aggregate_func(id_filter=mock_filter)
assert isinstance(result, list)
assert mock_filter in result
def test_created_at_filter_aggregation() -> None:
"""Test aggregation with created_at filter."""
aggregate_func = _create_filter_aggregate_function({"created_at": True})
# Check signature
sig = inspect.signature(aggregate_func)
assert "created_filter" in sig.parameters
# Simulate calling with filter
mock_filter = MagicMock(spec=BeforeAfter)
result = aggregate_func(created_filter=mock_filter)
assert isinstance(result, list)
assert mock_filter in result
def test_updated_at_filter_aggregation() -> None:
"""Test aggregation with updated_at filter."""
aggregate_func = _create_filter_aggregate_function({"updated_at": True})
# Check signature
sig = inspect.signature(aggregate_func)
assert "updated_filter" in sig.parameters
# Simulate calling with filter
mock_filter = MagicMock(spec=BeforeAfter)
result = aggregate_func(updated_filter=mock_filter)
assert isinstance(result, list)
assert mock_filter in result
def test_search_filter_aggregation() -> None:
"""Test aggregation with search filter."""
aggregate_func = _create_filter_aggregate_function({"search": ["name"]})
# Check signature
sig = inspect.signature(aggregate_func)
assert "search_filter" in sig.parameters
# Mock search filter with valid attributes
mock_filter = MagicMock(spec=SearchFilter)
mock_filter.field_name = "name"
mock_filter.value = "test"
result = aggregate_func(search_filter=mock_filter)
assert isinstance(result, list)
assert mock_filter in result
# Test with invalid search filter (None value)
mock_filter.value = None
result = aggregate_func(search_filter=mock_filter)
assert mock_filter not in result
def test_limit_offset_filter_aggregation() -> None:
"""Test aggregation with limit_offset filter."""
aggregate_func = _create_filter_aggregate_function({"pagination_type": "limit_offset"})
# Check signature
sig = inspect.signature(aggregate_func)
assert "limit_offset_filter" in sig.parameters
# Simulate calling with filter
mock_filter = MagicMock(spec=LimitOffset)
result = aggregate_func(limit_offset_filter=mock_filter)
assert isinstance(result, list)
assert mock_filter in result
def test_order_by_filter_aggregation() -> None:
"""Test aggregation with order_by filter."""
aggregate_func = _create_filter_aggregate_function({"sort_field": "name"})
# Check signature
sig = inspect.signature(aggregate_func)
assert "order_by_filter" in sig.parameters
# Mock order_by filter with valid field_name
mock_filter = MagicMock(spec=OrderBy)
mock_filter.field_name = "name"
result = aggregate_func(order_by_filter=mock_filter)
assert isinstance(result, list)
assert mock_filter in result
# Test with invalid order_by filter (None field_name)
mock_filter.field_name = None
result = aggregate_func(order_by_filter=mock_filter)
assert mock_filter not in result
def test_not_in_filter_aggregation() -> None:
"""Test aggregation with not_in filter."""
aggregate_func = _create_filter_aggregate_function({"not_in_fields": ["status"]})
# Check signature
sig = inspect.signature(aggregate_func)
assert "status_not_in_filter" in sig.parameters
# Simulate calling with filter
mock_filter = MagicMock(spec=NotInCollectionFilter)
result = aggregate_func(status_not_in_filter=mock_filter)
assert isinstance(result, list)
assert mock_filter in result
# Simulate calling without filter (value is None)
result_none = aggregate_func(status_not_in_filter=None)
assert mock_filter not in result_none
def test_in_filter_aggregation() -> None:
"""Test aggregation with in filter."""
config = cast(FilterConfig, {"in_fields": ["tag"]})
aggregate_func = _create_filter_aggregate_function(config)
# Check signature
sig = inspect.signature(aggregate_func)
assert "tag_in_filter" in sig.parameters
# Simulate calling with filter
mock_filter = MagicMock(spec=CollectionFilter)
result = aggregate_func(tag_in_filter=mock_filter)
assert isinstance(result, list)
assert mock_filter in result
# Simulate calling without filter (value is None)
result_none = aggregate_func(tag_in_filter=None)
assert mock_filter not in result_none
def test_multiple_filters_aggregation() -> None:
"""Test aggregation with multiple filters."""
aggregate_func = _create_filter_aggregate_function(
{
"id_filter": int,
"created_at": True,
"updated_at": True,
"search": "name",
"pagination_type": "limit_offset",
"sort_field": "name",
"not_in_fields": ["status"],
"in_fields": ["tag"],
}
)
# Check signature has all parameters
sig = inspect.signature(aggregate_func)
assert "id_filter" in sig.parameters
assert "created_filter" in sig.parameters
assert "updated_filter" in sig.parameters
assert "search_filter" in sig.parameters
assert "limit_offset_filter" in sig.parameters
assert "order_by_filter" in sig.parameters
assert "status_not_in_filter" in sig.parameters
assert "tag_in_filter" in sig.parameters
# Simulate calling with multiple filters
mock_id_filter = MagicMock(spec=CollectionFilter)
mock_created_filter = MagicMock(spec=BeforeAfter)
mock_updated_filter = MagicMock(spec=BeforeAfter)
mock_search_filter = MagicMock(spec=SearchFilter)
mock_search_filter.field_name = "name"
mock_search_filter.value = "test"
mock_limit_offset = MagicMock(spec=LimitOffset)
mock_order_by_filter = MagicMock(spec=OrderBy)
mock_order_by_filter.field_name = "name"
mock_not_in_filter = MagicMock(spec=NotInCollectionFilter)
mock_in_filter = MagicMock(spec=CollectionFilter)
result = aggregate_func(
id_filter=mock_id_filter,
created_filter=mock_created_filter,
updated_filter=mock_updated_filter,
search_filter=mock_search_filter,
limit_offset_filter=mock_limit_offset,
order_by_filter=mock_order_by_filter,
status_not_in_filter=mock_not_in_filter,
tag_in_filter=mock_in_filter,
)
# Verify all filters are included
assert len(result) == 8
assert mock_id_filter in result
assert mock_created_filter in result
assert mock_updated_filter in result
assert mock_search_filter in result
assert mock_limit_offset in result
assert mock_order_by_filter in result
assert mock_not_in_filter in result
assert mock_in_filter in result
@unittest.mock.patch(
"advanced_alchemy.extensions.litestar.providers.create_filter_dependencies",
wraps=create_filter_dependencies, # Call the original function logic
)
def test_litestar_openapi_schema(mock_create_filters: unittest.mock.MagicMock) -> None:
"""Test OpenAPI schema generation for filter dependencies."""
filter_config = {
"id_filter": uuid.UUID, # Example using UUID
"id_field": "guid",
"created_at": True,
"updated_at": True,
"pagination_type": "limit_offset",
"pagination_size": 25,
"search": "name,description",
"search_ignore_case": True,
"sort_field": "name",
"sort_order": "asc",
"not_in_fields": ["status", "category"],
"in_fields": ["tag", "region"],
}
# Call the mocked function, which wraps the original
filter_dependencies = mock_create_filters(filter_config)
@get("/test")
async def test_handler(filters: list[FilterTypes]) -> list[str]:
"""Dummy handler to test schema generation."""
return [type(f).__name__ for f in filters]
app = Litestar(
route_handlers=[test_handler],
signature_namespace=signature_namespace_values,
dependencies=filter_dependencies, # Provide all dependencies to the app
openapi_config=OpenAPIConfig(
title="Test API", version="1.0.0", use_handler_docstrings=True, path="/schema"
), # Explicitly enable OpenAPI with specific path
)
client = TestClient(app)
# Fetch the OpenAPI schema (using the exact path from Litestar's default config)
response = client.get("/schema/openapi.json")
assert response.status_code == 200, (
f"Failed to get schema, status: {response.status_code}, content: {response.text[:200]}"
)
schema = response.json()
# Find the parameters for the /test endpoint
path_item = schema.get("paths", {}).get("/test", {}).get("get", {})
parameters = path_item.get("parameters", [])
# Assert all expected parameter names are present
param_names = {p["name"] for p in parameters}
expected_params = {
"ids", # from id_filter, alias based on id_field 'guid' might not be reflected here, Litestar uses parameter name
"createdBefore",
"createdAfter",
"updatedBefore",
"updatedAfter",
"currentPage",
"pageSize",
"searchString",
"searchIgnoreCase",
"orderBy",
"sortOrder",
"statusNotIn",
"categoryNotIn",
"tagIn",
"regionIn",
}
assert param_names == expected_params
# Check details of specific parameters
# ids (based on id_filter: uuid.UUID)
ids_param = next(p for p in parameters if p["name"] == "ids")
assert ids_param["in"] == "query"
assert ids_param["required"] is False
assert "oneOf" in ids_param["schema"]
assert len(ids_param["schema"]["oneOf"]) == 2
array_schema = ids_param["schema"]["oneOf"][0]
assert array_schema["type"] == "array"
assert array_schema["items"]["type"] == "string"
# createdBefore (datetime parameter)
created_before_param = next(p for p in parameters if p["name"] == "createdBefore")
assert created_before_param["in"] == "query"
assert created_before_param["required"] is False
assert "oneOf" in created_before_param["schema"]
date_schema = created_before_param["schema"]["oneOf"][0]
assert date_schema["type"] == "string"
assert date_schema["format"] == "date-time"
# Check in and not_in parameters
status_not_in_param = next(p for p in parameters if p["name"] == "statusNotIn")
assert status_not_in_param["in"] == "query"
assert status_not_in_param["required"] is False
assert "oneOf" in status_not_in_param["schema"]
tag_in_param = next(p for p in parameters if p["name"] == "tagIn")
assert tag_in_param["in"] == "query"
assert tag_in_param["required"] is False
assert "oneOf" in tag_in_param["schema"]
|