🐛 Improve logging for external envfile loading and rename test function for clarity

Author: pcrespov

packages/pytest-simcore/src/pytest_simcore/environment_configs.py

@@ -3,6 +3,7 @@
 # pylint: disable=unused-variable
 
 
+import logging
 import re
 from pathlib import Path
 from typing import Any
@@ -12,6 +13,8 @@
 from .helpers.monkeypatch_envs import load_dotenv, setenvs_from_dict
 from .helpers.typing_env import EnvVarsDict
 
+_logger = logging.getLogger(__name__)
+
 
 def pytest_addoption(parser: pytest.Parser):
     simcore_group = parser.getgroup("simcore")
@@ -35,12 +38,20 @@ def external_envfile_dict(request: pytest.FixtureRequest) -> EnvVarsDict:
     """
     envs = {}
     if envfile := request.config.getoption("--external-envfile"):
-        print("🚨 EXTERNAL `envfile` option detected. Loading", envfile, "...")
+        _logger.warning(
+            "🚨 EXTERNAL `envfile` option detected. Loading '%s' ...", envfile
+        )
 
         assert isinstance(envfile, Path)
         assert envfile.exists()
         assert envfile.is_file()
 
+        if not any(term in envfile.name.lower() for term in ("ignore", "secret")):
+            _logger.warning(
+                "🚨 CAUTION: The provided envfile '%s' might be pushed in this repository. Please rename it with `secret` or `ignore`",
+                envfile.name,
+            )
+
         envs = load_dotenv(envfile)
 
     return envs

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

@@ -23,7 +23,6 @@ def app_environment(
 
     ln -s /path/to/osparc-config/deployments/mydeploy.com/repo.config .secrets
     pytest --external-envfile=.secrets tests/unit/test_core_settings.py
-
     """
     if external_envfile_dict:
         delenvs_from_dict(monkeypatch, app_environment, raising=False)
@@ -34,7 +33,17 @@ def app_environment(
     return app_environment
 
 
-def test_unit_app_environment(app_environment: EnvVarsDict):
+def test_valid_application_settings(app_environment: EnvVarsDict):
+    """
+    We can validate actual .env files (also refered as `repo.config` files) by passing them via the CLI
+
+    $ ln -s /path/to/osparc-config/deployments/mydeploy.com/repo.config .secrets
+    $ pytest --external-envfile=.secrets --pdb tests/unit/test_core_settings.py
+
+    """
     assert app_environment
-    settings = ApplicationSettings.create_from_envs()
-    print("captured settings: \n", settings.model_dump_json(indent=2))
+
+    settings = ApplicationSettings()  # type: ignore
+    assert settings
+
+    assert settings == ApplicationSettings.create_from_envs()