refactor: split result_backend & broker_url into multiple config fields

Author: matthiasschaub

config/sample.config.toml

@@ -1,3 +1,5 @@
 # required configuration variables for docker compose setup
-# broker_url = "redis://redis:6379"
-# result_backend = "db+postgresql://smt:smt@postgres:5432"
+# postgres_host = "postgres"
+# postgres_password = "smt"
+# postgres_user = "smt"
+# redis_host = "redis"

docs/configuration.md

@@ -27,8 +27,10 @@ All lot of configuration values come with defaults.
 For running the services using Docker Compose set broker URL and result backend to:
 
 ```toml
-broker_url = "redis://redis:6379"
-result_backend = "db+postgresql://smt:smt@postgres:5432"
+postgres_host = "postgres"
+postgres_password = "smt"
+postgres_user = "smt"
+redis_host = "redis"
 ```
 
 
@@ -38,8 +40,10 @@ All environment variables are prefixed with `SMT_`. For example above
 configuration via environment variables is done like this:
 
 ```sh
-SMT_BROKER_URL="redis://redis:6379"
-SMT_RESULT_BACKEND="db+postgresql://smt:smt@postgres:5432"
+SMT_POSTGRES_HOST = "postgres"
+SMT_POSTGRES_PASSWORD = "smt"
+SMT_POSTGRES_USER = "smt"
+SMT_REDIS_HOST = "redis"
 ```
 
 

sketch_map_tool/config.py

@@ -1,7 +1,7 @@
 import logging
 import os
 
-from pydantic import field_validator
+from pydantic import computed_field, field_validator
 from pydantic_settings import (
     BaseSettings,
     PydanticBaseSettingsSource,
@@ -23,15 +23,22 @@ def get_config_path() -> str:
 
 
 class Config(BaseSettings):
-    broker_url: str = "redis://localhost:6379"
     cleanup_map_frames_interval: str = "12 months"
     data_dir: str = str(get_project_root() / "data")  # TODO: make this a Path
     esri_api_key: str = ""
     log_level: str = "INFO"
     max_nr_simultaneous_uploads: int = 100
     model_type_sam: str = "vit_b"
     point_area_threshold: float = 0.00047
-    result_backend: str = "db+postgresql://smt:smt@localhost:5432"
+    postgres_host: str = "localhost"
+    postgres_port: str = "5432"
+    postgres_dbname: str = ""
+    postgres_user: str = "smt"
+    postgres_password: str = "smt"
+    redis_host: str = "localhost"
+    redis_port: str = "6379"
+    redis_db_number: str = ""
+    redis_password: str | None = None
     user_agent: str = "sketch-map-tool"
     weights_dir: str = str(get_project_root() / "weights")  # TODO: make this a Path
     wms_layers_esri_world_imagery: str = "world_imagery"
@@ -52,6 +59,34 @@ class Config(BaseSettings):
         toml_file=get_config_path(),
     )
 
+    @computed_field
+    @property
+    def result_backend(self) -> str:
+        return "db+postgresql://{user}:{password}@{host}:{port}/{dbname}".format(
+            user=self.postgres_user,
+            password=self.postgres_password,
+            host=self.postgres_host,
+            port=self.postgres_port,
+            dbname=self.postgres_dbname,
+        )
+
+    @computed_field
+    @property
+    def broker_url(self) -> str:
+        if self.redis_password is None:
+            return "redis://{host}:{port}/{db_number}".format(
+                host=self.redis_host,
+                port=self.redis_port,
+                db_number=self.redis_db_number,
+            )
+        else:
+            return "redis://:{password}@{host}:{port}/{db_number}".format(
+                password=self.redis_password,
+                host=self.redis_host,
+                port=self.redis_port,
+                db_number=self.redis_db_number,
+            )
+
     @classmethod
     def settings_customise_sources(
         cls,

tests/integration/conftest.py

@@ -40,14 +40,15 @@ def postgres_container(monkeypatch_session):
     Connection string will be different for each test session.
     """
     with PostgresContainer("postgres:15") as postgres:
-        conn = "db+postgresql://{user}:{password}@127.0.0.1:{port}/{database}".format(
-            user=postgres.username,
-            password=postgres.password,
-            port=postgres.get_exposed_port(5432),  # 5432 is default port of postgres
-            database=postgres.dbname,
+        monkeypatch_session.setattr(
+            CONFIG,
+            "postgres_port",
+            postgres.get_exposed_port(5432),
         )
-        monkeypatch_session.setattr(CONFIG, "result_backend", conn)
-        yield {"connection_url": conn}
+        monkeypatch_session.setattr(CONFIG, "postgres_dbname", postgres.dbname)
+        monkeypatch_session.setattr(CONFIG, "postgres_user", postgres.username)
+        monkeypatch_session.setattr(CONFIG, "postgres_password", postgres.password)
+        yield
     # cleanup
 
 
@@ -59,17 +60,16 @@ def redis_container(monkeypatch_session):
     """
     with RedisContainer("redis:7") as redis:
         port = redis.get_exposed_port(6379)  # 6379 is default port of redis
-        conn = f"redis://127.0.0.1:{port}"
-        monkeypatch_session.setattr(CONFIG, "broker_url", conn)
-        yield {"connection_url": conn}
+        monkeypatch_session.setattr(CONFIG, "redis_port", port)
+        yield redis
     # cleanup
 
 
 @pytest.fixture(scope="session", autouse=True)
 def celery_config(postgres_container, redis_container):
     """Set Celery config to point at testcontainers."""
-    CELERY_CONFIG["result_backend"] = postgres_container["connection_url"]
-    CELERY_CONFIG["broker_url"] = redis_container["connection_url"]
+    CELERY_CONFIG["result_backend"] = CONFIG.result_backend
+    CELERY_CONFIG["broker_url"] = CONFIG.broker_url
     return CELERY_CONFIG