Move CEI909 constant outside of record data manipulation

Author: Tristan-WorkGH

src/main/java/org/gridsuite/shortcircuit/server/dto/ShortCircuitParametersInfos.java

@@ -6,9 +6,12 @@
  */
 package org.gridsuite.shortcircuit.server.dto;
 
+import com.fasterxml.jackson.annotation.JsonGetter;
 import com.powsybl.shortcircuit.ShortCircuitParameters;
 import com.powsybl.shortcircuit.VoltageRange;
-import lombok.*;
+import lombok.Builder;
+import lombok.extern.jackson.Jacksonized;
+import org.gridsuite.shortcircuit.server.service.ShortCircuitService;
 
 import java.util.List;
 
@@ -17,9 +20,13 @@
  * @since 1.7.0
  */
 @Builder
+@Jacksonized
 public record ShortCircuitParametersInfos(
     ShortCircuitPredefinedConfiguration predefinedParameters,
-    ShortCircuitParameters parameters,
-    List<VoltageRange> cei909VoltageRanges
+    ShortCircuitParameters parameters
 ) {
+    @JsonGetter
+    public List<VoltageRange> cei909VoltageRanges() {
+        return ShortCircuitService.CEI909_VOLTAGE_PROFILE;
+    }
 }

src/main/java/org/gridsuite/shortcircuit/server/service/ShortCircuitService.java

@@ -52,11 +52,9 @@
  */
 @Service
 public class ShortCircuitService {
-
     private static final Logger LOGGER = LoggerFactory.getLogger(ShortCircuitService.class);
 
-    //TODO tmp migration
-    private static final List<VoltageRange> CEI909_VOLTAGE_PROFILE = List.of(
+    public static final List<VoltageRange> CEI909_VOLTAGE_PROFILE = List.of(
         new VoltageRange(10.0, 199.99, 1.1),
         new VoltageRange(200.0, 299.99, 1.09),
         new VoltageRange(300.0, 500.0, 1.05)
@@ -171,16 +169,14 @@ private static ShortCircuitParametersInfos fromEntity(AnalysisParametersEntity e
                 .setWithVSCConverterStations(entity.isWithVscConverterStations())
                 .setWithNeutralPosition(entity.isWithNeutralPosition())
                 .setInitialVoltageProfileMode(entity.getInitialVoltageProfileMode())
-                .setVoltageRanges(InitialVoltageProfileMode.CONFIGURED.equals(entity.getInitialVoltageProfileMode()) ? CEI909_VOLTAGE_PROFILE : null),
-            CEI909_VOLTAGE_PROFILE
+                .setVoltageRanges(InitialVoltageProfileMode.CONFIGURED.equals(entity.getInitialVoltageProfileMode()) ? CEI909_VOLTAGE_PROFILE : null)
         );
     }
 
     private static ShortCircuitParametersInfos getDefaultDtoParameters() {
         return new ShortCircuitParametersInfos(
             ShortCircuitPredefinedConfiguration.ICC_MAX_WITH_CEI909,
-            getDefaultShortCircuitParameters(),
-            CEI909_VOLTAGE_PROFILE
+            getDefaultShortCircuitParameters()
         );
     }
 

src/test/java/org/gridsuite/shortcircuit/server/dto/ShortCircuitParametersInfosTest.java

@@ -0,0 +1,67 @@
+package org.gridsuite.shortcircuit.server.dto;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.powsybl.shortcircuit.ShortCircuitParameters;
+import com.powsybl.shortcircuit.VoltageRange;
+import lombok.NonNull;
+import lombok.SneakyThrows;
+import org.assertj.core.api.WithAssertions;
+import org.gridsuite.shortcircuit.server.RestTemplateConfig;
+import org.json.JSONArray;
+import org.json.JSONObject;
+import org.junit.jupiter.api.Test;
+import org.skyscreamer.jsonassert.JSONAssert;
+import org.skyscreamer.jsonassert.JSONCompareMode;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.autoconfigure.json.JsonTest;
+import org.springframework.test.context.ContextConfiguration;
+
+import static org.gridsuite.shortcircuit.server.service.ShortCircuitService.CEI909_VOLTAGE_PROFILE;
+
+@ContextConfiguration(classes = { RestTemplateConfig.class })
+@JsonTest
+class ShortCircuitParametersInfosTest implements WithAssertions {
+    @Autowired
+    ObjectMapper objectMapper;
+
+    @SneakyThrows
+    private static JSONObject toJson(@NonNull final VoltageRange voltageRange) {
+        return new JSONObject().put("minimumNominalVoltage", voltageRange.getMinimumNominalVoltage())
+                               .put("maximumNominalVoltage", voltageRange.getMaximumNominalVoltage())
+                               .put("voltageRangeCoefficient", voltageRange.getRangeCoefficient());
+    }
+
+    @Test
+    void shouldSerializeCei909VoltageRanges() throws Exception {
+        JSONAssert.assertEquals(
+            new JSONObject().put("predefinedParameters", ShortCircuitPredefinedConfiguration.ICC_MAX_WITH_CEI909.toString())
+                            .put("parameters", new JSONObject().put("version", "1.3")
+                                                               .put("withLimitViolations", true)
+                                                               .put("withVoltageResult", true)
+                                                               .put("withFeederResult", true)
+                                                               .put("studyType", "TRANSIENT")
+                                                               .put("minVoltageDropProportionalThreshold", 0.0)
+                                                               .put("withFortescueResult", true)
+                                                               .put("withLoads", true)
+                                                               .put("withShuntCompensators", true)
+                                                               .put("withVSCConverterStations", true)
+                                                               .put("withNeutralPosition", false)
+                                                               .put("initialVoltageProfileMode", "NOMINAL")
+                                                               .put("detailedReport", true))
+                            .put("cei909VoltageRanges", CEI909_VOLTAGE_PROFILE.stream()
+                                    .map(ShortCircuitParametersInfosTest::toJson)
+                                    .reduce(new JSONArray(), JSONArray::put, (arr1, arr2) -> null)),
+            new JSONObject(objectMapper.writeValueAsString(new ShortCircuitParametersInfos(ShortCircuitPredefinedConfiguration.ICC_MAX_WITH_CEI909, new ShortCircuitParameters()))),
+            JSONCompareMode.STRICT
+        );
+    }
+
+    @Test
+    void shouldIgnoreCei909VoltageRangesWhenDeserialize() {
+        final String dumbJson = "\"predefinedParameters\":\"ICC_MAX_WITH_CEI909\", \"parameters\":{\"version\":\"1.3\",\"withLimitViolations\":true,\"withVoltageResult\":true,\"withFeederResult\":true,\"studyType\":\"TRANSIENT\",\"minVoltageDropProportionalThreshold\":0.0,\"withFortescueResult\":false,\"withLoads\":true,\"withShuntCompensators\":true,\"withVSCConverterStations\":true,\"withNeutralPosition\":false,\"initialVoltageProfileMode\":\"NOMINAL\",\"detailedReport\":true}";
+        assertThatNoException().as("DTO with CEI909 field")
+                               .isThrownBy(() -> objectMapper.readValue("{" + dumbJson + ", \"cei909VoltageRanges\":[null,null]}", ShortCircuitParametersInfos.class));
+        assertThatNoException().as("DTO without CEI909 field")
+                               .isThrownBy(() -> objectMapper.readValue("{" + dumbJson + "}", ShortCircuitParametersInfos.class));
+    }
+}