Merge pull request #546 from com-pas/develop

ecoquilleau · web-flow · commit 6e6bab36c68e · 2025-10-10T10:46:56.000+02:00
Release 0.2.47
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -0,0 +1,7 @@
+# SPDX-FileCopyrightText: 2025 RTE FRANCE
+#
+# SPDX-License-Identifier: Apache-2.0
+
+# All members of the @com-pas/rte team are code owners for this repository
+
+*   @com-pas/rte
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,9 @@
+<!--
+SPDX-FileCopyrightText: 2025 RTE FRANCE
+
+SPDX-License-Identifier: Apache-2.0
+-->
+
+# Code of Conduct
+
+This project follows the CoMPAS Code of Conduct. Please see the [Code of Conduct documentation](https://com-pas.github.io/contributing/#code-of-conduct) for details on our community standards and expectations.
diff --git a/GOVERNANCE.md b/GOVERNANCE.md
@@ -0,0 +1,9 @@
+<!--
+SPDX-FileCopyrightText: 2025 RTE FRANCE
+
+SPDX-License-Identifier: Apache-2.0
+-->
+
+# Governance
+
+This project follows the CoMPAS governance model. See the [governance documentation](https://com-pas.github.io/contributing/GOVERNANCE.html) for details.
diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 <!--
-SPDX-FileCopyrightText: 2021 Alliander N.V.
+SPDX-FileCopyrightText: 2025 RTE FRANCE
 
 SPDX-License-Identifier: Apache-2.0
 -->
diff --git a/SUPPORT.md b/SUPPORT.md
@@ -0,0 +1,9 @@
+<!--
+SPDX-FileCopyrightText: 2025 RTE FRANCE
+
+SPDX-License-Identifier: Apache-2.0
+-->
+
+# Support
+
+For support and help, see the [CoMPAS contributing guide](https://com-pas.github.io/contributing/SUPPORT.html).
diff --git a/sct-commons/src/main/java/org/lfenergy/compas/sct/commons/BayService.java b/sct-commons/src/main/java/org/lfenergy/compas/sct/commons/BayService.java
@@ -0,0 +1,40 @@
+// SPDX-FileCopyrightText: 2023 2024 RTE FRANCE
+//
+// SPDX-License-Identifier: Apache-2.0
+
+package org.lfenergy.compas.sct.commons;
+
+import lombok.extern.slf4j.Slf4j;
+import org.lfenergy.compas.scl2007b4.model.SCL;
+import org.lfenergy.compas.scl2007b4.model.TBay;
+import org.lfenergy.compas.scl2007b4.model.TSubstation;
+
+import java.util.Optional;
+import java.util.function.Predicate;
+import java.util.stream.Stream;
+
+@Slf4j
+public class BayService {
+
+    public Stream<TBay> getBays(SCL scl) {
+        return scl.getSubstation().stream().flatMap(this::getBays);
+    }
+
+    public Stream<TBay> getBays(TSubstation tSubstation) {
+        return tSubstation.getVoltageLevel().stream()
+                .flatMap(tVoltageLevel -> tVoltageLevel.getBay().stream());
+    }
+
+    public Stream<TBay> getFilteredBays(TSubstation tSubstation, Predicate<TBay> bayPredicate) {
+        return getBays(tSubstation).filter(bayPredicate);
+    }
+
+    public Optional<TBay> findBay(TSubstation tSubstation, Predicate<TBay> bayPredicate) {
+        return getFilteredBays(tSubstation, bayPredicate).findFirst();
+    }
+
+    public Optional<TBay> findBay(TSubstation tSubstation, String bayName) {
+        return findBay(tSubstation, bay -> bay.getName().equals(bayName));
+    }
+
+}
diff --git a/sct-commons/src/main/java/org/lfenergy/compas/sct/commons/ExtRefEditorService.java b/sct-commons/src/main/java/org/lfenergy/compas/sct/commons/ExtRefEditorService.java
diff --git a/sct-commons/src/main/java/org/lfenergy/compas/sct/commons/LNodeService.java b/sct-commons/src/main/java/org/lfenergy/compas/sct/commons/LNodeService.java
@@ -0,0 +1,47 @@
+// SPDX-FileCopyrightText: 2023 2024 RTE FRANCE
+//
+// SPDX-License-Identifier: Apache-2.0
+
+package org.lfenergy.compas.sct.commons;
+
+import lombok.extern.slf4j.Slf4j;
+import org.apache.commons.lang3.StringUtils;
+import org.lfenergy.compas.scl2007b4.model.*;
+
+import java.util.Optional;
+import java.util.function.Predicate;
+import java.util.stream.Stream;
+
+@Slf4j
+public class LNodeService {
+
+    public Stream<TLNode> getLNodes(TBay tBay) {
+        return tBay.getFunction().stream()
+                .flatMap(tFunction -> tFunction.getLNode().stream());
+    }
+
+    public Stream<TLNode> getFilteredLNodes(TBay tBay, Predicate<TLNode> tlNodePredicate) {
+        return getLNodes(tBay).filter(tlNodePredicate);
+    }
+
+    public Optional<TLNode> findLNode(TBay tBay, Predicate<TLNode> tlNodePredicate) {
+        return getFilteredLNodes(tBay, tlNodePredicate).findFirst();
+    }
+
+    public boolean matchesLnode(TLNode tlNode, String iedName, String ldInst, TAnyLN tAnyLN) {
+        return switch (tAnyLN) {
+            case TLN ln -> matchesLnode(tlNode, iedName, ldInst, ln.getLnClass().isEmpty() ? "" : ln.getLnClass().getFirst(), ln.getInst(), ln.getPrefix());
+            case LN0 ln0 -> matchesLnode(tlNode, iedName, ldInst, TLLN0Enum.LLN_0.value(), ln0.getInst(), "");
+            default -> throw new IllegalStateException("Unexpected value: " + tAnyLN);
+        };
+    }
+
+    public boolean matchesLnode(TLNode tlNode, String iedName, String ldInst, String lnClass, String lnInst, String lnPrefix) {
+        return tlNode.getIedName().equals(iedName)
+               && tlNode.getLdInst().equals(ldInst)
+               && tlNode.getLnClass().contains(lnClass)
+               && StringUtils.trimToEmpty(lnInst).equals(StringUtils.trimToEmpty(tlNode.getLnInst()))
+               && StringUtils.trimToEmpty(lnPrefix).equals(StringUtils.trimToEmpty(tlNode.getPrefix()));
+    }
+
+}
diff --git a/sct-commons/src/main/java/org/lfenergy/compas/sct/commons/LnService.java b/sct-commons/src/main/java/org/lfenergy/compas/sct/commons/LnService.java
@@ -26,7 +26,7 @@
 public class LnService implements LnEditor {
 
     private static final DoLinkedToDaFilter DAI_FILTER_MOD_STVAL = DoLinkedToDaFilter.from(MOD_DO_NAME, STVAL_DA_NAME);
-    private static final String LNODE_STATUS_PRIVATE_TYPE = "COMPAS-LNodeStatus";
+    public static final String LNODE_STATUS_PRIVATE_TYPE = "COMPAS-LNodeStatus";
 
     public Stream<TAnyLN> getAnylns(TLDevice tlDevice) {
         return Stream.concat(Stream.of(tlDevice.getLN0()), tlDevice.getLN().stream());
@@ -58,10 +58,10 @@ public Optional<TLN> findLn(TLDevice tlDevice, Predicate<TLN> lnPredicate) {
 
     public boolean matchesLn(TAnyLN tAnyLN, String lnClass, String lnInst, String lnPrefix) {
         return switch (tAnyLN) {
-            case TLN ln -> lnClass.equals(ln.getLnClass().getFirst())
+            case TLN ln -> ln.getLnClass().contains(lnClass)
                            && StringUtils.trimToEmpty(lnInst).equals(StringUtils.trimToEmpty(ln.getInst()))
                            && (StringUtils.trimToEmpty(lnPrefix).equals(StringUtils.trimToEmpty(ln.getPrefix())));
-            case LN0 ignored -> lnClass.equals(TLLN0Enum.LLN_0.value());
+            case LN0 ignored -> TLLN0Enum.LLN_0.value().equals(lnClass);
             default -> throw new IllegalStateException("Unexpected value: " + tAnyLN);
         };
     }
diff --git a/sct-commons/src/main/java/org/lfenergy/compas/sct/commons/scl/ln/AbstractLNAdapter.java b/sct-commons/src/main/java/org/lfenergy/compas/sct/commons/scl/ln/AbstractLNAdapter.java
@@ -293,7 +293,7 @@ protected void updateExtRefBindingInfo(TExtRef extRef, ExtRefInfo extRefInfo) {
                 extRef.setDoName(bindingInfo.getDoName().toString());
             }
 
-            extRef.setPrefix(bindingInfo.getPrefix());
+            extRef.setPrefix(StringUtils.trimToNull(bindingInfo.getPrefix()));
             // invalid source info
             removeExtRefSourceBinding(extRef);
             isSrcReset = true;
@@ -306,7 +306,7 @@ protected void updateExtRefBindingInfo(TExtRef extRef, ExtRefInfo extRefInfo) {
                 extRef.getSrcLNClass().add(sourceInfo.getSrcLNClass());
             }
             extRef.setSrcLDInst(sourceInfo.getSrcLDInst());
-            extRef.setSrcPrefix(sourceInfo.getSrcPrefix());
+            extRef.setSrcPrefix(StringUtils.trimToNull(sourceInfo.getSrcPrefix()));
             extRef.setSrcCBName(sourceInfo.getSrcCBName());
         }
     }
diff --git a/sct-commons/src/main/java/org/lfenergy/compas/sct/commons/scl/sstation/LNodeAdapter.java b/sct-commons/src/main/java/org/lfenergy/compas/sct/commons/scl/sstation/LNodeAdapter.java
@@ -4,6 +4,7 @@
 
 package org.lfenergy.compas.sct.commons.scl.sstation;
 
+import org.apache.commons.lang3.StringUtils;
 import org.lfenergy.compas.scl2007b4.model.TFunction;
 import org.lfenergy.compas.scl2007b4.model.TLNode;
 import org.lfenergy.compas.scl2007b4.model.TText;
@@ -65,7 +66,7 @@ public TLNode deepCopy() {
         newLNode.setLdInst(currentElem.getLdInst());
         newLNode.setLnInst(currentElem.getLnInst());
         newLNode.setLnType(currentElem.getLnType());
-        newLNode.setPrefix(currentElem.getPrefix());
+        newLNode.setPrefix(StringUtils.trimToNull(currentElem.getPrefix())); // trimToNull is important because getPrefix() returns "" if null
         if (currentElem.isSetText()) {
             TText newText = new TText();
             newText.setSource(currentElem.getText().getSource());
diff --git a/sct-commons/src/main/java/org/lfenergy/compas/sct/commons/util/SclConstructorHelper.java b/sct-commons/src/main/java/org/lfenergy/compas/sct/commons/util/SclConstructorHelper.java
@@ -139,7 +139,7 @@ public static TFCDA newFcda(String ldInst, String lnClass, String lnInst, String
         tfcda.setLdInst(ldInst);
         if (StringUtils.isNotBlank(lnClass)) tfcda.getLnClass().add(lnClass);
         tfcda.setLnInst(lnInst);
-        tfcda.setPrefix(prefix);
+        tfcda.setPrefix(StringUtils.trimToNull(prefix));
         tfcda.setDoName(doName);
         tfcda.setDaName(daName);
         tfcda.setFc(fc);
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
@@ -347,8 +347,8 @@ public static TLN copyLn(TLN tln) {
         newLn.getLnClass().addAll(tln.getLnClass());
         newLn.setInst(tln.getInst());
         newLn.setLnType(tln.getLnType());
-        newLn.setPrefix(tln.getPrefix());
-        newLn.setDesc(tln.getDesc());
+        newLn.setPrefix(StringUtils.trimToNull(tln.getPrefix())); // trimToNull is important because getPrefix returns "" if null
+        newLn.setDesc(StringUtils.trimToNull(tln.getDesc())); // trimToNull is important because getDesc returns "" if null
         newLn.setInputs(tln.getInputs());
         newLn.setText(tln.getText());
         newLn.getPrivate().addAll(tln.getPrivate());
diff --git a/sct-commons/src/main/resources/xsd/LDEPF.xsd b/sct-commons/src/main/resources/xsd/LDEPF.xsd
@@ -60,6 +60,7 @@ SPDX-License-Identifier: Apache-2.0
 		<xs:attribute name="IEDSystemVersionInstance" type="xs:string" use="optional"/>
 		<xs:attribute name="IEDRedundancy" type="tIEDredundancy" use="optional"/>
 		<xs:attribute name="ChannelShortLabel" type="xs:string" use="optional"/>
+		<xs:attribute name="ChannelShortLabelQ" type="xs:string" use="optional"/>
 		<xs:attribute name="ChannelMREP" type="tChannelMREP" use="optional"/>
 		<xs:attribute name="ChannelLevModQ" type="tChannelLevMod" use="optional"/>
 		<xs:attribute name="ChannelLevMod" type="tChannelLevMod" use="optional"/>
diff --git a/sct-commons/src/test/java/org/lfenergy/compas/sct/commons/BayServiceTest.java b/sct-commons/src/test/java/org/lfenergy/compas/sct/commons/BayServiceTest.java
@@ -0,0 +1,125 @@
+// SPDX-FileCopyrightText: 2025 RTE FRANCE
+//
+// SPDX-License-Identifier: Apache-2.0
+
+package org.lfenergy.compas.sct.commons;
+
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.lfenergy.compas.scl2007b4.model.SCL;
+import org.lfenergy.compas.scl2007b4.model.TBay;
+import org.lfenergy.compas.scl2007b4.model.TSubstation;
+import org.lfenergy.compas.scl2007b4.model.TVoltageLevel;
+
+import java.util.Optional;
+import java.util.stream.Stream;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+class BayServiceTest {
+
+    private BayService bayService;
+
+    @BeforeEach
+    void setUp() {
+        bayService = new BayService();
+
+    }
+
+    @Test
+    void getBays_on_Scl_should_return_bays() {
+        // Given
+        SCL scl = new SCL();
+        TSubstation tSubstation = createSubstation();
+        scl.getSubstation().add(tSubstation);
+
+        // When
+        Stream<TBay> bays = bayService.getBays(scl);
+
+        // Then
+        assertThat(bays)
+                .extracting(TBay::getName)
+                .containsExactlyInAnyOrder("BayA", "BayB", "BayC");
+    }
+
+    @Test
+    void getBays_on_Substation_should_return_bays() {
+        // Given
+        TSubstation tSubstation = createSubstation();
+
+        // When
+        Stream<TBay> bays = bayService.getBays(tSubstation);
+
+        // Then
+        assertThat(bays)
+                .extracting(TBay::getName)
+                .containsExactlyInAnyOrder("BayA", "BayB", "BayC");
+    }
+
+    @Test
+    void getFilteredBays_should_succeed() {
+        // Given
+        TSubstation tSubstation = createSubstation();
+        // When
+        Stream<TBay> result = bayService.getFilteredBays(tSubstation, tBay -> tBay.getName().equals("BayA") || tBay.getName().equals("BayC"));
+        // Then
+        assertThat(result)
+                .extracting(TBay::getName)
+                .containsExactlyInAnyOrder("BayA", "BayC");
+    }
+
+    @Test
+    void findBay_by_predicate_should_succeed() {
+        // Given
+        TSubstation tSubstation = createSubstation();
+        // When
+        Optional<TBay> result = bayService.findBay(tSubstation, tBay -> tBay.getName().equals("BayA"));
+        // Then
+        assertThat(result)
+                .map(TBay::getName)
+                .hasValue("BayA");
+    }
+
+    @Test
+    void findBay_by_name_should_succeed() {
+        // Given
+        TSubstation tSubstation = createSubstation();
+        // When
+        Optional<TBay> result = bayService.findBay(tSubstation, "BayA");
+        // Then
+        assertThat(result)
+                .map(TBay::getName)
+                .hasValue("BayA");
+    }
+
+    @Test
+    void findBay_should_succeed() {
+        // Given
+        TSubstation tSubstation = createSubstation();
+        // When
+        Optional<TBay> result = bayService.findBay(tSubstation, "BayA");
+        // Then
+        assertThat(result)
+                .map(TBay::getName)
+                .hasValue("BayA");
+    }
+
+    private static TSubstation createSubstation() {
+        TSubstation tSubstation = new TSubstation();
+        TVoltageLevel tVoltageLevel1 = new TVoltageLevel();
+        tSubstation.getVoltageLevel().add(tVoltageLevel1);
+        tVoltageLevel1.getBay().add(createBay("BayA"));
+        tVoltageLevel1.getBay().add(createBay("BayB"));
+        TVoltageLevel tVoltagelevel2 = new TVoltageLevel();
+        tSubstation.getVoltageLevel().add(tVoltagelevel2);
+        tVoltagelevel2.getBay().add(createBay("BayC"));
+        return tSubstation;
+    }
+
+    private static TBay createBay(String name) {
+        TBay bay = new TBay();
+        bay.setName(name);
+        return bay;
+    }
+
+}
diff --git a/sct-commons/src/test/java/org/lfenergy/compas/sct/commons/ExtRefEditorServiceTest.java b/sct-commons/src/test/java/org/lfenergy/compas/sct/commons/ExtRefEditorServiceTest.java
diff --git a/sct-commons/src/test/java/org/lfenergy/compas/sct/commons/LNodeServiceTest.java b/sct-commons/src/test/java/org/lfenergy/compas/sct/commons/LNodeServiceTest.java

Original file line number	Diff line number	Diff line change
`@@ -293,7 +293,7 @@ protected void updateExtRefBindingInfo(TExtRef extRef, ExtRefInfo extRefInfo) {`
`293`	`293`	`extRef.setDoName(bindingInfo.getDoName().toString());`
`294`	`294`	`}`
`295`	`295`
`296`		`- extRef.setPrefix(bindingInfo.getPrefix());`
	`296`	`+ extRef.setPrefix(StringUtils.trimToNull(bindingInfo.getPrefix()));`
`297`	`297`	`// invalid source info`
`298`	`298`	`removeExtRefSourceBinding(extRef);`
`299`	`299`	`isSrcReset = true;`
`@@ -306,7 +306,7 @@ protected void updateExtRefBindingInfo(TExtRef extRef, ExtRefInfo extRefInfo) {`
`306`	`306`	`extRef.getSrcLNClass().add(sourceInfo.getSrcLNClass());`
`307`	`307`	`}`
`308`	`308`	`extRef.setSrcLDInst(sourceInfo.getSrcLDInst());`
`309`		`- extRef.setSrcPrefix(sourceInfo.getSrcPrefix());`
	`309`	`+ extRef.setSrcPrefix(StringUtils.trimToNull(sourceInfo.getSrcPrefix()));`
`310`	`310`	`extRef.setSrcCBName(sourceInfo.getSrcCBName());`
`311`	`311`	`}`
`312`	`312`	`}`