Add endpoint to replace all spreadsheet configs in a collection (#136)

Signed-off-by: Ayoub LABIDI <[email protected]>

Author: ayolab

src/main/java/org/gridsuite/explore/server/ExploreController.java

@@ -445,6 +445,19 @@ public ResponseEntity<Void> updateSpreadsheetConfigCollection(@PathVariable UUID
         return ResponseEntity.noContent().build();
     }
 
+    @PutMapping(value = "/explore/spreadsheet-config-collections/{id}/spreadsheet-configs/replace-all", consumes = MediaType.APPLICATION_JSON_VALUE)
+    @Operation(summary = "Replace all spreadsheet configurations in a collection")
+    @ApiResponses(value = {@ApiResponse(responseCode = "204", description = "Spreadsheet config collection has been successfully modified")})
+    @PreAuthorize("@authorizationService.isAuthorized(#userId, #id, null, T(org.gridsuite.explore.server.dto.PermissionType).WRITE)")
+    public ResponseEntity<Void> replaceAllSpreadsheetConfigsInCollection(@PathVariable UUID id,
+                                                                        @RequestBody List<UUID> configUuids,
+                                                                        @RequestHeader(QUERY_PARAM_USER_ID) String userId,
+                                                                        @RequestParam(QUERY_PARAM_NAME) String name,
+                                                                        @RequestParam(QUERY_PARAM_DESCRIPTION) String description) {
+        exploreService.replaceAllSpreadsheetConfigsInCollection(id, configUuids, userId, name, description);
+        return ResponseEntity.noContent().build();
+    }
+
     @PostMapping(value = "/explore/spreadsheet-configs", params = "duplicateFrom")
     @Operation(summary = "Duplicate a spreadsheet configuration")
     @ApiResponses(value = {@ApiResponse(responseCode = "201", description = "Spreadsheet config has been successfully duplicated")})

src/main/java/org/gridsuite/explore/server/services/ExploreService.java

@@ -327,6 +327,11 @@ public void updateSpreadsheetConfigCollection(UUID id, String spreadsheetConfigC
         updateElementNameAndDescription(id, name, description, userId);
     }
 
+    public void replaceAllSpreadsheetConfigsInCollection(UUID id, List<UUID> configIds, String userId, String name, String description) {
+        spreadsheetConfigCollectionService.replaceAllSpreadsheetConfigsInCollection(id, configIds);
+        updateElementNameAndDescription(id, name, description, userId);
+    }
+
     public void duplicateSpreadsheetConfig(UUID sourceId, UUID targetDirectoryId, String userId) {
         UUID newSpreadsheetConfigUuid = spreadsheetConfigService.duplicateSpreadsheetConfig(sourceId);
         directoryService.duplicateElement(sourceId, newSpreadsheetConfigUuid, targetDirectoryId, userId);

src/main/java/org/gridsuite/explore/server/services/SpreadsheetConfigCollectionService.java

@@ -108,6 +108,23 @@ public void updateSpreadsheetConfigCollection(UUID collectionId, String collecti
         restTemplate.exchange(spreadsheetConfigServerBaseUri + path, HttpMethod.PUT, httpEntity, Void.class);
     }
 
+    public void replaceAllSpreadsheetConfigsInCollection(UUID collectionId, List<UUID> configIds) {
+        Objects.requireNonNull(collectionId);
+        Objects.requireNonNull(configIds);
+
+        var path = UriComponentsBuilder
+                .fromPath(SPREADSHEET_CONFIG_COLLECTIONS_PATH + DELIMITER + collectionId + "/spreadsheet-configs/replace-all")
+                .buildAndExpand()
+                .toUriString();
+
+        HttpHeaders headers = new HttpHeaders();
+        headers.setContentType(MediaType.APPLICATION_JSON);
+
+        HttpEntity<List<UUID>> httpEntity = new HttpEntity<>(configIds, headers);
+
+        restTemplate.exchange(spreadsheetConfigServerBaseUri + path, HttpMethod.PUT, httpEntity, Void.class);
+    }
+
     @Override
     public void delete(UUID configUuid, String userId) {
         Objects.requireNonNull(configUuid);

src/test/java/org/gridsuite/explore/server/SpreadsheetConfigCollectionTest.java

@@ -90,6 +90,8 @@ public MockResponse dispatch(RecordedRequest request) {
                     return new MockResponse(201, Headers.of("Content-Type", "application/json"), objectMapper.writeValueAsString(COLLECTION_UUID));
                 } else if (path.matches(SPREADSHEET_CONFIG_COLLECTION_SERVER_BASE_URL + "/" + COLLECTION_UUID)) {
                     return new MockResponse(204);
+                } else if (path.matches(SPREADSHEET_CONFIG_COLLECTION_SERVER_BASE_URL + "/" + COLLECTION_UUID + "/spreadsheet-configs/replace-all")) {
+                    return new MockResponse(204);
                 } else if (path.matches(SPREADSHEET_CONFIG_COLLECTION_SERVER_BASE_URL + "\\?duplicateFrom=" + COLLECTION_UUID) && "POST".equals(request.getMethod())) {
                     return new MockResponse(201, Headers.of("Content-Type", "application/json"), objectMapper.writeValueAsString(UUID.randomUUID()));
                 } else if (path.matches("/v1/directories/.*/elements\\?allowNewName=.*") && "POST".equals(request.getMethod()) || path.matches("/v1/elements/" + COLLECTION_UUID)) {
@@ -137,6 +139,18 @@ void testCreateSpreadsheetConfigCollectionWithMerge() throws Exception {
         perform.andExpect(status().isCreated());
     }
 
+    @Test
+    void testReplaceAllSpreadsheetConfigsInCollection() throws Exception {
+        String configIds = "[\"" + UUID.randomUUID() + "\", \"" + UUID.randomUUID() + "\"]";
+        ResultActions perform = mockMvc.perform(put(BASE_URL + "/{id}/spreadsheet-configs/replace-all", COLLECTION_UUID)
+                .contentType(MediaType.APPLICATION_JSON)
+                .content(configIds)
+                .param("name", COLLECTION_NAME)
+                .param("description", "Test Description")
+                .header("userId", USER_ID));
+        perform.andExpect(status().isNoContent());
+    }
+
     @Test
     void testUpdateSpreadsheetConfigCollection() throws Exception {
         mockMvc.perform(put(BASE_URL + "/{id}", COLLECTION_UUID)