Handle exceptions in Vardef client

src/dapla_metadata/variable_definitions/exceptions.py

@@ -0,0 +1,69 @@
+"""Vardef client exceptions."""
+
+import json
+from functools import wraps
+
+from dapla_metadata.variable_definitions.generated.vardef_client.exceptions import (
+    OpenApiException,
+)
+
+
+class VardefClientException(OpenApiException):
+    """Custom exception to represent errors encountered in the Vardef client.
+
+    This exception extracts and formats error details from a JSON response body
+    provided by the Vardef API, enabling more descriptive error messages.
+    If the response body cannot be parsed as JSON or lacks expected keys,
+    default values are used to provide meaningful feedback.
+    """
+
+    def __init__(self, response_body: str) -> None:
+        """Initialize the exception with a JSON-formatted response body.
+
+        Args:
+            response_body (str): The JSON string containing error details
+                                from the Vardef API response.
+
+        Attributes:
+            status (str): The status code from the response, or "Unknown status"
+                        if not available or the response is invalid.
+            detail (str || list): A detailed error message from the response, or
+                        "No detail provided" if not provided. If "Constraint violation"
+                        the detail is a list with field and message.
+            response_body (str): The raw response body string, stored for
+                                debugging purposes.
+        """
+        self.detail: str | list
+        try:
+            data = json.loads(response_body)
+            self.status = data.get("status", "Unknown status")
+            if data.get("title") == "Constraint Violation":
+                violations = data.get("violations", [])
+                self.detail = [
+                    {
+                        "field": violation.get("field", "Unknown field"),
+                        "message": violation.get("message", "No message provided"),
+                    }
+                    for violation in violations
+                ]
+            else:
+                self.detail = data.get("detail", "No detail provided")
+            self.response_body = response_body
+        except (json.JSONDecodeError, TypeError):
+            self.status = "Unknown"
+            self.detail = "Could not decode error response from API"
+            data = None
+        super().__init__(f"Status {self.status}: {self.detail}")
+
+
+def vardef_exception_handler(method):  # noqa: ANN201, ANN001
+    """Decorator for handling exceptions in Vardef."""
+
+    @wraps(method)
+    def _impl(self, *method_args, **method_kwargs):  # noqa: ANN001, ANN002, ANN003
+        try:
+            return method(self, *method_args, **method_kwargs)
+        except OpenApiException as e:
+            raise VardefClientException(e.body) from e
+
+    return _impl

src/dapla_metadata/variable_definitions/vardef.py

@@ -2,6 +2,7 @@
 
 from dapla_metadata.variable_definitions import config
 from dapla_metadata.variable_definitions._client import VardefClient
+from dapla_metadata.variable_definitions.exceptions import vardef_exception_handler
 from dapla_metadata.variable_definitions.generated.vardef_client.api.data_migration_api import (
     DataMigrationApi,
 )
@@ -113,6 +114,7 @@ def migrate_from_vardok(cls, vardok_id: str) -> VariableDefinition:
         )
 
     @classmethod
