Skip to content

feat: validators return specific error classes #840

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 3, 2025
Merged

feat: validators return specific error classes #840

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8e5deee
feat: validators return specific error classes
jkowalleck Jul 3, 2025
0b765bc
wip
jkowalleck Jul 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 17 additions & 8 deletions cyclonedx/validation/json.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
# Copyright (c) OWASP Foundation. All Rights Reserved.


__all__ = ['JsonValidator', 'JsonStrictValidator']
__all__ = ['JsonValidator', 'JsonStrictValidator', 'JsonValidationError']

from abc import ABC
from collections.abc import Iterable
Expand All @@ -40,6 +40,7 @@
from referencing.jsonschema import DRAFT7

if TYPE_CHECKING: # pragma: no cover
from jsonschema.exceptions import ValidationError as JsonSchemaValidationError # type:ignore[import-untyped]
from jsonschema.protocols import Validator as JsonSchemaValidator # type:ignore[import-untyped]
except ImportError as err:
_missing_deps_error = MissingOptionalDependencyException(
Expand All @@ -48,6 +49,14 @@
), err


class JsonValidationError(ValidationError):
@classmethod
def _make_from_jsve(cls, e: 'JsonSchemaValidationError') -> 'JsonValidationError':
"""⚠️ This is an internal API. It is not part of the public interface and may change without notice."""
# in preparation for https://github.com/CycloneDX/cyclonedx-python-lib/pull/836
return cls(e)


class _BaseJsonValidator(BaseSchemabasedValidator, ABC):
@property
def output_format(self) -> Literal[OutputFormat.JSON]:
Expand All @@ -60,16 +69,16 @@ def __init__(self, schema_version: 'SchemaVersion') -> None:
# region typing-relevant copy from parent class - needed for mypy and doc tools

@overload
def validate_str(self, data: str, *, all_errors: Literal[False] = ...) -> Optional[ValidationError]:
def validate_str(self, data: str, *, all_errors: Literal[False] = ...) -> Optional[JsonValidationError]:
... # pragma: no cover

@overload
def validate_str(self, data: str, *, all_errors: Literal[True]) -> Optional[Iterable[ValidationError]]:
def validate_str(self, data: str, *, all_errors: Literal[True]) -> Optional[Iterable[JsonValidationError]]:
... # pragma: no cover

def validate_str(
self, data: str, *, all_errors: bool = False
) -> Union[None, ValidationError, Iterable[ValidationError]]:
) -> Union[None, JsonValidationError, Iterable[JsonValidationError]]:
... # pragma: no cover

# endregion
Expand All @@ -79,22 +88,22 @@ def validate_str(

def validate_str( # type:ignore[no-redef] # noqa:F811 # typing-relevant headers go first
self, data: str, *, all_errors: bool = False
) -> Union[None, ValidationError, Iterable[ValidationError]]:
) -> Union[None, JsonValidationError, Iterable[JsonValidationError]]:
raise self.__MDERROR[0] from self.__MDERROR[1]

else:

def validate_str( # type:ignore[no-redef] # noqa:F811 # typing-relevant headers go first
self, data: str, *, all_errors: bool = False
) -> Union[None, ValidationError, Iterable[ValidationError]]:
) -> Union[None, JsonValidationError, Iterable[JsonValidationError]]:
validator = self._validator # may throw on error that MUST NOT be caught
structure = json_loads(data)
errors = validator.iter_errors(structure)
first_error = next(errors, None)
if first_error is None:
return None
first_error = ValidationError(first_error)
return chain((first_error,), map(ValidationError, errors)) \
first_error = JsonValidationError._make_from_jsve(first_error)
return chain((first_error,), map(JsonValidationError._make_from_jsve, errors)) \
if all_errors \
else first_error

Expand Down
27 changes: 19 additions & 8 deletions cyclonedx/validation/xml.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
# Copyright (c) OWASP Foundation. All Rights Reserved.


__all__ = ['XmlValidator']
__all__ = ['XmlValidator', 'XmlValidationError']

from abc import ABC
from collections.abc import Iterable
Expand All @@ -37,13 +37,24 @@
XMLSchema,
fromstring as xml_fromstring,
)

if TYPE_CHECKING: # pragma: no cover
from lxml.etree import _LogEntry as _XmlLogEntry
except ImportError as err:
_missing_deps_error = MissingOptionalDependencyException(
'This functionality requires optional dependencies.\n'
'Please install `cyclonedx-python-lib` with the extra "xml-validation".\n'
), err


class XmlValidationError(ValidationError):
@classmethod
def _make_from_xle(cls, e: '_XmlLogEntry') -> 'XmlValidationError':
"""⚠️ This is an internal API. It is not part of the public interface and may change without notice."""
# in preparation for https://github.com/CycloneDX/cyclonedx-python-lib/pull/836
return cls(e)


class _BaseXmlValidator(BaseSchemabasedValidator, ABC):

@property
Expand All @@ -57,16 +68,16 @@ def __init__(self, schema_version: 'SchemaVersion') -> None:
# region typing-relevant copy from parent class - needed for mypy and doc tools

