♻️ Maintenance: Unify ApplicationSettings Testing Across Services and Prepare for External Env File Support (#7919)

Author: pcrespov

.vscode/launch.template.json

@@ -44,6 +44,28 @@
       "justMyCode": false
     },
     {
+      // This test adds --external-envfile and expects a file named ".secrets" in the workspace root.
+      "name": "Python: Test w/ repo.config",
+      "type": "debugpy",
+      "request": "launch",
+      "module": "pytest",
+      "args": [
+        "--ff",
+        "--log-cli-level=INFO",
+        "--external-envfile=${workspaceFolder}/.secrets",
+        "--pdb",
+        "--setup-show",
+        "--durations=5",
+        "-s",
+        "-vv",
+        "${file}"
+      ],
+      "cwd": "${workspaceFolder}",
+      "console": "integratedTerminal",
+      "justMyCode": false
+    },
+    {
+      // This tests enables the httpx spy and dumps captures in a json. Mainly for api-server
       "name": "Python: Test-Httpx-Spy",
       "type": "debugpy",
       "request": "launch",

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")
@@ -20,12 +23,17 @@ def pytest_addoption(parser: pytest.Parser):
         action="store",
         type=Path,
         default=None,
-        help="Path to an env file. Consider passing a link to repo configs, i.e. `ln -s /path/to/osparc-ops-config/repo.config`",
+        help="Path to an env file. Replaces .env-devel in the tests by an external envfile."
+        "e.g. consider "
+        " `ln -s /path/to/osparc-ops-config/repo.config .secrets` and then "
+        " `pytest --external-envfile=.secrets --pdb tests/unit/test_core_settings.py`",
     )
 
 
 @pytest.fixture(scope="session")
-def external_envfile_dict(request: pytest.FixtureRequest) -> EnvVarsDict:
+def external_envfile_dict(
+    request: pytest.FixtureRequest, osparc_simcore_root_dir: Path
+) -> EnvVarsDict:
     """
     If a file under test folder prefixed with `.env-secret` is present,
     then this fixture captures it.
@@ -35,19 +43,43 @@ 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()
 
+        envfile = envfile.resolve()
+        osparc_simcore_root_dir = osparc_simcore_root_dir.resolve()
+
+        if osparc_simcore_root_dir in envfile.parents and not any(
+            term in envfile.name.lower() for term in ("ignore", "secret")
+        ):
+            _logger.warning(
+                "🚨 CAUTION: The external envfile '%s' may contain sensitive data and could be accidentally versioned. "
+                "To prevent this, include the words 'secret' or 'ignore' in the filename.",
+                envfile.name,
+            )
+
         envs = load_dotenv(envfile)
 
+    if envs:
+        response = input(
+            f"🚨 CAUTION: You are about to run tests using environment variables loaded from '{envfile}'.\n"
+            "This may cause tests to interact with or modify real external systems (e.g., production or staging environments).\n"
+            "Proceeding could result in data loss or unintended side effects.\n"
+            "Are you sure you want to continue? [y/N]: "
+        )
+        if response.strip().lower() not in ("y", "yes"):
+            pytest.exit("Aborted by user due to external envfile usage.")
+
     return envs
 
 
 @pytest.fixture(scope="session")
-def skip_if_external_envfile_dict(external_envfile_dict: EnvVarsDict) -> None:
+def skip_if_no_external_envfile(external_envfile_dict: EnvVarsDict) -> None:
     if not external_envfile_dict:
         pytest.skip(reason="Skipping test since external-envfile is not set")
 

services/agent/tests/unit/test_core_settings.py

@@ -0,0 +1,18 @@
+# pylint: disable=unused-variable
+# pylint: disable=unused-argument
+# pylint: disable=redefined-outer-name
+
+
+from pytest_simcore.helpers.monkeypatch_envs import (
+    EnvVarsDict,
+)
+from simcore_service_agent.core.settings import ApplicationSettings
+
+
+def test_valid_application_settings(mock_environment: EnvVarsDict):
+    assert mock_environment
+
+    settings = ApplicationSettings()  # type: ignore
+    assert settings
+
+    assert settings == ApplicationSettings.create_from_envs()

services/api-server/src/simcore_service_api_server/api/dependencies/models_schemas_jobs_filters.py

@@ -18,7 +18,9 @@ def get_job_metadata_filter(
             *Format*: `key:pattern` where pattern can contain glob wildcards
             """
             ),
