✨ Enhance test coverage for job-marked projects by introducing fixtures and refactoring test cases

Author: pcrespov

services/web/server/tests/unit/with_dbs/02/test_projects__jobs_service.py

@@ -1,8 +1,16 @@
+# pylint: disable=redefined-outer-name
+# pylint: disable=unused-argument
+# pylint: disable=unused-variable
+# pylint: disable=too-many-arguments
+
+from dataclasses import dataclass
+
 import pytest
 from aiohttp.test_utils import TestClient
 from common_library.users_enums import UserRole
 from models_library.products import ProductName
 from models_library.projects import ProjectID
+from models_library.users import UserID
 from pytest_simcore.helpers.webserver_login import UserInfoDict
 from simcore_service_webserver.projects._jobs_service import (
     list_my_projects_marked_as_jobs,
@@ -11,12 +19,46 @@
 from simcore_service_webserver.projects.models import ProjectDict
 
 
+@dataclass
+class ProjectJobFixture:
+    user_id: UserID
+    project_uuid: ProjectID
+    job_parent_resource_name: str
+
+
 @pytest.fixture
 def user_role() -> UserRole:
     # for logged_user
     return UserRole.USER
 
 
+@pytest.fixture
+async def project_job_fixture(
+    client: TestClient,
+    logged_user: UserInfoDict,
+    user_project: ProjectDict,
+    osparc_product_name: ProductName,
+) -> ProjectJobFixture:
+    assert client.app
+
+    user_id = logged_user["id"]
+    project_uuid = ProjectID(user_project["uuid"])
+    job_parent_resource_name = "test/resource"
+
+    await set_project_as_job(
+        app=client.app,
+        product_name=osparc_product_name,
+        user_id=user_id,
+        project_uuid=project_uuid,
+        job_parent_resource_name=job_parent_resource_name,
+    )
+    return ProjectJobFixture(
+        user_id=user_id,
+        project_uuid=project_uuid,
+        job_parent_resource_name=job_parent_resource_name,
+    )
+
+
 async def test_list_my_projects_marked_as_jobs_empty(
     client: TestClient,
     logged_user: UserInfoDict,  # owns `user_project`
@@ -35,45 +77,37 @@ async def test_list_my_projects_marked_as_jobs_empty(
     assert result == []
 
 
-async def test_list_my_projects_marked_as_jobs_with_one_marked(
+async def test_user_can_see_marked_project(
     client: TestClient,
-    logged_user: UserInfoDict,  # owns `user_project`
-    user_project: ProjectDict,
-    user: UserInfoDict,
     osparc_product_name: ProductName,
+    project_job_fixture: ProjectJobFixture,
 ):
     assert client.app
-
-    user_id = logged_user["id"]
-    project_uuid = ProjectID(user_project["uuid"])
-    other_user_id = user["id"]
-
-    assert user_id != other_user_id
-    assert user_project["prjOwner"] == logged_user["email"]  # owns `user_project`
-
-    job_parent_resource_name = "test/resource"
-    await set_project_as_job(
-        app=client.app,
-        product_name=osparc_product_name,
-        user_id=user_id,
-        project_uuid=project_uuid,
-        job_parent_resource_name=job_parent_resource_name,
-    )
-
-    # user can see the project
     total_count, result = await list_my_projects_marked_as_jobs(
         app=client.app,
         product_name=osparc_product_name,
-        user_id=user_id,
+        user_id=project_job_fixture.user_id,
     )
     assert total_count == 1
     assert len(result) == 1
 
     project = result[0]
-    assert project.uuid == project_uuid
-    assert project.job_parent_resource_name == job_parent_resource_name
+    assert project.uuid == project_job_fixture.project_uuid
+    assert (
+        project.job_parent_resource_name == project_job_fixture.job_parent_resource_name
+    )
+
+
+async def test_other_user_cannot_see_marked_project(
+    client: TestClient,
+    user: UserInfoDict,
+    osparc_product_name: ProductName,
+    project_job_fixture: ProjectJobFixture,
+):
+    assert client.app
+    other_user_id = user["id"]
+    assert project_job_fixture.user_id != other_user_id
 
-    # other-user cannot see the project even if it is marked as a job
     total_count, result = await list_my_projects_marked_as_jobs(
         app=client.app,
         product_name=osparc_product_name,
@@ -82,39 +116,51 @@ async def test_list_my_projects_marked_as_jobs_with_one_marked(
     assert total_count == 0
     assert len(result) == 0
 
-    # user can see the project with a filter
+
+async def test_user_can_filter_marked_project(
+    client: TestClient,
+    osparc_product_name: ProductName,
+    project_job_fixture: ProjectJobFixture,
+):
+    assert client.app
+
+    # Exact filter
     total_count, result = await list_my_projects_marked_as_jobs(
         app=client.app,
         product_name=osparc_product_name,
-        user_id=user_id,
-        job_parent_resource_name_filter=job_parent_resource_name,
+        user_id=project_job_fixture.user_id,
+        job_parent_resource_name_filter=project_job_fixture.job_parent_resource_name,
     )
     assert total_count == 1
     assert len(result) == 1
 
     project = result[0]
-    assert project.uuid == project_uuid
-    assert project.job_parent_resource_name == job_parent_resource_name
+    assert project.uuid == project_job_fixture.project_uuid
+    assert (
+        project.job_parent_resource_name == project_job_fixture.job_parent_resource_name
+    )
 
-    # user can see the project with a wildcard filter
+    # Wildcard filter
     total_count, result = await list_my_projects_marked_as_jobs(
         app=client.app,
         product_name=osparc_product_name,
-        user_id=user_id,
+        user_id=project_job_fixture.user_id,
         job_parent_resource_name_filter="test/%",
     )
     assert total_count == 1
     assert len(result) == 1
 
     project = result[0]
-    assert project.uuid == project_uuid
-    assert project.job_parent_resource_name == job_parent_resource_name
+    assert project.uuid == project_job_fixture.project_uuid
+    assert (
+        project.job_parent_resource_name == project_job_fixture.job_parent_resource_name
+    )
 
-    # user cannot see the project with another wildcard filter
+    # Non-matching filter
     total_count, result = await list_my_projects_marked_as_jobs(
         app=client.app,
         product_name=osparc_product_name,
-        user_id=user_id,
+        user_id=project_job_fixture.user_id,
         job_parent_resource_name_filter="other/%",
     )
     assert total_count == 0