Add endpoint to update a spreadsheet config (#827)

Signed-off-by: Franck LECUYER <[email protected]>

Author: FranckLecuyer

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

@@ -142,4 +142,17 @@ public ResponseEntity<Void> resetFilters(
         studyService.resetFilters(studyUuid, id);
         return ResponseEntity.noContent().build();
     }
+
+    @PutMapping("/{id}")
+    @Operation(summary = "Update a spreadsheet configuration",
+            description = "Updates an existing spreadsheet configuration")
+    @ApiResponse(responseCode = "204", description = "Configuration updated")
+    @ApiResponse(responseCode = "404", description = "Configuration not found")
+    public ResponseEntity<Void> updateSpreadsheetConfig(
+        @PathVariable("studyUuid") UUID studyUuid,
+        @Parameter(description = "ID of the configuration to update") @PathVariable UUID id,
+        @Valid @RequestBody String spreadsheetConfigInfos) {
+        studyService.updateSpreadsheetConfig(studyUuid, id, spreadsheetConfigInfos);
+        return ResponseEntity.noContent().build();
+    }
 }

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

@@ -376,6 +376,19 @@ public void renameSpreadsheetConfig(UUID configUuid, String newName) {
         }
     }
 
+    public void updateSpreadsheetConfig(UUID configUuid, String spreadsheetConfigInfos) {
+        var uriBuilder = UriComponentsBuilder.fromPath(DELIMITER + STUDY_CONFIG_API_VERSION + SPREADSHEET_CONFIG_WITH_ID_URI);
+        String path = uriBuilder.buildAndExpand(configUuid).toUriString();
+        HttpHeaders headers = new HttpHeaders();
+        headers.setContentType(MediaType.APPLICATION_JSON);
+        HttpEntity<String> httpEntity = new HttpEntity<>(spreadsheetConfigInfos, headers);
+        try {
+            restTemplate.exchange(studyConfigServerBaseUri + path, HttpMethod.PUT, httpEntity, Void.class);
+        } catch (HttpStatusCodeException e) {
+            throw handleHttpError(e, UPDATE_SPREADSHEET_CONFIG_FAILED);
+        }
+    }
+
     public void setGlobalFilters(UUID configUuid, String globalFilters) {
         var uriBuilder = UriComponentsBuilder.fromPath(DELIMITER + STUDY_CONFIG_API_VERSION + SPREADSHEET_CONFIG_WITH_ID_URI + "/global-filters");
         String path = uriBuilder.buildAndExpand(configUuid).toUriString();

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

@@ -3415,6 +3415,11 @@ public void renameSpreadsheetConfig(UUID studyUuid, UUID configUuid, String newN
         notificationService.emitSpreadsheetConfigChanged(studyUuid, configUuid);
     }
 
+    public void updateSpreadsheetConfig(UUID studyUuid, UUID configUuid, String spreadsheetConfigInfos) {
+        studyConfigService.updateSpreadsheetConfig(configUuid, spreadsheetConfigInfos);
+        notificationService.emitSpreadsheetConfigChanged(studyUuid, configUuid);
+    }
+
     public UUID addSpreadsheetConfigToCollection(UUID studyUuid, UUID collectionUuid, String configurationDto) {
         UUID newConfigId = studyConfigService.addSpreadsheetConfigToCollection(collectionUuid, configurationDto);
         notificationService.emitSpreadsheetCollectionChanged(studyUuid, collectionUuid);

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

@@ -256,6 +256,36 @@ void testResetFilters(final MockWebServer server) throws Exception {
         wireMockUtils.verifyPutRequest(stubId, configServerUrl, false, Map.of(), null);
     }
 
+    @Test
+    void testUpdateConfig() throws Exception {
+        StudyEntity studyEntity = insertStudy();
+        String configServerUrl = "/v1/spreadsheet-configs/" + SPREADSHEET_CONFIG_UUID;
+
+        UUID stubId = wireMockServer.stubFor(WireMock.put(WireMock.urlPathEqualTo(configServerUrl))
+                .willReturn(WireMock.noContent())).getId();
+
+        String spreadsheetConfig = "{\"id\": \"" + SPREADSHEET_CONFIG_UUID + "\"," +
+                                   "\"name\": \"name\"" + "," +
+                                   "\"sheetType\": \"SUBSTATION\"" + "," +
+                                   "\"columns\": [{" +
+                                   "\"uuid\": \"" + UUID.randomUUID() + "\"," +
+                                   "\"id\": \"id\"" + "," +
+                                   "\"name\": \"columnName\"" + "," +
+                                   "\"type\": \"TEXT\"" + "," +
+                                   "\"formula\": \"id\"" +
+                                   "}]" +
+                                   "}";
+
+        mockMvc.perform(put("/v1/studies/{studyUuid}/spreadsheet-config/{configUuid}", studyEntity.getId(), SPREADSHEET_CONFIG_UUID)
+                        .header("content-type", "application/json")
+                        .content(spreadsheetConfig))
+                .andExpect(status().isNoContent())
+                .andReturn();
+
+        checkSpreadsheetTabUpdateMessageReceived(studyEntity.getId());
+        wireMockUtils.verifyPutRequest(stubId, configServerUrl, false, Map.of(), spreadsheetConfig);
+    }
+
     private StudyEntity insertStudy() {
         StudyEntity studyEntity = TestUtils.createDummyStudy(NETWORK_UUID, "netId", CASE_UUID, "", "", SPREADSHEET_CONFIG_UUID);
         var study = studyRepository.save(studyEntity);