+    @vardef_exception_handler
     def list_variable_definitions(
         cls,
         date_of_validity: date | None = None,
@@ -141,6 +143,7 @@ def list_variable_definitions(
         ]
 
     @classmethod
+    @vardef_exception_handler
     def get_variable_definition(
         cls,
         variable_definition_id: str,

tests/utils/constants.py

@@ -7,3 +7,81 @@
 DAPLA_REGION = "DAPLA_REGION"
 DAPLA_GROUP_CONTEXT = "DAPLA_GROUP_CONTEXT"
 DAPLA_SERVICE = "DAPLA_SERVICE"
+NOT_FOUND_STATUS = 404
+BAD_REQUEST_STATUS = 400
+CONSTRAINT_VIOLATION_BODY = """{
+    "cause": null,
+    "suppressed": [
+    ],
+    "detail": null,
+    "instance": null,
+    "parameters": {
+    },
+    "type": "https://zalando.github.io/problem/constraint-violation",
+    "title": "Constraint Violation",
+    "status": 400,
+    "violations": [
+        {
+            "field": "updateVariableDefinitionById.updateDraft.owner.team",
+            "message": "Invalid Dapla team"
+        },
+        {
+            "field": "updateVariableDefinitionById.updateDraft.owner.team",
+            "message": "must not be empty"
+        }
+    ]
+}"""
+CONSTRAINT_VIOLATION_BODY_MISSING_MESSAGES = """{
+    "cause": null,
+    "suppressed": [
+    ],
+    "detail": null,
+    "instance": null,
+    "parameters": {
+    },
+    "type": "https://zalando.github.io/problem/constraint-violation",
+    "title": "Constraint Violation",
+    "status": 400,
+    "violations": [
+        {
+            "field": "updateVariableDefinitionById.updateDraft.owner.team"
+        },
+        {
+            "field": "updateVariableDefinitionById.updateDraft.owner.team"
+        }
+    ]
+}"""
+
+CONSTRAINT_VIOLATION_BODY_MISSING_VIOLATIONS = """{
+    "cause": null,
+    "suppressed": [
+    ],
+    "detail": null,
+    "instance": null,
+    "parameters": {
+    },
+    "type": "https://zalando.github.io/problem/constraint-violation",
+    "title": "Constraint Violation",
+    "status": 400,
+    "violations": []
+}"""
+CONSTRAINT_VIOLATION_BODY_MISSING_FIELD = """{
+    "cause": null,
+    "suppressed": [
+    ],
+    "detail": null,
+    "instance": null,
+    "parameters": {
+    },
+    "type": "https://zalando.github.io/problem/constraint-violation",
+    "title": "Constraint Violation",
+    "status": 400,
+    "violations": [
+        {
+            "message": "Invalid Dapla team"
+        },
+        {
+            "message": "must not be empty"
+        }
+    ]
+}"""

tests/variable_definitions/conftest.py

@@ -73,7 +73,7 @@ def draft(language_string_type, contact) -> Draft:
         short_name="test",
         definition=language_string_type,
         classification_reference="91",
-        unit_types=["a", "b"],
+        unit_types=["01"],
         subject_fields=["a", "b"],
         contains_sensitive_personal_information=True,
         measurement_type="test",

tests/variable_definitions/test_vardef.py

@@ -2,6 +2,7 @@
 
 from dapla_metadata._shared.config import DAPLA_GROUP_CONTEXT
 from dapla_metadata.variable_definitions._client import VardefClient
+from dapla_metadata.variable_definitions.exceptions import VardefClientException
 from dapla_metadata.variable_definitions.generated.vardef_client.configuration import (
     Configuration,
 )
@@ -16,6 +17,7 @@
 )
 from dapla_metadata.variable_definitions.vardef import Vardef
 from dapla_metadata.variable_definitions.variable_definition import VariableDefinition
+from tests.utils.constants import NOT_FOUND_STATUS
 from tests.utils.constants import VARDEF_EXAMPLE_ACTIVE_GROUP
 from tests.utils.constants import VARDEF_EXAMPLE_DATE
 from tests.utils.constants import VARDEF_EXAMPLE_DEFINITION_ID
@@ -45,6 +47,17 @@ def test_get_variable_definition(client_configuration: Configuration):
     assert landbak.classification_reference == "91"
 
 
+def test_get_variable_definition_invalid_id(client_configuration: Configuration):
+    VardefClient.set_config(client_configuration)
+    with pytest.raises(VardefClientException) as e:
+        Vardef.get_variable_definition(
+            variable_definition_id="invalid id",
+        )
+    assert e.value.status == NOT_FOUND_STATUS
+    assert e.value.detail == "Not found"
+    assert str(e.value) == "Status 404: Not found"
+
+
 def test_list_patches(client_configuration: Configuration):
     VardefClient.set_config(client_configuration)
     landbak = Vardef.get_variable_definition(