Align implementation of getLegacyReportingName() for test templates with specification in TestDescriptor

[alitokmen]

Overview

As per https://junit.org/junit5/docs/5.0.1/api/org/junit/platform/engine/TestDescriptor.html#getLegacyReportingName-- the default getLegacyReportingName is expected to use getDisplayName.

Aligning the definition accordingly, the current implementation instead always forces a [0], [1], ... at the end.

---

I hereby agree to the terms of the JUnit Contributor License Agreement.

---

Definition of Done

• There are no TODOs left in the code
• Method preconditions are checked and documented in the method's Javadoc
• Coding conventions (e.g. for logging) have been followed
• Change is covered by automated tests including corner cases, errors, and exception handling
• Public API has Javadoc and @API annotations
• Change is documented in the User Guide and Release Notes

[sormuras]

The default implementation in TestDescriptor does as specified:

junit5/junit-platform-engine/src/main/java/org/junit/platform/engine/TestDescriptor.java

Lines 58 to 69 in 6d260da

	/**
	* Get the name of this descriptor in a format that is suitable for legacy
	* reporting infrastructure — for example, for reporting systems built
	* on the Ant-based XML reporting format for JUnit 4.
	*
	* <p>The default implementation delegates to {@link #getDisplayName()}.
	*
	* @return the legacy reporting name; never {@code null} or blank
	*/
	default String getLegacyReportingName() {
	return getDisplayName();
	}

The Jupiter implementation overrides this by always forcing "a [0], [1], ... at the end." Working as specified, right? Or is the wording misleading?

[alitokmen]

Thanks @sormuras the way I understood the specification was that it is expected to be overridable through getDisplayName.

Now that I see sooooo many failing tests, I have doubts whether to change the existing. I'm happy to drop it too.

[sbrannen]

Thanks @sormuras the way I understood the specification was that it is expected to be overridable through getDisplayName.

The specification states the following.

Get the name of this descriptor in a format that is suitable for legacy reporting infrastructure — for example, for reporting systems built on the Ant-based XML reporting format for JUnit 4.

The default implementation simply delegates to getDisplayName().

That last sentence merely states how the interface default method is implemented.

It does not state that other implementations must delegate to getDisplayName().

Thus, other implementations are free to implement getLegacyReportingName() as they see fit.

Now that I see sooooo many failing tests, I have doubts whether to change the existing. I'm happy to drop it too.

OK. I'm closing this PR.