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

[spring-projects-issues]

Phil Webb opened SPR-12602 and commented

BootstrapUtils.resolveTestContextBootstrapper currently finds the first @BootstrapWith annotation to create the bootstrapper. If the user has accidentally included more than one @BootstrapWith annotation (via meta-annotated annotations) it's seemingly arbitrary which is used.

It would be better to throw an explicit error.

---

Affects: 4.1 GA

Issue Links:

• Relax explicit TestContextBootstrapper resolution [SPR-17006] #21544 Relax explicit TestContextBootstrapper resolution
• Throw exception if multiple meta-annotations are found by AnnotationUtils [SPR-13015] #17606 Throw exception if multiple meta-annotations are found by AnnotationUtils

Referenced from: commits e85e976

[spring-projects-issues]

Phil Webb commented

See spring-projects/spring-boot#1956 (comment) for more background.

[spring-projects-issues]

Sam Brannen commented

Completed as described in GitHub commit e85e976:

Fail if multiple @BootstrapWith's are present

Prior to this commit it was possible for two @BootstrapWith annotations
to be 'present' on a test class -- for example, via competing custom
composed annotations. However, only one of the annotations will ever be
used to bootstrap the TestContext Framework. Thus, in such scenarios
one of the annotations will be silently ignored.

This commit introduces a check for such scenarios. BootstrapUtils'
resolveTestContextBootstrapper() method now throws an
IllegalStateException if more than one @BootstrapWith annotation is
'present' on a given test class.