Prohibit bean overriding by default and analyze override failures
Closes gh-13609pull/13724/merge
Andy Wilkinson
6 years ago
parent
cdd9c92ba2
commit
c1a81cfca0
@ -0,0 +1,55 @@
|
||||
/*
|
||||
* Copyright 2012-2018 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
|
||||
*
|
||||
* http://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.diagnostics.analyzer;
|
||||
|
||||
import java.io.PrintWriter;
|
||||
import java.io.StringWriter;
|
||||
|
||||
import org.springframework.beans.factory.support.BeanDefinitionOverrideException;
|
||||
import org.springframework.boot.diagnostics.AbstractFailureAnalyzer;
|
||||
import org.springframework.boot.diagnostics.FailureAnalysis;
|
||||
|
||||
/**
|
||||
* An {@link AbstractFailureAnalyzer} that performs analysis of failures caused by a
|
||||
* {@link BeanDefinitionOverrideException}.
|
||||
*
|
||||
* @author Andy Wilkinson
|
||||
*/
|
||||
class BeanDefinitionOverrideFailureAnalyzer
|
||||
extends AbstractFailureAnalyzer<BeanDefinitionOverrideException> {
|
||||
|
||||
private static final String ACTION = "Consider renaming one of the beans or enabling "
|
||||
+ "overriding by setting spring.main.allow-bean-definition-overriding=true";
|
||||
|
||||
@Override
|
||||
protected FailureAnalysis analyze(Throwable rootFailure,
|
||||
BeanDefinitionOverrideException cause) {
|
||||
return new FailureAnalysis(getDescription(cause), ACTION, cause);
|
||||
}
|
||||
|
||||
private String getDescription(BeanDefinitionOverrideException ex) {
|
||||
StringWriter description = new StringWriter();
|
||||
PrintWriter printer = new PrintWriter(description);
|
||||
printer.printf(
|
||||
"The bean '%s', defined in %s, could not be registered. A bean with that "
|
||||
+ "name has already been defined in %s and overriding is disabled.",
|
||||
ex.getBeanName(), ex.getBeanDefinition().getResourceDescription(),
|
||||
ex.getExistingDefinition().getResourceDescription());
|
||||
return description.toString();
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,92 @@
|
||||
/*
|
||||
* Copyright 2012-2018 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
|
||||
*
|
||||
* http://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.diagnostics.analyzer;
|
||||
|
||||
import org.junit.Test;
|
||||
|
||||
import org.springframework.beans.factory.support.BeanDefinitionOverrideException;
|
||||
import org.springframework.boot.diagnostics.FailureAnalysis;
|
||||
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
|
||||
import org.springframework.context.annotation.Bean;
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
import org.springframework.context.annotation.Import;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
|
||||
/**
|
||||
* Tests for {@link BeanDefinitionOverrideFailureAnalyzer}.
|
||||
*
|
||||
* @author Andy Wilkinson
|
||||
*/
|
||||
public class BeanDefinitionOverrideFailureAnalyzerTests {
|
||||
|
||||
@Test
|
||||
public void bindExceptionWithFieldErrorsDueToValidationFailure() {
|
||||
FailureAnalysis analysis = performAnalysis(BeanOverrideConfiguration.class);
|
||||
String description = analysis.getDescription();
|
||||
assertThat(description).contains("The bean 'testBean', defined in "
|
||||
+ SecondConfiguration.class.getName() + ", could not be registered.");
|
||||
assertThat(description).contains(FirstConfiguration.class.getName());
|
||||
}
|
||||
|
||||
private FailureAnalysis performAnalysis(Class<?> configuration) {
|
||||
BeanDefinitionOverrideException failure = createFailure(configuration);
|
||||
assertThat(failure).isNotNull();
|
||||
return new BeanDefinitionOverrideFailureAnalyzer().analyze(failure);
|
||||
}
|
||||
|
||||
private BeanDefinitionOverrideException createFailure(Class<?> configuration) {
|
||||
try {
|
||||
AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();
|
||||
context.setAllowBeanDefinitionOverriding(false);
|
||||
context.register(configuration);
|
||||
context.refresh();
|
||||
context.close();
|
||||
return null;
|
||||
}
|
||||
catch (BeanDefinitionOverrideException ex) {
|
||||
return ex;
|
||||
}
|
||||
}
|
||||
|
||||
@Configuration
|
||||
@Import({ FirstConfiguration.class, SecondConfiguration.class })
|
||||
static class BeanOverrideConfiguration {
|
||||
|
||||
}
|
||||
|
||||
@Configuration
|
||||
static class FirstConfiguration {
|
||||
|
||||
@Bean
|
||||
public String testBean() {
|
||||
return "test";
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@Configuration
|
||||
static class SecondConfiguration {
|
||||
|
||||
@Bean
|
||||
public String testBean() {
|
||||
return "test";
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
Loading…
Reference in New Issue