✨ [Tests] Enhance test fixtures with AsyncExitStack for better resource management

Author: pcrespov

services/web/server/tests/conftest.py

@@ -4,6 +4,7 @@
 # pylint: disable=unused-variable
 
 import asyncio
+import contextlib
 import json
 import logging
 import random
@@ -88,6 +89,13 @@
 ]
 
 
+@pytest.fixture
+async def exit_stack() -> AsyncIterator[contextlib.AsyncExitStack]:
+    """Provides an AsyncExitStack that gets cleaned up after each test"""
+    async with contextlib.AsyncExitStack() as stack:
+        yield stack
+
+
 @pytest.fixture(scope="session")
 def package_dir() -> Path:
     """osparc-simcore installed directory"""

services/web/server/tests/integration/01/test_garbage_collection.py

@@ -3,6 +3,7 @@
 # pylint: disable=unused-variable
 
 import asyncio
+import contextlib
 import logging
 import re
 from collections.abc import AsyncIterable, Awaitable, Callable
@@ -203,14 +204,20 @@ async def _fake_background_task(app: web.Application):
     )
 
 
-async def login_user(client: TestClient):
+async def login_user(client: TestClient, *, exit_stack: contextlib.AsyncExitStack):
     """returns a logged in regular user"""
-    return await log_client_in(client=client, user_data={"role": UserRole.USER.name})
+    return await log_client_in(
+        client=client, user_data={"role": UserRole.USER.name}, exit_stack=exit_stack
+    )
 
 
-async def login_guest_user(client: TestClient):
+async def login_guest_user(
+    client: TestClient, *, exit_stack: contextlib.AsyncExitStack
+):
     """returns a logged in Guest user"""
-    return await log_client_in(client=client, user_data={"role": UserRole.GUEST.name})
+    return await log_client_in(
+        client=client, user_data={"role": UserRole.GUEST.name}, exit_stack=exit_stack
+    )
 
 
 async def new_project(
@@ -482,10 +489,11 @@ async def test_t1_while_guest_is_connected_no_resources_are_removed(
     aiopg_engine: aiopg.sa.engine.Engine,
     tests_data_dir: Path,
     osparc_product_name: str,
+    exit_stack: contextlib.AsyncExitStack,
 ):
     """while a GUEST user is connected GC will not remove none of its projects nor the user itself"""
     assert client.app
-    logged_guest_user = await login_guest_user(client)
+    logged_guest_user = await login_guest_user(client, exit_stack=exit_stack)
     empty_guest_user_project = await new_project(
         client, logged_guest_user, osparc_product_name, tests_data_dir
     )
@@ -508,10 +516,11 @@ async def test_t2_cleanup_resources_after_browser_is_closed(
     aiopg_engine: aiopg.sa.engine.Engine,
     tests_data_dir: Path,
     osparc_product_name: str,
+    exit_stack: contextlib.AsyncExitStack,
 ):
     """After a GUEST users with one opened project closes browser tab regularly (GC cleans everything)"""
     assert client.app
-    logged_guest_user = await login_guest_user(client)
+    logged_guest_user = await login_guest_user(client, exit_stack=exit_stack)
     empty_guest_user_project = await new_project(
         client, logged_guest_user, osparc_product_name, tests_data_dir
     )
@@ -557,11 +566,12 @@ async def test_t3_gc_will_not_intervene_for_regular_users_and_their_resources(
     fake_project: dict,
     tests_data_dir: Path,
     osparc_product_name: str,
+    exit_stack: contextlib.AsyncExitStack,
 ):
     """after a USER disconnects the GC will remove none of its projects or templates nor the user itself"""
     number_of_projects = 5
     number_of_templates = 5
-    logged_user = await login_user(client)
+    logged_user = await login_user(client, exit_stack=exit_stack)
     user_projects = [
         await new_project(client, logged_user, osparc_product_name, tests_data_dir)
         for _ in range(number_of_projects)
@@ -604,16 +614,17 @@ async def test_t4_project_shared_with_group_transferred_to_user_in_group_on_owne
     aiopg_engine: aiopg.sa.engine.Engine,
     tests_data_dir: Path,
     osparc_product_name: str,
+    exit_stack: contextlib.AsyncExitStack,
 ):
     """
     USER "u1" creates a GROUP "g1" and invites USERS "u2" and "u3";
     USER "u1" creates a project and shares it with "g1";
     USER "u1" is manually marked as "GUEST";
     EXPECTED: one of the users in the "g1" will become the new owner of the project and "u1" will be deleted
     """
-    u1 = await login_user(client)
-    u2 = await login_user(client)
-    u3 = await login_user(client)
+    u1 = await login_user(client, exit_stack=exit_stack)
+    u2 = await login_user(client, exit_stack=exit_stack)
+    u3 = await login_user(client, exit_stack=exit_stack)
 
     # creating g1 and inviting u2 and u3
     g1 = await get_group(client, u1)
@@ -648,15 +659,16 @@ async def test_t5_project_shared_with_other_users_transferred_to_one_of_them(
     aiopg_engine: aiopg.sa.engine.Engine,
     tests_data_dir: Path,
     osparc_product_name: str,
+    exit_stack: contextlib.AsyncExitStack,
 ):
     """
     USER "u1" creates a project and shares it with "u2" and "u3";
     USER "u1" is manually marked as "GUEST";
     EXPECTED: one of "u2" or "u3" will become the new owner of the project and "u1" will be deleted
     """
-    u1 = await login_user(client)
-    u2 = await login_user(client)
-    u3 = await login_user(client)
+    u1 = await login_user(client, exit_stack=exit_stack)
+    u2 = await login_user(client, exit_stack=exit_stack)
+    u3 = await login_user(client, exit_stack=exit_stack)
 
     q_u2 = await fetch_user_from_db(aiopg_engine, u2)
     assert q_u2
@@ -694,6 +706,7 @@ async def test_t6_project_shared_with_group_transferred_to_last_user_in_group_on
     aiopg_engine: aiopg.sa.engine.Engine,
     tests_data_dir: Path,
     osparc_product_name: str,
+    exit_stack: contextlib.AsyncExitStack,
 ):
     """
     USER "u1" creates a GROUP "g1" and invites USERS "u2" and "u3";
@@ -703,9 +716,9 @@ async def test_t6_project_shared_with_group_transferred_to_last_user_in_group_on
     the new owner either "u2" or "u3" will be manually marked as "GUEST";
     EXPECTED: the GUEST user will be deleted and the project will pass to the last member of "g1"
     """
