[BugFix]: Gracefully handle keys for maps that are not of type string #418
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
joshfried-aws
requested review from
akshayrane,
setttings,
Neel-Renavikar,
razcloud,
Brianwithay21,
wkexiang,
frankret,
brianlaoaws,
reza-aws,
rpdutt,
minhphuong98 and
pamkuang
minhphuong98
approved these changes
Nov 28, 2023
akshayrane
approved these changes
Nov 28, 2023
Merged
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.
Issue #, if available:
N/A
Description of changes:
We have received a report about guard panicking when a key in a map isn't of type string. Our previous release had an oversight and we believed it was from an issue with nested maps only. Upon further investigation we realized this was not the case.
To remain consistent, we have decided to currently only allow for string types as keys for maps. If a template provides a key of a different type, cfn-guard will error out, and advise them of the issue.
An example error message looks like this:
In addition to this, we also refactored our
InternalErrorvariant to be an enum itself, with 2 different variants currently. The 2 variants areInvalidKeyTypeandUnresolvedKeyForReporterBy submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license