root
/
spring-boot
mirror of https://github.com/spring-projects/spring-boot.git
1
0
Fork 0
Code Issues Actions 15 Packages Projects Releases Wiki Activity

Clean endpointIds in generated metadata 

Closes gh-11107
This commit is contained in:
Stephane Nicoll 2017-12-13 10:18:08 +01:00
parent 7f2af8b209
commit b6aa0f24e2
6 changed files with 113 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/ConfigurationMetadataAnnotationProcessor.java
View File

@ -416,23 +416,21 @@ public class ConfigurationMetadataAnnotationProcessor extends AbstractProcessor
if (endpointId == null || "".equals(endpointId)) {
return; // Can't process that endpoint
}
String endpointKey = ItemMetadata.newItemMetadataPrefix(
"management.endpoint.", endpointId);
Boolean enabledByDefault = (Boolean) elementValues.get("enableByDefault");
String type = this.typeUtils.getQualifiedName(element);
this.metadataCollector
.add(ItemMetadata.newGroup(endpointKey(endpointId), type, type, null));
this.metadataCollector.add(ItemMetadata.newProperty(endpointKey(endpointId),
.add(ItemMetadata.newGroup(endpointKey, type, type, null));
this.metadataCollector.add(ItemMetadata.newProperty(endpointKey,
"enabled", Boolean.class.getName(), type, null,
String.format("Whether to enable the %s endpoint.", endpointId),
(enabledByDefault == null ? true : enabledByDefault), null));
this.metadataCollector.add(ItemMetadata.newProperty(endpointKey(endpointId),
this.metadataCollector.add(ItemMetadata.newProperty(endpointKey,
"cache.time-to-live", Duration.class.getName(), type, null,
"Maximum time that a response can be cached.", 0, null));
}
private String endpointKey(String suffix) {
return "management.endpoint." + suffix;
}
private boolean isNested(Element returnType, VariableElement field,
TypeElement element) {
if (hasAnnotation(field, nestedConfigurationPropertyAnnotation())) {

3
spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/metadata/ConfigurationMetadata.java
View File

@ -22,6 +22,7 @@ import java.util.Collections;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Set;
@ -191,7 +192,7 @@ public class ConfigurationMetadata {
previous = current;
}
return dashed.toString().toLowerCase();
return dashed.toString().toLowerCase(Locale.ENGLISH);
}
private static <T extends Comparable<T>> List<T> flattenValues(Map<?, List<T>> map) {

7
spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/metadata/ItemMetadata.java
View File

@ -16,6 +16,8 @@
package org.springframework.boot.configurationprocessor.metadata;
import java.util.Locale;
/**
* A group or property meta-data item from some {@link ConfigurationMetadata}.
*
@ -215,6 +217,11 @@ public final class ItemMetadata implements Comparable<ItemMetadata> {
sourceMethod, description, defaultValue, deprecation);
}
public static String newItemMetadataPrefix(String prefix, String suffix) {
return prefix.toLowerCase(Locale.ENGLISH) +
ConfigurationMetadata.toDashedCase(suffix);
}
/**
* The item type.
*/

22
spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationprocessor/ConfigurationMetadataAnnotationProcessorTests.java
View File

@ -37,6 +37,7 @@ import org.springframework.boot.configurationprocessor.metadata.ItemHint;
import org.springframework.boot.configurationprocessor.metadata.ItemMetadata;
import org.springframework.boot.configurationprocessor.metadata.Metadata;
import org.springframework.boot.configurationprocessor.metadata.TestJsonConverter;
import org.springframework.boot.configurationsample.endpoint.CamelCaseEndpoint;
import org.springframework.boot.configurationsample.endpoint.CustomPropertiesEndpoint;
import org.springframework.boot.configurationsample.endpoint.DisabledEndpoint;
import org.springframework.boot.configurationsample.endpoint.EnabledEndpoint;
@ -583,6 +584,16 @@ public class ConfigurationMetadataAnnotationProcessorTests {
assertThat(metadata.getItems()).hasSize(3);
}
@Test
public void camelCaseEndpoint() {
ConfigurationMetadata metadata = compile(CamelCaseEndpoint.class);
assertThat(metadata).has(Metadata.withGroup("management.endpoint.pascal-case")
.fromSource(CamelCaseEndpoint.class));
assertThat(metadata).has(enabledFlag("PascalCase", "pascal-case", true));
assertThat(metadata).has(cacheTtl("pascal-case"));
assertThat(metadata.getItems()).hasSize(3);
}
@Test
public void incrementalEndpointBuildChangeGeneralEnabledFlag() throws Exception {
TestProject project = new TestProject(this.temporaryFolder,
@ -623,11 +634,16 @@ public class ConfigurationMetadataAnnotationProcessorTests {
assertThat(metadata.getItems()).hasSize(3);
}
private Metadata.MetadataItemCondition enabledFlag(String endpointId,
String endpointSuffix, Boolean defaultValue) {
return Metadata.withEnabledFlag("management.endpoint." + endpointSuffix
+ ".enabled").withDefaultValue(defaultValue).withDescription(
String.format("Whether to enable the %s endpoint.", endpointId));
}
private Metadata.MetadataItemCondition enabledFlag(String endpointId,
Boolean defaultValue) {
return Metadata.withEnabledFlag("management.endpoint." + endpointId + ".enabled")
.withDefaultValue(defaultValue).withDescription(
String.format("Whether to enable the %s endpoint.", endpointId));
return enabledFlag(endpointId, endpointId, defaultValue);
}
private Metadata.MetadataItemCondition cacheTtl(String endpointId) {

51
spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationprocessor/metadata/ItemMetadataTests.java Normal file
View File

@ -0,0 +1,51 @@
/*
* 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.configurationprocessor.metadata;
import org.junit.Test;
import static org.assertj.core.api.Assertions.assertThat;
/**
* Tests for {@link ItemMetadata}.
*
* @author Stephane Nicoll
*/
public class ItemMetadataTests {
@Test
public void newItemMetadataPrefixWithUpperCasePrefix() {
assertThat(newItemMetadataPrefix("Prefix.", "value")).isEqualTo("prefix.value");
}
@Test
public void newItemMetadataPrefixWithCamelCaseSuffix() {
assertThat(newItemMetadataPrefix("prefix.", "myValue"))
.isEqualTo("prefix.my-value");
}
@Test
public void newItemMetadataPrefixWithUpperCamelCaseSuffix() {
assertThat(newItemMetadataPrefix("prefix.", "MyValue"))
.isEqualTo("prefix.my-value");
}
private String newItemMetadataPrefix(String prefix, String suffix) {
return ItemMetadata.newItemMetadataPrefix(prefix, suffix);
}
}

29
spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/endpoint/CamelCaseEndpoint.java Normal file
View File

@ -0,0 +1,29 @@
/*
* 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.configurationsample.endpoint;
import org.springframework.boot.configurationsample.Endpoint;
/**
* An endpoint with a upper camel case id.
*
* @author Stephane Nicoll
*/
@Endpoint(id = "PascalCase")
public class CamelCaseEndpoint {
}