refactor(@jest/reporters): improve annotation formatting of GitHubActionsReporter
#12826
Conversation
|
Absolute paths are still bugging me. Will try one more time. Otherwise, looking good:
|
|
That’s much better – macOS, ubuntu, windows:
|
|
Visual difference is very minimal, just a bit cleaner. Colors would help, but they are not supported at the moment. Before:
After:
|
| failureMessages.forEach(failure => { | ||
| const {message, stack} = separateMessageFromStack(stripAnsi(failure)); | ||
|
|
||
| const relativeTestPath = slash(relative('', test.path)); |
There was a problem hiding this comment.
For some reason, rootDir is not pointing to the right place. See #12822 (comment).
In the other hand, in CI it feels right to keep paths relative to root of the repo.
|
Just made sure that annotations look similar to the one in CLI and path normalization works as expected. If some helper throws outside a test file:
That all looks fine with
Also snapshots:
And a nested title case:
|
|
One more case to do: would be nice to annotate |
|
Exciting! 😀 |
|
Done. Annotates retry messages as warnings, if
|
| line: string, | ||
| ) => { | ||
| config: StackTraceConfig, | ||
| relativeTestPath: string | null = null, |
There was a problem hiding this comment.
Perhaps fine to have null as default, it just enables more styling.
| aggregatedResults?: AggregatedResult, | ||
| ): void { | ||
| const messages = getMessages(aggregatedResults?.testResults); | ||
| onTestFileResult({context}: Test, {testResults}: TestResult): void { |
There was a problem hiding this comment.
onTestFileResult is needed to annotate retries. I was trying to use onTestCaseResult first, but it reports retried tests as failures. (By the way, strangely TestContext from onTestCaseResult has wrong rootDir, but all is good with onTestFileResult.)
There was a problem hiding this comment.
By the way, strangely
TestContextfromonTestCaseResulthas wrongrootDir, but all is good withonTestFileResult.)
can you file an issue for it?
There was a problem hiding this comment.
Have to figure out what is the root of that. Locally all was fine, but not on CI. Strange thing. Let’s see.
|
This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
Split from #12822
Summary
As mentioned, annotations produced by
GitHubActionsReporteris very nice improvement. Few details could make them even better:Test plan
Reworked unit tests. And some screenshots from temporary failing tests.