[SUREFIRE-2219] Option to include stdOut/stdErr console logs into test report

[jira-importer]

Alexander Kriegisch opened SUREFIRE-2219 and commented

Surefire report XML includes tags capturing console logs, e.g. testsuite/testcase/system-err:

!image-2023-12-02-11-16-11-109.png!

As a report reader, I want to see the stdOut/stdErr console logs per test case in the HTML report, ideally in a monotype font to easily be able to read stack traces.

This requirement has been discussed online a lot, e.g. on Stack Overflow or Reddit. I wonder why such a feature is missing. The HTML report basically being an XML transformation from the surefire report, it should not be super complicated to implement.

---

Affects: 3.2.2

Attachments:

• image-2023-12-02-11-16-11-109.png (23.13 kB)

Remote Links:

• GitHub Pull Request #692
  

[jira-importer]

Michael Osipov commented

Interesting...I am surprised that we don't do this by default. Can you provide refs for those reports on SO and Reddit?

[jira-importer]

Alexander Kriegisch commented

Michael Osipov: One example is this Reddit thread. Two years ago, Karl Heinz Marbaise replied to it, recommending to open an issue for it, which I just did. 😉

Other posts revolve around workarounds like using redirectTestOutputToFile, which retains the information, but does not embed it into the Surefire report. There also seems to be an option keepLongStdio in the Jenkins JUnit plugin to retain the output.

[jira-importer]

Michael Osipov commented

I see OK. Do you want to give it a try? I'd be happy to review it.

[jira-importer]

Alexander Kriegisch commented

Michael Osipov, that was not my plan, and HTML layout, CSS and such is not my strong suit. Probably the code review would take 7x longer than the implementation. Most reviews are not done in a collaborative approach but by someone telling me what they don't like and urging me to do something they could have done much more quickly by themselves by just committing on top of the PR. I do not have time for this at the moment. Maybe if you offer a pair programming session with live destop sharing and audio connection. If it was something algorithmic only without any GUI or shiny output and a certain probability for a smooth review, maybe. But I can test, if someone contributes the feature.

I am surprised that we don't do this by default.

That was my thought exactly. Why is such a basic feature not present after all these years, especially given the fact that the necessary information is in the XML report already?

[jira-importer]

Michael Osipov commented

Well, you don't need any HTML/CSS skills, all is done in Java in the Sink. What you could do is to make sure that the data is available to the SurefireReportRenderer, from there I could takeover. You do the backend, I'll do the frontend. The data is in the XML file, but not read out. WDYT?

[jira-importer]

Alexander Kriegisch commented

Michael Osipov, done, please refer to the PR. There are still many to-dos, sorry. But my time budget for this was 90 minutes, and I have used them all up. I saw this code for the first time and hope I did it basically right.