Skip to content

Consider @Primary annotation when using @MockBean #11066

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Consider @Primary annotation when using @MockBean #11066

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions ...t-test/src/main/java/org/springframework/boot/test/mock/mockito/MockitoPostProcessor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
import java.beans.PropertyDescriptor;
import java.lang.reflect.Field;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.LinkedHashSet;
Expand Down Expand Up @@ -228,7 +229,8 @@ private String getBeanName(ConfigurableListableBeanFactory beanFactory,
if (StringUtils.hasLength(mockDefinition.getName())) {
return mockDefinition.getName();
}
Set<String> existingBeans = findCandidateBeans(beanFactory, mockDefinition);
Set<String> existingBeans = findCandidateBeans(beanFactory, mockDefinition,
beanDefinition);
if (existingBeans.isEmpty()) {
return this.beanNameGenerator.generateBeanName(beanDefinition, registry);
}
Expand All @@ -253,14 +255,23 @@ private void registerSpy(ConfigurableListableBeanFactory beanFactory,
}

private Set<String> findCandidateBeans(ConfigurableListableBeanFactory beanFactory,
MockDefinition mockDefinition) {
MockDefinition mockDefinition, RootBeanDefinition mockBeanDefinition) {
QualifierDefinition qualifier = mockDefinition.getQualifier();
Set<String> candidates = new TreeSet<>();
String primaryBeanName = null;
for (String candidate : getExistingBeans(beanFactory,
mockDefinition.getTypeToMock())) {
if (qualifier == null || qualifier.matches(beanFactory, candidate)) {
candidates.add(candidate);
}
if (beanFactory.containsBeanDefinition(candidate) &&
beanFactory.getBeanDefinition(candidate).isPrimary()) {
primaryBeanName = candidate;
}
}
if (qualifier == null && primaryBeanName != null) {
mockBeanDefinition.setPrimary(true);
return Collections.singleton(primaryBeanName);
}
return candidates;
}
Expand Down
83 changes: 83 additions & 0 deletions ...t/src/test/java/org/springframework/boot/test/mock/mockito/MockitoPostProcessorTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,11 @@
import org.springframework.beans.factory.support.RootBeanDefinition;
import org.springframework.boot.test.mock.mockito.example.ExampleService;
import org.springframework.boot.test.mock.mockito.example.FailingExampleService;
import org.springframework.boot.test.mock.mockito.example.RealExampleService;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Primary;

import static org.assertj.core.api.Assertions.assertThat;

Expand Down Expand Up @@ -84,6 +86,46 @@ public void canMockBeanProducedByFactoryBeanWithObjectTypeAttribute() {
.isTrue();
}

@Test
public void canMockPrimaryBean() {
AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();
MockitoPostProcessor.register(context);
context.register(MockPrimaryBean.class);
context.refresh();
assertThat(Mockito.mockingDetails(
context.getBean(MockPrimaryBean.class).mock)
.isMock()).isTrue();
assertThat(Mockito.mockingDetails(
context.getBean(ExampleService.class))
.isMock()).isTrue();
assertThat(Mockito.mockingDetails(
context.getBean("examplePrimary", ExampleService.class))
.isMock()).isTrue();
assertThat(Mockito.mockingDetails(
context.getBean("exampleQualified", ExampleService.class))
.isMock()).isFalse();
}

@Test
public void canMockQualifiedBeanWithPrimaryBeanPresent() {
AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();
MockitoPostProcessor.register(context);
context.register(MockQualifiedBean.class);
context.refresh();
assertThat(Mockito.mockingDetails(
context.getBean(MockQualifiedBean.class).mock)
.isMock()).isTrue();
assertThat(Mockito.mockingDetails(
context.getBean(ExampleService.class))
.isMock()).isFalse();
assertThat(Mockito.mockingDetails(
context.getBean("examplePrimary", ExampleService.class))
.isMock()).isFalse();
assertThat(Mockito.mockingDetails(
context.getBean("exampleQualified", ExampleService.class))
.isMock()).isTrue();
}

@Configuration
@MockBean(SomeInterface.class)
static class MockedFactoryBean {
Expand Down Expand Up @@ -137,6 +179,47 @@ public ExampleService example3() {

}

@Configuration
static class MockPrimaryBean {

@MockBean(ExampleService.class)
private ExampleService mock;

@Bean
@Qualifier("test")
public ExampleService exampleQualified() {
return new RealExampleService("qualified");
}

@Bean
@Primary
public ExampleService examplePrimary() {
return new RealExampleService("primary");
}

}

@Configuration
static class MockQualifiedBean {

@MockBean(ExampleService.class)
@Qualifier("test")
private ExampleService mock;

@Bean
@Qualifier("test")
public ExampleService exampleQualified() {
return new RealExampleService("qualified");
}

@Bean
@Primary
public ExampleService examplePrimary() {
return new RealExampleService("primary");
}

}

static class TestFactoryBean implements FactoryBean<Object> {

@Override
Expand Down