fix(test): strip ansi colors in junit output #23371
Open
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
bartlomieju
reviewed
Apr 15, 2024
Comment on lines
+11
to
+12
| static ANSI_ESCAPE_REMOVE: Lazy<Regex> = | ||
| lazy_regex::lazy_regex!(r#"\x1b\[([\x30-\x3f]*[\x20-\x2f]*[\x40-\x7e])"#); |
There was a problem hiding this comment.
Feels like we already have this code available somewhere...
There was a problem hiding this comment.
Ah, you can import it from console_static_text::ansi::strip_ansi_codes
magurotuna
reviewed
Apr 16, 2024
Comment on lines
+5
to
+6
| // deno-lint-ignore no-explicit-any | ||
| Deno.test("step fail color", async (t: any) => { |
There was a problem hiding this comment.
is this type annotation needed?
Comment on lines
+39
to
+53
| TestResult::Failed(failure) => { | ||
| let message = failure.overview(); | ||
| let detail = failure.detail(); | ||
| let message_stripped = | ||
| ANSI_ESCAPE_REMOVE.replace_all(message.as_str(), ""); | ||
| let detail_stripped = | ||
| ANSI_ESCAPE_REMOVE.replace_all(detail.as_str(), ""); | ||
| quick_junit::TestCaseStatus::NonSuccess { | ||
| kind: quick_junit::NonSuccessKind::Failure, | ||
| message: Some(message_stripped.into()), | ||
| ty: None, | ||
| description: Some(detail_stripped.into()), | ||
| reruns: vec![], | ||
| } | ||
| } |
There was a problem hiding this comment.
I thought that it would be great to remove escape codes only when printing to non-tty, but considering it further, now I feel this isn't really necessary given that JUnit XML output is not read by human but actually ingested by some other programs in 99.9% cases.
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.
This PR strips ansi escape codes in the JUnit reporter.
Fixes #23316