feat(validator): include missing data elements from JsonSchemaValueException

Author: michaelbrewer

aws_lambda_powertools/utilities/validation/base.py

@@ -32,6 +32,15 @@ def validate_data_against_schema(data: Union[Dict, str], schema: Dict, formats:
         fastjsonschema.validate(definition=schema, data=data, formats=formats)
     except (TypeError, AttributeError, fastjsonschema.JsonSchemaDefinitionException) as e:
         raise InvalidSchemaFormatError(f"Schema received: {schema}, Formats: {formats}. Error: {e}")
-    except fastjsonschema.JsonSchemaException as e:
-        message = f"Failed schema validation. Error: {e.message}, Path: {e.path}, Data: {e.value}"  # noqa: B306, E501
-        raise SchemaValidationError(message)
+    except fastjsonschema.JsonSchemaValueException as e:
+        message = f"Failed schema validation. Error: {e.message}, Path: {e.path}, Data: {e.value}"
+        raise SchemaValidationError(
+            message,
+            validation_message=e.message,
+            name=e.name,
+            path=e.path,
+            value=e.value,
+            definition=e.definition,
+            rule=e.rule,
+            rule_definition=e.rule_definition,
+        )

aws_lambda_powertools/utilities/validation/exceptions.py

@@ -1,9 +1,55 @@
+from typing import Any, List, Optional
+
 from ...exceptions import InvalidEnvelopeExpressionError
 
 
 class SchemaValidationError(Exception):
     """When serialization fail schema validation"""
 
+    def __init__(
+        self,
+        message: str,
+        validation_message: Optional[str] = None,
+        name: Optional[str] = None,
+        path: Optional[List] = None,
+        value: Optional[Any] = None,
+        definition: Optional[Any] = None,
+        rule: Optional[str] = None,
+        rule_definition: Optional[Any] = None,
+    ):
+        """
+
+        Parameters
+        ----------
+        message : str
+            Powertools formatted error message
+        validation_message : str, optional
+            Containing human-readable information what is wrong (e.g. ``data.property[index] must be smaller than or
+            equal to 42``)
+        name : str, optional
+            name of a path in the data structure (e.g. ``data.property[index]``)
+        path: List, optional
+            ``path`` as an array in the data structure (e.g. ``['data', 'property', 'index']``),
+        value : Any, optional
+            the invalid value
+        definition : Any, optional
+            The full rule ``definition`` (e.g. ``42``)
+        rule : str, optional
+            `rule`` which the ``data`` is breaking (e.g. ``maximum``)
+        rule_definition : Any, optional
+            The full rule ``definition`` (e.g. ``42``)
+        """
+        super().__init__(message)
+        self.message = message
+
+        self.validation_message = validation_message
+        self.name = name
+        self.path = path
+        self.value = value
+        self.definition = definition
+        self.rule = rule
+        self.rule_definition = rule_definition
+
 
 class InvalidSchemaFormatError(Exception):
     """When JSON Schema is in invalid format"""