Merge pull request #236 from com-pas/235-error-while-importing-std-files

fix(#235): Error occurs when importing STD file during SCD automated creation

Author: SaintierFr

sct-commons/src/main/java/org/lfenergy/compas/sct/commons/scl/PrivateService.java

@@ -12,6 +12,7 @@
 import javax.xml.bind.JAXBElement;
 import java.util.*;
 import java.util.function.Predicate;
+import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
 import static org.lfenergy.compas.sct.commons.util.CommonConstants.*;
@@ -298,21 +299,23 @@ public static String stdCheckFormatExceptionMessage(TPrivate key) throws ScdExce
 
 
     /**
-     * Creates map of IEDName and related Private for all Privates COMPAS-ICDHeader in /Substation of SCL
+     * Creates stream of Private for all Privates COMPAS-ICDHeader in /Substation of SCL
      *
      * @param scdRootAdapter SCL file in which Private should be found
-     * @return map of Private and its IEDName parameter
+     * @return stream of COMPAS-ICDHeader Private
      */
-    public static Stream<TPrivate> createMapIEDNameAndPrivate(SclRootAdapter scdRootAdapter) {
+    public static Stream<TPrivate> streamIcdHeaderPrivatesWithDistinctIEDName(SclRootAdapter scdRootAdapter) {
         return scdRootAdapter.getCurrentElem().getSubstation().get(0).getVoltageLevel().stream()
                 .map(TVoltageLevel::getBay).flatMap(Collection::stream)
                 .map(TBay::getFunction).flatMap(Collection::stream)
                 .map(TFunction::getLNode).flatMap(Collection::stream)
                 .map(TLNode::getPrivate).flatMap(Collection::stream)
                 .filter(tPrivate ->
                         tPrivate.getType().equals(COMPAS_ICDHEADER.getPrivateType())
-                                && PrivateService.extractCompasICDHeader(tPrivate).isPresent()
-                                && PrivateService.extractCompasICDHeader(tPrivate).get().getIEDName() != null);
+                                && PrivateService.extractCompasICDHeader(tPrivate).map(TCompasICDHeader::getIEDName).isPresent())
+                .collect(Collectors.groupingBy(tPrivate -> PrivateService.extractCompasICDHeader(tPrivate).get().getIEDName()))
+                .values().stream()
+                .map(tPrivates -> tPrivates.get(0));
     }
 
 

sct-commons/src/main/java/org/lfenergy/compas/sct/commons/scl/SclService.java

@@ -502,7 +502,7 @@ public static SclRootAdapter importSTDElementsInSCD(@NonNull SclRootAdapter scdR
         PrivateService.checkSTDCorrespondanceWithLNodeCompasICDHeader(mapICDSystemVersionUuidAndSTDFile);
         // List all Private and remove duplicated one with same iedName
         //For each Private.ICDSystemVersionUUID and Private.iedName find STD File
-        PrivateService.createMapIEDNameAndPrivate(scdRootAdapter).forEach(tPrivate -> {
+        PrivateService.streamIcdHeaderPrivatesWithDistinctIEDName(scdRootAdapter).forEach(tPrivate -> {
             String iedName = PrivateService.extractCompasICDHeader(tPrivate).get().getIEDName();
             String icdSysVerUuid = PrivateService.extractCompasICDHeader(tPrivate).map(TCompasICDHeader::getICDSystemVersionUUID)
                     .orElseThrow(() -> new ScdException(ICD_SYSTEM_VERSION_UUID + " is not present in COMPAS-ICDHeader in LNode")

sct-commons/src/test/java/org/lfenergy/compas/sct/commons/scl/PrivateServiceTest.java

@@ -437,7 +437,7 @@ void createMapIEDNameAndPrivate_should_return_map_of_three_items() {
         //When
         SclRootAdapter sclRootAdapter = SclService.initScl(Optional.empty(), "hv", "hr");
         sclRootAdapter.setCurrentElem(scl);
-        Stream<TPrivate> tPrivateStream = PrivateService.createMapIEDNameAndPrivate(sclRootAdapter);
+        Stream<TPrivate> tPrivateStream = PrivateService.streamIcdHeaderPrivatesWithDistinctIEDName(sclRootAdapter);
 
         //Then
         assertThat(tPrivateStream.toList()).hasSize(3)
@@ -467,7 +467,7 @@ void createMapIEDNameAndPrivate_should_return_empty_map_when_no_compasicdheader_
         //When
         SclRootAdapter sclRootAdapter = SclService.initScl(Optional.empty(), "hv", "hr");
         sclRootAdapter.setCurrentElem(scl);
-        Stream<TPrivate> tPrivateStream = PrivateService.createMapIEDNameAndPrivate(sclRootAdapter);
+        Stream<TPrivate> tPrivateStream = PrivateService.streamIcdHeaderPrivatesWithDistinctIEDName(sclRootAdapter);
 
         //Then
         assertThat(tPrivateStream.toList()).isEmpty();

sct-commons/src/test/java/org/lfenergy/compas/sct/commons/scl/SclServiceTest.java

@@ -792,6 +792,17 @@ void testImportSTDElementsInSCD_Several_STD_Match_Compas_ICDHeader() {
         assertIsMarshallable(scd);
     }
 
+    @Test
+    void test_importSTDElementsInSCD_should_not_throw_exception_when_SCD_file_contains_same_ICDHeader_in_two_different_functions() {
+        //Given
+        SCL scd = SclTestMarshaller.getSCLFromFile("/scd-ied-dtt-com-import-stds/scd_with_same_compas_icd_header_in_different_functions.xml");
+        SCL std = SclTestMarshaller.getSCLFromFile("/scd-ied-dtt-com-import-stds/std.xml");
+        SclRootAdapter scdRootAdapter = new SclRootAdapter(scd);
+        //When Then
+        assertDoesNotThrow(() -> SclService.importSTDElementsInSCD(scdRootAdapter, Set.of(std), DTO.comMap));
+        assertIsMarshallable(scd);
+    }
+
     @Test
     void testImportSTDElementsInSCD_Compas_ICDHeader_Not_Match() {
         //Given

sct-commons/src/test/resources/scd-ied-dtt-com-import-stds/scd_with_same_compas_icd_header_in_different_functions.xml

@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ~ // SPDX-FileCopyrightText: 2021 RTE FRANCE
+  ~ //
+  ~ // SPDX-License-Identifier: Apache-2.0
+  -->
+<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>
+    </Private>
+    <Header id="HeaderId" version="HeaderVersion" revision="HeaderRevision"/>
+    <Substation name="SITE">
+        <VoltageLevel nomFreq="50" numPhases="3" name="0">
+            <Voltage unit="V" multiplier="k">0</Voltage>
+            <Bay name="BAY_1">
+                <Function name="FUNCTION_1">
+                    <LNode iedName="None" ldInst="LDGW" lnClass="LLN0">
+                        <Private type="COMPAS-ICDHeader">
+                            <compas:ICDHeader IEDType="SCU" IEDinstance="0" BayLabel="SITE1" IEDName="SITESITE1SCU0" ICDSystemVersionUUID="IED4d4fe1a8cda64cf88a5ee4176a1a0eef" VendorName="RTE" 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>
+                <Function name="FUNCTION_2">
+                    <LNode iedName="None" ldInst="LDGW" lnClass="GAPC">
+                        <Private type="COMPAS-ICDHeader">
+                            <compas:ICDHeader IEDType="SCU" IEDinstance="0" BayLabel="SITE1" IEDName="SITESITE1SCU0" ICDSystemVersionUUID="IED4d4fe1a8cda64cf88a5ee4176a1a0eef" VendorName="RTE" 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>
+            </Bay>
+        </VoltageLevel>
+    </Substation>
+</SCL>