config: simplify SentryConfig env override (bug 2058322)

README.md

@@ -85,7 +85,7 @@ configuration file can be specified with the `--config` (`-c`) option.
 It contains 6 main sections:
 
 - `pulse` holds the exchange configuration (can be overridden by environment, see below)
-- `sentry` contains the `sentry_dsn` for monitoring
+- `sentry` contains the `dsn` for monitoring
 - `clones` allows to set the `directory` in which local work clones will be created
 - `tracked_repositories` provides `name` and source `url` for Git repos to track
 - `branch_mappings` describes which Git repo and branches should be synced to which Hg repo

config-development.toml

@@ -13,7 +13,7 @@ heartbeat = 30
 queue = "queue/githgsyncdev/pushes"
 
 [sentry]
-sentry_dsn = ""
+dsn = ""
 
 [clones]
 directory = "/clones"

config-docker.toml

@@ -10,7 +10,7 @@ heartbeat = 30
 ssl = false
 
 [sentry]
-sentry_dsn = ""
+dsn = ""
 
 [clones]
 directory = "/clones"

config-production.toml

@@ -17,7 +17,7 @@ routing_key = ""
 queue = ""
 
 [sentry]
-sentry_dsn = ""
+dsn = ""
 
 [clones]
 directory = "/clones"

config-staging.toml

@@ -13,7 +13,7 @@ heartbeat = 30
 queue = "queue/githgsyncstage/pushes"
 
 [sentry]
-sentry_dsn = ""
+dsn = ""
 
 [clones]
 directory = "/clones"

config.toml.example

@@ -10,7 +10,7 @@ heartbeat = 30
 ssl = true
 
 [sentry]
-sentry_dsn = ""
+dsn = ""
 
 [clones]
 directory = "../git_hg_sync_repos/"

git_hg_sync/__main__.py

@@ -86,9 +86,9 @@ def main() -> None:
         sys.exit(1)
 
     sentry_config = config.sentry
-    if sentry_config and sentry_config.sentry_dsn:
-        logger.info(f"Sentry DSN: {sentry_config.sentry_dsn}")
-        sentry_sdk.init(sentry_config.sentry_dsn, max_value_length=4096)
+    if sentry_config and sentry_config.dsn:
+        logger.info(f"Sentry DSN: {sentry_config.dsn}")
+        sentry_sdk.init(sentry_config.dsn, max_value_length=4096)
     start_app(config, logger)
 
 

git_hg_sync/config.py

@@ -8,8 +8,6 @@
 from mozlog import get_proxy_logger
 from pydantic import (
     AfterValidator,
-    AliasChoices,
-    Field,
     ValidationInfo,
     model_validator,
 )
@@ -57,7 +55,7 @@ class ClonesConfig(BaseSettings):
 
 
 class SentryConfig(BaseSettings):
-    sentry_dsn: Annotated[str, Field(alias=AliasChoices("sentry_dsn", "dsn"))] = ""
+    dsn: str = ""
 
 
 class Config(BaseSettings):

tests/data/config.toml

@@ -9,6 +9,9 @@ password = "guest"
 heartbeat = 30
 ssl = false
 
+[sentry]
+dsn = ""
+
 [clones]
 directory = "{directory}/clones"
 

tests/test_config.py

@@ -30,18 +30,13 @@ def test_load_config_env_override(monkeypatch: pytest.MonkeyPatch) -> None:
             "heartbeat": "42",
         },
         "sentry": {
-            "sentry_dsn": "overridden sentry_dsn",
+            "dsn": "overridden sentry_dsn",
         },
     }
 
-    no_prefix_sections = ["sentry"]
-
     for section, env in overrides.items():
         for var, value in env.items():
-            if section in no_prefix_sections:
-                monkeypatch.setenv(f"{var}".upper(), value)
-            else:
-                monkeypatch.setenv(f"{section}_{var}".upper(), value)
+            monkeypatch.setenv(f"{section}_{var}".upper(), value)
 
     config = Config.from_file(HERE / "data" / "config.toml")