Madhura Bhave
8 years ago
parent
291b0c5fa7
commit
9ef3a448e6
@ -0,0 +1,116 @@
|
||||
/*
|
||||
* Copyright 2012-2017 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.util.List;
|
||||
|
||||
import org.springframework.boot.context.properties.bind.BindException;
|
||||
import org.springframework.boot.context.properties.bind.validation.BindValidationException;
|
||||
import org.springframework.boot.diagnostics.AbstractFailureAnalyzer;
|
||||
import org.springframework.boot.diagnostics.FailureAnalysis;
|
||||
import org.springframework.boot.origin.Origin;
|
||||
import org.springframework.validation.FieldError;
|
||||
import org.springframework.validation.ObjectError;
|
||||
|
||||
/**
|
||||
* An {@link AbstractFailureAnalyzer} that performs analysis of any bind validation failures
|
||||
* caused by {@link BindValidationException} or {@link org.springframework.validation.BindException}.
|
||||
*
|
||||
* @author Madhura Bhave
|
||||
*/
|
||||
public class BindValidationFailureAnalyzer extends AbstractFailureAnalyzer<Throwable> {
|
||||
|
||||
@Override
|
||||
protected FailureAnalysis analyze(Throwable rootFailure, Throwable cause) {
|
||||
ExceptionDetails details = getBindValidationExceptionDetails(rootFailure);
|
||||
if (details == null) {
|
||||
return null;
|
||||
}
|
||||
return analyzeBindValidationException(details);
|
||||
}
|
||||
|
||||
private ExceptionDetails getBindValidationExceptionDetails(Throwable rootFailure) {
|
||||
BindValidationException validationException = findCause(rootFailure, BindValidationException.class);
|
||||
if (validationException != null) {
|
||||
BindException target = findCause(rootFailure, BindException.class);
|
||||
List<ObjectError> errors = validationException.getValidationErrors().getAllErrors();
|
||||
return new ExceptionDetails(errors, target, validationException);
|
||||
}
|
||||
org.springframework.validation.BindException bindException = findCause(rootFailure, org.springframework.validation.BindException.class);
|
||||
if (bindException != null) {
|
||||
List<ObjectError> errors = bindException.getAllErrors();
|
||||
return new ExceptionDetails(errors, bindException.getTarget(), bindException);
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
private FailureAnalysis analyzeBindValidationException(ExceptionDetails details) {
|
||||
StringBuilder description = new StringBuilder(
|
||||
String.format("Binding to target %s failed:%n", details.getTarget()));
|
||||
for (ObjectError error : details.getErrors()) {
|
||||
if (error instanceof FieldError) {
|
||||
appendFieldError(description, (FieldError) error);
|
||||
}
|
||||
description.append(
|
||||
String.format("%n Reason: %s%n", error.getDefaultMessage()));
|
||||
}
|
||||
return getFailureAnalysis(description, details.getCause());
|
||||
}
|
||||
|
||||
private void appendFieldError(StringBuilder description, FieldError error) {
|
||||
Origin origin = Origin.from(error);
|
||||
description.append(String.format("%n Property: %s",
|
||||
error.getObjectName() + "." + error.getField()));
|
||||
description.append(String.format("%n Value: %s", error.getRejectedValue()));
|
||||
if (origin != null) {
|
||||
description.append(String.format("%n Origin: %s", origin));
|
||||
}
|
||||
}
|
||||
|
||||
private FailureAnalysis getFailureAnalysis(Object description, Throwable cause) {
|
||||
return new FailureAnalysis(description.toString(),
|
||||
"Update your application's configuration", cause);
|
||||
}
|
||||
|
||||
private static class ExceptionDetails {
|
||||
|
||||
private List<ObjectError> errors;
|
||||
|
||||
private Object target;
|
||||
|
||||
private Throwable cause;
|
||||
|
||||
ExceptionDetails(List<ObjectError> errors, Object target, Throwable cause) {
|
||||
this.errors = errors;
|
||||
this.target = target;
|
||||
this.cause = cause;
|
||||
}
|
||||
|
||||
public Object getTarget() {
|
||||
return this.target;
|
||||
}
|
||||
|
||||
public List<ObjectError> getErrors() {
|
||||
return this.errors;
|
||||
}
|
||||
|
||||
public Throwable getCause() {
|
||||
return this.cause;
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,64 @@
|
||||
/*
|
||||
* Copyright 2012-2017 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.springframework.boot.context.properties.bind.BindException;
|
||||
import org.springframework.boot.context.properties.bind.UnboundConfigurationPropertiesException;
|
||||
import org.springframework.boot.context.properties.source.ConfigurationProperty;
|
||||
import org.springframework.boot.diagnostics.AbstractFailureAnalyzer;
|
||||
import org.springframework.boot.diagnostics.FailureAnalysis;
|
||||
|
||||
/**
|
||||
* An {@link AbstractFailureAnalyzer} that performs analysis of failures caused by any
|
||||
* {@link UnboundConfigurationPropertiesException}.
|
||||
*
|
||||
* @author Madhura Bhave
|
||||
*/
|
||||
public class UnboundConfigurationPropertyFailureAnalyzer extends AbstractFailureAnalyzer<UnboundConfigurationPropertiesException> {
|
||||
|
||||
@Override
|
||||
protected FailureAnalysis analyze(Throwable rootFailure, UnboundConfigurationPropertiesException cause) {
|
||||
BindException exception = findCause(rootFailure, BindException.class);
|
||||
return analyzeUnboundConfigurationPropertiesException(exception, cause);
|
||||
}
|
||||
|
||||
private FailureAnalysis analyzeUnboundConfigurationPropertiesException(
|
||||
BindException cause, UnboundConfigurationPropertiesException exception) {
|
||||
StringBuilder description = new StringBuilder(
|
||||
String.format("Binding to target %s failed:%n", cause.getTarget()));
|
||||
for (ConfigurationProperty property : exception.getUnboundProperties()) {
|
||||
buildDescription(description, property);
|
||||
description.append(String.format("%n Reason: %s", exception.getMessage()));
|
||||
}
|
||||
return getFailureAnalysis(description, cause);
|
||||
}
|
||||
|
||||
private void buildDescription(StringBuilder description,
|
||||
ConfigurationProperty property) {
|
||||
if (property != null) {
|
||||
description.append(String.format("%n Property: %s", property.getName()));
|
||||
description.append(String.format("%n Value: %s", property.getValue()));
|
||||
description.append(String.format("%n Origin: %s", property.getOrigin()));
|
||||
}
|
||||
}
|
||||
|
||||
private FailureAnalysis getFailureAnalysis(Object description, BindException cause) {
|
||||
return new FailureAnalysis(description.toString(),
|
||||
"Update your application's configuration", cause);
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,221 @@
|
||||
/*
|
||||
* Copyright 2012-2017 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.util.HashMap;
|
||||
import java.util.Locale;
|
||||
import java.util.Map;
|
||||
|
||||
import javax.validation.Valid;
|
||||
import javax.validation.constraints.Min;
|
||||
import javax.validation.constraints.NotNull;
|
||||
|
||||
import org.junit.After;
|
||||
import org.junit.Before;
|
||||
import org.junit.Test;
|
||||
|
||||
import org.springframework.beans.factory.BeanCreationException;
|
||||
import org.springframework.boot.context.properties.ConfigurationProperties;
|
||||
import org.springframework.boot.context.properties.EnableConfigurationProperties;
|
||||
import org.springframework.boot.diagnostics.FailureAnalysis;
|
||||
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
|
||||
import org.springframework.context.i18n.LocaleContextHolder;
|
||||
import org.springframework.core.env.MapPropertySource;
|
||||
import org.springframework.core.env.MutablePropertySources;
|
||||
import org.springframework.validation.BindException;
|
||||
import org.springframework.validation.Errors;
|
||||
import org.springframework.validation.FieldError;
|
||||
import org.springframework.validation.Validator;
|
||||
import org.springframework.validation.annotation.Validated;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
|
||||
/**
|
||||
* Tests for {@link BindValidationFailureAnalyzer}.
|
||||
*
|
||||
* @author Madhura Bhave
|
||||
*/
|
||||
public class BindValidationFailureAnalyzerTests {
|
||||
|
||||
@Before
|
||||
public void setup() {
|
||||
LocaleContextHolder.setLocale(Locale.US);
|
||||
}
|
||||
|
||||
@After
|
||||
public void cleanup() {
|
||||
LocaleContextHolder.resetLocaleContext();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void bindExceptionWithFieldErrorsDueToValidationFailure() {
|
||||
FailureAnalysis analysis = performAnalysis(
|
||||
FieldValidationFailureConfiguration.class);
|
||||
assertThat(analysis.getDescription())
|
||||
.contains(failure("test.foo.foo", "null", "may not be null"));
|
||||
assertThat(analysis.getDescription())
|
||||
.contains(failure("test.foo.value", "0", "at least five"));
|
||||
assertThat(analysis.getDescription())
|
||||
.contains(failure("test.foo.nested.bar", "null", "may not be null"));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void bindExceptionWithOriginDueToValidationFailure() throws Exception {
|
||||
FailureAnalysis analysis = performAnalysis(
|
||||
FieldValidationFailureConfiguration.class, "test.foo.value=4");
|
||||
assertThat(analysis.getDescription())
|
||||
.contains("Origin: \"test.foo.value\" from property source \"test\"");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void bindExceptionWithObjectErrorsDueToValidationFailure() throws Exception {
|
||||
FailureAnalysis analysis = performAnalysis(
|
||||
ObjectValidationFailureConfiguration.class);
|
||||
assertThat(analysis.getDescription())
|
||||
.contains("Reason: This object could not be bound.");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void otherBindExceptionShouldReturnAnalysis() throws Exception {
|
||||
BindException cause = new BindException(new FieldValidationFailureProperties(), "fieldValidationFailureProperties");
|
||||
cause.addError(new FieldError("test", "value", "may not be null"));
|
||||
BeanCreationException rootFailure = new BeanCreationException("bean creation failure", cause);
|
||||
FailureAnalysis analysis = new BindValidationFailureAnalyzer().analyze(rootFailure, rootFailure);
|
||||
assertThat(analysis.getDescription())
|
||||
.contains(failure("test.value", "null", "may not be null"));
|
||||
}
|
||||
|
||||
private static String failure(String property, String value, String reason) {
|
||||
return String.format("Property: %s%n Value: %s%n Reason: %s", property,
|
||||
value, reason);
|
||||
}
|
||||
|
||||
private FailureAnalysis performAnalysis(Class<?> configuration,
|
||||
String... environment) {
|
||||
BeanCreationException failure = createFailure(configuration, environment);
|
||||
assertThat(failure).isNotNull();
|
||||
return new BindValidationFailureAnalyzer().analyze(failure);
|
||||
}
|
||||
|
||||
private BeanCreationException createFailure(Class<?> configuration,
|
||||
String... environment) {
|
||||
try {
|
||||
AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();
|
||||
addEnvironment(context, environment);
|
||||
context.register(configuration);
|
||||
context.refresh();
|
||||
context.close();
|
||||
return null;
|
||||
}
|
||||
catch (BeanCreationException ex) {
|
||||
return ex;
|
||||
}
|
||||
}
|
||||
|
||||
private void addEnvironment(AnnotationConfigApplicationContext context,
|
||||
String[] environment) {
|
||||
MutablePropertySources sources = context.getEnvironment().getPropertySources();
|
||||
Map<String, Object> map = new HashMap<>();
|
||||
for (String pair : environment) {
|
||||
int index = pair.indexOf("=");
|
||||
String key = pair.substring(0, index > 0 ? index : pair.length());
|
||||
String value = index > 0 ? pair.substring(index + 1) : "";
|
||||
map.put(key.trim(), value.trim());
|
||||
}
|
||||
sources.addFirst(new MapPropertySource("test", map));
|
||||
}
|
||||
|
||||
@EnableConfigurationProperties(FieldValidationFailureProperties.class)
|
||||
static class FieldValidationFailureConfiguration {
|
||||
|
||||
}
|
||||
|
||||
@EnableConfigurationProperties(ObjectErrorFailureProperties.class)
|
||||
static class ObjectValidationFailureConfiguration {
|
||||
|
||||
}
|
||||
|
||||
@ConfigurationProperties("test.foo")
|
||||
@Validated
|
||||
static class FieldValidationFailureProperties {
|
||||
|
||||
@NotNull
|
||||
private String foo;
|
||||
|
||||
@Min(value = 5, message = "at least five")
|
||||
private int value;
|
||||
|
||||
@Valid
|
||||
private FieldValidationFailureProperties.Nested nested = new FieldValidationFailureProperties.Nested();
|
||||
|
||||
public String getFoo() {
|
||||
return this.foo;
|
||||
}
|
||||
|
||||
public void setFoo(String foo) {
|
||||
this.foo = foo;
|
||||
}
|
||||
|
||||
public int getValue() {
|
||||
return this.value;
|
||||
}
|
||||
|
||||
public void setValue(int value) {
|
||||
this.value = value;
|
||||
}
|
||||
|
||||
public FieldValidationFailureProperties.Nested getNested() {
|
||||
return this.nested;
|
||||
}
|
||||
|
||||
public void setNested(FieldValidationFailureProperties.Nested nested) {
|
||||
this.nested = nested;
|
||||
}
|
||||
|
||||
static class Nested {
|
||||
|
||||
@NotNull
|
||||
private String bar;
|
||||
|
||||
public String getBar() {
|
||||
return this.bar;
|
||||
}
|
||||
|
||||
public void setBar(String bar) {
|
||||
this.bar = bar;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@ConfigurationProperties("foo.bar")
|
||||
@Validated
|
||||
static class ObjectErrorFailureProperties implements Validator {
|
||||
|
||||
@Override
|
||||
public void validate(Object target, Errors errors) {
|
||||
errors.reject("my.objectError", "This object could not be bound.");
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean supports(Class<?> clazz) {
|
||||
return true;
|
||||
}
|
||||
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,127 @@
|
||||
/*
|
||||
* Copyright 2012-2017 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.util.HashMap;
|
||||
import java.util.List;
|
||||
import java.util.Locale;
|
||||
import java.util.Map;
|
||||
|
||||
import org.junit.After;
|
||||
import org.junit.Before;
|
||||
import org.junit.Test;
|
||||
|
||||
import org.springframework.beans.factory.BeanCreationException;
|
||||
import org.springframework.boot.context.properties.ConfigurationProperties;
|
||||
import org.springframework.boot.context.properties.EnableConfigurationProperties;
|
||||
import org.springframework.boot.diagnostics.FailureAnalysis;
|
||||
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
|
||||
import org.springframework.context.i18n.LocaleContextHolder;
|
||||
import org.springframework.core.env.MapPropertySource;
|
||||
import org.springframework.core.env.MutablePropertySources;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
|
||||
/**
|
||||
* Tests for {@link UnboundConfigurationPropertyFailureAnalyzer}.
|
||||
*
|
||||
* @author Madhura Bhave
|
||||
*/
|
||||
public class UnboundConfigurationPropertyFailureAnalyzerTests {
|
||||
|
||||
@Before
|
||||
public void setup() {
|
||||
LocaleContextHolder.setLocale(Locale.US);
|
||||
}
|
||||
|
||||
@After
|
||||
public void cleanup() {
|
||||
LocaleContextHolder.resetLocaleContext();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void bindExceptionDueToUnboundElements() throws Exception {
|
||||
FailureAnalysis analysis = performAnalysis(
|
||||
UnboundElementsFailureConfiguration.class, "test.foo.listValue[0]=hello",
|
||||
"test.foo.listValue[2]=world");
|
||||
assertThat(analysis.getDescription()).contains(failure("test.foo.listvalue[2]",
|
||||
"world", "\"test.foo.listValue[2]\" from property source \"test\"",
|
||||
"The elements [test.foo.listvalue[2]] were left unbound."));
|
||||
}
|
||||
|
||||
private static String failure(String property, String value, String origin,
|
||||
String reason) {
|
||||
return String.format(
|
||||
"Property: %s%n Value: %s%n Origin: %s%n Reason: %s", property,
|
||||
value, origin, reason);
|
||||
}
|
||||
|
||||
private FailureAnalysis performAnalysis(Class<?> configuration,
|
||||
String... environment) {
|
||||
BeanCreationException failure = createFailure(configuration, environment);
|
||||
assertThat(failure).isNotNull();
|
||||
return new UnboundConfigurationPropertyFailureAnalyzer().analyze(failure);
|
||||
}
|
||||
|
||||
private BeanCreationException createFailure(Class<?> configuration,
|
||||
String... environment) {
|
||||
try {
|
||||
AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();
|
||||
addEnvironment(context, environment);
|
||||
context.register(configuration);
|
||||
context.refresh();
|
||||
context.close();
|
||||
return null;
|
||||
}
|
||||
catch (BeanCreationException ex) {
|
||||
return ex;
|
||||
}
|
||||
}
|
||||
|
||||
private void addEnvironment(AnnotationConfigApplicationContext context,
|
||||
String[] environment) {
|
||||
MutablePropertySources sources = context.getEnvironment().getPropertySources();
|
||||
Map<String, Object> map = new HashMap<>();
|
||||
for (String pair : environment) {
|
||||
int index = pair.indexOf("=");
|
||||
String key = pair.substring(0, index > 0 ? index : pair.length());
|
||||
String value = index > 0 ? pair.substring(index + 1) : "";
|
||||
map.put(key.trim(), value.trim());
|
||||
}
|
||||
sources.addFirst(new MapPropertySource("test", map));
|
||||
}
|
||||
|
||||
@EnableConfigurationProperties(UnboundElementsFailureProperties.class)
|
||||
static class UnboundElementsFailureConfiguration {
|
||||
|
||||
}
|
||||
|
||||
@ConfigurationProperties("test.foo")
|
||||
static class UnboundElementsFailureProperties {
|
||||
|
||||
private List<String> listValue;
|
||||
|
||||
public List<String> getListValue() {
|
||||
return this.listValue;
|
||||
}
|
||||
|
||||
public void setListValue(List<String> listValue) {
|
||||
this.listValue = listValue;
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
Loading…
Reference in New Issue