CRAC importer integration of ReportNode beginning

Signed-off-by: Sébastien Murgey <sebastien.murgey@rte-france.com>

Author: murgeyseb

data/crac-creation/crac-creator-api/src/test/java/com/powsybl/openrao/data/craccreation/creator/api/CracCreationReportTest.java

@@ -16,6 +16,11 @@
 import org.junit.jupiter.api.Test;
 import org.slf4j.LoggerFactory;
 
+import java.io.IOException;
+import java.io.StringWriter;
+import java.net.URISyntaxException;
+import java.nio.file.Files;
+import java.nio.file.Path;
 import java.util.List;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
@@ -28,6 +33,11 @@ class CracCreationReportTest {
 
     private CracCreationReport cracCreationReport;
 
+    private static ReportNode buildNewRootNode() {
+        ReportNode reportNode = ReportNode.newRootReportNode().withMessageTemplate("root", "Root node for tests").build();
+        return reportNode;
+    }
+
     @BeforeEach
     public void setUp() {
         cracCreationReport = new CracCreationReport();
@@ -127,4 +137,22 @@ void testPrintReport() {
         assertEquals("[INFO] [WARN] message1", logsList.get(0).toString());
         assertEquals("[INFO] [ERROR] message2", logsList.get(1).toString());
     }
+
+    @Test
+    void testReportNode() throws IOException, URISyntaxException {
+        ReportNode reportNode = buildNewRootNode();
+        cracCreationReport.warn("message1", reportNode);
+        cracCreationReport.error("message2", reportNode);
+        cracCreationReport.info("message3", reportNode);
+        cracCreationReport.added("message4", reportNode);
+        cracCreationReport.altered("message5", reportNode);
+        cracCreationReport.removed("message6", reportNode);
+
+        String expected = Files.readString(Path.of(getClass().getResource("/expectedReportNodeContent.txt").toURI()));
+        try (StringWriter writer = new StringWriter()) {
+            reportNode.print(writer);
+            String actual = writer.toString();
+            assertEquals(expected, actual);
+        }
+    }
 }

data/crac-creation/crac-creator-api/src/test/java/com/powsybl/openrao/data/craccreation/creator/api/mock/NativeCracImporterMock.java

@@ -30,7 +30,7 @@ public NativeCracMock importNativeCrac(InputStream inputStream, ReportNode repor
     }
 
     @Override
-    public boolean exists(String fileName, InputStream inputStream) {
+    public boolean exists(String fileName, InputStream inputStream, ReportNode reportNode) {
         return true;
     }
 }

data/crac-creation/crac-creator-api/src/test/resources/expectedReportNodeContent.txt

@@ -0,0 +1,7 @@
++ Root node for tests
+   [WARN] message1
+   [ERROR] message2
+   [INFO] message3
+   [ADDED] message4
+   [ALTERED] message5
+   [REMOVED] message6

data/crac-creation/crac-creator-cim/src/main/java/com/powsybl/openrao/data/craccreation/creator/cim/importer/CimCracImporter.java

@@ -58,7 +58,7 @@ public CimCrac importNativeCrac(InputStream inputStream, ReportNode reportNode)
     }
 
     @Override
