Loadflow modifications endpoint (#830)

Signed-off-by: LE SAULNIER Kevin <[email protected]>

Author: klesaulnier

src/main/java/org/gridsuite/study/server/RestResponseEntityExceptionHandler.java

@@ -34,6 +34,7 @@ protected ResponseEntity<Object> handleStudyException(StudyException exception)
                     STUDY_NOT_FOUND,
                     NODE_NOT_FOUND,
                     ROOT_NETWORK_NOT_FOUND,
+                    LOADFLOW_NOT_FOUND,
                     SECURITY_ANALYSIS_NOT_FOUND,
                     SENSITIVITY_ANALYSIS_NOT_FOUND,
                     SHORT_CIRCUIT_ANALYSIS_NOT_FOUND,

src/main/java/org/gridsuite/study/server/StudyConstants.java

@@ -44,6 +44,7 @@ private StudyConstants() {
 
     public static final String DELIMITER = "/";
     public static final String QUERY_PARAM_VARIANT_ID = "variantId";
+    public static final String QUERY_PARAM_NETWORK_UUID = "networkUuid";
     public static final String QUERY_PARAM_EQUIPMENT_TYPE = "equipmentType";
     public static final String QUERY_PARAM_ELEMENT_TYPE = "elementType";
     public static final String QUERY_PARAM_SIDE = "side";

src/main/java/org/gridsuite/study/server/controller/StudyController.java

@@ -764,6 +764,16 @@ public ResponseEntity<LoadFlowComputationInfos> getLoadFlowComputationInfos(@Par
         return ResponseEntity.ok().contentType(MediaType.APPLICATION_JSON).body(rootNetworkNodeInfoService.getLoadFlowComputationInfos(nodeUuid, rootNetworkUuid));
     }
 
+    @GetMapping(value = "/studies/{studyUuid}/root-networks/{rootNetworkUuid}/nodes/{nodeUuid}/loadflow/modifications")
+    @Operation(summary = "Get the loadflow modifications on study node and root network")
+    @ApiResponses(value = {@ApiResponse(responseCode = "200", description = "The loadflow computation infos"),
+        @ApiResponse(responseCode = "404", description = "The loadflow computation has not been found")})
+    public ResponseEntity<String> getLoadFlowModifications(@Parameter(description = "Study UUID") @PathVariable("studyUuid") UUID studyUuid,
+                                                                                @Parameter(description = "rootNetworkUuid") @PathVariable("rootNetworkUuid") UUID rootNetworkUuid,
+                                                                                @Parameter(description = "nodeUuid") @PathVariable("nodeUuid") UUID nodeUuid) {
+        return ResponseEntity.ok().contentType(MediaType.APPLICATION_JSON).body(rootNetworkNodeInfoService.getLoadFlowModifications(nodeUuid, rootNetworkUuid));
+    }
+
     @PutMapping(value = "/studies/{studyUuid}/root-networks/{rootNetworkUuid}/nodes/{nodeUuid}/loadflow/stop")
     @Operation(summary = "stop loadflow on study")
     @ApiResponses(value = {@ApiResponse(responseCode = "200", description = "The loadflow has been stopped")})

src/main/java/org/gridsuite/study/server/service/LoadFlowService.java

@@ -143,6 +143,23 @@ public String getLoadFlowResult(UUID resultUuid, String filters, Sort sort) {
         return result;
     }
 
+    public String getLoadFlowModifications(UUID resultUuid) {
+        String result;
+
+        UriComponentsBuilder uriComponentsBuilder = UriComponentsBuilder.fromPath(DELIMITER + LOADFLOW_API_VERSION + "/results/{resultUuid}/modifications");
+        String path = uriComponentsBuilder.buildAndExpand(resultUuid).toUriString();
+
+        try {
+            result = restTemplate.getForObject(loadFlowServerBaseUri + path, String.class);
+        } catch (HttpStatusCodeException e) {
+            if (HttpStatus.NOT_FOUND.equals(e.getStatusCode())) {
+                throw new StudyException(LOADFLOW_NOT_FOUND);
+            }
+            throw e;
+        }
+        return result;
+    }
+
     public LoadFlowStatus getLoadFlowStatus(UUID resultUuid) {
         LoadFlowStatus result;
 

src/main/java/org/gridsuite/study/server/service/RootNetworkNodeInfoService.java

@@ -655,6 +655,15 @@ public LoadFlowComputationInfos getLoadFlowComputationInfos(UUID nodeUuid, UUID
         return new LoadFlowComputationInfos(isWithRatioTapChangers);
     }
 
+    @Transactional(readOnly = true)
+    public String getLoadFlowModifications(UUID nodeUuid, UUID rootNetworkUuid) {
+        UUID resultUuid = getComputationResultUuid(nodeUuid, rootNetworkUuid, LOAD_FLOW);
+        if (resultUuid == null) {
+            throw new StudyException(LOADFLOW_NOT_FOUND);
+        }
+        return loadFlowService.getLoadFlowModifications(resultUuid);
+    }
+
     @Transactional(readOnly = true)
     public SecurityAnalysisStatus getSecurityAnalysisStatus(UUID nodeUuid, UUID rootNetworkUuid) {
         UUID resultUuid = getComputationResultUuid(nodeUuid, rootNetworkUuid, SECURITY_ANALYSIS);

src/test/java/org/gridsuite/study/server/LoadFlowTest.java

@@ -145,6 +145,7 @@ class LoadFlowTest {
     private static final String LOADFLOW_RESULT_DESTINATION = "loadflow.result";
     private static final String LOADFLOW_STOPPED_DESTINATION = "loadflow.stopped";
     private static final String LOADFLOW_FAILED_DESTINATION = "loadflow.run.dlx";
+    private static final String LOADFLOW_MODIFICATIONS = "loadflow modifications mock";
 
     @Autowired
     private MockMvc mockMvc;
@@ -274,6 +275,10 @@ public MockResponse dispatch(RecordedRequest request) {
                     return new MockResponse(200, Headers.of(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON_VALUE), COMPUTING_STATUS_JSON);
                 } else if (path.matches("/v1/results/" + LOADFLOW_RESULT_UUID + "/computation")) {
                     return new MockResponse(404);
+                } else if (path.matches("/v1/results/" + LOADFLOW_RESULT_UUID + "/modifications")) {
+                    return new MockResponse(200, Headers.of(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON_VALUE), "loadflow modifications mock");
+                } else if (path.matches("/v1/results/" + LOADFLOW_ERROR_RESULT_UUID + "/modifications")) {
+                    return new MockResponse(404);
                 } else if (path.matches("/v1/results/invalidate-status\\?resultUuid=" + LOADFLOW_RESULT_UUID)) {
                     return new MockResponse(200);
                 } else if (path.matches("/v1/results/invalidate-status\\?resultUuid=" + LOADFLOW_RESULT_UUID + "&resultUuid=" + LOADFLOW_OTHER_NODE_RESULT_UUID)) {
@@ -958,6 +963,42 @@ void testInvalidateNodesAfterLoadflow(final MockWebServer server) throws Excepti
         assertEquals(NodeBuildStatusEmbeddable.from(BuildStatus.NOT_BUILT), rootNetworkNodeInfoService.getRootNetworkNodeInfo(node3.getId(), rootNetworkUuid).map(RootNetworkNodeInfoEntity::getNodeBuildStatus).orElseThrow());
     }
 
+    @Test
+    void testGetLoadFlowModification(final MockWebServer server) throws Exception {
+        StudyEntity studyEntity = insertDummyStudy(UUID.fromString(NETWORK_UUID_STRING), CASE_LOADFLOW_UUID, LOADFLOW_PARAMETERS_UUID);
+        UUID studyUuid = studyEntity.getId();
+        UUID rootNetworkUuid = studyTestUtils.getOneRootNetworkUuid(studyUuid);
+        RootNode rootNode = getRootNode(studyUuid);
+        NetworkModificationNode node1 = createNetworkModificationConstructionNode(studyUuid, rootNode.getId(), UUID.randomUUID(), VARIANT_ID, "N1");
+        updateLoadflowResultUuid(node1.getId(), rootNetworkUuid, UUID.fromString(LOADFLOW_RESULT_UUID));
+
+        MvcResult mvcResult = mockMvc.perform(get("/v1/studies/{studyUuid}/root-networks/{rootNetworkUuid}/nodes/{nodeUuid}/loadflow/modifications", studyUuid, rootNetworkUuid, node1.getId()))
+            .andExpect(status().isOk())
+            .andReturn();
+
+        assertEquals(LOADFLOW_MODIFICATIONS, mvcResult.getResponse().getContentAsString());
+
+        assertRequestsDone(server, List.of("/v1/results/" + LOADFLOW_RESULT_UUID + "/modifications"));
+    }
+
+    @Test
+    void testGetLoadFlowModificationNotFound(final MockWebServer server) throws Exception {
+        StudyEntity studyEntity = insertDummyStudy(UUID.fromString(NETWORK_UUID_STRING), CASE_LOADFLOW_UUID, LOADFLOW_PARAMETERS_UUID);
+        UUID studyUuid = studyEntity.getId();
+        UUID rootNetworkUuid = studyTestUtils.getOneRootNetworkUuid(studyUuid);
+        RootNode rootNode = getRootNode(studyUuid);
+        NetworkModificationNode node1 = createNetworkModificationConstructionNode(studyUuid, rootNode.getId(), UUID.randomUUID(), VARIANT_ID, "N1");
+
+        mockMvc.perform(get("/v1/studies/{studyUuid}/root-networks/{rootNetworkUuid}/nodes/{nodeUuid}/loadflow/modifications", studyUuid, rootNetworkUuid, node1.getId()))
+            .andExpect(status().isNotFound());
+
+        updateLoadflowResultUuid(node1.getId(), rootNetworkUuid, UUID.fromString(LOADFLOW_ERROR_RESULT_UUID));
+        mockMvc.perform(get("/v1/studies/{studyUuid}/root-networks/{rootNetworkUuid}/nodes/{nodeUuid}/loadflow/modifications", studyUuid, rootNetworkUuid, node1.getId()))
+            .andExpect(status().isNotFound());
+
+        assertRequestsDone(server, List.of("/v1/results/" + LOADFLOW_ERROR_RESULT_UUID + "/modifications"));
+    }
+
     private void updateNodeBuildStatus(UUID nodeId, UUID rootNetworkUuid, BuildStatus buildStatus) {
         RootNetworkNodeInfoEntity rootNetworkNodeInfoEntity = rootNetworkNodeInfoRepository.findByNodeInfoIdAndRootNetworkId(nodeId, rootNetworkUuid).orElseThrow();
         rootNetworkNodeInfoEntity.setNodeBuildStatus(NodeBuildStatusEmbeddable.from(buildStatus));