Skip to content

BIGTOP-4442: Support resolve nested variables for service config #224

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
timyuer merged 1 commit into from
Jun 16, 2025
Merged

BIGTOP-4442: Support resolve nested variables for service config #224

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions ...stack-core/src/main/java/org/apache/bigtop/manager/stack/core/executor/StackExecutor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ public static ShellResult execute(ComponentCommandPayload payload) {
.getClass()
.getDeclaredConstructor(ComponentCommandPayload.class)
.newInstance(payload);
params.initGlobalParams();
if (Environments.isDevMode()) {
log.info("Executing {}::{} on dev mode", script.getName(), method.getName());
return ShellResult.success();
Expand Down
84 changes: 81 additions & 3 deletions ...r-stack-core/src/main/java/org/apache/bigtop/manager/stack/core/spi/param/BaseParams.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@
import org.apache.bigtop.manager.stack.core.exception.StackException;
import org.apache.bigtop.manager.stack.core.utils.LocalSettings;

import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.extern.slf4j.Slf4j;

Expand All @@ -44,17 +43,49 @@
@NoArgsConstructor
public abstract class BaseParams implements Params {

@Getter
protected final Map<String, Object> globalParamsMap = new HashMap<>();

private boolean globalParamsResolved = false;

private static int CURRENT_RESOLVING_DEPTH = 0;
private static final int MAX_RECURSION_DEPTH = 5;

public static final String LIMITS_CONF_DIR = "/etc/security/limits.d";

protected ComponentCommandPayload payload;

@SuppressWarnings("unchecked")
protected BaseParams(ComponentCommandPayload payload) {
this.payload = payload;
}

public void putGlobalParam(String key, Object value) {
if (value instanceof String s) {
if (s.contains("${") && s.contains("}")) {
globalParamsResolved = false;
}
}

globalParamsMap.put(key, value);
}

public Object getGlobalParam(String key) {
if (!globalParamsResolved) {
recursivelyResolveGlobalParams();
}

return globalParamsMap.get(key);
}

public Map<String, Object> getGlobalParamsMap() {
if (!globalParamsResolved) {
recursivelyResolveGlobalParams();
}

return globalParamsMap;
}

@SuppressWarnings("unchecked")
public void initGlobalParams() {
// Global Parameters Injection
Method[] declaredMethods = this.getClass().getDeclaredMethods();
for (Method declaredMethod : declaredMethods) {
Expand All @@ -67,7 +98,54 @@ protected BaseParams(ComponentCommandPayload payload) {
log.warn("Get {} Params error", declaredMethod, e);
}
}

globalParamsMap.remove("content");

recursivelyResolveGlobalParams();
globalParamsResolved = true;
}

private void recursivelyResolveGlobalParams() {
CURRENT_RESOLVING_DEPTH++;
boolean allResolved = true;
for (Map.Entry<String, Object> entry : globalParamsMap.entrySet()) {
if (entry.getValue() instanceof String value) {
while (value.contains("${") && value.contains("}")) {
allResolved = false;
int start = -1, end = -1;
for (int i = 0; i < value.length(); i++) {
if (value.startsWith("${", i)) {
start = i;
} else if (value.charAt(i) == '}') {
end = i;
break;
}
}
if (start != -1 && end != -1) {
String key = value.substring(start + 2, end);
Object resolvedValue = globalParamsMap.get(key);
if (resolvedValue != null) {
value = value.substring(0, start) + resolvedValue + value.substring(end + 1);
entry.setValue(value);
} else {
// Log a warning if the key is not found
log.warn("Parameter '{}' not found for replacement in '{}'", key, entry.getKey());
break;
}
}
}
}
}

if (!allResolved) {
if (CURRENT_RESOLVING_DEPTH >= MAX_RECURSION_DEPTH) {
CURRENT_RESOLVING_DEPTH = 0;
} else {
recursivelyResolveGlobalParams();
}
} else {
CURRENT_RESOLVING_DEPTH = 0;
}
}

public String hostname() {
Expand Down
2 changes: 2 additions & 0 deletions ...nager-stack-core/src/main/java/org/apache/bigtop/manager/stack/core/spi/param/Params.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@

public interface Params extends PrioritySPI {

void initGlobalParams();

String confDir();

String user();
Expand Down
22 changes: 22 additions & 0 deletions ...ack-core/src/test/java/org/apache/bigtop/manager/stack/core/spi/param/BaseParamsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@

import java.util.ArrayList;
import java.util.List;
import java.util.Map;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.mockito.Mockito.mockStatic;
Expand Down Expand Up @@ -105,6 +106,27 @@ public void tearDown() {
netUtilsMockedStatic.close();
}

@Test
public void testInitGlobalParams() {
Map<String, Object> globalParamsMap = mockBaseParams.getGlobalParamsMap();
globalParamsMap.put("a1", "k1");
globalParamsMap.put("a2", "k2");
globalParamsMap.put("a3", "k3");
globalParamsMap.put("k1_k2", "kk1");
globalParamsMap.put("kk1_k3", "value");
globalParamsMap.put("key", "${key3}");
globalParamsMap.put("key1", "${k1_${a2}}_${a3}");
globalParamsMap.put("key2", "${${k1_${a2}}_${a3}}");
globalParamsMap.put("key3", "${key1}");
globalParamsMap.put("key4", "${not_exists}");
mockBaseParams.initGlobalParams();
assertEquals("kk1_k3", globalParamsMap.get("key"));
assertEquals("kk1_k3", globalParamsMap.get("key1"));
assertEquals("value", mockBaseParams.getGlobalParamsMap().get("key2"));
assertEquals("kk1_k3", globalParamsMap.get("key3"));
assertEquals("${not_exists}", globalParamsMap.get("key4"));
}

@Test
public void testHostname() {
String hostname = mockBaseParams.hostname();
Expand Down
6 changes: 3 additions & 3 deletions ...fra/src/main/java/org/apache/bigtop/manager/stack/infra/v1_0_0/grafana/GrafanaParams.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,11 +110,11 @@ public Map<String, Object> prometheus() {
}
prometheusServer = prometheusServers.get(0);

Map<String, Object> prometheus_configuration = LocalSettings.configurations("prometheus", "prometheus");
if (prometheus_configuration == null) {
Map<String, Object> prometheusConf = LocalSettings.configurations("prometheus", "prometheus");
if (prometheusConf == null) {
return configuration;
}
prometheusPort = (String) prometheus_configuration.get("port");
prometheusPort = (String) prometheusConf.get("port");
return configuration;
}

Expand Down
2 changes: 0 additions & 2 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,9 +226,7 @@
<configuration>
<source>${java.version}</source>
<failOnError>false</failOnError>
<aggregate>true</aggregate>
<skip>${maven.javadoc.skip}</skip>
<additionalparam>-Xdoclint:none</additionalparam>
</configuration>
<executions>
<execution>
Expand Down
Loading