Include class template invocation index in legacy reporting names

amilbourne · marcphilipp · amilbourne · commit adbff58b71c4 · 2026-04-20T18:43:11.000+01:00
This is a backport of commit b9756dd 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>
diff --git a/documentation/modules/ROOT/pages/release-notes.adoc b/documentation/modules/ROOT/pages/release-notes.adoc
@@ -9,6 +9,8 @@ Please refer to the xref:overview.adoc[User Guide] for comprehensive
 reference documentation for programmers writing tests, extension authors, and engine
 authors as well as build tool and IDE vendors.
 
+include::partial$release-notes/release-notes-5.14.4.adoc[]
+
 include::partial$release-notes/release-notes-5.14.3.adoc[]
 
 include::partial$release-notes/release-notes-5.14.2.adoc[]
diff --git a/documentation/modules/ROOT/partials/release-notes/release-notes-5.14.4.adoc b/documentation/modules/ROOT/partials/release-notes/release-notes-5.14.4.adoc
@@ -0,0 +1,32 @@
+[[v5.14.4]]
+== 5.14.4
+
+*Date of Release:* ❓
+
+*Scope:* Bug fix for legacy XML reporting of `@ClassTemplate`/`@ParameterizedClass` tests
+
+For a complete list of all _closed_ issues and pull requests for this release, consult the
+link:{junit-framework-repo}+/milestone/MILESTONE_NUMBER?closed=1+[5.14.4] milestone page in the JUnit
+repository on GitHub.
+
+
+[[v5.14.4-junit-platform]]
+=== JUnit Platform
+
+No changes.
+
+
+[[v5.14.4-junit-jupiter]]
+=== JUnit Jupiter
+
+[[v5.14.4-junit-jupiter-bug-fixes]]
+==== Bug Fixes
+
+* Include index of `@ClassTemplate`/`@ParameterizedClass` invocations in test names in
+  legacy XML reports to make them unique.
+
+
+[[v5.14.4-junit-vintage]]
+=== JUnit Vintage
+
+No changes.
diff --git a/junit-jupiter-engine/src/main/java/org/junit/jupiter/engine/descriptor/ClassBasedTestDescriptor.java b/junit-jupiter-engine/src/main/java/org/junit/jupiter/engine/descriptor/ClassBasedTestDescriptor.java
@@ -126,7 +126,7 @@ public final Type getType() {
 	}
 
 	@Override
