Feat/117 empty files (#121)

* feat: all loaders support empty configs. Will return an empty map. #117 * test: Integration tests for empty sources.
gestalt-config · Oct 15, 2023 · 9768add · 9768add
1 parent 4939bcd
commit 9768add
Show file tree

Hide file tree

Showing 10 changed files with 152 additions and 2 deletions.
diff --git a/gestalt-core/src/main/java/org/github/gestalt/config/loader/EnvironmentVarsLoader.java b/gestalt-core/src/main/java/org/github/gestalt/config/loader/EnvironmentVarsLoader.java
@@ -6,6 +6,7 @@
 import org.github.gestalt.config.lexer.PathLexer;
 import org.github.gestalt.config.lexer.SentenceLexer;
 import org.github.gestalt.config.node.ConfigNode;
+import org.github.gestalt.config.node.MapNode;
 import org.github.gestalt.config.parser.ConfigParser;
 import org.github.gestalt.config.parser.MapConfigParser;
 import org.github.gestalt.config.source.ConfigSource;
@@ -15,6 +16,7 @@
 
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Map;
 
 /**
  * Loads Environment Variables from EnvironmentConfigSource.
@@ -64,6 +66,10 @@ public ValidateOf<List<ConfigNodeContainer>> loadSource(ConfigSource source) thr
             throw new GestaltException("Config source: " + source.name() + " does not have a list to load.");
         }
 
+        if (configs.isEmpty()) {
+            return ValidateOf.valid(List.of(new ConfigNodeContainer(new MapNode(Map.of()), source)));
+        }
+
         ValidateOf<ConfigNode> loadedNode = ConfigCompiler.analyze(source.failOnErrors(), lexer, parser, configs);
 
         List<ValidationError> errors = new ArrayList<>();

diff --git a/gestalt-core/src/main/java/org/github/gestalt/config/loader/MapConfigLoader.java b/gestalt-core/src/main/java/org/github/gestalt/config/loader/MapConfigLoader.java
@@ -6,6 +6,7 @@
 import org.github.gestalt.config.lexer.PathLexer;
 import org.github.gestalt.config.lexer.SentenceLexer;
 import org.github.gestalt.config.node.ConfigNode;
+import org.github.gestalt.config.node.MapNode;
 import org.github.gestalt.config.parser.ConfigParser;
 import org.github.gestalt.config.parser.MapConfigParser;
 import org.github.gestalt.config.source.ConfigSource;
@@ -15,6 +16,7 @@
 
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Map;
 
 /**
  * Loads an in memory map from MapConfigSource.
@@ -63,6 +65,10 @@ public ValidateOf<List<ConfigNodeContainer>> loadSource(ConfigSource source) thr
             throw new GestaltException("Config source: " + source.name() + " does not have a list to load.");
         }
 
+        if (configs.isEmpty()) {
+            return ValidateOf.valid(List.of(new ConfigNodeContainer(new MapNode(Map.of()), source)));
+        }
+
         ValidateOf<ConfigNode> loadedNode = ConfigCompiler.analyze(source.failOnErrors(), lexer, parser, configs);
 
         List<ValidationError> errors = new ArrayList<>();

diff --git a/gestalt-core/src/main/java/org/github/gestalt/config/loader/PropertyLoader.java b/gestalt-core/src/main/java/org/github/gestalt/config/loader/PropertyLoader.java
@@ -6,6 +6,7 @@
 import org.github.gestalt.config.lexer.PathLexer;
 import org.github.gestalt.config.lexer.SentenceLexer;
 import org.github.gestalt.config.node.ConfigNode;
+import org.github.gestalt.config.node.MapNode;
 import org.github.gestalt.config.parser.ConfigParser;
 import org.github.gestalt.config.parser.MapConfigParser;
 import org.github.gestalt.config.source.ConfigSource;
@@ -17,6 +18,7 @@
 import java.io.InputStream;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Map;
 import java.util.Properties;
 import java.util.stream.Collectors;
 
@@ -81,6 +83,10 @@ public ValidateOf<List<ConfigNodeContainer>> loadSource(ConfigSource source) thr
             throw new GestaltException("Config source: " + source.name() + " does not have a stream to load.");
         }
 
+        if (properties.isEmpty()) {
+            return ValidateOf.valid(List.of(new ConfigNodeContainer(new MapNode(Map.of()), source)));
+        }
+
         List<Pair<String, String>> configs = properties.entrySet()
                                                        .stream()
                                                        .map(prop -> new Pair<>((String) prop.getKey(), (String) prop.getValue()))

diff --git a/...alt-core/src/test/java/org/github/gestalt/config/integration/GestaltIntegrationTests.java b/...alt-core/src/test/java/org/github/gestalt/config/integration/GestaltIntegrationTests.java
@@ -11,11 +11,11 @@
 import org.github.gestalt.config.reflect.TypeCapture;
 import org.github.gestalt.config.reload.CoreReloadListener;
 import org.github.gestalt.config.reload.FileChangeReloadStrategy;
+import org.github.gestalt.config.reload.ManualConfigReloadStrategy;
 import org.github.gestalt.config.source.*;
 import org.github.gestalt.config.tag.Tags;
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.BeforeAll;
-import org.junit.jupiter.api.Disabled;
 import org.junit.jupiter.api.Test;
 
 import java.io.File;
@@ -81,7 +81,7 @@ public void integrationTestProxyPassThrough() throws GestaltException {
 
     //to run this test it must be run as an administrator.
     @Test
-    @Disabled
+    //@Disabled
     public void integrationTestReloadFile() throws GestaltException, IOException, InterruptedException {
         Map<String, String> configs = new HashMap<>();
         configs.put("db.hosts[0].password", "1234");
@@ -108,6 +108,7 @@ public void integrationTestReloadFile() throws GestaltException, IOException, In
             .addSource(new MapConfigSource(configs))
             .addReloadStrategy(new FileChangeReloadStrategy(devFileSource))
             .addCoreReloadListener(reloadListener)
+            .setTreatNullValuesInClassAsErrors(false)
             .build();
 
         gestalt.loadConfigs();
@@ -232,6 +233,64 @@ public void integrationTestReloadFile() throws GestaltException, IOException, In
         Assertions.assertEquals("jdbc:postgresql://dev.host.name3:5432/mydb2", hosts.get(2).url);
     }
 
+    @Test
+    public void integrationTestEmpty() throws GestaltException {
+        Map<String, String> configs = new HashMap<>();
+        configs.put("db.hosts[0].password", "1234");
+        configs.put("db.hosts[1].password", "5678");
+        configs.put("db.hosts[2].password", "9012");
+
+        String fileURL = "https://raw.githubusercontent.com/gestalt-config/gestalt/main/gestalt-core/src/test/resources/default.properties";
+
+        GestaltBuilder builder = new GestaltBuilder();
+        Gestalt gestalt = builder
+            .addSource(new URLConfigSource(fileURL))
+            .addSource(new ClassPathConfigSource("dev.properties"))
+            .addSource(new ClassPathConfigSource("empty.properties"))
+            .addSource(new MapConfigSource(configs))
+            .addSource(new StringConfigSource("db.idleTimeout=123", "properties"))
+            .addSource(new StringConfigSource("", "properties"))
+            .setTreatNullValuesInClassAsErrors(false)
+            .build();
+
+        gestalt.loadConfigs();
+
+        validateResults(gestalt);
+    }
+
+    @Test
+    public void integrationTestEmptyReload() throws GestaltException {
+        Map<String, String> configs = new HashMap<>();
+        configs.put("db.hosts[0].password", "1234");
+        configs.put("db.hosts[1].password", "5678");
+        configs.put("db.hosts[2].password", "9012");
+
+        String fileURL = "https://raw.githubusercontent.com/gestalt-config/gestalt/main/gestalt-core/src/test/resources/default.properties";
+
+        ConfigSource emptyString = new StringConfigSource("", "properties");
+        ManualConfigReloadStrategy reloadStrategy = new ManualConfigReloadStrategy(emptyString);
+
+        GestaltBuilder builder = new GestaltBuilder();
+        Gestalt gestalt = builder
+            .addSource(new URLConfigSource(fileURL))
+            .addSource(new ClassPathConfigSource("dev.properties"))
+            .addSource(new ClassPathConfigSource("empty.properties"))
+            .addSource(new MapConfigSource(configs))
+            .addSource(new StringConfigSource("db.idleTimeout=123", "properties"))
+            .addSource(emptyString)
+            .addReloadStrategy(reloadStrategy)
+            .setTreatNullValuesInClassAsErrors(false)
+            .build();
+
+        gestalt.loadConfigs();
+
+        validateResults(gestalt);
+
+        reloadStrategy.reload();
+
+        validateResults(gestalt);
+    }
+
     @Test
     public void integrationTestEnvVars() throws GestaltException {
 

diff --git a/gestalt-core/src/test/java/org/github/gestalt/config/loader/MapConfigLoaderTest.java b/gestalt-core/src/test/java/org/github/gestalt/config/loader/MapConfigLoaderTest.java
@@ -351,4 +351,20 @@ void loadSourceBadSource() throws GestaltException {
             Assertions.assertEquals("Config source: String format: conf does not have a list to load.", e.getMessage());
         }
     }
+
+    @Test
+    void loadSourceEmpty() throws GestaltException {
+
+        MapConfigSource source = new MapConfigSource(Map.of());
+
+        MapConfigLoader mapConfigLoader = new MapConfigLoader();
+
+        ValidateOf<List<ConfigNodeContainer>> resultContainer = mapConfigLoader.loadSource(source);
+
+        Assertions.assertFalse(resultContainer.hasErrors());
+        Assertions.assertTrue(resultContainer.hasResults());
+
+        ConfigNode result = resultContainer.results().get(0).getConfigNode();
+        Assertions.assertEquals(0, result.size());
+    }
 }
diff --git a/gestalt-core/src/test/java/org/github/gestalt/config/loader/PropertyLoaderTest.java b/gestalt-core/src/test/java/org/github/gestalt/config/loader/PropertyLoaderTest.java
@@ -10,6 +10,7 @@
 import org.github.gestalt.config.parser.ConfigParser;
 import org.github.gestalt.config.source.ConfigSource;
 import org.github.gestalt.config.source.MapConfigSource;
+import org.github.gestalt.config.source.StringConfigSource;
 import org.github.gestalt.config.tag.Tags;
 import org.github.gestalt.config.token.ObjectToken;
 import org.github.gestalt.config.token.Token;
@@ -367,4 +368,20 @@ void loadSourceBadSource() {
             Assertions.assertEquals("Config source: mapConfig does not have a stream to load.", e.getMessage());
         }
     }
+
+    @Test
+    void loadSourceEmpty() throws GestaltException {
+
+        StringConfigSource source = new StringConfigSource("", "properties");
+
+        PropertyLoader propertyLoader = new PropertyLoader();
+
+        ValidateOf<List<ConfigNodeContainer>> resultContainer = propertyLoader.loadSource(source);
+
+        Assertions.assertFalse(resultContainer.hasErrors());
+        Assertions.assertTrue(resultContainer.hasResults());
+
+        ConfigNode result = resultContainer.results().get(0).getConfigNode();
+        Assertions.assertEquals(0, result.size());
+    }
 }
diff --git a/gestalt-core/src/test/resources/empty.properties b/gestalt-core/src/test/resources/empty.properties
diff --git a/gestalt-toml/src/test/java/org/github/gestalt/config/toml/TomlLoaderTest.java b/gestalt-toml/src/test/java/org/github/gestalt/config/toml/TomlLoaderTest.java
@@ -166,6 +166,23 @@ void loadSourceEmptyValue() throws GestaltException {
         }
     }
 
+    @Test
+    void loadSourceEmpty() throws GestaltException {
+
+        StringConfigSource source = new StringConfigSource("", "toml");
+
+        TomlLoader tomlLoader = new TomlLoader();
+
+        ValidateOf<List<ConfigNodeContainer>> resultContainer = tomlLoader.loadSource(source);
+
+        Assertions.assertFalse(resultContainer.hasErrors());
+        Assertions.assertTrue(resultContainer.hasResults());
+
+        ConfigNode result = resultContainer.results().get(0).getConfigNode();
+
+        Assertions.assertEquals(0, result.size());
+    }
+
     @Test
     void loadSourceBadInput() throws GestaltException {
 

diff --git a/gestalt-yaml/src/main/java/org/github/gestalt/config/yaml/YamlLoader.java b/gestalt-yaml/src/main/java/org/github/gestalt/config/yaml/YamlLoader.java
@@ -19,6 +19,8 @@
 import java.io.InputStream;
 import java.util.*;
 
+import static com.fasterxml.jackson.databind.node.JsonNodeType.MISSING;
+
 /**
  * Loads from a yaml files from multiple sources, such as a file.
  *
@@ -74,6 +76,10 @@ public ValidateOf<List<ConfigNodeContainer>> loadSource(ConfigSource source) thr
                     throw new GestaltException("Exception loading source: " + source.name() + " no yaml found");
                 }
 
+                if (jsonNode.getNodeType() == MISSING) {
+                    return ValidateOf.valid(List.of(new ConfigNodeContainer(new MapNode(Map.of()), source)));
+                }
+
                 ValidateOf<ConfigNode> node = buildConfigTree("", jsonNode);
 
                 if (node.hasResults()) {

diff --git a/gestalt-yaml/src/test/java/org/github/gestalt/config/yaml/YamlLoaderTest.java b/gestalt-yaml/src/test/java/org/github/gestalt/config/yaml/YamlLoaderTest.java
@@ -209,4 +209,21 @@ void loadSourceBadSource() {
             Assertions.assertEquals("Config source: mapConfig does not have a stream to load.", e.getMessage());
         }
     }
+
+    @Test
+    void loadSourceEmptySource() throws GestaltException {
+
+        StringConfigSource source = new StringConfigSource("", "yml");
+
+        YamlLoader yamlLoader = new YamlLoader();
+
+        ValidateOf<List<ConfigNodeContainer>> resultContainer = yamlLoader.loadSource(source);
+
+        Assertions.assertFalse(resultContainer.hasErrors());
+        Assertions.assertTrue(resultContainer.hasResults());
+
+        ConfigNode result = resultContainer.results().get(0).getConfigNode();
+
+        Assertions.assertEquals(0, result.size());
+    }
 }