Adding withAllResourceBundlesFromClasspath

Signed-off-by: Florian Dupuy <[email protected]>

Author: flo-dup

commons/src/main/java/com/powsybl/commons/report/PowsyblCoreReportResourceBundle.java

@@ -7,13 +7,17 @@
  */
 package com.powsybl.commons.report;
 
+import com.google.auto.service.AutoService;
+
 /**
  * @author Alice Caron {@literal <alice.caron at rte-france.com>}
  */
-public final class PowsyblCoreReportResourceBundle {
+@AutoService(ReportResourceBundle.class)
+public final class PowsyblCoreReportResourceBundle implements ReportResourceBundle {
 
     public static final String BASE_NAME = "com.powsybl.commons.reports";
 
-    private PowsyblCoreReportResourceBundle() {
+    public String getBaseName() {
+        return BASE_NAME;
     }
 }

commons/src/main/java/com/powsybl/commons/report/ReportNodeBuilder.java

@@ -9,6 +9,7 @@
 
 import java.time.format.DateTimeFormatter;
 import java.util.Locale;
+import java.util.ServiceLoader;
 
 /**
  * A builder to create a {@link ReportNode} object.
@@ -34,6 +35,20 @@ public interface ReportNodeBuilder extends ReportNodeAdderOrBuilder<ReportNodeBu
      */
     ReportNodeBuilder withLocale(Locale locale);
 
+    /**
+     * Sets the {@link MessageTemplateProvider} for the whole tree, unless overridden, to the {@link MultiBundleMessageTemplateProvider}
+     * corresponding to all the bundle base names gathered by the {@link java.util.ServiceLoader} of {@link ReportResourceBundle}
+     * implementations.
+     * @return a reference to this object
+     */
+    default ReportNodeBuilder withAllResourceBundlesFromClasspath() {
+        String[] bundleBaseNames = ServiceLoader.load(ReportResourceBundle.class).stream()
+                .map(ServiceLoader.Provider::get)
+                .map(ReportResourceBundle::getBaseName)
+                .toArray(String[]::new);
+        return withMessageTemplateProvider(new MultiBundleMessageTemplateProvider(bundleBaseNames));
+    }
+
     /**
      * Build the corresponding {@link ReportNode}.
      * @return the new {@link ReportNode} corresponding to current <code>ReportNodeBuilder</code>

commons/src/main/java/com/powsybl/commons/report/ReportResourceBundle.java

@@ -0,0 +1,16 @@
+/**
+ * Copyright (c) 2025, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ * SPDX-License-Identifier: MPL-2.0
+ */
+package com.powsybl.commons.report;
+
+/**
+ * Interface used to load all the report ResourceBundles which are in the classpath.
+ * @author Florian Dupuy {@literal <florian.dupuy at rte-france.com>}
+ */
+public interface ReportResourceBundle {
+    String getBaseName();
+}

commons/src/test/java/com/powsybl/commons/report/MockReportResourceBundle.java

@@ -0,0 +1,21 @@
+/**
+ * Copyright (c) 2025, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ * SPDX-License-Identifier: MPL-2.0
+ */
+package com.powsybl.commons.report;
+
+import com.google.auto.service.AutoService;
+
+/**
+ * @author Florian Dupuy {@literal <florian.dupuy at rte-france.com>}
+ */
+@AutoService(ReportResourceBundle.class)
+public final class MockReportResourceBundle implements ReportResourceBundle {
+
+    public String getBaseName() {
+        return "i18n.mock.test";
+    }
+}

commons/src/test/java/com/powsybl/commons/report/ReportNodeTest.java

@@ -373,6 +373,21 @@ void testLocaleAndi18n() {
         assertEquals(Locale.FRANCE, rootReportFrance.getTreeContext().getLocale());
     }
 
+    @Test
+    void testAllBundlesFromClasspath() {
+        ReportNode root = ReportNode.newRootReportNode()
+                .withAllResourceBundlesFromClasspath()
+                .withMessageTemplate("core.iidm.modification.voltageLevelRemoved")
+                .withTypedValue("vlId", "vl1", TypedValue.ID)
+                .build();
+        assertEquals("Voltage level vl1 removed", root.getMessage());
+
+        ReportNode child = root.newReportNode()
+                .withMessageTemplate("mocking.key")
+                .add();
+        assertEquals("Mocking message template", child.getMessage());
+    }
+
     private static void assertHasNoTimeStamp(ReportNode root1) {
         assertFalse(root1.getValues().containsKey(ReportConstants.TIMESTAMP_KEY));
     }

commons/src/test/resources/i18n/mock/reports.properties

@@ -0,0 +1 @@
+mocking.key = Mocking message template