From bc53fe0344496376fe042c6bd260fd7fd91df61e Mon Sep 17 00:00:00 2001 From: Andy Wilkinson Date: Thu, 5 Dec 2019 16:13:02 +0000 Subject: [PATCH] Recommend mockito-inline for mocking and spying of CGLib proxies This reverts commit 52050c173c35e8b96722051031ab55774f524967. See gh-17817 Closes gh-19020 --- .../main/asciidoc/spring-boot-features.adoc | 5 + .../mock/mockito/MockitoPostProcessor.java | 22 +--- ...ForExistingScopedBeanIntegrationTests.java | 113 ------------------ 3 files changed, 10 insertions(+), 130 deletions(-) delete mode 100644 spring-boot-project/spring-boot-test/src/test/java/org/springframework/boot/test/mock/mockito/SpyBeanOnTestFieldForExistingScopedBeanIntegrationTests.java diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc index 8fc2213c1d29..9d225f1836e4 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc @@ -5801,6 +5801,11 @@ We recommend using a `@Bean` method to create and configure the mock in this sit Additionally, you can use `@SpyBean` to wrap any existing bean with a Mockito `spy`. See the {spring-boot-test-module-api}/mock/mockito/SpyBean.html[Javadoc] for full details. +NOTE: CGLib proxies, such as those created for scoped beans, declare the proxied methods as `final`. +This stops Mockito from functioning correctly as it cannot mock or spy on `final` methods in its default configuration. +If you want to mock or spy on such a bean, configure Mockito to use its inline mock maker by adding `org.mockito:mockito-inline` to your application's test dependencies. +This allows Mockito to mock and spy on `final` methods. + NOTE: While Spring's test framework caches application contexts between tests and reuses a context for tests sharing the same configuration, the use of `@MockBean` or `@SpyBean` influences the cache key, which will most likely increase the number of contexts. TIP: If you are using `@SpyBean` to spy on a bean with `@Cacheable` methods that refer to parameters by name, your application must be compiled with `-parameters`. diff --git a/spring-boot-project/spring-boot-test/src/main/java/org/springframework/boot/test/mock/mockito/MockitoPostProcessor.java b/spring-boot-project/spring-boot-test/src/main/java/org/springframework/boot/test/mock/mockito/MockitoPostProcessor.java index a7824c505938..8e46cc584bd1 100644 --- a/spring-boot-project/spring-boot-test/src/main/java/org/springframework/boot/test/mock/mockito/MockitoPostProcessor.java +++ b/spring-boot-project/spring-boot-test/src/main/java/org/springframework/boot/test/mock/mockito/MockitoPostProcessor.java @@ -27,7 +27,6 @@ import java.util.Set; import java.util.TreeSet; -import org.springframework.aop.scope.ScopedObject; import org.springframework.aop.scope.ScopedProxyUtils; import org.springframework.beans.BeansException; import org.springframework.beans.PropertyValues; @@ -360,9 +359,6 @@ private void inject(Field field, Object target, String beanName) { Assert.state(ReflectionUtils.getField(field, target) == null, () -> "The field " + field + " cannot have an existing value"); Object bean = this.beanFactory.getBean(beanName, field.getType()); - if (bean instanceof ScopedObject) { - bean = ((ScopedObject) bean).getTargetObject(); - } ReflectionUtils.setField(field, target, bean); } catch (Throwable ex) { @@ -427,9 +423,8 @@ private static BeanDefinition getOrAddBeanDefinition(BeanDefinitionRegistry regi } /** - * {@link BeanPostProcessor} to handle {@link SpyBean @SpyBean} definitions. - * Registered as a separate processor so that it can be ordered above AOP post - * processors. + * {@link BeanPostProcessor} to handle {@link SpyBean} definitions. Registered as a + * separate processor so that it can be ordered above AOP post processors. */ static class SpyPostProcessor extends InstantiationAwareBeanPostProcessorAdapter implements PriorityOrdered { @@ -448,22 +443,15 @@ public int getOrder() { @Override public Object getEarlyBeanReference(Object bean, String beanName) throws BeansException { - return this.mockitoPostProcessor.createSpyIfNecessary(bean, getOriginalBeanNameIfScopedTarget(beanName)); + return this.mockitoPostProcessor.createSpyIfNecessary(bean, beanName); } @Override public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException { - if (bean instanceof FactoryBean || bean instanceof ScopedObject) { + if (bean instanceof FactoryBean) { return bean; } - return this.mockitoPostProcessor.createSpyIfNecessary(bean, getOriginalBeanNameIfScopedTarget(beanName)); - } - - private String getOriginalBeanNameIfScopedTarget(String beanName) { - if (ScopedProxyUtils.isScopedTarget(beanName)) { - return beanName.substring("scopedTarget.".length()); - } - return beanName; + return this.mockitoPostProcessor.createSpyIfNecessary(bean, beanName); } public static void register(BeanDefinitionRegistry registry) { diff --git a/spring-boot-project/spring-boot-test/src/test/java/org/springframework/boot/test/mock/mockito/SpyBeanOnTestFieldForExistingScopedBeanIntegrationTests.java b/spring-boot-project/spring-boot-test/src/test/java/org/springframework/boot/test/mock/mockito/SpyBeanOnTestFieldForExistingScopedBeanIntegrationTests.java deleted file mode 100644 index c4fd29e7c060..000000000000 --- a/spring-boot-project/spring-boot-test/src/test/java/org/springframework/boot/test/mock/mockito/SpyBeanOnTestFieldForExistingScopedBeanIntegrationTests.java +++ /dev/null @@ -1,113 +0,0 @@ -/* - * Copyright 2012-2019 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.boot.test.mock.mockito; - -import org.junit.Test; -import org.junit.runner.RunWith; - -import org.springframework.beans.factory.ObjectFactory; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.beans.factory.config.CustomScopeConfigurer; -import org.springframework.boot.test.mock.mockito.SpyBeanOnTestFieldForExistingScopedBeanIntegrationTests.SpyBeanOnTestFieldForExistingScopedBeanConfig; -import org.springframework.boot.test.mock.mockito.example.ExampleService; -import org.springframework.boot.test.mock.mockito.example.ExampleServiceCaller; -import org.springframework.boot.test.mock.mockito.example.SimpleExampleService; -import org.springframework.context.annotation.Bean; -import org.springframework.context.annotation.Configuration; -import org.springframework.context.annotation.Import; -import org.springframework.context.annotation.Scope; -import org.springframework.context.annotation.ScopedProxyMode; -import org.springframework.test.context.ContextConfiguration; -import org.springframework.test.context.junit4.SpringRunner; - -import static org.assertj.core.api.Assertions.assertThat; -import static org.mockito.Mockito.verify; - -/** - * Test {@link SpyBean @SpyBean} on a test class field can be used to replace existing - * scoped beans. - * - * @author Andy Wilkinson - */ -@RunWith(SpringRunner.class) -@ContextConfiguration(classes = SpyBeanOnTestFieldForExistingScopedBeanConfig.class) -public class SpyBeanOnTestFieldForExistingScopedBeanIntegrationTests { - - @SpyBean - private ExampleService exampleService; - - @Autowired - private ExampleServiceCaller caller; - - @Test - public void testSpying() { - assertThat(this.caller.sayGreeting()).isEqualTo("I say simple"); - verify(this.exampleService).greeting(); - } - - @Configuration - @Import({ ExampleServiceCaller.class }) - static class SpyBeanOnTestFieldForExistingScopedBeanConfig { - - @Bean - @Scope(scopeName = "custom", proxyMode = ScopedProxyMode.TARGET_CLASS) - SimpleExampleService simpleExampleService() { - return new SimpleExampleService(); - } - - @Bean - static CustomScopeConfigurer customScopeConfigurer() { - CustomScopeConfigurer configurer = new CustomScopeConfigurer(); - configurer.addScope("custom", new org.springframework.beans.factory.config.Scope() { - - private Object bean; - - @Override - public Object resolveContextualObject(String key) { - throw new UnsupportedOperationException(); - } - - @Override - public Object remove(String name) { - throw new UnsupportedOperationException(); - } - - @Override - public void registerDestructionCallback(String name, Runnable callback) { - throw new UnsupportedOperationException(); - } - - @Override - public String getConversationId() { - throw new UnsupportedOperationException(); - } - - @Override - public Object get(String name, ObjectFactory objectFactory) { - if (this.bean == null) { - this.bean = objectFactory.getObject(); - } - return this.bean; - } - - }); - return configurer; - } - - } - -}