feat: add new properties to ValidationError

ValidationError had a single untyped property: .data, which hold
different objects in the XML and JSON cases, while they do have some
common properties.

The new properties introduced in this commit are
- .message: the error message text
- .path: pointer to the location of the error in the input

Signed-off-by: Krisztian Fekete <[email protected]>

Author: e3krisztian

cyclonedx/validation/__init__.py

@@ -30,10 +30,26 @@
 class ValidationError:
     """Validation failed with this specific error.
 
-    Use :attr:`~data` to access the content.
+    You can use :attr:`~data` to access the raw error object, but prefer
+    other properties and functions, if possible.
     """
 
     data: Any
+    """Raw error data from one of the validation libraries."""
+
+    @property
+    def message(self) -> str:
+        """The error message."""
+        return str(getattr(self.data, 'message', self))
+
+    @property
+    def path(self) -> str:
+        """Path to the location of the problem in the document.
+
+        An XPath/JSONPath string.
+        """
+        # only subclasses know how to extract this info
+        return str(getattr(self.data, 'path', ''))
 
     def __init__(self, data: Any) -> None:
         self.data = data

cyclonedx/validation/json.py

@@ -33,7 +33,7 @@
 
 _missing_deps_error: Optional[tuple[MissingOptionalDependencyException, ImportError]] = None
 try:
-    from jsonschema.exceptions import ValidationError as JsonValidationError  # type:ignore[import-untyped]
+    from jsonschema.exceptions import ValidationError as JsonSchemaValidationError  # type:ignore[import-untyped]
     from jsonschema.validators import Draft7Validator  # type:ignore[import-untyped]
     from referencing import Registry
     from referencing.jsonschema import DRAFT7
@@ -47,6 +47,16 @@
     ), err
 
 
+class _JsonValidationError(ValidationError):
+    @property
+    def path(self) -> str:
+        """Path to the location of the problem in the document.
+
+        An XPath/JSONPath string.
+        """
+        return str(getattr(self.data, 'json_path', ''))
+
+
 class _BaseJsonValidator(BaseSchemabasedValidator, ABC):
     @property
     def output_format(self) -> Literal[OutputFormat.JSON]:
@@ -71,8 +81,8 @@ def _validate_data(self, data: Any) -> Optional[ValidationError]:
             validator = self._validator  # may throw on error that MUST NOT be caught
             try:
                 validator.validate(data)
-            except JsonValidationError as error:
-                return ValidationError(error)
+            except JsonSchemaValidationError as error:
+                return _JsonValidationError(error)
             return None
 
         __validator: Optional['JsonSchemaValidator'] = None

tests/test_validation_json.py

@@ -132,3 +132,5 @@ def test_validate_expected_error(self, schema_version: SchemaVersion, test_data_
             self.skipTest('MissingOptionalDependencyException')
         self.assertIsNotNone(validation_error)
         self.assertIsNotNone(validation_error.data)
+        self.assertTrue(bool(validation_error.message))
+        self.assertTrue(bool(validation_error.path))

tests/test_validation_xml.py

@@ -92,3 +92,5 @@ def test_validate_expected_error(self, schema_version: SchemaVersion, test_data_
             self.skipTest('MissingOptionalDependencyException')
         self.assertIsNotNone(validation_error)
         self.assertIsNotNone(validation_error.data)
+        self.assertTrue(bool(validation_error.message))
+        self.assertTrue(bool(validation_error.path))