Feat #152: Update SCD creation automation service to call #74 issue (Delete all Control Blocks and Dataset and all ExtRef @srcxxx attributes into a given SCL file) (#182)

SaintierFr · web-flow · commit 742016e09570 · 2022-11-10T17:05:17.000+01:00
Signed-off-by: SaintierFr  &lt;99645240+SaintierFr@users.noreply.github.com&gt;
diff --git a/pom.xml b/pom.xml
@@ -157,6 +157,20 @@
                         </execution>
                     </executions>
                 </plugin>
+                <plugin>
+                    <groupId>org.apache.maven.plugins</groupId>
+                    <artifactId>maven-javadoc-plugin</artifactId>
+                    <version>${maven.plugin.javadoc}</version>
+                    <executions>
+                        <execution>
+                            <id>attach-javadocs</id>
+                            <phase>package</phase>
+                            <goals>
+                                <goal>aggregate</goal>
+                            </goals>
+                        </execution>
+                    </executions>
+                </plugin>
                 <plugin>
                     <groupId>org.apache.maven.plugins</groupId>
                     <artifactId>maven-source-plugin</artifactId>
diff --git a/sct-app/pom.xml b/sct-app/pom.xml
@@ -60,6 +60,11 @@
             <version>3.6.28</version>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>org.assertj</groupId>
+            <artifactId>assertj-core</artifactId>
+            <version>3.23.1</version>
+        </dependency>
     </dependencies>
     <build>
         <plugins>
diff --git a/sct-app/src/main/java/org/lfenergy/compas/sct/app/SclAutomationService.java b/sct-app/src/main/java/org/lfenergy/compas/sct/app/SclAutomationService.java
@@ -33,9 +33,11 @@ public class SclAutomationService {
      */
     private static final Map<Pair<String, String>, List<String>> comMap = Map.of(
             Pair.of("RSPACE_PROCESS_NETWORK", SubNetworkDTO.SubnetworkType.MMS.toString()), Arrays.asList("PROCESS_AP", "TOTO_AP_GE"),
-            Pair.of("RSPACE_ADMIN_NETWORK", SubNetworkDTO.SubnetworkType.IP.toString()), Arrays.asList("ADMIN_AP","TATA_AP_EFFACEC"));
+            Pair.of("RSPACE_ADMIN_NETWORK", SubNetworkDTO.SubnetworkType.IP.toString()), Arrays.asList("ADMIN_AP", "TATA_AP_EFFACEC"));
 
-    private SclAutomationService(){throw new IllegalStateException("SclAutomationService class"); }
+    private SclAutomationService() {
+        throw new UnsupportedOperationException("This is a utility class and cannot be instantiated");
+    }
 
     /**
      * Create a SCD file from specified parameters, it calls all functions defined in the process one by one, every step
@@ -48,13 +50,14 @@ public class SclAutomationService {
      */
     public static SclRootAdapter createSCD(@NonNull SCL ssd, @NonNull HeaderDTO headerDTO, Set<SCL> stds) throws ScdException {
         SclRootAdapter scdAdapter = SclService.initScl(Optional.ofNullable(headerDTO.getId()),
-                headerDTO.getVersion(),headerDTO.getRevision());
-        if(!headerDTO.getHistoryItems().isEmpty()) {
+                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());
         }
         SubstationService.addSubstation(scdAdapter.getCurrentElem(), ssd);
         SclService.importSTDElementsInSCD(scdAdapter, stds, comMap);
+        SclService.removeAllControlBlocksAndDatasetsAndExtRefSrcBindings(scdAdapter.getCurrentElem());
         return scdAdapter;
     }
 }
diff --git a/sct-app/src/test/java/org.lfenergy.compas.sct.app/SclAutomationServiceTest.java b/sct-app/src/test/java/org.lfenergy.compas.sct.app/SclAutomationServiceTest.java
@@ -6,16 +6,23 @@
 
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
+import org.lfenergy.compas.scl2007b4.model.LN0;
 import org.lfenergy.compas.scl2007b4.model.SCL;
 import org.lfenergy.compas.sct.commons.dto.HeaderDTO;
 import org.lfenergy.compas.sct.commons.exception.ScdException;
+import org.lfenergy.compas.sct.commons.scl.SclElementAdapter;
 import org.lfenergy.compas.sct.commons.scl.SclRootAdapter;
+import org.lfenergy.compas.sct.commons.scl.ied.LDeviceAdapter;
 import org.lfenergy.compas.sct.commons.testhelpers.SclTestMarshaller;
 
+import java.lang.reflect.Constructor;
+import java.lang.reflect.InvocationTargetException;
 import java.util.Arrays;
 import java.util.HashSet;
 import java.util.Set;
 
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.assertThatThrownBy;
 import static org.junit.jupiter.api.Assertions.*;
 import static org.lfenergy.compas.sct.commons.testhelpers.SclTestMarshaller.assertIsMarshallable;
 
