[java] Fix problem with whitespace in properties#3064
Merged
adangel merged 4 commits intoJan 21, 2021
Conversation
Change contract in Annotatable interface The goal is to allow us to drop support for canonical name loading in PMD 7, for performance.
Generated by 🚫 Danger |
adangel
approved these changes
Jan 21, 2021
adangel
left a comment
Member
There was a problem hiding this comment.
Thanks!
I agree, TypeTestUtil should be strict and validation should happen higher up.
And eventually (with PMD 7), we might even validate the properties already.
adangel
added a commit
that referenced
this pull request
Jan 21, 2021
oowekyala:issue2454-typehelper-trim-whitespace [java] Fix problem with whitespace in properties #3064
36 tasks
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Describe the PR
The problem with #2454 is that the input to TypeTestUtil is not sanitized to remove whitespace from the property value.
We can either
I prefer solution 2, so TypeTestUtil now checks that its input is a binary name without whitespace. Annotatable, which is a bit higher in the call tree, still cleans up the input strings, so it doesn't change behavior.
In PMD 7 I think we should be more restrictive vis à vis this user input, and sanitize it directly in the properties (eg with property constraints, refs #1432). Then we're sure that every class name we handle is a valid binary name.
The AssertionUtil here is extracted from the pmd 7 branch
Related issues
Ready?
./mvnw clean verifypasses (checked automatically by travis)