added test for relationship to self

Author: CosmoV

tests/models.py

@@ -231,5 +231,22 @@ def process_result_value(self, value, dialect):
         return UUID(value)
 
 
-class MiscCases(Base):
+class IdCast(Base):
     id = Column(UUIDType, primary_key=True)
+
+
+class SelfRelationship(Base):
+    id = Column(Integer, primary_key=True)
+    name = Column(String)
+    self_relationship_id = Column(
+        Integer,
+        ForeignKey(
+            "selfrelationships.id",
+            name="fk_self_relationship_id",
+            ondelete="CASCADE",
+            onupdate="CASCADE",
+        ),
+        nullable=True,
+    )
+    # parent = relationship("SelfRelationship", back_populates="s")
+    self_relationship = relationship("SelfRelationship", remote_side=[id])

tests/schemas.py

@@ -332,9 +332,14 @@ class Config:
     id: int
 
 
-class MiscCasesAttributesSchema(BaseModel):
-    pass
+class IdCastSchema(BaseModel):
+    id: UUID = Field(client_can_set_id=True)
 
 
-class MiscCasesSchema(MiscCasesAttributesSchema):
-    id: UUID = Field(client_can_set_id=True)
+class SelfRelationshipSchema(BaseModel):
+    name: str
+    self_relationship: Optional["SelfRelationshipSchema"] = Field(
+        relationship=RelationshipInfo(
+            resource_type="self_relationship",
+        ),
+    )

tests/test_api/test_api_sqla_with_includes.py

@@ -16,17 +16,19 @@
 from tests.misc.utils import fake
 from tests.models import (
     Computer,
-    MiscCases,
+    IdCast,
     Post,
     PostComment,
+    SelfRelationship,
     User,
     UserBio,
     Workplace,
 )
 from tests.schemas import (
-    MiscCasesSchema,
+    IdCastSchema,
     PostAttributesBaseSchema,
     PostCommentAttributesBaseSchema,
+    SelfRelationshipSchema,
     UserAttributesBaseSchema,
     UserBioBaseSchema,
     UserInSchemaAllowIdOnPost,
@@ -822,20 +824,20 @@ async def test_create_user_and_fetch_data(self, client: AsyncClient):
         assert response_data["data"]["attributes"] == create_user_body["data"]["attributes"]
         assert response_data["data"]["id"] == user_id
 
-    def _build_app_custom(self, schema, schema_in_post, model=None) -> FastAPI:
+    def _build_app_custom(self, schema, schema_in_post, model, resource_type: str = "misc") -> FastAPI:
         router: APIRouter = APIRouter()
 
         RoutersJSONAPI(
             router=router,
-            path="/users",
-            tags=["User"],
+            path="/misc",
+            tags=["Misc"],
             class_detail=DetailViewBaseGeneric,
             class_list=ListViewBaseGeneric,
             schema=schema,
-            resource_type="user",
+            resource_type="misc",
             schema_in_patch=UserPatchSchema,
             schema_in_post=schema_in_post,
-            model=model or User,
+            model=model,
         )
 
         app = build_app_plain()
@@ -844,7 +846,12 @@ def _build_app_custom(self, schema, schema_in_post, model=None) -> FastAPI:
         return app
 
     async def test_create_id_by_client(self):
-        app = self._build_app_custom(UserSchema, UserInSchemaAllowIdOnPost)
+        app = self._build_app_custom(
+            UserSchema,
+            UserInSchemaAllowIdOnPost,
+            User,
+            "user",
+        )
 
         new_id = str(fake.pyint(100, 999))
         attrs = UserAttributesBaseSchema(
@@ -860,7 +867,7 @@ async def test_create_id_by_client(self):
         }
 
         async with AsyncClient(app=app, base_url="http://test") as client:
-            res = await client.post("/users", json=create_user_body)
+            res = await client.post("/misc", json=create_user_body)
             assert res.status_code == status.HTTP_201_CREATED, res.text
             assert res.json() == {
                 "data": {
@@ -873,25 +880,106 @@ async def test_create_id_by_client(self):
             }
 
     async def test_create_id_by_client_uuid_type(self):
-        app = self._build_app_custom(MiscCasesSchema, MiscCasesSchema, MiscCases)
+        app = self._build_app_custom(IdCastSchema, IdCastSchema, IdCast)
 
         new_id = str(uuid4())
-        create_user_body = {
+        create_body = {
             "data": {
                 "attributes": {},
                 "id": new_id,
             },
         }
 
         async with AsyncClient(app=app, base_url="http://test") as client:
-            res = await client.post("/users", json=create_user_body)
+            res = await client.post("/misc", json=create_body)
             assert res.status_code == status.HTTP_201_CREATED, res.text
             assert res.json() == {
                 "data": {
                     "attributes": {},
                     "id": new_id,
-                    "type": "user",
+                    "type": "misc",
+                },
+                "jsonapi": {"version": "1.0"},
+                "meta": None,
+            }
+
+    async def test_create_with_relationship_to_the_same_table(self):
+        app = self._build_app_custom(
+            SelfRelationshipSchema,
+            SelfRelationshipSchema,
+            SelfRelationship,
+        )
+
+        async with AsyncClient(app=app, base_url="http://test") as client:
+            create_body = {
+                "data": {
+                    "attributes": {
+                        "name": "parent",
+                    },
+                },
+            }
+
+            res = await client.post("/misc", json=create_body)
+            assert res.status_code == status.HTTP_201_CREATED, res.text
+
+            response_json = res.json()
+            assert response_json["data"]
+            assert (parent_object_id := response_json["data"].get("id"))
+            assert response_json == {
+                "data": {
+                    "attributes": {
+                        "name": "parent",
+                    },
+                    "id": parent_object_id,
+                    "relationships": None,
+                    "type": "self_relationship",
+                },
+                "jsonapi": {"version": "1.0"},
+                "meta": None,
+            }
+
+            create_with_relationship_body = {
+                "data": {
+                    "attributes": {
+                        "name": "child",
+                    },
+                    "relationships": {
+                        "self_relationship": {
+                            "data": {
+                                "type": "self_relationship",
+                                "id": parent_object_id,
+                            },
+                        },
+                    },
                 },
+            }
+            res = await client.post("/misc?include=self_relationship", json=create_with_relationship_body)
+            assert res.status_code == status.HTTP_201_CREATED, res.text
+
+            response_json = res.json()
+            assert response_json["data"]
+            assert (child_object_id := response_json["data"].get("id"))
+            assert res.json() == {
+                "data": {
+                    "attributes": {"name": "child"},
+                    "id": child_object_id,
+                    "relationships": {
+                        "self_relationship": {
+                            "data": {
+                                "id": parent_object_id,
+                                "type": "self_relationship",
+                            },
+                        },
+                    },
+                    "type": "self_relationship",
+                },
+                "included": [
+                    {
+                        "attributes": {"name": "parent"},
+                        "id": parent_object_id,
+                        "type": "self_relationship",
+                    },
+                ],
                 "jsonapi": {"version": "1.0"},
                 "meta": None,
             }