Introduce `@DisabledInAotMode` in the TestContext framework

[dsyer]

I guess technically @DisabledInNativeImage doesn't mean "disable AOT processing", but if the annotation is there, it's probably a sign that we don't expect AOT to work? So the stack traces (logged at WARN level) seem harsh, and hard to debug (there's no hint as to why it's there). Arguably it shouldn't even be a warning. To reproduce just add a @MockBean and @DisabledInNativeImage to a test and and try to run native tests. The test doesn't run but the exception is logged in the build.

Example from PetClinic:

2023-07-07T10:35:23.700+01:00  WARN 3778203 --- [           main] o.s.t.c.aot.TestContextAotGenerator      : Failed to generate AOT artifacts for test classes [org.springframework.samples.petclinic.vet.VetControllerTests]

org.springframework.test.context.aot.TestContextAotException: Failed to process test class [org.springframework.samples.petclinic.vet.VetControllerTests] for AOT
        at org.springframework.test.context.aot.TestContextAotGenerator.processAheadOfTime(TestContextAotGenerator.java:239) ~[spring-test-6.0.10.jar:6.0.10]
        at org.springframework.test.context.aot.TestContextAotGenerator.lambda$processAheadOfTime$4(TestContextAotGenerator.java:205) ~[spring-test-6.0.10.jar:6.0.10]
        at java.base/java.util.LinkedHashMap.forEach(LinkedHashMap.java:721) ~[na:na]
        at org.springframework.util.MultiValueMapAdapter.forEach(MultiValueMapAdapter.java:179) ~[spring-core-6.0.10.jar:6.0.10]
        at org.springframework.test.context.aot.TestContextAotGenerator.processAheadOfTime(TestContextAotGenerator.java:197) ~[spring-test-6.0.10.jar:6.0.10]
...

[sbrannen]

At one point I proposed introducing a Spring-specific @DisabledInAot annotation, but the team decided we likely did not need that feature.

If we were to introduce such a @DisabledInAot annotation (that is potentially meta-annotated with JUnit Jupiter's @DisabledInNativeImage) and then skip AOT processing for any test class annotated with @DisabledInAot, would that suit your needs?

p.s. @DisabledInAot could also disable any test class/method when the spring.aot.enabled property is set to true -- which would disable the tests when running in AOT mode on the JVM.

[dsyer]

@DisabledInAot would work I guess. I don't understand the comment about spring.aot.enabled - what would @DisabledInAot do if it wasn't going to disable the test?

[sbrannen]

@DisabledInAot would work I guess.

Glad to hear it.

I don't understand the comment about spring.aot.enabled - what would @DisabledInAot do if it wasn't going to disable the test?

Sorry for being vague. I meant that @DisabledInAot would serve two roles.

1. As a marker annotation to indicate that the annotated test class should not be processed for AOT optimizations -- thereby avoiding the build-time TestContextAotException you reported.
2. As a JUnit Jupiter ExecutionCondition that disables the annotated test class or method when AotDetector.useGeneratedArtifacts() (which checks the spring.aot.enabled property) evaluates to true.

Does that make sense now?

If so, I think we should go with that.

[sbrannen]

Naming is hard.

Perhaps @DisabledInAot is not the best name for the annotation, since you cannot really be "in AOT".

Maybe @DisabledInAotMode is better.

The long-winded alternative is @DisabledWhenUsingAotGeneratedArtifacts which is technically correct, but I doubt anyone would favor that annotation name.

Thoughts?