From 62f9c61ae6657227fd1f5dbc86c59a22b6bac28f Mon Sep 17 00:00:00 2001 From: Dmitry Tantsur Date: Tue, 30 Aug 2022 12:15:42 +0200 Subject: Improve error message heuristics with jsonschema>=4.8 Before version 4.8, jsonschema did some wild guessing when producing error messages for schemas with several equivalent subschemas. In version 4.8 it is no longer done, causing error messages that are more correct but also more generic. This change restores guessing the potential root cause without claiming that it's the only possible root cause. Also the traits schema is simplified to make it less ambiguous. See https://github.com/python-jsonschema/jsonschema/issues/991 for details. Change-Id: Ia75cecd2bfbc602b8b2b85bdda20fdc04c5eadf4 --- ironic/common/args.py | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) (limited to 'ironic/common') diff --git a/ironic/common/args.py b/ironic/common/args.py index 94cfe8841..bd13e3eaf 100755 --- a/ironic/common/args.py +++ b/ironic/common/args.py @@ -211,12 +211,17 @@ def _validate_schema(name, value, schema): try: jsonschema.validate(value, schema) except jsonschema.exceptions.ValidationError as e: - - # The error message includes the whole schema which can be very - # large and unhelpful, so truncate it to be brief and useful - error_msg = ' '.join(str(e).split("\n")[:3])[:-1] - raise exception.InvalidParameterValue( - _('Schema error for %s: %s') % (name, error_msg)) + error_msg = _('Schema error for %s: %s') % (name, e.message) + # Sometimes the root message is too generic, try to find a possible + # root cause: + cause = None + current = e + while current.context: + current = jsonschema.exceptions.best_match(current.context) + cause = current.message + if cause is not None: + error_msg += _('. Possible root cause: %s') % cause + raise exception.InvalidParameterValue(error_msg) return value -- cgit v1.2.1