tests: API: Test unrecognized fields everywhere #1382
Conversation
Currently we test adding unrecognised fields in specific places in our file format structure. Instead add the fields everywhere (except specific locations where that would not be valid). Signed-off-by: Jussi Kukkonen <[email protected]>
jku
force-pushed
the
automate-unrecognised-fields-testing
branch
from
29b9e92 to
dad0b58
Compare
|
rebased on develop |
|
|
||
| # if dicts keys are limited in spec or if dicts values are | ||
| # strictly defined, skip it | ||
| if name in ["hashes", "keys", "meta", "roles", "targets"]: |
There was a problem hiding this comment.
Not really a review but how did we come up with this list? I guess you did it by going through the spec. Can we note it somewhere so that we don't do it again?
There was a problem hiding this comment.
Yes you guessed correctly. I'll try to phrase that somehow clearly
There was a problem hiding this comment.
Wondering why do you include meta here?
There was a problem hiding this comment.
because it seems to me the meta content is strictly defined: keys must be metadata filenames (in the timestamp case there is basically only one allowed value). values must be MetaFile dict representations. I don't think allowing something else is reasonable.
|
I will suggest combing this pr with changes in ADR 8 clarifying that some of the fields won't support unrecognized fields. |
|
The alternative to this PR would be to include a test case "unrecognised fields" in every test dataset in #1416 ... That would mean none of this code is needed (good) but does mean we'd have to be diligent about really including the cases everywhere (bad) We could leave this as draft until we see if we get #1416 implemented in a nice way instead? |
|
Yes, I suppose let's agree on 1416 and then decide about this one. |
|
made this a draft until we see if serialization tests can/should cover this without code |
|
The Pr using the table testing for tests connected with unrecognized fields out in the wild: #1466. |
Currently we test adding unrecognised fields in specific places in our
file format structure. Instead add the fields everywhere (except
specific locations where that would not be valid).
Signed-off-by: Jussi Kukkonen [email protected]
The idea here is to test inserting custom items into every dictionary (except where spec doesn't actually allow it), instead of testing only specific dictionaries.