PTFE-693: unit test for settings class

.github/workflows/tests.yaml

@@ -15,7 +15,7 @@ jobs:
         test: [unit, api]
 
     env:
-      REDIS_OM_URL: redis://localhost:6379
+      REDIS_OM_URL: redis://localhost:6379/0
       GITHUB_BASE_URL: http://localhost:4010
 
     steps:

runner_manager/models/settings.py

@@ -10,7 +10,7 @@
     A simple settings source that loads variables from a yaml file
 
     """
     config_file: Optional[Path] = settings.__config__.config.config_file
     if config_file:
         return yaml.full_load(config_file.read_text())
     return {}
@@ -21,7 +21,7 @@
 
 
 class Settings(BaseSettings):
-    name: str = "runner-manager"
+    name: Optional[str] = "runner-manager"
     redis_om_url: Optional[RedisDsn] = None
     github_base_url: Optional[AnyHttpUrl] = None
 

tests/unit/models/test_settings.py

@@ -0,0 +1,55 @@
+import os
+import tempfile
+import pytest
+import yaml
+from pytest import fixture
+
+from runner_manager.models.settings import Settings
+
+
+def test_settings_default_values():
+    settings = Settings()
+    assert settings.name == "runner-manager"
+    assert settings.redis_om_url == os.getenv("REDIS_OM_URL")
+    assert settings.github_base_url == os.getenv("GITHUB_BASE_URL")
+
+
+@fixture
+def temp_yaml_file():
+    yaml_data = """
+    name: test-runner-manager
+    redis_om_url: redis://localhost:6379/0
+    github_base_url: https://github.com
+    """
+    yaml_file = tempfile.NamedTemporaryFile(mode="w", delete=False)
+    yaml_file.write(yaml_data)
+    return yaml_file.name
+
+def test_invalid_redis_url():
+    with pytest.raises(ValueError):
+        Settings(redis_om_url="invalid_redis_url")
+
+def test_invalid_github_url():
+    with pytest.raises(ValueError):
+        Settings(github_base_url="invalid_github_url")
+
+def test_yaml_config(temp_yaml_file):
+    os.environ["CONFIG_FILE"] = temp_yaml_file
+    # settings should automatically look for the config file
+    # environment variable and load the file if it exists
+    settings = Settings()
+    with open(temp_yaml_file) as f:
+        yaml_data = yaml.safe_load(f)
+    assert settings.name == yaml_data["name"]
+    assert settings.redis_om_url == yaml_data["redis_om_url"]
+    assert settings.github_base_url == yaml_data["github_base_url"]
+
+
+def test_env_file():
+    os.environ["REDIS_OM_URL"] = "redis://localhost:6379/0"
+    os.environ["GITHUB_BASE_URL"] = "https://github.com"
+    os.environ["NAME"] = "test-runner-manager"
+    settings = Settings()
+    assert settings.name == os.getenv("NAME")
+    assert settings.redis_om_url == os.getenv("REDIS_OM_URL")
+    assert settings.github_base_url == os.getenv("GITHUB_BASE_URL")