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

Fail if superfluous properties are used in property metadata

Browse Source 
Closes gh-37597
This commit is contained in:
Moritz Halbritter
2023-11-30 14:29:19 +01:00
parent 970c226847
commit 25614710d5
2 changed files with 232 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -18,30 +18,31 @@ package org.springframework.boot.configurationprocessor.metadata;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.OutputStream;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.TreeSet;
import org.springframework.boot.configurationprocessor.json.JSONArray;
import org.springframework.boot.configurationprocessor.json.JSONObject;
import org.springframework.boot.configurationprocessor.metadata.ItemMetadata.ItemType;
/**
* Marshaller to write {@link ConfigurationMetadata} as JSON.
* Marshaller to read and write {@link ConfigurationMetadata} as JSON.
*
* @author Stephane Nicoll
* @author Phillip Webb
* @author Moritz Halbritter
* @since 1.2.0
*/
public class JsonMarshaller {
private static final int BUFFER_SIZE = 4098;
public void write(ConfigurationMetadata metadata, OutputStream outputStream) throws IOException {
try {
JSONObject object = new JSONObject();
@@ -65,42 +66,53 @@ public class JsonMarshaller {
public ConfigurationMetadata read(InputStream inputStream) throws Exception {
ConfigurationMetadata metadata = new ConfigurationMetadata();
JSONObject object = new JSONObject(toString(inputStream));
JsonPath path = JsonPath.root();
checkAllowedKeys(object, path, "groups", "properties", "hints");
JSONArray groups = object.optJSONArray("groups");
if (groups != null) {
for (int i = 0; i < groups.length(); i++) {
metadata.add(toItemMetadata((JSONObject) groups.get(i), ItemType.GROUP));
metadata
.add(toItemMetadata((JSONObject) groups.get(i), path.resolve("groups").index(i), ItemType.GROUP));
}
}
JSONArray properties = object.optJSONArray("properties");
if (properties != null) {
for (int i = 0; i < properties.length(); i++) {
metadata.add(toItemMetadata((JSONObject) properties.get(i), ItemType.PROPERTY));
metadata.add(toItemMetadata((JSONObject) properties.get(i), path.resolve("properties").index(i),
ItemType.PROPERTY));
}
}
JSONArray hints = object.optJSONArray("hints");
if (hints != null) {
for (int i = 0; i < hints.length(); i++) {
metadata.add(toItemHint((JSONObject) hints.get(i)));
metadata.add(toItemHint((JSONObject) hints.get(i), path.resolve("hints").index(i)));
}
}
return metadata;
}
private ItemMetadata toItemMetadata(JSONObject object, ItemType itemType) throws Exception {
private ItemMetadata toItemMetadata(JSONObject object, JsonPath path, ItemType itemType) throws Exception {
switch (itemType) {
case GROUP -> checkAllowedKeys(object, path, "name", "type", "description", "sourceType", "sourceMethod");
case PROPERTY -> checkAllowedKeys(object, path, "name", "type", "description", "sourceType", "defaultValue",
"deprecation", "deprecated");
}
String name = object.getString("name");
String type = object.optString("type", null);
String description = object.optString("description", null);
String sourceType = object.optString("sourceType", null);
String sourceMethod = object.optString("sourceMethod", null);
Object defaultValue = readItemValue(object.opt("defaultValue"));
ItemDeprecation deprecation = toItemDeprecation(object);
ItemDeprecation deprecation = toItemDeprecation(object, path);
return new ItemMetadata(itemType, name, null, type, sourceType, sourceMethod, description, defaultValue,
deprecation);
}
private ItemDeprecation toItemDeprecation(JSONObject object) throws Exception {
private ItemDeprecation toItemDeprecation(JSONObject object, JsonPath path) throws Exception {
if (object.has("deprecation")) {
JSONObject deprecationJsonObject = object.getJSONObject("deprecation");
checkAllowedKeys(deprecationJsonObject, path.resolve("deprecation"), "level", "reason", "replacement",
"since");
ItemDeprecation deprecation = new ItemDeprecation();
deprecation.setLevel(deprecationJsonObject.optString("level", null));
deprecation.setReason(deprecationJsonObject.optString("reason", null));
@@ -111,32 +123,35 @@ public class JsonMarshaller {
return object.optBoolean("deprecated") ? new ItemDeprecation() : null;
}
private ItemHint toItemHint(JSONObject object) throws Exception {
private ItemHint toItemHint(JSONObject object, JsonPath path) throws Exception {
checkAllowedKeys(object, path, "name", "values", "providers");
String name = object.getString("name");
List<ItemHint.ValueHint> values = new ArrayList<>();
if (object.has("values")) {
JSONArray valuesArray = object.getJSONArray("values");
for (int i = 0; i < valuesArray.length(); i++) {
values.add(toValueHint((JSONObject) valuesArray.get(i)));
values.add(toValueHint((JSONObject) valuesArray.get(i), path.resolve("values").index(i)));
}
}
List<ItemHint.ValueProvider> providers = new ArrayList<>();
if (object.has("providers")) {
JSONArray providersObject = object.getJSONArray("providers");
for (int i = 0; i < providersObject.length(); i++) {
providers.add(toValueProvider((JSONObject) providersObject.get(i)));
providers.add(toValueProvider((JSONObject) providersObject.get(i), path.resolve("providers").index(i)));
}
}
return new ItemHint(name, values, providers);
}
private ItemHint.ValueHint toValueHint(JSONObject object) throws Exception {
private ItemHint.ValueHint toValueHint(JSONObject object, JsonPath path) throws Exception {
checkAllowedKeys(object, path, "value", "description");
Object value = readItemValue(object.get("value"));
String description = object.optString("description", null);
return new ItemHint.ValueHint(value, description);
}
private ItemHint.ValueProvider toValueProvider(JSONObject object) throws Exception {
private ItemHint.ValueProvider toValueProvider(JSONObject object, JsonPath path) throws Exception {
checkAllowedKeys(object, path, "name", "parameters");
String name = object.getString("name");
Map<String, Object> parameters = new HashMap<>();
if (object.has("parameters")) {
@@ -162,14 +177,48 @@ public class JsonMarshaller {
}
private String toString(InputStream inputStream) throws IOException {
StringBuilder out = new StringBuilder();
InputStreamReader reader = new InputStreamReader(inputStream, StandardCharsets.UTF_8);
char[] buffer = new char[BUFFER_SIZE];
int bytesRead;
while ((bytesRead = reader.read(buffer)) != -1) {
out.append(buffer, 0, bytesRead);
return new String(inputStream.readAllBytes(), StandardCharsets.UTF_8);
}
@SuppressWarnings("unchecked")
private void checkAllowedKeys(JSONObject object, JsonPath path, String... allowedKeys) {
Set<String> availableKeys = new TreeSet<>();
object.keys().forEachRemaining((key) -> availableKeys.add((String) key));
Arrays.stream(allowedKeys).forEach(availableKeys::remove);
if (!availableKeys.isEmpty()) {
throw new IllegalStateException("Expected only keys %s, but found additional keys %s. Path: %s"
.formatted(new TreeSet<>(Arrays.asList(allowedKeys)), availableKeys, path));
}
return out.toString();
}
private static final class JsonPath {
private final String path;
private JsonPath(String path) {
this.path = path;
}
JsonPath resolve(String path) {
if (this.path.endsWith(".")) {
return new JsonPath(this.path + path);
}
return new JsonPath(this.path + "." + path);
}
JsonPath index(int index) {
return resolve("[%d]".formatted(index));
}
@Override
public String toString() {
return this.path;
}
static JsonPath root() {
return new JsonPath(".");
}
}
}