Update Backend Config Files (#663)

# Purpose
Closes #656.
Replaced the original database configuration setup in config.py with a
new Pydantic database config class.

# New Changes
- Created a database configuration Pydantic class and added it to the
backend config class
- wrote additional unit tests

# Testing
Explain tests that you ran to verify code functionality.
- [x] I have unit-tested this PR. Otherwise, explain why it cannot be
unit-tested.
- [x] I have included screenshots of the tests performed below.
<img width="1654" height="252" alt="image"
src="https://github.com/user-attachments/assets/fcda182b-2c25-47fe-98b5-24158bce67e1"
/>


# Outstanding Changes
If there are non-critical changes (i.e. additional features) that can be
made to this feature in the future, indicate them here.

---------

Co-authored-by: Brain256 <brian@BrianYoga7.localdomain>

Author: Brain256

gs/backend/api/backend_setup.py

@@ -12,7 +12,7 @@
 from gs.backend.api.v1.mcc.endpoints.commands import commands_router
 from gs.backend.api.v1.mcc.endpoints.main_commands import main_commands_router
 from gs.backend.api.v1.mcc.endpoints.telemetry import telemetry_router
-from gs.backend.config.config import backend_config
+from gs.backend.config.config import settings
 
 
 def setup_routes(app: FastAPI) -> None:
@@ -38,7 +38,7 @@ def setup_middlewares(app: FastAPI) -> None:
     app.add_middleware(AuthMiddleware)
     app.add_middleware(
         LoggerMiddleware,
-        excluded_endpoints=backend_config.logger_config.excluded_endpoints,
+        excluded_endpoints=settings.logger.excluded_endpoints,
     )
 
 

gs/backend/api/middleware/cors_middleware.py

@@ -1,7 +1,7 @@
 from fastapi import FastAPI
 from fastapi.middleware.cors import CORSMiddleware
 
-from gs.backend.config.config import backend_config
+from gs.backend.config.config import settings
 
 
 def add_cors_middleware(app: FastAPI) -> None:
@@ -12,8 +12,8 @@ def add_cors_middleware(app: FastAPI) -> None:
     """
     app.add_middleware(
         CORSMiddleware,
-        allow_origins=backend_config.cors_config.allow_origins,
-        allow_credentials=backend_config.cors_config.allow_credentials,
-        allow_methods=backend_config.cors_config.allow_methods,
-        allow_headers=backend_config.cors_config.allow_headers,
+        allow_origins=settings.cors.allow_origins,
+        allow_credentials=settings.cors.allow_credentials,
+        allow_methods=settings.cors.allow_methods,
+        allow_headers=settings.cors.allow_headers,
     )

gs/backend/config/config.py

@@ -1,13 +1,8 @@
 # TODO:(335) Improve loading the configuration
-from os import environ
-from typing import Final
 
-from dotenv import load_dotenv
-
-from .cors_config import CORSConfig
-from .logger_config import LoggerConfig
-
-load_dotenv()
+from gs.backend.config.cors_config import CORSConfig
+from gs.backend.config.database_config import DatabaseConfig
+from gs.backend.config.logger_config import LoggerConfig
 
 
 class BackendConfiguration:
@@ -16,34 +11,9 @@ class BackendConfiguration:
     """
 
     def __init__(self) -> None:
-        self.cors_config = CORSConfig()
-        self.logger_config = LoggerConfig()
-
-
-backend_config = BackendConfiguration()
-
-
-def getenv(config: str) -> str:
-    """
-    Validates whether or not database env values exist in .env. If not, throws a value error.
-
-    :param config: Variable in .env
-    :type config: str
-    :return: Value of variable in .env
-    :rtype: str
-    """
-    value = environ.get(config)
-    if not value:
-        raise ValueError(f"{config} is missing from .env.")
-    return value
-
+        self.cors = CORSConfig()
+        self.logger = LoggerConfig()
+        self.db = DatabaseConfig()
 
-GS_DATABASE_USER = getenv("GS_DATABASE_USER")
-GS_DATABASE_PASSWORD = getenv("GS_DATABASE_PASSWORD")
-GS_DATABASE_LOCATION = getenv("GS_DATABASE_LOCATION")
-GS_DATABASE_PORT = getenv("GS_DATABASE_PORT")
-GS_DATABASE_NAME = getenv("GS_DATABASE_NAME")
 
-DATABASE_CONNECTION_STRING: Final[
-    str
-] = f"postgresql+psycopg2://{GS_DATABASE_USER}:{GS_DATABASE_PASSWORD}@{GS_DATABASE_LOCATION}:{GS_DATABASE_PORT}/{GS_DATABASE_NAME}"
+settings = BackendConfiguration()

gs/backend/config/database_config.py

@@ -0,0 +1,25 @@
+from pydantic import SecretStr
+from pydantic_settings import BaseSettings, SettingsConfigDict
+
+
+class DatabaseConfig(BaseSettings):
+    """
+    Pydantic class for storing database configuration settings
+    """
+
+    model_config = SettingsConfigDict(env_prefix="GS_DATABASE_")
+
+    user: str
+    password: SecretStr
+    location: str
+    port: int
+    name: str
+
+    @property
+    def connection_string(self) -> str:
+        """
+        Returns the database connection string
+        """
+
+        pwd = self.password.get_secret_value()
+        return f"postgresql://{self.user}:{pwd}@{self.location}:{self.port}/{self.name}"

gs/backend/data/database/engine.py

@@ -1,7 +1,7 @@
 from sqlalchemy import Engine
 from sqlmodel import Session, create_engine, text
 
-from gs.backend.config.config import DATABASE_CONNECTION_STRING
+from gs.backend.config.config import settings
 from gs.backend.data.tables.aro_user_tables import ARO_USER_SCHEMA_NAME
 from gs.backend.data.tables.main_tables import MAIN_SCHEMA_NAME
 from gs.backend.data.tables.transactional_tables import TRANSACTIONAL_SCHEMA_NAME
@@ -13,7 +13,7 @@ def get_db_engine() -> Engine:
 
     :return: engine
     """
-    return create_engine(DATABASE_CONNECTION_STRING)
+    return create_engine(settings.db.connection_string)
 
 
 def get_db_session() -> Session:

python_test/conftest.py

@@ -2,6 +2,12 @@
 import subprocess
 from datetime import datetime
 
+os.environ.setdefault("GS_DATABASE_USER", "testuser")
+os.environ.setdefault("GS_DATABASE_PASSWORD", "testpassword")
+os.environ.setdefault("GS_DATABASE_LOCATION", "localhost")
+os.environ.setdefault("GS_DATABASE_PORT", "5432")
+os.environ.setdefault("GS_DATABASE_NAME", "testdb")
+
 import pytest
 from gs.backend.data.database.engine import setup_database
 from gs.backend.data.tables.transactional_tables import CommsSession

python_test/test_config_manager.py

@@ -1,12 +1,16 @@
 import importlib
 
-from gs.backend.config import config
+import pytest
+from gs.backend.config.config import BackendConfiguration, settings
 from gs.backend.config.cors_config import CORSConfig
+from gs.backend.config.database_config import DatabaseConfig
 from gs.backend.config.logger_config import LoggerConfig
+from pydantic import ValidationError
 
 
 def test_logger_config_default():
     cfg = LoggerConfig()
+
     assert cfg.excluded_endpoints == []
 
 
@@ -21,9 +25,67 @@ def test_cors_config_default():
 
 def test_backend_configuration_from_env(monkeypatch):
     monkeypatch.setenv("LOGGER_EXCLUDED_ENDPOINTS", '["/test"]')
-    monkeypatch.setenv("CORS_ALLOW_ORIGINS", '["http://test.com"]')
 
-    importlib.reload(config)
-    cfg = config.backend_config
-    assert "/test" in cfg.logger_config.excluded_endpoints
-    assert "http://test.com" in cfg.cors_config.allow_origins
+    monkeypatch.setenv("CORS_ALLOW_ORIGINS", '["http://localhost:5173"]')
+    monkeypatch.setenv("CORS_ALLOW_CREDENTIALS", "True")
+    monkeypatch.setenv("CORS_ALLOW_METHODS", '["*"]')
+    monkeypatch.setenv("CORS_ALLOW_HEADERS", '["*"]')
+
+    monkeypatch.setenv("GS_DATABASE_USER", "testuser")
+    monkeypatch.setenv("GS_DATABASE_PASSWORD", "testpassword")
+    monkeypatch.setenv("GS_DATABASE_LOCATION", "localhost")
+    monkeypatch.setenv("GS_DATABASE_PORT", "5432")
+    monkeypatch.setenv("GS_DATABASE_NAME", "testdb")
+
+    cfg = BackendConfiguration()
+
+    assert "/test" in cfg.logger.excluded_endpoints
+    assert "http://localhost:5173" in cfg.cors.allow_origins
+    assert cfg.db.user == "testuser"
+    assert cfg.db.password.get_secret_value() == "testpassword"
+    assert cfg.db.location == "localhost"
+    assert cfg.db.port == 5432
+    assert cfg.db.name == "testdb"
+
+
+def test_database_connection_string(monkeypatch):
+    monkeypatch.setenv("GS_DATABASE_USER", "testuser")
+    monkeypatch.setenv("GS_DATABASE_PASSWORD", "testpassword")
+    monkeypatch.setenv("GS_DATABASE_LOCATION", "localhost")
+    monkeypatch.setenv("GS_DATABASE_PORT", "5432")
+    monkeypatch.setenv("GS_DATABASE_NAME", "testdb")
+
+    cfg = BackendConfiguration()
+    db = cfg.db
+
+    assert db.password.get_secret_value() == "testpassword"
+    expected_url = "postgresql://testuser:testpassword@localhost:5432/testdb"
+    assert db.connection_string == expected_url
+
+
+def test_database_missing_env(monkeypatch):
+    monkeypatch.setenv("GS_DATABASE_USER", "testuser")
+    monkeypatch.setenv("GS_DATABASE_PASSWORD", "testpassword")
+    monkeypatch.setenv("GS_DATABASE_LOCATION", "localhost")
+    monkeypatch.setenv("GS_DATABASE_PORT", "5432")
+    monkeypatch.setenv("GS_DATABASE_NAME", "testdb")
+
+    monkeypatch.delenv("GS_DATABASE_PASSWORD")
+
+    with pytest.raises(ValidationError):
+        DatabaseConfig()
+
+
+def test_invalid_env(monkeypatch):
+    monkeypatch.setenv("GS_DATABASE_PORT", "test")
+    monkeypatch.setenv("CORS_ALLOW_CREDENTIALS", "3")
+    monkeypatch.setenv("LOGGER_EXCLUDED_ENDPOINTS", "3")
+
+    with pytest.raises(ValidationError):
+        DatabaseConfig()
+
+    with pytest.raises(ValidationError):
+        CORSConfig()
+
+    with pytest.raises(ValidationError):
+        LoggerConfig()