adds tests

Author: pcrespov

packages/postgres-database/src/simcore_postgres_database/utils_projects_nodes.py

@@ -66,50 +66,46 @@ class ProjectNodeCreate(BaseModel):
     parent: str | None = None
     boot_options: dict[str, Any] | None = None
 
+    model_config = ConfigDict(frozen=True)
+
     @classmethod
     def get_field_names(cls, *, exclude: set[str]) -> set[str]:
         return cls.model_fields.keys() - exclude
 
+    def _get_node_exclude_fields(self) -> set[str]:
+        """Get the base fields to exclude when converting to Node model."""
+        return {"node_id", "required_resources"}
+
     def model_dump_as_node(self) -> dict[str, Any]:
         """Converts a ProjectNode from the database to a Node model for the API.
 
+        Usage:
+            Node.model_validate(project_node_create.model_dump_as_node(), by_name=True)
+
         Handles field mapping and excludes database-specific fields that are not
         part of the Node model.
         """
-        # Get all ProjectNode fields except those that don't belong in Node
-        exclude_fields = {"node_id", "required_resources"}
         return self.model_dump(
             # NOTE: this setup ensures using the defaults provided in Node model when the db does not
             # provide them, e.g. `state`
-            exclude=exclude_fields,
+            exclude=self._get_node_exclude_fields(),
             exclude_none=True,
             exclude_unset=True,
         )
 
-    model_config = ConfigDict(frozen=True)
-
 
 class ProjectNode(ProjectNodeCreate):
     created: datetime.datetime
     modified: datetime.datetime
 
     model_config = ConfigDict(from_attributes=True)
 
-    def model_dump_as_node(self) -> dict[str, Any]:
-        """Converts a ProjectNode from the database to a Node model for the API.
+    def _get_node_exclude_fields(self) -> set[str]:
+        """Get the fields to exclude when converting to Node model, including DB-specific fields."""
+        base_excludes = super()._get_node_exclude_fields()
+        return base_excludes | {"created", "modified"}
 
-        Handles field mapping and excludes database-specific fields that are not
-        part of the Node model.
-        """
-        # Get all ProjectNode fields except those that don't belong in Node
-        exclude_fields = {"node_id", "required_resources", "created", "modified"}
-        return self.model_dump(
-            # NOTE: this setup ensures using the defaults provided in Node model when the db does not
-            # provide them, e.g. `state`
-            exclude=exclude_fields,
-            exclude_none=True,
-            exclude_unset=True,
-        )
+    # NOTE: model_dump_as_node is inherited from ProjectNodeCreate and uses the overridden _get_node_exclude_fields
 
 
 @dataclass(frozen=True, kw_only=True)

packages/postgres-database/tests/test_utils_projects_metadata.py

@@ -391,3 +391,19 @@ async def test_not_implemented_use_cases(
             parent_project_uuid=missing_parent_project["uuid"],
             parent_node_id=missing_parent_node.node_id,
         )
+
+
+async def test_model_dump_as_node(
+    connection: SAConnection,
+    create_fake_user: Callable[..., Awaitable[RowProxy]],
+    create_fake_project: Callable[..., Awaitable[RowProxy]],
+    create_fake_projects_node: Callable[[uuid.UUID], Awaitable[ProjectNode]],
+):
+    user: RowProxy = await create_fake_user(connection)
+    project: RowProxy = await create_fake_project(connection, user, hidden=True)
+    project_node = await create_fake_projects_node(project["uuid"])
+
+    node_data = project_node.model_dump_as_node()
+    assert isinstance(node_data, dict)
+    assert node_data["key"] == project_node.key
+    assert "node_id" not in node_data, "this is only in ProjectNode but not in Node!"

services/web/server/tests/unit/isolated/test_models.py

@@ -7,8 +7,13 @@
 
 import pytest
 from faker import Faker
+from models_library.projects_nodes import Node
 from pydantic import TypeAdapter, ValidationError
 from pytest_simcore.helpers.faker_factories import random_phone_number
+from simcore_postgres_database.utils_projects_nodes import (
+    ProjectNode,
+    ProjectNodeCreate,
+)
 from simcore_service_webserver.users._controller.rest._rest_schemas import (
     MyPhoneRegister,
     PhoneNumberStr,
@@ -67,3 +72,36 @@ def test_invalid_phone_numbers(phone: str):
     # This test is used to tune options of PhoneNumberValidator
     with pytest.raises(ValidationError):
         MyPhoneRegister.model_validate({"phone": phone})
+
+
+_node_examples = Node.model_json_schema()["examples"]
+
+
+@pytest.mark.parametrize(
+    "node_data",
+    _node_examples,
+    ids=[f"example-{i}" for i in range(len(_node_examples))],
+)
+def test_adapters_between_project_node_models(node_data: dict, faker: Faker):
+    # -> to Node
+    node_id = faker.uuid4()
+    node = Node.model_validate(node_data)
+
+    # -> to ProjectNodeCreate and ProjectNode
+    project_node_create = ProjectNodeCreate(
+        node_id=node_id,
+        **node.model_dump(by_alias=False, mode="json"),
+    )
+    project_node = ProjectNode(
+        node_id=node_id,
+        created=faker.date_time(),
+        modified=faker.date_time(),
+        **node.model_dump(by_alias=False, mode="json"),
+    )
+
+    # -> to Node
+    assert (
+        Node.model_validate(project_node_create.model_dump_as_node(), by_name=True)
+        == node
+    )
+    assert Node.model_validate(project_node.model_dump_as_node(), by_name=True) == node