-    u1 = await login_user(client)
-    u2 = await login_user(client)
-    u3 = await login_user(client)
+    u1 = await login_user(client, exit_stack=exit_stack)
+    u2 = await login_user(client, exit_stack=exit_stack)
+    u3 = await login_user(client, exit_stack=exit_stack)
 
     # creating g1 and inviting u2 and u3
     g1 = await get_group(client, u1)
@@ -765,6 +778,7 @@ async def test_t7_project_shared_with_group_transferred_from_one_member_to_the_l
     aiopg_engine: aiopg.sa.engine.Engine,
     tests_data_dir: Path,
     osparc_product_name: str,
+    exit_stack: contextlib.AsyncExitStack,
 ):
     """
     USER "u1" creates a GROUP "g1" and invites USERS "u2" and "u3";
@@ -777,9 +791,9 @@ async def test_t7_project_shared_with_group_transferred_from_one_member_to_the_l
     EXPECTED: the last user will be removed and the project will be removed
     """
     assert client.app
-    u1 = await login_user(client)
-    u2 = await login_user(client)
-    u3 = await login_user(client)
+    u1 = await login_user(client, exit_stack=exit_stack)
+    u2 = await login_user(client, exit_stack=exit_stack)
+    u3 = await login_user(client, exit_stack=exit_stack)
 
     # creating g1 and inviting u2 and u3
     g1 = await get_group(client, u1)
@@ -853,6 +867,7 @@ async def test_t8_project_shared_with_other_users_transferred_to_one_of_them_unt
     aiopg_engine: aiopg.sa.engine.Engine,
     tests_data_dir: Path,
     osparc_product_name: str,
+    exit_stack: contextlib.AsyncExitStack,
 ):
     """
     USER "u1" creates a project and shares it with "u2" and "u3";
@@ -861,9 +876,9 @@ async def test_t8_project_shared_with_other_users_transferred_to_one_of_them_unt
     same as T5 => afterwards afterwards the new owner either "u2" or "u3" will be manually marked as "GUEST";
     EXPECTED: the GUEST user will be deleted and the project will pass to the last member of "g1"
     """