-            example=["key1:val*", "key2:exactval"],
+            examples=[
+                ["key1:val*", "key2:exactval"],
+            ],
         ),
     ] = None,
 ) -> JobMetadataFilter | None:

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

@@ -3,38 +3,16 @@
 # pylint: disable=redefined-outer-name
 
 
-import pytest
 from pytest_simcore.helpers.monkeypatch_envs import (
     EnvVarsDict,
-    delenvs_from_dict,
-    setenvs_from_dict,
 )
 from simcore_service_api_server.core.settings import ApplicationSettings
 
 
-@pytest.fixture
-def app_environment(
-    monkeypatch: pytest.MonkeyPatch,
-    app_environment: EnvVarsDict,
-    external_envfile_dict: EnvVarsDict,
-) -> EnvVarsDict:
-    """
-    NOTE: To run against repo.config in osparc-config repo
-
-    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)
-        return setenvs_from_dict(
-            monkeypatch,
-            {**external_envfile_dict},
-        )
-    return app_environment
+def test_valid_application_settings(app_environment: EnvVarsDict):
+    assert app_environment
 
+    settings = ApplicationSettings()  # type: ignore
+    assert settings
 
-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))
+    assert settings == ApplicationSettings.create_from_envs()

services/autoscaling/tests/unit/test_core_settings.py

@@ -2,7 +2,13 @@
 # pylint: disable=redefined-outer-name
 # pylint: disable=unused-argument
 # pylint: disable=unused-variable
+"""
+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
+
+"""
 import datetime
 import json
 import logging

services/autoscaling/tests/unit/test_modules_auto_scaling_dynamic.py

@@ -1069,7 +1069,7 @@ async def test_cluster_scaling_up_and_down(
     ],
 )
 async def test_cluster_scaling_up_and_down_against_aws(
-    skip_if_external_envfile_dict: None,
+    skip_if_no_external_envfile: None,
     external_ec2_instances_allowed_types: None | dict[str, EC2InstanceBootSpecific],
     with_labelize_drain_nodes: EnvVarsDict,
     app_with_docker_join_drained: EnvVarsDict,

services/autoscaling/tests/unit/test_modules_buffer_machine_core.py

@@ -532,7 +532,7 @@ def pre_pull_images(
 
 
 async def test_monitor_buffer_machines_against_aws(
-    skip_if_external_envfile_dict: None,
+    skip_if_no_external_envfile: None,
     disable_buffers_pool_background_task: None,
     disable_autoscaling_background_task: None,
     disabled_rabbitmq: None,

services/catalog/tests/unit/conftest.py

@@ -15,10 +15,7 @@
 import pytest
 import respx
 import simcore_service_catalog
-import simcore_service_catalog.core.application
 import simcore_service_catalog.core.events
-import simcore_service_catalog.repository
-import simcore_service_catalog.repository.events
 import yaml
 from asgi_lifespan import LifespanManager
 from faker import Faker

services/catalog/tests/unit/test_core_settings.py

@@ -3,19 +3,13 @@
 # pylint: disable=unused-variable
 # pylint: disable=too-many-arguments
 
-
 from pytest_simcore.helpers.typing_env import EnvVarsDict
 from simcore_service_catalog.core.settings import ApplicationSettings
 
 
-def test_valid_web_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
+def test_valid_application_settings(app_environment: EnvVarsDict):
+    assert app_environment
 
-    """
     settings = ApplicationSettings()  # type: ignore
     assert settings