feat: extend validation interface with new method to iterate over all the problems

[e3krisztian]

cyclonedx.validation.SchemabasedValidator defines only a single method available: .validate_str(), which returns only the first problem found.

I would like to ask for an extension of the interface with a new method iterate_errors() to iterate over all the problems.

---

This could be used to add some smartness finding the most helpful error[s] - something like best_match in https://github.com/python-jsonschema/jsonschema/blob/main/jsonschema/exceptions.py do.

---

The underlying libraries already have support for it:
jsonschema has Validator.iter_errors():
https://github.com/python-jsonschema/jsonschema/blob/f5cfc0ead76a8fc69db040cd94ed3a5e505dca81/jsonschema/protocols.py#L169-L172

Have not looked deeper into the XML case, but it is probably also available, as only the last error is returned (L71):

cyclonedx-python-lib/cyclonedx/validation/xml.py

Lines 62 to 72 in 1a932a2

	def validate_str(self, data: str) -> Optional[ValidationError]:
	return self._validata_data(
	xml_fromstring( # nosec B320
	bytes(data, encoding='utf8'),
	parser=self.__xml_parser))
	def _validata_data(self, data: Any) -> Optional[ValidationError]:
	validator = self._validator # may throw on error that MUST NOT be caught
	if not validator.validate(data):
	return ValidationError(validator.error_log.last_error)
	return None

[jkowalleck]

This python library is a community effort.
Feel free to donate improvements via pullrequeasts. Here are our contribution guidelines: https://github.com/CycloneDX/cyclonedx-python-lib/blob/main/CONTRIBUTING.md

PS: please be aware that the underlying validation libraries are intended to be exchangeable - don't depend too much on their infra.

[e3krisztian]

This python library is a community effort. Feel free to donate improvements via pullrequeasts. Here are our contribution guidelines: https://github.com/CycloneDX/cyclonedx-python-lib/blob/main/CONTRIBUTING.md

Thanks, will make an attempt at it.

PS: please be aware that the underlying validation libraries are intended to be exchangeable - don't depend too much on their infra.

I am new to the CycloneDX library - are there other validation implementations besides jsonschema and lxml I need to look at?

[jkowalleck]

I am new to the CycloneDX library - are there other validation implementations besides jsonschema and lxml I need to look at?

nope, just those that inherit .validation.SchemabasedValidator

cyclonedx-python-lib/cyclonedx/validation/__init__.py

Lines 48 to 59 in 1a932a2

	class SchemabasedValidator(Protocol):
	"""Schema-based Validator protocol"""
	def validate_str(self, data: str) -> Optional[ValidationError]:
	"""Validate a string
	:param data: the data string to validate
	:return: validation error
	:retval None: if ``data`` is valid
	:retval ValidationError: if ``data`` is invalid
	"""
	... # pragma: no cover

[jkowalleck]

fixed via https://github.com/CycloneDX/cyclonedx-python-lib/releases/tag/v10.3.0

Schema based validation may return iterable of all errors (#834, f95576f)