Skip to content

Commit 1fc446b

Browse files
sbrannensbrannen
committed
Provide AOT support for @⁠Nested classes in a @⁠ParameterizedClass
This commit adds AOT support for discovering @⁠Nested test classes within a @⁠ClassTemplate test class, which includes @⁠ParameterizedClass test classes. Closes gh-35744
1 parent 096303c commit 1fc446b

File tree

7 files changed

+329
-31
lines changed

7 files changed

+329
-31
lines changed

‎spring-test/src/main/java/org/springframework/test/context/aot/TestClassScanner.java‎

Lines changed: 54 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,12 @@
1717
package org.springframework.test.context.aot;
1818

1919
import java.lang.annotation.Annotation;
20+
import java.lang.reflect.Modifier;
2021
import java.nio.file.Files;
2122
import java.nio.file.Path;
2223
import java.util.Arrays;
2324
import java.util.Comparator;
25+
import java.util.HashSet;
2426
import java.util.Optional;
2527
import java.util.Set;
2628
import java.util.stream.Stream;
@@ -82,8 +84,10 @@
8284
class TestClassScanner {
8385

8486
// JUnit Jupiter
85-
private static final String EXTEND_WITH_ANNOTATION_NAME = "org.junit.jupiter.api.extension.ExtendWith";
8687
private static final String SPRING_EXTENSION_NAME = "org.springframework.test.context.junit.jupiter.SpringExtension";
88+
private static final String EXTEND_WITH_ANNOTATION_NAME = "org.junit.jupiter.api.extension.ExtendWith";
89+
private static final String CLASS_TEMPLATE_ANNOTATION_NAME = "org.junit.jupiter.api.ClassTemplate";
90+
private static final String NESTED_ANNOTATION_NAME = "org.junit.jupiter.api.Nested";
8791

8892
// JUnit 4
8993
private static final String RUN_WITH_ANNOTATION_NAME = "org.junit.runner.RunWith";
@@ -161,6 +165,7 @@ Stream<Class<?>> scan(String... packageNames) {
161165
.map(this::getJavaClass)
162166
.flatMap(Optional::stream)
163167
.filter(this::isSpringTestClass)
168+
.flatMap(this::expandJupiterClassTemplateIfNecessary)
164169
.distinct()
165170
.sorted(Comparator.comparing(Class::getName));
166171
}
@@ -184,6 +189,45 @@ private boolean isSpringTestClass(Class<?> clazz) {
184189
return isSpringTestClass;
185190
}
186191

192+
/**
193+
* Expand the supplied test class into a stream containing the supplied test
194+
* class. If the supplied class is a JUnit Jupiter {@code @ClassTemplate}
195+
* (such as a {@code @ParameterizedClass}), the returned stream will also
196+
* contain {@code @Nested} test classes associated with the supplied test
197+
* class.
198+
* @since 7.0
199+
*/
200+
private Stream<Class<?>> expandJupiterClassTemplateIfNecessary(Class<?> testClass) {
201+
if (isJupiterClassTemplate(testClass)) {
202+
Set<Class<?>> testClasses = new HashSet<>();
203+
collectNestedTestClasses(testClass, testClasses, new HashSet<>());
204+
testClasses.add(testClass);
205+
return testClasses.stream();
206+
}
207+
return Stream.of(testClass);
208+
}
209+
210+
/**
211+
* Collect all {@code @Nested} test classes declared in the superclass hierarchy
212+
* of the supplied test class as well as {@code @Nested} test classes declared
213+
* in the supplied test class itself, recursively.
214+
* @since 7.0
215+
*/
216+
private static void collectNestedTestClasses(Class<?> testClass, Set<Class<?>> testClasses, Set<Class<?>> visited) {
217+
if (visited.add(testClass)) {
218+
Class<?> superclass = testClass.getSuperclass();
219+
if (superclass != null && superclass != Object.class) {
220+
collectNestedTestClasses(superclass, testClasses, visited);
221+
}
222+
for (Class<?> nestedClass : testClass.getDeclaredClasses()) {
223+
if (isJupiterNestedClass(nestedClass)) {
224+
testClasses.add(nestedClass);
225+
collectNestedTestClasses(nestedClass, testClasses, visited);
226+
}
227+
}
228+
}
229+
}
230+
187231
private static boolean isJupiterSpringTestClass(Class<?> clazz) {
188232
return MergedAnnotations.search(TYPE_HIERARCHY)
189233
.withEnclosingClasses(ClassUtils::isInnerClass)
@@ -195,6 +239,15 @@ private static boolean isJupiterSpringTestClass(Class<?> clazz) {
195239
.anyMatch(SPRING_EXTENSION_NAME::equals);
196240
}
197241

242+
private static boolean isJupiterClassTemplate(Class<?> clazz) {
243+
return MergedAnnotations.from(clazz, TYPE_HIERARCHY).isPresent(CLASS_TEMPLATE_ANNOTATION_NAME);
244+
}
245+
246+
private static boolean isJupiterNestedClass(Class<?> clazz) {
247+
return (!Modifier.isAbstract(clazz.getModifiers()) && ClassUtils.isInnerClass(clazz) &&
248+
MergedAnnotations.from(clazz, TYPE_HIERARCHY).isPresent(NESTED_ANNOTATION_NAME));
249+
}
250+
198251
private static boolean isJUnit4SpringTestClass(Class<?> clazz) {
199252
MergedAnnotation<Annotation> mergedAnnotation =
200253
MergedAnnotations.from(clazz, INHERITED_ANNOTATIONS).get(RUN_WITH_ANNOTATION_NAME);

‎spring-test/src/test/java/org/springframework/test/context/aot/AbstractAotTests.java‎

Lines changed: 62 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -30,61 +30,95 @@
3030
abstract class AbstractAotTests {
3131

3232
static final String[] expectedSourceFilesForBasicSpringTests = {
33+
34+
// BasicSpringJupiterSharedConfigTests -- not generated b/c already generated for AbstractSpringJupiterParameterizedClassTests.InheritedNestedTests.
35+
// BasicSpringJupiterTests -- not generated b/c already generated for AbstractSpringJupiterParameterizedClassTests.InheritedNestedTests.
36+
// BasicSpringJupiterTests.NestedTests -- not generated b/c already generated for BasicSpringJupiterParameterizedClassTests.NestedTests.
37+
3338
// Global
3439
"org/springframework/test/context/aot/AotTestContextInitializers__Generated.java",
3540
"org/springframework/test/context/aot/AotTestAttributes__Generated.java",
36-
// BasicSpringJupiterImportedConfigTests
41+
42+
// AbstractSpringJupiterParameterizedClassTests.InheritedNestedTests
3743
"org/springframework/context/event/DefaultEventListenerFactory__TestContext001_BeanDefinitions.java",
3844
"org/springframework/context/event/EventListenerMethodProcessor__TestContext001_BeanDefinitions.java",
39-
"org/springframework/test/context/aot/samples/basic/BasicSpringJupiterImportedConfigTests__TestContext001_ApplicationContextInitializer.java",
40-
"org/springframework/test/context/aot/samples/basic/BasicSpringJupiterImportedConfigTests__TestContext001_BeanDefinitions.java",
41-
"org/springframework/test/context/aot/samples/basic/BasicSpringJupiterImportedConfigTests__TestContext001_BeanFactoryRegistrations.java",
45+
"org/springframework/test/context/aot/samples/basic/AbstractSpringJupiterParameterizedClassTests_InheritedNestedTests__TestContext001_ApplicationContextInitializer.java",
46+
"org/springframework/test/context/aot/samples/basic/AbstractSpringJupiterParameterizedClassTests_InheritedNestedTests__TestContext001_BeanFactoryRegistrations.java",
47+
"org/springframework/test/context/aot/samples/basic/AbstractSpringJupiterParameterizedClassTests_InheritedNestedTests__TestContext001_ManagementApplicationContextInitializer.java",
48+
"org/springframework/test/context/aot/samples/basic/AbstractSpringJupiterParameterizedClassTests_InheritedNestedTests__TestContext001_ManagementBeanFactoryRegistrations.java",
4249
"org/springframework/test/context/aot/samples/basic/BasicTestConfiguration__TestContext001_BeanDefinitions.java",
50+
"org/springframework/test/context/aot/samples/management/ManagementConfiguration__TestContext001_BeanDefinitions.java",
51+
"org/springframework/test/context/aot/samples/management/ManagementMessageService__TestContext001_ManagementBeanDefinitions.java",
4352
"org/springframework/test/context/support/DynamicPropertyRegistrarBeanInitializer__TestContext001_BeanDefinitions.java",
44-
// BasicSpringJupiterSharedConfigTests
53+
54+
// AbstractSpringJupiterParameterizedClassTests.InheritedNestedTests.InheritedDoublyNestedTests
4555
"org/springframework/context/event/DefaultEventListenerFactory__TestContext002_BeanDefinitions.java",
4656
"org/springframework/context/event/EventListenerMethodProcessor__TestContext002_BeanDefinitions.java",
47-
"org/springframework/test/context/aot/samples/basic/BasicSpringJupiterSharedConfigTests__TestContext002_ApplicationContextInitializer.java",
48-
"org/springframework/test/context/aot/samples/basic/BasicSpringJupiterSharedConfigTests__TestContext002_BeanFactoryRegistrations.java",
49-
"org/springframework/test/context/aot/samples/basic/BasicSpringJupiterSharedConfigTests__TestContext002_ManagementApplicationContextInitializer.java",
50-
"org/springframework/test/context/aot/samples/basic/BasicSpringJupiterSharedConfigTests__TestContext002_ManagementBeanFactoryRegistrations.java",
57+
"org/springframework/test/context/aot/samples/basic/AbstractSpringJupiterParameterizedClassTests_InheritedNestedTests_InheritedDoublyNestedTests__TestContext002_ApplicationContextInitializer.java",
58+
"org/springframework/test/context/aot/samples/basic/AbstractSpringJupiterParameterizedClassTests_InheritedNestedTests_InheritedDoublyNestedTests__TestContext002_BeanFactoryRegistrations.java",
59+
"org/springframework/test/context/aot/samples/basic/AbstractSpringJupiterParameterizedClassTests_InheritedNestedTests_InheritedDoublyNestedTests__TestContext002_ManagementApplicationContextInitializer.java",
60+
"org/springframework/test/context/aot/samples/basic/AbstractSpringJupiterParameterizedClassTests_InheritedNestedTests_InheritedDoublyNestedTests__TestContext002_ManagementBeanFactoryRegistrations.java",
5161
"org/springframework/test/context/aot/samples/basic/BasicTestConfiguration__TestContext002_BeanDefinitions.java",
5262
"org/springframework/test/context/aot/samples/management/ManagementConfiguration__TestContext002_BeanDefinitions.java",
5363
"org/springframework/test/context/aot/samples/management/ManagementMessageService__TestContext002_ManagementBeanDefinitions.java",
5464
"org/springframework/test/context/support/DynamicPropertyRegistrarBeanInitializer__TestContext002_BeanDefinitions.java",
55-
// BasicSpringJupiterTests -- not generated b/c already generated for BasicSpringJupiterSharedConfigTests.
56-
// BasicSpringJupiterTests.NestedTests
65+
66+
// BasicSpringJupiterImportedConfigTests
5767
"org/springframework/context/event/DefaultEventListenerFactory__TestContext003_BeanDefinitions.java",
5868
"org/springframework/context/event/EventListenerMethodProcessor__TestContext003_BeanDefinitions.java",
59-
"org/springframework/test/context/aot/samples/basic/BasicSpringJupiterTests_NestedTests__TestContext003_ApplicationContextInitializer.java",
60-
"org/springframework/test/context/aot/samples/basic/BasicSpringJupiterTests_NestedTests__TestContext003_BeanFactoryRegistrations.java",
61-
"org/springframework/test/context/aot/samples/basic/BasicSpringJupiterTests_NestedTests__TestContext003_ManagementApplicationContextInitializer.java",
62-
"org/springframework/test/context/aot/samples/basic/BasicSpringJupiterTests_NestedTests__TestContext003_ManagementBeanFactoryRegistrations.java",
69+
"org/springframework/test/context/aot/samples/basic/BasicSpringJupiterImportedConfigTests__TestContext003_ApplicationContextInitializer.java",
70+
"org/springframework/test/context/aot/samples/basic/BasicSpringJupiterImportedConfigTests__TestContext003_BeanDefinitions.java",
71+
"org/springframework/test/context/aot/samples/basic/BasicSpringJupiterImportedConfigTests__TestContext003_BeanFactoryRegistrations.java",
6372
"org/springframework/test/context/aot/samples/basic/BasicTestConfiguration__TestContext003_BeanDefinitions.java",
64-
"org/springframework/test/context/aot/samples/management/ManagementConfiguration__TestContext003_BeanDefinitions.java",
65-
"org/springframework/test/context/aot/samples/management/ManagementMessageService__TestContext003_ManagementBeanDefinitions.java",
6673
"org/springframework/test/context/support/DynamicPropertyRegistrarBeanInitializer__TestContext003_BeanDefinitions.java",
67-
// BasicSpringTestNGTests
74+
75+
// BasicSpringJupiterParameterizedClassTests.NestedTests
6876
"org/springframework/context/event/DefaultEventListenerFactory__TestContext004_BeanDefinitions.java",
6977
"org/springframework/context/event/EventListenerMethodProcessor__TestContext004_BeanDefinitions.java",
70-
"org/springframework/test/context/aot/samples/basic/BasicSpringTestNGTests__TestContext004_ApplicationContextInitializer.java",
71-
"org/springframework/test/context/aot/samples/basic/BasicSpringTestNGTests__TestContext004_BeanFactoryRegistrations.java",
78+
"org/springframework/test/context/aot/samples/basic/BasicSpringJupiterParameterizedClassTests_NestedTests__TestContext004_ApplicationContextInitializer.java",
79+
"org/springframework/test/context/aot/samples/basic/BasicSpringJupiterParameterizedClassTests_NestedTests__TestContext004_BeanFactoryRegistrations.java",
80+
"org/springframework/test/context/aot/samples/basic/BasicSpringJupiterParameterizedClassTests_NestedTests__TestContext004_ManagementApplicationContextInitializer.java",
81+
"org/springframework/test/context/aot/samples/basic/BasicSpringJupiterParameterizedClassTests_NestedTests__TestContext004_ManagementBeanFactoryRegistrations.java",
7282
"org/springframework/test/context/aot/samples/basic/BasicTestConfiguration__TestContext004_BeanDefinitions.java",
83+
"org/springframework/test/context/aot/samples/management/ManagementConfiguration__TestContext004_BeanDefinitions.java",
84+
"org/springframework/test/context/aot/samples/management/ManagementMessageService__TestContext004_ManagementBeanDefinitions.java",
7385
"org/springframework/test/context/support/DynamicPropertyRegistrarBeanInitializer__TestContext004_BeanDefinitions.java",
74-
// BasicSpringVintageTests
86+
87+
// BasicSpringJupiterParameterizedClassTests.NestedTests.DoublyNestedTests
7588
"org/springframework/context/event/DefaultEventListenerFactory__TestContext005_BeanDefinitions.java",
7689
"org/springframework/context/event/EventListenerMethodProcessor__TestContext005_BeanDefinitions.java",
77-
"org/springframework/test/context/aot/samples/basic/BasicSpringVintageTests__TestContext005_ApplicationContextInitializer.java",
78-
"org/springframework/test/context/aot/samples/basic/BasicSpringVintageTests__TestContext005_BeanFactoryRegistrations.java",
90+
"org/springframework/test/context/aot/samples/basic/BasicSpringJupiterParameterizedClassTests_NestedTests_DoublyNestedTests__TestContext005_ApplicationContextInitializer.java",
91+
"org/springframework/test/context/aot/samples/basic/BasicSpringJupiterParameterizedClassTests_NestedTests_DoublyNestedTests__TestContext005_BeanFactoryRegistrations.java",
92+
"org/springframework/test/context/aot/samples/basic/BasicSpringJupiterParameterizedClassTests_NestedTests_DoublyNestedTests__TestContext005_ManagementApplicationContextInitializer.java",
93+
"org/springframework/test/context/aot/samples/basic/BasicSpringJupiterParameterizedClassTests_NestedTests_DoublyNestedTests__TestContext005_ManagementBeanFactoryRegistrations.java",
7994
"org/springframework/test/context/aot/samples/basic/BasicTestConfiguration__TestContext005_BeanDefinitions.java",
95+
"org/springframework/test/context/aot/samples/management/ManagementConfiguration__TestContext005_BeanDefinitions.java",
96+
"org/springframework/test/context/aot/samples/management/ManagementMessageService__TestContext005_ManagementBeanDefinitions.java",
8097
"org/springframework/test/context/support/DynamicPropertyRegistrarBeanInitializer__TestContext005_BeanDefinitions.java",
81-
// DisabledInAotRuntimeMethodLevelTests
98+
99+
// BasicSpringTestNGTests
82100
"org/springframework/context/event/DefaultEventListenerFactory__TestContext006_BeanDefinitions.java",
83101
"org/springframework/context/event/EventListenerMethodProcessor__TestContext006_BeanDefinitions.java",
84-
"org/springframework/test/context/aot/samples/basic/DisabledInAotRuntimeMethodLevelTests__TestContext006_ApplicationContextInitializer.java",
85-
"org/springframework/test/context/aot/samples/basic/DisabledInAotRuntimeMethodLevelTests__TestContext006_BeanDefinitions.java",
86-
"org/springframework/test/context/aot/samples/basic/DisabledInAotRuntimeMethodLevelTests__TestContext006_BeanFactoryRegistrations.java",
87-
"org/springframework/test/context/support/DynamicPropertyRegistrarBeanInitializer__TestContext006_BeanDefinitions.java"
102+
"org/springframework/test/context/aot/samples/basic/BasicSpringTestNGTests__TestContext006_ApplicationContextInitializer.java",
103+
"org/springframework/test/context/aot/samples/basic/BasicSpringTestNGTests__TestContext006_BeanFactoryRegistrations.java",
104+
"org/springframework/test/context/aot/samples/basic/BasicTestConfiguration__TestContext006_BeanDefinitions.java",
105+
"org/springframework/test/context/support/DynamicPropertyRegistrarBeanInitializer__TestContext006_BeanDefinitions.java",
106+
107+
// BasicSpringVintageTests
108+
"org/springframework/context/event/DefaultEventListenerFactory__TestContext007_BeanDefinitions.java",
109+
"org/springframework/context/event/EventListenerMethodProcessor__TestContext007_BeanDefinitions.java",
110+
"org/springframework/test/context/aot/samples/basic/BasicSpringVintageTests__TestContext007_ApplicationContextInitializer.java",
111+
"org/springframework/test/context/aot/samples/basic/BasicSpringVintageTests__TestContext007_BeanFactoryRegistrations.java",
112+
"org/springframework/test/context/aot/samples/basic/BasicTestConfiguration__TestContext007_BeanDefinitions.java",
113+
"org/springframework/test/context/support/DynamicPropertyRegistrarBeanInitializer__TestContext007_BeanDefinitions.java",
114+
115+
// DisabledInAotRuntimeMethodLevelTests
116+
"org/springframework/context/event/DefaultEventListenerFactory__TestContext008_BeanDefinitions.java",
117+
"org/springframework/context/event/EventListenerMethodProcessor__TestContext008_BeanDefinitions.java",
118+
"org/springframework/test/context/aot/samples/basic/DisabledInAotRuntimeMethodLevelTests__TestContext008_ApplicationContextInitializer.java",
119+
"org/springframework/test/context/aot/samples/basic/DisabledInAotRuntimeMethodLevelTests__TestContext008_BeanDefinitions.java",
120+
"org/springframework/test/context/aot/samples/basic/DisabledInAotRuntimeMethodLevelTests__TestContext008_BeanFactoryRegistrations.java",
121+
"org/springframework/test/context/support/DynamicPropertyRegistrarBeanInitializer__TestContext008_BeanDefinitions.java"
88122
};
89123

90124
Stream<Class<?>> scan() {

‎spring-test/src/test/java/org/springframework/test/context/aot/AotIntegrationTests.java‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@
4646
import org.springframework.core.test.tools.CompileWithForkedClassLoader;
4747
import org.springframework.core.test.tools.TestCompiler;
4848
import org.springframework.test.context.aot.samples.basic.BasicSpringJupiterImportedConfigTests;
49+
import org.springframework.test.context.aot.samples.basic.BasicSpringJupiterParameterizedClassTests;
4950
import org.springframework.test.context.aot.samples.basic.BasicSpringJupiterSharedConfigTests;
5051
import org.springframework.test.context.aot.samples.basic.BasicSpringJupiterTests;
5152
import org.springframework.test.context.aot.samples.basic.BasicSpringTestNGTests;
@@ -116,11 +117,12 @@ void endToEndTests() {
116117
// .printFiles(System.out)
117118
.compile(compiled ->
118119
// AOT RUN-TIME: EXECUTION
119-
runTestsInAotMode(7, List.of(
120+
runTestsInAotMode(17, List.of(
120121
// The #s represent how many tests should run from each test class, which
121122
// must add up to the expectedNumTests above.
122123
/* 1 */ BasicSpringJupiterSharedConfigTests.class,
123124
/* 2 */ BasicSpringJupiterTests.class, // NestedTests get executed automatically
125+
/* 2 * 5 */ BasicSpringJupiterParameterizedClassTests.class, // NestedTests get executed automatically
124126
// Run @Import tests AFTER the tests with otherwise identical config
125127
// in order to ensure that the other test classes are not accidentally
126128
// using the config for the @Import tests.
@@ -147,6 +149,9 @@ void endToEndTestsForEntireSpringTestModule() {
147149
.filter(clazz -> clazz.getSimpleName().endsWith("Tests"))
148150
// TestNG EJB tests use @PersistenceContext which is not yet supported in tests in AOT mode.
149151
.filter(clazz -> !clazz.getPackageName().contains("testng.transaction.ejb"))
152+
// AOT processing works for ParameterizedDependencyInjectionTests by itself
153+
// but fails for an unknown reason within the entire spring-test module.
154+
.filter(clazz -> !clazz.getName().equals("org.springframework.test.context.junit4.ParameterizedDependencyInjectionTests"))
150155
.toList();
151156

152157
// Optionally set failOnError flag to true to halt processing at the first failure.

‎spring-test/src/test/java/org/springframework/test/context/aot/TestAotProcessorTests.java‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
import org.junit.jupiter.api.io.TempDir;
3131

3232
import org.springframework.test.context.aot.samples.basic.BasicSpringJupiterImportedConfigTests;
33+
import org.springframework.test.context.aot.samples.basic.BasicSpringJupiterParameterizedClassTests;
3334
import org.springframework.test.context.aot.samples.basic.BasicSpringJupiterSharedConfigTests;
3435
import org.springframework.test.context.aot.samples.basic.BasicSpringJupiterTests;
3536
import org.springframework.test.context.aot.samples.basic.BasicSpringTestNGTests;
@@ -55,9 +56,9 @@ void process(@TempDir(cleanup = CleanupMode.ON_SUCCESS) Path tempDir) throws Exc
5556
Path classpathRoot = Files.createDirectories(tempDir.resolve("build/classes"));
5657
Stream.of(
5758
BasicSpringJupiterImportedConfigTests.class,
59+
BasicSpringJupiterParameterizedClassTests.class,
5860
BasicSpringJupiterSharedConfigTests.class,
5961
BasicSpringJupiterTests.class,
60-
BasicSpringJupiterTests.NestedTests.class,
6162
BasicSpringTestNGTests.class,
6263
BasicSpringVintageTests.class,
6364
DisabledInAotProcessingTests.class,

0 commit comments

Comments
 (0)