added a ValidatorError.schema properties which contains a dict representation of the whole validation error schema

mongoengine/base.py

@@ -20,10 +20,13 @@ class InvalidDocumentError(Exception):
 
 
 class ValidationError(Exception):
+    """Validation exception.
+    """
     errors = {}
     field_name = None
 
     def __init__(self, message, **kwargs):
+        self.errors = kwargs.get('errors', {})
         self.field_name = kwargs.get('field_name')
         super(ValidationError, self).__init__(message)
 
@@ -40,6 +43,25 @@ class ValidationError(Exception):
         else:
             return message
 
+    @property
+    def schema(self):
+        def get_schema(source):
+            errors_dict = {}
+            if not source:
+                return errors_dict
+            if isinstance(source, dict):
+                for field_name, error in source.iteritems():
+                    errors_dict[field_name] = get_schema(error)
+            elif isinstance(source, ValidationError) and source.errors:
+                return get_schema(source.errors)
+            else:
+                return unicode(source)
+            return errors_dict
+        if not self.errors:
+            return {}
+        return get_schema(self.errors)
+
+
 _document_registry = {}
 
 

tests/fields.py

@@ -1586,6 +1586,7 @@ class FieldTest(unittest.TestCase):
         except ValidationError, error:
             pass
 
+        # ValidationError.errors property
         self.assertTrue(hasattr(error, 'errors'))
         self.assertTrue(isinstance(error.errors, dict))
         self.assertTrue('comments' in error.errors)
@@ -1593,9 +1594,56 @@ class FieldTest(unittest.TestCase):
         self.assertTrue(isinstance(error.errors['comments'][1]['content'],
                         ValidationError))
 
+        # ValidationError.schema property
+        schema = error.schema
+        self.assertTrue(isinstance(schema, dict))
+        self.assertTrue('comments' in schema)
+        self.assertTrue(1 in schema['comments'])
+        self.assertTrue('content' in schema['comments'][1])
+        self.assertEquals(schema['comments'][1]['content'],
+                          u'Field is required ("content")')
+
         post.comments[1].content = 'here we go'
         post.validate()
 
 
+class ValidatorErrorTest(unittest.TestCase):
+
+    def test_schema(self):
+        """Ensure a ValidationError handles error schema correctly.
+        """
+        error = ValidationError('root')
+        self.assertEquals(error.schema, {})
+
+        # 1st level error schema
+        error.errors = {'1st': ValidationError('bad 1st'), }
+        self.assertTrue('1st' in error.schema)
+        self.assertEquals(error.schema['1st'], 'bad 1st')
+
+        # 2nd level error schema
+        error.errors = {'1st': ValidationError('bad 1st', errors={
+            '2nd': ValidationError('bad 2nd'),
+        })}
+        self.assertTrue('1st' in error.schema)
+        self.assertTrue(isinstance(error.schema['1st'], dict))
+        self.assertTrue('2nd' in error.schema['1st'])
+        self.assertEquals(error.schema['1st']['2nd'], 'bad 2nd')
+
+        # moar levels
+        error.errors = {'1st': ValidationError('bad 1st', errors={
+            '2nd': ValidationError('bad 2nd', errors={
+                '3rd': ValidationError('bad 3rd', errors={
+                    '4th': ValidationError('Inception'),
+                }),
+            }),
+        })}
+        self.assertTrue('1st' in error.schema)
+        self.assertTrue('2nd' in error.schema['1st'])
+        self.assertTrue('3rd' in error.schema['1st']['2nd'])
+        self.assertTrue('4th' in error.schema['1st']['2nd']['3rd'])
+        self.assertEquals(error.schema['1st']['2nd']['3rd']['4th'],
+                          'Inception')
+
+
 if __name__ == '__main__':
     unittest.main()