Deprecate @MockBean and @SpyBean

- Deprecate Deprecate @MockBean and @SpyBean in favor of Spring
  Framework 6.2's @MockitoBean and @MockitoSpy
- Migrate usages of @MockBean and @SpyBean to @MockitoBean and
  @MockitoSpy

Signed-off-by: Jakob Wanger <[email protected]>

See gh-39864

Author: wanger26

buildSrc/build.gradle

@@ -22,7 +22,7 @@ new File(projectDir.parentFile, "gradle.properties").withInputStream {
 	}
 }
 versions["jackson"] = "2.15.3"
-versions["springFramework"] = "6.0.12"
+versions["springFramework"] = "6.2.0-SNAPSHOT"
 ext.set("versions", versions)
 if (versions.springFramework.contains("-")) {
 	repositories {

spring-boot-project/spring-boot-actuator-autoconfigure/build.gradle

@@ -177,6 +177,7 @@ dependencies {
 	testImplementation("org.springframework.restdocs:spring-restdocs-webtestclient")
 	testImplementation("org.springframework.security:spring-security-test")
 	testImplementation("org.yaml:snakeyaml")
+	testImplementation("org.springframework:spring-test")
 
 	testRuntimeOnly("jakarta.management.j2ee:jakarta.management.j2ee-api")
 	testRuntimeOnly("jakarta.transaction:jakarta.transaction-api")

spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/documentation/AuditEventsEndpointDocumentationTests.java

@@ -26,10 +26,10 @@
 import org.springframework.boot.actuate.audit.AuditEvent;
 import org.springframework.boot.actuate.audit.AuditEventRepository;
 import org.springframework.boot.actuate.audit.AuditEventsEndpoint;
-import org.springframework.boot.test.mock.mockito.MockBean;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Import;
+import org.springframework.test.bean.override.mockito.MockitoBean;
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.mockito.ArgumentMatchers.any;
@@ -48,7 +48,7 @@
  */
 class AuditEventsEndpointDocumentationTests extends MockMvcEndpointDocumentationTests {
 
-	@MockBean
+	@MockitoBean
 	private AuditEventRepository repository;
 
 	@Test

spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/documentation/HttpExchangesEndpointDocumentationTests.java

@@ -41,6 +41,7 @@
 import org.springframework.context.annotation.Import;
 import org.springframework.http.HttpHeaders;
 import org.springframework.restdocs.payload.JsonFieldType;
+import org.springframework.test.bean.override.mockito.MockitoBean;
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.mockito.BDDMockito.given;
@@ -56,7 +57,7 @@
  */
 class HttpExchangesEndpointDocumentationTests extends MockMvcEndpointDocumentationTests {
 
-	@MockBean
+	@MockitoBean
 	private HttpExchangeRepository repository;
 
 	@Test

spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/documentation/LoggersEndpointDocumentationTests.java

@@ -38,6 +38,7 @@
 import org.springframework.restdocs.mockmvc.MockMvcRestDocumentation;
 import org.springframework.restdocs.payload.FieldDescriptor;
 import org.springframework.restdocs.payload.JsonFieldType;
+import org.springframework.test.bean.override.mockito.MockitoBean;
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.mockito.BDDMockito.given;
@@ -62,7 +63,7 @@ class LoggersEndpointDocumentationTests extends MockMvcEndpointDocumentationTest
 			.type(JsonFieldType.STRING)
 			.optional(), fieldWithPath("members").description("Loggers that are part of this group"));
 
-	@MockBean
+	@MockitoBean
 	private LoggingSystem loggingSystem;
 
 	@Autowired

spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/documentation/QuartzEndpointDocumentationTests.java

@@ -178,7 +178,7 @@ class QuartzEndpointDocumentationTests extends MockMvcEndpointDocumentationTests
 				.type(JsonFieldType.OBJECT)
 				.description("Job data map keyed by name, if any.") };
 
-	@MockBean
+	@MockitoBean
 	private Scheduler scheduler;
 
 	@Test

spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/documentation/SessionsEndpointDocumentationTests.java

@@ -35,6 +35,7 @@
 import org.springframework.session.FindByIndexNameSessionRepository;
 import org.springframework.session.MapSession;
 import org.springframework.session.Session;
+import org.springframework.test.bean.override.mockito.MockitoBean;
 import org.springframework.test.context.TestPropertySource;
 
 import static org.assertj.core.api.Assertions.assertThat;
@@ -72,7 +73,7 @@ class SessionsEndpointDocumentationTests extends MockMvcEndpointDocumentationTes
 				.description("Maximum permitted period of inactivity, in seconds, before the session will expire."),
 			fieldWithPath("expired").description("Whether the session has expired."));
 
-	@MockBean
+	@MockitoBean
 	private FindByIndexNameSessionRepository<Session> sessionRepository;
 
 	@Test

spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/features/kotlin.adoc

@@ -145,7 +145,7 @@ JUnit 5 enables a test class to be instantiated once and reused for all of the c
 This makes it possible to use `@BeforeAll` and `@AfterAll` annotations on non-static methods, which is a good fit for Kotlin.
 
 To mock Kotlin classes, https://mockk.io/[MockK] is recommended.
-If you need the `MockK` equivalent of the Mockito specific xref:testing/spring-boot-applications.adoc#testing.spring-boot-applications.mocking-beans[`@MockBean` and `@SpyBean` annotations], you can use https://github.com/Ninja-Squad/springmockk[SpringMockK] which provides similar `@MockkBean` and `@SpykBean` annotations.
+If you need the `MockK` equivalent of the Mockito specific xref:testing/spring-boot-applications.adoc#testing.spring-boot-applications.mocking-beans[`@MockitoBean` and `@MockitoSpyBean` annotations], you can use https://github.com/Ninja-Squad/springmockk[SpringMockK] which provides similar `@MockkBean` and `@SpykBean` annotations.
 
 
 

spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/testing/springbootapplications/springmvctests/MyControllerTests.java

@@ -20,8 +20,8 @@
 
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
-import org.springframework.boot.test.mock.mockito.MockBean;
 import org.springframework.http.MediaType;
+import org.springframework.test.bean.override.mockito.MockitoBean;
 import org.springframework.test.web.servlet.assertj.MockMvcTester;
 
 import static org.assertj.core.api.Assertions.assertThat;
@@ -33,7 +33,7 @@ class MyControllerTests {
 	@Autowired
 	private MockMvcTester mvc;
 
-	@MockBean
+	@MockitoBean
 	private UserVehicleService userVehicleService;
 
 	@Test

spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/testing/springbootapplications/springmvctests/MyHtmlUnitTests.java

@@ -22,7 +22,7 @@
 
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
-import org.springframework.boot.test.mock.mockito.MockBean;
+import org.springframework.test.bean.override.mockito.MockitoBean;
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.mockito.BDDMockito.given;
@@ -33,7 +33,7 @@ class MyHtmlUnitTests {
 	@Autowired
 	private WebClient webClient;
 
-	@MockBean
+	@MockitoBean
 	private UserVehicleService userVehicleService;
 
 	@Test

spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/testing/springbootapplications/springwebfluxtests/MyControllerTests.java

@@ -20,8 +20,8 @@
 
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.test.autoconfigure.web.reactive.WebFluxTest;
-import org.springframework.boot.test.mock.mockito.MockBean;
 import org.springframework.http.MediaType;
+import org.springframework.test.bean.override.mockito.MockitoBean;
 import org.springframework.test.web.reactive.server.WebTestClient;
 
 import static org.mockito.BDDMockito.given;
@@ -32,7 +32,7 @@ class MyControllerTests {
 	@Autowired
 	private WebTestClient webClient;
 
-	@MockBean
+	@MockitoBean
 	private UserVehicleService userVehicleService;
 
 	@Test

spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/features/testing/springbootapplications/springmvctests/MyControllerTests.kt

@@ -21,14 +21,14 @@ import org.junit.jupiter.api.Test
 import org.mockito.BDDMockito.given
 import org.springframework.beans.factory.annotation.Autowired
 import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest
-import org.springframework.boot.test.mock.mockito.MockBean
 import org.springframework.http.MediaType
+import org.springframework.test.bean.override.mockito.MockitoBean
 import org.springframework.test.web.servlet.assertj.MockMvcTester
 
 @WebMvcTest(UserVehicleController::class)
 class MyControllerTests(@Autowired val mvc: MockMvcTester) {
 
-	@MockBean
+	@MockitoBean
 	lateinit var userVehicleService: UserVehicleService
 
 	@Test

spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/features/testing/springbootapplications/springmvctests/MyHtmlUnitTests.kt

@@ -23,12 +23,12 @@ import org.junit.jupiter.api.Test
 import org.mockito.BDDMockito.given
 import org.springframework.beans.factory.annotation.Autowired
 import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest
-import org.springframework.boot.test.mock.mockito.MockBean
+import org.springframework.test.bean.override.mockito.MockitoBean
 
 @WebMvcTest(UserVehicleController::class)
 class MyHtmlUnitTests(@Autowired val webClient: WebClient) {
 
-	@MockBean
+	@MockitoBean
 	lateinit var userVehicleService: UserVehicleService
 
 	@Test

spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/features/testing/springbootapplications/springwebfluxtests/MyControllerTests.kt

@@ -20,15 +20,15 @@ import org.junit.jupiter.api.Test
 import org.mockito.BDDMockito.given
 import org.springframework.beans.factory.annotation.Autowired
 import org.springframework.boot.test.autoconfigure.web.reactive.WebFluxTest
-import org.springframework.boot.test.mock.mockito.MockBean
 import org.springframework.http.MediaType
+import org.springframework.test.bean.override.mockito.MockitoBean
 import org.springframework.test.web.reactive.server.WebTestClient
 import org.springframework.test.web.reactive.server.expectBody
 
 @WebFluxTest(UserVehicleController::class)
 class MyControllerTests(@Autowired val webClient: WebTestClient) {
 
-	@MockBean
+	@MockitoBean
 	lateinit var userVehicleService: UserVehicleService
 
 	@Test

spring-boot-project/spring-boot-test/build.gradle

@@ -55,6 +55,7 @@ dependencies {
 	testImplementation("org.spockframework:spock-core")
 	testImplementation("org.springframework:spring-webmvc")
 	testImplementation("org.springframework:spring-core-test")
+	testImplementation("org.springframework:spring-test")
 	testImplementation("org.testng:testng")
 
 	testRuntimeOnly("org.junit.vintage:junit-vintage-engine")

spring-boot-project/spring-boot-test/src/main/java/org/springframework/boot/test/mock/mockito/Definition.java

@@ -23,7 +23,9 @@
  *
  * @author Phillip Webb
  * @see DefinitionsParser
+ * @deprecated since 3.4.0. See {@link SpyBean} and {@link MockBean} for more details.
  */
+@Deprecated(since = "3.4.0")
 abstract class Definition {
 
 	private static final int MULTIPLIER = 31;

spring-boot-project/spring-boot-test/src/main/java/org/springframework/boot/test/mock/mockito/DefinitionsParser.java

@@ -41,7 +41,10 @@
  *
  * @author Phillip Webb
  * @author Stephane Nicoll
+ * @deprecated since 3.4.0. See {@link SpyBean} and {@link MockBean} for more details.
  */
+
+@Deprecated(since = "3.4.0")
 class DefinitionsParser {
 
 	private final Set<Definition> definitions;

spring-boot-project/spring-boot-test/src/main/java/org/springframework/boot/test/mock/mockito/MockBean.java

@@ -91,11 +91,14 @@
  * @author Phillip Webb
  * @since 1.4.0
  * @see MockitoPostProcessor
+ * @deprecated since 3.4.0 in favor of
+ * {@link org.springframework.test.bean.override.mockito.MockitoBean}
  */
 @Target({ ElementType.TYPE, ElementType.FIELD })
 @Retention(RetentionPolicy.RUNTIME)
 @Documented
 @Repeatable(MockBeans.class)
+@Deprecated(since = "3.4.0")
 public @interface MockBean {
 
 	/**

spring-boot-project/spring-boot-test/src/main/java/org/springframework/boot/test/mock/mockito/MockBeans.java

@@ -33,10 +33,13 @@
  *
  * @author Phillip Webb
  * @since 1.4.0
+ * @deprecated since 3.4.0 in favor of
+ * {@link org.springframework.test.bean.override.mockito.MockitoBean}
  */
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.TYPE)
 @Documented
+@Deprecated(since = "3.4.0")
 public @interface MockBeans {
 
 	/**

spring-boot-project/spring-boot-test/src/main/java/org/springframework/boot/test/mock/mockito/MockDefinition.java

@@ -37,7 +37,9 @@
  * A complete definition that can be used to create a Mockito mock.
  *
  * @author Phillip Webb
+ * @deprecated since 3.4.0. See {@link MockBean} for more details.
  */
+@Deprecated(since = "3.4.0")
 class MockDefinition extends Definition {
 
 	private static final int MULTIPLIER = 31;

spring-boot-project/spring-boot-test/src/main/java/org/springframework/boot/test/mock/mockito/MockReset.java

@@ -35,7 +35,11 @@
  * @author Phillip Webb
  * @since 1.4.0
  * @see ResetMocksTestExecutionListener
+ * @deprecated since 3.4.0 in favor of
+ * {@link org.springframework.test.bean.override.mockito.MockReset}
  */
+
+@Deprecated(since = "3.4.0")
 public enum MockReset {
 
 	/**

spring-boot-project/spring-boot-test/src/main/java/org/springframework/boot/test/mock/mockito/MockitoBeans.java

@@ -24,7 +24,9 @@
  * Beans created using Mockito.
  *
  * @author Andy Wilkinson
+ * @deprecated since 3.4.0. See {@link MockBean} for more details.
  */
+@Deprecated(since = "3.4.0")
 class MockitoBeans implements Iterable<Object> {
 
 	private final List<Object> beans = new ArrayList<>();

spring-boot-project/spring-boot-test/src/main/java/org/springframework/boot/test/mock/mockito/MockitoContextCustomizer.java

@@ -28,7 +28,10 @@
  * A {@link ContextCustomizer} to add Mockito support.
  *
  * @author Phillip Webb
+ * @deprecated since 3.4.0 in favor of
+ * {@link org.springframework.test.bean.override.BeanOverrideContextCustomizerFactory}
  */
+@Deprecated(since = "3.4.0")
 class MockitoContextCustomizer implements ContextCustomizer {
 
 	private final Set<Definition> definitions;

spring-boot-project/spring-boot-test/src/main/java/org/springframework/boot/test/mock/mockito/MockitoContextCustomizerFactory.java

@@ -27,7 +27,10 @@
  * A {@link ContextCustomizerFactory} to add Mockito support.
  *
  * @author Phillip Webb
+ * @deprecated since 3.4.0 in favor of
+ * {@link org.springframework.test.bean.override.BeanOverrideContextCustomizerFactory}
  */
+@Deprecated(since = "3.4.0")
 class MockitoContextCustomizerFactory implements ContextCustomizerFactory {
 
 	@Override

spring-boot-project/spring-boot-test/src/main/java/org/springframework/boot/test/mock/mockito/MockitoPostProcessor.java

@@ -76,7 +76,10 @@
  * @author Stephane Nicoll
  * @author Andreas Neiser
  * @since 1.4.0
+ * @deprecated since 3.4.0 in favor of
+ * {@link org.springframework.test.bean.override.BeanOverrideBeanPostProcessor}
  */
+@Deprecated(since = "3.4.0")
 public class MockitoPostProcessor implements InstantiationAwareBeanPostProcessor, BeanClassLoaderAware,
 		BeanFactoryAware, BeanFactoryPostProcessor, Ordered {
 

spring-boot-project/spring-boot-test/src/main/java/org/springframework/boot/test/mock/mockito/MockitoTestExecutionListener.java

@@ -37,7 +37,11 @@
  * @author Moritz Halbritter
  * @since 1.4.2
  * @see ResetMocksTestExecutionListener
+ * @deprecated since 3.4.0 in favor of
+ * {@link org.springframework.test.bean.override.mockito.MockitoTestExecutionListener}
  */
+
+@Deprecated(since = "3.4.0")
 public class MockitoTestExecutionListener extends AbstractTestExecutionListener {
 
 	@Override

spring-boot-project/spring-boot-test/src/main/java/org/springframework/boot/test/mock/mockito/QualifierDefinition.java

@@ -34,7 +34,10 @@
  * @author Phillip Webb
  * @author Stephane Nicoll
  * @see Definition
+ * @deprecated since 3.4.0. See {@link SpyBean} and {@link MockBean} for more details.
  */
+
+@Deprecated(since = "3.4.0")
 class QualifierDefinition {
 
 	private final Field field;

spring-boot-project/spring-boot-test/src/main/java/org/springframework/boot/test/mock/mockito/ResetMocksTestExecutionListener.java

@@ -43,7 +43,10 @@
  * @author Phillip Webb
  * @since 1.4.0
  * @see MockitoTestExecutionListener
+ * @deprecated since 3.4.0 in favor of
+ * {@link org.springframework.test.bean.override.mockito.MockitoResetTestExecutionListener}
  */
+@Deprecated(since = "3.4.0")
 public class ResetMocksTestExecutionListener extends AbstractTestExecutionListener {
 
 	private static final boolean MOCKITO_IS_PRESENT = ClassUtils.isPresent("org.mockito.MockSettings",

spring-boot-project/spring-boot-test/src/main/java/org/springframework/boot/test/mock/mockito/SpyBean.java

@@ -89,7 +89,10 @@
  * @author Phillip Webb
  * @since 1.4.0
  * @see MockitoPostProcessor
+ * @deprecated since 3.4.0 in favor of
+ * {@link org.springframework.test.bean.override.mockito.MockitoSpyBean}
  */
+@Deprecated(since = "3.4.0")
 @Target({ ElementType.TYPE, ElementType.FIELD })
 @Retention(RetentionPolicy.RUNTIME)
 @Documented

spring-boot-project/spring-boot-test/src/main/java/org/springframework/boot/test/mock/mockito/SpyBeans.java

@@ -33,10 +33,13 @@
  *
  * @author Phillip Webb
  * @since 1.4.0
+ * @deprecated since 3.4.0 in favor of
+ * {@link org.springframework.test.bean.override.mockito.MockitoSpyBean}
  */
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.TYPE)
 @Documented
+@Deprecated(since = "3.4.0")
 public @interface SpyBeans {
 
 	/**