Merge pull request #194 from com-pas/feat/92_filter_FCDA

feat(92): RSR-473 - add check ExtRef is Bay internal and is ExtRef source a Fcda Candidate
feat(80): RSR-398 - add service to create DataSet and ControlBlocks part 1

Author: massifben

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

@@ -146,7 +146,7 @@ void createSCD_should_delete_ControlBlocks_DataSet_and_ExtRef_src_attributes() t
         // Then
         LN0 ln0 = expectedSCD.streamIEDAdapters()
                 .findFirst()
-                .map(iedAdapter -> iedAdapter.getLDeviceAdapterByLdInst("lDeviceInst1").orElseThrow())
+                .map(iedAdapter -> iedAdapter.findLDeviceAdapterByLdInst("lDeviceInst1").orElseThrow())
                 .map(LDeviceAdapter::getLN0Adapter)
                 .map(SclElementAdapter::getCurrentElem)
                 .orElseThrow(() -> new RuntimeException("Test shouldn't fail here, please check your XML input file"));

sct-commons/pom.xml

@@ -21,6 +21,7 @@
         <sonar.coverage.jacoco.xmlReportPaths>${basedir}/${aggregate.report.dir}</sonar.coverage.jacoco.xmlReportPaths>
         <sonar.jacoco.excludes>**/scl2007b4/**/*</sonar.jacoco.excludes>
         <assertJ.version>3.22.0</assertJ.version>
+        <opencsv.version>5.6</opencsv.version>
         <mockito.version>4.9.0</mockito.version>
     </properties>
 
@@ -112,6 +113,11 @@
             <version>${assertJ.version}</version>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>com.opencsv</groupId>
+            <artifactId>opencsv</artifactId>
+            <version>${opencsv.version}</version>
+        </dependency>
     </dependencies>
 
     <build>

sct-commons/src/main/java/org/lfenergy/compas/sct/commons/dto/ControlBlock.java

