Merge branch 'master' into mai/refactor-products

Author: pcrespov

api/specs/web-server/_storage.py

@@ -17,6 +17,7 @@
     FileUploadCompletionBody,
     FileUploadSchema,
     LinkType,
+    PathMetaDataGet,
     PresignedLink,
 )
 from models_library.api_schemas_webserver.storage import (
@@ -58,7 +59,7 @@ async def list_storage_locations():
 
 @router.get(
     "/storage/locations/{location_id}/paths",
-    response_model=CursorPage[FileMetaDataGet],
+    response_model=CursorPage[PathMetaDataGet],
 )
 async def list_storage_paths(
     _path: Annotated[StorageLocationPathParams, Depends()],

packages/models-library/tests/test_service_settings_labels.py

@@ -5,7 +5,6 @@
 
 import json
 from copy import deepcopy
-from pprint import pformat
 from typing import Any, Final, NamedTuple
 
 import pytest
@@ -33,6 +32,10 @@
 from models_library.services_resources import DEFAULT_SINGLE_SERVICE_NAME
 from models_library.utils.string_substitution import TextTemplate
 from pydantic import BaseModel, TypeAdapter, ValidationError
+from pytest_simcore.pydantic_models import (
+    assert_validation_model,
+    iter_model_examples_in_class,
+)
 
 
 class _Parametrization(NamedTuple):
@@ -89,17 +92,23 @@ def test_service_settings():
         service_setting.set_destination_containers(["random_value1", "random_value2"])
 
 
-@pytest.mark.parametrize("model_cls", [SimcoreServiceLabels])
+@pytest.mark.parametrize(
+    "model_cls, example_name, example_data",
+    iter_model_examples_in_class(SimcoreServiceLabels),
+)
 def test_correctly_detect_dynamic_sidecar_boot(
-    model_cls: type[BaseModel], model_cls_examples: dict[str, dict[str, Any]]
+    model_cls: type[BaseModel], example_name: str, example_data: Any
 ):
-    for name, example in model_cls_examples.items():
-        print(name, ":", pformat(example))
-        model_instance = TypeAdapter(model_cls).validate_python(example)
-        assert model_instance.callbacks_mapping is not None
-        assert model_instance.needs_dynamic_sidecar == (
-            "simcore.service.paths-mapping" in example
-        )
+
+    model_instance = assert_validation_model(
+        model_cls, example_name=example_name, example_data=example_data
+    )
+
+    assert isinstance(model_instance, SimcoreServiceLabels)
+    assert model_instance.callbacks_mapping is not None
+    assert model_instance.needs_dynamic_sidecar == (
+        "simcore.service.paths-mapping" in example_data
+    )
 
 
 def test_raises_error_if_http_entrypoint_is_missing():

packages/pytest-simcore/src/pytest_simcore/helpers/faker_factories.py

@@ -290,7 +290,7 @@ def random_product(
 
 
 def random_product_price(
-    product_name: str, fake: Faker = DEFAULT_FAKER, **overrides
+    *, product_name: str, fake: Faker = DEFAULT_FAKER, **overrides
 ) -> dict[str, Any]:
     from simcore_postgres_database.models.products_prices import products_prices
 

packages/pytest-simcore/src/pytest_simcore/pydantic_models.py

@@ -7,7 +7,7 @@
 from collections.abc import Iterator
 from contextlib import suppress
 from types import ModuleType
-from typing import Any, NamedTuple
+from typing import Any, NamedTuple, TypeVar
 
 import pytest
 from common_library.json_serialization import json_dumps
@@ -143,9 +143,12 @@ def test_model_examples(
             )
 
 
+TBaseModel = TypeVar("TBaseModel", bound=BaseModel)
+
+
 def assert_validation_model(
-    model_cls: type[BaseModel], example_name: str, example_data: Any
-) -> BaseModel:
+    model_cls: type[TBaseModel], example_name: str, example_data: Any
+) -> TBaseModel:
     try:
         model_instance = model_cls.model_validate(example_data)
     except ValidationError as err:
@@ -155,7 +158,7 @@ def assert_validation_model(
             f"\nError: {err}"
         )
 
-    assert isinstance(model_instance, BaseModel)
+    assert isinstance(model_instance, model_cls)
     return model_instance
 
 
@@ -171,6 +174,7 @@ def model_cls_examples(model_cls: type[BaseModel]) -> dict[str, dict[str, Any]]:
         "The 'model_cls_examples' fixture is deprecated and will be removed in a future version. "
         "Please use 'iter_model_example_in_class' or 'iter_model_examples_in_module' as an alternative.",
         DeprecationWarning,
+        stacklevel=2,
     )
     # Use by defining model_cls as test parametrization
     assert model_cls, (

packages/service-integration/tests/test_versioning.py

@@ -2,10 +2,17 @@
 # pylint: disable=unused-argument
 # pylint: disable=unused-variable
 
-import json
+
+import itertools
+from typing import Any
 
 import pytest
 from packaging.version import Version
+from pydantic import BaseModel
+from pytest_simcore.pydantic_models import (
+    assert_validation_model,
+    iter_model_examples_in_class,
+)
 from service_integration.versioning import (
     ExecutableVersionInfo,
     ServiceVersionInfo,
@@ -45,11 +52,15 @@ def test_bump_version_string(
 
 
 @pytest.mark.parametrize(
-    "model_cls",
-    [ExecutableVersionInfo, ServiceVersionInfo],
+    "model_cls, example_name, example_data",
+    itertools.chain(
+        iter_model_examples_in_class(ExecutableVersionInfo),
+        iter_model_examples_in_class(ServiceVersionInfo),
+    ),
 )
-def test_version_info_model_examples(model_cls, model_cls_examples):
-    for name, example in model_cls_examples.items():
-        print(name, ":", json.dumps(example, indent=1))
-        model_instance = model_cls(**example)
-        assert model_instance, f"Failed with {name}"
+def test_version_info_model_examples(
+    model_cls: type[BaseModel], example_name: str, example_data: Any
+):
+    assert_validation_model(
+        model_cls, example_name=example_name, example_data=example_data
+    )

packages/settings-library/tests/test__models_examples.py

@@ -1,19 +1,22 @@
-import json
 from typing import Any
 
 import pytest
 import settings_library
 from pydantic import BaseModel
-from pytest_simcore.pydantic_models import walk_model_examples_in_package
+from pytest_simcore.pydantic_models import (
+    assert_validation_model,
+    walk_model_examples_in_package,
+)
 
 
 @pytest.mark.parametrize(
     "model_cls, example_name, example_data",
     walk_model_examples_in_package(settings_library),
 )
 def test_all_settings_library_models_config_examples(
-    model_cls: type[BaseModel], example_name: int, example_data: Any
+    model_cls: type[BaseModel], example_name: str, example_data: Any
 ):
-    assert model_cls.model_validate(
-        example_data
-    ), f"Failed {example_name} : {json.dumps(example_data)}"
+
+    assert_validation_model(
+        model_cls, example_name=example_name, example_data=example_data
+    )

services/api-server/tests/unit/test__models_examples.py

@@ -1,20 +1,22 @@
-import json
 from itertools import chain
 from typing import Any
 
 import pytest
 import simcore_service_api_server.models.schemas
 from pydantic import BaseModel
-from pytest_simcore.pydantic_models import walk_model_examples_in_package
+from pytest_simcore.pydantic_models import (
+    assert_validation_model,
+    walk_model_examples_in_package,
+)
 
 
 @pytest.mark.parametrize(
     "model_cls, example_name, example_data",
     chain(walk_model_examples_in_package(simcore_service_api_server.models)),
 )
 def test_all_models_library_models_config_examples(
-    model_cls: type[BaseModel], example_name: int, example_data: Any
+    model_cls: type[BaseModel], example_name: str, example_data: Any
 ):
-    assert model_cls.model_validate(
-        example_data
-    ), f"Failed {example_name} : {json.dumps(example_data)}"
+    assert_validation_model(
+        model_cls, example_name=example_name, example_data=example_data
+    )

services/api-server/tests/unit/test_models.py

@@ -3,13 +3,15 @@
 # pylint: disable=too-many-arguments
 # pylint: disable=unused-argument
 # pylint: disable=unused-variable
-import json
 from typing import Any
 
 import pytest
 import simcore_service_api_server.models
 from pydantic import BaseModel
-from pytest_simcore.pydantic_models import walk_model_examples_in_package
+from pytest_simcore.pydantic_models import (
+    assert_validation_model,
+    walk_model_examples_in_package,
+)
 from simcore_postgres_database.models.users import UserRole
 from simcore_service_api_server.models.schemas.profiles import UserRoleEnum
 
@@ -21,9 +23,9 @@
 def test_api_server_model_examples(
     model_cls: type[BaseModel], example_name: int, example_data: Any
 ):
-    assert model_cls.model_validate(
-        example_data
-    ), f"Failed {example_name} : {json.dumps(example_data)}"
+    assert_validation_model(
+        model_cls, example_name=example_name, example_data=example_data
+    )
 
 
 def test_enums_in_sync():

services/catalog/tests/unit/test__model_examples.py

@@ -4,25 +4,24 @@
 # pylint: disable=unused-argument
 # pylint: disable=unused-variable
 
-import json
 from typing import Any
 
 import pytest
 import simcore_service_catalog.models
-from pydantic import BaseModel, ValidationError
-from pytest_simcore.pydantic_models import walk_model_examples_in_package
+from pydantic import BaseModel
+from pytest_simcore.pydantic_models import (
+    assert_validation_model,
+    walk_model_examples_in_package,
+)
 
 
 @pytest.mark.parametrize(
     "model_cls, example_name, example_data",
     walk_model_examples_in_package(simcore_service_catalog.models),
 )
 def test_catalog_service_model_examples(
-    model_cls: type[BaseModel], example_name: int, example_data: Any
+    model_cls: type[BaseModel], example_name: str, example_data: Any
 ):
-    try:
-        assert model_cls.model_validate(example_data) is not None
-    except ValidationError as err:
-        pytest.fail(
-            f"\n{example_name}: {json.dumps(example_data, indent=1)}\nError: {err}"
-        )
+    assert_validation_model(
+        model_cls, example_name=example_name, example_data=example_data
+    )

services/director/tests/unit/test__model_examples.py

@@ -4,25 +4,24 @@
 # pylint: disable=unused-argument
 # pylint: disable=unused-variable
 
-import json
 from typing import Any
 
 import pytest
 import simcore_service_director.models
-from pydantic import BaseModel, ValidationError
-from pytest_simcore.pydantic_models import walk_model_examples_in_package
+from pydantic import BaseModel
+from pytest_simcore.pydantic_models import (
+    assert_validation_model,
+    walk_model_examples_in_package,
+)
 
 
 @pytest.mark.parametrize(
     "model_cls, example_name, example_data",
     walk_model_examples_in_package(simcore_service_director.models),
 )
 def test_director_service_model_examples(
-    model_cls: type[BaseModel], example_name: int, example_data: Any
+    model_cls: type[BaseModel], example_name: str, example_data: Any
 ):
-    try:
-        assert model_cls.model_validate(example_data) is not None
-    except ValidationError as err:
-        pytest.fail(
-            f"\n{example_name}: {json.dumps(example_data, indent=1)}\nError: {err}"
-        )
+    assert_validation_model(
+        model_cls, example_name=example_name, example_data=example_data
+    )