feat(188): handle Report ExtRef when creating dataSet

massifben · massifben · commit 09da44f30070 · 2022-11-23T14:32:43.000+01:00
Signed-off-by: massifben &lt;105049157+massifben@users.noreply.github.com&gt;
diff --git a/sct-commons/src/main/java/org/lfenergy/compas/sct/commons/scl/ied/InputsAdapter.java b/sct-commons/src/main/java/org/lfenergy/compas/sct/commons/scl/ied/InputsAdapter.java
@@ -17,8 +17,8 @@
 import org.lfenergy.compas.sct.commons.util.Utils;
 
 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.LDeviceStatus.OFF;
 import static org.lfenergy.compas.sct.commons.util.LDeviceStatus.ON;
@@ -44,6 +44,9 @@ public class InputsAdapter extends SclElementAdapter<LN0Adapter, TInputs> {
     private static final String MESSAGE_SERVICE_TYPE_MISSING_ON_EXTREF = "The signal ExtRef is missing ServiceType attribute";
     private static final String MESSAGE_INVALID_SERVICE_TYPE = "The signal ExtRef ServiceType attribute is unexpected : %s";
     private static final String MESSAGE_IED_IS_MISSING_PRIVATE_COMPAS_BAY_UUID = "IED is missing Private/compas:Bay@UUID attribute";
+    private static final String MESSAGE_REPORT_EXTREF_DESC_MALFORMED = "ExtRef.serviceType=Report but ExtRef.desc attribute is malformed";
+    private static final int EXTREF_DESC_DA_NAME_POSITION = -2;
+    private static final String EXTREF_DESC_DELIMITER = "_";
 
     /**
      * Constructor
@@ -296,29 +299,34 @@ private Optional<SclReportItem> updateSourceDataSetsAndControlBlocks(TExtRef ext
             return warningReportItem(extRef, String.format(MESSAGE_SOURCE_LN_NOT_FOUND, optionalSourceLDevice.get().getXPath()));
         }
 
-        //TODO: Don't forget to test this in issue #84 RSR-433
-        List<ResumedDataTemplate> mxAndStSources = sourceDas.stream()
-            .filter(da -> da.getFc() == TFCEnum.MX || da.getFc() == TFCEnum.ST).toList();
-
-        Stream<ResumedDataTemplate> sourceDaToProcess;
-        switch (extRef.getServiceType()) {
-            case GOOSE:
-            case SMV:
-                sourceDaToProcess = mxAndStSources.stream().filter(FcdaCandidates.SINGLETON::contains);
-                break;
-            case REPORT:
-                //TODO: In issue RSR-608, replace with mxAndStSources.filter(...)
-                sourceDaToProcess = Stream.empty();
-                break;
-            case POLL:
-            default:
-                return fatalReportItem(extRef, String.format(MESSAGE_INVALID_SERVICE_TYPE, extRef.getServiceType()));
-        }
+        Optional<SclReportItem> sclReportItem = removeFilteredSourceDas(extRef, sourceDas);
         //TODO: map to FCDA in issue #84 RSR-433 and remove print to console
-        String daToPrint = sourceDaToProcess
+        String daToPrint = sourceDas.stream()
             .map(da -> da.getFc() + "#" + da.getDataAttributes())
             .collect(Collectors.joining(","));
         System.out.print("," + (daToPrint.isEmpty() ? "--NO_VALID_SOURCE_DA--" : daToPrint));
+        return sclReportItem;
+    }
+
+    private Optional<SclReportItem> removeFilteredSourceDas(TExtRef extRef, final Set<ResumedDataTemplate> sourceDas) {
+        //TODO: Don't forget to test this in issue #84 RSR-433
+        sourceDas.removeIf(da -> da.getFc() != TFCEnum.MX && da.getFc() != TFCEnum.ST);
+        return switch (extRef.getServiceType()) {
+            case GOOSE, SMV -> {
+                sourceDas.removeIf(Predicate.not(FcdaCandidates.SINGLETON::contains));
+                yield Optional.empty();
+            }
+            case REPORT -> filterReportSourceDa(extRef, sourceDas);
+            default -> fatalReportItem(extRef, String.format(MESSAGE_INVALID_SERVICE_TYPE, extRef.getServiceType()));
+        };
+    }
+
+    private Optional<SclReportItem> filterReportSourceDa(TExtRef extRef, Set<ResumedDataTemplate> sourceDas) {
+        String daName = Utils.extractField(extRef.getDesc(), EXTREF_DESC_DELIMITER, EXTREF_DESC_DA_NAME_POSITION);
+        if (StringUtils.isBlank(daName)) {
+            return fatalReportItem(extRef, MESSAGE_REPORT_EXTREF_DESC_MALFORMED);
+        }
+        sourceDas.removeIf(resumedDataTemplate -> !resumedDataTemplate.getDaName().toString().equals(daName));
         return Optional.empty();
     }
 
diff --git a/sct-commons/src/main/java/org/lfenergy/compas/sct/commons/util/Utils.java b/sct-commons/src/main/java/org/lfenergy/compas/sct/commons/util/Utils.java
@@ -140,6 +140,14 @@ public static boolean equalsOrBothBlank(String s1, String s2) {
             || (StringUtils.isBlank(s1) && StringUtils.isBlank(s2));
     }
 
+    /**
+     * Remove all digits at the end of the string, if any
+     * @param s input string
+     * @return s without digits at the end.
+     * Guarantees that the last character of the return value is not a digit.
+     * If s is composed only of digits, the result is an empty string
+     * @see Character#isDigit(int)
+     */
     public static String removeTrailingDigits(String s) {
         Objects.requireNonNull(s);
         if (s.isEmpty()) {
@@ -151,4 +159,20 @@ public static String removeTrailingDigits(String s) {
         }
         return s.substring(0, digitsPos);
     }
+
+    /**
+     * Split string s using regexDelimiter into an array, and return element at given index.
+     * @param s string to split
+     * @param regexDelimiter delimiter
+     * @param index index of the element in the split array (0 being the first element).
+     *              If index is a negative integer, position is counted from the end (-1 behind the last element).
+     * @return the element at position index in the split array, or null if index is out of bound
+     * @see String#split(String)
+     */
+    public static String extractField(String s, String regexDelimiter, int index) {
+        Objects.requireNonNull(s);
+        String[] split = s.split(regexDelimiter);
+        int column = index < 0 ? split.length + index : index;
+        return 0 <= column && column < split.length ? split[column] : null;
+    }
 }
diff --git a/sct-commons/src/test/java/org/lfenergy/compas/sct/commons/scl/ied/InputsAdapterForDemoTest.java b/sct-commons/src/test/java/org/lfenergy/compas/sct/commons/scl/ied/InputsAdapterForDemoTest.java
@@ -95,11 +95,10 @@ public static Stream<Arguments> provideUpdateAllSourceDataSetsAndControlBlocks()
                         + "ST#OtherDoName.daNameST",
                     "ExtRef.desc=test ServiceType is SMV, no daName and DO contains ST and MX, but only ST is FCDA candidate,isBayInternal=true,"
                         + "ST#OtherDoName.daNameST"})),
