Skip to content
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

Jump to bottom

Remove dependency on apache-commons-configuration #619

Merged
merged 1 commit into from
Sep 6, 2022
Merged

Remove dependency on apache-commons-configuration #619

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
11 changes: 0 additions & 11 deletions backend/manager/dependencies/common/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,6 @@
<artifactId>java-client-kubevirt</artifactId>
</dependency>

<dependency>
<groupId>commons-configuration</groupId>
<artifactId>commons-configuration</artifactId>
</dependency>

<dependency>
<groupId>commons-jxpath</groupId>
<artifactId>commons-jxpath</artifactId>
Expand Down Expand Up @@ -239,12 +234,6 @@
<moduleName>org.ovirt.java-client-kubevirt</moduleName>
</module>

<module>
<groupId>commons-configuration</groupId>
<artifactId>commons-configuration</artifactId>
<moduleName>org.apache.commons.configuration</moduleName>
</module>

<module>
<groupId>commons-jxpath</groupId>
<artifactId>commons-jxpath</artifactId>
Expand Down
25 changes: 0 additions & 25 deletions ...ger/dependencies/common/src/main/modules/org/apache/commons/configuration/main/module.xml
View file
Open in desktop

This file was deleted.

28 changes: 0 additions & 28 deletions backend/manager/tools/src/main/java/org/ovirt/engine/core/config/AppConfig.java
View file
Open in desktop

This file was deleted.

20 changes: 0 additions & 20 deletions backend/manager/tools/src/main/java/org/ovirt/engine/core/config/ConfigFile.java
View file
Open in desktop

This file was deleted.

136 changes: 81 additions & 55 deletions backend/manager/tools/src/main/java/org/ovirt/engine/core/config/EngineConfigLogic.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,28 +5,30 @@
import java.io.FileReader;
import java.io.IOException;
import java.net.ConnectException;
import java.nio.file.Files;
import java.security.InvalidParameterException;
import java.sql.SQLException;
import java.text.MessageFormat;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;

