Add Endpoint to importCase from s3 directrory by basseche · Pull Request #143 · powsybl/powsybl-case-server

basseche · 2026-01-07T13:15:56Z

Please check if the PR fulfills these requirements

The commit message follows our guidelines
Tests for the changes have been added (for bug fixes / features)
Docs have been added / updated (for bug fixes / features)
A PR or issue has been opened in all impacted repositories (if any)

Does this PR already have an issue describing the problem?
No.

What kind of change does this PR introduce?
Feature

What is the current behavior?
Cases can be imported from a file.

What is the new behavior (if this is a feature change)?
Cases can be imported also from an s3 key now.

Does this PR introduce a breaking change or deprecate an API?

Yes
No

Signed-off-by: basseche <bassel.el-cheikh_externe@rte-france.com>

… from S3 Signed-off-by: basseche <bassel.el-cheikh_externe@rte-france.com>

Signed-off-by: basseche <bassel.el-cheikh_externe@rte-france.com>

thangqp · 2026-01-15T08:19:31Z

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

+                .param("fileName", fileName))
+            .andExpect(status().isOk());
+
+        assertNotNull(outputDestination.receive(1000, caseImportDestination));


You can check content of notification,

THEN getObjet from s3 then check file size from resource and file size from s3

thangqp · 2026-01-15T08:20:29Z

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

+                .param("caseUuid", caseUuid.toString())
+                .param("folderName", folderName)
+                .param("fileName", fileName))
+            .andExpect(status().isInternalServerError());


Should detail which message error expected and why for example, bad folder name

thangqp · 2026-01-15T08:25:16Z

src/test/resources/zippedTestCase.zip

should be named as testCase.zip ?

No! If i do that another test will fail in another test file.

Yes, there's a weird behavior with datasources.
But test(2)Case.xiidm was to test a specific bug.
Name it zippedTestCase.zip and it will work

src/main/java/com/powsybl/caseserver/datasource/utils/S3MultiPartFile.java

…artFile.java Co-authored-by: Thang PHAM <117309322+thangqp@users.noreply.github.com> Signed-off-by: basseche <bassel.el-cheikh_externe@rte-france.com>

etiennehomer · 2026-01-16T10:04:36Z

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

