adds mock for bg

Author: pcrespov

services/web/server/src/simcore_service_webserver/garbage_collector/plugin.py

@@ -3,17 +3,12 @@
 from aiohttp import web
 from servicelib.aiohttp.application_setup import ModuleCategory, app_module_setup
 from servicelib.logging_utils import set_parent_module_log_level
-from simcore_service_webserver.garbage_collector._tasks_trash import (
-    create_background_task_to_prune_trash,
-)
 
 from ..application_settings import get_application_settings
 from ..login.plugin import setup_login_storage
 from ..projects.db import setup_projects_db
 from ..socketio.plugin import setup_socketio
-from ._tasks_api_keys import create_background_task_to_prune_api_keys
-from ._tasks_core import run_background_task
-from ._tasks_users import create_background_task_for_trial_accounts
+from . import _tasks_api_keys, _tasks_core, _tasks_trash, _tasks_users
 from .settings import get_plugin_settings
 
 _logger = logging.getLogger(__name__)
@@ -35,7 +30,7 @@ def setup_garbage_collector(app: web.Application) -> None:
 
     settings = get_plugin_settings(app)
 
-    app.cleanup_ctx.append(run_background_task)
+    app.cleanup_ctx.append(_tasks_core.run_background_task)
 
     set_parent_module_log_level(
         _logger.name, min(logging.INFO, get_application_settings(app).log_level)
@@ -48,10 +43,17 @@ def setup_garbage_collector(app: web.Application) -> None:
     # If more tasks of this nature are needed, we should setup some sort of registration mechanism
     # with a interface such that plugins can pass tasks to the GC plugin to handle them
     interval_s = settings.GARBAGE_COLLECTOR_EXPIRED_USERS_CHECK_INTERVAL_S
-    app.cleanup_ctx.append(create_background_task_for_trial_accounts(interval_s))
+    app.cleanup_ctx.append(
+        _tasks_users.create_background_task_for_trial_accounts(interval_s)
+    )
 
     # SEE https://github.com/ITISFoundation/osparc-issues/issues/705
     wait_period_s = settings.GARBAGE_COLLECTOR_PRUNE_APIKEYS_INTERVAL_S
-    app.cleanup_ctx.append(create_background_task_to_prune_api_keys(wait_period_s))
+    app.cleanup_ctx.append(
+        _tasks_api_keys.create_background_task_to_prune_api_keys(wait_period_s)
+    )
 
-    app.cleanup_ctx.append(create_background_task_to_prune_trash(wait_period_s))
+    # SEE https://github.com/ITISFoundation/osparc-issues#468
+    app.cleanup_ctx.append(
+        _tasks_trash.create_background_task_to_prune_trash(wait_period_s)
+    )

services/web/server/tests/unit/with_dbs/03/trash/conftest.py

@@ -6,20 +6,26 @@
 # pylint: disable=unused-variable
 
 
+import logging
 from collections.abc import AsyncIterable, Callable
 from pathlib import Path
 
 import pytest
+from aiohttp import web
 from aiohttp.test_utils import TestClient
 from aioresponses import aioresponses
 from models_library.products import ProductName
+from pytest_mock import MockerFixture
+from pytest_simcore.helpers.logging_tools import log_context
 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 NewUser, UserInfoDict
 from pytest_simcore.helpers.webserver_parametrizations import MockedStorageSubsystem
 from pytest_simcore.helpers.webserver_projects import NewProject
 from simcore_service_webserver.projects.models import ProjectDict
 
+_logger = logging.getLogger(__name__)
+
 
 @pytest.fixture
 def app_environment(
@@ -79,3 +85,18 @@ def mocked_director_v2(director_v2_service_mock: aioresponses):
 @pytest.fixture
 def mocked_storage(storage_subsystem_mock: MockedStorageSubsystem):
     ...
+
+
+@pytest.fixture
+def with_disabled_background_task_to_prune_trash(mocker: MockerFixture) -> None:
+    async def _empty_lifespan(app: web.Application):
+        with log_context(
+            logging.INFO, "Fake background_task_to_prune_trash event", logger=_logger
+        ):
+            yield
+
+    mocker.patch(
+        "simcore_service_webserver.garbage_collector._tasks_trash.create_background_task_to_prune_trash",
+        autospec=True,
+        return_value=_empty_lifespan,
+    )

services/web/server/tests/unit/with_dbs/03/trash/test_trash_service.py

@@ -20,15 +20,21 @@
 from simcore_service_webserver.db.models import UserRole
 from simcore_service_webserver.projects import _trash_service
 from simcore_service_webserver.projects.models import ProjectDict
-from simcore_service_webserver.trash._service import delete_expired_trash
+from simcore_service_webserver.trash import trash_service
 
 
 @pytest.fixture
 def app_environment(
-    app_environment: EnvVarsDict, monkeypatch: pytest.MonkeyPatch
+    app_environment: EnvVarsDict,
+    monkeypatch: pytest.MonkeyPatch,
+    with_disabled_background_task_to_prune_trash: None,
 ) -> EnvVarsDict:
     return app_environment | setenvs_from_dict(
-        monkeypatch, {"TRASH_RETENTION_DAYS": "0"}
+        monkeypatch,
+        {
+            "TRASH_RETENTION_DAYS": "0",
+            "WEBSERVER_GARBAGE_COLLECTOR": "null",
+        },
     )
 
 
@@ -104,7 +110,7 @@ async def test_trash_service__delete_expired_trash(
     assert ProjectGet.model_validate(data).trashed_by == logged_user["primary_gid"]
 
     # UNDER TEST: Run delete_expired_trash
-    await delete_expired_trash(client.app)
+    await trash_service.delete_expired_trash(client.app)
 
     # ASSERT: logged_user tries to get the project and expects 404
     resp = await client.get(f"/v0/projects/{user_project_id}")