Fix contingency equality (#1637)

Signed-off-by: Peter Mitri <peter.mitri@rte-france.com>

Author: pet-mit

data/crac/crac-impl/src/main/java/com/powsybl/openrao/data/crac/impl/PostContingencyState.java

@@ -7,13 +7,15 @@
 
 package com.powsybl.openrao.data.crac.impl;
 
-import com.powsybl.openrao.commons.OpenRaoException;
 import com.powsybl.contingency.Contingency;
+import com.powsybl.contingency.ContingencyElement;
+import com.powsybl.openrao.commons.OpenRaoException;
 import com.powsybl.openrao.data.crac.api.Instant;
 import com.powsybl.openrao.data.crac.api.State;
 
 import java.time.OffsetDateTime;
 import java.util.Optional;
+import java.util.stream.Collectors;
 
 /**
  * Business object for a state (instant and contingency) in the CRAC file.
@@ -56,8 +58,8 @@ public Optional<OffsetDateTime> getTimestamp() {
     }
 
     /**
-     * Check if states are equals. States are considered equals when instant and contingency are equals if
-     * contingency is present. Otherwise they are considered equals when instant are equals.
+     * Check if states are equal. States are considered equal when instant and contingency are equal if
+     * contingency is present. Otherwise, they are considered equal when instants are equal.
      *
      * @param o If it's null or another object than State it will return false.
      * @return A boolean true if objects are equals, otherwise false.
@@ -72,8 +74,11 @@ public boolean equals(Object o) {
         }
         State state = (State) o;
         Optional<Contingency> oContingency = state.getContingency();
+        // Check for contingency ID & elements IDs equality, because two same contingencies can have
+        // different implementations (e.g. LineContingency & BranchContingency)
         return state.getInstant().equals(instant)
-            && oContingency.map(value -> value.equals(contingency)).orElseGet(() -> contingency == null)
+            && oContingency.isPresent() && oContingency.get().getId().equals(contingency.getId())
+            && oContingency.get().getElements().stream().map(ContingencyElement::getId).collect(Collectors.toSet()).equals(contingency.getElements().stream().map(ContingencyElement::getId).collect(Collectors.toSet()))
             && state.getTimestamp().equals(Optional.ofNullable(timestamp));
     }
 

data/crac/crac-impl/src/test/java/com/powsybl/openrao/data/crac/impl/PostContingencyStateTest.java

@@ -61,6 +61,43 @@ void testEquals() {
         assertEquals(state1, state2);
     }
 
+    @Test
+    void testEqualsDifferentContingencyImplementations() {
+        // using different Crac instances, different contingency implementations (BRANCH instead of LINE)
+        // but with the same content, states must be equal
+        Crac crac2 = new CracImplFactory().create("cracId")
+            .newInstant("preventive", InstantKind.PREVENTIVE)
+            .newInstant("outage", InstantKind.OUTAGE)
+            .newInstant("curative", InstantKind.CURATIVE);
+        Contingency contingency1Clone = crac2.newContingency()
+            .withId("contingency1")
+            .withContingencyElement("anyNetworkElement", ContingencyElementType.BRANCH)
+            .add();
+
+        PostContingencyState state1 = new PostContingencyState(contingency1, outageInstant, null);
+        PostContingencyState state2 = new PostContingencyState(contingency1Clone, outageInstant, null);
+
+        assertEquals(state1, state2);
+    }
+
+    @Test
+    void testNotEqualsDifferentContingencyImplementations() {
+        // the same as the previous test but with different contingency elements
+        Crac crac2 = new CracImplFactory().create("cracId")
+            .newInstant("preventive", InstantKind.PREVENTIVE)
+            .newInstant("outage", InstantKind.OUTAGE)
+            .newInstant("curative", InstantKind.CURATIVE);
+        Contingency contingency1Clone = crac2.newContingency()
+            .withId("contingency1")
+            .withContingencyElement("anotherNetworkElement", ContingencyElementType.BRANCH)
+            .add();
+
+        PostContingencyState state1 = new PostContingencyState(contingency1, outageInstant, null);
+        PostContingencyState state2 = new PostContingencyState(contingency1Clone, outageInstant, null);
+
+        assertNotEquals(state1, state2);
+    }
+
     @Test
     void testNotEqualsByInstant() {
         PostContingencyState state1 = new PostContingencyState(contingency1, outageInstant, null);

data/crac/crac-io/crac-io-network/src/main/java/com/powsybl/openrao/data/crac/io/network/NetworkCracCreator.java

@@ -7,16 +7,20 @@
 
 package com.powsybl.openrao.data.crac.io.network;
 
-import com.powsybl.contingency.ContingencyElementType;
-import com.powsybl.iidm.network.*;
+import com.powsybl.contingency.ContingencyElementFactory;
+import com.powsybl.iidm.network.Network;
 import com.powsybl.openrao.commons.OpenRaoException;
 import com.powsybl.openrao.data.crac.api.Crac;
 import com.powsybl.openrao.data.crac.api.InstantKind;
 import com.powsybl.openrao.data.crac.api.parameters.CracCreationParameters;
 import com.powsybl.openrao.data.crac.api.parameters.RangeActionGroup;
-import com.powsybl.openrao.data.crac.io.network.parameters.*;
+import com.powsybl.openrao.data.crac.io.network.parameters.Contingencies;
+import com.powsybl.openrao.data.crac.io.network.parameters.NetworkCracCreationParameters;
 
-import java.util.*;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.SortedMap;
 
 /**
  * Creates a CRAC from a network.
@@ -73,7 +77,7 @@ private static void addContingencies(Crac crac, Network network, Contingencies p
             .forEach(
                 branch -> crac.newContingency()
                     .withId("CO_" + branch.getNameOrId())
-                    .withContingencyElement(branch.getId(), ContingencyElementType.BRANCH)
+                    .withContingencyElement(branch.getId(), ContingencyElementFactory.create(branch).getType())
                     .add());
     }
 }