test: update unit tests so pydantic-settings reads existing files

patching pydantic-settings directly was hiding the files' parsing in tests

Author: Powlinett

connectors-sdk/tests/test_settings/conftest.py

@@ -1,5 +1,7 @@
 import sys
+from pathlib import Path
 from types import SimpleNamespace
+
 import pytest
 
 
@@ -11,8 +13,11 @@ def mock_main_path(monkeypatch):
         sys.modules, "__main__", SimpleNamespace(__file__="/app/src/main.py")
     )
 
+
 @pytest.fixture
-def mock_basic_environment(monkeypatch):
+def mock_environment(monkeypatch):
+    """Mock `os.environ` for `_SettingsLoader` and `BaseConnectorSettings` calls."""
+
     monkeypatch.setenv("OPENCTI_URL", "http://localhost:8080")
     monkeypatch.setenv("OPENCTI_TOKEN", "changeme")
     monkeypatch.setenv("CONNECTOR_ID", "connector-poc--uid")
@@ -23,60 +28,26 @@ def mock_basic_environment(monkeypatch):
 
 
 @pytest.fixture
-def mock_yaml_file_presence(monkeypatch):
-    def is_file(self):
-        if self.name == "config.yml":
-            return True
-        return False
+def mock_config_yml_file_presence(monkeypatch):
+    """Mock the path of `config.yml` for `_SettingsLoader` and `BaseConnectorSettings` calls."""
 
-    monkeypatch.setattr("pathlib.Path.is_file", is_file)
-
-
-@pytest.fixture
-def mock_env_file_presence(monkeypatch):
-    def is_file(self):
-        if self.name == ".env":
-            return True
-        return False
-
-    monkeypatch.setattr("pathlib.Path.is_file", is_file)
-
-
-@pytest.fixture
-def mock_yaml_config_settings_read_files(monkeypatch):
-    def read_files(_, __):
-        return {
-            "connector": {
-                "duration_period": "PT5M",
-                "id": "connector-poc--uid",
-                "log_level": "error",
-                "name": "Test Connector",
-                "scope": "test",
-            },
-            "opencti": {"token": "changeme", "url": "http://localhost:8080"},
-        }
+    def get_config_yml_file_path():
+        return Path(__file__).parent / "data" / "config.test.yml"
 
     monkeypatch.setattr(
-        "pydantic_settings.YamlConfigSettingsSource._read_files", read_files
+        "connectors_sdk.settings.base_settings._SettingsLoader._get_config_yml_file_path",
+        get_config_yml_file_path,
     )
 
 
 @pytest.fixture
-def mock_env_config_settings_read_env_files(monkeypatch):
-    def _read_env_files(self):
-        if self.settings_cls.__name__ == "SettingsLoader":
-            return {
-                "opencti": {"url": "http://localhost:8080", "token": "changeme"},
-                "connector": {
-                    "id": "connector-poc--uid",
-                    "name": "Test Connector",
-                    "duration_period": "PT5M",
-                    "log_level": "error",
-                    "scope": "test",
-                },
-            }
-        return {}
+def mock_dot_env_file_presence(monkeypatch):
+    """Mock the path of `.env` for `_SettingsLoader` and `BaseConnectorSettings` calls."""
+
+    def get_dot_env_file_path():
+        return Path(__file__).parent / "data" / ".env.test"
 
     monkeypatch.setattr(
-        "pydantic_settings.DotEnvSettingsSource._load_env_vars", _read_env_files
+        "connectors_sdk.settings.base_settings._SettingsLoader._get_dot_env_file_path",
+        get_dot_env_file_path,
     )

connectors-sdk/tests/test_settings/data/.env.test

@@ -0,0 +1,7 @@
+OPENCTI_URL=http://localhost:8080
+OPENCTI_TOKEN=changeme
+CONNECTOR_ID=connector-poc--uid
+CONNECTOR_NAME=Test Connector
+CONNECTOR_SCOPE=test
+CONNECTOR_LOG_LEVEL=error
+CONNECTOR_DURATION_PERIOD=PT5M

connectors-sdk/tests/test_settings/data/config.test.yml

@@ -0,0 +1,11 @@
+opencti:
+  url: http://localhost:8080
+  token: changeme
+
+connector:
+  id: connector-poc--uid
+  name: Test Connector
+  scope: test
+  log_level: error
+  duration_period: PT5M
+            

connectors-sdk/tests/test_settings/test_base_settings.py

@@ -78,13 +78,72 @@ def is_file(self: Path) -> bool:
         dot_env_file_path = _SettingsLoader._get_dot_env_file_path()
 
     assert dot_env_file_path == Path("/app/.env").resolve()
