4.x: Make MP test annotations ordering deterministic (#9904)

Author: tvallin

docs/src/main/asciidoc/mp/testing/testing-common.adoc

@@ -203,15 +203,32 @@ include::{sourcedir}/mp/testing/TestingSnippets.java[tag=snippet_11, indent=0]
 The ordering of the test configuration can be controlled using the mechanism defined by the
 link:{microprofile-config-spec-url}#_configsource_ordering[MicroProfile Config specification].
 
-NOTE: The configuration expressed with link:{mp-testing-javadoc-url}/AddConfig.html[`@AddConfig`] has a fixed ordinal value
-of `1000`
-
 [source,java]
 .Add a properties text block with ordinal
 ----
 include::{sourcedir}/mp/testing/TestingSnippets.java[tag=snippet_12, indent=0]
 ----
 
+The default ordering is the following
+
+[cols="1,3"]
+|===
+|Annotation |Ordinal
+
+|link:{mp-testing-javadoc-url}/AddConfig.html[`@AddConfig`]
+|1000
+
+|link:{mp-testing-javadoc-url}/AddConfigBlock.html[`@AddConfigBlock`]
+|900
+
+|link:{mp-testing-javadoc-url}/AddConfigSource.html[`@AddConfigSource`]
+|800
+
+|link:{mp-testing-javadoc-url}/Configuration.html[`@Configuration`]
+|700
+
+|===
+
 === Injectable Types
 
 Helidon provides injection support for types that reflect the current server. E.g. JAXRS client.

microprofile/testing/testing/src/main/java/io/helidon/microprofile/testing/HelidonTestConfigSynthetic.java

@@ -37,6 +37,7 @@
 import org.eclipse.microprofile.config.spi.ConfigSource;
 
 import static io.helidon.microprofile.testing.ReflectionHelper.invoke;
+import static io.helidon.microprofile.testing.ReflectionHelper.isDefaultMethod;
 import static io.helidon.microprofile.testing.ReflectionHelper.requireStatic;
 
 /**
@@ -151,17 +152,20 @@ private Config buildConfig() {
         configSources.add(MpConfigSources.create(testInfo.id(), map));
         blocks.forEach((type, values) -> {
             for (String value : values) {
-                configSources.add(MpConfigSources.create(type, new StringReader(value)));
+                ConfigSource config = MpConfigSources.create(type, new StringReader(value));
+                configSources.add(addConfigOrdinal(config, type, "900"));
             }
         });
         for (Method m : methods) {
-            configSources.add(invoke(ConfigSource.class, requireStatic(m), null));
+            ConfigSource config = invoke(ConfigSource.class, requireStatic(m), null);
+            configSources.add(new ConfigSourceWrapper(config));
         }
         for (String source : resources) {
             String filename = source.trim();
             for (URL url : resources(filename)) {
                 String type = extension(filename);
-                configSources.add(MpConfigSources.create(type, url));
+                ConfigSource config = MpConfigSources.create(type, url);
+                configSources.add(addConfigOrdinal(config, type, "700"));
             }
         }
         ConfigBuilder builder = ConfigProviderResolver.instance()
@@ -173,6 +177,12 @@ private Config buildConfig() {
         return builder.build();
     }
 
+    private ConfigSource addConfigOrdinal(ConfigSource config, String type, String ordinal) {
+        Map<String, String> properties = new HashMap<>(config.getProperties());
+        properties.putIfAbsent(ConfigSource.CONFIG_ORDINAL, ordinal);
+        return MpConfigSources.create(type, properties);
+    }
+
     private static String extension(String filename) {
         int idx = filename.lastIndexOf('.');
         return idx > -1 ? filename.substring(idx + 1) : "properties";
@@ -190,4 +200,33 @@ private static Collection<URL> resources(String name) {
                     "Failed to read '%s' from classpath", name), e);
         }
     }
+
+    private record ConfigSourceWrapper(ConfigSource delegate) implements ConfigSource {
+        @Override
+        public Set<String> getPropertyNames() {
+            return delegate.getPropertyNames();
+        }
+
+        @Override
+        public String getValue(String propertyName) {
+            return delegate.getValue(propertyName);
+        }
+
+        @Override
+        public String getName() {
+            return delegate.getName();
+        }
+
+        @Override
+        public Map<String, String> getProperties() {
+            return delegate.getProperties();
+        }
+
+        @Override
+        public int getOrdinal() {
+            boolean isDefault = isDefaultMethod(delegate, "getOrdinal");
+            boolean isDefaultOrdinal = delegate.getOrdinal() == ConfigSource.DEFAULT_ORDINAL;
+            return isDefault && isDefaultOrdinal ? 800 : delegate.getOrdinal();
+        }
+    }
 }

microprofile/testing/testing/src/main/java/io/helidon/microprofile/testing/ReflectionHelper.java

@@ -59,14 +59,29 @@ static List<Method> methodHierarchy(Method method) {
      *
      * @param method   base method
      * @param override override method
-     * @return {@code true} if overrides, {@code false otherwise}
+     * @return {@code true} if overrides, {@code false} otherwise
      */
     static boolean isOverride(Method method, Method override) {
         return override.getName().equals(method.getName())
                && override.getReturnType().isAssignableFrom(method.getReturnType())
                && Arrays.equals(override.getParameterTypes(), method.getParameterTypes());
     }
 
+    /**
+     * Test if the given instance has a default method by name. If the method does not exist, return {@code false}.
+     *
+     * @param instance  instance
+     * @param name      method name
+     * @return {@code true} if is default, {@code false} otherwise
+     */
+    static boolean isDefaultMethod(Object instance, String name) {
+        try {
+            return instance.getClass().getMethod(name).isDefault();
+        } catch (NoSuchMethodException e) {
+            return false;
+        }
+    }
+
     /**
      * Collect all types in the type hiearchy of the given type.
      *

microprofile/tests/testing/junit5/pom.xml

@@ -85,7 +85,11 @@
                         <java.util.logging.config.file>
                             ${project.build.testOutputDirectory}/logging.properties
                         </java.util.logging.config.file>
+                        <foo>systemProperty</foo>
                     </systemPropertyVariables>
+                    <environmentVariables>
+                        <foo>environmentProperty</foo>
+                    </environmentVariables>
                     <redirectTestOutputToFile>${redirectTestOutputToFile}</redirectTestOutputToFile>
                 </configuration>
             </plugin>

microprofile/tests/testing/junit5/src/test/java/io/helidon/microprofile/tests/testing/junit5/TestAddConfigBlockProperties.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2024 Oracle and/or its affiliates.
+ * Copyright (c) 2024, 2025 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.
@@ -16,9 +16,6 @@
 
 package io.helidon.microprofile.tests.testing.junit5;
 
-import static org.hamcrest.CoreMatchers.is;
-import static org.hamcrest.MatcherAssert.assertThat;
-
 import jakarta.inject.Inject;
 
 import io.helidon.microprofile.testing.junit5.AddConfigBlock;
@@ -27,11 +24,14 @@
 import org.eclipse.microprofile.config.inject.ConfigProperty;
 import org.junit.jupiter.api.Test;
 
+import static org.hamcrest.CoreMatchers.is;
+import static org.hamcrest.MatcherAssert.assertThat;
+
 @HelidonTest
 @AddConfigBlock("""
     some.key1=some.value1
     some.key2=some.value2
-""")
+    """)
 class TestAddConfigBlockProperties {
 
     @Inject

microprofile/tests/testing/junit5/src/test/java/io/helidon/microprofile/tests/testing/junit5/TestAddConfigBlockYaml.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2024 Oracle and/or its affiliates.
+ * Copyright (c) 2024, 2025 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.
@@ -16,9 +16,6 @@
 
 package io.helidon.microprofile.tests.testing.junit5;
 
-import static org.hamcrest.CoreMatchers.is;
-import static org.hamcrest.MatcherAssert.assertThat;
-
 import jakarta.inject.Inject;
 
 import io.helidon.microprofile.testing.junit5.AddConfigBlock;
@@ -27,13 +24,16 @@
 import org.eclipse.microprofile.config.inject.ConfigProperty;
 import org.junit.jupiter.api.Test;
 
+import static org.hamcrest.CoreMatchers.is;
+import static org.hamcrest.MatcherAssert.assertThat;
+
 @HelidonTest
 @AddConfigBlock(type = "yaml", value = """
     another1:
       key: "another1.value"
     another2:
       key: "another2.value"
-""")
+    """)
 class TestAddConfigBlockYaml {
 
     @Inject

microprofile/tests/testing/junit5/src/test/java/io/helidon/microprofile/tests/testing/junit5/TestConfigSourceOrderingCustom.java

@@ -0,0 +1,102 @@
+/*
+ * Copyright (c) 2025 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.microprofile.tests.testing.junit5;
+
+import java.util.Iterator;
+import java.util.List;
+import java.util.Set;
+
+import io.helidon.microprofile.testing.AddConfig;
+import io.helidon.microprofile.testing.AddConfigBlock;
+import io.helidon.microprofile.testing.AddConfigSource;
+import io.helidon.microprofile.testing.Configuration;
+import io.helidon.microprofile.testing.junit5.HelidonTest;
+
+import jakarta.inject.Inject;
+import org.eclipse.microprofile.config.Config;
+import org.eclipse.microprofile.config.spi.ConfigSource;
+import org.junit.jupiter.api.Test;
+
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.is;
+import static org.hamcrest.Matchers.iterableWithSize;
+
+@HelidonTest
+@AddConfig(key = "foo", value = "addConfig")
+@AddConfig(key = "config_ordinal", value = "999")
+@AddConfigBlock(value = """
+        foo=configBlock
+        config_ordinal=998
+        """)
+@Configuration(configSources = "ordinal-custom.properties")
+class TestConfigSourceOrderingCustom {
+
+    private final List<Ordering> ORDERINGS = List.of(
+            new Ordering(999, "addConfig"),
+            new Ordering(998, "configBlock"),
+            new Ordering(997, "configSource"),
+            new Ordering(996, "configuration"),
+            new Ordering(400, "systemProperty"),
+            new Ordering(300, "environmentProperty"));
+
+    @Inject
+    @SuppressWarnings("CdiInjectionPointsInspection")
+    private Config config;
+
+    @AddConfigSource
+    static ConfigSource config() {
+        return new CustomConfigSource();
+    }
+
+    @Test
+    void testOrdering() {
+        Iterator<Ordering> ordering = ORDERINGS.iterator();
+        Iterable<ConfigSource> configSources = config.getConfigSources();
+
+        assertThat(configSources, iterableWithSize(6));
+
+        for (ConfigSource configSource : configSources) {
+            Ordering it = ordering.next();
+            assertThat(it.ordinal(), is(configSource.getOrdinal()));
+            assertThat(it.value(), is(configSource.getValue("foo")));
+        }
+    }
+
+    static class CustomConfigSource implements ConfigSource {
+        @Override
+        public Set<String> getPropertyNames() {
+            return Set.of();
+        }
+
+        @Override
+        public String getValue(String propertyName) {
+            return "foo".equals(propertyName) ? "configSource" : null;
+        }
+
+        @Override
+        public String getName() {
+            return CustomConfigSource.class.getSimpleName();
+        }
+
+        @Override
+        public int getOrdinal() {
+            return 997;
+        }
+    }
+
+    record Ordering(int ordinal, String value) {
+    }
+}