Merge pull request #18104 from radcortez/fix-17892

Do not record Env values in the runtime defaults

core/deployment/src/main/java/io/quarkus/deployment/configuration/BuildTimeConfigurationReader.java

@@ -54,8 +54,10 @@
 import io.quarkus.runtime.configuration.HyphenateEnumConverter;
 import io.quarkus.runtime.configuration.NameIterator;
 import io.smallrye.config.Converters;
+import io.smallrye.config.EnvConfigSource;
 import io.smallrye.config.Expressions;
 import io.smallrye.config.SmallRyeConfig;
+import io.smallrye.config.SmallRyeConfigBuilder;
 
 /**
  * A configuration reader.
@@ -296,6 +298,7 @@ ReadResult run() {
                 nameBuilder.setLength(len);
             }
             // sweep-up
+            SmallRyeConfig runtimeDefaultsConfig = getConfigForRuntimeDefaults();
             for (String propertyName : getAllProperties()) {
                 if (propertyName.equals(ConfigSource.CONFIG_ORDINAL)) {
                     continue;
@@ -380,12 +383,12 @@ ReadResult run() {
                     if (matched != null) {
                         // it's a specified run-time default (record for later)
                         specifiedRunTimeDefaultValues.put(propertyName, Expressions.withoutExpansion(
-                                () -> config.getOptionalValue(propertyName, String.class).orElse("")));
+                                () -> runtimeDefaultsConfig.getOptionalValue(propertyName, String.class).orElse("")));
                     }
                 } else {
                     // it's not managed by us; record it
                     specifiedRunTimeDefaultValues.put(propertyName, Expressions.withoutExpansion(
-                            () -> config.getOptionalValue(propertyName, String.class).orElse("")));
+                            () -> runtimeDefaultsConfig.getOptionalValue(propertyName, String.class).orElse("")));
                 }
             }
             return new ReadResult(objectsByRootClass, specifiedRunTimeDefaultValues, buildTimeRunTimeVisibleValues,
@@ -734,6 +737,28 @@ private Set<String> getAllProperties() {
             }
             return properties;
         }
+
+        /**
+         * Use this Config instance to record the specified runtime default values. We cannot use the main Config
+         * instance because it may record values coming from the EnvSource in build time. We do exclude the properties
+         * coming from the EnvSource, but a call to getValue may still provide values coming from the EnvSource, so we
+         * need to exclude it from sources when recoding values.
+         *
+         * We also do not want to completely exclude the EnvSource, because it may provide values for the build. This
+         * is only specific when recording the defaults.
+         *
+         * @return a new SmallRye instance without the EnvSources.
+         */
+        private SmallRyeConfig getConfigForRuntimeDefaults() {
+            SmallRyeConfigBuilder builder = ConfigUtils.emptyConfigBuilder();
+            for (ConfigSource configSource : config.getConfigSources()) {
+                if (configSource instanceof EnvConfigSource) {
+                    continue;
+                }
+                builder.withSources(configSource);
+            }
+            return builder.build();
+        }
     }
 
     public static final class ReadResult {

core/test-extension/deployment/src/main/resources/application.properties

@@ -145,3 +145,6 @@ QUARKUS_HTTP_NON_APPLICATION_ROOT_PATH=/1234
 quarkus.http.non.application.root.path=/1234
 QUARKUS_HTTP_SSL_PORT=4443
 quarkus.http.ssl.port=4443
+
+### Do not record env values in build time
+bt.do.not.record=properties

core/test-extension/deployment/src/test/java/io/quarkus/extest/RuntimeDefaultsTest.java

@@ -0,0 +1,42 @@
+package io.quarkus.extest;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+
+import javax.inject.Inject;
+
+import org.eclipse.microprofile.config.Config;
+import org.eclipse.microprofile.config.spi.ConfigSource;
+import org.jboss.shrinkwrap.api.ShrinkWrap;
+import org.jboss.shrinkwrap.api.spec.JavaArchive;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+import io.quarkus.test.QuarkusUnitTest;
+
+public class RuntimeDefaultsTest {
+    @RegisterExtension
+    static final QuarkusUnitTest TEST = new QuarkusUnitTest()
+            .setArchiveProducer(() -> ShrinkWrap.create(JavaArchive.class)
+                    // Don't change this to types, because of classloader class cast exception.
+                    .addAsServiceProvider("org.eclipse.microprofile.config.spi.ConfigSource",
+                            "io.quarkus.extest.runtime.config.EnvBuildTimeConfigSource")
+                    .addAsResource("application.properties"));
+
+    @Inject
+    Config config;
+
+    @Test
+    void doNotRecordEnvRuntimeDefaults() {
+        ConfigSource defaultValues = null;
+        for (ConfigSource configSource : config.getConfigSources()) {
+            if (configSource.getName().contains("PropertiesConfigSource[source=Specified default values]")) {
+                defaultValues = configSource;
+                break;
+            }
+        }
+        assertNotNull(defaultValues);
+
+        assertEquals("properties", defaultValues.getValue("bt.do.not.record"));
+    }
+}

core/test-extension/runtime/src/main/java/io/quarkus/extest/runtime/config/EnvBuildTimeConfigSource.java

@@ -0,0 +1,15 @@
+package io.quarkus.extest.runtime.config;
+
+import java.util.HashMap;
+
+import io.smallrye.config.EnvConfigSource;
+
+public class EnvBuildTimeConfigSource extends EnvConfigSource {
+    public EnvBuildTimeConfigSource() {
+        super(new HashMap<String, String>() {
+            {
+                put("BT_DO_NOT_RECORD", "env-source");
+            }
+        }, Integer.MAX_VALUE);
+    }
+}