Problem with top-level oneOf construct and validation

[wshayes]

Having trouble with the validation error for a top-level oneOf jsonschema construct. I've put an example script together showing the problem where I have a missing 'id' property that is required. https://gist.github.com/7bb4118cfe21b962cdc1.git

The error I get is:

jsonschema.exceptions.ValidationError: {u'graph': {u'label': u'testlabel'}} is not valid under any of the given schemas

Failed validating u'oneOf' in schema:

followed by the entire schema file.

[Julian]

Hey.

You are specifying that id is required, and not providing it. See https://python-jsonschema.readthedocs.org/en/latest/errors/#jsonschema.exceptions.ValidationError.context which will give you some info that helps debugging these kinds of errors, and also jsonschema.exceptions.best_match.

Also it'd be helpful in the future if you provided full traceback, and possibly tried the mailing list rather than the issue tracker :).

[wshayes]

The error I was getting with the top-level oneOf construct is much less useful than the error messages without the top-level oneOf construct. Without the oneOf construct - the error messages indicate it's a missing 'id' that is required. With the oneOf construct - I got the validation error above. I thought that the lack of specificity in the error message is worthy of an issue. If this is working as expected, it will make it very hard to track down the reason a json file is failing a jsonschema validation.

Looks like the link I included with the test json files, jsonschema and test python script isn't working. You can clone the gist at: https://gist.github.com/7bb4118cfe21b962cdc1.git or try the link: https://gist.github.com/wshayes/7bb4118cfe21b962cdc1

[Julian]

Ah I see, yes it's expected, but if you have suggestions for improvement I'd love to hear them. Had you seen context? It exists specifically for this case, and while naming always sucks, it's quite effective IMHO.

Every validation error means "this validator failed" and corresponds to a single error in the schema. The "problem" with oneOf and friends is that they are compound errors, and they fail for arbitrarily deep other sub-errors. best_match makes that even more transparent.

[wshayes]

I've seen context, but it seems to dump the entire file in this case (a large JSON construct) - I could not interpret what was causing the validation error. I tried best_match - it returned with 'None'. I'm not sure how best to fix this. I'd be happy enough when using it to see different validation errors one at a time and to fix them with an indicator of where in the JSON file it failed and why. This tool is very useful - just not easy to sort out the validation issues in the case of compound errors.

On Jul 4, 2014, at 3:01 PM, Julian Berman notifications@github.com wrote:

Ah I see, yes it's expected, but if you have suggestions for improvement I'd love to hear them. Had you seen context? It exists specifically for this case, and while naming always sucks, it's quite effective IMHO.

Every validation error means "this validator failed" and corresponds to a single error in the schema. The "problem" with oneOf and friends is that they are compound errors, and they fail for arbitrarily deep other sub-errors. best_match makes that even more transparent.

—
Reply to this email directly or view it on GitHub.

[Julian]

What do you mean "dump the entire file"? .context doesn't print things, it's an attribute of validation errors – what exactly are you running? Same with best_match, it gives exactly what you want, assuming you ran:

>>> jsonschema.exceptions.best_match(jsonschema.Draft4Validator(schema).iter_errors(bad_network))
<ValidationError: "u'id' is a required property">

[wshayes]

Thanks - I'll take anything further on this to the mailing list. I'll try again with the validation error attributes and best_match. I was probably doing something wrong.

On Jul 4, 2014, at 3:23 PM, Julian Berman notifications@github.com wrote:

What do you mean "dump the entire file"? .context doesn't print things, it's an attribute of validation errors – what exactly are you running? Same with best_match, it gives exactly what you want, assuming you ran:

jsonschema.exceptions.best_match(jsonschema.Draft4Validator(schema).iter_errors(bad_network))
<ValidationError: "u'id' is a required property">
—
Reply to this email directly or view it on GitHub.

[dennismonsewicz]

I am using the jsonschema module like so:

            validate(autoresponder_workflow, self.schema)
        except ValidationError as e:
            field = '%s %s' % (e.path.popleft(), e.path.pop())
            raise MissingInformation('%s is missing' % field)

How could I use the best_match while utilizing the try:; except?

[Julian]

You wouldn't, or well, you could use it in a limited way if you just wanted it to traverse into oneOfs for you by calling best_match([e]), but more likely you want to switch to using iter_errors instead.

[dennismonsewicz]

@Julian could you give an example of using the iter_errors?