Updated Test Data and first step to improved checks.

Signed-off-by: Dennis Labordus <[email protected]>

Author: Dennis Labordus

service/src/test/java/org/lfenergy/compas/scl/auto/alignment/TestUtil.java

@@ -3,40 +3,50 @@
 // SPDX-License-Identifier: Apache-2.0
 package org.lfenergy.compas.scl.auto.alignment;
 
+import javanet.staxutils.SimpleNamespaceContext;
 import org.lfenergy.compas.core.commons.ElementConverter;
 import org.w3c.dom.Element;
+import org.w3c.dom.NodeList;
 
+import javax.xml.xpath.XPathConstants;
+import javax.xml.xpath.XPathFactory;
 import java.io.*;
 import java.nio.charset.StandardCharsets;
 
-import static org.lfenergy.compas.scl.auto.alignment.SclAutoAlignmentConstants.SCL_ELEMENT_NAME;
-import static org.lfenergy.compas.scl.auto.alignment.SclAutoAlignmentConstants.SCL_NS_URI;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.lfenergy.compas.scl.auto.alignment.SclAutoAlignmentConstants.*;
 
 public final class TestUtil {
     private TestUtil() {
         // Only static methods.
     }
 
-    public static Element readSCLElement(String filename) throws IOException {
-        var sclData = readSCL(filename);
+    public static Element toElement(String sclData) throws IOException {
         var converter = new ElementConverter();
+        try (var inputStream = new BufferedInputStream(
+                new ByteArrayInputStream(sclData.getBytes(StandardCharsets.UTF_8)))) {
+            return converter.convertToElement(inputStream, SCL_ELEMENT_NAME, SCL_NS_URI);
+        }
+    }
 
-        return converter.convertToElement(new BufferedInputStream(
-                new ByteArrayInputStream(sclData.getBytes(StandardCharsets.UTF_8))), SCL_ELEMENT_NAME, SCL_NS_URI);
+    public static Element readSCLElement(String filename) throws IOException {
+        var sclData = readSCL(filename);
+        return toElement(sclData);
     }
 
     public static String readSCL(String filename) throws IOException {
         return readFile("/scl/" + filename);
     }
 
     public static String readFile(String filename) throws IOException {
-        var inputStream = TestUtil.class.getResourceAsStream(filename);
-        assert inputStream != null;
+        try (var inputStream = TestUtil.class.getResourceAsStream(filename)) {
+            assert inputStream != null;
 
-        return new String(inputStream.readAllBytes());
+            return new String(inputStream.readAllBytes());
+        }
     }
 
-    @Deprecated
     public static void writeFile(String fileName, String data) {
         var file = new File("target", fileName);
         try (var fw = new OutputStreamWriter(new FileOutputStream(file), StandardCharsets.UTF_8)) {
@@ -45,4 +55,20 @@ public static void writeFile(String fileName, String data) {
             throw new UncheckedIOException(e);
         }
     }
+
+    public static void assertXYCoordinates(Element rootElement, String xPathExpression, Integer x, Integer y) throws Exception {
+        var xPath = XPathFactory.newInstance().newXPath();
+
+        SimpleNamespaceContext nsCtx = new SimpleNamespaceContext();
+        nsCtx.setPrefix("scl", SCL_NS_URI);
+        xPath.setNamespaceContext(nsCtx);
+
+        var nodeList = (NodeList) xPath.compile(xPathExpression).evaluate(rootElement.getOwnerDocument(), XPathConstants.NODESET);
+        assertEquals(1, nodeList.getLength());
+
+        var element = (Element) nodeList.item(0);
+        assertNotNull(element);
+        assertEquals(x.toString(), element.getAttributeNS(SCLXY_NS_URI, "x"));
+        assertEquals(y.toString(), element.getAttributeNS(SCLXY_NS_URI, "y"));
+    }
 }

service/src/test/java/org/lfenergy/compas/scl/auto/alignment/service/SclAutoAlignmentEnricherTest.java

@@ -17,12 +17,13 @@
 import static org.junit.jupiter.api.Assertions.assertNotNull;
 import static org.lfenergy.compas.scl.auto.alignment.SclAutoAlignmentConstants.SCL_ELEMENT_NAME;
 import static org.lfenergy.compas.scl.auto.alignment.SclAutoAlignmentConstants.SCL_NS_URI;
-import static org.lfenergy.compas.scl.auto.alignment.TestUtil.readFile;
-import static org.lfenergy.compas.scl.auto.alignment.TestUtil.readSCL;
+import static org.lfenergy.compas.scl.auto.alignment.TestUtil.*;
 
 class SclAutoAlignmentEnricherTest {
     @Test
-    void enrich_WhenPassingCase1_ThenXSDUpdated() throws IOException {
+    void enrich_WhenPassingCase1_ThenSCDUpdated() throws Exception {
+        // The JSON file used here is a copy created by the testcase
+        // SclAutoAlignmentServiceTest#createJson_WhenPassingCase1_ThenJsonReturned
         var filename = "scl-1";
         var jsonString = readFile("/json/" + filename + ".json");
         var scl = new GenericSCL(readSCLElement(filename + ".scd"));
@@ -32,10 +33,15 @@ void enrich_WhenPassingCase1_ThenXSDUpdated() throws IOException {
 
         assertNotNull(scl.getElement());
         writeFile(filename + "-updated.scd", scl);
+
+        assertXYCoordinates(scl.getElement(), "//scl:VoltageLevel[@name='J1']", 2, 4);
+        assertXYCoordinates(scl.getElement(), "//scl:Bay[@name='BusBar A']", 1, 15);
     }
 
     @Test
-    void enrich_WhenPassingCase2_ThenXSDUpdated() throws IOException {
+    void enrich_WhenPassingCase2_ThenSCDUpdated() throws IOException {
+        // The JSON file used here is a copy created by the testcase
+        // SclAutoAlignmentServiceTest#createJson_WhenPassingCase2_ThenJsonReturned
         var filename = "scl-2";
         var jsonString = readFile("/json/" + filename + ".json");
         var scl = new GenericSCL(readSCLElement(filename + ".scd"));

service/src/test/java/org/lfenergy/compas/scl/auto/alignment/service/SclAutoAlignmentServiceTest.java

@@ -13,8 +13,7 @@
 import java.util.List;
 
 import static org.junit.jupiter.api.Assertions.assertNotNull;
-import static org.lfenergy.compas.scl.auto.alignment.TestUtil.readSCL;
-import static org.lfenergy.compas.scl.auto.alignment.TestUtil.writeFile;
+import static org.lfenergy.compas.scl.auto.alignment.TestUtil.*;
 
 @ExtendWith(MockitoExtension.class)
 class SclAutoAlignmentServiceTest {
@@ -29,17 +28,21 @@ void beforeEach() {
     }
 
     @Test
-    void updateSCL_WhenPassingCase1_ThenUpdatedSCLReturned() throws IOException {
+    void updateSCL_WhenPassingCase1_ThenUpdatedSCLReturned() throws Exception {
         var filename = "scl-1";
         var sclString = readSCL(filename + ".scd");
 
         var result = sclAutoAlignmentService.updateSCL(sclString, List.of("AA1"), "Mr. Editor");
         assertNotNull(result);
         writeFile(filename + "-updated-service.scd", result);
+
+        var rootElement = toElement(result);
+        assertXYCoordinates(rootElement, "//scl:VoltageLevel[@name='J1']", 2, 4);
+        assertXYCoordinates(rootElement, "//scl:Bay[@name='BusBar A']", 1, 15);
     }
 
     @Test
-    void updateSCL_WhenPassingCase2_ThenUpdatedSCLReturned() throws IOException {
+    void updateSCL_WhenPassingCase2_ThenUpdatedSCLReturned() throws Exception {
         var filename = "scl-2";
         var sclString = readSCL(filename + ".scd");
 
@@ -50,6 +53,7 @@ void updateSCL_WhenPassingCase2_ThenUpdatedSCLReturned() throws IOException {
 
     @Test
     void getSVG_WhenPassingCase1_ThenSVGReturned() throws IOException {
+        // Nice addition to the updateSCL Test to have a visual output from PowSyBl and check how their drawing looks.
         var filename = "scl-1";
         var sclString = readSCL(filename + ".scd");
 
@@ -60,6 +64,7 @@ void getSVG_WhenPassingCase1_ThenSVGReturned() throws IOException {
 
     @Test
     void getSVG_WhenPassingCase2_ThenSVGReturned() throws IOException {
+        // Nice addition to the updateSCL Test to have a visual output from PowSyBl and check how their drawing looks.
         var filename = "scl-2";
         var sclString = readSCL(filename + ".scd");
 
@@ -70,6 +75,8 @@ void getSVG_WhenPassingCase2_ThenSVGReturned() throws IOException {
 
     @Test
     void createJson_WhenPassingCase1_ThenJsonReturned() throws IOException {
+        // This just tests if the SCD File can be processed, because most of the work is done in PowSyBl.
+        // But this way we know the GraphBuilders are still working and not missing electric components.
         var filename = "scl-1";
         var substationName = "AA1";
         var sclData = readSCL(filename + ".scd");
@@ -83,6 +90,8 @@ void createJson_WhenPassingCase1_ThenJsonReturned() throws IOException {
 
     @Test
     void createJson_WhenPassingCase2_ThenJsonReturned() throws IOException {
+        // This just tests if the SCD File can be processed, because most of the work is done in PowSyBl.
+        // But this way we know the GraphBuilders are still working and not missing electric components.
         var filename = "scl-2";
         var substationName = "_af9a4ae3-ba2e-4c34-8e47-5af894ee20f4";
         var sclData = readSCL(filename + ".scd");