4.x: Meta-configuration fixes (helidon-io#9233)

* Do not use meta configuration unless requested by user. * Set global config from MP * Ignore meta-config failures (and log them as warning) in SE * Make sure we convert enums correctly Signed-off-by: Tomas Langer <tomas.langer@oracle.com>
Captain1653 · Sep 5, 2024 · 2397b81 · 2397b81
1 parent e31d55a
commit 2397b81
Show file tree

Hide file tree

Showing 20 changed files with 554 additions and 24 deletions.
diff --git a/config/config-mp/src/main/java/io/helidon/config/mp/MpConfigImpl.java b/config/config-mp/src/main/java/io/helidon/config/mp/MpConfigImpl.java
@@ -30,6 +30,7 @@
 import java.util.LinkedHashSet;
 import java.util.LinkedList;
 import java.util.List;
+import java.util.Locale;
 import java.util.Map;
 import java.util.NoSuchElementException;
 import java.util.Optional;
@@ -452,7 +453,11 @@ private <T> Optional<Converter<T>> findImplicit(Class<T> type) {
         if (Enum.class.isAssignableFrom(type)) {
             return Optional.of(value -> {
                 Class<? extends Enum> enumClass = (Class<? extends Enum>) type;
-                return (T) Enum.valueOf(enumClass, value);
+                try {
+                    return (T) Enum.valueOf(enumClass, value);
+                } catch (Exception e) {
+                    return (T) Enum.valueOf(enumClass, value.toUpperCase(Locale.ROOT));
+                }
             });
         }
         // any class that has a "public static T method()"

diff --git a/config/config-mp/src/main/java/io/helidon/config/mp/MpConfigProviderResolver.java b/config/config-mp/src/main/java/io/helidon/config/mp/MpConfigProviderResolver.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019, 2023 Oracle and/or its affiliates.
+ * Copyright (c) 2019, 2024 Oracle and/or its affiliates.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -32,6 +32,7 @@
 import java.util.stream.Stream;
 
 import io.helidon.common.GenericType;
+import io.helidon.common.config.GlobalConfig;
 import io.helidon.config.ConfigValue;
 import io.helidon.config.MetaConfig;
 import io.helidon.config.spi.ConfigMapper;
@@ -167,8 +168,8 @@ public static void buildTimeEnd() {
     private ConfigDelegate doRegisterConfig(Config config, ClassLoader classLoader) {
         ConfigDelegate currentConfig = CONFIGS.remove(classLoader);
 
-        if (config instanceof ConfigDelegate) {
-            config = ((ConfigDelegate) config).delegate();
+        if (config instanceof ConfigDelegate delegate) {
+            config = delegate.delegate();
         }
 
         if (null != currentConfig) {
@@ -178,6 +179,11 @@ private ConfigDelegate doRegisterConfig(Config config, ClassLoader classLoader)
         ConfigDelegate newConfig = new ConfigDelegate(config);
         CONFIGS.put(classLoader, newConfig);
 
+        if (classLoader == Thread.currentThread().getContextClassLoader()) {
+            // this should be the default class loader (we do not support classloader magic in Helidon)
+            GlobalConfig.config(() -> newConfig, true);
+        }
+
         return newConfig;
     }
 

diff --git a/config/config/src/main/java/io/helidon/config/BuilderImpl.java b/config/config/src/main/java/io/helidon/config/BuilderImpl.java
@@ -61,6 +61,7 @@ class BuilderImpl implements Config.Builder {
     private MergingStrategy mergingStrategy = MergingStrategy.fallback();
     private boolean hasSystemPropertiesSource;
     private boolean hasEnvVarSource;
+    private boolean sourcesConfigured;
     /*
      * Config mapper providers
      */
@@ -123,6 +124,8 @@ public Config.Builder sources(List<Supplier<? extends ConfigSource>> sourceSuppl
         sourceSuppliers.stream()
                 .map(Supplier::get)
                 .forEach(this::addSource);
+        // this was intentional, even if empty (such as from Config.just())
+        this.sourcesConfigured = true;
 
         return this;
     }
@@ -427,14 +430,14 @@ private ConfigSourcesRuntime buildConfigSources(ConfigContextImpl context) {
             envVarAliasGeneratorEnabled = true;
         }
 
-        boolean nothingConfigured = sources.isEmpty();
+        boolean nothingConfigured = sources.isEmpty() && !sourcesConfigured;
 
         if (nothingConfigured) {
             // use meta configuration to load all sources
-            MetaConfig.configSources(mediaType -> context.findParser(mediaType).isPresent(), context.supportedSuffixes())
-                    .stream()
+            MetaConfigFinder.findConfigSource(mediaType -> context.findParser(mediaType).isPresent(),
+                                                     context.supportedSuffixes())
                     .map(context::sourceRuntimeBase)
-                    .forEach(targetSources::add);
+                    .ifPresent(targetSources::add);
         } else {
             // add all configured or discovered sources
 

diff --git a/config/config/src/main/java/io/helidon/config/Config.java b/config/config/src/main/java/io/helidon/config/Config.java
@@ -1635,8 +1635,14 @@ default Builder sources(Supplier<? extends ConfigSource> configSource,
          * @see #config(Config)
          */
         default Builder metaConfig() {
-            MetaConfig.metaConfig()
-                    .ifPresent(this::config);
+            try {
+                MetaConfig.metaConfig()
+                        .ifPresent(this::config);
+            } catch (Exception e) {
+                System.getLogger(getClass().getName())
+                        .log(System.Logger.Level.WARNING, "Failed to load SE meta-configuration,"
+                                + " please make sure it has correct format.", e);
+            }
 
             return this;
         }

diff --git a/config/config/src/main/java/io/helidon/config/MetaConfig.java b/config/config/src/main/java/io/helidon/config/MetaConfig.java
@@ -22,7 +22,6 @@
 import java.util.Optional;
 import java.util.ServiceLoader;
 import java.util.Set;
-import java.util.function.Function;
 
 import io.helidon.common.HelidonServiceLoader;
 import io.helidon.common.media.type.MediaType;
@@ -241,18 +240,6 @@ static List<ConfigSource> configSources(Config metaConfig) {
         return configSources;
     }
 
-    // only interested in config source
-    static List<ConfigSource> configSources(Function<MediaType, Boolean> supportedMediaType, List<String> supportedSuffixes) {
-        Optional<Config> metaConfigOpt = metaConfig();
-
-        return metaConfigOpt
-                .map(MetaConfig::configSources)
-                .orElseGet(() -> MetaConfigFinder.findConfigSource(supportedMediaType, supportedSuffixes)
-                        .map(List::of)
-                        .orElseGet(List::of));
-
-    }
-
     private static Config createDefault() {
         // use defaults
         Config.Builder builder = Config.builder();

diff --git a/config/tests/pom.xml b/config/tests/pom.xml
@@ -64,5 +64,8 @@
         <module>config-metadata-meta-api</module>
         <module>config-metadata-builder-api</module>
         <module>test-lazy-source</module>
+        <module>test-no-config-sources</module>
+        <module>test-default-config-source</module>
+        <module>test-mp-se-meta</module>
     </modules>
 </project>
diff --git a/config/tests/test-default-config-source/pom.xml b/config/tests/test-default-config-source/pom.xml
@@ -0,0 +1,63 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+    Copyright (c) 2024 Oracle and/or its affiliates.
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+        http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
+-->
+
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <groupId>io.helidon.config.tests</groupId>
+        <artifactId>helidon-config-tests-project</artifactId>
+        <version>4.1.0-SNAPSHOT</version>
+        <relativePath>../pom.xml</relativePath>
+    </parent>
+    <artifactId>helidon-test-default-config-source</artifactId>
+    <name>Helidon Config Tests Default Config Source</name>
+
+    <description>
+        Test that when no config sources are configured, we do not fall to meta config, but we want to
+        use default config sources
+    </description>
+
+    <dependencies>
+        <dependency>
+            <groupId>io.helidon.config</groupId>
+            <artifactId>helidon-config</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>io.helidon.config</groupId>
+            <artifactId>helidon-config-yaml</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>io.helidon.common.testing</groupId>
+            <artifactId>helidon-common-testing-junit5</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.hamcrest</groupId>
+            <artifactId>hamcrest-all</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter-api</artifactId>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
+</project>
diff --git a/config/tests/test-default-config-source/src/main/resources/application.yaml b/config/tests/test-default-config-source/src/main/resources/application.yaml
@@ -0,0 +1,17 @@
+#
+# Copyright (c) 2024 Oracle and/or its affiliates.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+value: "from-file"
diff --git a/config/tests/test-default-config-source/src/main/resources/meta-config.yaml b/config/tests/test-default-config-source/src/main/resources/meta-config.yaml
@@ -0,0 +1,21 @@
+#
+# Copyright (c) 2024 Oracle and/or its affiliates.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+# MP style, which would normally fail in Helidon SE, but should be ignored, as we do not specify meta config
+add-default-sources: true
+sources:
+  - type: "properties"
+    classpath: "app.properties"
diff --git a/...ault-config-source/src/test/java/io/helidon/config/tests/nosources/DefaultSourceTest.java b/...ault-config-source/src/test/java/io/helidon/config/tests/nosources/DefaultSourceTest.java
@@ -0,0 +1,46 @@
+/*
+ * Copyright (c) 2024 Oracle and/or its affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.helidon.config.tests.nosources;
+
+import java.util.Optional;
+
+import io.helidon.config.Config;
+
+import org.junit.jupiter.api.Test;
+
+import static io.helidon.common.testing.junit5.OptionalMatcher.optionalValue;
+import static org.hamcrest.CoreMatchers.is;
+import static org.hamcrest.MatcherAssert.assertThat;
+
+public class DefaultSourceTest {
+    @Test
+    public void testDefaultSource() {
+        Config config = Config.builder()
+                .disableSystemPropertiesSource()
+                .disableEnvironmentVariablesSource()
+                .build();
+
+        Optional<String> value = config.get("value")
+                .asString()
+                .asOptional();
+
+        // meta config MUST be ignored
+        assertThat("We defined not sources, we should fall back to default application.yaml",
+                   value,
+                   optionalValue(is("from-file")));
+    }
+}
diff --git a/config/tests/test-mp-se-meta/pom.xml b/config/tests/test-mp-se-meta/pom.xml
@@ -0,0 +1,67 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+    Copyright (c) 2024 Oracle and/or its affiliates.
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+        http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
+-->
+
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <groupId>io.helidon.config.tests</groupId>
+        <artifactId>helidon-config-tests-project</artifactId>
+        <version>4.1.0-SNAPSHOT</version>
+        <relativePath>../pom.xml</relativePath>
+    </parent>
+    <artifactId>helidon-config-tests-mp-se-meta</artifactId>
+    <name>Helidon Config Tests MP SE Meta</name>
+
+    <description>
+        Test that when using MP config with meta-config file name that conflicts with Helidon SE, everything
+        works as expected.
+    </description>
+
+    <dependencies>
+        <dependency>
+            <groupId>io.helidon.config</groupId>
+            <artifactId>helidon-config</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>io.helidon.config</groupId>
+            <artifactId>helidon-config-mp</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>io.helidon.config</groupId>
+            <artifactId>helidon-config-yaml</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>io.helidon.common.testing</groupId>
+            <artifactId>helidon-common-testing-junit5</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.hamcrest</groupId>
+            <artifactId>hamcrest-all</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter-api</artifactId>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
+</project>
diff --git a/config/tests/test-mp-se-meta/src/main/resources/app.properties b/config/tests/test-mp-se-meta/src/main/resources/app.properties
@@ -0,0 +1,17 @@
+#
+# Copyright (c) 2024 Oracle and/or its affiliates.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+helidon.test.value=value