Fallbacks from kubernetes to openshift and knative

extensions/kubernetes/openshift/deployment/src/test/java/io/quarkus/openshift/deployment/config/OpenShiftConfigFallbackTest.java

@@ -51,9 +51,9 @@ void configFallback() throws Exception {
         YamlConfigSource kubernetes = new YamlConfigSource(kubernetesDir.resolve("kubernetes.yml").toUri().toURL());
         YamlConfigSource openshift = new YamlConfigSource(kubernetesDir.resolve("openshift.yml").toUri().toURL());
 
-        // Only in Kubernetes, must fallback to Openshift
+        // spec.replicas is only for Kubernetes and Openshift, no fallback
         assertEquals("10", kubernetes.getValue("spec.replicas"));
-        assertEquals("10", openshift.getValue("spec.replicas"));
+        assertEquals("1", openshift.getValue("spec.replicas"));
 
         // In both, each should retain the value
         assertEquals("0.1-SNAPSHOT", kubernetes.getValue("spec.template.metadata.labels.\"app.kubernetes.io/version\""));

extensions/kubernetes/vanilla/deployment/src/main/java/io/quarkus/kubernetes/deployment/KubernetesConfigBuilderCustomizer.java

@@ -0,0 +1,207 @@
+package io.quarkus.kubernetes.deployment;
+
+import static io.smallrye.config.ConfigMappingInterface.getProperties;
+import static io.smallrye.config.ConfigMappingLoader.getConfigMapping;
+import static io.smallrye.config.ProfileConfigSourceInterceptor.convertProfile;
+
+import java.util.Comparator;
+import java.util.HashSet;
+import java.util.Iterator;
+import java.util.List;
+import java.util.OptionalInt;
+import java.util.Set;
+import java.util.function.Function;
+
+import io.smallrye.config.ConfigSourceInterceptor;
+import io.smallrye.config.ConfigSourceInterceptorContext;
+import io.smallrye.config.ConfigSourceInterceptorFactory;
+import io.smallrye.config.ConfigValue;
+import io.smallrye.config.FallbackConfigSourceInterceptor;
+import io.smallrye.config.NameIterator;
+import io.smallrye.config.Priorities;
+import io.smallrye.config.PropertyName;
+import io.smallrye.config.RelocateConfigSourceInterceptor;
+import io.smallrye.config.SmallRyeConfigBuilder;
+import io.smallrye.config.SmallRyeConfigBuilderCustomizer;
+
+public class KubernetesConfigBuilderCustomizer implements SmallRyeConfigBuilderCustomizer {
+    @Override
+    public void configBuilder(final SmallRyeConfigBuilder builder) {
+        Set<PropertyName> ignoreNames = ignoreNames();
+
+        builder.withInterceptorFactories(new ConfigSourceInterceptorFactory() {
+            @Override
+            public ConfigSourceInterceptor getInterceptor(final ConfigSourceInterceptorContext context) {
+                return new Fallbacks(new Function<String, String>() {
+                    @Override
+                    public String apply(final String name) {
+                        if (name.startsWith("quarkus.openshift.") && !ignoreNames.contains(new PropertyName(name))) {
+                            return "quarkus.kubernetes." + name.substring(18);
+                        } else if (name.startsWith("quarkus.knative.") && !ignoreNames.contains(new PropertyName(name))) {
+                            return "quarkus.kubernetes." + name.substring(16);
+                        }
+                        return name;
+                    }
+                }) {
+                    // There is no bidirectional connection between kubernetes and openshift / knative, so do not
+                    // include reverse properties
+                    @Override
+                    public Iterator<String> iterateNames(final ConfigSourceInterceptorContext context) {
+                        return context.iterateNames();
+                    }
+                };
+            }
+
+            @Override
+            public OptionalInt getPriority() {
+                return OptionalInt.of(Priorities.LIBRARY + 590);
+            }
+        });
+        // To rewrite the fallback names to the main name. Required for fallbacks to work properly with Maps keys
+        builder.withInterceptorFactories(new ConfigSourceInterceptorFactory() {
+            @Override
+            public ConfigSourceInterceptor getInterceptor(final ConfigSourceInterceptorContext context) {
+                return new RelocateConfigSourceInterceptor(new Function<String, String>() {
+                    @Override
+                    public String apply(final String name) {
+                        if (name.startsWith("quarkus.kubernetes.") && !ignoreNames.contains(new PropertyName(name))) {
+                            return "quarkus.openshift." + name.substring(19);
+                        }
+                        return name;
+                    }
+                }) {
+                    @Override
+                    public ConfigValue getValue(final ConfigSourceInterceptorContext context, final String name) {
+                        return context.proceed(name);
+                    }
+                };
+            }
+        });
+        // To rewrite the fallback names to the main name. Required for fallbacks to work properly with Maps keys
+        builder.withInterceptorFactories(new ConfigSourceInterceptorFactory() {
+            @Override
+            public ConfigSourceInterceptor getInterceptor(final ConfigSourceInterceptorContext context) {
+                return new RelocateConfigSourceInterceptor(new Function<String, String>() {
+                    @Override
+                    public String apply(final String name) {
+                        if (name.startsWith("quarkus.kubernetes.") && !ignoreNames.contains(new PropertyName(name))) {
+                            return "quarkus.knative." + name.substring(19);
+                        }
+                        return name;
+                    }
+                }) {
+                    @Override
+                    public ConfigValue getValue(final ConfigSourceInterceptorContext context, final String name) {
+                        return context.proceed(name);
+                    }
+                };
+            }
+        });
+    }
+
+    /**
+     * Overrides the base {@link FallbackConfigSourceInterceptor} to use {@link ConfigSourceInterceptorContext#restart}
+     * instead of {@link ConfigSourceInterceptorContext#proceed}. The plan is to move the base one to use it as well,
+     * but it is a breaking change so it is better to keep it locally here for now.
+     */
+    private static class Fallbacks extends FallbackConfigSourceInterceptor {
+        public Fallbacks(final Function<String, String> mapping) {
+            super(mapping);
+        }
+
+        @Override
+        public ConfigValue getValue(final ConfigSourceInterceptorContext context, final String name) {
+            ConfigValue configValue = context.proceed(name);
+            String map = getMapping().apply(name);
+
+            if (name.equals(map)) {
+                return configValue;
+            }
+
+            ConfigValue fallbackValue = context.restart(map);
+            // Check which one comes from a higher ordinal source to avoid defaults from the main name
+            if (configValue != null && fallbackValue != null) {
+                return CONFIG_SOURCE_COMPARATOR.compare(configValue, fallbackValue) >= 0 ? configValue
+                        : fallbackValue.withName(name);
+            }
+
+            if (configValue != null) {
+                return configValue;
+            } else if (fallbackValue != null) {
+                return fallbackValue.withName(name);
+            }
+            return null;
+        }
+    }
+
+    // TODO - This will become public in a new version of SmallRye Config - can be removed later
+    private static final Comparator<ConfigValue> CONFIG_SOURCE_COMPARATOR = new Comparator<ConfigValue>() {
+        @Override
+        public int compare(ConfigValue original, ConfigValue candidate) {
+            int result = Integer.compare(original.getConfigSourceOrdinal(), candidate.getConfigSourceOrdinal());
+            if (result != 0) {
+                return result;
+            }
+            result = Integer.compare(original.getConfigSourcePosition(), candidate.getConfigSourcePosition()) * -1;
+            if (result != 0) {
+                return result;
+            }
+            // If both properties are profiled, prioritize the one with the most specific profile.
+            if (original.getName().charAt(0) == '%' && candidate.getName().charAt(0) == '%') {
+                List<String> originalProfiles = convertProfile(
+                        new NameIterator(original.getName()).getNextSegment().substring(1));
+                List<String> candidateProfiles = convertProfile(
+                        new NameIterator(candidate.getName()).getNextSegment().substring(1));
+                return Integer.compare(originalProfiles.size(), candidateProfiles.size()) * -1;
+            }
+            return result;
+        }
+    };
+
+    /**
+     * Collect the properties names that are not shared between <code>kubernetes</code>, <code>openshift</code> and
+     * <code>knative</code> to ignore when performing the fallback functions.
+     *
+     * @return a Set of properties names to ignore
+     */
+    private static Set<PropertyName> ignoreNames() {
+        Set<String> kubernetes = getProperties(getConfigMapping(KubernetesConfig.class))
+                .get(KubernetesConfig.class).get("").keySet();
+        Set<String> openshift = getProperties(getConfigMapping(OpenShiftConfig.class))
+                .get(OpenShiftConfig.class).get("").keySet();
+        Set<String> knative = getProperties(getConfigMapping(KnativeConfig.class))
+                .get(KnativeConfig.class).get("").keySet();
+
+        Set<PropertyName> ignored = new HashSet<>();
+        for (String name : kubernetes) {
+            if (!openshift.contains(name) || !knative.contains(name)) {
+                ignored.add(new PropertyName("quarkus.kubernetes." + name));
+                ignored.add(new PropertyName("quarkus.openshift." + name));
+                ignored.add(new PropertyName("quarkus.knative." + name));
+            }
+        }
+        for (String name : openshift) {
+            if (!kubernetes.contains(name) || !knative.contains(name)) {
+                ignored.add(new PropertyName("quarkus.kubernetes." + name));
+                ignored.add(new PropertyName("quarkus.openshift." + name));
+                ignored.add(new PropertyName("quarkus.knative." + name));
+            }
+        }
+        for (String name : knative) {
+            if (!kubernetes.contains(name) || !openshift.contains(name)) {
+                ignored.add(new PropertyName("quarkus.kubernetes." + name));
+                ignored.add(new PropertyName("quarkus.openshift." + name));
+                ignored.add(new PropertyName("quarkus.knative." + name));
+            }
+        }
+
+        // These are shared, but must work independently
+        ignored.add(new PropertyName("quarkus.kubernetes.deploy"));
+        ignored.add(new PropertyName("quarkus.openshift.deploy"));
+        ignored.add(new PropertyName("quarkus.knative.deploy"));
+        ignored.add(new PropertyName("quarkus.kubernetes.deploy-strategy"));
+        ignored.add(new PropertyName("quarkus.openshift.deploy-strategy"));
+        ignored.add(new PropertyName("quarkus.knative.deploy-strategy"));
+        return ignored;
+    }
+}

extensions/kubernetes/vanilla/deployment/src/main/resources/META-INF/services/io.smallrye.config.SmallRyeConfigBuilderCustomizer

@@ -0,0 +1 @@
+io.quarkus.kubernetes.deployment.KubernetesConfigBuilderCustomizer

extensions/kubernetes/vanilla/deployment/src/test/java/io/quarkus/kubernetes/deployment/KubernetesConfigFallbackTest.java

@@ -0,0 +1,49 @@
+package io.quarkus.kubernetes.deployment;
+
+import static io.smallrye.config.PropertiesConfigSourceLoader.inClassPath;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+import java.time.Duration;
+import java.util.Map;
+
+import org.junit.jupiter.api.Test;
+
+import io.quarkus.runtime.configuration.DurationConverter;
+import io.smallrye.config.SmallRyeConfig;
+import io.smallrye.config.SmallRyeConfigBuilder;
+
+class KubernetesConfigFallbackTest {
+    @Test
+    void fallback() {
+        SmallRyeConfig config = new SmallRyeConfigBuilder()
+                .withSources(
+                        inClassPath("application-kubernetes.properties", 250, Thread.currentThread().getContextClassLoader()))
+                .addDiscoveredCustomizers()
+                .withConverter(Duration.class, 100, new DurationConverter())
+                .withMappingIgnore("quarkus.**")
+                .withMapping(KubernetesConfig.class)
+                .withMapping(OpenShiftConfig.class)
+                .withMapping(KnativeConfig.class)
+                .build();
+
+        KubernetesConfig kubernetes = config.getConfigMapping(KubernetesConfig.class);
+        OpenShiftConfig openShift = config.getConfigMapping(OpenShiftConfig.class);
+        KnativeConfig knative = config.getConfigMapping(KnativeConfig.class);
+
+        assertTrue(kubernetes.name().isPresent());
+        assertTrue(openShift.name().isPresent());
+        assertEquals("naruto", kubernetes.name().get());
+        assertEquals("sasuke", openShift.name().get());
+        assertEquals(knative.name(), kubernetes.name());
+
+        assertEquals(kubernetes.partOf(), openShift.partOf());
+
+        for (Map.Entry<String, String> entry : kubernetes.labels().entrySet()) {
+            assertTrue(openShift.labels().containsKey(entry.getKey()));
+            assertEquals(openShift.labels().get(entry.getKey()), entry.getValue());
+            assertTrue(knative.labels().containsKey(entry.getKey()));
+            assertEquals(knative.labels().get(entry.getKey()), entry.getValue());
+        }
+    }
+}

extensions/kubernetes/vanilla/deployment/src/test/java/io/quarkus/kubernetes/deployment/KubernetesConfigTest.java

@@ -11,7 +11,6 @@
 import java.nio.file.Path;
 import java.util.List;
 import java.util.Map;
-import java.util.function.Consumer;
 
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.RegisterExtension;
@@ -43,15 +42,6 @@ class KubernetesConfigTest {
     @SuppressWarnings("unchecked")
     void kubernetes() throws Exception {
         Path outputDir = prodModeTestResults.getBuildDir().resolve("kubernetes");
-        Files.list(outputDir).forEach(new Consumer<Path>() {
-            @Override
-            public void accept(final Path path) {
-                System.out.println(path);
-            }
-        });
-        String kubernetes = new String(Files.readAllBytes(outputDir.resolve("kubernetes.yml")));
-        System.out.println(kubernetes);
-
         Iterable<Object> objects = new Yaml().loadAll(new String(Files.readAllBytes(outputDir.resolve("kubernetes.yml"))));
         for (Object object : objects) {
             if (((Map<String, Object>) object).get("kind").equals("Secret")) {

extensions/kubernetes/vanilla/deployment/src/test/resources/application-kubernetes.properties

@@ -231,7 +231,8 @@ quarkus.kubernetes.env.vars.UCHIHA_SASUKE=sasuke
 #quarkus.kubernetes.env.using-prefix."prefixes".for-configmap=
 
 # OpenShift
-quarkus.openshift.name=naruto
+quarkus.openshift.name=sasuke
+quarkus.openshift.version=0
 
 # Knative
 quarkus.knative.mounts.client-crts.path=/mnt/clientcerts