-    u1 = await login_user(client)
-    u2 = await login_user(client)
-    u3 = await login_user(client)
+    u1 = await login_user(client, exit_stack=exit_stack)
+    u2 = await login_user(client, exit_stack=exit_stack)
+    u3 = await login_user(client, exit_stack=exit_stack)
 
     q_u2 = await fetch_user_from_db(aiopg_engine, u2)
     assert q_u2
@@ -927,6 +942,7 @@ async def test_t9_project_shared_with_other_users_transferred_between_them_and_t
     aiopg_engine: aiopg.sa.engine.Engine,
     tests_data_dir: Path,
     osparc_product_name: str,
+    exit_stack: contextlib.AsyncExitStack,
 ):
     """
     USER "u1" creates a project and shares it with "u2" and "u3";
@@ -937,9 +953,9 @@ async def test_t9_project_shared_with_other_users_transferred_between_them_and_t
     same as T8 => afterwards the last user will be marked as "GUEST";
     EXPECTED: the last user will be removed and the project will be removed
     """
-    u1 = await login_user(client)
-    u2 = await login_user(client)
-    u3 = await login_user(client)
+    u1 = await login_user(client, exit_stack=exit_stack)
+    u2 = await login_user(client, exit_stack=exit_stack)
+    u3 = await login_user(client, exit_stack=exit_stack)
 
     q_u2 = await fetch_user_from_db(aiopg_engine, u2)
     assert q_u2
