Make MP test configuration ordinal deterministic

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

@@ -61,7 +61,6 @@ class HelidonTestConfigSynthetic extends HelidonTestConfigDelegate {
     HelidonTestConfigSynthetic(HelidonTestInfo<?> testInfo, Runnable onUpdate) {
         this.testInfo = testInfo;
         this.onUpdate = onUpdate;
-        map.put(ConfigSource.CONFIG_ORDINAL, "1000");
         map.put("server.port", "0");
         map.put("mp.config.profile", "test");
         testInfo.addConfigs().forEach(this::update);
@@ -148,20 +147,24 @@ boolean useExisting() {
 
     private Config buildConfig() {
         List<ConfigSource> configSources = new ArrayList<>();
-        configSources.add(MpConfigSources.create(testInfo.id(), map));
+        ConfigSource configSource = MpConfigSources.create(testInfo.id(), map);
+        configSources.add(addConfigOrdinal(configSource, "1000"));
         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(addConfigOrdinal(config, "800"));
         }
         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 +176,16 @@ private Config buildConfig() {
         return builder.build();
     }
 
+    private ConfigSource addConfigOrdinal(ConfigSource config, String ordinal) {
+        return addConfigOrdinal(config, "Map", ordinal);
+    }
+
+    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";

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,22 +16,24 @@
 
 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.Configuration;
 import io.helidon.microprofile.testing.junit5.AddConfigBlock;
 import io.helidon.microprofile.testing.junit5.HelidonTest;
 
 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
-""")
+    """)
+@Configuration(configSources = "configBlock.properties")
 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,24 +16,26 @@
 
 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.Configuration;
 import io.helidon.microprofile.testing.junit5.AddConfigBlock;
 import io.helidon.microprofile.testing.junit5.HelidonTest;
 
 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"
-""")
+    """)
+@Configuration(configSources = "configBlock.yaml")
 class TestAddConfigBlockYaml {
 
     @Inject

microprofile/tests/testing/junit5/src/test/resources/configBlock.properties

@@ -0,0 +1,18 @@
+#
+# 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.
+#
+
+some.key1=foo
+some.key2=bar

microprofile/tests/testing/junit5/src/test/resources/configBlock.yaml

@@ -0,0 +1,20 @@
+#
+# 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.
+#
+
+another1:
+  key: "foo"
+another2:
+  key: "bar"

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

@@ -21,6 +21,7 @@
 
 import jakarta.inject.Inject;
 
+import io.helidon.microprofile.testing.Configuration;
 import io.helidon.microprofile.testing.testng.AddConfigBlock;
 import io.helidon.microprofile.testing.testng.HelidonTest;
 
@@ -31,7 +32,8 @@
 @AddConfigBlock("""
     some.key1=some.value1
     some.key2=some.value2
-""")
+    """)
+@Configuration(configSources = "configBlock.properties")
 public class TestAddConfigBlockProperties {
 
     @Inject

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

@@ -21,6 +21,7 @@
 
 import jakarta.inject.Inject;
 
+import io.helidon.microprofile.testing.Configuration;
 import io.helidon.microprofile.testing.testng.AddConfigBlock;
 import io.helidon.microprofile.testing.testng.HelidonTest;
 
@@ -33,7 +34,8 @@
       key: "another1.value"
     another2:
       key: "another2.value"
-""")
+    """)
+@Configuration(configSources = "configBlock.yaml")
 public class TestAddConfigBlockYaml {
 
     @Inject

microprofile/tests/testing/testng/src/test/resources/configBlock.properties

@@ -0,0 +1,18 @@
+#
+# 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.
+#
+
+some.key1=prod.value
+some.key2=prod.value

microprofile/tests/testing/testng/src/test/resources/configBlock.yaml

@@ -0,0 +1,20 @@
+#
+# 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.
+#
+
+another1:
+  key: "prod.value"
+another2:
+  key: "prod.value"