-    public boolean exists(String s, InputStream inputStream) {
+    public boolean exists(String s, InputStream inputStream, ReportNode reportNode) {
         Source xmlFile = new StreamSource(inputStream);
         // The following line triggers sonar issue java:S2755 which prevents us from accessing XSD schema files
         SchemaFactory schemaFactory = SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI); //NOSONAR

data/crac-creation/crac-creator-csa-profiles/src/main/java/com/powsybl/openrao/data/craccreation/creator/csaprofile/importer/CsaProfileCracImporter.java

@@ -131,7 +131,7 @@ private static void importZipEntry(ZipEntry zipEntry, ZipInputStream zipInputStr
     }
 
     @Override
-    public boolean exists(String fileName, InputStream inputStream) {
+    public boolean exists(String fileName, InputStream inputStream, ReportNode reportNode) {
         TripleStore tripleStoreCsaProfile = TripleStoreFactory.create(CsaProfileConstants.TRIPLESTORE_RDF4J_NAME);
         tripleStoreCsaProfile.read(inputStream, CsaProfileConstants.RDF_BASE_URL, "");
         return FilenameUtils.getExtension(fileName).equals(CsaProfileConstants.EXTENSION_FILE_CSA_PROFILE);

data/crac-creation/crac-creator-cse/src/main/java/com/powsybl/openrao/data/craccreation/creator/cse/CseCracImporter.java

@@ -57,7 +57,7 @@ public CseCrac importNativeCrac(InputStream inputStream, ReportNode reportNode)
     }
 
     @Override
-    public boolean exists(String s, InputStream inputStream) {
+    public boolean exists(String s, InputStream inputStream, ReportNode reportNode) {
         Source xmlFile = new StreamSource(inputStream);
         // The following line triggers sonar issue java:S2755 which prevents us from accessing XSD schema files
         SchemaFactory schemaFactory = SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI); //NOSONAR

data/crac-creation/crac-creator-fb-constraint/src/main/java/com/powsybl/openrao/data/craccreation/creator/fbconstraint/importer/FbConstraintImporter.java

@@ -69,7 +69,7 @@ public FbConstraint importNativeCrac(InputStream inputStream, ReportNode reportN
     }
 
     @Override
-    public boolean exists(String s, InputStream inputStream) {
+    public boolean exists(String s, InputStream inputStream, ReportNode reportNode) {
         try {
             byte[] bytes = getBytesFromInputStream(inputStream);
             int flowBasedDocumentVersion = flowBasedDocumentVersion(new ByteArrayInputStream(bytes));

data/crac-io/crac-io-api/src/main/java/com/powsybl/openrao/data/cracioapi/CracImporter.java

@@ -7,6 +7,7 @@
 
 package com.powsybl.openrao.data.cracioapi;
 
+import com.powsybl.commons.report.ReportNode;
 import com.powsybl.iidm.network.Network;
 import com.powsybl.openrao.data.cracapi.Crac;
 import com.powsybl.openrao.data.cracapi.CracFactory;
@@ -24,7 +25,20 @@ public interface CracImporter {
 
     Crac importCrac(InputStream inputStream, @Nonnull CracFactory cracFactory, Network network);
 
+    default Crac importCrac(InputStream inputStream, @Nonnull CracFactory cracFactory, Network network, ReportNode reportNode) {
+        return importCrac(inputStream, cracFactory, network);
+    }
+
     Crac importCrac(InputStream inputStream, Network network);
 
+    default Crac importCrac(InputStream inputStream, Network network, ReportNode reportNode) {
+        return importCrac(inputStream, network);
+    }
+
     boolean exists(String fileName, InputStream inputStream);
+
+    default boolean exists(String fileName, InputStream inputStream, ReportNode reportNode) {
+        return exists(fileName, inputStream);
+    }
+
 }

data/crac-io/crac-io-api/src/main/java/com/powsybl/openrao/data/cracioapi/CracImporters.java

@@ -7,6 +7,7 @@
 
 package com.powsybl.openrao.data.cracioapi;
 
+import com.powsybl.commons.report.ReportNode;
 import com.powsybl.iidm.network.Network;
 import com.powsybl.openrao.commons.OpenRaoException;
 import com.powsybl.openrao.data.cracapi.Crac;
@@ -30,8 +31,12 @@ private CracImporters() {
     }
 
     public static Crac importCrac(Path cracPath, Network network) {
+        return importCrac(cracPath, network, ReportNode.NO_OP);
+    }
+
+    public static Crac importCrac(Path cracPath, Network network, ReportNode reportNode) {
         try (InputStream is = new FileInputStream(cracPath.toFile())) {
-            return importCrac(cracPath.getFileName().toString(), is, network);
+            return importCrac(cracPath.getFileName().toString(), is, network, reportNode);
         } catch (FileNotFoundException e) {
             throw new OpenRaoException("File not found.");
         } catch (IOException e) {
@@ -47,6 +52,10 @@ private static byte[] getBytesFromInputStream(InputStream inputStream) throws IO
     }
 
     public static Crac importCrac(String fileName, InputStream inputStream, Network network) {
+        return importCrac(fileName, inputStream, network, ReportNode.NO_OP);
+    }
+
+    public static Crac importCrac(String fileName, InputStream inputStream, Network network, ReportNode reportNode) {
         try {
             byte[] bytes = getBytesFromInputStream(inputStream);
 
@@ -61,6 +70,10 @@ public static Crac importCrac(String fileName, InputStream inputStream, Network
     }
 
     public static CracImporter findImporter(String fileName, InputStream inputStream) {
+        return findImporter(fileName, inputStream, ReportNode.NO_OP);
+    }
+
+    public static CracImporter findImporter(String fileName, InputStream inputStream, ReportNode reportNode) {
         try {
             byte[] bytes = getBytesFromInputStream(inputStream);
 

data/native-crac/native-crac-io-api/src/main/java/com/powsybl/openrao/data/nativecracioapi/NativeCracImporter.java

@@ -27,6 +27,13 @@ public interface NativeCracImporter<T extends NativeCrac> {
      */
     String getFormat();
 
+    /**
+     * Import a NativeCrac from an input stream.
+     */
+    default T importNativeCrac(InputStream inputStream) {
+        return importNativeCrac(inputStream, ReportNode.NO_OP);
+    }
+
     /**
      * Import a NativeCrac from an input stream.
      */
@@ -38,5 +45,15 @@ public interface NativeCracImporter<T extends NativeCrac> {
      * @param inputStream the input stream of the file
      * @return true if the inputStream is importable, false otherwise
      */
-    boolean exists(String fileName, InputStream inputStream);
+    default boolean exists(String fileName, InputStream inputStream) {
+        return exists(fileName, inputStream, ReportNode.NO_OP);
+    }
+
+    /**
+     * Check if a file is importable.
+     * @param fileName the file name
+     * @param inputStream the input stream of the file
+     * @return true if the inputStream is importable, false otherwise
+     */
+    boolean exists(String fileName, InputStream inputStream, ReportNode reportNode);
 }