Core: Options - Validate keys when loading an OptionSet or OptionList from text #3274
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
affects: core
agilbert1412
added
the
is: bug/fix
github-actions
bot
added
the
waiting-on: peer-review
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is this fixing or adding?
Currently, if loading an OptionSet or OptionKey from an iterable, it validates that the keys are all valid, using the valid_keys optional attribute (if set).
But when loading from_text(), it does not do this validation. This leads to the problem that, depending on how the yaml is formatted (and, presumably, other sources like unit tests could have the same issue), the valid keys can be bypassed entirely
How was this tested?
Ran the unit tests, made sure nothing was broken.
Ran my own test case (from the original problem that made me discover this), and it now validates my keys properly
If this makes graphical changes, please attach screenshots.