-	public final String getLegacyReportingName() {
+	protected final String getLegacyReportingBaseName() {
 		return getTestClass().getName();
 	}
 
diff --git a/junit-jupiter-engine/src/main/java/org/junit/jupiter/engine/descriptor/ClassTemplateInvocationTestDescriptor.java b/junit-jupiter-engine/src/main/java/org/junit/jupiter/engine/descriptor/ClassTemplateInvocationTestDescriptor.java
@@ -18,6 +18,7 @@
 import static org.junit.jupiter.engine.support.JupiterThrowableCollectorFactory.createThrowableCollector;
 
 import java.util.List;
+import java.util.OptionalInt;
 import java.util.Set;
 import java.util.function.Function;
 import java.util.function.UnaryOperator;
@@ -80,8 +81,13 @@ public Type getType() {
 	}
 
 	@Override
-	public String getLegacyReportingName() {
-		return getTestClass().getName() + "[" + index + "]";
+	protected String getLegacyReportingBaseName() {
+		return getTestClass().getName();
+	}
+
+	@Override
+	protected OptionalInt getLegacyReportingIndex() {
+		return OptionalInt.of(index);
 	}
 
 	// --- TestClassAware ------------------------------------------------------
diff --git a/junit-jupiter-engine/src/main/java/org/junit/jupiter/engine/descriptor/DynamicNodeTestDescriptor.java b/junit-jupiter-engine/src/main/java/org/junit/jupiter/engine/descriptor/DynamicNodeTestDescriptor.java
@@ -10,6 +10,8 @@
 
 package org.junit.jupiter.engine.descriptor;
 
+import java.util.OptionalInt;
+
 import org.junit.jupiter.api.DynamicNode;
 import org.junit.jupiter.api.extension.ExtensionContext;
 import org.junit.jupiter.engine.config.JupiterConfiguration;
@@ -34,15 +36,24 @@ abstract class DynamicNodeTestDescriptor extends JupiterTestDescriptor {
 	}
 
 	@Override
-	public String getLegacyReportingName() {
+	protected final String getLegacyReportingBaseName() {
 		// @formatter:off
 		return getParent()
-				.map(TestDescriptor::getLegacyReportingName)
-				.orElseGet(this::getDisplayName)
-						+ "[" + index + "]";
+				.map(parent -> {
+					if (parent instanceof JupiterTestDescriptor) {
+						return ((JupiterTestDescriptor) parent).getLegacyReportingBaseName();
+					}
+					return parent.getLegacyReportingName();
+				})
+				.orElseGet(this::getDisplayName);
 		// @formatter:on
 	}
 
+	@Override
+	protected OptionalInt getLegacyReportingIndex() {
+		return OptionalInt.of(index);
+	}
+
 	@Override
 	public JupiterEngineExecutionContext prepare(JupiterEngineExecutionContext context) {
 		ExtensionContext extensionContext = new DynamicExtensionContext(context.getExtensionContext(),
diff --git a/junit-jupiter-engine/src/main/java/org/junit/jupiter/engine/descriptor/JupiterTestDescriptor.java b/junit-jupiter-engine/src/main/java/org/junit/jupiter/engine/descriptor/JupiterTestDescriptor.java
@@ -12,6 +12,7 @@
 
 import static java.util.Collections.emptySet;
 import static java.util.stream.Collectors.collectingAndThen;
+import static java.util.stream.Collectors.joining;
 import static java.util.stream.Collectors.toCollection;
 import static java.util.stream.Collectors.toSet;
 import static org.apiguardian.api.API.Status.INTERNAL;
@@ -24,11 +25,13 @@
 import java.util.LinkedHashSet;
 import java.util.List;
 import java.util.Optional;
+import java.util.OptionalInt;
 import java.util.Set;
 import java.util.concurrent.atomic.AtomicReference;
 import java.util.function.Consumer;
 import java.util.function.Supplier;
 import java.util.function.UnaryOperator;
+import java.util.stream.IntStream;
 
 import org.apiguardian.api.API;
 import org.junit.jupiter.api.Tag;
@@ -77,6 +80,35 @@ public abstract class JupiterTestDescriptor extends AbstractTestDescriptor
 
 	// --- TestDescriptor ------------------------------------------------------
 
+	@Override
+	public final String getLegacyReportingName() {
+		return getLegacyReportingBaseName()
+				+ getLegacyReportingIndexes().mapToObj(i -> "[" + i + "]").collect(joining());
+	}
+
+	protected String getLegacyReportingBaseName() {
+		return getDisplayName();
+	}
+
+	private IntStream getLegacyReportingIndexes() {
+		OptionalInt ownIndex = getLegacyReportingIndex();
+		return getParent() //
+				.map(it -> it instanceof JupiterTestDescriptor //
+						? ((JupiterTestDescriptor) it).getLegacyReportingIndexes() //
+						: null) //
+				.map(parentIndexes -> IntStream.concat(parentIndexes, asStream(ownIndex))) //
+				.orElse(asStream(ownIndex));
+	}
+
+	private IntStream asStream(final OptionalInt optInt) {
+		return optInt.isPresent() ? IntStream.of(optInt.getAsInt()) : IntStream.empty();
+
+	}
+
+	protected OptionalInt getLegacyReportingIndex() {
+		return OptionalInt.empty();
+	}
+
 	static Set<TestTag> getTags(AnnotatedElement element, Supplier<String> elementDescription,
 			Supplier<TestSource> sourceProvider, Consumer<DiscoveryIssue> issueCollector) {
 		AtomicReference<TestSource> source = new AtomicReference<>();
diff --git a/junit-jupiter-engine/src/main/java/org/junit/jupiter/engine/descriptor/MethodBasedTestDescriptor.java b/junit-jupiter-engine/src/main/java/org/junit/jupiter/engine/descriptor/MethodBasedTestDescriptor.java
@@ -87,7 +87,7 @@ public final Set<TestTag> getTags() {
 	}
 
 	@Override
-	public String getLegacyReportingName() {
+	protected final String getLegacyReportingBaseName() {
 		return String.format("%s(%s)", getTestMethod().getName(),
 			ClassUtils.nullSafeToString(Class::getSimpleName, getTestMethod().getParameterTypes()));
 	}
diff --git a/junit-jupiter-engine/src/main/java/org/junit/jupiter/engine/descriptor/TestTemplateInvocationTestDescriptor.java b/junit-jupiter-engine/src/main/java/org/junit/jupiter/engine/descriptor/TestTemplateInvocationTestDescriptor.java
@@ -14,6 +14,7 @@
 import static org.apiguardian.api.API.Status.INTERNAL;
 
 import java.lang.reflect.Method;
+import java.util.OptionalInt;
 import java.util.Set;
 import java.util.function.UnaryOperator;
 
@@ -70,8 +71,8 @@ public Set<ExclusiveResource> getExclusiveResources() {
 	}
 
 	@Override
-	public String getLegacyReportingName() {
-		return super.getLegacyReportingName() + "[" + index + "]";
+	protected OptionalInt getLegacyReportingIndex() {
+		return OptionalInt.of(index);
 	}
 
 	@Override
diff --git a/jupiter-tests/src/test/java/org/junit/jupiter/params/ParameterizedClassIntegrationTests.java b/jupiter-tests/src/test/java/org/junit/jupiter/params/ParameterizedClassIntegrationTests.java
@@ -37,6 +37,7 @@
 import static org.junit.platform.testkit.engine.EventConditions.event;
 import static org.junit.platform.testkit.engine.EventConditions.finishedSuccessfully;
 import static org.junit.platform.testkit.engine.EventConditions.finishedWithFailure;
+import static org.junit.platform.testkit.engine.EventConditions.legacyReportingName;
 import static org.junit.platform.testkit.engine.EventConditions.started;
 import static org.junit.platform.testkit.engine.EventConditions.test;
 import static org.junit.platform.testkit.engine.EventConditions.uniqueId;
@@ -106,6 +107,7 @@
 import org.junit.platform.engine.reporting.ReportEntry;
 import org.junit.platform.testkit.engine.EngineExecutionResults;
 import org.junit.platform.testkit.engine.Event;
+import org.junit.platform.testkit.engine.EventType;
 import org.junit.platform.testkit.engine.Events;
 
 @SuppressWarnings("JUnitMalformedDeclaration")
@@ -132,19 +134,19 @@ void injectsParametersIntoClass(Class<?> classTemplateClass) {
 			event(container("#1"), started()), //
 			event(dynamicTestRegistered("test1")), //
 			event(dynamicTestRegistered("test2")), //
-			event(test("test1"), started()), //
+			event(test("test1"), legacyReportingName("test1()[1]"), started()), //
 			event(test("test1"), finishedSuccessfully()), //
-			event(test("test2"), started()), //
+			event(test("test2"), legacyReportingName("test2()[1]"), started()), //
 			event(test("test2"), finishedSuccessfully()), //
 			event(container("#1"), finishedSuccessfully()), //
 
 			event(dynamicTestRegistered("#2"), displayName("[2] %s1".formatted(parameterNamePrefix))), //
 			event(container("#2"), started()), //
 			event(dynamicTestRegistered("test1")), //
 			event(dynamicTestRegistered("test2")), //
-			event(test("test1"), started()), //
+			event(test("test1"), legacyReportingName("test1()[2]"), started()), //
 			event(test("test1"), finishedWithFailure(message(it -> it.contains("negative")))), //
-			event(test("test2"), started()), //
+			event(test("test2"), legacyReportingName("test2()[2]"), started()), //
 			event(test("test2"), finishedWithFailure(message(it -> it.contains("negative")))), //
 			event(container("#2"), finishedSuccessfully()), //
 
@@ -461,6 +463,18 @@ void supportsNestedParameterizedClass(Class<?> classTemplateClass) {
 					"afterAll: %s".formatted(classTemplateClass.getSimpleName())
 					// @formatter:on
 			);
+			var legacyReportingNames = results.testEvents() //
+					.filter(it -> it.getType() == EventType.STARTED) //
+					.map(e -> e.getTestDescriptor().getLegacyReportingName());
+			assertThat(legacyReportingNames).containsExactly( //
+				"test(boolean, TestReporter)[1][1][1]", //
+				"test(boolean, TestReporter)[1][1][2]", //
+				"test(boolean, TestReporter)[1][2][1]", //
+				"test(boolean, TestReporter)[1][2][2]", //
+				"test(boolean, TestReporter)[2][1][1]", //
+				"test(boolean, TestReporter)[2][1][2]", //
+				"test(boolean, TestReporter)[2][2][1]", //
+				"test(boolean, TestReporter)[2][2][2]");
 		}
 
 		@ParameterizedTest
diff --git a/platform-tooling-support-tests/src/test/resources/platform/tooling/support/tests/AntStarterTests_snapshots/open-test-report.xml.snapshot b/platform-tooling-support-tests/src/test/resources/platform/tooling/support/tests/AntStarterTests_snapshots/open-test-report.xml.snapshot
diff --git a/platform-tooling-support-tests/src/test/resources/platform/tooling/support/tests/GradleStarterTests_snapshots/open-test-report.xml.snapshot b/platform-tooling-support-tests/src/test/resources/platform/tooling/support/tests/GradleStarterTests_snapshots/open-test-report.xml.snapshot
diff --git a/platform-tooling-support-tests/src/test/resources/platform/tooling/support/tests/MavenStarterTests_snapshots/open-test-report.xml.snapshot b/platform-tooling-support-tests/src/test/resources/platform/tooling/support/tests/MavenStarterTests_snapshots/open-test-report.xml.snapshot

Original file line number	Diff line number	Diff line change
`@@ -126,7 +126,7 @@ public final Type getType() {`
`126`	`126`	`}`
`127`	`127`
`128`	`128`	`@Override`
`129`		`- public final String getLegacyReportingName() {`
	`129`	`+ protected final String getLegacyReportingBaseName() {`
`130`	`130`	`return getTestClass().getName();`
`131`	`131`	`}`
`132`	`132`
Original file line number	Diff line number	Diff line change
`@@ -87,7 +87,7 @@ public final Set<TestTag> getTags() {`
`87`	`87`	`}`
`88`	`88`
`89`	`89`	`@Override`
`90`		`- public String getLegacyReportingName() {`
	`90`	`+ protected final String getLegacyReportingBaseName() {`
`91`	`91`	`return String.format("%s(%s)", getTestMethod().getName(),`
`92`	`92`	`ClassUtils.nullSafeToString(Class::getSimpleName, getTestMethod().getParameterTypes()));`
`93`	`93`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@`
`14`	`14`	`import static org.apiguardian.api.API.Status.INTERNAL;`
`15`	`15`
`16`	`16`	`import java.lang.reflect.Method;`
	`17`	`+import java.util.OptionalInt;`
`17`	`18`	`import java.util.Set;`
`18`	`19`	`import java.util.function.UnaryOperator;`
`19`	`20`
`@@ -70,8 +71,8 @@ public Set<ExclusiveResource> getExclusiveResources() {`
`70`	`71`	`}`
`71`	`72`
`72`	`73`	`@Override`
`73`		`- public String getLegacyReportingName() {`
`74`		`- return super.getLegacyReportingName() + "[" + index + "]";`
	`74`	`+ protected OptionalInt getLegacyReportingIndex() {`
	`75`	`+ return OptionalInt.of(index);`
`75`	`76`	`}`
`76`	`77`
`77`	`78`	`@Override`