+
+
+def test_settings_loader_should_parse_config_yml_file(mock_config_yml_file_presence):
+    """
+    Test that `_SettingsLoader()` parses config vars in `config.yml`.
+    For testing purpose, the path of `config.yml` file is `tests/test_settings/data/config.test.yml`.
+    """
+    settings_loader = _SettingsLoader()
+    settings_dict = settings_loader.model_dump()
+
+    assert settings_dict == {
+        "opencti": {
+            "url": "http://localhost:8080",
+            "token": "changeme",
+        },
+        "connector": {
+            "id": "connector-poc--uid",
+            "name": "Test Connector",
+            "duration_period": "PT5M",
+            "log_level": "error",
+            "scope": "test",
+        },
+    }
+
+
+def test_settings_loader_should_parse_dot_env_file(mock_dot_env_file_presence):
+    """
+    Test that `_SettingsLoader()` parses env vars in `.env`.
+    For testing purpose, the path of `.env` file is `tests/test_settings/data/.env.test`.
+    """
+
+    settings_loader = _SettingsLoader()
+    settings_dict = settings_loader.model_dump()
+
+    assert settings_dict == {
+        "opencti_url": "http://localhost:8080",
+        "opencti_token": "changeme",
+        "connector_id": "connector-poc--uid",
+        "connector_name": "Test Connector",
+        "connector_duration_period": "PT5M",
+        "connector_log_level": "error",
+        "connector_scope": "test",
+    }
+
+
+def test_settings_loader_should_parse_os_environ(mock_environment):
+    """
+    Test that `_SettingsLoader()` parses env vars from `os.environ`.
+    For testing purpose, `os.environ` is patched.
+    """
+
     settings_loader = _SettingsLoader()
     settings_dict = settings_loader.model_dump()
 
     assert settings_dict == {}
 
 
-def test_should_create_settings_loader_from_model(mock_basic_environment):
+def test_settings_loader_should_parse_config_yml_from_model(
+    mock_config_yml_file_presence,
+):
+    """
+    Test that `_SettingsLoader.build_loader_from_model` returns a `BaseSettings` subclass
+    capable of parsing `config.yml` according to the given `BaseModel`.
+    For testing purpose, the path of `config.yml` file is `tests/test_settings/data/config.test.yml`.
+    """
+
     settings_loader = _SettingsLoader.build_loader_from_model(BaseConnectorSettings)
     settings_dict = settings_loader().model_dump()
 
@@ -96,39 +155,31 @@ def test_should_create_settings_loader_from_model(mock_basic_environment):
     assert settings_dict["connector"]["log_level"] == "error"
 
 
-def test_should_create_base_connector_settings(mock_basic_environment):
-    settings = BaseConnectorSettings()
-    assert settings.opencti.url == HttpUrl("http://localhost:8080/")
-    assert settings.opencti.token == "changeme"
-    assert settings.connector.id == "connector-poc--uid"
-    assert settings.connector.name == "Test Connector"
-    assert settings.connector.scope == ["test"]
-    assert settings.connector.log_level == "error"
-
+def test_settings_loader_should_parse_dot_env_from_model(mock_dot_env_file_presence):
+    """
+    Test that `_SettingsLoader.build_loader_from_model` returns a `BaseSettings` subclass
+    capable of parsing `.env` according to the given `BaseModel`.
+    For testing purpose, the path of `.env` file is `tests/test_settings/data/.env.test`.
+    """
 
-def test_should_fail_with_missing_mandatory_env_vars():
-    with pytest.raises(ConfigValidationError):
-        BaseConnectorSettings()
+    settings_loader = _SettingsLoader.build_loader_from_model(BaseConnectorSettings)
+    settings_dict = settings_loader().model_dump()
 
+    assert settings_dict["opencti"]["url"] == "http://localhost:8080"
+    assert settings_dict["opencti"]["token"] == "changeme"
+    assert settings_dict["connector"]["id"] == "connector-poc--uid"
+    assert settings_dict["connector"]["name"] == "Test Connector"
+    assert settings_dict["connector"]["scope"] == "test"
+    assert settings_dict["connector"]["log_level"] == "error"
 
-def test_should_dump_opencti_model(mock_basic_environment):
-    settings = BaseConnectorSettings()
-    opencti_dict = settings.to_helper_config()
-    assert opencti_dict == {
-        "connector": {
-            "duration_period": "PT5M",
-            "id": "connector-poc--uid",
-            "log_level": "error",
-            "name": "Test Connector",
-            "scope": "test",
-        },
-        "opencti": {"token": "changeme", "url": "http://localhost:8080/"},
-    }
 
