WIP: Fix ContextSettings tests

data_safe_haven/config/context_settings.py

@@ -5,7 +5,7 @@
 )
 
 from pathlib import Path
-from typing import Any, ClassVar
+from typing import ClassVar
 
 import yaml
 from pydantic import BaseModel, Field, ValidationError
@@ -136,11 +136,8 @@ def from_yaml(cls, settings_yaml: str) -> ContextSettings:
         try:
             return ContextSettings.model_validate(settings_dict)
         except ValidationError as exc:
-            cls.logger.error(f"{exc.error_count()} errors found in context settings:")
-            for error in exc.errors():
-                cls.logger.error(f"{error['msg']} at '{'->'.join(error['loc'])}'")
             msg = f"Could not load context settings.\n{exc}"
-            raise DataSafeHavenConfigError(msg) from exc
+            raise DataSafeHavenParameterError(msg) from exc
 
     @classmethod
     def from_file(cls, config_file_path: Path | None = None) -> ContextSettings:
@@ -165,5 +162,5 @@ def write(self, config_file_path: Path | None = None) -> None:
         config_file_path.parent.mkdir(parents=True, exist_ok=True)
 
         with open(config_file_path, "w", encoding="utf-8") as f_yaml:
-            yaml.dump(self.model_dump(), f_yaml, indent=2)
+            yaml.dump(self.model_dump(by_alias=True), f_yaml, indent=2)
         self.logger.info(f"Saved context settings to '[green]{config_file_path}[/]'.")

tests_/config/test_context_settings.py

@@ -41,23 +41,33 @@ def context_yaml():
 
 @fixture
 def context_settings(context_yaml):
-    return ContextSettings(yaml.safe_load(context_yaml))
+    return ContextSettings.from_yaml(context_yaml)
 
 
 class TestContextSettings:
     def test_constructor(self, context_yaml):
-        settings = ContextSettings(yaml.safe_load(context_yaml))
+        settings = ContextSettings(
+            selected="acme_deployment",
+            contexts={
+                "acme_deployment": Context(
+                    name="Acme Deployment",
+                    admin_group_id="d5c5c439-1115-4cb6-ab50-b8e547b6c8dd",
+                    location="uksouth",
+                    subscription_name="Data Safe Haven (Acme)",
+                )
+            },
+        )
         assert isinstance(settings, ContextSettings)
 
     def test_missing_selected(self, context_yaml):
         context_yaml = "\n".join(context_yaml.splitlines()[1:])
 
         with pytest.raises(DataSafeHavenParameterError) as exc:
-            ContextSettings(yaml.safe_load(context_yaml))
-            assert "Missing Key: 'selected'" in exc
-
-    def test_settings(self, context_settings):
-        assert isinstance(context_settings.settings, dict)
+            ContextSettings.from_yaml(context_yaml)
+            assert "Could not load context settings" in exc
+            assert "1 validation error for ContextSettings" in exc
+            assert "selected" in exc
+            assert "Field required" in exc
 
     def test_selected(self, context_settings):
         assert context_settings.selected == "acme_deployment"