Files
fastapi-toolsets/tests/test_crud.py
d3vyce 9d07dfea85 feat: add opt-in default_load_options parameter in CrudFactory (#82)
* feat: add opt-in default_load_options parameter in CrudFactory

* docs: add Relationship loading in CRUD
2026-02-21 12:35:15 +01:00

1347 lines
46 KiB
Python

"""Tests for fastapi_toolsets.crud module."""
import uuid
import pytest
from sqlalchemy.ext.asyncio import AsyncSession
from sqlalchemy.orm import selectinload
from fastapi_toolsets.crud import CrudFactory
from fastapi_toolsets.crud.factory import AsyncCrud
from fastapi_toolsets.exceptions import NotFoundError
from .conftest import (
Post,
PostCreate,
PostCrud,
PostM2MCreate,
PostM2MCrud,
PostM2MUpdate,
Role,
RoleCreate,
RoleCrud,
RoleUpdate,
TagCreate,
TagCrud,
User,
UserCreate,
UserCrud,
UserUpdate,
)
class TestCrudFactory:
"""Tests for CrudFactory."""
def test_creates_crud_class(self):
"""CrudFactory creates a properly configured CRUD class."""
crud = CrudFactory(User)
assert issubclass(crud, AsyncCrud)
assert crud.model is User
def test_creates_unique_classes(self):
"""Each call creates a unique class."""
crud1 = CrudFactory(User)
crud2 = CrudFactory(User)
assert crud1 is not crud2
def test_class_name_includes_model(self):
"""Generated class name includes model name."""
crud = CrudFactory(User)
assert "User" in crud.__name__
def test_default_load_options_none_by_default(self):
"""default_load_options is None when not specified."""
crud = CrudFactory(User)
assert crud.default_load_options is None
def test_default_load_options_set(self):
"""default_load_options is stored on the class."""
options = [selectinload(User.role)]
crud = CrudFactory(User, default_load_options=options)
assert crud.default_load_options == options
def test_default_load_options_not_shared_between_classes(self):
"""default_load_options is isolated per factory call."""
options = [selectinload(User.role)]
crud_with = CrudFactory(User, default_load_options=options)
crud_without = CrudFactory(User)
assert crud_with.default_load_options == options
assert crud_without.default_load_options is None
class TestResolveLoadOptions:
"""Tests for _resolve_load_options logic."""
def test_returns_load_options_when_provided(self):
"""Explicit load_options takes priority over default_load_options."""
options = [selectinload(User.role)]
default = [selectinload(Post.tags)]
crud = CrudFactory(User, default_load_options=default)
assert crud._resolve_load_options(options) == options
def test_returns_default_when_load_options_is_none(self):
"""Falls back to default_load_options when load_options is None."""
default = [selectinload(User.role)]
crud = CrudFactory(User, default_load_options=default)
assert crud._resolve_load_options(None) == default
def test_returns_none_when_both_are_none(self):
"""Returns None when neither load_options nor default_load_options set."""
crud = CrudFactory(User)
assert crud._resolve_load_options(None) is None
def test_empty_list_overrides_default(self):
"""An empty list is a valid override and disables default_load_options."""
default = [selectinload(User.role)]
crud = CrudFactory(User, default_load_options=default)
# Empty list is not None, so it should replace default
assert crud._resolve_load_options([]) == []
class TestDefaultLoadOptionsIntegration:
"""Integration tests for default_load_options with real DB queries."""
@pytest.mark.anyio
async def test_default_load_options_applied_to_get(self, db_session: AsyncSession):
"""default_load_options loads relationships automatically on get()."""
UserWithDefaultLoad = CrudFactory(
User, default_load_options=[selectinload(User.role)]
)
role = await RoleCrud.create(db_session, RoleCreate(name="admin"))
user = await UserCrud.create(
db_session,
UserCreate(username="alice", email="alice@test.com", role_id=role.id),
)
fetched = await UserWithDefaultLoad.get(db_session, [User.id == user.id])
assert fetched.role is not None
assert fetched.role.name == "admin"
@pytest.mark.anyio
async def test_default_load_options_applied_to_get_multi(
self, db_session: AsyncSession
):
"""default_load_options loads relationships automatically on get_multi()."""
UserWithDefaultLoad = CrudFactory(
User, default_load_options=[selectinload(User.role)]
)
role = await RoleCrud.create(db_session, RoleCreate(name="admin"))
await UserCrud.create(
db_session,
UserCreate(username="alice", email="alice@test.com", role_id=role.id),
)
users = await UserWithDefaultLoad.get_multi(db_session)
assert users[0].role is not None
assert users[0].role.name == "admin"
@pytest.mark.anyio
async def test_default_load_options_applied_to_first(
self, db_session: AsyncSession
):
"""default_load_options loads relationships automatically on first()."""
UserWithDefaultLoad = CrudFactory(
User, default_load_options=[selectinload(User.role)]
)
role = await RoleCrud.create(db_session, RoleCreate(name="admin"))
await UserCrud.create(
db_session,
UserCreate(username="alice", email="alice@test.com", role_id=role.id),
)
user = await UserWithDefaultLoad.first(db_session)
assert user is not None
assert user.role is not None
assert user.role.name == "admin"
@pytest.mark.anyio
async def test_default_load_options_applied_to_paginate(
self, db_session: AsyncSession
):
"""default_load_options loads relationships automatically on paginate()."""
UserWithDefaultLoad = CrudFactory(
User, default_load_options=[selectinload(User.role)]
)
role = await RoleCrud.create(db_session, RoleCreate(name="admin"))
await UserCrud.create(
db_session,
UserCreate(username="alice", email="alice@test.com", role_id=role.id),
)
result = await UserWithDefaultLoad.paginate(db_session)
assert result.data[0].role is not None
assert result.data[0].role.name == "admin"
@pytest.mark.anyio
async def test_load_options_overrides_default_load_options(
self, db_session: AsyncSession
):
"""Explicit load_options fully replaces default_load_options."""
PostWithDefaultLoad = CrudFactory(
Post,
default_load_options=[selectinload(Post.tags)],
)
user = await UserCrud.create(
db_session,
UserCreate(username="alice", email="alice@test.com"),
)
post = await PostCrud.create(
db_session,
PostCreate(title="Hello", author_id=user.id),
)
# Pass empty load_options to override default — tags should not load
fetched = await PostWithDefaultLoad.get(
db_session,
[Post.id == post.id],
load_options=[],
)
# tags were not loaded — accessing them would lazy-load or return empty
# We just assert the fetch itself succeeded with the override
assert fetched.id == post.id
class TestCrudCreate:
"""Tests for CRUD create operations."""
@pytest.mark.anyio
async def test_create_single_record(self, db_session: AsyncSession):
"""Create a single record."""
data = RoleCreate(name="admin")
role = await RoleCrud.create(db_session, data)
assert role.id is not None
assert role.name == "admin"
@pytest.mark.anyio
async def test_create_with_relationship(self, db_session: AsyncSession):
"""Create records with foreign key relationships."""
role = await RoleCrud.create(db_session, RoleCreate(name="user"))
user_data = UserCreate(
username="john",
email="john@example.com",
role_id=role.id,
)
user = await UserCrud.create(db_session, user_data)
assert user.role_id == role.id
@pytest.mark.anyio
async def test_create_with_defaults(self, db_session: AsyncSession):
"""Create uses model defaults."""
user_data = UserCreate(username="jane", email="jane@example.com")
user = await UserCrud.create(db_session, user_data)
assert user.is_active is True
class TestCrudGet:
"""Tests for CRUD get operations."""
@pytest.mark.anyio
async def test_get_existing_record(self, db_session: AsyncSession):
"""Get an existing record by filter."""
created = await RoleCrud.create(db_session, RoleCreate(name="admin"))
fetched = await RoleCrud.get(db_session, [Role.id == created.id])
assert fetched.id == created.id
assert fetched.name == "admin"
@pytest.mark.anyio
async def test_get_raises_not_found(self, db_session: AsyncSession):
"""Get raises NotFoundError for missing records."""
non_existent_id = uuid.uuid4()
with pytest.raises(NotFoundError):
await RoleCrud.get(db_session, [Role.id == non_existent_id])
@pytest.mark.anyio
async def test_get_with_multiple_filters(self, db_session: AsyncSession):
"""Get with multiple filter conditions."""
await UserCrud.create(
db_session,
UserCreate(username="active", email="active@test.com", is_active=True),
)
await UserCrud.create(
db_session,
UserCreate(username="inactive", email="inactive@test.com", is_active=False),
)
user = await UserCrud.get(
db_session,
[User.username == "active", User.is_active == True], # noqa: E712
)
assert user.username == "active"
class TestCrudFirst:
"""Tests for CRUD first operations."""
@pytest.mark.anyio
async def test_first_returns_record(self, db_session: AsyncSession):
"""First returns the first matching record."""
await RoleCrud.create(db_session, RoleCreate(name="admin"))
role = await RoleCrud.first(db_session, [Role.name == "admin"])
assert role is not None
assert role.name == "admin"
@pytest.mark.anyio
async def test_first_returns_none_when_not_found(self, db_session: AsyncSession):
"""First returns None for missing records."""
role = await RoleCrud.first(db_session, [Role.name == "nonexistent"])
assert role is None
@pytest.mark.anyio
async def test_first_without_filters(self, db_session: AsyncSession):
"""First without filters returns any record."""
await RoleCrud.create(db_session, RoleCreate(name="role1"))
await RoleCrud.create(db_session, RoleCreate(name="role2"))
role = await RoleCrud.first(db_session)
assert role is not None
class TestCrudGetMulti:
"""Tests for CRUD get_multi operations."""
@pytest.mark.anyio
async def test_get_multi_returns_all(self, db_session: AsyncSession):
"""Get multiple records."""
await RoleCrud.create(db_session, RoleCreate(name="admin"))
await RoleCrud.create(db_session, RoleCreate(name="user"))
await RoleCrud.create(db_session, RoleCreate(name="guest"))
roles = await RoleCrud.get_multi(db_session)
assert len(roles) == 3
@pytest.mark.anyio
async def test_get_multi_with_filters(self, db_session: AsyncSession):
"""Get multiple with filter."""
await UserCrud.create(
db_session,
UserCreate(username="active1", email="a1@test.com", is_active=True),
)
await UserCrud.create(
db_session,
UserCreate(username="active2", email="a2@test.com", is_active=True),
)
await UserCrud.create(
db_session,
UserCreate(username="inactive", email="i@test.com", is_active=False),
)
active_users = await UserCrud.get_multi(
db_session,
filters=[User.is_active == True], # noqa: E712
)
assert len(active_users) == 2
@pytest.mark.anyio
async def test_get_multi_with_limit(self, db_session: AsyncSession):
"""Get multiple with limit."""
for i in range(5):
await RoleCrud.create(db_session, RoleCreate(name=f"role{i}"))
roles = await RoleCrud.get_multi(db_session, limit=3)
assert len(roles) == 3
@pytest.mark.anyio
async def test_get_multi_with_offset(self, db_session: AsyncSession):
"""Get multiple with offset."""
for i in range(5):
await RoleCrud.create(db_session, RoleCreate(name=f"role{i}"))
roles = await RoleCrud.get_multi(db_session, offset=2)
assert len(roles) == 3
@pytest.mark.anyio
async def test_get_multi_with_order_by(self, db_session: AsyncSession):
"""Get multiple with ordering."""
await RoleCrud.create(db_session, RoleCreate(name="charlie"))
await RoleCrud.create(db_session, RoleCreate(name="alpha"))
await RoleCrud.create(db_session, RoleCreate(name="bravo"))
roles = await RoleCrud.get_multi(db_session, order_by=Role.name)
names = [r.name for r in roles]
assert names == ["alpha", "bravo", "charlie"]
class TestCrudUpdate:
"""Tests for CRUD update operations."""
@pytest.mark.anyio
async def test_update_record(self, db_session: AsyncSession):
"""Update an existing record."""
role = await RoleCrud.create(db_session, RoleCreate(name="old_name"))
updated = await RoleCrud.update(
db_session,
RoleUpdate(name="new_name"),
[Role.id == role.id],
)
assert updated.name == "new_name"
assert updated.id == role.id
@pytest.mark.anyio
async def test_update_raises_not_found(self, db_session: AsyncSession):
"""Update raises NotFoundError for missing records."""
non_existent_id = uuid.uuid4()
with pytest.raises(NotFoundError):
await RoleCrud.update(
db_session,
RoleUpdate(name="new"),
[Role.id == non_existent_id],
)
@pytest.mark.anyio
async def test_update_excludes_unset(self, db_session: AsyncSession):
"""Update excludes unset fields by default."""
user = await UserCrud.create(
db_session,
UserCreate(username="john", email="john@test.com", is_active=True),
)
updated = await UserCrud.update(
db_session,
UserUpdate(username="johnny"),
[User.id == user.id],
)
assert updated.username == "johnny"
assert updated.email == "john@test.com"
assert updated.is_active is True
class TestCrudDelete:
"""Tests for CRUD delete operations."""
@pytest.mark.anyio
async def test_delete_record(self, db_session: AsyncSession):
"""Delete an existing record."""
role = await RoleCrud.create(db_session, RoleCreate(name="to_delete"))
result = await RoleCrud.delete(db_session, [Role.id == role.id])
assert result is True
assert await RoleCrud.first(db_session, [Role.id == role.id]) is None
@pytest.mark.anyio
async def test_delete_multiple_records(self, db_session: AsyncSession):
"""Delete multiple records with filter."""
await UserCrud.create(
db_session,
UserCreate(username="u1", email="u1@test.com", is_active=False),
)
await UserCrud.create(
db_session,
UserCreate(username="u2", email="u2@test.com", is_active=False),
)
await UserCrud.create(
db_session,
UserCreate(username="u3", email="u3@test.com", is_active=True),
)
await UserCrud.delete(db_session, [User.is_active == False]) # noqa: E712
remaining = await UserCrud.get_multi(db_session)
assert len(remaining) == 1
assert remaining[0].username == "u3"
class TestCrudExists:
"""Tests for CRUD exists operations."""
@pytest.mark.anyio
async def test_exists_returns_true(self, db_session: AsyncSession):
"""Exists returns True for existing records."""
await RoleCrud.create(db_session, RoleCreate(name="admin"))
assert await RoleCrud.exists(db_session, [Role.name == "admin"]) is True
@pytest.mark.anyio
async def test_exists_returns_false(self, db_session: AsyncSession):
"""Exists returns False for missing records."""
assert await RoleCrud.exists(db_session, [Role.name == "nonexistent"]) is False
class TestCrudCount:
"""Tests for CRUD count operations."""
@pytest.mark.anyio
async def test_count_all(self, db_session: AsyncSession):
"""Count all records."""
await RoleCrud.create(db_session, RoleCreate(name="role1"))
await RoleCrud.create(db_session, RoleCreate(name="role2"))
await RoleCrud.create(db_session, RoleCreate(name="role3"))
count = await RoleCrud.count(db_session)
assert count == 3
@pytest.mark.anyio
async def test_count_with_filter(self, db_session: AsyncSession):
"""Count records with filter."""
await UserCrud.create(
db_session,
UserCreate(username="a1", email="a1@test.com", is_active=True),
)
await UserCrud.create(
db_session,
UserCreate(username="a2", email="a2@test.com", is_active=True),
)
await UserCrud.create(
db_session,
UserCreate(username="i1", email="i1@test.com", is_active=False),
)
active_count = await UserCrud.count(
db_session,
filters=[User.is_active == True], # noqa: E712
)
assert active_count == 2
class TestCrudUpsert:
"""Tests for CRUD upsert operations (PostgreSQL-specific)."""
@pytest.mark.anyio
async def test_upsert_insert_new_record(self, db_session: AsyncSession):
"""Upsert inserts a new record when it doesn't exist."""
role_id = uuid.uuid4()
data = RoleCreate(id=role_id, name="upsert_new")
role = await RoleCrud.upsert(
db_session,
data,
index_elements=["id"],
)
assert role is not None
assert role.name == "upsert_new"
@pytest.mark.anyio
async def test_upsert_update_existing_record(self, db_session: AsyncSession):
"""Upsert updates an existing record."""
role_id = uuid.uuid4()
# First insert
data = RoleCreate(id=role_id, name="original_name")
await RoleCrud.upsert(db_session, data, index_elements=["id"])
# Upsert with update
updated_data = RoleCreate(id=role_id, name="updated_name")
role = await RoleCrud.upsert(
db_session,
updated_data,
index_elements=["id"],
set_=RoleUpdate(name="updated_name"),
)
assert role is not None
assert role.name == "updated_name"
# Verify only one record exists
count = await RoleCrud.count(db_session, [Role.id == role_id])
assert count == 1
@pytest.mark.anyio
async def test_upsert_do_nothing_on_conflict(self, db_session: AsyncSession):
"""Upsert does nothing on conflict when set_ is not provided."""
role_id = uuid.uuid4()
# First insert
data = RoleCreate(id=role_id, name="do_nothing_original")
await RoleCrud.upsert(db_session, data, index_elements=["id"])
# Upsert without set_ (do nothing)
conflict_data = RoleCreate(id=role_id, name="do_nothing_conflict")
await RoleCrud.upsert(db_session, conflict_data, index_elements=["id"])
# Original value should be preserved
role = await RoleCrud.first(db_session, [Role.id == role_id])
assert role is not None
assert role.name == "do_nothing_original"
@pytest.mark.anyio
async def test_upsert_with_unique_constraint(self, db_session: AsyncSession):
"""Upsert works with unique constraint columns."""
# Insert first role
data1 = RoleCreate(name="unique_role")
await RoleCrud.upsert(db_session, data1, index_elements=["name"])
# Upsert with same name - should update (or do nothing)
data2 = RoleCreate(name="unique_role")
role = await RoleCrud.upsert(db_session, data2, index_elements=["name"])
assert role is not None
assert role.name == "unique_role"
# Should still be only one record
count = await RoleCrud.count(db_session, [Role.name == "unique_role"])
assert count == 1
class TestCrudPaginate:
"""Tests for CRUD pagination."""
@pytest.mark.anyio
async def test_paginate_first_page(self, db_session: AsyncSession):
"""Paginate returns first page."""
for i in range(25):
await RoleCrud.create(db_session, RoleCreate(name=f"role{i:02d}"))
result = await RoleCrud.paginate(db_session, page=1, items_per_page=10)
assert len(result.data) == 10
assert result.pagination.total_count == 25
assert result.pagination.page == 1
assert result.pagination.items_per_page == 10
assert result.pagination.has_more is True
@pytest.mark.anyio
async def test_paginate_last_page(self, db_session: AsyncSession):
"""Paginate returns last page with has_more=False."""
for i in range(25):
await RoleCrud.create(db_session, RoleCreate(name=f"role{i:02d}"))
result = await RoleCrud.paginate(db_session, page=3, items_per_page=10)
assert len(result.data) == 5
assert result.pagination.has_more is False
@pytest.mark.anyio
async def test_paginate_with_filters(self, db_session: AsyncSession):
"""Paginate with filter conditions."""
for i in range(10):
await UserCrud.create(
db_session,
UserCreate(
username=f"user{i}",
email=f"user{i}@test.com",
is_active=i % 2 == 0,
),
)
result = await UserCrud.paginate(
db_session,
filters=[User.is_active == True], # noqa: E712
page=1,
items_per_page=10,
)
assert result.pagination.total_count == 5
@pytest.mark.anyio
async def test_paginate_with_ordering(self, db_session: AsyncSession):
"""Paginate with custom ordering."""
await RoleCrud.create(db_session, RoleCreate(name="charlie"))
await RoleCrud.create(db_session, RoleCreate(name="alpha"))
await RoleCrud.create(db_session, RoleCreate(name="bravo"))
result = await RoleCrud.paginate(
db_session,
order_by=Role.name,
page=1,
items_per_page=10,
)
names = [r.name for r in result.data]
assert names == ["alpha", "bravo", "charlie"]
class TestCrudJoins:
"""Tests for CRUD operations with joins."""
@pytest.mark.anyio
async def test_get_with_join(self, db_session: AsyncSession):
"""Get with inner join filters correctly."""
# Create user with posts
user = await UserCrud.create(
db_session,
UserCreate(username="author", email="author@test.com"),
)
await PostCrud.create(
db_session,
PostCreate(title="Post 1", author_id=user.id, is_published=True),
)
# Get user with join on published posts
fetched = await UserCrud.get(
db_session,
filters=[User.id == user.id, Post.is_published == True], # noqa: E712
joins=[(Post, Post.author_id == User.id)],
)
assert fetched.id == user.id
@pytest.mark.anyio
async def test_first_with_join(self, db_session: AsyncSession):
"""First with join returns matching record."""
user = await UserCrud.create(
db_session,
UserCreate(username="writer", email="writer@test.com"),
)
await PostCrud.create(
db_session,
PostCreate(title="Draft", author_id=user.id, is_published=False),
)
# Find user with unpublished posts
result = await UserCrud.first(
db_session,
filters=[Post.is_published == False], # noqa: E712
joins=[(Post, Post.author_id == User.id)],
)
assert result is not None
assert result.id == user.id
@pytest.mark.anyio
async def test_first_with_outer_join(self, db_session: AsyncSession):
"""First with outer join includes records without related data."""
# User without posts
user = await UserCrud.create(
db_session,
UserCreate(username="no_posts", email="no_posts@test.com"),
)
# With outer join, user should be found even without posts
result = await UserCrud.first(
db_session,
filters=[User.id == user.id],
joins=[(Post, Post.author_id == User.id)],
outer_join=True,
)
assert result is not None
assert result.id == user.id
@pytest.mark.anyio
async def test_get_multi_with_inner_join(self, db_session: AsyncSession):
"""Get multiple with inner join only returns matching records."""
# User with published post
user1 = await UserCrud.create(
db_session,
UserCreate(username="publisher", email="pub@test.com"),
)
await PostCrud.create(
db_session,
PostCreate(title="Published", author_id=user1.id, is_published=True),
)
# User without posts
await UserCrud.create(
db_session,
UserCreate(username="lurker", email="lurk@test.com"),
)
# Inner join should only return user with published post
users = await UserCrud.get_multi(
db_session,
joins=[(Post, Post.author_id == User.id)],
filters=[Post.is_published == True], # noqa: E712
)
assert len(users) == 1
assert users[0].username == "publisher"
@pytest.mark.anyio
async def test_get_multi_with_outer_join(self, db_session: AsyncSession):
"""Get multiple with outer join includes all records."""
# User with post
user1 = await UserCrud.create(
db_session,
UserCreate(username="has_post", email="has@test.com"),
)
await PostCrud.create(
db_session,
PostCreate(title="My Post", author_id=user1.id),
)
# User without posts
await UserCrud.create(
db_session,
UserCreate(username="no_post", email="no@test.com"),
)
# Outer join should return both users
users = await UserCrud.get_multi(
db_session,
joins=[(Post, Post.author_id == User.id)],
outer_join=True,
)
assert len(users) == 2
@pytest.mark.anyio
async def test_count_with_join(self, db_session: AsyncSession):
"""Count with join counts correctly."""
# Create users with different post statuses
user1 = await UserCrud.create(
db_session,
UserCreate(username="active_author", email="active@test.com"),
)
await PostCrud.create(
db_session,
PostCreate(title="Published 1", author_id=user1.id, is_published=True),
)
user2 = await UserCrud.create(
db_session,
UserCreate(username="draft_author", email="draft@test.com"),
)
await PostCrud.create(
db_session,
PostCreate(title="Draft 1", author_id=user2.id, is_published=False),
)
# Count users with published posts
count = await UserCrud.count(
db_session,
filters=[Post.is_published == True], # noqa: E712
joins=[(Post, Post.author_id == User.id)],
)
assert count == 1
@pytest.mark.anyio
async def test_exists_with_join(self, db_session: AsyncSession):
"""Exists with join checks correctly."""
user = await UserCrud.create(
db_session,
UserCreate(username="poster", email="poster@test.com"),
)
await PostCrud.create(
db_session,
PostCreate(title="Exists Post", author_id=user.id, is_published=True),
)
# Check if user with published post exists
exists = await UserCrud.exists(
db_session,
filters=[Post.is_published == True], # noqa: E712
joins=[(Post, Post.author_id == User.id)],
)
assert exists is True
# Check if user with specific title exists
exists = await UserCrud.exists(
db_session,
filters=[Post.title == "Nonexistent"],
joins=[(Post, Post.author_id == User.id)],
)
assert exists is False
@pytest.mark.anyio
async def test_paginate_with_join(self, db_session: AsyncSession):
"""Paginate with join works correctly."""
# Create users with posts
for i in range(5):
user = await UserCrud.create(
db_session,
UserCreate(username=f"author{i}", email=f"author{i}@test.com"),
)
await PostCrud.create(
db_session,
PostCreate(
title=f"Post {i}",
author_id=user.id,
is_published=i % 2 == 0,
),
)
# Paginate users with published posts
result = await UserCrud.paginate(
db_session,
joins=[(Post, Post.author_id == User.id)],
filters=[Post.is_published == True], # noqa: E712
page=1,
items_per_page=10,
)
assert result.pagination.total_count == 3
assert len(result.data) == 3
@pytest.mark.anyio
async def test_paginate_with_outer_join(self, db_session: AsyncSession):
"""Paginate with outer join includes all records."""
# User with post
user1 = await UserCrud.create(
db_session,
UserCreate(username="with_post", email="with@test.com"),
)
await PostCrud.create(
db_session,
PostCreate(title="A Post", author_id=user1.id),
)
# User without post
await UserCrud.create(
db_session,
UserCreate(username="without_post", email="without@test.com"),
)
# Paginate with outer join
result = await UserCrud.paginate(
db_session,
joins=[(Post, Post.author_id == User.id)],
outer_join=True,
page=1,
items_per_page=10,
)
assert result.pagination.total_count == 2
assert len(result.data) == 2
@pytest.mark.anyio
async def test_multiple_joins(self, db_session: AsyncSession):
"""Multiple joins can be applied."""
role = await RoleCrud.create(db_session, RoleCreate(name="author_role"))
user = await UserCrud.create(
db_session,
UserCreate(
username="multi_join",
email="multi@test.com",
role_id=role.id,
),
)
await PostCrud.create(
db_session,
PostCreate(title="Multi Join Post", author_id=user.id, is_published=True),
)
# Join both Role and Post
users = await UserCrud.get_multi(
db_session,
joins=[
(Role, Role.id == User.role_id),
(Post, Post.author_id == User.id),
],
filters=[Role.name == "author_role", Post.is_published == True], # noqa: E712
)
assert len(users) == 1
assert users[0].username == "multi_join"
class TestAsResponse:
"""Tests for as_response parameter."""
@pytest.mark.anyio
async def test_create_as_response(self, db_session: AsyncSession):
"""Create with as_response=True returns Response."""
from fastapi_toolsets.schemas import Response
data = RoleCreate(name="response_role")
result = await RoleCrud.create(db_session, data, as_response=True)
assert isinstance(result, Response)
assert result.data is not None
assert result.data.name == "response_role"
@pytest.mark.anyio
async def test_get_as_response(self, db_session: AsyncSession):
"""Get with as_response=True returns Response."""
from fastapi_toolsets.schemas import Response
created = await RoleCrud.create(db_session, RoleCreate(name="get_response"))
result = await RoleCrud.get(
db_session, [Role.id == created.id], as_response=True
)
assert isinstance(result, Response)
assert result.data is not None
assert result.data.id == created.id
@pytest.mark.anyio
async def test_update_as_response(self, db_session: AsyncSession):
"""Update with as_response=True returns Response."""
from fastapi_toolsets.schemas import Response
created = await RoleCrud.create(db_session, RoleCreate(name="old_name"))
result = await RoleCrud.update(
db_session,
RoleUpdate(name="new_name"),
[Role.id == created.id],
as_response=True,
)
assert isinstance(result, Response)
assert result.data is not None
assert result.data.name == "new_name"
@pytest.mark.anyio
async def test_delete_as_response(self, db_session: AsyncSession):
"""Delete with as_response=True returns Response."""
from fastapi_toolsets.schemas import Response
created = await RoleCrud.create(db_session, RoleCreate(name="to_delete"))
result = await RoleCrud.delete(
db_session, [Role.id == created.id], as_response=True
)
assert isinstance(result, Response)
assert result.data is None
class TestCrudFactoryM2M:
"""Tests for CrudFactory with m2m_fields parameter."""
def test_creates_crud_with_m2m_fields(self):
"""CrudFactory configures m2m_fields on the class."""
crud = CrudFactory(Post, m2m_fields={"tag_ids": Post.tags})
assert crud.m2m_fields is not None
assert "tag_ids" in crud.m2m_fields
def test_creates_crud_without_m2m_fields(self):
"""CrudFactory without m2m_fields has None."""
crud = CrudFactory(Post)
assert crud.m2m_fields is None
def test_m2m_schema_fields(self):
"""_m2m_schema_fields returns correct field names."""
crud = CrudFactory(Post, m2m_fields={"tag_ids": Post.tags})
assert crud._m2m_schema_fields() == {"tag_ids"}
def test_m2m_schema_fields_empty_when_none(self):
"""_m2m_schema_fields returns empty set when no m2m_fields."""
crud = CrudFactory(Post)
assert crud._m2m_schema_fields() == set()
@pytest.mark.anyio
async def test_resolve_m2m_returns_empty_without_m2m_fields(
self, db_session: AsyncSession
):
"""_resolve_m2m returns empty dict when m2m_fields is not configured."""
from pydantic import BaseModel
class DummySchema(BaseModel):
name: str
result = await PostCrud._resolve_m2m(db_session, DummySchema(name="test"))
assert result == {}
class TestM2MResolveNone:
"""Tests for _resolve_m2m when IDs field is None."""
@pytest.mark.anyio
async def test_resolve_m2m_with_none_ids(self, db_session: AsyncSession):
"""_resolve_m2m sets empty list when ids value is None."""
from pydantic import BaseModel
class SchemaWithNullableTags(BaseModel):
tag_ids: list[uuid.UUID] | None = None
result = await PostM2MCrud._resolve_m2m(
db_session, SchemaWithNullableTags(tag_ids=None)
)
assert result == {"tags": []}
class TestM2MCreate:
"""Tests for create with M2M relationships."""
@pytest.mark.anyio
async def test_create_with_m2m_tags(self, db_session: AsyncSession):
"""Create a post with M2M tags resolves tag IDs."""
user = await UserCrud.create(
db_session, UserCreate(username="author", email="author@test.com")
)
tag1 = await TagCrud.create(db_session, TagCreate(name="python"))
tag2 = await TagCrud.create(db_session, TagCreate(name="fastapi"))
post = await PostM2MCrud.create(
db_session,
PostM2MCreate(
title="M2M Post",
author_id=user.id,
tag_ids=[tag1.id, tag2.id],
),
)
assert post.id is not None
assert post.title == "M2M Post"
# Reload with tags eagerly loaded
loaded = await PostM2MCrud.get(
db_session,
[Post.id == post.id],
load_options=[selectinload(Post.tags)],
)
tag_names = sorted(t.name for t in loaded.tags)
assert tag_names == ["fastapi", "python"]
@pytest.mark.anyio
async def test_create_with_empty_m2m(self, db_session: AsyncSession):
"""Create a post with empty tag_ids list works."""
user = await UserCrud.create(
db_session, UserCreate(username="author", email="author@test.com")
)
post = await PostM2MCrud.create(
db_session,
PostM2MCreate(
title="No Tags Post",
author_id=user.id,
tag_ids=[],
),
)
assert post.id is not None
loaded = await PostM2MCrud.get(
db_session,
[Post.id == post.id],
load_options=[selectinload(Post.tags)],
)
assert loaded.tags == []
@pytest.mark.anyio
async def test_create_with_default_m2m(self, db_session: AsyncSession):
"""Create a post using default tag_ids (empty list) works."""
user = await UserCrud.create(
db_session, UserCreate(username="author", email="author@test.com")
)
post = await PostM2MCrud.create(
db_session,
PostM2MCreate(title="Default Tags", author_id=user.id),
)
loaded = await PostM2MCrud.get(
db_session,
[Post.id == post.id],
load_options=[selectinload(Post.tags)],
)
assert loaded.tags == []
@pytest.mark.anyio
async def test_create_with_nonexistent_tag_id_raises(
self, db_session: AsyncSession
):
"""Create with a nonexistent tag ID raises NotFoundError."""
user = await UserCrud.create(
db_session, UserCreate(username="author", email="author@test.com")
)
tag = await TagCrud.create(db_session, TagCreate(name="valid"))
fake_id = uuid.uuid4()
with pytest.raises(NotFoundError):
await PostM2MCrud.create(
db_session,
PostM2MCreate(
title="Bad Tags",
author_id=user.id,
tag_ids=[tag.id, fake_id],
),
)
@pytest.mark.anyio
async def test_create_with_single_tag(self, db_session: AsyncSession):
"""Create with a single tag works correctly."""
user = await UserCrud.create(
db_session, UserCreate(username="author", email="author@test.com")
)
tag = await TagCrud.create(db_session, TagCreate(name="solo"))
post = await PostM2MCrud.create(
db_session,
PostM2MCreate(
title="Single Tag",
author_id=user.id,
tag_ids=[tag.id],
),
)
loaded = await PostM2MCrud.get(
db_session,
[Post.id == post.id],
load_options=[selectinload(Post.tags)],
)
assert len(loaded.tags) == 1
assert loaded.tags[0].name == "solo"
class TestM2MUpdate:
"""Tests for update with M2M relationships."""
@pytest.mark.anyio
async def test_update_m2m_tags(self, db_session: AsyncSession):
"""Update replaces M2M tags when tag_ids is set."""
user = await UserCrud.create(
db_session, UserCreate(username="author", email="author@test.com")
)
tag1 = await TagCrud.create(db_session, TagCreate(name="old_tag"))
tag2 = await TagCrud.create(db_session, TagCreate(name="new_tag"))
# Create with tag1
post = await PostM2MCrud.create(
db_session,
PostM2MCreate(
title="Update Test",
author_id=user.id,
tag_ids=[tag1.id],
),
)
# Update to tag2
updated = await PostM2MCrud.update(
db_session,
PostM2MUpdate(tag_ids=[tag2.id]),
[Post.id == post.id],
)
loaded = await PostM2MCrud.get(
db_session,
[Post.id == updated.id],
load_options=[selectinload(Post.tags)],
)
assert len(loaded.tags) == 1
assert loaded.tags[0].name == "new_tag"
@pytest.mark.anyio
async def test_update_without_m2m_preserves_tags(self, db_session: AsyncSession):
"""Update without setting tag_ids preserves existing tags."""
user = await UserCrud.create(
db_session, UserCreate(username="author", email="author@test.com")
)
tag = await TagCrud.create(db_session, TagCreate(name="keep_me"))
post = await PostM2MCrud.create(
db_session,
PostM2MCreate(
title="Keep Tags",
author_id=user.id,
tag_ids=[tag.id],
),
)
# Update only title, tag_ids not set
await PostM2MCrud.update(
db_session,
PostM2MUpdate(title="Updated Title"),
[Post.id == post.id],
)
loaded = await PostM2MCrud.get(
db_session,
[Post.id == post.id],
load_options=[selectinload(Post.tags)],
)
assert loaded.title == "Updated Title"
assert len(loaded.tags) == 1
assert loaded.tags[0].name == "keep_me"
@pytest.mark.anyio
async def test_update_clear_m2m_tags(self, db_session: AsyncSession):
"""Update with empty tag_ids clears all tags."""
user = await UserCrud.create(
db_session, UserCreate(username="author", email="author@test.com")
)
tag = await TagCrud.create(db_session, TagCreate(name="remove_me"))
post = await PostM2MCrud.create(
db_session,
PostM2MCreate(
title="Clear Tags",
author_id=user.id,
tag_ids=[tag.id],
),
)
# Explicitly set tag_ids to empty list
await PostM2MCrud.update(
db_session,
PostM2MUpdate(tag_ids=[]),
[Post.id == post.id],
)
loaded = await PostM2MCrud.get(
db_session,
[Post.id == post.id],
load_options=[selectinload(Post.tags)],
)
assert loaded.tags == []
@pytest.mark.anyio
async def test_update_m2m_with_nonexistent_id_raises(
self, db_session: AsyncSession
):
"""Update with nonexistent tag ID raises NotFoundError."""
user = await UserCrud.create(
db_session, UserCreate(username="author", email="author@test.com")
)
tag = await TagCrud.create(db_session, TagCreate(name="existing"))
post = await PostM2MCrud.create(
db_session,
PostM2MCreate(
title="Bad Update",
author_id=user.id,
tag_ids=[tag.id],
),
)
fake_id = uuid.uuid4()
with pytest.raises(NotFoundError):
await PostM2MCrud.update(
db_session,
PostM2MUpdate(tag_ids=[fake_id]),
[Post.id == post.id],
)
@pytest.mark.anyio
async def test_update_m2m_and_scalar_fields(self, db_session: AsyncSession):
"""Update both scalar fields and M2M tags together."""
user = await UserCrud.create(
db_session, UserCreate(username="author", email="author@test.com")
)
tag1 = await TagCrud.create(db_session, TagCreate(name="tag1"))
tag2 = await TagCrud.create(db_session, TagCreate(name="tag2"))
post = await PostM2MCrud.create(
db_session,
PostM2MCreate(
title="Original",
author_id=user.id,
tag_ids=[tag1.id],
),
)
# Update title and tags simultaneously
await PostM2MCrud.update(
db_session,
PostM2MUpdate(title="Updated", tag_ids=[tag1.id, tag2.id]),
[Post.id == post.id],
)
loaded = await PostM2MCrud.get(
db_session,
[Post.id == post.id],
load_options=[selectinload(Post.tags)],
)
assert loaded.title == "Updated"
tag_names = sorted(t.name for t in loaded.tags)
assert tag_names == ["tag1", "tag2"]
class TestM2MWithNonM2MCrud:
"""Tests that non-M2M CRUD classes are unaffected."""
@pytest.mark.anyio
async def test_create_without_m2m_unchanged(self, db_session: AsyncSession):
"""Regular PostCrud.create still works without M2M logic."""
from .conftest import PostCreate
user = await UserCrud.create(
db_session, UserCreate(username="author", email="author@test.com")
)
post = await PostCrud.create(
db_session,
PostCreate(title="Plain Post", author_id=user.id),
)
assert post.id is not None
assert post.title == "Plain Post"
@pytest.mark.anyio
async def test_update_without_m2m_unchanged(self, db_session: AsyncSession):
"""Regular PostCrud.update still works without M2M logic."""
from .conftest import PostCreate, PostUpdate
user = await UserCrud.create(
db_session, UserCreate(username="author", email="author@test.com")
)
post = await PostCrud.create(
db_session,
PostCreate(title="Plain Post", author_id=user.id),
)
updated = await PostCrud.update(
db_session,
PostUpdate(title="Updated Plain"),
[Post.id == post.id],
)
assert updated.title == "Updated Plain"