+def test_settings_loader_should_parse_os_environ_from_model(mock_environment):
+    """
+    Test that `_SettingsLoader.build_loader_from_model` returns a `BaseSettings` subclass
+    capable of parsing `os.environ` according to the given `BaseModel`.
+    For testing purpose, `os.environ` is patched.
+    """
 
-def test_should_create_yml_settings_loader_from_model(
-    mock_yaml_file_presence, mock_yaml_config_settings_read_files
-):
     settings_loader = _SettingsLoader.build_loader_from_model(BaseConnectorSettings)
     settings_dict = settings_loader().model_dump()
 
@@ -140,10 +191,16 @@ def test_should_create_yml_settings_loader_from_model(
     assert settings_dict["connector"]["log_level"] == "error"
 
 
-def test_should_load_settings_from_yaml_file(
-    mock_yaml_file_presence, mock_yaml_config_settings_read_files
+def test_base_connector_settings_should_validate_settings_from_config_yaml_file(
+    mock_config_yml_file_presence,
 ):
+    """
+    Test that `BaseConnectorSettings` casts and validates config vars in `config.yml`.
+    For testing purpose, the path of `config.yml` file is `tests/test_settings/data/config.test.yml`.
+    """
+
     settings = BaseConnectorSettings()
+
     assert settings.opencti.url == HttpUrl("http://localhost:8080/")
     assert settings.opencti.token == "changeme"
     assert settings.connector.id == "connector-poc--uid"
@@ -152,27 +209,67 @@ def test_should_load_settings_from_yaml_file(
     assert settings.connector.log_level == "error"
 
 
-def test_should_create_dot_env_settings_loader_from_model(
-    mock_env_file_presence, mock_env_config_settings_read_env_files
+def test_base_connector_settings_should_validate_settings_from_dot_env_file(
+    mock_dot_env_file_presence,
 ):
-    settings_loader = _SettingsLoader.build_loader_from_model(BaseConnectorSettings)
-    settings_dict = settings_loader().model_dump()
+    """
+    Test that `BaseConnectorSettings` casts and validates env vars in `.env`.
+    For testing purpose, the path of `.env` file is `tests/test_settings/data/.env.test`.
+    """
 
-    assert settings_dict["opencti"]["url"] == "http://localhost:8080"
-    assert settings_dict["opencti"]["token"] == "changeme"
-    assert settings_dict["connector"]["id"] == "connector-poc--uid"
-    assert settings_dict["connector"]["name"] == "Test Connector"
-    assert settings_dict["connector"]["scope"] == "test"
-    assert settings_dict["connector"]["log_level"] == "error"
+    settings = BaseConnectorSettings()
+
+    assert settings.opencti.url == HttpUrl("http://localhost:8080/")
+    assert settings.opencti.token == "changeme"
+    assert settings.connector.id == "connector-poc--uid"
+    assert settings.connector.name == "Test Connector"
+    assert settings.connector.scope == ["test"]
+    assert settings.connector.log_level == "error"
 
 
-def test_should_load_settings_from_env_file(
-    mock_env_file_presence, mock_env_config_settings_read_env_files
+def test_base_connector_settings_should_validate_settings_from_os_environ(
+    mock_environment,
 ):
+    """
+    Test that `BaseConnectorSettings` casts and validates env vars in `os.environ`.
+    For testing purpose, `os.environ` is patched.
+    """
+
     settings = BaseConnectorSettings()
+
     assert settings.opencti.url == HttpUrl("http://localhost:8080/")
     assert settings.opencti.token == "changeme"
     assert settings.connector.id == "connector-poc--uid"
     assert settings.connector.name == "Test Connector"
     assert settings.connector.scope == ["test"]
     assert settings.connector.log_level == "error"
+
+
+def test_base_connector_settings_should_raise_when_missing_mandatory_env_vars():
+    """Test that `BaseConnectorSettings` raises a `ValidationError` when no value is provided for required fields."""
+    with pytest.raises(ConfigValidationError):
+        BaseConnectorSettings()
+
+
+def test_base_connector_settings_should_provide_helper_config(mock_environment):
+    """
+    Test that `BaseConnectorSettings().to_helper_config` returns a valid `config` dict for `pycti.OpenCTIConnectorHelper`.
+    For testing purpose, `os.environ` is patched.
+    """
+
+    settings = BaseConnectorSettings()
+    opencti_dict = settings.to_helper_config()
+
+    assert opencti_dict == {
+        "connector": {
+            "duration_period": "PT5M",
+            "id": "connector-poc--uid",
+            "log_level": "error",
+            "name": "Test Connector",
+            "scope": "test",
+        },
+        "opencti": {
+            "token": "changeme",
+            "url": "http://localhost:8080/",
+        },
+    }