Replace non-printable characters in display names #4813
Conversation
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
Prior to this commit, display names were "sanitized" before they were printed via the ConsoleLauncher (junit-team#1713), and text-based arguments in display names for parameterized tests were quoted and escaped (junit-team#4716). However, there was still the chance that display names could contain control characters such as CR or LF. To address that, this commit introduces support for automatically replacing non-printable characters in any display name passed to one of the constructors for AbstractTestDescriptor. Doing so automatically covers all display names in JUnit Jupiter, @SuiteDisplayName, and any other test engines that subclass AbstractTestDescriptor, which should cover most common use cases. Specifically, the following replacements are performed. - \r -> <CR> - \n -> <LF> - ISO control character -> � (Unicode replacement character) This commit also removes the special handling of ISO control characters from QuoteUtils, since this is now handled in AbstractTestDescriptor. See junit-team#1713 See junit-team#4716 Closes junit-team#4714
d118523 to
87eb2f6
Compare
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.
Prior to this commit, display names were "sanitized" before they were printed via the
ConsoleLauncher(#1713), and text-based arguments in display names for parameterized tests were quoted and escaped (#4716). However, there was still the chance that display names could contain control characters such as CR or LF.To address that, this commit introduces support for automatically replacing non-printable characters in any display name passed to one of the constructors for
AbstractTestDescriptor. Doing so automatically covers all display names in Jupiter,@SuiteDisplayName, and any other test engines that subclassAbstractTestDescriptor, which should cover most common use cases.Specifically, the following replacements are performed.
\r-><CR>\n-><LF>This commit also removes the special handling of ISO control characters from
QuoteUtils, since this is now handled withinAbstractTestDescriptor.ConsoleLauncher#1713