fix(forge): detect invalid inline config keys
#9363
+63
−6
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
yash-atreya
requested review from
DaniPopes,
klkvr,
mattsse,
grandizzy and
zerosnacks
as code owners
zerosnacks
reviewed
Nov 20, 2024
Comment on lines
+59
to
+65
| return Err(InlineConfigError { | ||
| line, | ||
| source: InlineConfigParserError::InvalidConfigKey( | ||
| wrong_key, | ||
| format!("{VALID_CONFIG_KEYS:?}"), | ||
| ), | ||
| }); |
There was a problem hiding this comment.
I think a warning would be sufficient here given that the key is simply ignored when continuing
There was a problem hiding this comment.
Warnings won't be shown if --quiet is enabled.
Moreover, currently we error out on invalid property keys like fuzz.runssss. This keeps it consistent with that i.e err thrown on invalid keys.
zerosnacks
reviewed
Nov 20, 2024
Comment on lines
+5
to
+11
| /// Used to detect invalid configuration keys in the inline config. | ||
| /// | ||
| /// # Example | ||
| /// | ||
| /// forge-config: default.fuzz.runs = 100 - `fuzz` is a valid key | ||
| /// forge-config: default.wrong.runs = 100 - `wrong` is an invalid key | ||
| const VALID_CONFIG_KEYS: [&str; 2] = ["fuzz", "invariant"]; |
There was a problem hiding this comment.
For now this is sufficient I think, assuming this functionality will be updated when we have full support for in-line configuration
mattsse
reviewed
Nov 20, 2024
| /// | ||
| /// forge-config: default.fuzz.runs = 100 - `fuzz` is a valid key | ||
| /// forge-config: default.wrong.runs = 100 - `wrong` is an invalid key | ||
| const VALID_CONFIG_KEYS: [&str; 2] = ["fuzz", "invariant"]; |
There was a problem hiding this comment.
I wonder if this isn't too simplistic?
There was a problem hiding this comment.
It is for now. But it won't be needed when we have full support for inline config.
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
Closes #5371
Solution
const VALID_CONFIG_KEYSVALID_CONFIG_KEYS.InvalidConfigKeyerror if it does.