feat: iterate over validation errors

There was only one validation method, that returned a single error (and
it was the first error (JSON) or the last one (XML)).

The new function `SchemabasedValidator.iterate_errors()` allows to
enumerate over all the validation errors.

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

Author: e3krisztian

cyclonedx/validation/__init__.py

@@ -17,6 +17,7 @@
 
 
 from abc import ABC, abstractmethod
+from collections.abc import Iterable
 from typing import TYPE_CHECKING, Any, Literal, Optional, Protocol, Union, overload
 
 from ..schema import OutputFormat
@@ -120,6 +121,14 @@ def validate_str(self, data: str) -> Optional[ValidationError]:
         """
         ...  # pragma: no cover
 
+    def iterate_errors(self, data: str) -> Iterable[ValidationError]:
+        """Validate a string, enumerating all the problems.
+
+        :param data: the data string to validate
+        :return: iterator over the errors
+        """
+        ...  # pragma: no cover
+
 
 class BaseSchemabasedValidator(ABC, SchemabasedValidator):
     """Base Schema-based Validator"""

cyclonedx/validation/json.py

@@ -19,6 +19,7 @@
 __all__ = ['JsonValidator', 'JsonStrictValidator']
 
 from abc import ABC
+from collections.abc import Iterable
 from json import loads as json_loads
 from typing import TYPE_CHECKING, Any, Literal, Optional
 
@@ -107,7 +108,14 @@ def __init__(self, schema_version: 'SchemaVersion') -> None:
         def validate_str(self, data: str) -> Optional[ValidationError]:
             raise self.__MDERROR[0] from self.__MDERROR[1]
 
+        def iterate_errors(self, data: str) -> Iterable[ValidationError]:
+            raise self.__MDERROR[0] from self.__MDERROR[1]
     else:
+        def iterate_errors(self, data: str) -> Iterable[ValidationError]:
+            json_data = json_loads(data)
+            validator = self._validator  # may throw on error that MUST NOT be caught
+            yield from validator.iter_errors(json_data)
+
         def validate_str(self, data: str) -> Optional[ValidationError]:
             return self._validate_data(
                 json_loads(data))

cyclonedx/validation/xml.py

@@ -19,6 +19,7 @@
 __all__ = ['XmlValidator']
 
 from abc import ABC
+from collections.abc import Iterable
 from typing import TYPE_CHECKING, Any, Literal, Optional
 
 from ..exception import MissingOptionalDependencyException
@@ -53,12 +54,24 @@ def __init__(self, schema_version: 'SchemaVersion') -> None:
         # this is the def that is used for generating the documentation
         super().__init__(schema_version)
 
-    if _missing_deps_error:
+    if _missing_deps_error:  # noqa:C901
         __MDERROR = _missing_deps_error
 
         def validate_str(self, data: str) -> Optional[ValidationError]:
             raise self.__MDERROR[0] from self.__MDERROR[1]
+
+        def iterate_errors(self, data: str) -> Iterable[ValidationError]:
+            raise self.__MDERROR[0] from self.__MDERROR[1]
     else:
+        def iterate_errors(self, data: str) -> Iterable[ValidationError]:
+            xml_data = xml_fromstring(  # nosec B320
+                bytes(data, encoding='utf8'),
+                parser=self.__xml_parser)
+            validator = self._validator  # may throw on error that MUST NOT be caught
+            validator.validate(xml_data)
+            for error in validator.error_log:
+                yield ValidationError(error)
+
         def validate_str(self, data: str) -> Optional[ValidationError]:
             return self._validate_data(
                 xml_fromstring(  # nosec B320

tests/test_validation_json.py

@@ -117,6 +117,8 @@ def test_validate_no_none(self, schema_version: SchemaVersion, test_data_file: s
             self.skipTest('MissingOptionalDependencyException')
         self.assertIsNone(validation_error)
 
+        self.assertEqual(list(validator.iterate_errors(test_data)), [])
+
     @idata(chain(
         _dp_sv_tf(False),
         _dp_sv_own(False)
@@ -138,3 +140,5 @@ def test_validate_expected_error(self, schema_version: SchemaVersion, test_data_
 
         squeezed_message = validation_error.get_squeezed_message(max_size=100)
         self.assertLessEqual(len(squeezed_message), 100, squeezed_message)
+
+        self.assertNotEqual(list(validator.iterate_errors(test_data)), [])

tests/test_validation_xml.py

@@ -77,6 +77,8 @@ def test_validate_no_none(self, schema_version: SchemaVersion, test_data_file: s
             self.skipTest('MissingOptionalDependencyException')
         self.assertIsNone(validation_error)
 
+        self.assertEqual(list(validator.iterate_errors(test_data)), [])
+
     @idata(chain(
         _dp_sv_tf(False),
         _dp_sv_own(False)
@@ -98,3 +100,5 @@ def test_validate_expected_error(self, schema_version: SchemaVersion, test_data_
 
         squeezed_message = validation_error.get_squeezed_message(max_size=100)
         self.assertLessEqual(len(squeezed_message), 100, squeezed_message)
+
+        self.assertNotEqual(list(validator.iterate_errors(test_data)), [])