improved warning messages detailed while throwing a dedicated error when environment variable is not resolved successfully

Author: polmichel

backend/infrahub/webhook/models.py

@@ -117,23 +117,26 @@ def from_event(cls, event_id: str, event_type: str, event_occured_at: str, event
         )
 
 
+class WebhookHeaderResolutionError(Exception):
+    pass
+
+
 class WebhookHeader(BaseModel):
     key: str
     value: str
     kind: Literal["static", "environment"]
 
-    def resolve(self) -> str | None:
+    def resolve(self) -> str:
         """Resolve the header value based on its kind.
 
-        Returns None if the value cannot be resolved (e.g. missing environment variable).
+        Raises WebhookHeaderResolutionError if the value cannot be resolved.
         """
         if self.kind == "static":
             return self.value
 
         resolved = os.environ.get(self.value)
         if resolved is None:
-            logger.warning("Environment variable '%s' not found, skipping header '%s'", self.value, self.key)
-            return None
+            raise WebhookHeaderResolutionError(f"Environment variable '{self.value}' not found")
         return resolved
 
 
@@ -158,9 +161,10 @@ def _assign_headers(self, uuid: UUID | None = None, at: Timestamp | None = None)
         }
 
         for header in self.custom_headers:
-            resolved = header.resolve()
-            if resolved is not None:
-                self._headers[header.key] = resolved
+            try:
+                self._headers[header.key] = header.resolve()
+            except WebhookHeaderResolutionError as exc:
+                logger.warning("Webhook '%s': %s, skipping header '%s'", self.name, exc, header.key)
 
         if self.shared_key:
             message_id = f"msg_{uuid.hex}" if uuid else f"msg_{uuid4().hex}"

backend/tests/unit/webhook/test_models.py

@@ -140,3 +140,4 @@ def test_assign_headers_skips_missing_environment_variable(caplog: pytest.LogCap
     assert webhook._headers["X-Source"] == "infrahub"
     assert "MISSING_VAR" in caplog.text
     assert "X-API-Key" in caplog.text
+    assert "test" in caplog.text  # webhook name included in warning

backend/tests/unit/webhook/test_webhook_header.py

@@ -1,9 +1,8 @@
-import logging
 from unittest.mock import patch
 
 import pytest
 
-from infrahub.webhook.models import WebhookHeader
+from infrahub.webhook.models import WebhookHeader, WebhookHeaderResolutionError
 
 
 def test_webhook_header_model() -> None:
@@ -29,11 +28,7 @@ def test_webhook_header_resolve_environment() -> None:
         assert header.resolve() == "secret123"
 
 
-def test_webhook_header_resolve_missing_environment(caplog: pytest.LogCaptureFixture) -> None:
+def test_webhook_header_resolve_missing_environment() -> None:
     header = WebhookHeader(key="X-API-Key", value="MISSING_VAR", kind="environment")
-    with patch.dict("os.environ", {}, clear=True), caplog.at_level(logging.WARNING, logger="infrahub.webhook.models"):
-        result = header.resolve()
-
-    assert result is None
-    assert "MISSING_VAR" in caplog.text
-    assert "X-API-Key" in caplog.text
+    with patch.dict("os.environ", {}, clear=True), pytest.raises(WebhookHeaderResolutionError, match="MISSING_VAR"):
+        header.resolve()