Junit5: Make XML report generator available to the public

[cburgmer]

Overview

We have written our own test runner and would like to use the JUnit Platform's XmlReportsWritingListener to generate test result output. However the implementation is currently not in the public API.

Background:

We have created our own test runner, it seems for the following reasons.

• Setup of external dependencies
• Provide own TestExecutionListener

With this we replace which I assume would otherwise be provided by the ConsoleTestExecutor, which is the only point in JUnit which accesses the XmlReportsWritingListener.

Deliverables

• [x] Make XML report generation publicly available.

[sbrannen]

Tentatively slated for 5.3 for _team discussion_

[marcphilipp]

Team Decision: Polish (e.g. rename) and publish it as part of junit-platform-launcher.

[marcphilipp]

@cburgmer Is this issue still relevant to you?

[cburgmer]

As in "will be implemented and released eventually"? If so, feel free to close now. We are running our own version right now, but in the long run it might be nice to replace with upstream.

[sbrannen]

If so, feel free to close now.

Well, if we close this issue now, that means the task will no longer be in any backlog (which means it will not be done). 😉

On the other hand, if nobody in the community needs it urgently, the issue may potentially remain open but assigned to a later _milestone_.

[cburgmer]

Let's say, we can work with the solution we have now. I'll get out of your hair, so you can decide best what the priorities are for the next weeks :)

[r0e]

I would also like to make use of the XML Report generator

[sbrannen]

@r0e, can you tell us what your concrete use case is?

[sormuras]

Using this XML report generator is common use case when integrating the JUnit Platform in "build tools". By now, I could use them in both projects listed below:

• https://github.com/forax/pro
• https://github.com/sormuras/junit-platform-maven-plugin

Same goes for the TreePrintingListener, to a lesser extend.

[sormuras]

Team Decision: Polish (e.g. rename) and publish it as part of junit-platform-launcher.

Perhaps a dedicated junit-platform-reporter project is better place to collect commonly used report generating listeners? Would keep the junit-platform-launcher clear from those implementations.

[sbrannen]

Perhaps a dedicated junit-platform-reporter project is better place to collect commonly used report generating listeners?

Maybe, but we'd probably want to name it something like junit-platform-reporting or junit-platform-reports.

[marcphilipp]

+1 for junit-platform-reporting

[sormuras]

_in progress..._

[sormuras]

@cburgmer the junit-platform-reporting module is (soon) avaiable in the 1.4.0-SNAPSHOT builds. It'd be great, if you find the now public XmlReportsWritingListener useful. Feedback is very appreciated.

[marcphilipp]

Team Decision:

Add Legacy to differentiate from potential future XML format.

[sbrannen]

Closing this issue now that the "legacy" renaming and polishing have been pushed to master.