@@ -24,7 +31,7 @@ class SclAutomationServiceTest {
     private HeaderDTO headerDTO;
 
     @BeforeEach
-    void init(){
+    void init() {
         headerDTO = new HeaderDTO();
         headerDTO.setRevision("hRevision");
         headerDTO.setVersion("hVersion");
@@ -63,7 +70,7 @@ void createSCD_With_HItem() throws Exception {
         SclRootAdapter expectedSCD = SclAutomationService.createSCD(ssd, headerDTO, Set.of(std1, std2, std3));
         // Then
         assertNotNull(expectedSCD.getCurrentElem().getHeader().getId());
-        assertEquals(1 ,expectedSCD.getCurrentElem().getHeader().getHistory().getHitem().size());
+        assertEquals(1, expectedSCD.getCurrentElem().getHeader().getHistory().getHitem().size());
         assertEquals(1, expectedSCD.getCurrentElem().getSubstation().size());
         assertIsMarshallable(expectedSCD.getCurrentElem());
     }
@@ -85,7 +92,7 @@ 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));
+        SclRootAdapter expectedSCD = SclAutomationService.createSCD(ssd, headerDTO, Set.of(std1, std2, std3));
         // Then
         assertNotNull(expectedSCD.getCurrentElem().getHeader().getId());
         assertEquals(1, expectedSCD.getCurrentElem().getHeader().getHistory().getHitem().size());
@@ -98,8 +105,68 @@ 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<>();
         assertThrows(ScdException.class,
-                () ->  SclAutomationService.createSCD(ssd, headerDTO, new HashSet<>()) );
+                () -> SclAutomationService.createSCD(ssd, headerDTO, stdListEmpty));
+    }
+
+    @Test
+    void createSCD_should_throw_exception_when_null_ssd() throws Exception {
+        // Given
+        HeaderDTO.HistoryItem historyItem = new HeaderDTO.HistoryItem();
+        historyItem.setWhat("what");
+        historyItem.setWho("me");
+        historyItem.setWhy("because");
+        headerDTO.getHistoryItems().add(historyItem);
+        SCL std1 = SclTestMarshaller.getSCLFromFile("/std_1.xml");
+        Set<SCL> stdList = Set.of(std1);
+
+        // When & Then
+        assertThrows(NullPointerException.class, () -> SclAutomationService.createSCD(null, headerDTO, stdList));
     }
 
+    @Test
+    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);
+
+        // When & Then
+        assertThrows(NullPointerException.class, () -> SclAutomationService.createSCD(ssd, null, stdList));
+    }
+
+    @Test
+    void createSCD_should_delete_ControlBlocks_DataSet_and_ExtRef_src_attributes() throws Exception {
+        // Given
+        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));
+        // Then
+        LN0 ln0 = expectedSCD.streamIEDAdapters()
+                .findFirst()
+                .map(iedAdapter -> iedAdapter.getLDeviceAdapterByLdInst("lDeviceInst1").orElseThrow())
+                .map(LDeviceAdapter::getLN0Adapter)
+                .map(SclElementAdapter::getCurrentElem)
+                .orElseThrow(() -> new RuntimeException("Test shouldn't fail here, please check your XML input file"));
+
+        assertThat(ln0.getDataSet()).isEmpty();
+        assertThat(ln0.getInputs().getExtRef()).hasSize(2);
+        assertFalse(ln0.getInputs().getExtRef().get(0).isSetSrcLDInst());
+        assertIsMarshallable(expectedSCD.getCurrentElem());
+    }
+
+    @Test
+    void class_should_not_be_instantiable() {
+        // Given
+        Constructor<?>[] constructors = SclAutomationService.class.getDeclaredConstructors();
+        assertThat(constructors).hasSize(1);
+        Constructor<?> constructor = constructors[0];
+        constructor.setAccessible(true);
+        // When & Then
+        assertThatThrownBy(constructor::newInstance)
+                .isInstanceOf(InvocationTargetException.class)
+                .getCause().isInstanceOf(UnsupportedOperationException.class);
+    }
 }
diff --git a/sct-commons/src/main/java/org/lfenergy/compas/sct/commons/scl/ied/AbstractLNAdapter.java b/sct-commons/src/main/java/org/lfenergy/compas/sct/commons/scl/ied/AbstractLNAdapter.java
@@ -350,7 +350,7 @@ public List<ControlBlock<?>> getControlBlocksForMatchingFCDA(@NonNull ExtRefInfo
         List<TDataSet> tDataSets = this.getDataSetMatchingExtRefInfo(extRefInfo);
         return getControlBlocks(tDataSets, extRefInfo.getBindingInfo().getServiceType());
     }
