Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Use the field name as a fallback qualifier for Bean Overriding

Browse Source 
This commit harmonizes how a candidate bean definition is determined
for overriding using `@TestBean`, `@MockitoBean`, and `@MockitoSpyBean`.

Previously, a qualifier was necessary even if the name of the annotated
field matches the name of a candidate. After this commit, such candidate
will be picked up transparently, the same it is done for regular
autowiring.

This commit also reviews the documentation of the feature as considering
the field means that its name is taken into account to compute a cache
key if by-type lookup is requested.

Closes gh-32939
This commit is contained in:
Stéphane Nicoll
2024-06-10 18:07:36 +02:00
parent 4c7374797e
commit 28f62abda4
10 changed files with 363 additions and 101 deletions
Download Patch File Download Diff File Expand all files Collapse all files

129
spring-test/src/test/java/org/springframework/test/context/bean/override/BeanOverrideBeanFactoryPostProcessorTests.java
View File

@@ -55,18 +55,16 @@ import static org.mockito.Mockito.mock;
class BeanOverrideBeanFactoryPostProcessorTests {
@Test
void canReplaceExistingBeanDefinitions() {
AnnotationConfigApplicationContext context = createContext(CaseByNameAndByType.class);
void replaceBeanByNameWithMatchingBeanDefinition() {
AnnotationConfigApplicationContext context = createContext(CaseByName.class);
context.registerBean("descriptionBean", String.class, () -> "Original");
context.registerBean("someInteger", Integer.class, () -> 1);
context.refresh();
assertThat(context.getBean("descriptionBean")).isEqualTo("overridden");
assertThat(context.getBean("someInteger")).isSameAs(42);
}
@Test
void cannotReplaceIfNoBeanNameMatching() {
void replaceBeanByNameWithoutMatchingBeanDefinitionFails() {
AnnotationConfigApplicationContext context = createContext(CaseByName.class);
assertThatIllegalStateException()
@@ -76,40 +74,18 @@ class BeanOverrideBeanFactoryPostProcessorTests {
}
@Test
void cannotReplaceIfNoBeanTypeMatching() {
AnnotationConfigApplicationContext context = createContext(CaseByType.class);
void replaceBeanByNameWithMatchingBeanDefinitionAndWrongTypeFails() {
AnnotationConfigApplicationContext context = createContext(CaseByName.class);
context.registerBean("descriptionBean", Integer.class, () -> -1);
assertThatIllegalStateException()
.isThrownBy(context::refresh)
.withMessage("Unable to override bean: no bean definitions of type java.lang.Integer " +
"(as required by annotated field 'CaseByType.counter')");
.withMessage("Unable to override bean 'descriptionBean': there is no bean definition " +
"to replace with that name of type java.lang.String");
}
@Test
void canReplaceExistingBeanDefinitionsWithCreateReplaceStrategy() {
AnnotationConfigApplicationContext context = createContext(CaseByNameAndByTypeWithReplaceOrCreateStrategy.class);
context.register(CaseByNameAndByTypeWithReplaceOrCreateStrategy.class);
context.registerBean("descriptionBean", String.class, () -> "Original");
context.registerBean("someInteger", Integer.class, () -> 1);
context.refresh();
assertThat(context.getBean("descriptionBean")).isEqualTo("overridden");
assertThat(context.getBean("someInteger")).isEqualTo(42);
}
@Test
void canCreateIfOriginalMissingWithCreateReplaceStrategy() {
AnnotationConfigApplicationContext context = createContext(CaseByNameAndByTypeWithReplaceOrCreateStrategy.class);
context.refresh();
String byTypeGeneratedBeanName = "java.lang.Integer#0";
assertThat(context.getBeanDefinitionNames()).contains("descriptionBean", byTypeGeneratedBeanName);
assertThat(context.getBean("descriptionBean")).isEqualTo("overridden");
assertThat(context.getBean(byTypeGeneratedBeanName)).isEqualTo(42);
}
@Test
void canOverrideBeanProducedByFactoryBeanWithClassObjectTypeAttribute() {
void replaceBeanByNameCanOverrideBeanProducedByFactoryBeanWithClassObjectTypeAttribute() {
AnnotationConfigApplicationContext context = prepareContextWithFactoryBean(CharSequence.class);
context.refresh();
@@ -117,7 +93,7 @@ class BeanOverrideBeanFactoryPostProcessorTests {
}
@Test
void canOverrideBeanProducedByFactoryBeanWithResolvableTypeObjectTypeAttribute() {
void replaceBeanByNameCanOverrideBeanProducedByFactoryBeanWithResolvableTypeObjectTypeAttribute() {
AnnotationConfigApplicationContext context = prepareContextWithFactoryBean(ResolvableType.forClass(CharSequence.class));
context.refresh();
@@ -133,6 +109,84 @@ class BeanOverrideBeanFactoryPostProcessorTests {
return context;
}
@Test
void replaceBeanByTypeWithSingleMatchingBean() {
AnnotationConfigApplicationContext context = createContext(CaseByType.class);
context.registerBean("someInteger", Integer.class, () -> 1);
context.refresh();
assertThat(context.getBean("someInteger")).isEqualTo(42);
}
@Test
void replaceBeanByTypeWithoutMatchingBeanFails() {
AnnotationConfigApplicationContext context = createContext(CaseByType.class);
assertThatIllegalStateException()
.isThrownBy(context::refresh)
.withMessage("Unable to override bean: no bean definitions of type java.lang.Integer " +
"(as required by annotated field 'CaseByType.counter')");
}
@Test
void replaceBeanByTypeWithMultipleMatchesAndNoQualifierFails() {
AnnotationConfigApplicationContext context = createContext(CaseByType.class);
context.registerBean("someInteger", Integer.class, () -> 1);
context.registerBean("anotherInteger", Integer.class, () -> 2);
assertThatIllegalStateException()
.isThrownBy(context::refresh)
.withMessage("Unable to select a bean definition to override: found 2 bean definitions " +
"of type java.lang.Integer (as required by annotated field 'CaseByType.counter'): " +
"[someInteger, anotherInteger]");
}
@Test
void replaceBeanByTypeWithMultipleMatchesAndFieldNameQualifierMatches() {
AnnotationConfigApplicationContext context = createContext(CaseByType.class);
context.registerBean("counter", Integer.class, () -> 1);
context.registerBean("someInteger", Integer.class, () -> 2);
context.refresh();
assertThat(context.getBean("counter")).isSameAs(42);
}
@Test
void createOrReplaceBeanByNameWithMatchingBeanDefinition() {
AnnotationConfigApplicationContext context = createContext(CaseByNameWithReplaceOrCreateStrategy.class);
context.registerBean("descriptionBean", String.class, () -> "Original");
context.refresh();
assertThat(context.getBean("descriptionBean")).isEqualTo("overridden");
}
@Test
void createOrReplaceBeanByNameWithoutMatchingDefinitionCreatesBeanDefinition() {
AnnotationConfigApplicationContext context = createContext(CaseByNameWithReplaceOrCreateStrategy.class);
context.refresh();
assertThat(context.getBean("descriptionBean")).isEqualTo("overridden");
}
@Test
void createOrReplaceBeanByTypeWithMatchingBean() {
AnnotationConfigApplicationContext context = createContext(CaseByTypeWithReplaceOrCreateStrategy.class);
context.registerBean("someBean", String.class, () -> "Original");
context.refresh();
assertThat(context.getBean("someBean")).isEqualTo("overridden");
}
@Test
void createOrReplaceBeanByTypeWithoutMatchingDefinitionCreatesBeanDefinition() {
AnnotationConfigApplicationContext context = createContext(CaseByTypeWithReplaceOrCreateStrategy.class);
context.refresh();
String generatedBeanName = "java.lang.String#0";
assertThat(context.getBeanDefinitionNames()).contains(generatedBeanName);
assertThat(context.getBean(generatedBeanName)).isEqualTo("overridden");
}
@Test
void postProcessorShouldNotTriggerEarlyInitialization() {
AnnotationConfigApplicationContext context = createContext(CaseByTypeWithReplaceOrCreateStrategy.class);
@@ -216,14 +270,11 @@ class BeanOverrideBeanFactoryPostProcessorTests {
}
static class CaseByNameAndByType {
static class CaseByNameWithReplaceOrCreateStrategy {
@DummyBean(beanName = "descriptionBean")
@DummyBean(beanName = "descriptionBean", strategy = BeanOverrideStrategy.REPLACE_OR_CREATE_DEFINITION)
private String description;
@DummyBean
private Integer counter;
}
static class CaseByTypeWithReplaceOrCreateStrategy {

25
spring-test/src/test/java/org/springframework/test/context/bean/override/OverrideMetadataTests.java
View File

@@ -68,9 +68,9 @@ public class OverrideMetadataTests {
List<OverrideMetadata> overrideMetadata = OverrideMetadata.forTestClass(MultipleAnnotationsDuplicate.class);
assertThat(overrideMetadata).hasSize(2)
.anySatisfy(hasTestBeanMetadata(
field(MultipleAnnotationsDuplicate.class, "message1"), String.class, null))
field(MultipleAnnotationsDuplicate.class, "message1"), String.class, "messageBean"))
.anySatisfy(hasTestBeanMetadata(
field(MultipleAnnotationsDuplicate.class, "message2"), String.class, null));
field(MultipleAnnotationsDuplicate.class, "message2"), String.class, "messageBean"));
assertThat(new HashSet<>(overrideMetadata)).hasSize(1);
}
@@ -127,6 +127,14 @@ public class OverrideMetadataTests {
assertThat(metadata).hasSameHashCodeAs(metadata2);
}
@Test
void isEqualToWithByNameLookupAndDifferentFieldNames() {
OverrideMetadata metadata = createMetadata(field(ConfigA.class, "noQualifier"), "beanToOverride");
OverrideMetadata metadata2 = createMetadata(field(ConfigB.class, "example"), "beanToOverride");
assertThat(metadata).isEqualTo(metadata2);
assertThat(metadata).hasSameHashCodeAs(metadata2);
}
@Test
void isEqualToWithSameMetadataAndSameQualifierValues() {
OverrideMetadata metadata = createMetadata(field(ConfigA.class, "directQualifier"));
@@ -149,6 +157,13 @@ public class OverrideMetadataTests {
assertThat(metadata).isNotEqualTo(metadata2);
}
@Test
void isNotEqualToWithByTypeLookupAndDifferentFieldNames() {
OverrideMetadata metadata = createMetadata(field(ConfigA.class, "noQualifier"));
OverrideMetadata metadata2 = createMetadata(field(ConfigB.class, "example"));
assertThat(metadata).isNotEqualTo(metadata2);
}
private OverrideMetadata createMetadata(Field field) {
return createMetadata(field, null);
}
@@ -195,10 +210,10 @@ public class OverrideMetadataTests {
static class MultipleAnnotationsDuplicate {
@DummyBean
@DummyBean(beanName = "messageBean")
String message1;
@DummyBean
@DummyBean(beanName = "messageBean")
String message2;
}
@@ -233,6 +248,8 @@ public class OverrideMetadataTests {
private ExampleService noQualifier;
private ExampleService example;
@Qualifier("test")
private ExampleService directQualifier;

22
spring-test/src/test/java/org/springframework/test/context/bean/override/convention/TestBeanOverrideMetadataTests.java
View File

@@ -74,13 +74,20 @@ class TestBeanOverrideMetadataTests {
}
@Test
void isEqualToWithSameMetadataButDifferentField() {
TestBeanOverrideMetadata metadata1 = createMetadata(sampleField("message"), sampleMethod("message"));
TestBeanOverrideMetadata metadata2 = createMetadata(sampleField("message2"), sampleMethod("message"));
void isEqualToWithSameMetadataByNameLookupAndDifferentField() {
TestBeanOverrideMetadata metadata1 = createMetadata(sampleField("message3"), sampleMethod("message"));
TestBeanOverrideMetadata metadata2 = createMetadata(sampleField("message4"), sampleMethod("message"));
assertThat(metadata1).isEqualTo(metadata2);
assertThat(metadata1).hasSameHashCodeAs(metadata2);
}
@Test
void isNotEqualToWithSameMetadataByTypeLookupAndDifferentField() {
TestBeanOverrideMetadata metadata1 = createMetadata(sampleField("message"), sampleMethod("message"));
TestBeanOverrideMetadata metadata2 = createMetadata(sampleField("message2"), sampleMethod("message"));
assertThat(metadata1).isNotEqualTo(metadata2);
}
@Test
void isNotEqualToWithSameMetadataButDifferentBeanName() {
TestBeanOverrideMetadata metadata1 = createMetadata(sampleField("message"), sampleMethod("message"));
@@ -98,7 +105,7 @@ class TestBeanOverrideMetadataTests {
@Test
void isNotEqualToWithSameMetadataButDifferentAnnotations() {
TestBeanOverrideMetadata metadata1 = createMetadata(sampleField("message"), sampleMethod("message"));
TestBeanOverrideMetadata metadata2 = createMetadata(sampleField("message4"), sampleMethod("message"));
TestBeanOverrideMetadata metadata2 = createMetadata(sampleField("message5"), sampleMethod("message"));
assertThat(metadata1).isNotEqualTo(metadata2);
}
@@ -116,7 +123,7 @@ class TestBeanOverrideMetadataTests {
private TestBeanOverrideMetadata createMetadata(Field field, Method overrideMethod) {
TestBean annotation = field.getAnnotation(TestBean.class);
String beanName = (StringUtils.hasText(annotation.value()) ? annotation.value() : null);
String beanName = (StringUtils.hasText(annotation.name()) ? annotation.name() : null);
return new TestBeanOverrideMetadata(field, ResolvableType.forClass(field.getType()), beanName, overrideMethod);
}
@@ -162,9 +169,12 @@ class TestBeanOverrideMetadataTests {
@TestBean(name = "anotherBean")
private String message3;
@TestBean(name = "anotherBean")
private String message4;
@Qualifier("anotherBean")
@TestBean
private String message4;
private String message5;
static String message() {
return "OK";

84
spring-test/src/test/java/org/springframework/test/context/bean/override/mockito/MockitoBeanContextCustomizerEqualityTests.java
View File

@@ -34,28 +34,48 @@ class MockitoBeanContextCustomizerEqualityTests {
@Test
void contextCustomizerWithSameMockInDifferentClassIsEqual() {
assertThat(createContextCustomizer(Case1.class)).isEqualTo(createContextCustomizer(Case2.class));
void contextCustomizerWithSameMockByNameInDifferentClassIsEqual() {
assertThat(createContextCustomizer(Case1ByName.class)).isEqualTo(createContextCustomizer(Case2ByName.class));
}
@Test
void contextCustomizerWithSameSpyInDifferentClassIsEqual() {
assertThat(createContextCustomizer(Case4.class)).isEqualTo(createContextCustomizer(Case5.class));
void contextCustomizerWithSameMockByTypeInDifferentClassIsEqual() {
assertThat(createContextCustomizer(Case1ByType.class)).isEqualTo(createContextCustomizer(Case2ByTypeSameFieldName.class));
}
@Test
void contextCustomizerWithSameMockByTypeAndDifferentFieldNamesAreNotEqual() {
assertThat(createContextCustomizer(Case1ByType.class)).isNotEqualTo(createContextCustomizer(Case2ByType.class));
}
@Test
void contextCustomizerWithSameSpyByNameInDifferentClassIsEqual() {
assertThat(createContextCustomizer(Case4ByName.class)).isEqualTo(createContextCustomizer(Case5ByName.class));
}
@Test
void contextCustomizerWithSameSpyByTypeInDifferentClassIsEqual() {
assertThat(createContextCustomizer(Case4ByType.class)).isEqualTo(createContextCustomizer(Case5ByTypeSameFieldName.class));
}
@Test
void contextCustomizerWithSameSpyByTypeAndDifferentFieldNamesAreNotEqual() {
assertThat(createContextCustomizer(Case4ByType.class)).isNotEqualTo(createContextCustomizer(Case5ByType.class));
}
@Test
void contextCustomizerWithSimilarMockButDifferentAnswersIsNotEqual() {
assertThat(createContextCustomizer(Case1.class)).isNotEqualTo(createContextCustomizer(Case3.class));
assertThat(createContextCustomizer(Case1ByType.class)).isNotEqualTo(createContextCustomizer(Case3.class));
}
@Test
void contextCustomizerWithSimilarSpyButDifferentProxyTargetClassFlagIsNotEqual() {
assertThat(createContextCustomizer(Case5.class)).isNotEqualTo(createContextCustomizer(Case6.class));
assertThat(createContextCustomizer(Case5ByType.class)).isNotEqualTo(createContextCustomizer(Case6.class));
}
@Test
void contextCustomizerWithMockAndSpyAreNotEqual() {
assertThat(createContextCustomizer(Case1.class)).isNotEqualTo(createContextCustomizer(Case4.class));
assertThat(createContextCustomizer(Case1ByType.class)).isNotEqualTo(createContextCustomizer(Case4ByType.class));
}
private ContextCustomizer createContextCustomizer(Class<?> testClass) {
@@ -64,20 +84,41 @@ class MockitoBeanContextCustomizerEqualityTests {
return customizer;
}
static class Case1 {
static class Case1ByName {
@MockitoBean(name = "serviceBean")
private String exampleService;
}
static class Case1ByType {
@MockitoBean
private String exampleService;
}
static class Case2 {
static class Case2ByName {
@MockitoBean(name = "serviceBean")
private String serviceToMock;
}
static class Case2ByType {
@MockitoBean
private String serviceToMock;
}
static class Case2ByTypeSameFieldName {
@MockitoBean
private String exampleService;
}
static class Case3 {
@MockitoBean(answers = Answers.RETURNS_MOCKS)
@@ -85,20 +126,41 @@ class MockitoBeanContextCustomizerEqualityTests {
}
static class Case4 {
static class Case4ByName {
@MockitoSpyBean(name = "serviceBean")
private String exampleService;
}
static class Case4ByType {
@MockitoSpyBean
private String exampleService;
}
static class Case5 {
static class Case5ByName {
@MockitoSpyBean(name = "serviceBean")
private String serviceToMock;
}
static class Case5ByType {
@MockitoSpyBean
private String serviceToMock;
}
static class Case5ByTypeSameFieldName {
@MockitoSpyBean
private String exampleService;
}
static class Case6 {
@MockitoSpyBean(proxyTargetAware = false)

24
spring-test/src/test/java/org/springframework/test/context/bean/override/mockito/MockitoBeanOverrideMetadataTests.java
View File

@@ -64,9 +64,16 @@ class MockitoBeanOverrideMetadataTests {
}
@Test
void isEqualToWithSameMetadataButDifferentField() {
void isNotEqualEqualToByTypeLookupWithSameMetadataButDifferentField() {
MockitoBeanOverrideMetadata metadata = createMetadata(sampleField("service"));
MockitoBeanOverrideMetadata metadata2 = createMetadata(sampleField("service2"));
assertThat(metadata).isNotEqualTo(metadata2);
}
@Test
void isEqualEqualToByNameLookupWithSameMetadataButDifferentField() {
MockitoBeanOverrideMetadata metadata = createMetadata(sampleField("service3"));
MockitoBeanOverrideMetadata metadata2 = createMetadata(sampleField("service4"));
assertThat(metadata).isEqualTo(metadata2);
assertThat(metadata).hasSameHashCodeAs(metadata2);
}
@@ -81,21 +88,21 @@ class MockitoBeanOverrideMetadataTests {
@Test
void isNotEqualToWithSameMetadataButDifferentExtraInterfaces() {
MockitoBeanOverrideMetadata metadata = createMetadata(sampleField("service"));
MockitoBeanOverrideMetadata metadata2 = createMetadata(sampleField("service4"));
MockitoBeanOverrideMetadata metadata2 = createMetadata(sampleField("service5"));
assertThat(metadata).isNotEqualTo(metadata2);
}
@Test
void isNotEqualToWithSameMetadataButDifferentAnswers() {
MockitoBeanOverrideMetadata metadata = createMetadata(sampleField("service"));
MockitoBeanOverrideMetadata metadata2 = createMetadata(sampleField("service5"));
MockitoBeanOverrideMetadata metadata2 = createMetadata(sampleField("service6"));
assertThat(metadata).isNotEqualTo(metadata2);
}
@Test
void isNotEqualToWithSameMetadataButDifferentSerializableFlag() {
MockitoBeanOverrideMetadata metadata = createMetadata(sampleField("service"));
MockitoBeanOverrideMetadata metadata2 = createMetadata(sampleField("service6"));
MockitoBeanOverrideMetadata metadata2 = createMetadata(sampleField("service7"));
assertThat(metadata).isNotEqualTo(metadata2);
}
@@ -137,15 +144,18 @@ class MockitoBeanOverrideMetadataTests {
@MockitoBean(name = "beanToMock")
private String service3;
@MockitoBean(extraInterfaces = Externalizable.class)
@MockitoBean(name = "beanToMock")
private String service4;
@MockitoBean(answers = Answers.RETURNS_MOCKS)
@MockitoBean(extraInterfaces = Externalizable.class)
private String service5;
@MockitoBean(serializable = true)
@MockitoBean(answers = Answers.RETURNS_MOCKS)
private String service6;
@MockitoBean(serializable = true)
private String service7;
}
}

20
spring-test/src/test/java/org/springframework/test/context/bean/override/mockito/MockitoSpyBeanOverrideMetadataTests.java
View File

@@ -62,9 +62,16 @@ class MockitoSpyBeanOverrideMetadataTests {
}
@Test
void isEqualToWithSameMetadataButDifferentField() {
void isNotEqualToByTypeLookupWithSameMetadataButDifferentField() {
MockitoSpyBeanOverrideMetadata metadata = createMetadata(sampleField("service"));
MockitoSpyBeanOverrideMetadata metadata2 = createMetadata(sampleField("service2"));
assertThat(metadata).isNotEqualTo(metadata2);
}
@Test
void isEqualToByNameLookupWithSameMetadataButDifferentField() {
MockitoSpyBeanOverrideMetadata metadata = createMetadata(sampleField("service3"));
MockitoSpyBeanOverrideMetadata metadata2 = createMetadata(sampleField("service4"));
assertThat(metadata).isEqualTo(metadata2);
assertThat(metadata).hasSameHashCodeAs(metadata2);
}
@@ -79,14 +86,14 @@ class MockitoSpyBeanOverrideMetadataTests {
@Test
void isNotEqualToWithSameMetadataButDifferentReset() {
MockitoSpyBeanOverrideMetadata metadata = createMetadata(sampleField("service"));
MockitoSpyBeanOverrideMetadata metadata2 = createMetadata(sampleField("service4"));
MockitoSpyBeanOverrideMetadata metadata2 = createMetadata(sampleField("service5"));
assertThat(metadata).isNotEqualTo(metadata2);
}
@Test
void isNotEqualToWithSameMetadataButDifferentProxyTargetAwareFlag() {
MockitoSpyBeanOverrideMetadata metadata = createMetadata(sampleField("service"));
MockitoSpyBeanOverrideMetadata metadata2 = createMetadata(sampleField("service5"));
MockitoSpyBeanOverrideMetadata metadata2 = createMetadata(sampleField("service6"));
assertThat(metadata).isNotEqualTo(metadata2);
}
@@ -128,12 +135,15 @@ class MockitoSpyBeanOverrideMetadataTests {
@MockitoSpyBean(name = "beanToMock")
private String service3;
@MockitoSpyBean(reset = MockReset.BEFORE)
@MockitoSpyBean(name = "beanToMock")
private String service4;
@MockitoSpyBean(proxyTargetAware = false)
@MockitoSpyBean(reset = MockReset.BEFORE)
private String service5;
@MockitoSpyBean(proxyTargetAware = false)
private String service6;
}
}