Include full display name in legacy XML reports (#5524)

Rather than just including the display name of the test, the display
names of all ancestors are now included as well, separated by the `>`
character. This includes display names of parents otherwise not
represented in the legacy XML format (for example, the invocation of a
`@ParameterizedClass`).

This is a backport of commit ee3a100

Changes were made to compile under Java 8

Co-authored-by: Marc Philipp <mail@marcphilipp.de>
Signed-off-by: Anthony Milbourne <18662115+amilbourne@users.noreply.github.com>

Author: amilbourne

documentation/modules/ROOT/partials/release-notes/release-notes-5.14.4.adoc

@@ -24,6 +24,8 @@ No changes.
 
 * Include index of `@ClassTemplate`/`@ParameterizedClass` invocations in test names in
   legacy XML reports to make them unique.
+* Legacy XML reports now include parent display names to make it easier to distinguish
+  between invocations for different parameters.
 
 
 [[v5.14.4-junit-vintage]]

junit-platform-reporting/src/main/java/org/junit/platform/reporting/legacy/xml/XmlReportWriter.java

@@ -37,6 +37,7 @@
 import java.net.UnknownHostException;
 import java.text.NumberFormat;
 import java.time.LocalDateTime;
+import java.util.ArrayDeque;
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.EnumSet;
@@ -116,7 +117,7 @@ private void writeXmlReport(TestIdentifier testIdentifier, Map<TestIdentifier, A
 			Writer out) throws XMLStreamException {
 
 		try (XmlReport report = new XmlReport(out)) {
-			report.write(testIdentifier, tests);
+			report.write(testIdentifier, tests, this.reportData.getTestPlan());
 		}
 	}
 
@@ -131,16 +132,16 @@ private class XmlReport implements AutoCloseable {
 			this.xml = factory.createXMLStreamWriter(this.out);
 		}
 
-		void write(TestIdentifier testIdentifier, Map<TestIdentifier, AggregatedTestResult> tests)
+		void write(TestIdentifier testIdentifier, Map<TestIdentifier, AggregatedTestResult> tests, TestPlan testPlan)
 				throws XMLStreamException {
 			xml.writeStartDocument("UTF-8", "1.0");
 			newLine();
-			writeTestsuite(testIdentifier, tests);
+			writeTestsuite(testIdentifier, tests, testPlan);
 			xml.writeEndDocument();
 		}
 
-		private void writeTestsuite(TestIdentifier testIdentifier, Map<TestIdentifier, AggregatedTestResult> tests)
-				throws XMLStreamException {
+		private void writeTestsuite(TestIdentifier testIdentifier, Map<TestIdentifier, AggregatedTestResult> tests,
+				TestPlan testPlan) throws XMLStreamException {
 
 			// NumberFormat is not thread-safe. Thus, we instantiate it here and pass it to
 			// writeTestcase instead of using a constant
@@ -154,10 +155,10 @@ private void writeTestsuite(TestIdentifier testIdentifier, Map<TestIdentifier, A
 			writeSystemProperties();
 
 			for (Entry<TestIdentifier, AggregatedTestResult> entry : tests.entrySet()) {
-				writeTestcase(entry.getKey(), entry.getValue(), numberFormat);
+				writeTestcase(entry.getKey(), entry.getValue(), numberFormat, testPlan);
 			}
 
-			writeOutputElement("system-out", formatNonStandardAttributesAsString(testIdentifier));
+			writeOutputElement("system-out", formatNonStandardAttributesAsString(testIdentifier, testPlan));
 
 			xml.writeEndElement();
 			newLine();
@@ -198,7 +199,7 @@ private void writeSystemProperties() throws XMLStreamException {
 		}
 
 		private void writeTestcase(TestIdentifier testIdentifier, AggregatedTestResult testResult,
-				NumberFormat numberFormat) throws XMLStreamException {
+				NumberFormat numberFormat, TestPlan testPlan) throws XMLStreamException {
 
 			xml.writeStartElement("testcase");
 
@@ -211,7 +212,7 @@ private void writeTestcase(TestIdentifier testIdentifier, AggregatedTestResult t
 
 			List<String> systemOutElements = new ArrayList<>();
 			List<String> systemErrElements = new ArrayList<>();
-			systemOutElements.add(formatNonStandardAttributesAsString(testIdentifier));
+			systemOutElements.add(formatNonStandardAttributesAsString(testIdentifier, testPlan));
 			collectReportEntries(testIdentifier, systemOutElements, systemErrElements);
 			writeOutputElements("system-out", systemOutElements);
 			writeOutputElements("system-err", systemErrElements);
@@ -334,9 +335,16 @@ private LocalDateTime getCurrentDateTime() {
 			return LocalDateTime.now(reportData.getClock()).withNano(0);
 		}
 
-		private String formatNonStandardAttributesAsString(TestIdentifier testIdentifier) {
+		private String formatNonStandardAttributesAsString(TestIdentifier testIdentifier, TestPlan testPlan) {
+			ArrayDeque<String> displayNames = new ArrayDeque<>();
+			TestIdentifier current = testIdentifier;
+			while (current != null) {
+				displayNames.push(current.getDisplayName());
+				current = testPlan.getParent(current).orElse(null);
+			}
+			String fullDisplayName = String.join(" > ", displayNames);
 			return "unique-id: " + testIdentifier.getUniqueId() //
-					+ "\ndisplay-name: " + testIdentifier.getDisplayName();
+					+ "\ndisplay-name: " + fullDisplayName;
 		}
 
 		private void writeOutputElements(String elementName, List<String> elements) throws XMLStreamException {

platform-tests/src/test/java/org/junit/platform/reporting/legacy/xml/LegacyXmlReportGeneratingListenerTests.java

@@ -90,7 +90,7 @@ void writesFileForSingleSucceedingTest() throws Exception {
 		assertThat(testcase.attr("classname")).isEqualTo("dummy");
 		assertThat(testcase.child("system-out").text()) //
 				.containsSubsequence("unique-id: [engine:dummy]/[test:succeedingTest]",
-					"display-name: display<-->Name 😎");
+					"display-name: dummy > display<-->Name 😎");
 
 		assertThat(testsuite.find("skipped")).isEmpty();
 		assertThat(testsuite.find("failure")).isEmpty();

platform-tests/src/test/java/org/junit/platform/reporting/legacy/xml/XmlReportWriterTests.java

@@ -91,9 +91,14 @@ void writesReportEntry() throws Exception {
 
 	@Test
 	void writesCapturedOutput() throws Exception {
-		var uniqueId = engineDescriptor.getUniqueId().append("test", "test");
-		var testDescriptor = new TestDescriptorStub(uniqueId, "successfulTest");
-		engineDescriptor.addChild(testDescriptor);
+		var classDescriptor = new TestDescriptorStub(engineDescriptor.getUniqueId().append("class", "SomeClass"),
+			"SomeClass");
+		engineDescriptor.addChild(classDescriptor);
+
+		var testDescriptor = new TestDescriptorStub(classDescriptor.getUniqueId().append("test", "successfulTest"),
+			"successfulTest");
+		classDescriptor.addChild(testDescriptor);
+
 		var testPlan = TestPlan.from(true, Set.of(engineDescriptor), configParams, dummyOutputDirectoryCreator());
 
 		var reportData = new XmlReportData(testPlan, Clock.systemDefaultZone());
@@ -103,13 +108,14 @@ void writesCapturedOutput() throws Exception {
 			"foo", "bar"));
 		reportData.addReportEntry(TestIdentifier.from(testDescriptor), reportEntry);
 		reportData.addReportEntry(TestIdentifier.from(testDescriptor), ReportEntry.from(Map.of("baz", "qux")));
-		reportData.markFinished(testPlan.getTestIdentifier(uniqueId), successful());
+		reportData.markFinished(testPlan.getTestIdentifier(testDescriptor.getUniqueId()), successful());
 
 		var testsuite = writeXmlReport(testPlan, reportData);
 
 		assertValidAccordingToJenkinsSchema(testsuite.document());
 		assertThat(testsuite.find("system-out").text(0)) //
-				.containsSubsequence("unique-id: ", "test:test", "display-name: successfulTest");
+				.containsSubsequence("unique-id: [engine:engine]/[class:SomeClass]/[test:successfulTest]",
+					"display-name: Engine > SomeClass > successfulTest");
 		assertThat(testsuite.find("system-out").text(1)) //
 				.containsSubsequence("Report Entry #1 (timestamp: ", "- foo: bar", "Report Entry #2 (timestamp: ",
 					"- baz: qux");