import org.apache.commons.configuration.Configuration;
import org.apache.commons.configuration.HierarchicalConfiguration;
import org.apache.commons.configuration.SubnodeConfiguration;
import org.apache.commons.configuration.tree.ConfigurationNode;
import org.apache.commons.lang.StringUtils;
import org.ovirt.engine.core.config.db.ConfigDao;
import org.ovirt.engine.core.config.db.ConfigDaoImpl;
import org.ovirt.engine.core.config.entity.ConfigKey;
import org.ovirt.engine.core.config.entity.ConfigKeyFactory;
import org.ovirt.engine.core.config.validation.ConfigActionType;
import org.ovirt.engine.core.tools.ToolConsole;
import org.ovirt.engine.core.utils.EngineLocalConfig;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.node.ObjectNode;
/**
* The <code>EngineConfigLogic</code> class is responsible for the logic of the EngineConfig tool.
*/
Expand All @@ -37,20 +39,23 @@ public class EngineConfigLogic {
// The console:
private static final ToolConsole console = ToolConsole.getInstance();

private static final String ALTERNATE_KEY = "alternateKey";
private static final String MERGABLE_TOKEN = "mergable";
private static final String DELIMITER_TOKEN = "delimiter";
private static final String MERGE_NOT_SUPPORTED_MSG = "%s does not support merge of values.";
private static final String MERGE_SAME_VALUE_MSG = "Merge operation cancelled as value is unchanged.";
private static final String MERGE_PERSIST_ERR_MSG = "setValue: error merging %s value. No such entry%s.";
private static final String KEY_NOT_FOUND_ERR_MSG = "Cannot display help for key %1$s. The key does not exist at the configuration file of engine-config.";

private Configuration appConfig;
private HierarchicalConfiguration keysConfig;
private Map<String, String> alternateKeysMap;
public static final File DEFAULT_CONFIG_PATH = new File(EngineLocalConfig.getInstance().getEtcDir(), "engine-config");
private static final String CONFIG_CONF = "engine-config.conf";
private ConfigKeyFactory configKeyFactory;
private ConfigDao configDao;
private EngineConfigCLIParser parser;
private static Map<String, JsonNode> props;
private static final String OVIRT_CONFIG_PROPERTIES = "engine-config.properties";
private final String[] defaultPropertiesFileLocations = {
new File(DEFAULT_CONFIG_PATH, OVIRT_CONFIG_PROPERTIES).getAbsolutePath(),
new File(DEFAULT_CONFIG_PATH, "engine-config_" + Locale.getDefault() + ".properties").getAbsolutePath()
};

public EngineConfigLogic(EngineConfigCLIParser parser) throws Exception {
this.parser = parser;
Expand All @@ -62,10 +67,28 @@ public EngineConfigLogic(EngineConfigCLIParser parser) throws Exception {
*/
private void init() throws Exception {
log.debug("init: beginning initiation of EngineConfigLogic");
appConfig = new AppConfig(parser.getAlternateConfigFile()).getFile();
keysConfig = new KeysConfig<>(parser.getAlternatePropertiesFile()).getFile();
populateAlternateKeyMap(keysConfig);
ConfigKeyFactory.init(keysConfig, alternateKeysMap, parser);
String alternateConfigFile = parser.getAlternateConfigFile();
File appConfigFile = !StringUtils.isBlank(alternateConfigFile)
? EngineConfigUtils.locateFileInPaths(new String[] { alternateConfigFile })
: new File(EngineConfig.DEFAULT_CONFIG_PATH, CONFIG_CONF);

List<String> appConfigContent = Files.readAllLines(appConfigFile.toPath());

Map<String, String> appConfig = new HashMap<>();
for (String str: appConfigContent) {
String[] data = str.split("=");
if (data.length == 2) {
appConfig.put(data[0], data[1]);
}
}

String alternatePropertiesFile = parser.getAlternatePropertiesFile();
File keysConf = EngineConfigUtils.locateFileInPaths(
!StringUtils.isBlank(alternatePropertiesFile) ? new String[] { alternatePropertiesFile }
: defaultPropertiesFileLocations);
this.props = new HashMap<>();
populateProperties(keysConf);
ConfigKeyFactory.init(props, parser);
configKeyFactory = ConfigKeyFactory.getInstance();
try {
this.configDao = new ConfigDaoImpl(appConfig);
Expand All @@ -75,25 +98,11 @@ private void init() throws Exception {
}
}

private void populateAlternateKeyMap(HierarchicalConfiguration config) {
List<SubnodeConfiguration> configurationsAt = config.configurationsAt("/*/" + ALTERNATE_KEY);
alternateKeysMap = new HashMap<>(configurationsAt.size());
for (SubnodeConfiguration node : configurationsAt) {
String rootKey = node.getRootNode()
.getParentNode().getName();
String[] alternateKeys = config.getStringArray("/" + rootKey + "/" + ALTERNATE_KEY);
for (String token : alternateKeys) {
alternateKeysMap.put(token, rootKey);
}
}
}

/**
* Executes desired action. Assumes the parser is now holding valid arguments.
*/
public void execute() throws Exception {
ConfigActionType actionType = parser.getConfigAction();
log.debug("execute: beginning execution of action {}.", actionType);

switch (actionType) {
case ACTION_ALL:
Expand Down Expand Up @@ -242,14 +251,11 @@ private void printAllValuesForKey(String key) throws Exception {
* Prints all configuration values. Is the actual execution of the 'get-all' action ('-a', '--all')
*/
private void printAllValues() {
List<ConfigurationNode> configNodes = keysConfig.getRootNode().getChildren();
for (ConfigurationNode node : configNodes) {
ConfigKey key = configKeyFactory.generateByPropertiesKey(node.getName());
// TODO - move to one statement for all - time permitting;
for (String key: props.keySet()) {
try {
printAllValuesForKey(key.getKey());
printAllValuesForKey(key);
} catch (Exception exception) {
log.error("Error while retrieving value for key \"{}\".", key.getKey(), exception);
log.error("Error while retrieving value for key \"{}\".", key, exception);
}
}
}
Expand All @@ -258,35 +264,30 @@ private void printAllValues() {
* Prints all available configuration keys.
*/
public void printAvailableKeys() {
iterateAllKeys(configKeyFactory, keysConfig, key -> {
iterateAllKeys(configKeyFactory, key -> {
printKeyInFormat(key);
return true;
});
}

public static boolean iterateAllKeys(ConfigKeyFactory factory,
HierarchicalConfiguration config,
ConfigKeyHandler handler) {
List<ConfigurationNode> configNodes = config.getRootNode().getChildren();
for (ConfigurationNode node : configNodes) {
ConfigKey key = factory.generateByPropertiesKey(node.getName());
if (!handler.handle(key)) {
public static boolean iterateAllKeys(ConfigKeyFactory factory, ConfigKeyHandler handler) {
for (String key: props.keySet()) {
ConfigKey configKey = factory.generateByPropertiesKey(key);
if (!handler.handle(configKey)) {
return true;
}
}
return false;
}

/**
* Prints all reloadable configuration keys. Is the actual execution of the 'list' action ('-l', '--list') with the
* --only-reloadable flag
*/
public void printReloadableKeys() {
List<ConfigurationNode> configNodes = keysConfig.getRootNode().getChildren();
for (ConfigurationNode node : configNodes) {
ConfigKey key = configKeyFactory.generateByPropertiesKey(node.getName());
if (key.isReloadable()) {
printKeyInFormat(key);
for (String key: props.keySet()) {
ConfigKey configKey = configKeyFactory.generateByPropertiesKey(key);
if (configKey.isReloadable()) {
printKeyInFormat(configKey);
}
}
}
Expand Down Expand Up @@ -367,19 +368,21 @@ private void persistValue() throws Exception {
private void mergeValue() throws Exception {
String key = parser.getKey();
String value = parser.getValue();
if(!keysConfig.getBoolean(key + "/" + MERGABLE_TOKEN, false)) {
console.writeFormat(MERGE_NOT_SUPPORTED_MSG, key);
console.writeLine();

JsonNode node = props.get(key);
if (!node.findValue(MERGABLE_TOKEN).asBoolean(false)) {
console.write(MERGE_NOT_SUPPORTED_MSG + " " + key + "\n");
return;
}

String version = parser.getVersion();
if (version == null) {
version = startVersionDialog(key);
}
ConfigKey configKey = fetchConfigKey(key, version);
if (configKey != null && configKey.getKey() != null && configKey.getDisplayValue().trim().length() > 0) {
String valueInDb = configKey.getDisplayValue().trim();
String delimiter = keysConfig.getString(key + "/" + DELIMITER_TOKEN, ";");
String delimiter = node.get(DELIMITER_TOKEN).asText(";");
value = mergedValues(value, valueInDb, delimiter);
if(valueInDb.equals(value)) {
console.writeFormat(MERGE_SAME_VALUE_MSG);
Expand Down Expand Up @@ -413,10 +416,10 @@ private String mergedValue(String valueToAppend, String currentValue, String del
return retValue.toString();
}

private void printHelpForKey() throws Exception {
private void printHelpForKey() {
final String keyName = parser.getKey();
boolean foundKey = iterateAllKeys(this.configKeyFactory, keysConfig, key -> {
if (key.getKey().equals(keyName)) {
boolean foundKey = iterateAllKeys(this.configKeyFactory, key -> {
if (key.equals(keyName)) {
console.writeLine(key.getValueHelper().getHelpNote(key));
return false;
}
Expand Down Expand Up @@ -502,7 +505,7 @@ public boolean persist(String key, String value) throws Exception {
}

private ConfigKey getConfigKey(String key) {
ConfigKey ckReturn = null;
ConfigKey ckReturn;
ckReturn = configKeyFactory.generateByPropertiesKey(key);
if (ckReturn == null || ckReturn.getKey() == null) {
ckReturn = null;
Expand Down Expand Up @@ -555,4 +558,27 @@ private void checkDiff() {
public ConfigDao getConfigDao() {
return configDao;
}

private void populateProperties(File file) throws IOException {
ObjectMapper mapper = new ObjectMapper();
List<String> lines = Files.readAllLines(file.toPath());
Map<String, String> allProps = new HashMap<>();
for (String line: lines) {
if (line.contains("=")) {
allProps.put(line.split("=")[0], line.split("=")[1]);
}
}
allProps.forEach((k, v) -> {
String[] mainKey = k.split("\\.");
if (this.props.get(mainKey[0]) != null) {
JsonNode oldNode = this.props.get(mainKey[0]);
((ObjectNode) oldNode).put(mainKey[1], v);
this.props.put(mainKey[0], oldNode);
} else {
ObjectNode node = mapper.createObjectNode();
node.put(mainKey[1], v);
this.props.put(mainKey[0], node);
}
});
}
}
Loading