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

Merge branch '2.1.x'

Browse Source 
Closes gh-17079
This commit is contained in:
Andy Wilkinson
2019-06-07 11:00:44 +01:00
parent 5b2de5c81d 24925c3dae
commit aef92b9295
2799 changed files with 28402 additions and 47836 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/main/java/org/springframework/boot/configurationdocs/CompoundConfigurationTableEntry.java
View File

@@ -40,8 +40,7 @@ class CompoundConfigurationTableEntry extends ConfigurationTableEntry {
}
void addConfigurationKeys(ConfigurationMetadataProperty... properties) {
Stream.of(properties).map(ConfigurationMetadataProperty::getId)
.forEach(this.configurationKeys::add);
Stream.of(properties).map(ConfigurationMetadataProperty::getId).forEach(this.configurationKeys::add);
}
@Override

62
spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/main/java/org/springframework/boot/configurationdocs/ConfigurationMetadataDocumentWriter.java
View File

@@ -38,15 +38,14 @@ import org.springframework.boot.configurationmetadata.ConfigurationMetadataRepos
*/
public class ConfigurationMetadataDocumentWriter {
public void writeDocument(Path outputDirectory, DocumentOptions options,
InputStream... metadata) throws IOException {
public void writeDocument(Path outputDirectory, DocumentOptions options, InputStream... metadata)
throws IOException {
assertValidOutputDirectory(outputDirectory);
if (!Files.exists(outputDirectory)) {
Files.createDirectory(outputDirectory);
}
assertMetadata(metadata);
List<ConfigurationTable> tables = createConfigTables(
getMetadataProperties(metadata), options);
List<ConfigurationTable> tables = createConfigTables(getMetadataProperties(metadata), options);
for (ConfigurationTable table : tables) {
writeConfigurationTable(table, outputDirectory);
}
@@ -57,8 +56,7 @@ public class ConfigurationMetadataDocumentWriter {
throw new IllegalArgumentException("output path should not be null");
}
if (Files.exists(outputDirPath) && !Files.isDirectory(outputDirPath)) {
throw new IllegalArgumentException(
"output path already exists and is not a directory");
throw new IllegalArgumentException("output path already exists and is not a directory");
}
}
@@ -68,47 +66,40 @@ public class ConfigurationMetadataDocumentWriter {
}
}
private Map<String, ConfigurationMetadataProperty> getMetadataProperties(
InputStream... metadata) throws IOException {
private Map<String, ConfigurationMetadataProperty> getMetadataProperties(InputStream... metadata)
throws IOException {
ConfigurationMetadataRepositoryJsonBuilder builder = ConfigurationMetadataRepositoryJsonBuilder
.create(metadata);
return builder.build().getAllProperties();
}
private List<ConfigurationTable> createConfigTables(
Map<String, ConfigurationMetadataProperty> metadataProperties,
private List<ConfigurationTable> createConfigTables(Map<String, ConfigurationMetadataProperty> metadataProperties,
DocumentOptions options) {
List<ConfigurationTable> tables = new ArrayList<>();
List<String> unmappedKeys = metadataProperties.values().stream()
.filter((property) -> !property.isDeprecated())
List<String> unmappedKeys = metadataProperties.values().stream().filter((property) -> !property.isDeprecated())
.map(ConfigurationMetadataProperty::getId).collect(Collectors.toList());
Map<String, CompoundConfigurationTableEntry> overrides = getOverrides(
metadataProperties, unmappedKeys, options);
options.getMetadataSections().forEach(
(id, keyPrefixes) -> tables.add(createConfigTable(metadataProperties,
unmappedKeys, overrides, id, keyPrefixes)));
Map<String, CompoundConfigurationTableEntry> overrides = getOverrides(metadataProperties, unmappedKeys,
options);
options.getMetadataSections().forEach((id, keyPrefixes) -> tables
.add(createConfigTable(metadataProperties, unmappedKeys, overrides, id, keyPrefixes)));
if (!unmappedKeys.isEmpty()) {
throw new IllegalStateException(
"The following keys were not written to the documentation: "
+ String.join(", ", unmappedKeys));
"The following keys were not written to the documentation: " + String.join(", ", unmappedKeys));
}
if (!overrides.isEmpty()) {
throw new IllegalStateException(
"The following keys were not written to the documentation: "
+ String.join(", ", overrides.keySet()));
throw new IllegalStateException("The following keys were not written to the documentation: "
+ String.join(", ", overrides.keySet()));
}
return tables;
}
private Map<String, CompoundConfigurationTableEntry> getOverrides(
Map<String, ConfigurationMetadataProperty> metadataProperties,
List<String> unmappedKeys, DocumentOptions options) {
Map<String, ConfigurationMetadataProperty> metadataProperties, List<String> unmappedKeys,
DocumentOptions options) {
Map<String, CompoundConfigurationTableEntry> overrides = new HashMap<>();
options.getOverrides().forEach((keyPrefix, description) -> {
CompoundConfigurationTableEntry entry = new CompoundConfigurationTableEntry(
keyPrefix, description);
List<String> matchingKeys = unmappedKeys.stream()
.filter((key) -> key.startsWith(keyPrefix))
CompoundConfigurationTableEntry entry = new CompoundConfigurationTableEntry(keyPrefix, description);
List<String> matchingKeys = unmappedKeys.stream().filter((key) -> key.startsWith(keyPrefix))
.collect(Collectors.toList());
for (String matchingKey : matchingKeys) {
entry.addConfigurationKeys(metadataProperties.get(matchingKey));
@@ -119,21 +110,17 @@ public class ConfigurationMetadataDocumentWriter {
return overrides;
}
private ConfigurationTable createConfigTable(
Map<String, ConfigurationMetadataProperty> metadataProperties,
List<String> unmappedKeys,
Map<String, CompoundConfigurationTableEntry> overrides, String id,
private ConfigurationTable createConfigTable(Map<String, ConfigurationMetadataProperty> metadataProperties,
List<String> unmappedKeys, Map<String, CompoundConfigurationTableEntry> overrides, String id,
List<String> keyPrefixes) {
ConfigurationTable table = new ConfigurationTable(id);
for (String keyPrefix : keyPrefixes) {
List<String> matchingOverrides = overrides.keySet().stream()
.filter((overrideKey) -> overrideKey.startsWith(keyPrefix))
.collect(Collectors.toList());
.filter((overrideKey) -> overrideKey.startsWith(keyPrefix)).collect(Collectors.toList());
matchingOverrides.forEach((match) -> table.addEntry(overrides.remove(match)));
}
List<String> matchingKeys = unmappedKeys.stream()
.filter((key) -> keyPrefixes.stream().anyMatch(key::startsWith))
.collect(Collectors.toList());
.filter((key) -> keyPrefixes.stream().anyMatch(key::startsWith)).collect(Collectors.toList());
for (String matchingKey : matchingKeys) {
ConfigurationMetadataProperty property = metadataProperties.get(matchingKey);
table.addEntry(new SingleConfigurationTableEntry(property));
@@ -142,8 +129,7 @@ public class ConfigurationMetadataDocumentWriter {
return table;
}
private void writeConfigurationTable(ConfigurationTable table, Path outputDirectory)
throws IOException {
private void writeConfigurationTable(ConfigurationTable table, Path outputDirectory) throws IOException {
Path outputFilePath = outputDirectory.resolve(table.getId() + ".adoc");
Files.deleteIfExists(outputFilePath);
Files.createFile(outputFilePath);

3
spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/main/java/org/springframework/boot/configurationdocs/DocumentOptions.java
View File

@@ -32,8 +32,7 @@ public final class DocumentOptions {
private final Map<String, String> overrides;
private DocumentOptions(Map<String, List<String>> metadataSections,
Map<String, String> overrides) {
private DocumentOptions(Map<String, List<String>> metadataSections, Map<String, String> overrides) {
this.metadataSections = metadataSections;
this.overrides = overrides;
}

6
spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/main/java/org/springframework/boot/configurationdocs/SingleConfigurationTableEntry.java
View File

@@ -34,8 +34,7 @@ class SingleConfigurationTableEntry extends ConfigurationTableEntry {
SingleConfigurationTableEntry(ConfigurationMetadataProperty property) {
this.key = property.getId();
if (property.getType() != null
&& property.getType().startsWith("java.util.Map")) {
if (property.getType() != null && property.getType().startsWith("java.util.Map")) {
this.key += ".*";
}
this.description = property.getDescription();
@@ -63,8 +62,7 @@ class SingleConfigurationTableEntry extends ConfigurationTableEntry {
private void writeDefaultValue(AsciidocBuilder builder) {
String defaultValue = (this.defaultValue != null) ? this.defaultValue : "";
defaultValue = defaultValue.replace("\\", "\\\\").replace("|",
"{vbar}" + System.lineSeparator());
defaultValue = defaultValue.replace("\\", "\\\\").replace("|", "{vbar}" + System.lineSeparator());
if (defaultValue.isEmpty()) {
builder.appendln("|");
}

9
spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/test/java/org/springframework/boot/configurationdocs/CompoundConfigurationTableEntryTests.java
View File

@@ -42,15 +42,14 @@ public class CompoundConfigurationTableEntryTests {
ConfigurationMetadataProperty thirdProp = new ConfigurationMetadataProperty();
thirdProp.setId("spring.test.third");
thirdProp.setType("java.lang.String");
CompoundConfigurationTableEntry entry = new CompoundConfigurationTableEntry(
"spring.test", "This is a description.");
CompoundConfigurationTableEntry entry = new CompoundConfigurationTableEntry("spring.test",
"This is a description.");
entry.addConfigurationKeys(firstProp, secondProp, thirdProp);
AsciidocBuilder builder = new AsciidocBuilder();
entry.write(builder);
assertThat(builder.toString()).isEqualTo(
"|`+spring.test.first+` +" + NEWLINE + "`+spring.test.second+` +"
+ NEWLINE + "`+spring.test.third+` +" + NEWLINE + NEWLINE + "|"
+ NEWLINE + "|+++This is a description.+++" + NEWLINE);
"|`+spring.test.first+` +" + NEWLINE + "`+spring.test.second+` +" + NEWLINE + "`+spring.test.third+` +"
+ NEWLINE + NEWLINE + "|" + NEWLINE + "|+++This is a description.+++" + NEWLINE);
}
}

13
spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/test/java/org/springframework/boot/configurationdocs/ConfigurationTableTests.java
View File

@@ -46,14 +46,11 @@ public class ConfigurationTableTests {
second.setType("java.lang.String");
table.addEntry(new SingleConfigurationTableEntry(first));
table.addEntry(new SingleConfigurationTableEntry(second));
assertThat(table.toAsciidocTable())
.isEqualTo("[cols=\"1,1,2\", options=\"header\"]" + NEWLINE + "|==="
+ NEWLINE + "|Key|Default Value|Description" + NEWLINE + NEWLINE
+ "|`+spring.test.other+`" + NEWLINE + "|`+other value+`"
+ NEWLINE + "|+++This is another description.+++" + NEWLINE
+ NEWLINE + "|`+spring.test.prop+`" + NEWLINE + "|`+something+`"
+ NEWLINE + "|+++This is a description.+++" + NEWLINE + NEWLINE
+ "|===" + NEWLINE);
assertThat(table.toAsciidocTable()).isEqualTo("[cols=\"1,1,2\", options=\"header\"]" + NEWLINE + "|==="
+ NEWLINE + "|Key|Default Value|Description" + NEWLINE + NEWLINE + "|`+spring.test.other+`" + NEWLINE
+ "|`+other value+`" + NEWLINE + "|+++This is another description.+++" + NEWLINE + NEWLINE
+ "|`+spring.test.prop+`" + NEWLINE + "|`+something+`" + NEWLINE + "|+++This is a description.+++"
+ NEWLINE + NEWLINE + "|===" + NEWLINE);
}
}

27
spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/test/java/org/springframework/boot/configurationdocs/SingleConfigurationTableEntryTests.java
View File

@@ -41,8 +41,8 @@ public class SingleConfigurationTableEntryTests {
SingleConfigurationTableEntry entry = new SingleConfigurationTableEntry(property);
AsciidocBuilder builder = new AsciidocBuilder();
entry.write(builder);
assertThat(builder.toString()).isEqualTo("|`+spring.test.prop+`" + NEWLINE
+ "|`+something+`" + NEWLINE + "|+++This is a description.+++" + NEWLINE);
assertThat(builder.toString()).isEqualTo("|`+spring.test.prop+`" + NEWLINE + "|`+something+`" + NEWLINE
+ "|+++This is a description.+++" + NEWLINE);
}
@Test
@@ -54,8 +54,8 @@ public class SingleConfigurationTableEntryTests {
SingleConfigurationTableEntry entry = new SingleConfigurationTableEntry(property);
AsciidocBuilder builder = new AsciidocBuilder();
entry.write(builder);
assertThat(builder.toString()).isEqualTo("|`+spring.test.prop+`" + NEWLINE + "|"
+ NEWLINE + "|+++This is a description.+++" + NEWLINE);
assertThat(builder.toString()).isEqualTo(
"|`+spring.test.prop+`" + NEWLINE + "|" + NEWLINE + "|+++This is a description.+++" + NEWLINE);
}
@Test
@@ -68,9 +68,8 @@ public class SingleConfigurationTableEntryTests {
SingleConfigurationTableEntry entry = new SingleConfigurationTableEntry(property);
AsciidocBuilder builder = new AsciidocBuilder();
entry.write(builder);
assertThat(builder.toString()).isEqualTo("|`+spring.test.prop+`" + NEWLINE
+ "|`+first{vbar}" + NEWLINE + "second+`" + NEWLINE
+ "|+++This is a description.+++" + NEWLINE);
assertThat(builder.toString()).isEqualTo("|`+spring.test.prop+`" + NEWLINE + "|`+first{vbar}" + NEWLINE
+ "second+`" + NEWLINE + "|+++This is a description.+++" + NEWLINE);
}
@Test
@@ -83,9 +82,8 @@ public class SingleConfigurationTableEntryTests {
SingleConfigurationTableEntry entry = new SingleConfigurationTableEntry(property);
AsciidocBuilder builder = new AsciidocBuilder();
entry.write(builder);
assertThat(builder.toString())
.isEqualTo("|`+spring.test.prop+`" + NEWLINE + "|`+first\\\\second+`"
+ NEWLINE + "|+++This is a description.+++" + NEWLINE);
assertThat(builder.toString()).isEqualTo("|`+spring.test.prop+`" + NEWLINE + "|`+first\\\\second+`" + NEWLINE
+ "|+++This is a description.+++" + NEWLINE);
}
@Test
@@ -97,8 +95,8 @@ public class SingleConfigurationTableEntryTests {
SingleConfigurationTableEntry entry = new SingleConfigurationTableEntry(property);
AsciidocBuilder builder = new AsciidocBuilder();
entry.write(builder);
assertThat(builder.toString()).isEqualTo("|`+spring.test.prop.*+`" + NEWLINE + "|"
+ NEWLINE + "|+++This is a description.+++" + NEWLINE);
assertThat(builder.toString()).isEqualTo(
"|`+spring.test.prop.*+`" + NEWLINE + "|" + NEWLINE + "|+++This is a description.+++" + NEWLINE);
}
@Test
@@ -112,9 +110,8 @@ public class SingleConfigurationTableEntryTests {
SingleConfigurationTableEntry entry = new SingleConfigurationTableEntry(property);
AsciidocBuilder builder = new AsciidocBuilder();
entry.write(builder);
assertThat(builder.toString()).isEqualTo("|`+spring.test.prop+`" + NEWLINE
+ "|`+first," + NEWLINE + "second," + NEWLINE + "third+`" + NEWLINE
+ "|+++This is a description.+++" + NEWLINE);
assertThat(builder.toString()).isEqualTo("|`+spring.test.prop+`" + NEWLINE + "|`+first," + NEWLINE + "second,"
+ NEWLINE + "third+`" + NEWLINE + "|+++This is a description.+++" + NEWLINE);
}
}