@sanderegg review: test origin of UserWarning, fixes issue in log validator and undos all warning

Author: pcrespov

packages/settings-library/setup.cfg

@@ -14,6 +14,7 @@ universal = 1
 # Define setup.py command aliases here
 test = pytest
 
-# NOTE: uncomment when pytest-asyncio is added in requirements
-# [tool:pytest]
-# asyncio_mode = auto
+[tool:pytest]
+# SEE https://docs.pytest.org/en/stable/how-to/capture-warnings.html
+filterwarnings =
+    error

packages/settings-library/src/settings_library/utils_logging.py

@@ -1,21 +1,23 @@
 import logging
 from functools import cached_property
 
+from common_library.basic_types import LogLevel
+
 
 class MixinLoggingSettings:
     """
     USAGE example in packages/settings-library/tests/test_utils_logging.py::test_mixin_logging
     """
 
     @classmethod
-    def validate_log_level(cls, value: str) -> str:
+    def validate_log_level(cls, value: str) -> LogLevel:
         """Standard implementation for @validator("LOG_LEVEL")"""
         try:
             getattr(logging, value.upper())
         except AttributeError as err:
             msg = f"{value.upper()} is not a valid level"
             raise ValueError(msg) from err
-        return value.upper()
+        return LogLevel(value.upper())
 
     @cached_property
     def log_level(self) -> int:

packages/settings-library/tests/test__pydantic_settings.py

@@ -12,11 +12,16 @@
 
 """
 
+from typing import Annotated
+
+import pytest
+from common_library.basic_types import LogLevel
 from common_library.pydantic_fields_extension import is_nullable
-from pydantic import ValidationInfo, field_validator
+from pydantic import AliasChoices, Field, ValidationInfo, field_validator
 from pydantic_core import PydanticUndefined
 from pydantic_settings import BaseSettings
 from pytest_simcore.helpers.monkeypatch_envs import setenvs_from_dict
+from settings_library.application import BaseApplicationSettings
 
 
 def assert_field_specs(
@@ -168,3 +173,28 @@ def test_construct(monkeypatch):
     assert settings_from_both == settings_from_init.model_copy(
         update={"VALUE_NULLABLE_REQUIRED": 3}
     )
+
+
+class _TestSettings(BaseApplicationSettings):
+    APP_LOGLEVEL: Annotated[
+        LogLevel,
+        Field(
+            validation_alias=AliasChoices("APP_LOGLEVEL", "LOG_LEVEL"),
+        ),
+    ] = LogLevel.WARNING
+
+
+@pytest.mark.filterwarnings("error")
+def test_pydantic_serialization_user_warning(monkeypatch: pytest.MonkeyPatch):
+    # This test is exploring the reason for `UserWarning`
+    #
+    # /python3.11/site-packages/pydantic/main.py:477: UserWarning: Pydantic serializer warnings:
+    #     Expected `enum` but got `str` with value `'WARNING'` - serialized value may not be as expected
+    #     return self.__pydantic_serializer__.to_json(
+    #
+    # NOTE: it seems settings.model_dump_json(warnings='none') is not the cause here of `UserWarning`
+    monkeypatch.setenv("LOG_LEVEL", "DEBUG")
+
+    settings = _TestSettings.create_from_envs()
+    assert settings.APP_LOGLEVEL == LogLevel.DEBUG
+    assert settings.model_dump_json(indent=2)

packages/settings-library/tests/test_twilio.py

@@ -20,7 +20,7 @@ def test_twilio_settings_within_envdevel(
             },
         )
         settings = TwilioSettings.create_from_envs()
-        print(settings.model_dump_json(indent=2, warnings="none"))
+        print(settings.model_dump_json(indent=2))
         assert settings
 
 

packages/settings-library/tests/test_utils_logging.py

@@ -42,7 +42,7 @@ def _v(cls, value: str) -> str:
     assert settings.LOG_LEVEL == "DEBUG"
 
     assert (
-        settings.model_dump_json(warnings="none")
+        settings.model_dump_json()
         == '{"SC_BOOT_MODE":null,"LOG_LEVEL":"DEBUG","APPNAME_DEBUG":false}'
     )
 

scripts/maintenance/migrate_project/src/cli.py

@@ -14,9 +14,7 @@
 def main(config: Path = typer.Option(..., exists=True)):
     assert config.exists()  # nosec
     settings = Settings.load_from_file(config)
-    typer.echo(
-        f"Detected settings:\n{settings.model_dump_json(indent=2,warnings='none')}\n"
-    )
+    typer.echo(f"Detected settings:\n{settings.model_dump_json(indent=2)}\n")
 
     r_clone_config_path = assemble_config_file(
         # source

services/agent/src/simcore_service_agent/core/application.py

@@ -41,7 +41,7 @@ def _setup_logger(settings: ApplicationSettings):
 def create_app() -> FastAPI:
     settings = ApplicationSettings.create_from_envs()
     _setup_logger(settings)
-    logger.debug(settings.model_dump_json(indent=2, warnings="none"))
+    logger.debug(settings.model_dump_json(indent=2))
 
     assert settings.SC_BOOT_MODE  # nosec
     app = FastAPI(

services/api-server/src/simcore_service_api_server/core/application.py

@@ -56,9 +56,7 @@ def init_app(settings: ApplicationSettings | None = None) -> FastAPI:
         logger_filter_mapping=settings.API_SERVER_LOG_FILTER_MAPPING,
         tracing_settings=settings.API_SERVER_TRACING,
     )
-    _logger.debug(
-        "App settings:\n%s", settings.model_dump_json(indent=2, warnings="none")
-    )
+    _logger.debug("App settings:\n%s", settings.model_dump_json(indent=2))
 
     # Labeling
     title = "osparc.io public API"

services/api-server/tests/unit/_with_db/test_core_settings__with_db.py

@@ -12,7 +12,7 @@
 
 def test_unit_with_db_app_environment(app_environment: EnvVarsDict):
     settings = ApplicationSettings.create_from_envs()
-    print("captured settings: \n", settings.model_dump_json(indent=2, warnings="none"))
+    print("captured settings: \n", settings.model_dump_json(indent=2))
 
     assert settings.SC_BOOT_MODE == BootModeEnum.PRODUCTION
     assert settings.log_level == logging.DEBUG

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

@@ -37,4 +37,4 @@ def app_environment(
 def test_unit_app_environment(app_environment: EnvVarsDict):
     assert app_environment
     settings = ApplicationSettings.create_from_envs()
-    print("captured settings: \n", settings.model_dump_json(indent=2, warnings="none"))
+    print("captured settings: \n", settings.model_dump_json(indent=2))