Add configuration validation #709
Merged
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
paracycle
force-pushed
the
uk-validate-config
branch
from
042573d
to
c997622
Compare
vinistock
reviewed
Jan 18, 2022
mutecipher
approved these changes
Jan 18, 2022
vinistock
approved these changes
Jan 18, 2022
The first time `options` method is hit, we validate the Tapioca configuration. The validation makes sure that all top level keys match to some command, all command options match to one of the flags for that command and that all values for command options are of the expected type.
paracycle
force-pushed
the
uk-validate-config
branch
from
c997622
to
dd3d128
Compare
Morriar
approved these changes
Jan 18, 2022
| Thor::CoreExt::HashWithIndifferentAccess.new(config[command_name] || {}) | ||
| end | ||
|
|
||
| sig { params(config_file: String, config: T::Hash[T.untyped, T.untyped]).void } | ||
| def validate_config!(config_file, config) | ||
| # To ensure that this is not re-entered, we mark during validation |
There was a problem hiding this comment.
Do we expect config_options to be called more than once in the same execution?
There was a problem hiding this comment.
Yes, say_error (or say) end up calling options[:quiet] to decide to print or not which ends up reentering the options method, before we've memoized the merged options hash. That causes an infinite loop. In general, any Thor code we call from this method could end up doing another options lookup, so I am protecting this method.
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.
Motivation
Fixes #704
Implementation
The first time
optionsmethod is hit, we validate the Tapioca configuration. The validation makes sure that all top level keys match to some command, all command options match to one of the flags for that command and that all values for command options are of the expected type.Tests
Add new tests for configuration failures.