Add new endpoint to create a spreadsheet collection from N model Ids (#27)

Signed-off-by: David BRAQUART <[email protected]>

Author: dbraquart

src/main/java/org/gridsuite/studyconfig/server/controller/SpreadsheetConfigCollectionController.java

@@ -21,6 +21,7 @@
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.*;
 
+import java.util.List;
 import java.util.UUID;
 
 import static org.springframework.http.MediaType.APPLICATION_JSON_VALUE;
@@ -46,6 +47,16 @@ public ResponseEntity<UUID> createSpreadsheetConfigCollection(@Parameter(descrip
         return ResponseEntity.status(HttpStatus.CREATED).body(id);
     }
 
+    @PostMapping(value = "/merge", consumes = APPLICATION_JSON_VALUE)
+    @Operation(summary = "Create a new spreadsheet configuration collection duplicating and merging a list of existing configurations",
+            description = "Creates a new spreadsheet configuration collection and returns its ID")
+    @ApiResponse(responseCode = "201", description = "Configuration collection created",
+            content = @Content(schema = @Schema(implementation = UUID.class)))
+    public ResponseEntity<UUID> createSpreadsheetConfigCollectionFromConfigs(@Parameter(description = "Configurations to duplicate and merge") @Valid @RequestBody List<UUID> configUuids) {
+        UUID id = spreadsheetConfigService.createSpreadsheetConfigCollectionFromConfigs(configUuids);
+        return ResponseEntity.status(HttpStatus.CREATED).body(id);
+    }
+
     @GetMapping("/{id}")
     @Operation(summary = "Get a spreadsheet configuration collection",
             description = "Retrieves a spreadsheet configuration collection by its ID")

src/main/java/org/gridsuite/studyconfig/server/service/SpreadsheetConfigService.java

@@ -44,12 +44,15 @@ public UUID createSpreadsheetConfig(SpreadsheetConfigInfos dto) {
 
     @Transactional
     public UUID duplicateSpreadsheetConfig(UUID id) {
-        SpreadsheetConfigEntity entity = findEntityById(id);
+        SpreadsheetConfigEntity duplicate = duplicateSpreadsheetConfigEntity(id);
+        return spreadsheetConfigRepository.save(duplicate).getId();
+    }
 
+    private SpreadsheetConfigEntity duplicateSpreadsheetConfigEntity(UUID id) {
+        SpreadsheetConfigEntity entity = findEntityById(id);
         SpreadsheetConfigEntity duplicate = SpreadsheetConfigEntity.builder()
                 .sheetType(entity.getSheetType())
                 .build();
-
         List<CustomColumnEmbeddable> customColumns = entity.getCustomColumns().stream()
                 .map(column -> CustomColumnEmbeddable.builder()
                         .name(column.getName())
@@ -60,10 +63,8 @@ public UUID duplicateSpreadsheetConfig(UUID id) {
                         .id(column.getId())
                         .build())
                 .toList();
-
         duplicate.setCustomColumns(customColumns);
-
-        return spreadsheetConfigRepository.save(duplicate).getId();
+        return duplicate;
     }
 
     @Transactional(readOnly = true)
@@ -127,6 +128,15 @@ public UUID createSpreadsheetConfigCollection(SpreadsheetConfigCollectionInfos d
         return spreadsheetConfigCollectionRepository.save(entity).getId();
     }
 
+    @Transactional
+    public UUID createSpreadsheetConfigCollectionFromConfigs(List<UUID> configUuids) {
+        SpreadsheetConfigCollectionEntity entity = new SpreadsheetConfigCollectionEntity();
+        entity.setSpreadsheetConfigs(configUuids.stream()
+                .map(this::duplicateSpreadsheetConfigEntity)
+                .toList());
+        return spreadsheetConfigCollectionRepository.save(entity).getId();
+    }
+
     @Transactional(readOnly = true)
     public SpreadsheetConfigCollectionInfos getSpreadsheetConfigCollection(UUID id) {
         SpreadsheetConfigCollectionEntity entity = spreadsheetConfigCollectionRepository.findById(id)

src/test/java/org/gridsuite/studyconfig/server/SpreadsheetConfigCollectionIntegrationTest.java

@@ -51,7 +51,7 @@ class SpreadsheetConfigCollectionIntegrationTest {
     private SpreadsheetConfigCollectionRepository spreadsheetConfigCollectionRepository;
 
     @AfterEach
-    public void tearDown() {
+    void tearDown() {
         spreadsheetConfigCollectionRepository.deleteAll();
     }
 
@@ -135,6 +135,22 @@ void testDuplicateCollection() throws Exception {
         assertThat(duplicatedCollection.id()).isNotEqualTo(collectionUuid);
     }
 
+    @Test
+    void testMergeModelsIntoNewCollection() throws Exception {
+        // create a first collection with 2 configs
+        SpreadsheetConfigCollectionInfos collectionToCreate = new SpreadsheetConfigCollectionInfos(null, createSpreadsheetConfigs());
+        UUID collectionUuid = postSpreadsheetConfigCollection(collectionToCreate);
+        List<UUID> configIds = getSpreadsheetConfigCollection(collectionUuid).spreadsheetConfigs().stream().map(SpreadsheetConfigInfos::id).toList();
+        assertThat(configIds).hasSize(2);
+        // create a second collection duplicating + merging these existing Configs
+        UUID mergedCollectionUuid = postMergeSpreadsheetConfigsIntoCollection(configIds);
+        List<UUID> duplicatedConfigIds = getSpreadsheetConfigCollection(mergedCollectionUuid).spreadsheetConfigs().stream().map(SpreadsheetConfigInfos::id).toList();
+
+        assertThat(mergedCollectionUuid).isNotEqualTo(collectionUuid);
+        assertThat(duplicatedConfigIds).hasSameSizeAs(configIds);
+        assertThat(duplicatedConfigIds.stream().sorted().toList()).isNotEqualTo(configIds.stream().sorted().toList());
+    }
+
     private List<SpreadsheetConfigInfos> createSpreadsheetConfigs() {
         List<CustomColumnInfos> customColumnInfos = Arrays.asList(
             new CustomColumnInfos("cust_a", ColumnType.NUMBER, 1, "cust_b + cust_c", "[\"cust_b\", \"cust_c\"]", "idA"),
@@ -184,6 +200,18 @@ private UUID postSpreadsheetConfigCollection(SpreadsheetConfigCollectionInfos co
         return mapper.readValue(mvcPostResult.getResponse().getContentAsString(), UUID.class);
     }
 
+    private UUID postMergeSpreadsheetConfigsIntoCollection(List<UUID> configIds) throws Exception {
+        String configIdsJson = mapper.writeValueAsString(configIds);
+
+        MvcResult mvcPostResult = mockMvc.perform(post(URI_SPREADSHEET_CONFIG_COLLECTION_BASE + "/merge")
+                        .content(configIdsJson)
+                        .contentType(MediaType.APPLICATION_JSON))
+                .andExpect(status().isCreated())
+                .andReturn();
+
+        return mapper.readValue(mvcPostResult.getResponse().getContentAsString(), UUID.class);
+    }
+
     private UUID duplicateSpreadsheetConfigCollection(UUID collectionUuid) throws Exception {
         MvcResult mvcPostResult = mockMvc.perform(post(URI_SPREADSHEET_CONFIG_COLLECTION_BASE + "/duplicate")
                         .queryParam("duplicateFrom", collectionUuid.toString()))