Relax explicit TestContextBootstrapper resolution [SPR-17006]

[spring-projects-issues]

Sam Brannen opened SPR-17006 and commented

Status Quo

The resolution process for explicit TestContextBootstrapper registration via @BootstrapWith currently throws an IllegalStateException if more than one declaration of @BootstrapWith is detected.

As mentioned in Moduliths Issue #5, the resolution can be relaxed by checking the concrete types registered via @BootstrapWith.

Proposals

1. If multiple @BootstrapWith declarations are detected but each register the exact same type of boostrapper, no exception should occur.
2. If multiple @BootstrapWith declarations are detected and all types registered exist within the same class hierarchy, no exception should occur, and the most specific type should be used.
3. Otherwise, throw an IllegalStateException.
4. If @BootstrapWith is declared locally, directly on a test class, that declaration should override any such declarations that are meta-present.

Deliverables

1. Proposal Spring core JMS pom.xml #1 already works.
2. Consider implementing proposal Improve annotation processing thread-safety #2.
3. Implement proposal SPR-7752 - EntityManager proxy now exposes provider specific interface. #4 (directly present annotation overrides meta-present annotations).
4. Ensure that an exception is still thrown otherwise.

---

Affects: 4.3.10

Reference URL: moduliths/moduliths#5

Issue Links:

• Explicit failure if multiple @BootstrapWith annotations are used on the same test [SPR-12602] #17203 Explicit failure if multiple @BootstrapWith annotations are used on the same test

[spring-projects-issues]

Sam Brannen commented

Regarding proposal #1, that appears to already be the case.

 
See comments here.

[spring-projects-issues]

Sam Brannen commented

This is related to #17203.

[spring-projects-issues]

Sam Brannen commented

FYI: I added a "directly present annotation overrides meta-present annotations" deliverable based on discussions in Moduliths Issue #5.

[spring-projects-issues]

Sam Brannen commented

This has been addressed in commit d20d95b as follows:

Allow directly present @BootstrapWith to override meta annotations

Prior to this commit, if a test class was meta-annotated with multiple @BootstrapWith declarations that registered different TestContextBootstrapper implementations, such a configuration would result in an IllegalStateException, and there was no way to override this behavior.

This commit addresses this shortcoming by relaxing the explicit TestContextBootstrapper resolution in BootstrapUtils so that a directly present @BootstrapWith annotation will now override declarations of @BootstrapWith that are meta-present. In other words, if @BootstrapWith is used as a meta-annotation, it can be overridden directly on the test class via an explicit, local declaration of @BootstrapWith.

[spring-projects-issues]

Sam Brannen commented

Oliver Drotbohm, I figured you'd like to know this has been addressed for Spring 5.1.

[spring-projects-issues]

Oliver Drotbohm commented

Thanks for the heads up, Sam Brannen. Looks useful to me :).

[spring-projects-issues]

Sam Brannen commented

You're welcome, Oliver Drotbohm!

Phil Webb, you may also find this useful to know since you originally requested the previous behavior.