disallow duplicate entries in config.json #616
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
|
|
||
| problems := findProblemsInTheConfig(jsonBytes, &c) | ||
| if len(problems) != 0 { | ||
| return nil, errors.New(strings.Join(problems, "\n")) |
There was a problem hiding this comment.
Example output is:
the lint 'e_cert_sig_alg_not_match_tbs_sig_alg' was declared 2 times and appeared on line numbers [296 759]
the lint 'e_ocsp_id_pkix_ocsp_nocheck_ext_not_included_server_auth' was declared 2 times and appeared on line numbers [450 762]
robplee
reviewed
Jul 16, 2021
| return &c, nil | ||
| } | ||
|
|
||
| // findProblemsInTheConfig tries keep the configuration honest with regard | ||
| // to aspects such as duplicate entries with in the Expected field. | ||
| func findProblemsInTheConfig(configBytes []byte, c *config) []string { |
There was a problem hiding this comment.
Do you have thoughts about other config problems you may try to find with this function in the future? Otherwise, findDuplicateConfigEntries might be a more precise name for the function.
There was a problem hiding this comment.
Yeah, I was thinking of other things like not being able to declare a result set for a lint that doesn't exist (which also happened in #613 )
There was a problem hiding this comment.
Fair enough, the name seems reasonable then.
robplee
approved these changes
Jul 23, 2021
| return &c, nil | ||
| } | ||
|
|
||
| // findProblemsInTheConfig tries keep the configuration honest with regard | ||
| // to aspects such as duplicate entries with in the Expected field. | ||
| func findProblemsInTheConfig(configBytes []byte, c *config) []string { |
There was a problem hiding this comment.
Fair enough, the name seems reasonable then.
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.
#613 providing me with quite a painful experience of trying to figuring out why deleting and modifying those particular entries in
config.jsondid not have the desired affect. That is, changing the entries would fail the test, but deleting them would not, which was quite surprising. It turns out it was because they were duplicates of entries already declared further up in the document.This change disallows duplicate entries in the integration test JSON as I just don't see a usecase for it and it can cause some confusing results that waste your time.
This PR resolves #615