cosmetic improvement

Author: bisgaard-itis

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

@@ -26,6 +26,14 @@
 class WebserverRpcSideEffects:
     # pylint: disable=no-self-use
 
+    def __init__(
+        self,
+        project_job_rpc_get: ProjectJobRpcGet = ProjectJobRpcGet.model_validate(
+            ProjectJobRpcGet.model_json_schema()["examples"][0]
+        ),
+    ):
+        self.project_job_rpc_get = project_job_rpc_get
+
     @validate_call(config={"arbitrary_types_allowed": True})
     async def mark_project_as_job(
         self,
@@ -104,7 +112,7 @@ async def get_project_marked_as_job(
         assert job_parent_resource_name
 
         # Return a valid example from the schema
-        example = ProjectJobRpcGet.model_json_schema()["examples"][0]
-        example["uuid"] = str(project_uuid)
-        example["job_parent_resource_name"] = job_parent_resource_name
-        return ProjectJobRpcGet.model_validate(example)
+        _data = self.project_job_rpc_get.model_dump()
+        _data["uuid"] = str(project_uuid)
+        _data["job_parent_resource_name"] = job_parent_resource_name
+        return ProjectJobRpcGet.model_validate(_data)

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

@@ -42,10 +42,11 @@
 from models_library.products import ProductName
 from models_library.projects import ProjectID
 from models_library.projects_nodes_io import BaseFileLink, SimcoreS3FileID
+from models_library.rpc.webserver.projects import ProjectJobRpcGet
 from models_library.users import UserID
 from moto.server import ThreadedMotoServer
 from packaging.version import Version
-from pydantic import EmailStr, HttpUrl, TypeAdapter
+from pydantic import EmailStr, HttpUrl, TypeAdapter, validate_call
 from pytest_mock import MockerFixture, MockType
 from pytest_simcore.helpers.catalog_rpc_server import CatalogRpcSideEffects
 from pytest_simcore.helpers.director_v2_rpc_server import DirectorV2SideEffects
@@ -543,9 +544,17 @@ def mocked_catalog_rest_api_base(
         yield respx_mock
 
 
+@pytest.fixture
+def project_job_rpc_get() -> ProjectJobRpcGet:
+    example = ProjectJobRpcGet.model_json_schema()["examples"][0]
+    return ProjectJobRpcGet.model_validate(example)
+
+
 @pytest.fixture
 def mocked_webserver_rpc_api(
-    mocked_app_dependencies: None, mocker: MockerFixture
+    mocked_app_dependencies: None,
+    mocker: MockerFixture,
+    project_job_rpc_get: ProjectJobRpcGet,
 ) -> dict[str, MockType]:
     """
     Mocks the webserver's simcore service RPC API for testing purposes.
@@ -554,7 +563,7 @@ def mocked_webserver_rpc_api(
         projects as projects_rpc,  # keep import here
     )
 
-    side_effects = WebserverRpcSideEffects()
+    side_effects = WebserverRpcSideEffects(project_job_rpc_get=project_job_rpc_get)
 
     return {
         "mark_project_as_job": mocker.patch.object(
@@ -578,6 +587,52 @@ def mocked_webserver_rpc_api(
     }
 
 
+@pytest.fixture
+def mocked_get_project_marked_as_job_storage_data_missing(
+    mocked_webserver_rpc_api: dict[str, MockType], mocker: MockerFixture
+) -> dict[str, MockType]:
+    from servicelib.rabbitmq.rpc_interfaces.webserver import (
+        projects as projects_rpc,  # keep import here
+    )
+
+    @validate_call(config={"arbitrary_types_allowed": True})
+    async def _get_project_marked_as_job(
+        rpc_client: RabbitMQRPCClient | MockType,
+        *,
+        product_name: ProductName,
+        user_id: UserID,
+        project_uuid: ProjectID,
+        job_parent_resource_name: str,
+    ) -> ProjectJobRpcGet:
+        assert rpc_client
+        assert product_name
+        assert user_id
+        assert project_uuid
+        assert job_parent_resource_name
+
+        # Return a valid example from the schema
+        example = ProjectJobRpcGet.model_json_schema()["examples"][0]
+        example["uuid"] = str(project_uuid)
+        example["job_parent_resource_name"] = job_parent_resource_name
+        example["storage_data_deleted"] = "true"
+        project_job_rpc_get = ProjectJobRpcGet.model_validate(example)
+        assert project_job_rpc_get.storage_data_deleted is True
+        return project_job_rpc_get
+
+    # Remove the previous patch if it exists
+    mocked_webserver_rpc_api["get_project_marked_as_job"].reset_mock()
+    del mocked_webserver_rpc_api["get_project_marked_as_job"]
+
+    # Add the new patch with the custom side effect
+    mocked_webserver_rpc_api["get_project_marked_as_job"] = mocker.patch.object(
+        projects_rpc,
+        "get_project_marked_as_job",
+        autospec=True,
+        side_effect=_get_project_marked_as_job,
+    )
+    return mocked_webserver_rpc_api
+
+
 @pytest.fixture
 def catalog_rpc_side_effects(request) -> Any:
     if "param" in dir(request) and request.param is not None:

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

@@ -3,6 +3,7 @@
 # pylint: disable=unused-variable
 # pylint: disable=too-many-arguments
 
+from datetime import datetime
 from decimal import Decimal
 from pathlib import Path
 from typing import Any, Final
@@ -15,19 +16,15 @@
 from fastapi.encoders import jsonable_encoder
 from httpx import AsyncClient
 from models_library.generics import Envelope
-from models_library.products import ProductName
-from models_library.projects import ProjectID
 from models_library.rpc.webserver.projects import ProjectJobRpcGet
-from models_library.users import UserID
-from pydantic import TypeAdapter, validate_call
-from pytest_mock import MockerFixture, MockType
+from pydantic import TypeAdapter
+from pytest_mock import MockType
 from pytest_simcore.helpers.httpx_calls_capture_models import (
     CreateRespxMockCallback,
     HttpApiCallCaptureModel,
     SideEffectCallback,
 )
 from respx import MockRouter
-from servicelib.rabbitmq import RabbitMQRPCClient
 from simcore_service_api_server._meta import API_VTAG
 from simcore_service_api_server.models.schemas.jobs import Job, JobStatus
 from simcore_service_api_server.models.schemas.model_adapter import (
@@ -352,56 +349,29 @@ async def test_start_solver_job_conflict(
     assert f"{job_status.job_id}" == _job_id
 
 
-@pytest.fixture
-def mocked_get_project_marked_as_job_storage_data_missing(
-    mocked_app_dependencies: None, mocker: MockerFixture
-) -> dict[str, MockType]:
-    """
-    Mocks the webserver's simcore service RPC API for testing purposes.
-    """
-    from servicelib.rabbitmq.rpc_interfaces.webserver import (
-        projects as projects_rpc,  # keep import here
-    )
-
-    @validate_call(config={"arbitrary_types_allowed": True})
-    async def _get_project_marked_as_job(
-        rpc_client: RabbitMQRPCClient | MockType,
-        *,
-        product_name: ProductName,
-        user_id: UserID,
-        project_uuid: ProjectID,
-        job_parent_resource_name: str,
-    ) -> ProjectJobRpcGet:
-        assert rpc_client
-        assert product_name
-        assert user_id
-        assert project_uuid
-        assert job_parent_resource_name
-
-        # Return a valid example from the schema
-        example = ProjectJobRpcGet.model_json_schema()["examples"][0]
-        example["uuid"] = str(project_uuid)
-        example["job_parent_resource_name"] = job_parent_resource_name
-        example["storage_data_deleted"] = "true"
-        project_job_rpc_get = ProjectJobRpcGet.model_validate(example)
-        assert project_job_rpc_get.storage_data_deleted is True
-        return project_job_rpc_get
-
-    return {
-        "get_project_marked_as_job": mocker.patch.object(
-            projects_rpc,
-            "get_project_marked_as_job",
-            autospec=True,
-            side_effect=_get_project_marked_as_job,
-        ),
-    }
-
-
+@pytest.mark.parametrize(
+    "project_job_rpc_get",
+    [
+        pytest.param(
+            ProjectJobRpcGet(
+                uuid=UUID("00000000-1234-5678-1234-123456789012"),
+                name="A study job",
+                description="A description of a study job with many node",
+                workbench={},
+                created_at=datetime.fromisoformat("2023-02-01T00:00:00Z"),
+                modified_at=datetime.fromisoformat("2023-02-01T00:00:00Z"),
+                job_parent_resource_name="studies/96642f2a-a72c-11ef-8776-02420a00087d",
+                storage_data_deleted=True,
+            ),
+            id="storage_data_deleted",
+        )
+    ],
+)
 async def test_start_solver_job_storage_data_missing(
     client: AsyncClient,
     mocked_webserver_rest_api_base: MockRouter,
     mocked_directorv2_rest_api_base: MockRouter,
-    mocked_get_project_marked_as_job_storage_data_missing: dict[str, MockType],
+    mocked_webserver_rpc_api: dict[str, MockType],
     create_respx_mock_from_capture: CreateRespxMockCallback,
     auth: httpx.BasicAuth,
     project_tests_dir: Path,