Generation dispatch logs on filters not found (#117)

FranckLecuyer · web-flow · commit e58812980c71 · 2025-11-04T11:01:02.000+01:00
* Log missing filters generation dispatch application

Signed-off-by: Franck LECUYER &lt;franck.lecuyer@rte-france.com&gt;
diff --git a/src/main/java/org/gridsuite/modification/modifications/GenerationDispatch.java b/src/main/java/org/gridsuite/modification/modifications/GenerationDispatch.java
@@ -16,6 +16,7 @@
 import lombok.Builder;
 import lombok.Getter;
 
+import org.gridsuite.filter.AbstractFilter;
 import org.gridsuite.modification.IFilterService;
 import org.gridsuite.modification.ILoadFlowService;
 import org.gridsuite.modification.NetworkModificationException;
@@ -450,8 +451,36 @@ private void reportDisconnectedGenerators(List<Generator> globalDisconnectedGene
         }
     }
 
+    private boolean checkMissingFilters(ReportNode subReportNode) {
+        Map<UUID, String> filterNamesByUuid = new LinkedHashMap<>();
+        generationDispatchInfos.getGeneratorsWithoutOutage().forEach(filterInfos -> filterNamesByUuid.put(filterInfos.getId(), filterInfos.getName()));
+        generationDispatchInfos.getGeneratorsWithFixedSupply().forEach(filterInfos -> filterNamesByUuid.put(filterInfos.getId(), filterInfos.getName()));
+        generationDispatchInfos.getGeneratorsFrequencyReserve().forEach(frequencyReserveInfos ->
+            frequencyReserveInfos.getGeneratorsFilters().forEach(filterInfos -> filterNamesByUuid.put(filterInfos.getId(), filterInfos.getName()))
+        );
+        if (!filterNamesByUuid.isEmpty()) {
+            List<AbstractFilter> filters = filterService.getFilters(new ArrayList<>(filterNamesByUuid.keySet()));
+            Set<UUID> validFilters = filters.stream().map(AbstractFilter::getId).collect(Collectors.toSet());
+            List<UUID> missingFilters = filterNamesByUuid.keySet().stream().filter(filterId -> !validFilters.contains(filterId)).toList();
+            if (!missingFilters.isEmpty()) {
+                report(subReportNode, "network.modification.missingFiltersInGenerationDispatch",
+                    Map.of("nb", missingFilters.size(), IS_PLURAL, missingFilters.size() > 1 ? "s" : ""),
+                    TypedValue.ERROR_SEVERITY);
+            }
+            return !missingFilters.isEmpty();
+        } else {
+            return false;
+        }
+    }
+
     @Override
     public void apply(Network network, ReportNode subReportNode) {
+        // check existence of all filters
+        boolean missingFilters = checkMissingFilters(subReportNode);
+        if (missingFilters) {
+            return;
+        }
+
         Collection<Component> synchronousComponents = network.getBusView().getBusStream()
             .filter(Bus::isInMainConnectedComponent)
             .map(Bus::getSynchronousComponent)
diff --git a/src/main/resources/org/gridsuite/modification/reports.properties b/src/main/resources/org/gridsuite/modification/reports.properties
@@ -341,3 +341,4 @@ network.modification.lcc.shuntCompensator.disconnected = Equipment with id=${id}
 network.modification.operationalLimitsGroup.creation = Creation of ${operationalLimitsGroupName}
 network.modification.operationalLimitsGroupPropertyValueNotFoundError = Cannot modify equipment ${id} : missing limit set applicable on side ${side} with property named ${propertyName} and with value ${propertyValue} : equipment ignored
 network.modification.operationalLimitsGroupPropertyValueMultipleError = Cannot modify equipment ${id} : multiple limit sets applicable on side ${side} with property named ${propertyName} and with value ${propertyValue} : equipment ignored
+network.modification.missingFiltersInGenerationDispatch = The modification points to at least ${nb} filter${isPlural} that does not exist anymore
diff --git a/src/test/java/org/gridsuite/modification/modifications/GenerationDispatchTest.java b/src/test/java/org/gridsuite/modification/modifications/GenerationDispatchTest.java
@@ -9,8 +9,11 @@
 import com.powsybl.commons.report.ReportNode;
 import com.powsybl.iidm.network.IdentifiableType;
 import com.powsybl.iidm.network.Network;
+import org.gridsuite.filter.AbstractFilter;
 import org.gridsuite.filter.identifierlistfilter.FilterEquipments;
 import org.gridsuite.filter.identifierlistfilter.IdentifiableAttributes;
+import org.gridsuite.filter.identifierlistfilter.IdentifierListFilter;
+import org.gridsuite.filter.utils.EquipmentType;
 import org.gridsuite.modification.IFilterService;
 import org.gridsuite.modification.NetworkModificationException;
 import org.gridsuite.modification.dto.*;
@@ -90,6 +93,15 @@ private void assertLogReportsForDefaultNetwork(double batteryBalanceOnSc2, Repor
         assertLogMessageWithoutRank("Sum of generator active power setpoints in SOUTH region: " + totalAmount + " MW (NUCLEAR: 0.0 MW, THERMAL: 0.0 MW, HYDRO: " + totalAmount + " MW, WIND AND SOLAR: 0.0 MW, OTHER: 0.0 MW).", "network.modification.SumGeneratorActivePower", report);
     }
 
+    @Override
+    @Test
+    public void testApply() throws Exception {
+        GenerationDispatch modif = (GenerationDispatch) buildModification().toModification();
+        modif.initApplicationContext(filterService, null);
+        modif.apply(getNetwork());
+        assertAfterNetworkModificationApplication();
+    }
+
     @Test
     void testGenerationDispatch() throws Exception {
         GenerationDispatchInfos modification = buildModification();
@@ -101,8 +113,9 @@ void testGenerationDispatch() throws Exception {
                 .withAllResourceBundlesFromClasspath()
                 .withMessageTemplate("test")
                 .build());
-
-        modification.toModification().apply(getNetwork(), report);
+        GenerationDispatch modif = (GenerationDispatch) modification.toModification();
+        modif.initApplicationContext(filterService, null);
+        modif.apply(getNetwork(), report);
         assertNetworkAfterCreationWithStandardLossCoefficient();
 
         assertLogReportsForDefaultNetwork(0., report);
@@ -123,7 +136,9 @@ void testGenerationDispatchWithBattery() throws Exception {
         ReportNode report = modification.createSubReportNode(ReportNode.newRootReportNode()
                 .withAllResourceBundlesFromClasspath()
                 .withMessageTemplate("test").build());
-        modification.toModification().apply(getNetwork(), report);
+        GenerationDispatch modif = (GenerationDispatch) modification.toModification();
+        modif.initApplicationContext(filterService, null);
+        modif.apply(getNetwork(), report);
         assertLogReportsForDefaultNetwork(batteryTotalTargetP, report);
     }
 
@@ -144,7 +159,9 @@ void testGenerationDispatchWithBatteryConnection() throws Exception {
         ReportNode report = modification.createSubReportNode(ReportNode.newRootReportNode()
                 .withAllResourceBundlesFromClasspath()
                 .withMessageTemplate("test").build());
-        modification.toModification().apply(getNetwork(), report);
+        GenerationDispatch modif = (GenerationDispatch) modification.toModification();
+        modif.initApplicationContext(filterService, null);
+        modif.apply(getNetwork(), report);
         assertLogReportsForDefaultNetwork(batteryTotalTargetP, report);
     }
 
@@ -157,7 +174,9 @@ void testGenerationDispatchWithMultipleEnergySource() throws Exception {
         ReportNode report = modification.createSubReportNode(ReportNode.newRootReportNode()
                 .withAllResourceBundlesFromClasspath()
                 .withMessageTemplate("test").build());
-        modification.toModification().apply(getNetwork(), report);
+        GenerationDispatch modif = (GenerationDispatch) modification.toModification();
+        modif.initApplicationContext(filterService, null);
+        modif.apply(getNetwork(), report);
 
         assertLogMessageWithoutRank("The total demand is : 768.0 MW", "network.modification.TotalDemand", report);
         assertLogMessageWithoutRank("The total amount of fixed supply is : 0.0 MW", "network.modification.TotalAmountFixedSupply", report);
@@ -179,7 +198,9 @@ void testGenerationDispatchWithHigherLossCoefficient() throws Exception {
         ReportNode report = modification.createSubReportNode(ReportNode.newRootReportNode()
                 .withAllResourceBundlesFromClasspath()
                 .withMessageTemplate("test").build());
-        modification.toModification().apply(getNetwork(), report);
+        GenerationDispatch modif = (GenerationDispatch) modification.toModification();
+        modif.initApplicationContext(filterService, null);
+        modif.apply(getNetwork(), report);
 
         assertEquals(100., getNetwork().getGenerator(GH1_ID).getTargetP(), 0.001);
         assertEquals(70., getNetwork().getGenerator(GH2_ID).getTargetP(), 0.001);
@@ -220,7 +241,9 @@ void testGenerationDispatchWithInternalHvdc() throws Exception {
         ReportNode report = modification.createSubReportNode(ReportNode.newRootReportNode()
                 .withAllResourceBundlesFromClasspath()
                 .withMessageTemplate("test").build());
-        modification.toModification().apply(getNetwork(), report);
+        GenerationDispatch modif = (GenerationDispatch) modification.toModification();
+        modif.initApplicationContext(filterService, null);
+        modif.apply(getNetwork(), report);
 
         assertEquals(100., getNetwork().getGenerator(GH1_ID).getTargetP(), 0.001);
         assertEquals(70., getNetwork().getGenerator(GH2_ID).getTargetP(), 0.001);
@@ -256,11 +279,18 @@ void testGenerationDispatchWithMaxPReduction() throws Exception {
         // network with 2 synchronous components, 2 hvdc lines between them, forcedOutageRate and plannedOutageRate defined for the generators
         setNetwork(Network.read("testGenerationDispatchReduceMaxP.xiidm", getClass().getResourceAsStream("/testGenerationDispatchReduceMaxP.xiidm")));
 
-        List<FilterEquipments> filters = List.of(new FilterEquipments(FILTER_ID_1, List.of(getIdentifiableAttributes(GTH2_ID), getIdentifiableAttributes(GROUP1_ID)), List.of()),
+        List<FilterEquipments> filterEquipments = List.of(new FilterEquipments(FILTER_ID_1, List.of(getIdentifiableAttributes(GTH2_ID), getIdentifiableAttributes(GROUP1_ID)), List.of()),
             new FilterEquipments(FILTER_ID_2, List.of(getIdentifiableAttributes(ABC_ID), getIdentifiableAttributes(GH3_ID)), List.of()),
             new FilterEquipments(FILTER_ID_3, List.of(), List.of(GEN1_NOT_FOUND_ID, GEN2_NOT_FOUND_ID)));
 
-        when(filterService.exportFilters(List.of(FILTER_ID_1, FILTER_ID_2, FILTER_ID_3), getNetwork())).thenReturn(filters.stream());
+        when(filterService.exportFilters(List.of(FILTER_ID_1, FILTER_ID_2, FILTER_ID_3), getNetwork())).thenReturn(filterEquipments.stream());
+
+        List<AbstractFilter> filters = List.of(
+            new IdentifierListFilter(FILTER_ID_1, new Date(), EquipmentType.GENERATOR, List.of()),
+            new IdentifierListFilter(FILTER_ID_2, new Date(), EquipmentType.GENERATOR, List.of()),
+            new IdentifierListFilter(FILTER_ID_3, new Date(), EquipmentType.GENERATOR, List.of()));
+        when(filterService.getFilters(List.of(FILTER_ID_1, FILTER_ID_2, FILTER_ID_3))).thenReturn(filters);
+
         GenerationDispatch modif = (GenerationDispatch) modification.toModification();
         modif.initApplicationContext(filterService, null);
         ReportNode report = modification.createSubReportNode(ReportNode.newRootReportNode()
@@ -323,6 +353,13 @@ void testGenerationDispatchGeneratorsWithFixedSupply() throws Exception {
             new FilterEquipments(FILTER_ID_4, List.of(getIdentifiableAttributes(TEST1_ID), getIdentifiableAttributes(GROUP2_ID)), List.of()));
         when(filterService.exportFilters(List.of(FILTER_ID_1, FILTER_ID_4), getNetwork())).thenReturn(filtersForFixedSupply.stream());
 
+        List<AbstractFilter> filters = List.of(
+            new IdentifierListFilter(FILTER_ID_1, new Date(), EquipmentType.GENERATOR, List.of()),
+            new IdentifierListFilter(FILTER_ID_2, new Date(), EquipmentType.GENERATOR, List.of()),
+            new IdentifierListFilter(FILTER_ID_3, new Date(), EquipmentType.GENERATOR, List.of()),
+            new IdentifierListFilter(FILTER_ID_4, new Date(), EquipmentType.GENERATOR, List.of()));
+        when(filterService.getFilters(List.of(FILTER_ID_1, FILTER_ID_2, FILTER_ID_3, FILTER_ID_4))).thenReturn(filters);
+
         GenerationDispatch modif = (GenerationDispatch) modification.toModification();
         modif.initApplicationContext(filterService, null);
         ReportNode report = modification.createSubReportNode(ReportNode.newRootReportNode()
@@ -413,6 +450,15 @@ void testGenerationDispatchWithFrequencyReserve() throws Exception {
         when(filterService.exportFilters(List.of(FILTER_ID_4, FILTER_ID_5), getNetwork())).thenReturn(filtersForFrequencyReserve.stream());
         when(filterService.exportFilters(List.of(FILTER_ID_6), getNetwork())).thenReturn(getGeneratorsFrequencyReserveFilter6().stream());
 
+        List<AbstractFilter> filters = List.of(
+            new IdentifierListFilter(FILTER_ID_1, new Date(), EquipmentType.GENERATOR, List.of()),
+            new IdentifierListFilter(FILTER_ID_2, new Date(), EquipmentType.GENERATOR, List.of()),
+            new IdentifierListFilter(FILTER_ID_3, new Date(), EquipmentType.GENERATOR, List.of()),
+            new IdentifierListFilter(FILTER_ID_4, new Date(), EquipmentType.GENERATOR, List.of()),
+            new IdentifierListFilter(FILTER_ID_5, new Date(), EquipmentType.GENERATOR, List.of()),
+            new IdentifierListFilter(FILTER_ID_6, new Date(), EquipmentType.GENERATOR, List.of()));
+        when(filterService.getFilters(List.of(FILTER_ID_1, FILTER_ID_2, FILTER_ID_3, FILTER_ID_4, FILTER_ID_5, FILTER_ID_6))).thenReturn(filters);
+
         GenerationDispatch modif = (GenerationDispatch) modification.toModification();
         modif.initApplicationContext(filterService, null);
         ReportNode report = modification.createSubReportNode(ReportNode.newRootReportNode()
@@ -463,8 +509,9 @@ void testGenerationDispatchWithSubstationsHierarchy() throws Exception {
 
         // network
         setNetwork(Network.read("ieee118cdf_testDemGroupe.xiidm", getClass().getResourceAsStream("/ieee118cdf_testDemGroupe.xiidm")));
-
-        modification.toModification().apply(getNetwork());
+        GenerationDispatch modif = (GenerationDispatch) modification.toModification();
+        modif.initApplicationContext(filterService, null);
+        modif.apply(getNetwork());
 
         // generators modified
         assertEquals(264, getNetwork().getGenerator("B4-G").getTargetP(), 0.001);
@@ -557,9 +604,11 @@ void testGenerationDispatchWithSubstationsHierarchyAndFixedSupply() {
         );
         when(filterService.exportFilters(List.of(FILTER_ID_1), getNetwork())).thenReturn(filtersForFixedSupply.stream());
 
+        List<AbstractFilter> filters = List.of(new IdentifierListFilter(FILTER_ID_1, new Date(), EquipmentType.GENERATOR, List.of()));
+        when(filterService.getFilters(List.of(FILTER_ID_1))).thenReturn(filters);
+
         GenerationDispatch modif = (GenerationDispatch) modification.toModification();
         modif.initApplicationContext(filterService, null);
-
         modif.apply(getNetwork());
 
         // Check expected target active power values
@@ -628,6 +677,15 @@ void testGenerationDispatchWithMaxValueLessThanMinP() throws Exception {
         when(filterService.exportFilters(List.of(FILTER_ID_4, FILTER_ID_5), getNetwork())).thenReturn(getGeneratorsFrequencyReserveFilters45().stream());
         when(filterService.exportFilters(List.of(FILTER_ID_6), getNetwork())).thenReturn(getGeneratorsFrequencyReserveFilter6().stream());
 
+        List<AbstractFilter> filters = List.of(
+            new IdentifierListFilter(FILTER_ID_1, new Date(), EquipmentType.GENERATOR, List.of()),
+            new IdentifierListFilter(FILTER_ID_2, new Date(), EquipmentType.GENERATOR, List.of()),
+            new IdentifierListFilter(FILTER_ID_3, new Date(), EquipmentType.GENERATOR, List.of()),
+            new IdentifierListFilter(FILTER_ID_4, new Date(), EquipmentType.GENERATOR, List.of()),
+            new IdentifierListFilter(FILTER_ID_5, new Date(), EquipmentType.GENERATOR, List.of()),
+            new IdentifierListFilter(FILTER_ID_6, new Date(), EquipmentType.GENERATOR, List.of()));
+        when(filterService.getFilters(List.of(FILTER_ID_1, FILTER_ID_2, FILTER_ID_3, FILTER_ID_4, FILTER_ID_5, FILTER_ID_6))).thenReturn(filters);
+
         GenerationDispatch modif = (GenerationDispatch) modification.toModification();
         modif.initApplicationContext(filterService, null);
         ReportNode report = modification.createSubReportNode(ReportNode.newRootReportNode()
@@ -708,6 +766,35 @@ protected void checkModification() {
         modification.setDefaultOutageRate(140.);
         e = assertThrows(NetworkModificationException.class, () -> modification.toModification().check(getNetwork()));
         assertEquals("GENERATION_DISPATCH_ERROR : The default outage rate must be between 0 and 100", e.getMessage());
+    }
+
+    @Test
+    void testGenerationDispatchWithMissingFilters() {
+        GenerationDispatchInfos modification = buildModification();
+        modification.setDefaultOutageRate(15.);
+        modification.setGeneratorsWithoutOutage(
+            List.of(GeneratorsFilterInfos.builder().id(FILTER_ID_1).name("filter1").build(),
+                GeneratorsFilterInfos.builder().id(FILTER_ID_2).name("filter2").build(),
+                GeneratorsFilterInfos.builder().id(FILTER_ID_3).name("filter3").build()));
+        modification.setGeneratorsWithFixedSupply(
+            List.of(GeneratorsFilterInfos.builder().id(FILTER_ID_1).name("filter1").build(),
+                GeneratorsFilterInfos.builder().id(FILTER_ID_2).name("filter2").build(),
+                GeneratorsFilterInfos.builder().id(FILTER_ID_3).name("filter3").build()));
+        modification.setGeneratorsFrequencyReserve(List.of(GeneratorsFrequencyReserveInfos.builder().frequencyReserve(3.)
+                .generatorsFilters(List.of(GeneratorsFilterInfos.builder().id(FILTER_ID_4).name("filter4").build(),
+                    GeneratorsFilterInfos.builder().id(FILTER_ID_5).name("filter5").build())).build(),
+            GeneratorsFrequencyReserveInfos.builder().frequencyReserve(5.)
+                .generatorsFilters(List.of(GeneratorsFilterInfos.builder().id(FILTER_ID_6).name("filter6").build())).build()));
 
+        // network with 2 synchronous components, 2 hvdc lines between them, forcedOutageRate and plannedOutageRate defined for the generators
+        setNetwork(Network.read("testGenerationDispatchReduceMaxP.xiidm", getClass().getResourceAsStream("/testGenerationDispatchReduceMaxP.xiidm")));
+
+        GenerationDispatch modif = (GenerationDispatch) modification.toModification();
+        modif.initApplicationContext(filterService, null);
+        ReportNode report = modification.createSubReportNode(ReportNode.newRootReportNode()
+            .withAllResourceBundlesFromClasspath()
+            .withMessageTemplate("test").build());
+        modif.apply(getNetwork(), report);
+        assertLogMessage("The modification points to at least 6 filters that does not exist anymore", "network.modification.missingFiltersInGenerationDispatch", report);
     }
 }
