Endpoint for cases S3 migration (#63)

Signed-off-by: Etienne Homer <etiennehomer@gmail.com>

Author: etiennehomer

src/main/java/com/powsybl/caseserver/CaseController.java

@@ -164,8 +164,9 @@ public ResponseEntity<Boolean> exists(@PathVariable("caseUuid") UUID caseUuid) {
     public ResponseEntity<UUID> importCase(@RequestParam("file") MultipartFile file,
                                            @RequestParam(value = "withExpiration", required = false, defaultValue = "false") boolean withExpiration,
                                            @RequestParam(value = "withIndexation", required = false, defaultValue = "false") boolean withIndexation) {
-        LOGGER.debug("importCase request received with file = {}", file.getName());
-        UUID caseUuid = caseService.importCase(file, withExpiration, withIndexation);
+        LOGGER.debug("importCase request received with file = {}", file.getOriginalFilename());
+        UUID caseUuid = UUID.randomUUID();
+        caseService.importCase(file, withExpiration, withIndexation, caseUuid);
         return ResponseEntity.ok().body(caseUuid);
     }
 

src/main/java/com/powsybl/caseserver/migration/MigrationController.java

@@ -0,0 +1,54 @@
+/**
+ * Copyright (c) 2025, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+package com.powsybl.caseserver.migration;
+
+import com.powsybl.caseserver.CaseConstants;
+import com.powsybl.caseserver.service.CaseService;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Qualifier;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.MediaType;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.*;
+import org.springframework.web.multipart.MultipartFile;
+import org.springframework.web.server.ResponseStatusException;
+
+import java.util.*;
+
+/**
+ * @author Etienne Homer <etienne.homer at rte-france.com>
+ */
+@RestController
+@RequestMapping(value = "/" + CaseConstants.API_VERSION + "/migration")
+@Tag(name = "Case migration")
+public class MigrationController {
+
+    private static final Logger LOGGER = LoggerFactory.getLogger(MigrationController.class);
+
+    @Autowired
+    @Qualifier("storageService")
+    private CaseService caseService;
+
+    @PostMapping(value = "/cases", consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
+    @Operation(summary = "import a case with given uuid")
+    @SuppressWarnings("javasecurity:S5145")
+    public ResponseEntity<UUID> importCase(@RequestParam("file") MultipartFile file,
+                                           @RequestParam(value = "withExpiration", defaultValue = "false") boolean withExpiration,
+                                           @RequestParam(value = "withIndexation", defaultValue = "false") boolean withIndexation,
+                                           @RequestParam(value = "caseUuid") UUID caseUuid) {
+        LOGGER.debug("importCase request received with file = {}", file.getOriginalFilename());
+        if (caseService.caseExists(caseUuid)) {
+            throw new ResponseStatusException(HttpStatus.CONFLICT, "Case with UUID " + caseUuid + " already exists");
+        }
+        caseService.importCase(file, withExpiration, withIndexation, caseUuid);
+        return ResponseEntity.ok().build();
+    }
+}

src/main/java/com/powsybl/caseserver/service/CaseService.java

@@ -168,7 +168,7 @@ default List<CaseInfos> getCasesToReindex() {
 
     Optional<byte[]> getCaseBytes(UUID caseUuid);
 
-    UUID importCase(MultipartFile file, boolean withExpiration, boolean withIndexation);
+    UUID importCase(MultipartFile file, boolean withExpiration, boolean withIndexation, UUID caseUuid);
 
     UUID duplicateCase(UUID sourceCaseUuid, boolean withExpiration);
 

src/main/java/com/powsybl/caseserver/service/FsCaseService.java

@@ -184,10 +184,9 @@ public boolean caseExists(UUID caseName) {
     }
 
     @Override
-    public UUID importCase(MultipartFile mpf, boolean withExpiration, boolean withIndexation) {
+    public UUID importCase(MultipartFile mpf, boolean withExpiration, boolean withIndexation, UUID caseUuid) {
         checkStorageInitialization();
 
-        UUID caseUuid = UUID.randomUUID();
         Path uuidDirectory = getStorageRootDir().resolve(caseUuid.toString());
 
         String caseName = Objects.requireNonNull(mpf.getOriginalFilename()).trim();

src/main/java/com/powsybl/caseserver/service/S3CaseService.java

@@ -336,9 +336,7 @@ public Set<String> listName(UUID caseUuid, String regex) {
     }
 
     @Override
-    public UUID importCase(MultipartFile mpf, boolean withExpiration, boolean withIndexation) {
-        UUID caseUuid = UUID.randomUUID();
-
+    public UUID importCase(MultipartFile mpf, boolean withExpiration, boolean withIndexation, UUID caseUuid) {
         String caseName = Objects.requireNonNull(mpf.getOriginalFilename());
         validateCaseName(caseName);
 

src/test/java/com/powsybl/caseserver/datasource/AbstractCaseDataSourceControllerTest.java

@@ -73,11 +73,11 @@ public abstract class AbstractCaseDataSourceControllerTest {
     protected DataSource iidmDataSource;
 
     protected static UUID importCase(String filename, String contentType) throws IOException {
-        UUID caseUUID;
+        UUID caseUuid = UUID.randomUUID();
         try (InputStream inputStream = S3CaseDataSourceControllerTest.class.getResourceAsStream("/" + filename)) {
-            caseUUID = caseService.importCase(new MockMultipartFile(filename, filename, contentType, inputStream.readAllBytes()), false, false);
+            caseService.importCase(new MockMultipartFile(filename, filename, contentType, inputStream.readAllBytes()), false, false, caseUuid);
         }
-        return caseUUID;
+        return caseUuid;
     }
 
     @Test

src/test/java/com/powsybl/caseserver/service/AbstractCaseControllerTest.java

@@ -66,6 +66,7 @@ abstract class AbstractCaseControllerTest {
     private static final String GET_CASE_FORMAT_URL = "/v1/cases/{caseName}/format";
 
     private static final UUID RANDOM_UUID = UUID.fromString("3e2b6777-fea5-4e76-9b6b-b68f151373ab");
+    private static final UUID CASE_UUID_TO_IMPORT = UUID.fromString("88601ab1-530e-47d2-8881-0dedecd6e6ee");
 
     @Autowired
     protected MockMvc mvc;
@@ -805,4 +806,28 @@ public void testTar() throws Exception {
         assertEquals(TEST_TAR_CASE, headersCase.get(CaseInfos.NAME_HEADER_KEY));
         assertEquals("XIIDM", headersCase.get(CaseInfos.FORMAT_HEADER_KEY));
     }
+
+    @Test
+    void testImportCaseWithUuid() throws Exception {
+        createStorageDir();
+
+        // import a case
+        mvc.perform(multipart("/v1/migration/cases")
+                        .file(createMockMultipartFile(TEST_CASE))
+                        .param("caseUuid", CASE_UUID_TO_IMPORT.toString()))
+                .andExpect(status().isOk());
+
+        // retrieve case format
+        mvc.perform(get(GET_CASE_FORMAT_URL, CASE_UUID_TO_IMPORT))
+                .andExpect(status().isOk())
+                .andExpect(content().string(TEST_CASE_FORMAT));
+
+        // import a case with existing UUID
+        mvc.perform(multipart("/v1/migration/cases")
+                        .file(createMockMultipartFile(TEST_CASE))
+                        .param("caseUuid", CASE_UUID_TO_IMPORT.toString()))
+                .andExpect(status().isConflict());
+
+        assertNotNull(outputDestination.receive(1000, caseImportDestination));
+    }
 }