@overload
def validate_str(self, data: str, *, all_errors: Literal[False] = ...) -> Optional[ValidationError]:
def validate_str(self, data: str, *, all_errors: Literal[False] = ...) -> Optional[XmlValidationError]:
... # pragma: no cover

@overload
def validate_str(self, data: str, *, all_errors: Literal[True]) -> Optional[Iterable[ValidationError]]:
def validate_str(self, data: str, *, all_errors: Literal[True]) -> Optional[Iterable[XmlValidationError]]:
... # pragma: no cover

def validate_str(
self, data: str, *, all_errors: bool = False
) -> Union[None, ValidationError, Iterable[ValidationError]]:
) -> Union[None, XmlValidationError, Iterable[XmlValidationError]]:
... # pragma: no cover

# endregion typing-relevant
Expand All @@ -76,13 +87,13 @@ def validate_str(

def validate_str( # type:ignore[no-redef] # noqa:F811 # typing-relevant headers go first
self, data: str, *, all_errors: bool = False
) -> Union[None, ValidationError, Iterable[ValidationError]]:
) -> Union[None, XmlValidationError, Iterable[XmlValidationError]]:
raise self.__MDERROR[0] from self.__MDERROR[1]

else:
def validate_str( # type:ignore[no-redef] # noqa:F811 # typing-relevant headers go first
self, data: str, *, all_errors: bool = False
) -> Union[None, ValidationError, Iterable[ValidationError]]:
) -> Union[None, XmlValidationError, Iterable[XmlValidationError]]:
validator = self._validator # may throw on error that MUST NOT be caught
valid = validator.validate(
xml_fromstring( # nosec B320 -- we use a custom prepared safe parser
Expand All @@ -91,9 +102,9 @@ def validate_str( # type:ignore[no-redef] # noqa:F811 # typing-relevant headers
if valid:
return None
errors = validator.error_log
return map(ValidationError, errors) \
return map(XmlValidationError._make_from_xle, errors) \
if all_errors \
else ValidationError(errors.last_error)
else XmlValidationError._make_from_xle(errors.last_error)

__validator: Optional['XMLSchema'] = None

Expand Down
12 changes: 6 additions & 6 deletions examples/complex_deserialize.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,9 +147,9 @@
}"""
my_json_validator = JsonStrictValidator(SchemaVersion.V1_6)
try:
validation_errors = my_json_validator.validate_str(json_data)
if validation_errors:
print('JSON invalid', 'ValidationError:', repr(validation_errors), sep='\n', file=sys.stderr)
json_validation_errors = my_json_validator.validate_str(json_data)
if json_validation_errors:
print('JSON invalid', 'ValidationError:', repr(json_validation_errors), sep='\n', file=sys.stderr)
sys.exit(2)
print('JSON valid')
except MissingOptionalDependencyException as error:
Expand Down Expand Up @@ -248,9 +248,9 @@
</bom>"""
my_xml_validator: 'XmlValidator' = make_schemabased_validator(OutputFormat.XML, SchemaVersion.V1_6)
try:
validation_errors = my_xml_validator.validate_str(xml_data)
if validation_errors:
print('XML invalid', 'ValidationError:', repr(validation_errors), sep='\n', file=sys.stderr)
xml_validation_errors = my_xml_validator.validate_str(xml_data)
if xml_validation_errors:
print('XML invalid', 'ValidationError:', repr(xml_validation_errors), sep='\n', file=sys.stderr)
sys.exit(2)
print('XML valid')
except MissingOptionalDependencyException as error:
Expand Down
12 changes: 6 additions & 6 deletions examples/complex_serialize.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,9 +91,9 @@
print(serialized_json)
my_json_validator = JsonStrictValidator(SchemaVersion.V1_6)
try:
validation_errors = my_json_validator.validate_str(serialized_json)
if validation_errors:
print('JSON invalid', 'ValidationError:', repr(validation_errors), sep='\n', file=sys.stderr)
json_validation_errors = my_json_validator.validate_str(serialized_json)
if json_validation_errors:
print('JSON invalid', 'ValidationError:', repr(json_validation_errors), sep='\n', file=sys.stderr)
sys.exit(2)
print('JSON valid')
except MissingOptionalDependencyException as error:
Expand All @@ -112,9 +112,9 @@
my_xml_validator: 'XmlValidator' = make_schemabased_validator(
my_xml_outputter.output_format, my_xml_outputter.schema_version)
try:
validation_errors = my_xml_validator.validate_str(serialized_xml)
if validation_errors:
print('XML invalid', 'ValidationError:', repr(validation_errors), sep='\n', file=sys.stderr)
xml_validation_errors = my_xml_validator.validate_str(serialized_xml)
if xml_validation_errors:
print('XML invalid', 'ValidationError:', repr(xml_validation_errors), sep='\n', file=sys.stderr)
sys.exit(2)
print('XML valid')
except MissingOptionalDependencyException as error:
Expand Down