@@ -105,7 +105,7 @@ public void validateCB() throws ScdException {
     public void validateDestination(SclRootAdapter sclRootAdapter) throws ScdException {
         for(TControlWithIEDName.IEDName iedName : iedNames){
             IEDAdapter iedAdapter =sclRootAdapter.getIEDAdapterByName(iedName.getValue());
-            LDeviceAdapter lDeviceAdapter = iedAdapter.getLDeviceAdapterByLdInst(iedName.getLdInst())
+            LDeviceAdapter lDeviceAdapter = iedAdapter.findLDeviceAdapterByLdInst(iedName.getLdInst())
                     .orElseThrow(
                             () -> new ScdException(
                                     String.format(

sct-commons/src/main/java/org/lfenergy/compas/sct/commons/dto/DataTypeName.java

@@ -45,6 +45,8 @@
 @NoArgsConstructor
 @EqualsAndHashCode
 public class DataTypeName {
+    protected static final String DELIMITER = ".";
+
     protected String name = ""; // dataName or DataAttributeName
 
     private List<String> structNames = new ArrayList<>(); // [.DataName[…]] or [.DAComponentName[ ….]]
@@ -98,13 +100,8 @@ public boolean isDefined(){
      */
     @Override
     public String toString(){
-        StringBuilder stringBuilder = new StringBuilder();
-        stringBuilder.append(name);
-        for(String sName : structNames){
-            stringBuilder.append('.');
-            stringBuilder.append(sName);
-        }
-        return stringBuilder.toString();
+        return name
+            + (getStructNames().isEmpty() ? StringUtils.EMPTY : DELIMITER + String.join(DELIMITER, getStructNames()));
     }
 
     /**

sct-commons/src/main/java/org/lfenergy/compas/sct/commons/dto/DoTypeName.java

@@ -8,7 +8,9 @@
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 import lombok.Setter;
+import org.apache.commons.lang3.StringUtils;
 import org.lfenergy.compas.scl2007b4.model.TPredefinedCDCEnum;
+import org.lfenergy.compas.sct.commons.util.Utils;
 
 /**
  * A representation of the model object <em><b>DoTypeName</b></em>.
@@ -34,6 +36,7 @@ public class DoTypeName extends DataTypeName {
 
     /**
      * Constructor
+     *
      * @param doName input
      */
     public DoTypeName(String doName) {
@@ -42,6 +45,7 @@ public DoTypeName(String doName) {
 
     /**
      * Constructor
+     *
      * @param ppDoName input
      * @param sdoNames input
      */
@@ -51,24 +55,39 @@ public DoTypeName(String ppDoName, String sdoNames) {
 
     /**
      * Initializes DoTypeName
+     *
      * @param dataName input
      * @return DoTypeName object
      */
-    public static DoTypeName from(DoTypeName dataName){
+    public static DoTypeName from(DoTypeName dataName) {
         DoTypeName doTypeName = new DoTypeName(dataName.toString());
-        if(doTypeName.isDefined()) {
+        if (doTypeName.isDefined()) {
             doTypeName.setCdc(dataName.getCdc());
         }
         return doTypeName;
     }
 
     /**
      * Copy DO's content
+     *
      * @param doName DO object
      */
     public void merge(DoTypeName doName) {
-        if(!isDefined()) return;
-        if(cdc == null)
+        if (!isDefined()) return;
+        if (cdc == null)
             cdc = doName.getCdc();
     }
+
+    /**
+     * Same as toString() without the instance of the DO.
+     * Only the DO can have an instance number (not the SDO).
+     * Prerequisites: A non instanced DO never ends with digits.
+     *
+     * @return Same as DataTypeName#toString(), without the digits at the end of the DO if any.
+     * @see DataTypeName#toString()
+     */
+    public String toStringWithoutInst() {
+        return Utils.removeTrailingDigits(name)
+            + (getStructNames().isEmpty() ? StringUtils.EMPTY : DELIMITER + String.join(DELIMITER, getStructNames()));
+    }
 }

sct-commons/src/main/java/org/lfenergy/compas/sct/commons/dto/SclReportItem.java

@@ -7,10 +7,12 @@
 import lombok.AllArgsConstructor;
 import lombok.EqualsAndHashCode;
 import lombok.Getter;
+import lombok.ToString;
 
 @Getter
 @EqualsAndHashCode
 @AllArgsConstructor
+@ToString
 public final class SclReportItem {
     private final String xpath;
     private final String message;

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

@@ -11,6 +11,7 @@
 import org.lfenergy.compas.scl2007b4.model.TIED;
 import org.lfenergy.compas.sct.commons.dto.SclReport;
 import org.lfenergy.compas.sct.commons.dto.SclReportItem;
+import org.lfenergy.compas.sct.commons.exception.ScdException;
 import org.lfenergy.compas.sct.commons.scl.ied.IEDAdapter;
 import org.lfenergy.compas.sct.commons.scl.ied.LDeviceAdapter;
 import org.lfenergy.compas.sct.commons.scl.ied.LN0Adapter;
@@ -19,10 +20,13 @@
 import java.util.*;
 import java.util.function.Function;
 import java.util.stream.Collectors;
+import java.util.stream.Stream;
 
 @UtilityClass
 public class ExtRefService {
 
+    private static final String MESSAGE_MISSING_IED_NAME_PARAMETER = "IED.name parameter is missing";
+
     /**
      * Updates iedName attribute of all ExtRefs in the Scd.
      *
@@ -88,12 +92,42 @@ private static List<SclReportItem> checkIedUnityOfIcdSystemVersionUuid(SclRootAd
             .filter(entry -> StringUtils.isNotBlank(entry.getKey()))
             .filter(entry -> entry.getValue().size() > 1)
             .map(entry -> SclReportItem.fatal(entry.getValue().stream()
-                .map(tied -> new IEDAdapter(sclRootAdapter, tied))
-                .map(IEDAdapter::getXPath)
-                .collect(Collectors.joining(", ")),
+                    .map(tied -> new IEDAdapter(sclRootAdapter, tied))
+                    .map(IEDAdapter::getXPath)
+                    .collect(Collectors.joining(", ")),
                 "/IED/Private/compas:ICDHeader[@ICDSystemVersionUUID] must be unique" +
                     " but the same ICDSystemVersionUUID was found on several IED."))
             .collect(Collectors.toList());
     }
 
+    public static SclReport createDataSetAndControlBlocks(SCL scd) {
+        SclRootAdapter sclRootAdapter = new SclRootAdapter(scd);
+        Stream<LDeviceAdapter> lDeviceAdapters = sclRootAdapter.streamIEDAdapters().flatMap(IEDAdapter::streamLDeviceAdapters);
+        return createDataSetAndControlBlocks(sclRootAdapter, lDeviceAdapters);
+    }
+
+    public static SclReport createDataSetAndControlBlocks(SCL scd, String targetIedName) {
+        SclRootAdapter sclRootAdapter = new SclRootAdapter(scd);
+        IEDAdapter iedAdapter = sclRootAdapter.getIEDAdapterByName(targetIedName);
+        return createDataSetAndControlBlocks(sclRootAdapter, iedAdapter.streamLDeviceAdapters());
+
+    }
+
+    public static SclReport createDataSetAndControlBlocks(SCL scd, String targetIedName, String targetLDeviceInst) {
+        if (StringUtils.isBlank(targetIedName)) {
+            throw new ScdException(MESSAGE_MISSING_IED_NAME_PARAMETER);
+        }
+        SclRootAdapter sclRootAdapter = new SclRootAdapter(scd);
+        IEDAdapter iedAdapter = sclRootAdapter.getIEDAdapterByName(targetIedName);
+        LDeviceAdapter lDeviceAdapter = iedAdapter.getLDeviceAdapterByLdInst(targetLDeviceInst);
+        return createDataSetAndControlBlocks(sclRootAdapter, Stream.of(lDeviceAdapter));
+    }
+
+    private static SclReport createDataSetAndControlBlocks(SclRootAdapter sclRootAdapter, Stream<LDeviceAdapter> lDeviceAdapters) {
+        List<SclReportItem> sclReportItems = lDeviceAdapters
+            .map(LDeviceAdapter::createDataSetAndControlBlocks)
+            .flatMap(List::stream)
+            .collect(Collectors.toList());
+        return new SclReport(sclRootAdapter, sclReportItems);
+    }
 }

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

@@ -17,6 +17,8 @@
 import org.lfenergy.compas.sct.commons.scl.ied.IEDAdapter;
 import org.lfenergy.compas.sct.commons.scl.sstation.SubstationAdapter;
 
+import java.util.Objects;
+import java.util.Optional;
 import java.util.stream.Stream;
 
 /**
@@ -59,6 +61,7 @@ public class SclRootAdapter extends SclElementAdapter<SclRootAdapter, SCL> {
     public static final short RELEASE = 4;
     public static final String REVISION = "B";
     public static final String VERSION = "2007";
+    private static final String MESSAGE_IED_NAME_NOT_FOUND = "IED.name '%s' not found in SCD";
 
     /**
      * Constructor
@@ -185,7 +188,7 @@ public IEDAdapter addIED(SCL icd, String iedName) throws ScdException {
             throw new ScdException("No IED to import from ICD file");
         }
 
-        if(hasIED(iedName)){
+        if(findIedAdapterByName(iedName).isPresent()){
             String msg = "SCL file already contains IED: " + iedName;
             log.error(msg);
             throw new ScdException(msg);
@@ -205,17 +208,6 @@ public IEDAdapter addIED(SCL icd, String iedName) throws ScdException {
         return getIEDAdapterByName(iedName);
     }
 
-    /**
-     * Checks if IED is present in SCL
-     * @param iedName name of IED to find in SCL
-     * @return <em>Boolean</em> value of check result
-     */
-    private boolean hasIED(String iedName) {
-        return currentElem.getIED()
-                .stream()
-                .anyMatch(tied -> tied.getName().equals(iedName));
-    }
-
     /**
      * Gets Header from current SCL
      * @return <em>HeaderAdapter</em> object as Header of SCL
@@ -242,8 +234,20 @@ public DataTypeTemplateAdapter getDataTypeTemplateAdapter(){
      * @throws ScdException throws when unknown IED
      */
     public IEDAdapter getIEDAdapterByName(String iedName) throws ScdException {
-        // <IED iedNAme></IED> ; Unmarshaller
-        return new IEDAdapter(this,iedName);
+        return findIedAdapterByName(iedName)
+            .orElseThrow(() -> new ScdException(String.format(MESSAGE_IED_NAME_NOT_FOUND, iedName)));
+    }
+
+    /**
+     * Find an IED by name from SCL
+     * @param iedName name of IED to find in SCL
+     * @return <em>Optional<IEDAdapter></em> of the first IED with a matching name
+     */
+    public Optional<IEDAdapter> findIedAdapterByName(String iedName) throws ScdException {
+        return currentElem.getIED().stream()
+            .filter(ied -> Objects.equals(ied.getName(), iedName))
+            .findFirst()
+            .map(ied -> new IEDAdapter(this, ied));
     }
 
     /**

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

@@ -79,9 +79,9 @@
 @Slf4j
 public class SclService {
 
-    public static final String UNKNOWN_LDEVICE_S_IN_IED_S = "Unknown LDevice (%s) in IED (%s)";
-    public static final String INVALID_OR_MISSING_ATTRIBUTES_IN_EXT_REF_BINDING_INFO = "Invalid or missing attributes in ExtRef binding info";
-    public static final ObjectFactory objectFactory = new ObjectFactory();
+    private static final String UNKNOWN_LDEVICE_S_IN_IED_S = "Unknown LDevice (%s) in IED (%s)";
+    private static final String INVALID_OR_MISSING_ATTRIBUTES_IN_EXT_REF_BINDING_INFO = "Invalid or missing attributes in ExtRef binding info";
+    private static final ObjectFactory objectFactory = new ObjectFactory();
 
     private SclService() {
         throw new IllegalStateException("SclService class");
@@ -233,7 +233,7 @@ public static List<ExtRefInfo> getExtRefInfo(SCL scd, String iedName, String ldI
 
         SclRootAdapter sclRootAdapter = new SclRootAdapter(scd);
         IEDAdapter iedAdapter = sclRootAdapter.getIEDAdapterByName(iedName);
-        LDeviceAdapter lDeviceAdapter = iedAdapter.getLDeviceAdapterByLdInst(ldInst)
+        LDeviceAdapter lDeviceAdapter = iedAdapter.findLDeviceAdapterByLdInst(ldInst)
                 .orElseThrow(() -> new ScdException(String.format(UNKNOWN_LDEVICE_S_IN_IED_S, ldInst, iedName)));
         return lDeviceAdapter.getExtRefInfo();
     }
@@ -254,7 +254,7 @@ public static List<ExtRefInfo> getExtRefInfo(SCL scd, String iedName, String ldI
     public static List<ExtRefBindingInfo> getExtRefBinders(SCL scd, String iedName, String ldInst, String lnClass, String lnInst, String prefix, ExtRefSignalInfo signalInfo) throws ScdException {
         SclRootAdapter sclRootAdapter = new SclRootAdapter(scd);
         IEDAdapter iedAdapter = sclRootAdapter.getIEDAdapterByName(iedName);
-        LDeviceAdapter lDeviceAdapter = iedAdapter.getLDeviceAdapterByLdInst(ldInst)
+        LDeviceAdapter lDeviceAdapter = iedAdapter.findLDeviceAdapterByLdInst(ldInst)
                 .orElseThrow(() -> new ScdException(String.format(UNKNOWN_LDEVICE_S_IN_IED_S, ldInst, iedName)));
         AbstractLNAdapter<?> abstractLNAdapter = AbstractLNAdapter.builder()
                 .withLDeviceAdapter(lDeviceAdapter)
@@ -289,7 +289,7 @@ public static void updateExtRefBinders(SCL scd, ExtRefInfo extRefInfo) throws Sc
         String ldInst = extRefInfo.getHolderLDInst();
         SclRootAdapter sclRootAdapter = new SclRootAdapter(scd);
         IEDAdapter iedAdapter = sclRootAdapter.getIEDAdapterByName(iedName);
-        LDeviceAdapter lDeviceAdapter = iedAdapter.getLDeviceAdapterByLdInst(ldInst)
+        LDeviceAdapter lDeviceAdapter = iedAdapter.findLDeviceAdapterByLdInst(ldInst)
                 .orElseThrow(() -> new ScdException(String.format(UNKNOWN_LDEVICE_S_IN_IED_S, ldInst, iedName)));
 
         AbstractLNAdapter<?> abstractLNAdapter = AbstractLNAdapter.builder()
@@ -330,7 +330,7 @@ public static List<ControlBlock<?>> getExtRefSourceInfo(SCL scd, ExtRefInfo extR
 
         // Get CBs
         IEDAdapter srcIEDAdapter = sclRootAdapter.getIEDAdapterByName(bindingInfo.getIedName());
-        LDeviceAdapter srcLDeviceAdapter = srcIEDAdapter.getLDeviceAdapterByLdInst(extRefInfo.getBindingInfo().getLdInst())
+        LDeviceAdapter srcLDeviceAdapter = srcIEDAdapter.findLDeviceAdapterByLdInst(extRefInfo.getBindingInfo().getLdInst())
                 .orElseThrow();
 
         List<AbstractLNAdapter<?>> aLNAdapters = srcLDeviceAdapter.getLNAdaptersInclundigLN0();
@@ -375,7 +375,7 @@ public static TExtRef updateExtRefSource(SCL scd, ExtRefInfo extRefInfo) throws
 
         SclRootAdapter sclRootAdapter = new SclRootAdapter(scd);
         IEDAdapter iedAdapter = sclRootAdapter.getIEDAdapterByName(iedName);
-        LDeviceAdapter lDeviceAdapter = iedAdapter.getLDeviceAdapterByLdInst(ldInst)
+        LDeviceAdapter lDeviceAdapter = iedAdapter.findLDeviceAdapterByLdInst(ldInst)
                 .orElseThrow(() -> new ScdException(String.format(UNKNOWN_LDEVICE_S_IN_IED_S, ldInst, iedName)));
         var anLNAdapter = AbstractLNAdapter.builder()
                 .withLDeviceAdapter(lDeviceAdapter)
@@ -401,7 +401,7 @@ public static TExtRef updateExtRefSource(SCL scd, ExtRefInfo extRefInfo) throws
     public static Set<ResumedDataTemplate> getDAI(SCL scd, String iedName, String ldInst, ResumedDataTemplate rDtt, boolean updatable) throws ScdException {
         SclRootAdapter sclRootAdapter = new SclRootAdapter(scd);
         IEDAdapter iedAdapter = new IEDAdapter(sclRootAdapter, iedName);
-        LDeviceAdapter lDeviceAdapter = iedAdapter.getLDeviceAdapterByLdInst(ldInst)
+        LDeviceAdapter lDeviceAdapter = iedAdapter.findLDeviceAdapterByLdInst(ldInst)
                 .orElseThrow(() -> new ScdException(String.format(UNKNOWN_LDEVICE_S_IN_IED_S, ldInst, iedName)));
 
         return lDeviceAdapter.getDAI(rDtt, updatable);
@@ -433,7 +433,7 @@ public static void updateDAI(SCL scd, String iedName, String ldInst, ResumedData
         }
 
         IEDAdapter iedAdapter = sclRootAdapter.getIEDAdapterByName(iedName);
-        LDeviceAdapter lDeviceAdapter = iedAdapter.getLDeviceAdapterByLdInst(ldInst)
+        LDeviceAdapter lDeviceAdapter = iedAdapter.findLDeviceAdapterByLdInst(ldInst)
                 .orElseThrow(() -> new ScdException(String.format(UNKNOWN_LDEVICE_S_IN_IED_S, ldInst, iedName)));
 
         AbstractLNAdapter<?> lnAdapter = AbstractLNAdapter.builder()

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

@@ -579,7 +579,7 @@ public TExtRef checkExtRefInfoCoherence(@NonNull ExtRefInfo extRefInfo) throws S
         } else {
             binderIEDAdapter = getCurrentIed();
         }
-        LDeviceAdapter binderLDAdapter = binderIEDAdapter.getLDeviceAdapterByLdInst(binderLdInst)
+        LDeviceAdapter binderLDAdapter = binderIEDAdapter.findLDeviceAdapterByLdInst(binderLdInst)
                 .orElseThrow(
                         () -> new ScdException(
                                 String.format("Unknown LDevice (%s) in IED (%s)", binderLdInst, binderIedName)