Revise support for JSR-330 and Jakarta @Inject for autowiring test constructors

Closes gh-29851

framework-docs/modules/ROOT/pages/testing/annotations/integration-junit-jupiter.adoc

@@ -170,8 +170,9 @@ of a test class constructor are autowired from components in the test's
 
 If `@TestConstructor` is not present or meta-present on a test class, the default _test
 constructor autowire mode_ will be used. See the tip below for details on how to change
-the default mode. Note, however, that a local declaration of `@Autowired` on a
-constructor takes precedence over both `@TestConstructor` and the default mode.
+the default mode. Note, however, that a local declaration of `@Autowired`,
+`@jakarta.inject.Inject`, or `@javax.inject.Inject` on a constructor takes precedence
+over both `@TestConstructor` and the default mode.
 
 .Changing the default test constructor autowire mode
 [TIP]

spring-test/spring-test.gradle

@@ -27,6 +27,7 @@ dependencies {
 	optional("jakarta.websocket:jakarta.websocket-api")
 	optional("jakarta.websocket:jakarta.websocket-client-api")
 	optional("jakarta.xml.bind:jakarta.xml.bind-api")
+	optional("javax.inject:javax.inject")
 	optional("junit:junit")
 	optional("net.sourceforge.htmlunit:htmlunit") {
 		exclude group: "commons-logging", module: "commons-logging"
@@ -70,7 +71,6 @@ dependencies {
 	testImplementation("jakarta.mail:jakarta.mail-api")
 	testImplementation("jakarta.validation:jakarta.validation-api")
 	testImplementation("javax.cache:cache-api")
-	testImplementation("javax.inject:javax.inject:1")
 	testImplementation("org.apache.httpcomponents:httpclient") {
 		exclude group: "commons-logging", module: "commons-logging"
 	}

spring-test/src/main/java/org/springframework/test/context/TestConstructor.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2020 the original author or authors.
+ * Copyright 2002-2023 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -38,9 +38,10 @@ import org.springframework.lang.Nullable;
  * on a test class, the default <em>test constructor autowire mode</em> will be
  * used. See {@link #TEST_CONSTRUCTOR_AUTOWIRE_MODE_PROPERTY_NAME} for details on
  * how to change the default mode. Note, however, that a local declaration of
- * {@link org.springframework.beans.factory.annotation.Autowired @Autowired} on
- * a constructor takes precedence over both {@code @TestConstructor} and the default
- * mode.
+ * {@link org.springframework.beans.factory.annotation.Autowired @Autowired}
+ * {@link jakarta.inject.Inject @jakarta.inject.Inject}, or
+ * {@link javax.inject.Inject @javax.inject.Inject} on a constructor takes
+ * precedence over both {@code @TestConstructor} and the default mode.
  *
  * <p>This annotation may be used as a <em>meta-annotation</em> to create custom
  * <em>composed annotations</em>.
@@ -60,6 +61,8 @@ import org.springframework.lang.Nullable;
  * @author Sam Brannen
  * @since 5.2
  * @see org.springframework.beans.factory.annotation.Autowired @Autowired
+ * @see jakarta.inject.Inject @jakarta.inject.Inject
+ * @see javax.inject.Inject @javax.inject.Inject
  * @see org.springframework.test.context.junit.jupiter.SpringExtension SpringExtension
  * @see org.springframework.test.context.junit.jupiter.SpringJUnitConfig @SpringJUnitConfig
  * @see org.springframework.test.context.junit.jupiter.web.SpringJUnitWebConfig @SpringJUnitWebConfig
@@ -104,6 +107,8 @@ public @interface TestConstructor {
 	 * @return an {@link AutowireMode} to take precedence over the global default
 	 * @see #TEST_CONSTRUCTOR_AUTOWIRE_MODE_PROPERTY_NAME
 	 * @see org.springframework.beans.factory.annotation.Autowired @Autowired
+	 * @see jakarta.inject.Inject @jakarta.inject.Inject
+	 * @see javax.inject.Inject @javax.inject.Inject
 	 * @see AutowireMode#ALL
 	 * @see AutowireMode#ANNOTATED
 	 */
@@ -120,7 +125,9 @@ public @interface TestConstructor {
 		/**
 		 * All test constructor parameters will be autowired as if the constructor
 		 * itself were annotated with
-		 * {@link org.springframework.beans.factory.annotation.Autowired @Autowired}.
+		 * {@link org.springframework.beans.factory.annotation.Autowired @Autowired},
+		 * {@link jakarta.inject.Inject @jakarta.inject.Inject}, or
+		 * {@link javax.inject.Inject @javax.inject.Inject}.
 		 * @see #ANNOTATED
 		 */
 		ALL,
@@ -131,7 +138,10 @@ public @interface TestConstructor {
 		 * {@link org.springframework.beans.factory.annotation.Autowired @Autowired},
 		 * {@link org.springframework.beans.factory.annotation.Qualifier @Qualifier},
 		 * or {@link org.springframework.beans.factory.annotation.Value @Value},
-		 * or if the constructor itself is annotated with {@code @Autowired}.
+		 * or if the constructor itself is annotated with
+		 * {@link org.springframework.beans.factory.annotation.Autowired @Autowired},
+		 * {@link jakarta.inject.Inject @jakarta.inject.Inject}, or
+		 * {@link javax.inject.Inject @javax.inject.Inject}.
 		 * @see #ALL
 		 */
 		ANNOTATED;

spring-test/src/main/java/org/springframework/test/context/support/TestConstructorUtils.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2022 the original author or authors.
+ * Copyright 2002-2023 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -22,6 +22,9 @@ import java.lang.reflect.Executable;
 import java.util.LinkedHashSet;
 import java.util.Set;
 
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.core.SpringProperties;
 import org.springframework.core.annotation.AnnotatedElementUtils;
@@ -41,8 +44,37 @@ import org.springframework.util.ClassUtils;
  * @since 5.2
  * @see TestConstructor
  */
+@SuppressWarnings("unchecked")
 public abstract class TestConstructorUtils {
 
+	private static final Log logger = LogFactory.getLog(TestConstructorUtils.class);
+
+	private static final Set<Class<? extends Annotation>> autowiredAnnotationTypes = new LinkedHashSet<>(2);
+
+	static {
+		autowiredAnnotationTypes.add(Autowired.class);
+
+		ClassLoader classLoader = TestConstructorUtils.class.getClassLoader();
+		try {
+			autowiredAnnotationTypes.add((Class<? extends Annotation>)
+					ClassUtils.forName("jakarta.inject.Inject", classLoader));
+			logger.trace("'jakarta.inject.Inject' annotation found and supported for autowiring");
+		}
+		catch (ClassNotFoundException ex) {
+			// jakarta.inject API not available - simply skip.
+		}
+
+		try {
+			autowiredAnnotationTypes.add((Class<? extends Annotation>)
+					ClassUtils.forName("javax.inject.Inject", classLoader));
+			logger.trace("'javax.inject.Inject' annotation found and supported for autowiring");
+		}
+		catch (ClassNotFoundException ex) {
+			// javax.inject API not available - simply skip.
+		}
+	}
+
+
 	private TestConstructorUtils() {
 	}
 
@@ -103,8 +135,9 @@ public abstract class TestConstructorUtils {
 	 * conditions is {@code true}.
 	 *
 	 * <ol>
-	 * <li>The constructor is annotated with {@link Autowired @Autowired}.</li>
-	 * <li>The constructor is annotated with {@link jakarta.inject.Inject} or {@code javax.inject.Inject}.</li>
+	 * <li>The constructor is annotated with {@link Autowired @Autowired},
+	 * {@link jakarta.inject.Inject @jakarta.inject.Inject}, or
+	 * {@link javax.inject.Inject @javax.inject.Inject}.</li>
 	 * <li>{@link TestConstructor @TestConstructor} is <em>present</em> or
 	 * <em>meta-present</em> on the test class with
 	 * {@link TestConstructor#autowireMode() autowireMode} set to
@@ -152,30 +185,9 @@ public abstract class TestConstructorUtils {
 		return (autowireMode == AutowireMode.ALL);
 	}
 
-	@SuppressWarnings("unchecked")
 	private static boolean isAnnotatedWithAutowiredOrInject(Constructor<?> constructor) {
-		Set<Class<? extends Annotation>> autowiredAnnotationTypes = new LinkedHashSet<>();
-
-		autowiredAnnotationTypes.add(Autowired.class);
-
-		try {
-			autowiredAnnotationTypes.add((Class<? extends Annotation>)
-					ClassUtils.forName("jakarta.inject.Inject", TestConstructorUtils.class.getClassLoader()));
-		}
-		catch (ClassNotFoundException ex) {
-			// jakarta.inject API not available - simply skip.
-		}
-
-		try {
-			autowiredAnnotationTypes.add((Class<? extends Annotation>)
-					ClassUtils.forName("javax.inject.Inject", TestConstructorUtils.class.getClassLoader()));
-		}
-		catch (ClassNotFoundException ex) {
-			// javax.inject API not available - simply skip.
-		}
-
 		return autowiredAnnotationTypes.stream()
-				.anyMatch(autowiredAnnotationType -> AnnotatedElementUtils.hasAnnotation(constructor, autowiredAnnotationType));
+				.anyMatch(annotationType -> AnnotatedElementUtils.hasAnnotation(constructor, annotationType));
 	}
 
 }

spring-test/src/test/java/org/springframework/test/context/junit/jupiter/InjectAnnotationIntegrationTests.java

@@ -1,56 +0,0 @@
-/*
- * Copyright 2002-2023 the original author or authors.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.test.context.junit.jupiter;
-
-import org.junit.jupiter.api.Test;
-
-import org.springframework.context.annotation.Bean;
-import org.springframework.context.annotation.Configuration;
-
-import static org.assertj.core.api.Assertions.assertThat;
-
-/**
- * Common test implementation for integration tests in order to verify support
- * for {@link jakarta.inject.Inject} and {@link javax.inject.Inject}.
- *
- * @author Florian Lehmann
- * @since 6.0.5
- */
-@SpringJUnitConfig
-public abstract class InjectAnnotationIntegrationTests {
-
-	private final String foo;
-
-	public InjectAnnotationIntegrationTests(String foo) {
-		this.foo = foo;
-	}
-
-	@Test
-	public void beanInjected() {
-		assertThat(this.foo).isEqualTo("foo");
-	}
-
-	@Configuration
-	static class Config {
-
-		@Bean
-		String foo() {
-			return "foo";
-		}
-
-	}
-}

spring-test/src/test/java/org/springframework/test/context/junit/jupiter/JakartaInjectAnnotationIntegrationTests.java

@@ -1,35 +0,0 @@
-/*
- * Copyright 2002-2023 the original author or authors.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.test.context.junit.jupiter;
-
-import jakarta.inject.Inject;
-
-/**
- * Integration tests which verify support for {@link jakarta.inject.Inject}.
- *
- * @author Florian Lehmann
- * @since 6.0.5
- */
-@SpringJUnitConfig
-public class JakartaInjectAnnotationIntegrationTests extends InjectAnnotationIntegrationTests {
-
-	@Inject
-	public JakartaInjectAnnotationIntegrationTests(String foo) {
-		super(foo);
-	}
-
-}

spring-test/src/test/java/org/springframework/test/context/junit/jupiter/JavaxInjectAnnotationIntegrationTests.java

@@ -1,35 +0,0 @@
-/*
- * Copyright 2002-2023 the original author or authors.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.test.context.junit.jupiter;
-
-import javax.inject.Inject;
-
-/**
- * Integration tests which verify support for {@link javax.inject.Inject}.
- *
- * @author Florian Lehmann
- * @since 6.0.5
- */
-@SpringJUnitConfig
-public class JavaxInjectAnnotationIntegrationTests extends InjectAnnotationIntegrationTests {
-
-	@Inject
-	public JavaxInjectAnnotationIntegrationTests(String foo) {
-		super(foo);
-	}
-
-}

spring-test/src/test/java/org/springframework/test/context/junit/jupiter/SpringJUnitJupiterAutowiredConstructorInjectionTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2022 the original author or authors.
+ * Copyright 2002-2023 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,6 +16,7 @@
 
 package org.springframework.test.context.junit.jupiter;
 
+import org.junit.jupiter.api.Nested;
 import org.junit.jupiter.api.Test;
 
 import org.springframework.beans.factory.annotation.Autowired;
@@ -28,28 +29,55 @@ import org.springframework.test.context.junit.jupiter.comics.Person;
 import static org.assertj.core.api.Assertions.assertThat;
 
 /**
- * Integration tests which demonstrate support for {@link Autowired @Autowired}
- * test class constructors with the Spring TestContext Framework and JUnit Jupiter.
+ * Integration tests which demonstrate support for <em>autowired</em> test class
+ * constructors with the Spring TestContext Framework and JUnit Jupiter.
  *
  * @author Sam Brannen
  * @since 5.0
  * @see SpringExtension
  * @see SpringJUnitJupiterConstructorInjectionTests
  */
-@SpringJUnitConfig(TestConfig.class)
-@TestPropertySource(properties = "enigma = 42")
 class SpringJUnitJupiterAutowiredConstructorInjectionTests {
 
-	final ApplicationContext applicationContext;
+	@Nested
+	class SpringAutowiredTests extends BaseClass {
+
+		@Autowired
+		SpringAutowiredTests(ApplicationContext context, Person dilbert, Dog dog, @Value("${enigma}") Integer enigma) {
+			super(context, dilbert, dog, enigma);
+		}
+	}
+
+	@Nested
+	class JakartaInjectTests extends BaseClass {
+
+		@jakarta.inject.Inject
+		JakartaInjectTests(ApplicationContext context, Person dilbert, Dog dog, @Value("${enigma}") Integer enigma) {
+			super(context, dilbert, dog, enigma);
+		}
+	}
+
+	@Nested
+	class JavaxInjectTests extends BaseClass {
+
+		@javax.inject.Inject
+		JavaxInjectTests(ApplicationContext context, Person dilbert, Dog dog, @Value("${enigma}") Integer enigma) {
+			super(context, dilbert, dog, enigma);
+		}
+	}
+
+
+	@SpringJUnitConfig(TestConfig.class)
+	@TestPropertySource(properties = "enigma = 42")
+	private static abstract class BaseClass {
+
+		final ApplicationContext context;
 		final Person dilbert;
 		final Dog dog;
 		final Integer enigma;
 
-	@Autowired
-	SpringJUnitJupiterAutowiredConstructorInjectionTests(ApplicationContext applicationContext, Person dilbert, Dog dog,
-			@Value("${enigma}") Integer enigma) {
-
-		this.applicationContext = applicationContext;
+		BaseClass(ApplicationContext context, Person dilbert, Dog dog, @Value("${enigma}") Integer enigma) {
+			this.context = context;
 			this.dilbert = dilbert;
 			this.dog = dog;
 			this.enigma = enigma;
@@ -57,23 +85,24 @@ class SpringJUnitJupiterAutowiredConstructorInjectionTests {
 
 		@Test
 		void applicationContextInjected() {
-		assertThat(applicationContext).as("ApplicationContext should have been injected by Spring").isNotNull();
-		assertThat(applicationContext.getBean("dilbert", Person.class)).isEqualTo(this.dilbert);
+			assertThat(context).as("ApplicationContext should have been injected").isNotNull();
+			assertThat(context.getBean("dilbert", Person.class)).isEqualTo(this.dilbert);
 		}
 
 		@Test
 		void beansInjected() {
-		assertThat(this.dilbert).as("Dilbert should have been @Autowired by Spring").isNotNull();
+			assertThat(this.dilbert).as("Dilbert should have been injected").isNotNull();
 			assertThat(this.dilbert.getName()).as("Person's name").isEqualTo("Dilbert");
 
-		assertThat(this.dog).as("Dogbert should have been @Autowired by Spring").isNotNull();
+			assertThat(this.dog).as("Dogbert should have been injected").isNotNull();
 			assertThat(this.dog.getName()).as("Dog's name").isEqualTo("Dogbert");
 		}
 
 		@Test
 		void propertyPlaceholderInjected() {
-		assertThat(this.enigma).as("Enigma should have been injected via @Value by Spring").isNotNull();
-		assertThat(this.enigma).as("enigma").isEqualTo(42);
+			assertThat(this.enigma).as("Enigma should have been injected via @Value").isEqualTo(42);
+		}
+
 	}
 
 }