tests are passing

Author: sanderegg

packages/models-library/src/models_library/storage_schemas.py

@@ -380,4 +380,46 @@ class PathMetaDataGet(BaseModel):
     file_meta_data: Annotated[
         FileMetaDataGet | None,
         Field(description="if filled, this is the file meta data of the s3 object"),
-    ]
+    ] = None
+
+    assert "json_schema_extra" in FileMetaDataGet.model_config  # nosec
+    assert isinstance(FileMetaDataGet.model_config["json_schema_extra"], dict)  # nosec
+    assert isinstance(  # nosec
+        FileMetaDataGet.model_config["json_schema_extra"]["examples"], list
+    )
+
+    model_config = ConfigDict(
+        extra="forbid",
+        json_schema_extra={
+            "examples": [
+                # ls no filter
+                {
+                    "path": "f8da77a9-24b9-4eab-aee7-1f0608da1e3e",
+                    "display_path": "my amazing project",
+                },
+                # ls f8da77a9-24b9-4eab-aee7-1f0608da1e3e
+                {
+                    "path": "f8da77a9-24b9-4eab-aee7-1f0608da1e3e/2f94f80f-633e-4dfa-a983-226b7babe3d7",
+                    "display_path": "my amazing project/awesome node",
+                },
+                # ls f8da77a9-24b9-4eab-aee7-1f0608da1e3e/2f94f80f-633e-4dfa-a983-226b7babe3d7
+                {
+                    "path": "f8da77a9-24b9-4eab-aee7-1f0608da1e3e/2f94f80f-633e-4dfa-a983-226b7babe3d7/outputs",
+                    "display_path": "my amazing project/awesome node/outputs",
+                },
+                # ls f8da77a9-24b9-4eab-aee7-1f0608da1e3e/2f94f80f-633e-4dfa-a983-226b7babe3d7/outputs
+                {
+                    "path": "f8da77a9-24b9-4eab-aee7-1f0608da1e3e/2f94f80f-633e-4dfa-a983-226b7babe3d7/outputs/output5",
+                    "display_path": "my amazing project/awesome node/outputs/output5",
+                },
+                # ls f8da77a9-24b9-4eab-aee7-1f0608da1e3e/2f94f80f-633e-4dfa-a983-226b7babe3d7/outputs/output_5
+                {
+                    "path": f"f8da77a9-24b9-4eab-aee7-1f0608da1e3e/2f94f80f-633e-4dfa-a983-226b7babe3d7/outputs/output5/{FileMetaDataGet.model_config['json_schema_extra']['examples'][0]['file_name']}",
+                    "display_path": f"my amazing project/awesome node/outputs/output5/{FileMetaDataGet.model_config['json_schema_extra']['examples'][0]['file_name']}",
+                    "file_meta_data": FileMetaDataGet.model_config["json_schema_extra"][
+                        "examples"
+                    ][0],
+                },
+            ]
+        },
+    )

services/web/server/tests/unit/with_dbs/01/storage/conftest.py

@@ -6,12 +6,16 @@
 import logging
 import random
 from collections.abc import Iterator
+from pathlib import Path
 from threading import Thread
+from typing import Annotated
 
 import pytest
 import uvicorn
 from faker import Faker
-from fastapi import APIRouter, FastAPI, Request, status
+from fastapi import APIRouter, Depends, FastAPI, Request, status
+from fastapi_pagination import add_pagination, create_page
+from fastapi_pagination.cursor import CursorPage, CursorParams
 from models_library.generics import Envelope
 from models_library.projects import ProjectID
 from models_library.projects_nodes_io import LocationID, StorageFileID
@@ -24,6 +28,7 @@
     FileUploadCompletionBody,
     FileUploadSchema,
     LinkType,
+    PathMetaDataGet,
 )
 from models_library.users import UserID
 from pydantic import AnyUrl, TypeAdapter
@@ -41,6 +46,8 @@ def storage_vtag() -> str:
 @pytest.fixture(scope="module")
 def fake_storage_app(storage_vtag: str) -> FastAPI:
     app = FastAPI(debug=True)
+    add_pagination(app)
+
     router = APIRouter(
         prefix=f"/{storage_vtag}",
     )
@@ -68,6 +75,38 @@ async def _list_storage_locations(user_id: UserID, request: Request):
             ]
         )
 
+    @router.get(
+        "/locations/{location_id}/paths",
+        response_model=CursorPage[PathMetaDataGet],
+    )
+    async def _list_paths(
+        page_params: Annotated[CursorParams, Depends()],
+        # dsm: Annotated[BaseDataManager, Depends(get_data_manager)],
+        user_id: UserID,
+        file_filter: Path | None = None,
+    ):
+        assert user_id
+        assert "json_schema_extra" in PathMetaDataGet.model_config
+        assert isinstance(PathMetaDataGet.model_config["json_schema_extra"], dict)
+        assert isinstance(
+            PathMetaDataGet.model_config["json_schema_extra"]["examples"], list
+        )
+
+        example_index = len(file_filter.parts) if file_filter else 0
+        assert example_index < len(
+            PathMetaDataGet.model_config["json_schema_extra"]["examples"]
+        ), "fake server unable to server this example"
+        chosen_example = PathMetaDataGet.model_config["json_schema_extra"]["examples"][
+            example_index
+        ]
+
+        return create_page(
+            random.randint(3, 15)
+            * [PathMetaDataGet.model_validate(chosen_example)],  # noqa: S311
+            params=page_params,
+            next_=None,
+        )
+
     @router.get(
         "/locations/{location_id}/files/metadata",
         response_model=Envelope[list[FileMetaDataGet]],

services/web/server/tests/unit/with_dbs/01/storage/test_storage.py

@@ -9,12 +9,14 @@
 import pytest
 from aiohttp.test_utils import TestClient
 from faker import Faker
+from fastapi_pagination.cursor import CursorPage
 from models_library.projects_nodes_io import LocationID, StorageFileID
 from models_library.storage_schemas import (
     DatasetMetaDataGet,
     FileLocation,
     FileMetaDataGet,
     FileUploadSchema,
+    PathMetaDataGet,
 )
 from pydantic import TypeAdapter
 from pytest_simcore.helpers.assert_checks import assert_status
@@ -80,7 +82,7 @@ async def test_list_storage_paths(
     resp = await client.get(f"{url}", params={"user_id": logged_user["id"]})
     data, error = await assert_status(resp, expected)
     if not error:
-        assert isinstance(data, list)
+        TypeAdapter(CursorPage[PathMetaDataGet]).validate_python(data)
 
 
 @pytest.mark.parametrize(
@@ -264,15 +266,16 @@ async def test_upload_file(
 
     resp = await client.put(url, params={"user_id": logged_user["id"]})
     data, error = await assert_status(resp, expected)
-    assert not error
-    assert data
-    file_upload_schema = FileUploadSchema.model_validate(data)
-
-    # let's abort
-    resp = await client.post(
-        f"{file_upload_schema.links.abort_upload.path}",
-        params={"user_id": logged_user["id"]},
-    )
-    data, error = await assert_status(resp, status.HTTP_204_NO_CONTENT)
-    assert not error
-    assert not data
+    if not error:
+        assert not error
+        assert data
+        file_upload_schema = FileUploadSchema.model_validate(data)
+
+        # let's abort
+        resp = await client.post(
+            f"{file_upload_schema.links.abort_upload.path}",
+            params={"user_id": logged_user["id"]},
+        )
+        data, error = await assert_status(resp, status.HTTP_204_NO_CONTENT)
+        assert not error
+        assert not data