Inherit `@TestClassOrder` and `@TestMethodOrder` within `@Nested` hierarchies

[sbrannen]

Overview

While upgrading the Spring Framework test suite to use JUnit 5.13, I noticed a discovery issue warning that @Order annotations were declared on test methods within a @Nested test class without proper configuration of the OrderAnnotation MethodOrderer.

However, the enclosing class was annotated with @TestMethodOrder(OrderAnnotation.class).

Thus, it became apparent that @TestMethodOrder is currently not inherited for @Nested test classes.

For Spring, I simply redeclared @TestMethodOrder on the @Nested test class, and the warning went away.

Proposal

It would be very useful if @Nested test classes inherited a @TestMethodOrder configured on an enclosing class.

However, there would then be no way to "turn off" the inherited MethodOrderer. To address that, I propose that we also introduce a new, no-op Default MethodOrderer which effectively signals that the "default" MethodOrderer should be used.

@TestClassOrder should also be inherited by default within @Nested test class hierarchies, and a Default implementation of ClassOrderer will also be necessary.

MethodOrderingVisitor.orderContainedMethods() and ClassOrderingVisitor.createClassLevelOrderer() will need to be updated accordingly to take into account Default orderers.

Deliverables

• Inherit @TestMethodOrder to nested test classes
• Inherit @TestClassOrder to nested test classes
• Introduce MethodOrderer.Default that can be used to opt-out and use the default orderer specified via the junit.jupiter.testmethod.order.default configuration parameter (or none if the configuration parameter is not set)
• Introduce ClassOrderer.Default that can be used to opt-out and use the default orderer specified via the junit.jupiter.testclass.order.default configuration parameter (or none if the configuration parameter is not set)

[raccoonback]

@sbrannen @marcphilipp
Hello!
I’d like to work on this issue. Has there been a team-level decision on the proposal in the description—namely:

1. inherit @TestMethodOrder and @TestClassOrder into @Nested classes by default,
2. provide “Default” no-op orderers to opt out, and
3. update MethodOrderingVisitor.orderContainedMethods(...) and ClassOrderingVisitor.createClassLevelOrderer(...) accordingly?

If there are any additional guidelines or considerations I should keep in mind, I’d really appreciate your guidance.

[sbrannen]

Hi @raccoonback,

No, we have not yet had a chance to discuss this within the team, due to summer vacation.

Thus, please do not start work on a PR yet.

[raccoonback]

@sbrannen
Thank you for the confirmation! 😀
I would appreciate it if you could share the results after the team discussion~!