-    
+
     /**
      * Gets all Control Blocks from LNode for specified Service Type (GOOSE, SMV and REPORT) and Data Sets
      *
diff --git a/sct-commons/src/test/java/org/lfenergy/compas/sct/commons/scl/ied/DAITrackerTest.java b/sct-commons/src/test/java/org/lfenergy/compas/sct/commons/scl/ied/DAITrackerTest.java
@@ -12,6 +12,7 @@
 import org.lfenergy.compas.sct.commons.scl.SclRootAdapter;
 import org.lfenergy.compas.sct.commons.testhelpers.SclTestMarshaller;
 
+import static org.assertj.core.api.Assertions.assertThat;
 import static org.junit.jupiter.api.Assertions.*;
 
 class DAITrackerTest {
diff --git a/sct-commons/src/test/java/org/lfenergy/compas/sct/commons/scl/ied/IEDAdapterTest.java b/sct-commons/src/test/java/org/lfenergy/compas/sct/commons/scl/ied/IEDAdapterTest.java
@@ -13,6 +13,7 @@
 import org.lfenergy.compas.sct.commons.exception.ScdException;
 import org.lfenergy.compas.sct.commons.scl.ObjectReference;
 import org.lfenergy.compas.sct.commons.scl.SclRootAdapter;
+import org.lfenergy.compas.sct.commons.scl.com.SubNetworkAdapter;
 import org.lfenergy.compas.sct.commons.testhelpers.SclTestMarshaller;
 import org.mockito.Mockito;
 
diff --git a/sct-commons/src/test/resources/scd-ied-dtt-com-import-stds/ssd.xml b/sct-commons/src/test/resources/scd-ied-dtt-com-import-stds/ssd.xml
@@ -6,7 +6,7 @@
   -->
 <SCL xmlns:compas="https://www.lfenergy.org/compas/extension/v1" xmlns="http://www.iec.ch/61850/2003/SCL" version="2007" revision="B" release="4">
     <Private type="COMPAS-SclFileType">
-        <compas:SclFileType>SCD</compas:SclFileType>
+        <compas:SclFileType>SSD</compas:SclFileType>
     </Private>
     <Header id="HeaderId" version="HeaderVersion" revision="HeaderRevision"/>
     <Substation name="SITE">
@@ -16,7 +16,7 @@
                 <Function name="FUNCTION_1">
                     <LNode iedName="None" ldInst="LDGW" lnClass="LLN0">
                         <Private type="COMPAS-ICDHeader">
-                            <compas:ICDHeader IEDType="GTW" IEDinstance="0" BayLabel="SITE1" IEDName="SITESITE1GTW0" ICDSystemVersionUUID="IED4d4fe1a8cda64cf88a5ee4176a1a0eef" VendorName="ABC" IEDredundancy="A" IEDmodel="ICDfromModeling" hwRev="01.00.00" swRev="01.00.00" headerId="f8dbc8c1-2db7-4652-a9d6-0b414bdeccfa" headerVersion="01.00.00" headerRevision="01.00.00"/>
+                            <compas:ICDHeader IEDType="GTW" IEDinstance="0" BayLabel="SITE1" IEDName="ied1" ICDSystemVersionUUID="IED4d4fe1a8cda64cf88a5ee4176a1a0eef" VendorName="ABC" IEDredundancy="A" IEDmodel="ICDfromModeling" hwRev="01.00.00" swRev="01.00.00" headerId="f8dbc8c1-2db7-4652-a9d6-0b414bdeccfa" headerVersion="01.00.00" headerRevision="01.00.00"/>
                         </Private>
                     </LNode>
                 </Function>
diff --git a/sct-commons/src/test/resources/scd-refresh-lnode/issue68_Test_Dai_Not_Updatable.scd b/sct-commons/src/test/resources/scd-refresh-lnode/issue68_Test_Dai_Not_Updatable.scd
diff --git a/sct-commons/src/test/resources/scl-remove-controlBlocks-dataSet-extRefSrc/scl-with-control-blocks.xml b/sct-commons/src/test/resources/scl-remove-controlBlocks-dataSet-extRefSrc/scl-with-control-blocks.xml

Original file line number	Diff line number	Diff line change
`@@ -350,7 +350,7 @@ public List<ControlBlock<?>> getControlBlocksForMatchingFCDA(@NonNull ExtRefInfo`
`350`	`350`	`List<TDataSet> tDataSets = this.getDataSetMatchingExtRefInfo(extRefInfo);`
`351`	`351`	`return getControlBlocks(tDataSets, extRefInfo.getBindingInfo().getServiceType());`
`352`	`352`	`}`
`353`		`-`
	`353`	`+`
`354`	`354`	`/**`
`355`	`355`	`* Gets all Control Blocks from LNode for specified Service Type (GOOSE, SMV and REPORT) and Data Sets`
`356`	`356`	`*`