Madhura Bhave
7 years ago
parent
c40668ecbd
commit
b19b515549
@ -0,0 +1,49 @@
|
||||
/*
|
||||
* 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.context.properties.source;
|
||||
|
||||
import java.util.List;
|
||||
|
||||
/**
|
||||
* Exception thrown when {@link ConfigurationPropertyName} has invalid
|
||||
* characters.
|
||||
*
|
||||
* @author Madhura Bhave
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public class InvalidConfigurationPropertyNameException extends RuntimeException {
|
||||
|
||||
private final List<Character> invalidCharacters;
|
||||
|
||||
private final CharSequence name;
|
||||
|
||||
public InvalidConfigurationPropertyNameException(List<Character> invalidCharacters, CharSequence name) {
|
||||
super("Configuration property name '" + name + "' is not valid");
|
||||
this.invalidCharacters = invalidCharacters;
|
||||
this.name = name;
|
||||
}
|
||||
|
||||
public List<Character> getInvalidCharacters() {
|
||||
return this.invalidCharacters;
|
||||
}
|
||||
|
||||
public CharSequence getName() {
|
||||
return this.name;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@ -0,0 +1,57 @@
|
||||
/*
|
||||
* 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.stream.Collectors;
|
||||
|
||||
import org.springframework.beans.factory.BeanCreationException;
|
||||
import org.springframework.boot.context.properties.source.InvalidConfigurationPropertyNameException;
|
||||
import org.springframework.boot.diagnostics.AbstractFailureAnalyzer;
|
||||
import org.springframework.boot.diagnostics.FailureAnalysis;
|
||||
|
||||
/**
|
||||
* An {@link AbstractFailureAnalyzer} that performs analysis of failures
|
||||
* caused by {@link InvalidConfigurationPropertyNameException}.
|
||||
*
|
||||
* @author Madhura Bhave
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public class InvalidConfigurationPropertyNameFailureAnalyzer extends AbstractFailureAnalyzer<InvalidConfigurationPropertyNameException> {
|
||||
|
||||
@Override
|
||||
protected FailureAnalysis analyze(Throwable rootFailure, InvalidConfigurationPropertyNameException cause) {
|
||||
BeanCreationException exception = findCause(rootFailure, BeanCreationException.class);
|
||||
String description = buildDescription(cause, exception);
|
||||
String action = String.format("Modify '%s' so that it conforms to the canonical names requirements.", cause.getName());
|
||||
return new FailureAnalysis(description, action, cause);
|
||||
}
|
||||
|
||||
private String buildDescription(InvalidConfigurationPropertyNameException cause, BeanCreationException exception) {
|
||||
StringBuilder description = new StringBuilder(
|
||||
String.format("Configuration property name '%s' is not valid:%n", cause.getName()));
|
||||
String invalid = cause.getInvalidCharacters().stream().map(c -> "'" + c.toString() + "'").collect(Collectors.joining(","));
|
||||
description.append(String.format("%n Invalid characters: %s", invalid));
|
||||
if (exception != null) {
|
||||
description.append(String.format("%n Bean: %s", exception.getBeanName()));
|
||||
}
|
||||
description.append(String.format("%n Reason: Canonical names should be kebab-case('-' separated), lowercase alpha-numeric characters" +
|
||||
" and must start with a letter"));
|
||||
return description.toString();
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@ -0,0 +1,86 @@
|
||||
/*
|
||||
* 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.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.annotation.Bean;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
|
||||
/**
|
||||
* Tests for {@link InvalidConfigurationPropertyNameFailureAnalyzer}.
|
||||
*
|
||||
* @author Madhura Bhave
|
||||
*/
|
||||
public class InvalidConfigurationPropertyNameFailureAnalyzerTests {
|
||||
|
||||
private InvalidConfigurationPropertyNameFailureAnalyzer analyzer = new InvalidConfigurationPropertyNameFailureAnalyzer();
|
||||
|
||||
@Test
|
||||
public void analysisWhenRootCauseIsBeanCreationFailureShouldContainBeanName() throws Exception {
|
||||
BeanCreationException failure = createFailure(InvalidPrefixConfiguration.class);
|
||||
FailureAnalysis analysis = this.analyzer.analyze(failure);
|
||||
assertThat(analysis.getDescription()).contains(String.format(
|
||||
"%n Invalid characters: %s%n Bean: %s%n Reason: %s",
|
||||
"'F','P'", "invalidPrefixProperties", "Canonical names should be kebab-case('-' separated), " +
|
||||
"lowercase alpha-numeric characters and must start with a letter"));
|
||||
}
|
||||
|
||||
private BeanCreationException createFailure(Class<?> configuration) {
|
||||
try {
|
||||
AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();
|
||||
context.register(configuration);
|
||||
context.refresh();
|
||||
context.close();
|
||||
return null;
|
||||
}
|
||||
catch (BeanCreationException ex) {
|
||||
return ex;
|
||||
}
|
||||
}
|
||||
|
||||
@EnableConfigurationProperties(InvalidPrefixProperties.class)
|
||||
static class InvalidPrefixConfiguration {
|
||||
|
||||
@Bean(name = "invalidPrefixProperties")
|
||||
public InvalidPrefixProperties invalidPrefixProperties() {
|
||||
return new InvalidPrefixProperties();
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@ConfigurationProperties("FooPrefix")
|
||||
static class InvalidPrefixProperties {
|
||||
|
||||
private String value;
|
||||
|
||||
public String getValue() {
|
||||
return this.value;
|
||||
}
|
||||
|
||||
public void setValue(String value) {
|
||||
this.value = value;
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
Loading…
Reference in New Issue