@sanderegg review: config error

Author: pcrespov

packages/service-library/src/servicelib/fastapi/lifespan_utils.py

@@ -1,13 +1,24 @@
 from collections.abc import AsyncIterator
 from typing import Protocol
 
+from common_library.errors_classes import OsparcErrorMixin
 from fastapi import FastAPI
 from fastapi_lifespan_manager import LifespanManager, State
 
 
+class LifespanError(OsparcErrorMixin, RuntimeError): ...
+
+
+class LifespanOnStartupError(LifespanError):
+    msg_template = "Failed during startup of {module}"
+
+
+class LifespanOnShutdownError(LifespanError):
+    msg_template = "Failed during shutdown of {module}"
+
+
 class LifespanGenerator(Protocol):
-    def __call__(self, app: FastAPI) -> AsyncIterator["State"]:
-        ...
+    def __call__(self, app: FastAPI) -> AsyncIterator["State"]: ...
 
 
 def combine_lifespans(*generators: LifespanGenerator) -> LifespanManager:

packages/service-library/src/servicelib/fastapi/postgres_lifespan.py

@@ -8,6 +8,7 @@
 from sqlalchemy.ext.asyncio import AsyncEngine
 
 from ..db_asyncpg_utils import create_async_engine_and_database_ready
+from .lifespan_utils import LifespanOnStartupError
 
 _logger = logging.getLogger(__name__)
 
@@ -20,6 +21,10 @@ class PostgresLifespanStateKeys(str, Enum):
     POSTGRES_ASYNC_ENGINE = "postgres.async_engine"
 
 
+class PostgresConfigurationError(LifespanOnStartupError):
+    msg_template = "Invalid postgres settings [={pg_settings}] on startup. Note that postgres cannot be disabled using settings"
+
+
 @postgres_lifespan_manager.add
 async def setup_postgres_database(_, state: State) -> AsyncIterator[State]:
 
@@ -30,8 +35,7 @@ async def setup_postgres_database(_, state: State) -> AsyncIterator[State]:
         ]
 
         if pg_settings is None or not isinstance(pg_settings, PostgresSettings):
-            msg = f"Invalid {pg_settings=} on startup. Postgres cannot be disabled using settings"
-            raise RuntimeError(msg)
+            raise PostgresConfigurationError(pg_settings=pg_settings, module="postgres")
 
         assert isinstance(pg_settings, PostgresSettings)  # nosec
 

packages/service-library/tests/fastapi/test_lifespan_utils.py

@@ -11,12 +11,15 @@
 
 import pytest
 from asgi_lifespan import LifespanManager as ASGILifespanManager
-from common_library.errors_classes import OsparcErrorMixin
 from fastapi import FastAPI
 from fastapi_lifespan_manager import LifespanManager, State
 from pytest_mock import MockerFixture
 from pytest_simcore.helpers.logging_tools import log_context
-from servicelib.fastapi.lifespan_utils import combine_lifespans
+from servicelib.fastapi.lifespan_utils import (
+    LifespanOnShutdownError,
+    LifespanOnStartupError,
+    combine_lifespans,
+)
 
 
 async def test_multiple_lifespan_managers(capsys: pytest.CaptureFixture):
@@ -161,17 +164,6 @@ async def setup_rpc_server(app: FastAPI, state: State) -> AsyncIterator[State]:
     #     <- postgres_sync_engine done (1ms)
 
 
-class LifespanError(OsparcErrorMixin, RuntimeError): ...
-
-
-class LifespanOnStartupError(LifespanError):
-    msg_template = "Failed during startup of {module}"
-
-
-class LifespanOnShutdownError(LifespanError):
-    msg_template = "Failed during shutdown of {module}"
-
-
 @pytest.fixture
 def failing_lifespan_manager(mocker: MockerFixture):
     startup_step = mocker.MagicMock()

packages/service-library/tests/fastapi/test_postgres_lifespan.py

@@ -17,6 +17,7 @@
 from pytest_simcore.helpers.monkeypatch_envs import setenvs_from_dict
 from pytest_simcore.helpers.typing_env import EnvVarsDict
 from servicelib.fastapi.postgres_lifespan import (
+    PostgresConfigurationError,
     PostgresLifespanStateKeys,
     postgres_lifespan_manager,
 )
@@ -147,3 +148,25 @@ async def my_faulty_setup(app: FastAPI, state: State) -> AsyncIterator[State]:
     # Verify that the engine was disposed even if error happend
     async_engine: Any = mock_create_async_engine_and_database_ready.return_value
     async_engine.dispose.assert_called_once()
+
+
+async def test_setup_postgres_database_with_empty_pg_settings(
+    is_pdb_enabled: bool,
+):
+    async def my_app_settings(app: FastAPI) -> AsyncIterator[State]:
+        yield {PostgresLifespanStateKeys.POSTGRES_SETTINGS: None}
+
+    app_lifespan_manager = LifespanManager()
+    app_lifespan_manager.add(my_app_settings)
+
+    app_lifespan_manager.include(postgres_lifespan_manager)
+
+    app = FastAPI(lifespan=app_lifespan_manager)
+
+    with pytest.raises(PostgresConfigurationError, match="postgres cannot be disabled"):
+        async with ASGILifespanManager(
+            app,
+            startup_timeout=None if is_pdb_enabled else 10,
+            shutdown_timeout=None if is_pdb_enabled else 10,
+        ):
+            ...