Merge branch 'main' into add-limits-and-properties-in-line-attached

Signed-off-by: Etienne LESOT <etienne.lesot@rte-france.com>

Author: EtienneLt

src/main/java/org/gridsuite/modification/dto/ModificationInfos.java

@@ -119,6 +119,9 @@ public class ModificationInfos {
     @Builder.Default
     private Boolean activated = true;
 
+    @Schema(description = "User description")
+    private String description;
+
     @JsonIgnore
     public ReportNode createSubReportNode(ReportNode reportNode) {
         throw new UnsupportedOperationException("Method createSubReportNode must be implemented in subclass " + this.getClass().getSimpleName());

src/main/java/org/gridsuite/modification/modifications/LineCreation.java

@@ -76,11 +76,12 @@ public void apply(Network network, ReportNode subReportNode) {
 
     public static void addLimits(LineCreationInfos modificationInfos, ReportNode subReportNode, Line line) {
         // Set permanent and temporary current limits
-        ReportNode limitsReporter = subReportNode.newReportNode().withMessageTemplate("network.modification.limitsCreated").add();
+        ReportNode limitsReporter = null;
         List<OperationalLimitsGroupInfos> opLimitsGroupSide1 = ModificationUtils.getOperationalLimitsGroupsOnSide(modificationInfos.getOperationalLimitsGroups(), Applicability.SIDE1);
         List<OperationalLimitsGroupInfos> opLimitsGroupSide2 = ModificationUtils.getOperationalLimitsGroupsOnSide(modificationInfos.getOperationalLimitsGroups(), Applicability.SIDE2);
-        ReportNode reportNode = null;
+        ReportNode reportNode;
         if (!CollectionUtils.isEmpty(modificationInfos.getOperationalLimitsGroups())) {
+            limitsReporter = subReportNode.newReportNode().withMessageTemplate("network.modification.limitsCreated").add();
             reportNode = addLimitSetReportNode(limitsReporter);
 
             for (OperationalLimitsGroupInfos olgInfos : modificationInfos.getOperationalLimitsGroups()) {
@@ -134,6 +135,9 @@ public static void addLimits(LineCreationInfos modificationInfos, ReportNode sub
         }
 
         if (!limitSetsOnSideReportNodes.isEmpty()) {
+            if (limitsReporter == null) {
+                limitsReporter = subReportNode.newReportNode().withMessageTemplate("network.modification.limitsCreated").add();
+            }
             ModificationUtils.getInstance().reportModifications(limitsReporter, limitSetsOnSideReportNodes,
                     "network.modification.ActiveLimitSets");
         }

src/main/java/org/gridsuite/modification/modifications/TwoWindingsTransformerCreation.java

@@ -255,12 +255,13 @@ private void completeTwoWindingsTransformerCreation(Network network,
         PropertiesUtils.applyProperties(twoWindingsTransformer, characteristicsReporter, modificationInfos.getProperties(), "network.modification.TwoWindingsTransformerProperties");
 
         // Set permanent and temporary current limits
-        ReportNode limitsReporter = subReportNode.newReportNode().withMessageTemplate("network.modification.limitsCreated").add();
+        ReportNode limitsReporter = null;
         List<OperationalLimitsGroupInfos> operationalLimitsGroups1 = ModificationUtils.getOperationalLimitsGroupsOnSide(modificationInfos.getOperationalLimitsGroups(), SIDE1);
         List<OperationalLimitsGroupInfos> operationalLimitsGroups2 = ModificationUtils.getOperationalLimitsGroupsOnSide(modificationInfos.getOperationalLimitsGroups(), SIDE2);
 
         List<ReportNode> limitSetsOnSideReportNodes = new ArrayList<>();
         if (!CollectionUtils.isEmpty(modificationInfos.getOperationalLimitsGroups())) {
+            limitsReporter = subReportNode.newReportNode().withMessageTemplate("network.modification.limitsCreated").add();
             ReportNode reportNode = limitsReporter.newReportNode()
                     .withSeverity(TypedValue.INFO_SEVERITY)
                     .withMessageTemplate("network.modification.LimitSets")
@@ -316,6 +317,9 @@ private void completeTwoWindingsTransformerCreation(Network network,
         }
 
         if (!limitSetsOnSideReportNodes.isEmpty()) {
+            if (limitsReporter == null) {
+                limitsReporter = subReportNode.newReportNode().withMessageTemplate("network.modification.limitsCreated").add();
+            }
             ModificationUtils.getInstance().reportModifications(limitsReporter, limitSetsOnSideReportNodes,
                 "network.modification.ActiveLimitSets");
         }

src/main/java/org/gridsuite/modification/modifications/olg/OperationalLimitsGroupsModification.java

@@ -9,9 +9,11 @@
 import com.powsybl.commons.report.ReportNode;
 import com.powsybl.commons.report.TypedValue;
 import com.powsybl.iidm.network.*;
+import jakarta.validation.constraints.NotNull;
 import org.gridsuite.modification.dto.*;
 
 import java.util.*;
+import java.util.stream.Stream;
 
 import static org.gridsuite.modification.dto.OperationalLimitsGroupInfos.Applicability.*;
 import static org.gridsuite.modification.dto.OperationalLimitsGroupInfos.Applicability.EQUIPMENT;
@@ -42,8 +44,7 @@ public void modifyOperationalLimitsGroups(OperationalLimitsGroupsModificationTyp
         if (operationalLimitsGroupsModificationType == OperationalLimitsGroupsModificationType.REPLACE) {
             // because we are replacing all the limit sets we remove all the limit sets that are not specified in the network modification
             // the others may be modified instead of recreated so it is better to not delete them in order to have more precise logs
-            deleteOlgsUnspecifiedInTheModification(SIDE1);
-            deleteOlgsUnspecifiedInTheModification(SIDE2);
+            deleteOlgsUnspecifiedInTheModification();
         }
 
         for (OperationalLimitsGroupModificationInfos opLGModifInfos : olgModificationInfos) {
@@ -65,36 +66,49 @@ public void modifyOperationalLimitsGroups(OperationalLimitsGroupsModificationTyp
         }
     }
 
-    private void deleteOlgsUnspecifiedInTheModification(OperationalLimitsGroupInfos.Applicability applicability) {
-        List<String> olgToBeDeleted = new ArrayList<>();
-        Collection<OperationalLimitsGroup> operationalLimitsGroups = applicability == SIDE1 ?
-                modifiedBranch.getOperationalLimitsGroups1() :
-                modifiedBranch.getOperationalLimitsGroups2();
-        operationalLimitsGroups.stream().filter(
-                operationalLimitsGroup ->
-                        olgModificationInfos.stream().noneMatch(
-                                operationalLimitsGroupModificationInfos ->
-                                        // we don't want to remove the limit sets specified in the network modification (operationalLimitsGroups) :
-                                        Objects.equals(operationalLimitsGroupModificationInfos.getId(), operationalLimitsGroup.getId())
-                                                && (operationalLimitsGroupModificationInfos.getApplicability() == applicability
-                                                || operationalLimitsGroupModificationInfos.getApplicability() == EQUIPMENT)
-                        )
-        ).forEach(operationalLimitsGroup -> olgToBeDeleted.add(operationalLimitsGroup.getId()));
+    private void deleteOlgsUnspecifiedInTheModification() {
+        Map<String, OperationalLimitsGroupInfos.Applicability> olgsToBeDeleted = new HashMap<>();
+
+        // get the deletions on side 1
+        getDeletableOperationalLimitsGroupStream(modifiedBranch.getOperationalLimitsGroups1(), SIDE1)
+                .forEach(operationalLimitsGroup -> olgsToBeDeleted.put(operationalLimitsGroup.getId(), SIDE1));
+
+        // then get the deletions on side 2. And if there is already a deletion on side 1, change it to EQUIPMENT
+        getDeletableOperationalLimitsGroupStream(modifiedBranch.getOperationalLimitsGroups2(), SIDE2)
+                .forEach(operationalLimitsGroup -> {
+                    if (olgsToBeDeleted.containsKey(operationalLimitsGroup.getId())) {
+                        olgsToBeDeleted.put(operationalLimitsGroup.getId(), EQUIPMENT);
+                    } else {
+                        olgsToBeDeleted.put(operationalLimitsGroup.getId(), SIDE2);
+                    }
+                });
 
-        Iterator<String> i = olgToBeDeleted.iterator();
-        while (i.hasNext()) {
-            String s = i.next();
+        for (Map.Entry<String, OperationalLimitsGroupInfos.Applicability> deletedOlg : olgsToBeDeleted.entrySet()) {
             new OperationalLimitsGroupModification(
                     modifiedBranch,
                     OperationalLimitsGroupModificationInfos.builder()
-                            .id(s)
-                            .applicability(applicability)
+                            .id(deletedOlg.getKey())
+                            .applicability(deletedOlg.getValue())
                             .build(),
                     olgsReportNode
             ).removeOlg();
         }
     }
 
+    @NotNull
+    private Stream<OperationalLimitsGroup> getDeletableOperationalLimitsGroupStream(Collection<OperationalLimitsGroup> modifiedOlgs, OperationalLimitsGroupInfos.Applicability side) {
+        return modifiedOlgs.stream().filter(
+                operationalLimitsGroup ->
+                        olgModificationInfos.stream().noneMatch(
+                                operationalLimitsGroupModificationInfos ->
+                                        // we don't want to remove the limit sets specified in the network modification (operationalLimitsGroups) :
+                                        Objects.equals(operationalLimitsGroupModificationInfos.getId(), operationalLimitsGroup.getId())
+                                                && (operationalLimitsGroupModificationInfos.getApplicability() == side
+                                                || operationalLimitsGroupModificationInfos.getApplicability() == EQUIPMENT)
+                        )
+        );
+    }
+
     private void logApplicabilityChange(List<ReportNode> olgReports, String groupId, OperationalLimitsGroupInfos.Applicability applicability) {
         olgReports.add(ReportNode.newRootReportNode().withMessageTemplate("network.modification.applicabilityChanged")
                 .withUntypedValue(OPERATIONAL_LIMITS_GROUP_NAME, groupId)

src/test/java/org/gridsuite/modification/modifications/TwoWindingsTransformerCreationNodeBreakerTest.java

@@ -184,7 +184,7 @@ protected void assertAfterNetworkModificationApplication() {
     }
 
     @Test
-    void testCreateTwoWindingsTransformerWithRatioTapChangerInNodeBreaker() throws Exception {
+    void testCreateTwoWindingsTransformerWithRatioTapChangerInNodeBreaker() {
         // create new 2wt in voltage level with Node/breaker topology, having a RatioTapChanger
         RatioTapChangerCreationInfos ratioTapChangerCreationInfos = RatioTapChangerCreationInfos.builder()
                 .lowTapPosition(0)
@@ -223,6 +223,7 @@ void testCreateTwoWindingsTransformerWithRatioTapChangerInNodeBreaker() throws E
         TwoWindingsTransformerCreationInfos twoWindingsTransformerCreationInfos2 = TwoWindingsTransformerCreationInfos.builder()
                 .equipmentId("id2wt1WithRatioTapChanger2")
                 .equipmentName("2wtName")
+                .description("a dummy description")
                 .voltageLevelId1("v1")
                 .busOrBusbarSectionId1("1.1")
                 .connected1(true)
@@ -241,7 +242,7 @@ void testCreateTwoWindingsTransformerWithRatioTapChangerInNodeBreaker() throws E
                 .build();
         testCreateTwoWindingsTransformerInNodeBreaker(twoWindingsTransformerCreationInfos2);
         assertEquals(
-            "TwoWindingsTransformerCreationInfos(super=BranchCreationInfos(super=EquipmentCreationInfos(super=EquipmentModificationInfos(super=ModificationInfos(uuid=null, type=TWO_WINDINGS_TRANSFORMER_CREATION, date=null, stashed=false, messageType=null, messageValues=null, activated=true), equipmentId=id2wt1WithRatioTapChanger2, properties=null), equipmentName=2wtName), r=400.0, x=300.0, voltageLevelId1=v1, voltageLevelId2=v4, busOrBusbarSectionId1=1.1, busOrBusbarSectionId2=1.A, operationalLimitsGroups=null, selectedOperationalLimitsGroupId1=null, selectedOperationalLimitsGroupId2=null, connectionName1=null, connectionDirection1=TOP, connectionName2=null, connectionDirection2=TOP, connectionPosition1=null, connectionPosition2=null, connected1=true, connected2=true), g=100.0, b=200.0, ratedU1=1000.0, ratedU2=1010.0, ratedS=null, ratioTapChanger=RatioTapChangerCreationInfos(super=TapChangerCreationInfos(lowTapPosition=0, tapPosition=1, regulating=true, targetDeadband=null, terminalRefConnectableId=v1load, terminalRefConnectableType=LOAD, terminalRefConnectableVlId=v1, steps=[TapChangerStepCreationInfos(index=0, rho=1.0, r=39.78473, x=39.784725, g=0.0, b=0.0, alpha=0.0), TapChangerStepCreationInfos(index=0, rho=1.0, r=39.78474, x=39.784726, g=0.0, b=0.0, alpha=0.0), TapChangerStepCreationInfos(index=0, rho=1.0, r=39.78475, x=39.784727, g=0.0, b=0.0, alpha=0.0)], loadTapChangingCapabilities=true), targetV=220.0), phaseTapChanger=null)",
+            "TwoWindingsTransformerCreationInfos(super=BranchCreationInfos(super=EquipmentCreationInfos(super=EquipmentModificationInfos(super=ModificationInfos(uuid=null, type=TWO_WINDINGS_TRANSFORMER_CREATION, date=null, stashed=false, messageType=null, messageValues=null, activated=true, description=a dummy description), equipmentId=id2wt1WithRatioTapChanger2, properties=null), equipmentName=2wtName), r=400.0, x=300.0, voltageLevelId1=v1, voltageLevelId2=v4, busOrBusbarSectionId1=1.1, busOrBusbarSectionId2=1.A, operationalLimitsGroups=null, selectedOperationalLimitsGroupId1=null, selectedOperationalLimitsGroupId2=null, connectionName1=null, connectionDirection1=TOP, connectionName2=null, connectionDirection2=TOP, connectionPosition1=null, connectionPosition2=null, connected1=true, connected2=true), g=100.0, b=200.0, ratedU1=1000.0, ratedU2=1010.0, ratedS=null, ratioTapChanger=RatioTapChangerCreationInfos(super=TapChangerCreationInfos(lowTapPosition=0, tapPosition=1, regulating=true, targetDeadband=null, terminalRefConnectableId=v1load, terminalRefConnectableType=LOAD, terminalRefConnectableVlId=v1, steps=[TapChangerStepCreationInfos(index=0, rho=1.0, r=39.78473, x=39.784725, g=0.0, b=0.0, alpha=0.0), TapChangerStepCreationInfos(index=0, rho=1.0, r=39.78474, x=39.784726, g=0.0, b=0.0, alpha=0.0), TapChangerStepCreationInfos(index=0, rho=1.0, r=39.78475, x=39.784727, g=0.0, b=0.0, alpha=0.0)], loadTapChangingCapabilities=true), targetV=220.0), phaseTapChanger=null)",
             twoWindingsTransformerCreationInfos2.toString()
         );
 
@@ -291,7 +292,7 @@ void testApplySelectedLimitsGroupsNotExist() {
     }
 
     @Test
-    void testCreateTwoWindingsTransformerWithPhaseTapChangerInNodeBreaker() throws Exception {
+    void testCreateTwoWindingsTransformerWithPhaseTapChangerInNodeBreaker() {
         // create new 2wt in voltage level with Node/breaker topology, having a PhaseTapChanger with Load regulating
         PhaseTapChangerCreationInfos phaseTapChangerLoadRegulatingCreationInfos = PhaseTapChangerCreationInfos.builder()
                 .lowTapPosition(0)
@@ -410,7 +411,7 @@ protected void checkModification() {
         assertEquals("TWO_WINDINGS_TRANSFORMER_ALREADY_EXISTS : trf1", exception.getMessage());
     }
 
-    private void testCreateTwoWindingsTransformerInNodeBreaker(TwoWindingsTransformerCreationInfos twoWindingsTransformerCreationInfos) throws Exception {
+    private void testCreateTwoWindingsTransformerInNodeBreaker(TwoWindingsTransformerCreationInfos twoWindingsTransformerCreationInfos) {
         final String transformerId = twoWindingsTransformerCreationInfos.getEquipmentId();
         twoWindingsTransformerCreationInfos.toModification().apply(getNetwork());
         TwoWindingsTransformer twoWindingsTransformer = getNetwork().getTwoWindingsTransformer(transformerId);