-
Notifications
You must be signed in to change notification settings - Fork 995
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
MNIOR: feat(apps): support config file (#17872)
* feat(apps): support config file - added support for app config files - removed AppPrivateConfig from the OpenMetadata server configuration * use dorpwizard utility classes for resolving environment variables in the config * moved fields to class level * format
- Loading branch information
Showing
6 changed files
with
147 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
57 changes: 57 additions & 0 deletions
57
openmetadata-service/src/main/java/org/openmetadata/service/apps/ConfigurationReader.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| package org.openmetadata.service.apps; | ||
|
|
||
| import com.fasterxml.jackson.databind.ObjectMapper; | ||
| import com.fasterxml.jackson.dataformat.yaml.YAMLFactory; | ||
| import io.dropwizard.configuration.ConfigurationException; | ||
| import io.dropwizard.configuration.EnvironmentVariableSubstitutor; | ||
| import io.dropwizard.configuration.FileConfigurationSourceProvider; | ||
| import io.dropwizard.configuration.SubstitutingSourceProvider; | ||
| import io.dropwizard.configuration.YamlConfigurationFactory; | ||
| import java.io.File; | ||
| import java.io.IOException; | ||
| import java.net.URL; | ||
| import java.util.Map; | ||
| import org.apache.commons.text.StringSubstitutor; | ||
| import org.openmetadata.schema.api.configuration.apps.AppPrivateConfig; | ||
| import org.openmetadata.service.util.JsonUtils; | ||
|
|
||
| public class ConfigurationReader { | ||
| private final StringSubstitutor substitutor; | ||
| private final ObjectMapper mapper = new ObjectMapper(new YAMLFactory()); | ||
| private final YamlConfigurationFactory<Object> factory = | ||
| new YamlConfigurationFactory<>(Object.class, null, mapper, "dw"); | ||
|
|
||
| public ConfigurationReader(Map<String, String> envMap) { | ||
| // envMap is for custom environment variables (e.g., for testing), defaulting to the system | ||
| // environment. | ||
| substitutor = | ||
| envMap == null ? new EnvironmentVariableSubstitutor(false) : new StringSubstitutor(envMap); | ||
| } | ||
|
|
||
| public ConfigurationReader() { | ||
| this(System.getenv()); | ||
| } | ||
|
|
||
| public AppPrivateConfig readConfigFromResource(String appName) | ||
| throws IOException, ConfigurationException { | ||
| String configFilePath = "applications/" + appName + "/config.yaml"; | ||
| URL resource = ConfigurationReader.class.getClassLoader().getResource(configFilePath); | ||
| if (resource == null) { | ||
| throw new IOException("Configuration file not found: " + configFilePath); | ||
| } | ||
| File configFile = new File(resource.getFile()); | ||
| return JsonUtils.convertValue(readConfigFile(configFile), AppPrivateConfig.class); | ||
| } | ||
|
|
||
| public Map<String, Object> readConfigFile(File configFile) | ||
| throws IOException, ConfigurationException { | ||
| try { | ||
| return (Map<String, Object>) | ||
| factory.build( | ||
| new SubstitutingSourceProvider(new FileConfigurationSourceProvider(), substitutor), | ||
| configFile.getAbsolutePath()); | ||
| } catch (ClassCastException e) { | ||
| throw new RuntimeException("Configuration file is not a valid YAML file", e); | ||
| } | ||
| } | ||
| } |
57 changes: 57 additions & 0 deletions
57
...ervice/src/test/java/org/openmetadata/service/resources/apps/ConfigurationReaderTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| package org.openmetadata.service.resources.apps; | ||
|
|
||
| import static org.junit.Assert.assertThrows; | ||
| import static org.junit.jupiter.api.Assertions.assertEquals; | ||
| import static org.junit.jupiter.api.Assertions.assertNotNull; | ||
|
|
||
| import io.dropwizard.configuration.ConfigurationException; | ||
| import java.io.IOException; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import org.junit.jupiter.api.Test; | ||
| import org.openmetadata.schema.api.configuration.apps.AppPrivateConfig; | ||
| import org.openmetadata.service.apps.ConfigurationReader; | ||
|
|
||
| public class ConfigurationReaderTest { | ||
|
|
||
| @Test | ||
| public void testReadConfigFile() throws IOException, ConfigurationException { | ||
| ConfigurationReader reader = | ||
| new ConfigurationReader( | ||
| Map.of( | ||
| "ENV_VAR", | ||
| "resolvedValue", | ||
| "NESTED_ENV_VAR", | ||
| "nestedValue", | ||
| "LIST_ENV_VAR", | ||
| "value1")); | ||
| AppPrivateConfig appConfig = reader.readConfigFromResource("TestApplication"); | ||
| assertNotNull(appConfig); | ||
| assertEquals("value1", appConfig.getParameters().getAdditionalProperties().get("key1")); | ||
| assertEquals("resolvedValue", appConfig.getParameters().getAdditionalProperties().get("key2")); | ||
| assertEquals("", appConfig.getParameters().getAdditionalProperties().get("emptyKey")); | ||
| assertEquals("default", appConfig.getParameters().getAdditionalProperties().get("defaultKey")); | ||
| Map<String, String> nested = | ||
| (Map<String, String>) appConfig.getParameters().getAdditionalProperties().get("nested"); | ||
| assertEquals("nestedValue", nested.get("nestedKey")); | ||
| List<String> list = | ||
| (List<String>) appConfig.getParameters().getAdditionalProperties().get("list"); | ||
| assertEquals("value1", list.get(1)); | ||
| } | ||
|
|
||
| @Test | ||
| public void testInvalidConfig() { | ||
| ConfigurationReader reader = new ConfigurationReader(); | ||
| assertThrows(RuntimeException.class, () -> reader.readConfigFromResource("InvalidConfig")); | ||
| } | ||
|
|
||
| @Test | ||
| public void missingConfig() { | ||
| ConfigurationReader reader = new ConfigurationReader(); | ||
| assertThrows( | ||
| IOException.class, | ||
| () -> { | ||
| reader.readConfigFromResource("missing"); | ||
| }); | ||
| } | ||
| } |
3 changes: 3 additions & 0 deletions
3
openmetadata-service/src/test/resources/applications/InvalidConfig/config.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| --- | ||
| - a | ||
| - b |
10 changes: 10 additions & 0 deletions
10
openmetadata-service/src/test/resources/applications/TestApplication/config.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| parameters: | ||
| key1: value1 | ||
| key2: ${ENV_VAR} | ||
| emptyKey: ${UNDEFINED_ENV_VAR:-""} | ||
| defaultKey: ${UNDEFINED_ENV_VAR:-default} | ||
| nested: | ||
| nestedKey: ${NESTED_ENV_VAR} | ||
| list: | ||
| - elem1 | ||
| - ${LIST_ENV_VAR} |