-            //TODO: issue 608 will change this
             Arguments.of(named("for Report, should ignore source DA",
                 new String[]{
-                    "ExtRef.desc=test ServiceType is Report,isBayInternal=true,"
-                        + NO_VALID_SOURCE_DA})),
+                    "ExtRef.desc=test ServiceType is Report_daReportST_1,isBayInternal=true,"
+                        + "ST#DoName.daReportST"})),
             Arguments.of(named("should ignore instance number when checking FCDA Candidate file",
                 new String[]{
                     "ExtRef.desc=test no daName and doName with instance number,isBayInternal=true,"
diff --git a/sct-commons/src/test/java/org/lfenergy/compas/sct/commons/scl/ied/InputsAdapterTest.java b/sct-commons/src/test/java/org/lfenergy/compas/sct/commons/scl/ied/InputsAdapterTest.java
@@ -88,7 +88,10 @@ void updateAllSourceDataSetsAndControlBlocks_should_report_ExtRef_attribute_miss
                 "The signal ExtRef is missing ServiceType attribute"),
             SclReportItem.fatal("/SCL/IED[@name=\"IED_NAME1\"]/AccessPoint/Server/LDevice[@inst=\"LD_INST11\"]/LN0/Inputs/" +
                     "ExtRef[@desc=\"ExtRef is ServiceType Poll\"]",
-                "The signal ExtRef ServiceType attribute is unexpected : POLL")
+                "The signal ExtRef ServiceType attribute is unexpected : POLL"),
+            SclReportItem.fatal("/SCL/IED[@name=\"IED_NAME1\"]/AccessPoint/Server/LDevice[@inst=\"LD_INST11\"]/LN0/Inputs/" +
+                    "ExtRef[@desc=\"ExtRef is ServiceType Report with malformed desc attribute\"]",
+                "ExtRef.serviceType=Report but ExtRef.desc attribute is malformed")
         );
     }
 
