tests coverage read custom model id field

Author: mahenzon

tests/conftest.py

@@ -51,6 +51,7 @@
     user_3,
     workplace_1,
     workplace_2,
+    age_rating_g,
 )
 from tests.fixtures.user import (  # noqa
     user_attributes,

tests/fixtures/app.py

@@ -39,7 +39,7 @@
 from fastapi_jsonapi.data_typing import TypeModel
 from fastapi_jsonapi.views.view_base import ViewBase
 
-from .models import Alpha, Beta, CustomUUIDItem, Delta, Gamma, Task
+from .models import Alpha, Beta, CustomUUIDItem, Delta, Gamma, Task, AgeRating
 from .schemas import (
     AlphaSchema,
     BetaSchema,
@@ -49,6 +49,9 @@
     TaskInSchema,
     TaskPatchSchema,
     TaskSchema,
+    AgeRatingSchema,
+    AgeRatingCreateSchema,
+    AgeRatingUpdateSchema,
 )
 from .views import ViewBaseGeneric
 
@@ -162,6 +165,17 @@ def add_routers(app_plain: FastAPI):
         schema_in_patch=UserPatchSchema,
         schema_in_post=UserInSchema,
     )
+    builder.add_resource(
+        path="/age-ratings",
+        tags=["Age Ratings"],
+        resource_type="age-rating",
+        view=ViewBaseGeneric,
+        model=AgeRating,
+        schema=AgeRatingSchema,
+        schema_in_post=AgeRatingCreateSchema,
+        schema_in_patch=AgeRatingUpdateSchema,
+        model_id_field_name="name",
+    )
     builder.initialize()
 
     return app_plain

tests/fixtures/entities.py

@@ -1,3 +1,4 @@
+from textwrap import dedent
 from typing import Awaitable, Callable, Optional
 
 import pytest
@@ -16,7 +17,7 @@
     Workplace,
 )
 from tests.common import is_postgres_tests
-from tests.fixtures.models import Task
+from tests.fixtures.models import Task, AgeRating
 from tests.misc.utils import fake
 
 
@@ -551,3 +552,24 @@ async def workplace_2(
     async_session: AsyncSession,
 ):
     yield await create_workplace(async_session, name="workplace_2")
+
+
+@async_fixture()
+async def age_rating_g(async_session: AsyncSession):
+    age_rating = AgeRating(
+        name="G",
+        description=dedent(
+            """G – General Audiences
+
+        All ages admitted.
+        Nothing that would offend parents for viewing by children.
+        """
+        ),
+    )
+    async_session.add(age_rating)
+    await async_session.commit()
+
+    yield age_rating
+
+    await async_session.delete(age_rating)
+    await async_session.commit()

tests/fixtures/models/__init__.py

@@ -9,8 +9,10 @@
 from tests.fixtures.models.gamma import Gamma
 from tests.fixtures.models.self_relationship import SelfRelationship
 from tests.fixtures.models.task import Task
+from tests.fixtures.models.age_rating import AgeRating
 
 __all__ = (
+    "AgeRating",
     "Alpha",
     "Beta",
     "BetaDeltaBinding",

tests/fixtures/models/age_rating.py

@@ -0,0 +1,33 @@
+from sqlalchemy import (
+    Identity,
+    String,
+    Text,
+)
+from sqlalchemy.orm import Mapped, mapped_column
+
+from examples.api_for_sqlalchemy.models.base import Base
+
+
+class AgeRating(Base):
+    __tablename__ = "age_rating"
+
+    @property
+    def id(self):
+        """
+        Compatibility with JSON:API for reading in view
+        """
+        return self.name
+
+    name: Mapped[str] = mapped_column(
+        String(20),
+        Identity(always=False),
+        primary_key=True,
+    )
+    description: Mapped[str] = mapped_column(
+        Text(),
+        default="",
+        server_default="",
+    )
+
+    def __str__(self) -> str:
+        return self.name

tests/fixtures/schemas/__init__.py

@@ -15,6 +15,13 @@
     TaskSchema,
 )
 
+from .age_rating import (
+    AgeRatingBaseSchema,
+    AgeRatingCreateSchema,
+    AgeRatingUpdateSchema,
+    AgeRatingSchema,
+)
+
 __all__ = (
     "AlphaSchema",
     "BetaSchema",
@@ -28,4 +35,8 @@
     "TaskInSchema",
     "TaskPatchSchema",
     "TaskSchema",
+    "AgeRatingBaseSchema",
+    "AgeRatingCreateSchema",
+    "AgeRatingUpdateSchema",
+    "AgeRatingSchema",
 )

tests/fixtures/schemas/age_rating.py

@@ -0,0 +1,33 @@
+from typing import Annotated
+
+from annotated_types import MaxLen, MinLen
+from pydantic import BaseModel, ConfigDict
+
+name_constrained = Annotated[
+    str,
+    MinLen(1),
+    MaxLen(20),
+]
+
+
+class AgeRatingBaseSchema(BaseModel):
+    model_config = ConfigDict(
+        from_attributes=True,
+    )
+    name: str
+    description: str
+
+
+class AgeRatingCreateSchema(AgeRatingBaseSchema):
+    name: name_constrained
+
+
+class AgeRatingUpdateSchema(AgeRatingBaseSchema):
+    name: name_constrained | None = None
+    description: str | None = None
+
+
+class AgeRatingSchema(AgeRatingBaseSchema):
+    """
+    Age Rating
+    """

tests/test_api/test_model_wo_id_custom_id_field_name.py

@@ -0,0 +1,29 @@
+from typing import Any
+
+from fastapi import FastAPI
+from httpx import AsyncClient
+from starlette import status
+
+from tests.fixtures.models import AgeRating
+from tests.fixtures.schemas import AgeRatingBaseSchema
+
+
+async def test_get_user_with_bio_relation(
+    app: FastAPI,
+    client: AsyncClient,
+    age_rating_g: AgeRating,
+):
+    url = app.url_path_for("get_age-rating_list")
+    response = await client.get(url)
+    assert response.status_code == status.HTTP_200_OK
+    response_data = response.json()
+    assert "data" in response_data, response_data
+    entities: list[dict[str, Any]] = response_data["data"]
+    for entity in entities:
+        assert entity["id"] == entity["attributes"]["name"]
+
+    rating_g_data = next(
+        filter(lambda e: e["id"] == age_rating_g.id, entities),
+    )
+    expected_rating_g_data = AgeRatingBaseSchema.model_validate(age_rating_g).model_dump()
+    assert rating_g_data["attributes"] == expected_rating_g_data