@@ -1014,6 +1030,7 @@ async def test_t10_owner_and_all_shared_users_marked_as_guests(
     aiopg_engine: aiopg.sa.engine.Engine,
     tests_data_dir: Path,
     osparc_product_name: str,
+    exit_stack: contextlib.AsyncExitStack,
 ):
     """
     USER "u1" creates a project and shares it with "u2" and "u3";
@@ -1026,9 +1043,9 @@ async def test_t10_owner_and_all_shared_users_marked_as_guests(
     )
     assert not gc_task.done()
 
-    u1 = await login_user(client)
-    u2 = await login_user(client)
-    u3 = await login_user(client)
+    u1 = await login_user(client, exit_stack=exit_stack)
+    u2 = await login_user(client, exit_stack=exit_stack)
+    u3 = await login_user(client, exit_stack=exit_stack)
 
     q_u2 = await fetch_user_from_db(aiopg_engine, u2)
     q_u3 = await fetch_user_from_db(aiopg_engine, u3)
@@ -1067,16 +1084,17 @@ async def test_t11_owner_and_all_users_in_group_marked_as_guests(
     aiopg_engine: aiopg.sa.engine.Engine,
     tests_data_dir: Path,
     osparc_product_name: str,
+    exit_stack: contextlib.AsyncExitStack,
 ):
     """
     USER "u1" creates a group and invites "u2" and "u3";
     USER "u1" creates a project and shares it with the group
     USER "u1", "u2" and "u3" are manually marked as "GUEST"
     EXPECTED: the project and all the users are removed
     """
-    u1 = await login_user(client)
-    u2 = await login_user(client)
-    u3 = await login_user(client)
+    u1 = await login_user(client, exit_stack=exit_stack)
+    u2 = await login_user(client, exit_stack=exit_stack)
+    u3 = await login_user(client, exit_stack=exit_stack)
 
     # creating g1 and inviting u2 and u3
     g1 = await get_group(client, u1)

services/web/server/tests/unit/with_dbs/01/groups/test_groups_handlers_crud.py

@@ -59,7 +59,7 @@ async def test_list_user_groups_and_try_modify_organizations(
 ):
     assert client.app
     assert logged_user["id"] != standard_groups_owner["id"]
-    assert logged_user["role"] == user_role.value
+    assert logged_user["role"] == user_role
 
     # List all groups (organizations, primary, everyone and products) I belong to
     url = client.app.router["list_groups"].url_for()
@@ -130,7 +130,7 @@ async def test_group_creation_workflow(
 ):
     assert client.app
     assert logged_user["id"] != 0
-    assert logged_user["role"] == user_role.value
+    assert logged_user["role"] == user_role
 
     url = client.app.router["create_group"].url_for()
     new_group_data = {

services/web/server/tests/unit/with_dbs/01/groups/test_groups_handlers_users.py

@@ -552,7 +552,7 @@ async def test_create_organization_and_add_users(
 ):
     assert client.app
     assert logged_user["id"] != 0
-    assert logged_user["role"] == user_role.value
+    assert logged_user["role"] == user_role
 
     # CREATE GROUP
     url = client.app.router["create_group"].url_for()

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

@@ -311,7 +311,7 @@ async def test_share_project_with_roles(
 ):
     assert client.app
 
-    assert logged_user["role"] == user_role.value
+    assert logged_user["role"] == user_role
 
     # Attempt to share the project
     url = client.app.router["share_project"].url_for(

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

@@ -6,6 +6,7 @@
 # pylint: disable=unused-variable
 
 import asyncio
+import contextlib
 import time
 from collections.abc import AsyncIterator, Awaitable, Callable, Iterator
 from copy import deepcopy
@@ -280,6 +281,7 @@ async def test_share_project(
     share_rights: dict,
     project_db_cleaner,
     request_create_project: Callable[..., Awaitable[ProjectDict]],
+    exit_stack: contextlib.AsyncExitStack,
 ):
     # Use-case: the user shares some projects with a group
 
@@ -303,7 +305,10 @@ async def test_share_project(
 
     # get another user logged in now
     await log_client_in(
-        client, {"role": user_role.name}, enable_check=user_role != UserRole.ANONYMOUS
+        client,
+        {"role": user_role.name},
+        enable_check=user_role != UserRole.ANONYMOUS,
+        exit_stack=exit_stack,
     )
     if new_project:
         # user 2 can get the project if user 2 has read access
@@ -1272,6 +1277,7 @@ async def test_open_shared_project_2_users_locked(
     clean_redis_table: None,
     mock_dynamic_scheduler_rabbitmq: None,
     mocked_notifications_plugin: dict[str, mock.Mock],
+    exit_stack: contextlib.AsyncExitStack,
 ):
     # Use-case: user 1 opens a shared project, user 2 tries to open it as well
     mock_project_state_updated_handler = mocker.Mock()
@@ -1332,7 +1338,10 @@ async def test_open_shared_project_2_users_locked(
 
     # 2. create a separate client now and log in user2, try to open the same shared project
     user_2 = await log_client_in(
-        client_2, {"role": user_role.name}, enable_check=user_role != UserRole.ANONYMOUS
+        client_2,
+        {"role": user_role.name},
+        enable_check=user_role != UserRole.ANONYMOUS,
+        exit_stack=exit_stack,
     )
     await _connect_websocket(
         socketio_client_factory,
@@ -1454,6 +1463,7 @@ async def test_open_shared_project_at_same_time(
     clean_redis_table,
     mock_dynamic_scheduler_rabbitmq: None,
     mocked_notifications_plugin: dict[str, mock.Mock],
+    exit_stack: contextlib.AsyncExitStack,
 ):
     NUMBER_OF_ADDITIONAL_CLIENTS = 10
     # log client 1
@@ -1475,6 +1485,7 @@ async def test_open_shared_project_at_same_time(
             new_client,
             {"role": user_role.name},
             enable_check=user_role != UserRole.ANONYMOUS,
+            exit_stack=exit_stack,
         )
         client_id = client_session_id_factory()
         sio = await _connect_websocket(

services/web/server/tests/unit/with_dbs/03/test_email.py

@@ -15,13 +15,14 @@
 import pytest
 from aiohttp import web
 from aiohttp.test_utils import TestClient, make_mocked_request
+from common_library.users_enums import UserRole
 from faker import Faker
 from pydantic import ValidationError
 from pytest_mock import MockerFixture
 from pytest_simcore.helpers.assert_checks import assert_status
 from pytest_simcore.helpers.monkeypatch_envs import setenvs_from_dict
 from pytest_simcore.helpers.typing_env import EnvVarsDict
-from pytest_simcore.helpers.webserver_login import UserInfoDict, UserRole
+from pytest_simcore.helpers.webserver_users import UserInfoDict
 from servicelib.aiohttp import status
 from settings_library.email import EmailProtocol, SMTPSettings
 from simcore_service_webserver._meta import API_VTAG