diff --git a/sct-commons/src/test/java/org/lfenergy/compas/sct/commons/util/UtilsTest.java b/sct-commons/src/test/java/org/lfenergy/compas/sct/commons/util/UtilsTest.java
@@ -200,26 +200,6 @@ void equalsOrBothBlank_should_be_true(String s1, String s2) {
         assertThat(result).isTrue();
     }
 
-    @ParameterizedTest
-    @MethodSource("provideEqualsOrBothBlankNotMatchingSource")
-    void equalsOrBothBlank_should_be_false(String s1, String s2) {
-        // Given : parameters
-        // When
-        boolean result = Utils.equalsOrBothBlank(s1, s2);
-        // Then
-        assertThat(result).isFalse();
-    }
-
-    @ParameterizedTest
-    @MethodSource("provideRemoveTrailingDigitsSource")
-    void removeTrailingDigits_should_remove_trailing_digits(String input, String expected) {
-        // Given : parameter
-        // When
-        String result = Utils.removeTrailingDigits(input);
-        // Then
-        assertThat(result).isEqualTo(expected);
-    }
-
     public static Stream<Arguments> provideEqualsOrBothBlankMatchingSource() {
         return Stream.of(
             Arguments.of("a", "a"),
@@ -235,6 +215,16 @@ public static Stream<Arguments> provideEqualsOrBothBlankMatchingSource() {
         );
     }
 
+    @ParameterizedTest
+    @MethodSource("provideEqualsOrBothBlankNotMatchingSource")
+    void equalsOrBothBlank_should_be_false(String s1, String s2) {
+        // Given : parameters
+        // When
+        boolean result = Utils.equalsOrBothBlank(s1, s2);
+        // Then
+        assertThat(result).isFalse();
+    }
+
     public static Stream<Arguments> provideEqualsOrBothBlankNotMatchingSource() {
         return Stream.of(
             Arguments.of("a", "b"),
@@ -247,6 +237,16 @@ public static Stream<Arguments> provideEqualsOrBothBlankNotMatchingSource() {
         );
     }
 
+    @ParameterizedTest
+    @MethodSource("provideRemoveTrailingDigitsSource")
+    void removeTrailingDigits_should_remove_trailing_digits(String input, String expected) {
+        // Given : parameter
+        // When
+        String result = Utils.removeTrailingDigits(input);
+        // Then
+        assertThat(result).isEqualTo(expected);
+    }
+
     public static Stream<Arguments> provideRemoveTrailingDigitsSource() {
         return Stream.of(
             Arguments.of("a", "a"),
@@ -258,4 +258,29 @@ public static Stream<Arguments> provideRemoveTrailingDigitsSource() {
             Arguments.of("1", ""),
             Arguments.of("123", ""));
     }
+
+    @ParameterizedTest
+    @MethodSource("provideExtractField")
+    void extractField_should(String s, int index, String expected) {
+        //Given : parameters
+        //When
+        String result = Utils.extractField(s, "_", index);
+        //Then
+        assertThat(result).isEqualTo(expected);
+    }
+
+    public static Stream<Arguments> provideExtractField() {
+        return Stream.of(
+            Arguments.of("a", 0, "a"),
+            Arguments.of("a", -1, "a"),
+            Arguments.of("a_b", 0, "a"),
+            Arguments.of("a_b", 1, "b"),
+            Arguments.of("a_b", -1, "b"),
+            Arguments.of("a_b", -2, "a"),
+            Arguments.of("a_b_c", -2, "b"),
+            Arguments.of("a", 1, null),
+            Arguments.of("a", -2, null),
+            Arguments.of("a_b_c", -4, null)
+        );
+    }
 }
diff --git a/sct-commons/src/test/resources/scd-extref-create-dataset-and-controlblocks/scd_create_dataset_and_controlblocks_extref_errors.xml b/sct-commons/src/test/resources/scd-extref-create-dataset-and-controlblocks/scd_create_dataset_and_controlblocks_extref_errors.xml
@@ -26,9 +26,11 @@
                             <Private type="COMPAS-Flow">
                                 <compas:Flow dataStreamKey="ExtRef is missing ServiceType attribute" FlowID="1" FlowKind="BAY_INTERNAL" ExtRefiedName="IED_NAME2" ExtReflnClass="ANCR" ExtRefldinst="LD_INST21" ExtReflnInst="1" ExtRefprefix="" FlowStatus="ACTIVE"/>
                                 <compas:Flow dataStreamKey="ExtRef is ServiceType Poll" FlowID="1" FlowKind="BAY_INTERNAL" ExtRefiedName="IED_NAME2" ExtReflnClass="ANCR" ExtRefldinst="LD_INST21" ExtReflnInst="1" ExtRefprefix="" FlowStatus="ACTIVE"/>
+                                <compas:Flow dataStreamKey="ExtRef is ServiceType Report with malformed desc attribute" FlowID="1" FlowKind="BAY_INTERNAL" ExtRefiedName="IED_NAME2" ExtReflnClass="ANCR" ExtRefldinst="LD_INST21" ExtReflnInst="1" ExtRefprefix="" FlowStatus="ACTIVE"/>
                             </Private>
                             <ExtRef desc="ExtRef is missing ServiceType attribute" iedName="IED_NAME2" ldInst="LD_INST21" lnClass="ANCR" lnInst="1" doName="DoName1" daName="daName1" intAddr="INT_ADDR11" pDO="Do11.sdo11" pDA="da11.bda111.bda112.bda113"/>
                             <ExtRef desc="ExtRef is ServiceType Poll" serviceType="Poll" iedName="IED_NAME2" ldInst="LD_INST21" lnClass="ANCR" lnInst="1" doName="DoName1" daName="daName1" intAddr="INT_ADDR11" pDO="Do11.sdo11" pDA="da11.bda111.bda112.bda113"/>
+                            <ExtRef desc="ExtRef is ServiceType Report with malformed desc attribute" serviceType="Report" iedName="IED_NAME2" ldInst="LD_INST21" lnClass="ANCR" lnInst="1" doName="DoName1" daName="daName1" intAddr="INT_ADDR11" pDO="Do11.sdo11" pDA="da11.bda111.bda112.bda113"/>
                         </Inputs>
                     </LN0>
                 </LDevice>
diff --git a/sct-commons/src/test/resources/scd-extref-create-dataset-and-controlblocks/scd_create_dataset_and_controlblocks_success.xml b/sct-commons/src/test/resources/scd-extref-create-dataset-and-controlblocks/scd_create_dataset_and_controlblocks_success.xml
@@ -31,7 +31,7 @@
                                 <compas:Flow dataStreamKey="test daName BL" FlowID="1" FlowKind="BAY_INTERNAL" ExtRefiedName="IED_NAME2" ExtReflnClass="ANCR" ExtRefldinst="LD_INST21" ExtReflnInst="1" ExtRefprefix="" FlowStatus="ACTIVE"/>
                                 <compas:Flow dataStreamKey="test ServiceType is GOOSE, no daName and DO contains ST and MX, but only ST is FCDA candidate" FlowID="1" FlowKind="BAY_INTERNAL" ExtRefiedName="IED_NAME2" ExtReflnClass="ANCR" ExtRefldinst="LD_INST21" ExtReflnInst="1" ExtRefprefix="" FlowStatus="ACTIVE"/>
                                 <compas:Flow dataStreamKey="test ServiceType is SMV, no daName and DO contains ST and MX, but only ST is FCDA candidate" FlowID="1" FlowKind="BAY_INTERNAL" ExtRefiedName="IED_NAME2" ExtReflnClass="ANCR" ExtRefldinst="LD_INST21" ExtReflnInst="1" ExtRefprefix="" FlowStatus="ACTIVE"/>
-                                <compas:Flow dataStreamKey="test ServiceType is Report" FlowID="1" FlowKind="BAY_INTERNAL" ExtRefiedName="IED_NAME2" ExtReflnClass="ANCR" ExtRefldinst="LD_INST21" ExtReflnInst="1" ExtRefprefix="" FlowStatus="ACTIVE"/>
+                                <compas:Flow dataStreamKey="test ServiceType is Report_daReportST_1" FlowID="1" FlowKind="BAY_INTERNAL" ExtRefiedName="IED_NAME2" ExtReflnClass="ANCR" ExtRefldinst="LD_INST21" ExtReflnInst="1" ExtRefprefix="" FlowStatus="ACTIVE"/>
                                 <compas:Flow dataStreamKey="test no daName and doName with instance number" FlowID="1" FlowKind="BAY_INTERNAL" ExtRefiedName="IED_NAME2" ExtReflnClass="ANCR" ExtRefldinst="LD_INST21" ExtReflnInst="1" ExtRefprefix="" FlowStatus="ACTIVE"/>
                                 <compas:Flow dataStreamKey="test no daName and doName with instance number and SDO" FlowID="1" FlowKind="BAY_INTERNAL" ExtRefiedName="IED_NAME2" ExtReflnClass="ANCR" ExtRefldinst="LD_INST21" ExtReflnInst="1" ExtRefprefix="" FlowStatus="ACTIVE"/>
                                 <compas:Flow dataStreamKey="test ignore internal binding" FlowID="1" FlowKind="BAY_INTERNAL" ExtRefiedName="IED_NAME1" ExtReflnClass="ANCR" ExtRefldinst="LD_INST12" ExtReflnInst="1" ExtRefprefix="" FlowStatus="ACTIVE"/>
@@ -52,7 +52,7 @@
                             <!-- ServiceType = SMV should keep only FCDA candidates -->
                             <ExtRef desc="test ServiceType is SMV, no daName and DO contains ST and MX, but only ST is FCDA candidate" iedName="IED_NAME2" ldInst="LD_INST21" lnClass="ANCR" lnInst="1" doName="OtherDoName" serviceType="SMV" intAddr="INT_ADDR11" pDO="Do11.sdo11" pDA="da11.bda111.bda112.bda113"/>
                             <!-- ServiceType = Report -->
-                            <ExtRef desc="test ServiceType is Report" iedName="IED_NAME2" ldInst="LD_INST21" lnClass="ANCR" lnInst="1" doName="DoName" daName="daNameST" serviceType="Report" intAddr="INT_ADDR11" pDO="Do11.sdo11" pDA="da11.bda111.bda112.bda113"/>
+                            <ExtRef desc="test ServiceType is Report_daReportST_1" iedName="IED_NAME2" ldInst="LD_INST21" lnClass="ANCR" lnInst="1" doName="DoName" serviceType="Report" intAddr="INT_ADDR11" pDO="Do11.sdo11" pDA="da11.bda111.bda112.bda113"/>
                             <!-- doName with instance number => instance number should be ignored when checking FCDA Candidates -->
                             <ExtRef desc="test no daName and doName with instance number" iedName="IED_NAME2" ldInst="LD_INST21" lnClass="ANCR" lnInst="1" doName="DoWithInst1" serviceType="GOOSE" intAddr="INT_ADDR11" pDO="Do11.sdo11" pDA="da11.bda111.bda112.bda113"/>
                             <!-- doName with instance number and SDO => instance number should be ignored when checking FCDA Candidates -->
@@ -140,6 +140,7 @@
             <DA fc="ST" name="daNameST" bType="BOOLEAN"/>
             <DA fc="MX" name="daNameMX" bType="BOOLEAN"/>
             <DA fc="BL" name="daNameBL" bType="BOOLEAN"/>
+            <DA fc="ST" name="daReportST" bType="BOOLEAN"/>
         </DOType>
         <DOType cdc="ENC" id="Do2">
             <SDO name="subDo" type="Do1"/>
