-
Notifications
You must be signed in to change notification settings - Fork 226
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add validation for null members in structures, lists and maps #2393
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
ac5a74c
to
3b3bb39
Compare
rationull
reviewed
Sep 5, 2024
smithy-model/src/main/java/software/amazon/smithy/model/validation/NodeValidationVisitor.java
Outdated
Show resolved
Hide resolved
kstich
requested changes
Sep 5, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some comments on event message formatting (that will also require test updates) and a simplification of the conditional check.
smithy-model/src/main/java/software/amazon/smithy/model/validation/NodeValidationVisitor.java
Outdated
Show resolved
Hide resolved
smithy-model/src/main/java/software/amazon/smithy/model/validation/NodeValidationVisitor.java
Outdated
Show resolved
Hide resolved
smithy-model/src/main/java/software/amazon/smithy/model/validation/NodeValidationVisitor.java
Outdated
Show resolved
Hide resolved
smithy-model/src/main/java/software/amazon/smithy/model/validation/NodeValidationVisitor.java
Outdated
Show resolved
Hide resolved
kstich
reviewed
Sep 5, 2024
smithy-model/src/main/java/software/amazon/smithy/model/validation/NodeValidationVisitor.java
Outdated
Show resolved
Hide resolved
smithy-model/src/main/java/software/amazon/smithy/model/validation/NodeValidationVisitor.java
Outdated
Show resolved
Hide resolved
smithy-model/src/main/java/software/amazon/smithy/model/validation/NodeValidationVisitor.java
Outdated
Show resolved
Hide resolved
smithy-model/src/main/java/software/amazon/smithy/model/validation/NodeValidationVisitor.java
Outdated
Show resolved
Hide resolved
smithy-model/src/main/java/software/amazon/smithy/model/validation/NodeValidationVisitor.java
Outdated
Show resolved
Hide resolved
rationull
reviewed
Sep 5, 2024
smithy-model/src/main/java/software/amazon/smithy/model/validation/NodeValidationVisitor.java
Outdated
Show resolved
Hide resolved
Simplify conditional check, return immediately for each case, change msg formatting Co-authored-by: Kevin Stich <kevin@kstich.com>
Remove unnecessary breaks
kstich
approved these changes
Sep 9, 2024
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.
Background
Previously, a NullNode could be provided as a required structure member without emitting a ValidationEvent. So an example test below would fail.
This happens because the memberShape function would check the member's target instead of itself, which always satisfies the !shape.isMemberShape() condition in the invalidShape function.
To fix this I added a new function to check null member nodes for structures, lists and maps. It relies on the
isMemberNullable
function, which checks that:Testing
Added testcases:
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.