feat: refactor and fix SclReport behavior #304

Signed-off-by: Samir Romdhani <[email protected]>

refactor test code to use AssertJ and using Gherkin to define scenarios #306

Signed-off-by: Samir Romdhani <[email protected]>

Author: samirromdhani

sct-app/src/main/java/org/lfenergy/compas/sct/app/SclAutomationService.java

@@ -10,7 +10,6 @@
 import org.lfenergy.compas.sct.commons.dto.HeaderDTO;
 import org.lfenergy.compas.sct.commons.dto.SubNetworkDTO;
 import org.lfenergy.compas.sct.commons.exception.ScdException;
-import org.lfenergy.compas.sct.commons.scl.SclRootAdapter;
 import org.lfenergy.compas.sct.commons.scl.SclService;
 import org.lfenergy.compas.sct.commons.scl.SubstationService;
 
@@ -22,7 +21,7 @@
  * The following features are supported:
  * </p>
  * <ul>
- *   <li>{@link SclAutomationService#createSCD(SCL, HeaderDTO, Set) Adds all elements under the <b>SCL </b> object from given <b>SSD </b> and <b>STD </b> files}
+ *   <li>{@link SclAutomationService#createSCD(SCL, HeaderDTO, List) Adds all elements under the <b>SCL </b> object from given <b>SSD </b> and <b>STD </b> files}
  *  </ul>
  */
 public class SclAutomationService {
@@ -40,24 +39,24 @@ private SclAutomationService() {
     }
 
     /**
-     * Create a SCD file from specified parameters, it calls all functions defined in the process one by one, every step
-     * return a SCD file which will be used by the next step.
+     * Create an SCD file from specified parameters, it calls all functions defined in the process one by one, every step
+     * return an SCD file which will be used by the next step.
      * @param ssd : (mandatory) file contains substation datas
      * @param headerDTO : (mandatory) object which hold header datas and historys' one
-     * @param stds : (optional) list of STD files containing IED datas (IED, Communication and DataTypeTemplate)
-     * @return a SCD file encapsuled in object SclRootAdapter
+     * @param stds : list of STD files containing IED datas (IED, Communication and DataTypeTemplate)
+     * @return an SCD object
      * @throws ScdException
      */
-    public static SclRootAdapter createSCD(@NonNull SCL ssd, @NonNull HeaderDTO headerDTO, Set<SCL> stds) throws ScdException {
-        SclRootAdapter scdAdapter = SclService.initScl(Optional.ofNullable(headerDTO.getId()),
+    public static SCL createSCD(@NonNull SCL ssd, @NonNull HeaderDTO headerDTO, List<SCL> stds) throws ScdException {
+        SCL scd = SclService.initScl(Optional.ofNullable(headerDTO.getId()),
                 headerDTO.getVersion(), headerDTO.getRevision());
         if (!headerDTO.getHistoryItems().isEmpty()) {
             HeaderDTO.HistoryItem hItem = headerDTO.getHistoryItems().get(0);
-            SclService.addHistoryItem(scdAdapter.getCurrentElem(), hItem.getWho(), hItem.getWhat(), hItem.getWhy());
+            SclService.addHistoryItem(scd, hItem.getWho(), hItem.getWhat(), hItem.getWhy());
         }
-        SubstationService.addSubstation(scdAdapter.getCurrentElem(), ssd);
-        SclService.importSTDElementsInSCD(scdAdapter, stds, comMap);
-        SclService.removeAllControlBlocksAndDatasetsAndExtRefSrcBindings(scdAdapter.getCurrentElem());
-        return scdAdapter;
+        SubstationService.addSubstation(scd, ssd);
+        SclService.importSTDElementsInSCD(scd, stds, comMap);
+        SclService.removeAllControlBlocksAndDatasetsAndExtRefSrcBindings(scd);
+        return scd;
     }
 }

sct-app/src/test/java/org.lfenergy.compas.sct.app/SclAutomationServiceTest.java

@@ -18,8 +18,7 @@
 import java.lang.reflect.Constructor;
 import java.lang.reflect.InvocationTargetException;
 import java.util.Arrays;
-import java.util.HashSet;
-import java.util.Set;
+import java.util.List;
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.assertThatThrownBy;
@@ -43,15 +42,15 @@ void createSCD_should_return_generatedSCD() throws Exception {
         SCL ssd = SclTestMarshaller.getSCLFromFile("/scd-ied-dtt-com-import-stds/scd.xml");
         SCL std = SclTestMarshaller.getSCLFromFile("/scd-ied-dtt-com-import-stds/std.xml");
         // When
-        SclRootAdapter expectedSCD = SclAutomationService.createSCD(ssd, headerDTO, Set.of(std));
+        SCL scd = SclAutomationService.createSCD(ssd, headerDTO, List.of(std));
         // Then
-        assertNotNull(expectedSCD.getCurrentElem().getHeader().getId());
-        assertNull(expectedSCD.getCurrentElem().getHeader().getHistory());
-        assertEquals(1, expectedSCD.getCurrentElem().getSubstation().size());
-        assertEquals(1, expectedSCD.getCurrentElem().getIED().size());
-        assertNotNull(expectedSCD.getCurrentElem().getDataTypeTemplates());
-        assertEquals(2, expectedSCD.getCurrentElem().getCommunication().getSubNetwork().size());
-        assertIsMarshallable(expectedSCD.getCurrentElem());
+        assertNotNull(scd.getHeader().getId());
+        assertNull(scd.getHeader().getHistory());
+        assertEquals(1, scd.getSubstation().size());
+        assertEquals(1, scd.getIED().size());
+        assertNotNull(scd.getDataTypeTemplates());
+        assertEquals(2, scd.getCommunication().getSubNetwork().size());
+        assertIsMarshallable(scd);
     }
 
     @Test
@@ -67,16 +66,16 @@ void createSCD_With_HItem() throws Exception {
         SCL std2 = SclTestMarshaller.getSCLFromFile("/std_2.xml");
         SCL std3 = SclTestMarshaller.getSCLFromFile("/std_3.xml");
         // When
-        SclRootAdapter expectedSCD = SclAutomationService.createSCD(ssd, headerDTO, Set.of(std1, std2, std3));
+        SCL scd = SclAutomationService.createSCD(ssd, headerDTO, List.of(std1, std2, std3));
         // Then
-        assertNotNull(expectedSCD.getCurrentElem().getHeader().getId());
-        assertEquals(1, expectedSCD.getCurrentElem().getHeader().getHistory().getHitem().size());
-        assertEquals(1, expectedSCD.getCurrentElem().getSubstation().size());
-        assertIsMarshallable(expectedSCD.getCurrentElem());
+        assertNotNull(scd.getHeader().getId());
+        assertEquals(1, scd.getHeader().getHistory().getHitem().size());
+        assertEquals(1, scd.getSubstation().size());
+        assertIsMarshallable(scd);
     }
 
     @Test
-    void createSCD_With_HItems() throws Exception {
+    void createSCD_With_HItems() {
         // Given
         HeaderDTO.HistoryItem historyItem = new HeaderDTO.HistoryItem();
         historyItem.setWhat("what");
@@ -92,20 +91,20 @@ void createSCD_With_HItems() throws Exception {
         SCL std2 = SclTestMarshaller.getSCLFromFile("/std_2.xml");
         SCL std3 = SclTestMarshaller.getSCLFromFile("/std_3.xml");
         // When
-        SclRootAdapter expectedSCD = SclAutomationService.createSCD(ssd, headerDTO, Set.of(std1, std2, std3));
+        SCL scd = SclAutomationService.createSCD(ssd, headerDTO, List.of(std1, std2, std3));
         // Then
-        assertNotNull(expectedSCD.getCurrentElem().getHeader().getId());
-        assertEquals(1, expectedSCD.getCurrentElem().getHeader().getHistory().getHitem().size());
-        assertEquals("what", expectedSCD.getCurrentElem().getHeader().getHistory().getHitem().get(0).getWhat());
-        assertIsMarshallable(expectedSCD.getCurrentElem());
+        assertNotNull(scd.getHeader().getId());
+        assertEquals(1, scd.getHeader().getHistory().getHitem().size());
+        assertEquals("what", scd.getHeader().getHistory().getHitem().get(0).getWhat());
+        assertIsMarshallable(scd);
     }
 
     @Test
     void createSCD_SSD_Without_Substation() throws Exception {
         // Given
         SCL ssd = SclTestMarshaller.getSCLFromFile("/scd-substation-import-ssd/ssd_without_substations.xml");
         // When & Then
-        Set<SCL> stdListEmpty = new HashSet<>();
+        List<SCL> stdListEmpty = List.of();
         assertThrows(ScdException.class,
                 () -> SclAutomationService.createSCD(ssd, headerDTO, stdListEmpty));
     }
@@ -119,7 +118,7 @@ void createSCD_should_throw_exception_when_null_ssd() throws Exception {
         historyItem.setWhy("because");
         headerDTO.getHistoryItems().add(historyItem);
         SCL std1 = SclTestMarshaller.getSCLFromFile("/std_1.xml");
-        Set<SCL> stdList = Set.of(std1);
+        List<SCL> stdList = List.of(std1);
 
         // When & Then
         assertThrows(NullPointerException.class, () -> SclAutomationService.createSCD(null, headerDTO, stdList));
@@ -130,7 +129,7 @@ void createSCD_should_throw_exception_when_null_headerDTO() throws Exception {
         // Given
         SCL ssd = SclTestMarshaller.getSCLFromFile("/scd-substation-import-ssd/ssd.xml");
         SCL std1 = SclTestMarshaller.getSCLFromFile("/std_1.xml");
-        Set<SCL> stdList = Set.of(std1);
+        List<SCL> stdList = List.of(std1);
 
         // When & Then
         assertThrows(NullPointerException.class, () -> SclAutomationService.createSCD(ssd, null, stdList));
@@ -142,9 +141,9 @@ void createSCD_should_delete_ControlBlocks_DataSet_and_ExtRef_src_attributes() t
         SCL ssd = SclTestMarshaller.getSCLFromFile("/scd-ied-dtt-com-import-stds/ssd.xml");
         SCL std = SclTestMarshaller.getSCLFromFile("/scl-remove-controlBlocks-dataSet-extRefSrc/scl-with-control-blocks.xml");
         // When
-        SclRootAdapter expectedSCD = SclAutomationService.createSCD(ssd, headerDTO, Set.of(std));
+        SCL scd = SclAutomationService.createSCD(ssd, headerDTO, List.of(std));
         // Then
-        LN0 ln0 = expectedSCD.streamIEDAdapters()
+        LN0 ln0 = new SclRootAdapter(scd).streamIEDAdapters()
                 .findFirst()
                 .map(iedAdapter -> iedAdapter.findLDeviceAdapterByLdInst("lDeviceInst1").orElseThrow())
                 .map(LDeviceAdapter::getLN0Adapter)
@@ -154,7 +153,7 @@ void createSCD_should_delete_ControlBlocks_DataSet_and_ExtRef_src_attributes() t
         assertThat(ln0.getDataSet()).isEmpty();
         assertThat(ln0.getInputs().getExtRef()).hasSize(2);
         assertFalse(ln0.getInputs().getExtRef().get(0).isSetSrcLDInst());
-        assertIsMarshallable(expectedSCD.getCurrentElem());
+        assertIsMarshallable(scd);
     }
 
     @Test