Add BlueapiBaseModel config to ApplicationConfig (#794)

Author: ZohebShaikh

dev-requirements.txt

@@ -18,7 +18,7 @@ bidict==0.23.1
 bluesky==1.13
 bluesky-kafka==0.10.0
 bluesky-live==0.0.8
-bluesky-stomp==0.1.2
+bluesky-stomp==0.1.3
 boltons==24.1.0
 cachetools==5.5.0
 caproto==1.1.1

pyproject.toml

@@ -31,7 +31,7 @@ dependencies = [
     "dls-dodal>=1.36.2",
     "super-state-machine",  # https://github.com/DiamondLightSource/blueapi/issues/553
     "GitPython",
-    "bluesky-stomp>=0.1.2",
+    "bluesky-stomp>=0.1.3",
     "event-model==1.22.1",    # https://github.com/DiamondLightSource/blueapi/issues/684
     "opentelemetry-distro>=0.48b0",
     "opentelemetry-instrumentation-fastapi>=0.48b0",

src/blueapi/config.py

@@ -26,12 +26,12 @@ class SourceKind(str, Enum):
     DODAL = "dodal"
 
 
-class Source(BaseModel):
+class Source(BlueapiBaseModel):
     kind: SourceKind
     module: Path | str
 
 
-class StompConfig(BaseModel):
+class StompConfig(BlueapiBaseModel):
     """
     Config for connecting to stomp broker
     """

tests/unit_tests/test_config.py

@@ -1,7 +1,8 @@
+import inspect
 import json
 import os
 import tempfile
-from collections.abc import Generator, Mapping
+from collections.abc import Generator, Iterable, Mapping
 from pathlib import Path
 from typing import Any
 from unittest import mock
@@ -150,8 +151,6 @@ def test_auth_from_env_throws_when_not_available():
     # Eagerly throws an exception, will fail during initial loading
     with pytest.raises(KeyError):
         BasicAuthentication(username="${BAZ}", password="baz")  # type: ignore
-    with pytest.raises(KeyError):
-        BasicAuthentication(username="${baz}", passcode="baz")  # type: ignore
 
 
 def is_subset(subset: Mapping[str, Any], superset: Mapping[str, Any]) -> bool:
@@ -364,3 +363,27 @@ def test_oauth_config_model_post_init(
     assert oidc_config.issuer == oidc_well_known["issuer"]
     assert oidc_config.jwks_uri == oidc_well_known["jwks_uri"]
     assert oidc_config.end_session_endpoint == oidc_well_known["end_session_endpoint"]
+
+
+def test_extra_fields_are_forbidden_for_application_config():
+    check_no_extra_fields(ApplicationConfig)
+
+
+def check_no_extra_fields(model_class: Any) -> None:
+    if not inspect.isclass(model_class):
+        return
+    if issubclass(model_class, BaseModel):
+        assert model_class.model_config.get("extra") == "forbid"
+        for field in model_class.model_fields.keys():
+            validate_field_annotations(model_class, field)
+
+
+def validate_field_annotations(model_class: Any, model_field: str) -> None:
+    field_annotation = model_class.model_fields[model_field].annotation
+    extracted_annotations = getattr(field_annotation, "__args__", field_annotation)
+
+    if isinstance(extracted_annotations, Iterable):
+        for annotation in extracted_annotations:
+            check_no_extra_fields(annotation)
+    else:
+        check_no_extra_fields(extracted_annotations)