Refactored live conditionals so that they are parsed via SpringBootApp

API
This commit is contained in:
nsingh
2017-11-02 13:10:13 -07:00
parent 46323af577
commit d5fcd91148
7 changed files with 280 additions and 152 deletions

View File

@@ -10,17 +10,74 @@
*******************************************************************************/
package org.springframework.ide.vscode.commons.boot.app.cli;
import org.springframework.ide.vscode.commons.boot.app.cli.SpringBootApp;
public class LiveConditional {
public final String condition;
public final String message;
public final SpringBootApp app;
private String condition;
private String message;
private String processId;
private String processName;
private String positiveMatchKey;
public LiveConditional(SpringBootApp app, String condition, String message) {
this.condition = condition;
this.message = message;
this.app = app;
public LiveConditional() {
}
public String getCondition() {
return condition;
}
public String getMessage() {
return message;
}
public String getProcessId() {
return processId;
}
public String getProcessName() {
return processName;
}
public String getPositiveMatchKey() {
return positiveMatchKey;
}
public static class LiveConditionalBuilder {
private LiveConditional conditional = new LiveConditional();
public LiveConditionalBuilder condition(String condition) {
conditional.condition = condition;
return this;
}
public LiveConditionalBuilder message(String message) {
conditional.message = message;
return this;
}
public LiveConditionalBuilder processId(String processId) {
conditional.processId = processId;
return this;
}
public LiveConditionalBuilder processName(String processName) {
conditional.processName = processName;
return this;
}
public LiveConditionalBuilder positiveMatchKey(String positiveMatchKey) {
conditional.positiveMatchKey = positiveMatchKey;
return this;
}
public LiveConditional build() {
return conditional;
}
}
public static LiveConditionalBuilder builder() {
return new LiveConditionalBuilder();
}
}

View File

@@ -0,0 +1,121 @@
/*******************************************************************************
* Copyright (c) 2017 Pivotal, Inc.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Pivotal, Inc. - initial API and implementation
*******************************************************************************/
package org.springframework.ide.vscode.commons.boot.app.cli;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Optional;
import org.json.JSONArray;
import org.json.JSONObject;
import org.springframework.ide.vscode.commons.util.Log;
import org.springframework.ide.vscode.commons.util.StringUtil;
/**
* Parsers @ConditionalOn annotations from a spring boot running app's
* autoconfig report. An example of a conditional that is parsed from a running
* app's autoconfig report would be:
*
* {"TraceRepositoryAutoConfiguration#traceRepository":[{"condition":"OnBeanCondition","message":"@ConditionalOnMissingBean
* (types: org.springframework.boot.actuate.trace.TraceRepository;
* SearchStrategy: all) did not find any beans"}]
*
*/
public class LiveConditionalParser {
private final String autoConfigRecord;
private final String appProcessName;
private final String appProcessId;
public LiveConditionalParser(String autoConfigRecord, String appProcessId, String appProcessName) {
this.autoConfigRecord = autoConfigRecord;
this.appProcessId = appProcessId;
this.appProcessName = appProcessName;
}
public Optional<List<LiveConditional>> parse() {
try {
List<LiveConditional> allConditionals = new ArrayList<>();
if (StringUtil.hasText(autoConfigRecord)) {
getConditionalsFromPositiveMatches(autoConfigRecord).stream()
.forEach(conditional -> allConditionals.add(conditional));
}
if (!allConditionals.isEmpty()) {
return Optional.of(allConditionals);
}
} catch (Exception e) {
Log.log(e);
}
return Optional.empty();
}
private Optional<JSONObject> getPositiveMatchesJson(String autoConfigReport) {
JSONObject autoConfigJson = new JSONObject(autoConfigReport);
Iterator<String> keys = autoConfigJson.keys();
while (keys.hasNext()) {
String key = keys.next();
if ("positiveMatches".equals(key)) {
Object obj = autoConfigJson.get(key);
if (obj instanceof JSONObject) {
return Optional.of((JSONObject) obj);
}
}
}
return Optional.empty();
}
private List<LiveConditional> getConditionalsFromPositiveMatches(String autoconfigReport) {
List<LiveConditional> conditions = new ArrayList<>();
getPositiveMatchesJson(autoconfigReport).ifPresent((positiveMatches) -> {
Iterator<String> pMKeys = positiveMatches.keys();
while (pMKeys.hasNext()) {
// The positive match key contains the bean method information where conditional
// was applied to
String positiveMatchKey = pMKeys.next();
JSONArray matchList = (JSONArray) positiveMatches.get(positiveMatchKey);
matchList.forEach((match) -> {
if (match instanceof JSONObject) {
resolveConditional(positiveMatchKey, (JSONObject) match)
.ifPresent((condition) -> conditions.add(condition));
}
});
}
});
return conditions;
}
private Optional<LiveConditional> resolveConditional(String positiveMatchKey, JSONObject conditionalJson) {
if (conditionalJson != null) {
String condition = (String) conditionalJson.get("condition");
String message = (String) conditionalJson.get("message");
// We care about the message itself as it contains the actual annotation as well
// as the reason it matched
if (StringUtil.hasText(message)) {
return Optional.of(LiveConditional.builder().processId(appProcessId).processName(appProcessName)
.condition(condition).message(message).positiveMatchKey(positiveMatchKey).build());
}
}
return Optional.empty();
}
public static Optional<List<LiveConditional>> parse(String autoConfigRecord, String appProcessId,
String appProcessName) {
return new LiveConditionalParser(autoConfigRecord, appProcessId, appProcessName).parse();
}
}

View File

@@ -19,6 +19,7 @@ import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Map.Entry;
import java.util.Optional;
import java.util.Properties;
import java.util.Set;
import java.util.StringTokenizer;
@@ -235,6 +236,24 @@ public class SpringBootApp {
return null;
}
public Optional<List<LiveConditional>> getLiveConditionals() throws Exception {
return getLiveConditionals(getAutoConfigReport(), getProcessID(), getProcessName());
}
/**
* Publicly visible so that it can be tested via a mock app
*
* @param autoConfigReport
* @param processId
* @param processName
* @return
* @throws Exception
*/
public static Optional<List<LiveConditional>> getLiveConditionals(String autoConfigReport, String processId,
String processName) {
return new LiveConditionalParser(autoConfigReport, processId, processName).parse();
}
public String getAutoConfigReport() throws Exception {
Object result = getActuatorDataFromAttribute("org.springframework.boot:type=Endpoint,name=autoConfigurationReportEndpoint", "Data");
if (result != null) {