+        @RequestParam(value = "withExpiration", required = false, defaultValue = "false") boolean withExpiration,
+        @RequestParam(value = "withIndexation", required = false, defaultValue = "false") boolean withIndexation) {
+
+        try (S3MultiPartFile mpf = new S3MultiPartFile(caseService, caseUuid, folderName, fileName + ZIP_EXTENSION, "application/zip")) {


Move this code to the service.
Just keep something like :
UUID uuid = caseService.importCaseFromS3(....)
return ResponseEntity.ok().body(uuid);

etiennehomer · 2026-01-16T10:15:29Z

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

+        @ApiResponse(responseCode = "404", description = "Source case not found"),
+        @ApiResponse(responseCode = "500", description = "An error occurred during the case file creation")})
+    public ResponseEntity<UUID> createCase(
+        @RequestParam("caseUuid") UUID caseUuid,


caseUuid, folderName are too specific to exportNetwork structure.
You can give only one parameter folderKey

And you fill the filename something like new Path(caseKey).getFileName()

etiennehomer · 2026-01-16T10:25:29Z

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

+        @RequestParam(value = "withExpiration", required = false, defaultValue = "false") boolean withExpiration,
+        @RequestParam(value = "withIndexation", required = false, defaultValue = "false") boolean withIndexation) {
+
+        try (S3MultiPartFile mpf = new S3MultiPartFile(caseService, caseUuid, folderName, fileName + ZIP_EXTENSION, "application/zip")) {


Do not give the service to the S3MultiPartFile constructor. It's a bad practice.
Write the file on /tmp in the service. And then only give the Path to the constructor

the problem is if we don't do that we have to manage file lifecycle (create, delete) each time from outside

src/main/java/com/powsybl/caseserver/datasource/utils/S3MultiPartFile.java

etiennehomer · 2026-01-16T12:28:39Z

src/main/java/com/powsybl/caseserver/datasource/utils/S3MultiPartFile.java

+
+    @Override
+    public void transferTo(File dest) throws IOException, IllegalStateException {
+        Files.copy(tempFile, dest.toPath(), StandardCopyOption.REPLACE_EXISTING);


throw new UnsupportedOperationException("Not supported.");

or

transferTo(dest.toPath());
?

etiennehomer · 2026-01-16T12:31:19Z

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

        return UUID.fromString(keyWithoutRootDirectory.substring(0, firstSlash));
    }

+    public Optional<InputStream> getInputStreamFromS3(UUID caseUuid, String folderName, String fileName) {


duplicated code from getCaseStream(). Code to put in common in a method

…artFile.java Co-authored-by: etiennehomer <etiennehomer@gmail.com> Signed-off-by: basseche <bassel.el-cheikh_externe@rte-france.com>

Signed-off-by: basseche <bassel.el-cheikh_externe@rte-france.com>

etiennehomer · 2026-01-22T11:38:25Z

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

    }

+    public UUID importCase(String folderKey, String contentType, boolean withExpiration, boolean withIndexation) throws IOException {
+


no empty row

etiennehomer · 2026-01-22T11:39:17Z

src/main/java/com/powsybl/caseserver/datasource/utils/S3MultiPartFile.java

+
+    private final String name;
+    private final String contentType;
+    private final CaseService caseService;


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

src/main/java/com/powsybl/caseserver/datasource/utils/S3MultiPartFile.java

etiennehomer · 2026-01-22T13:19:03Z

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

        return caseUuid;
    }

+    public UUID importCase(String folderKey, String contentType, boolean withExpiration, boolean withIndexation) throws IOException {


Suggested change

public UUID importCase(String folderKey, String contentType, boolean withExpiration, boolean withIndexation) throws IOException {

public UUID importCase(String caseFileKey, String contentType, boolean withExpiration, boolean withIndexation) throws IOException {

etiennehomer · 2026-01-22T13:22:54Z

src/test/resources/zippedTestCase.zip

Yes, there's a weird behavior with datasources.
But test(2)Case.xiidm was to test a specific bug.
Name it zippedTestCase.zip and it will work

Signed-off-by: basseche <bassel.el-cheikh_externe@rte-france.com>

Co-authored-by: etiennehomer <etiennehomer@gmail.com> Signed-off-by: basseche <bassel.el-cheikh_externe@rte-france.com>

…artFile.java Co-authored-by: etiennehomer <etiennehomer@gmail.com> Signed-off-by: basseche <bassel.el-cheikh_externe@rte-france.com>

Signed-off-by: basseche <bassel.el-cheikh_externe@rte-france.com>

etiennehomer · 2026-01-22T14:13:21Z

src/main/java/com/powsybl/caseserver/datasource/utils/S3MultiPartFile.java

+ * @author Bassel El Cheikh <bassel.el-cheikh_externe at rte-france.com>
+ */
+
+public class S3MultiPartFile implements MultipartFile, Closeable {


Suggested change

public class S3MultiPartFile implements MultipartFile, Closeable {

public class TmpMultiPartFile implements MultipartFile, Closeable {

As there is no more S3 notion in this class now

Signed-off-by: basseche <bassel.el-cheikh_externe@rte-france.com>

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

Signed-off-by: basseche <bassel.el-cheikh_externe@rte-france.com>

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

Signed-off-by: basseche <bassel.el-cheikh_externe@rte-france.com>

Co-authored-by: etiennehomer <etiennehomer@gmail.com> Signed-off-by: basseche <bassel.el-cheikh_externe@rte-france.com>

sonarqubecloud · 2026-01-23T13:52:51Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
88.5% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

basseche force-pushed the Import_Case_From_S3 branch from 76060e4 to df048e9 Compare January 7, 2026 16:42

basseche self-assigned this Jan 8, 2026

basseche force-pushed the Import_Case_From_S3 branch 2 times, most recently from 73d9dd2 to 88313fd Compare January 8, 2026 09:43

Add Endpoint to importCase from s3 directrory

ca19182

Signed-off-by: basseche <bassel.el-cheikh_externe@rte-france.com>

basseche force-pushed the Import_Case_From_S3 branch from 88313fd to ca19182 Compare January 8, 2026 09:46

basseche added 10 commits January 8, 2026 10:48

fix checkstyle issus

2665573

Signed-off-by: basseche <bassel.el-cheikh_externe@rte-france.com>

add copyright

d6342f1

Signed-off-by: basseche <bassel.el-cheikh_externe@rte-france.com>

improvements

6581bae

Signed-off-by: basseche <bassel.el-cheikh_externe@rte-france.com>

update param list

045c9af

Signed-off-by: basseche <bassel.el-cheikh_externe@rte-france.com>

Improve memory usage by S3MultiPartFile

6de831f

Signed-off-by: basseche <bassel.el-cheikh_externe@rte-france.com>

Create temporary file in s3MultiPartFile instead of reading each time…

d411a5c

… from S3 Signed-off-by: basseche <bassel.el-cheikh_externe@rte-france.com>

Add test for new Endpoint

773789a

Signed-off-by: basseche <bassel.el-cheikh_externe@rte-france.com>

Merge branch 'main' into Import_Case_From_S3

9477539

add tests

e2ae114

Signed-off-by: basseche <bassel.el-cheikh_externe@rte-france.com>

Fix tests

4251db0

Signed-off-by: basseche <bassel.el-cheikh_externe@rte-france.com>

basseche force-pushed the Import_Case_From_S3 branch from 1dec525 to 4251db0 Compare January 14, 2026 17:33

Increase tests coverage and resolve hotspot security issue

f1eec67

Signed-off-by: basseche <bassel.el-cheikh_externe@rte-france.com>

basseche force-pushed the Import_Case_From_S3 branch from f77494c to f1eec67 Compare January 14, 2026 18:23

basseche requested review from etiennehomer and thangqp January 14, 2026 18:24

Increase tests coverage 2

95a6344

Signed-off-by: basseche <bassel.el-cheikh_externe@rte-france.com>

thangqp reviewed Jan 15, 2026

View reviewed changes

src/main/java/com/powsybl/caseserver/datasource/utils/S3MultiPartFile.java Outdated Show resolved Hide resolved

Update src/main/java/com/powsybl/caseserver/datasource/utils/S3MultiP…

944dea0

…artFile.java Co-authored-by: Thang PHAM <117309322+thangqp@users.noreply.github.com> Signed-off-by: basseche <bassel.el-cheikh_externe@rte-france.com>

etiennehomer requested changes Jan 16, 2026

View reviewed changes

src/main/java/com/powsybl/caseserver/datasource/utils/S3MultiPartFile.java Outdated Show resolved Hide resolved

etiennehomer reviewed Jan 16, 2026

View reviewed changes

etiennehomer requested changes Jan 16, 2026

View reviewed changes

basseche and others added 7 commits January 16, 2026 15:51

Update src/main/java/com/powsybl/caseserver/datasource/utils/S3MultiP…

3fcade6

…artFile.java Co-authored-by: etiennehomer <etiennehomer@gmail.com> Signed-off-by: basseche <bassel.el-cheikh_externe@rte-france.com>

Review

30937fa

Signed-off-by: basseche <bassel.el-cheikh_externe@rte-france.com>

checkstyle

3ec46cb

Signed-off-by: basseche <bassel.el-cheikh_externe@rte-france.com>

Fix test

f41f454

Signed-off-by: basseche <bassel.el-cheikh_externe@rte-france.com>

fix tests 2

f7df72f

Signed-off-by: basseche <bassel.el-cheikh_externe@rte-france.com>

Review

8a5dd1b

Signed-off-by: basseche <bassel.el-cheikh_externe@rte-france.com>

Merge branch 'main' into Import_Case_From_S3

124f4e6

etiennehomer requested changes Jan 22, 2026

View reviewed changes

basseche and others added 4 commits January 22, 2026 14:46

changes on S3MultiPartFile

377e51a

Signed-off-by: basseche <bassel.el-cheikh_externe@rte-france.com>

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

1a1c065

Co-authored-by: etiennehomer <etiennehomer@gmail.com> Signed-off-by: basseche <bassel.el-cheikh_externe@rte-france.com>

Update src/main/java/com/powsybl/caseserver/datasource/utils/S3MultiP…

9ae6fa2

…artFile.java Co-authored-by: etiennehomer <etiennehomer@gmail.com> Signed-off-by: basseche <bassel.el-cheikh_externe@rte-france.com>

review

3842a7c

Signed-off-by: basseche <bassel.el-cheikh_externe@rte-france.com>

etiennehomer requested changes Jan 22, 2026

View reviewed changes

basseche added 2 commits January 22, 2026 15:19

fix

3d3f244

Signed-off-by: basseche <bassel.el-cheikh_externe@rte-france.com>

review

f199c41

Signed-off-by: basseche <bassel.el-cheikh_externe@rte-france.com>

etiennehomer requested changes Jan 23, 2026

View reviewed changes

src/main/java/com/powsybl/caseserver/CaseController.java Outdated Show resolved Hide resolved

Add observer

3b199ab

Signed-off-by: basseche <bassel.el-cheikh_externe@rte-france.com>

etiennehomer requested changes Jan 23, 2026

View reviewed changes

src/main/java/com/powsybl/caseserver/CaseController.java Outdated Show resolved Hide resolved

basseche and others added 2 commits January 23, 2026 11:44

modify endpoint

ac4d82e

Signed-off-by: basseche <bassel.el-cheikh_externe@rte-france.com>

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

bfb1e2b

Co-authored-by: etiennehomer <etiennehomer@gmail.com> Signed-off-by: basseche <bassel.el-cheikh_externe@rte-france.com>

etiennehomer approved these changes Jan 23, 2026

View reviewed changes

etiennehomer merged commit c43eb13 into main Jan 23, 2026
5 checks passed

etiennehomer deleted the Import_Case_From_S3 branch January 23, 2026 17:09

		}

		public UUID importCase(String folderKey, String contentType, boolean withExpiration, boolean withIndexation) throws IOException {

	public UUID importCase(String folderKey, String contentType, boolean withExpiration, boolean withIndexation) throws IOException {
	public UUID importCase(String caseFileKey, String contentType, boolean withExpiration, boolean withIndexation) throws IOException {

	public class S3MultiPartFile implements MultipartFile, Closeable {
	public class TmpMultiPartFile implements MultipartFile, Closeable {

Comments

Conversation

basseche commented Jan 7, 2026 • edited by etiennehomer Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

thangqp Jan 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

basseche Jan 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

etiennehomer Jan 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

basseche Jan 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud bot commented Jan 23, 2026

Quality Gate passed

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

basseche commented Jan 7, 2026 •

edited by etiennehomer

Loading

thangqp Jan 15, 2026 •

edited

Loading

basseche Jan 15, 2026 •

edited

Loading

etiennehomer Jan 16, 2026 •

edited

Loading

basseche Jan 16, 2026 •

edited

Loading