Merge pull request #17549 from geoand/#17519

Allow extensions to suppress build time config change warnings

core/deployment/src/main/java/io/quarkus/deployment/builditem/SuppressNonRuntimeConfigChangedWarningBuildItem.java

@@ -0,0 +1,23 @@
+package io.quarkus.deployment.builditem;
+
+import io.quarkus.builder.item.MultiBuildItem;
+
+/**
+ * Allows extensions to suppress the runtime warning that Quarkus emits on startup when a non-runtime configuration
+ * options is different at runtime than build time.
+ * An example usage of this is when a user provides some test value in {@code application.properties}
+ * for a build-time only property and only provides the actual value on the command line when building Quarkus.
+ * In such a case we don't want the value set at build time to be revealed at runtime as it could be sensitive.
+ */
+public final class SuppressNonRuntimeConfigChangedWarningBuildItem extends MultiBuildItem {
+
+    private final String configKey;
+
+    public SuppressNonRuntimeConfigChangedWarningBuildItem(String configKey) {
+        this.configKey = configKey;
+    }
+
+    public String getConfigKey() {
+        return configKey;
+    }
+}

core/deployment/src/main/java/io/quarkus/deployment/steps/ConfigGenerationBuildStep.java

@@ -4,9 +4,11 @@
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.HashMap;
+import java.util.HashSet;
 import java.util.List;
 import java.util.Map;
 import java.util.Optional;
+import java.util.Set;
 import java.util.stream.Collectors;
 
 import org.eclipse.microprofile.config.Config;
@@ -26,6 +28,7 @@
 import io.quarkus.deployment.builditem.LaunchModeBuildItem;
 import io.quarkus.deployment.builditem.LiveReloadBuildItem;
 import io.quarkus.deployment.builditem.RunTimeConfigurationDefaultBuildItem;
+import io.quarkus.deployment.builditem.SuppressNonRuntimeConfigChangedWarningBuildItem;
 import io.quarkus.deployment.configuration.BuildTimeConfigurationReader;
 import io.quarkus.deployment.configuration.RunTimeConfigurationGenerator;
 import io.quarkus.deployment.configuration.definition.ClassDefinition;
@@ -95,27 +98,37 @@ private List<String> getAdditionalBootstrapConfigSourceProviders(
         return result;
     }
 
+    @BuildStep
+    public SuppressNonRuntimeConfigChangedWarningBuildItem ignoreQuarkusProfileChange() {
+        return new SuppressNonRuntimeConfigChangedWarningBuildItem("quarkus.profile");
+    }
+
     /**
      * Warns if build time config properties have been changed at runtime.
      */
     @BuildStep
     @Record(ExecutionTime.RUNTIME_INIT)
     public void checkForBuildTimeConfigChange(
             ConfigChangeRecorder recorder, ConfigurationBuildItem configItem, LoggingSetupBuildItem loggingSetupBuildItem,
-            ConfigurationRuntimeConfig configurationConfig) {
+            ConfigurationRuntimeConfig configurationConfig,
+            List<SuppressNonRuntimeConfigChangedWarningBuildItem> suppressNonRuntimeConfigChangedWarningItems) {
         BuildTimeConfigurationReader.ReadResult readResult = configItem.getReadResult();
         Config config = ConfigProvider.getConfig();
 
+        Set<String> excludedConfigKeys = new HashSet<>(suppressNonRuntimeConfigChangedWarningItems.size());
+        for (SuppressNonRuntimeConfigChangedWarningBuildItem item : suppressNonRuntimeConfigChangedWarningItems) {
+            excludedConfigKeys.add(item.getConfigKey());
+        }
+
         Map<String, String> values = new HashMap<>();
         for (RootDefinition root : readResult.getAllRoots()) {
             if (root.getConfigPhase() == ConfigPhase.BUILD_AND_RUN_TIME_FIXED ||
                     root.getConfigPhase() == ConfigPhase.BUILD_TIME) {
 
                 Iterable<ClassDefinition.ClassMember> members = root.getMembers();
-                handleMembers(config, values, members, "quarkus." + root.getRootName() + ".");
+                handleMembers(config, values, members, "quarkus." + root.getRootName() + ".", excludedConfigKeys);
             }
         }
-        values.remove("quarkus.profile");
         recorder.handleConfigChange(configurationConfig, values);
     }
 
@@ -133,11 +146,14 @@ public void setupConfigOverride(
     }
 
     private void handleMembers(Config config, Map<String, String> values, Iterable<ClassDefinition.ClassMember> members,
-            String prefix) {
+            String prefix, Set<String> excludedConfigKeys) {
         for (ClassDefinition.ClassMember member : members) {
             if (member instanceof ClassDefinition.ItemMember) {
                 ClassDefinition.ItemMember itemMember = (ClassDefinition.ItemMember) member;
                 String propertyName = prefix + member.getPropertyName();
+                if (excludedConfigKeys.contains(propertyName)) {
+                    continue;
+                }
                 Optional<String> val = config.getOptionalValue(propertyName, String.class);
                 if (val.isPresent()) {
                     values.put(propertyName, val.get());
@@ -146,7 +162,7 @@ private void handleMembers(Config config, Map<String, String> values, Iterable<C
                 }
             } else if (member instanceof ClassDefinition.GroupMember) {
                 handleMembers(config, values, ((ClassDefinition.GroupMember) member).getGroupDefinition().getMembers(),
-                        prefix + member.getDescriptor().getName() + ".");
+                        prefix + member.getDescriptor().getName() + ".", excludedConfigKeys);
             }
         }
     }

extensions/container-image/deployment/src/main/java/io/quarkus/container/image/deployment/ContainerImageProcessor.java

@@ -11,6 +11,7 @@
 import io.quarkus.deployment.annotations.BuildProducer;
 import io.quarkus.deployment.annotations.BuildStep;
 import io.quarkus.deployment.builditem.ApplicationInfoBuildItem;
+import io.quarkus.deployment.builditem.SuppressNonRuntimeConfigChangedWarningBuildItem;
 import io.quarkus.deployment.pkg.builditem.ArtifactResultBuildItem;
 import io.quarkus.deployment.pkg.steps.NativeSourcesBuild;
 
@@ -22,7 +23,13 @@ public class ContainerImageProcessor {
     @BuildStep(onlyIf = NativeSourcesBuild.class)
     void failForNativeSources(BuildProducer<ArtifactResultBuildItem> artifactResultProducer) {
         throw new IllegalArgumentException(
-                "The Container Imagee extensions are incompatible with the 'native-sources' package type.");
+                "The Container Image extensions are incompatible with the 'native-sources' package type.");
+    }
+
+    @BuildStep
+    public void ignoreCredentialsChange(BuildProducer<SuppressNonRuntimeConfigChangedWarningBuildItem> producer) {
+        producer.produce(new SuppressNonRuntimeConfigChangedWarningBuildItem("quarkus.container-image.username"));
+        producer.produce(new SuppressNonRuntimeConfigChangedWarningBuildItem("quarkus.container-image.password"));
     }
 
     @BuildStep