Add debug mode to process execution

monitor-commons/src/main/java/org/gridsuite/monitor/commons/ProcessRunMessage.java

@@ -21,7 +21,8 @@ public record ProcessRunMessage<T extends ProcessConfig>(
     @JsonSubTypes({
         @JsonSubTypes.Type(value = SecurityAnalysisConfig.class, name = "SECURITY_ANALYSIS")
     })
-    T config
+    T config,
+    boolean isDebug
 ) {
     public ProcessType processType() {
         return config.processType();

monitor-commons/src/main/java/org/gridsuite/monitor/commons/utils/S3PathUtils.java

@@ -0,0 +1,28 @@
+/**
+ * Copyright (c) 2026, 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 org.gridsuite.monitor.commons.utils;
+
+import java.util.UUID;
+
+/**
+ * @author Kevin Le Saulnier <kevin.le-saulnier at rte-france.com>
+ */
+@SuppressWarnings("checkstyle:HideUtilityClassConstructor")
+public class S3PathUtils {
+    public static final String S3_DELIMITER = "/";
+
+    /**
+     * Builds root path used to build debug file location
+     * @param executionEnvName
+     * @param processType
+     * @param executionId
+     * @return {executionEnvName}_debug/process/{processType}/{executionId}
+     */
+    public static String toDebugLocation(String executionEnvName, String processType, UUID executionId) {
+        return String.join(S3_DELIMITER, executionEnvName + "_debug", "process", processType, executionId.toString());
+    }
+}

monitor-server/src/main/java/org/gridsuite/monitor/server/controllers/MonitorController.java

@@ -44,9 +44,10 @@ public MonitorController(MonitorService monitorService) {
     @ApiResponses(value = {@ApiResponse(responseCode = "200", description = "The security analysis execution has been started")})
     public ResponseEntity<UUID> executeSecurityAnalysis(
             @RequestParam UUID caseUuid,
+            @RequestParam(required = false, defaultValue = "false") boolean isDebug,
             @RequestBody SecurityAnalysisConfig securityAnalysisConfig,
             @RequestHeader(HEADER_USER_ID) String userId) {
-        UUID executionId = monitorService.executeProcess(caseUuid, userId, securityAnalysisConfig);
+        UUID executionId = monitorService.executeProcess(caseUuid, userId, securityAnalysisConfig, isDebug);
         return ResponseEntity.ok(executionId);
     }
 

monitor-server/src/main/java/org/gridsuite/monitor/server/entities/ProcessExecutionEntity.java

@@ -55,6 +55,12 @@ public class ProcessExecutionEntity {
     @Column
     private String userId;
 
+    @Column
+    private boolean isDebug;
+
+    @Column
+    private String debugFileLocation;
+
     @OneToMany(cascade = CascadeType.ALL, orphanRemoval = true, fetch = FetchType.EAGER)
     @JoinColumn(name = "execution_id", foreignKey = @ForeignKey(name = "processExecutionStep_processExecution_fk"))
     @OrderBy("stepOrder ASC")

monitor-server/src/main/java/org/gridsuite/monitor/server/services/MonitorService.java

@@ -11,6 +11,7 @@
 import org.gridsuite.monitor.commons.ProcessStatus;
 import org.gridsuite.monitor.commons.ProcessType;
 import org.gridsuite.monitor.commons.ResultInfos;
+import org.gridsuite.monitor.commons.utils.S3PathUtils;
 import org.gridsuite.monitor.server.dto.ProcessExecution;
 import org.gridsuite.monitor.server.dto.ReportPage;
 import org.gridsuite.monitor.server.entities.ProcessExecutionEntity;
@@ -49,17 +50,18 @@ public MonitorService(ProcessExecutionRepository executionRepository,
     }
 
     @Transactional
-    public UUID executeProcess(UUID caseUuid, String userId, ProcessConfig processConfig) {
+    public UUID executeProcess(UUID caseUuid, String userId, ProcessConfig processConfig, boolean isDebug) {
         ProcessExecutionEntity execution = ProcessExecutionEntity.builder()
             .type(processConfig.processType().name())
             .caseUuid(caseUuid)
             .status(ProcessStatus.SCHEDULED)
             .scheduledAt(Instant.now())
             .userId(userId)
+            .isDebug(isDebug)
             .build();
         executionRepository.save(execution);
 
-        notificationService.sendProcessRunMessage(caseUuid, processConfig, execution.getId());
+        notificationService.sendProcessRunMessage(caseUuid, processConfig, isDebug, execution.getId());
 
         return execution.getId();
     }
@@ -77,6 +79,10 @@ public void updateExecutionStatus(UUID executionId, ProcessStatus status, String
             if (completedAt != null) {
                 execution.setCompletedAt(completedAt);
             }
+            if (execution.isDebug() && executionEnvName != null
+                && (status.equals(ProcessStatus.COMPLETED) || status.equals(ProcessStatus.FAILED))) {
+                execution.setDebugFileLocation(S3PathUtils.toDebugLocation(executionEnvName, execution.getType(), executionId));
+            }
             executionRepository.save(execution);
         });
     }

monitor-server/src/main/java/org/gridsuite/monitor/server/services/NotificationService.java

@@ -23,11 +23,11 @@ public class NotificationService {
 
     private final StreamBridge publisher;
 
-    public void sendProcessRunMessage(UUID caseUuid, ProcessConfig processConfig, UUID executionId) {
+    public void sendProcessRunMessage(UUID caseUuid, ProcessConfig processConfig, boolean isDebug, UUID executionId) {
         String bindingName = switch (processConfig.processType()) {
             case SECURITY_ANALYSIS -> "publishRunSecurityAnalysis-out-0";
         };
-        ProcessRunMessage<?> message = new ProcessRunMessage<>(executionId, caseUuid, processConfig);
+        ProcessRunMessage<?> message = new ProcessRunMessage<>(executionId, caseUuid, processConfig, isDebug);
         publisher.send(bindingName, message);
     }
 }

monitor-server/src/main/resources/db/changelog/changesets/changelog_20260212T082157Z.xml

@@ -0,0 +1,15 @@
+<?xml version="1.1" encoding="UTF-8" standalone="no"?>
+<databaseChangeLog xmlns="http://www.liquibase.org/xml/ns/dbchangelog" xmlns:ext="http://www.liquibase.org/xml/ns/dbchangelog-ext" xmlns:pro="http://www.liquibase.org/xml/ns/pro" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog-ext http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-ext.xsd http://www.liquibase.org/xml/ns/pro http://www.liquibase.org/xml/ns/pro/liquibase-pro-latest.xsd http://www.liquibase.org/xml/ns/dbchangelog http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-latest.xsd">
+    <changeSet author="lesaulnierkev (generated)" id="1770884531328-1">
+        <addColumn tableName="process_execution">
+            <column name="debug_file_location" type="varchar(255)"/>
+        </addColumn>
+    </changeSet>
+    <changeSet author="lesaulnierkev (generated)" id="1770884531328-2">
+        <addColumn tableName="process_execution">
+            <column name="is_debug" type="boolean" defaultValueBoolean="false">
+                <constraints nullable="false"/>
+            </column>
+        </addColumn>
+    </changeSet>
+</databaseChangeLog>

monitor-server/src/main/resources/db/changelog/db.changelog-master.yaml

@@ -8,4 +8,6 @@ databaseChangeLog:
   - include:
       file: changesets/changelog_20260130T160426Z.xml
       relativeToChangelogFile: true
-
+  - include:
+      file: changesets/changelog_20260212T082157Z.xml
+      relativeToChangelogFile: true

monitor-server/src/test/java/org/gridsuite/monitor/server/MonitorIntegrationTest.java

@@ -102,7 +102,7 @@ void securityAnalysisProcessIT() throws Exception {
                 UUID.randomUUID(),
                 List.of("contingency1", "contingency2"),
                 List.of(UUID.randomUUID()));
-        UUID executionId = monitorService.executeProcess(caseUuid, userId, securityAnalysisConfig);
+        UUID executionId = monitorService.executeProcess(caseUuid, userId, securityAnalysisConfig, false);
 
         // Verify message was published
         Message<byte[]> sentMessage = outputDestination.receive(1000, PROCESS_SA_RUN_DESTINATION);

monitor-server/src/test/java/org/gridsuite/monitor/server/controllers/MonitorControllerTest.java

@@ -18,11 +18,15 @@
 import org.gridsuite.monitor.server.dto.Severity;
 import org.gridsuite.monitor.server.services.MonitorService;
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.NullSource;
+import org.junit.jupiter.params.provider.ValueSource;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
 import org.springframework.http.MediaType;
 import org.springframework.test.context.bean.override.mockito.MockitoBean;
 import org.springframework.test.web.servlet.MockMvc;
+import org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder;
 
 import java.time.Instant;
 import java.util.List;
@@ -54,8 +58,10 @@ class MonitorControllerTest {
     @MockitoBean
     private MonitorService monitorService;
 
-    @Test
-    void executeSecurityAnalysisShouldReturnExecutionId() throws Exception {
+    @ParameterizedTest
+    @ValueSource(booleans = {true, false})
+    @NullSource
+    void executeSecurityAnalysisShouldReturnExecutionId(Boolean isDebug) throws Exception {
         UUID caseUuid = UUID.randomUUID();
         UUID parametersUuid = UUID.randomUUID();
         UUID modificationUuid = UUID.randomUUID();
@@ -65,20 +71,27 @@ void executeSecurityAnalysisShouldReturnExecutionId() throws Exception {
                 List.of("contingency1", "contingency2"),
                 List.of(modificationUuid)
         );
+        boolean expectedDebugValue = Boolean.TRUE.equals(isDebug);
 
-        when(monitorService.executeProcess(any(UUID.class), any(String.class), any(SecurityAnalysisConfig.class)))
+        when(monitorService.executeProcess(any(UUID.class), any(String.class), any(SecurityAnalysisConfig.class), eq(expectedDebugValue)))
                 .thenReturn(executionId);
 
-        mockMvc.perform(post("/v1/execute/security-analysis")
-                        .param("caseUuid", caseUuid.toString())
-                        .header("userId", "user1")
-                        .contentType(MediaType.APPLICATION_JSON)
-                        .content(objectMapper.writeValueAsString(config)))
-                .andExpect(status().isOk())
-                .andExpect(content().contentType(MediaType.APPLICATION_JSON))
-                .andExpect(jsonPath("$").value(executionId.toString()));
+        MockHttpServletRequestBuilder request = post("/v1/execute/security-analysis")
+            .param("caseUuid", caseUuid.toString())
+            .header("userId", "user1")
+            .contentType(MediaType.APPLICATION_JSON)
+            .content(objectMapper.writeValueAsString(config));
+
+        if (isDebug != null) {
+            request.param("isDebug", isDebug.toString());
+        }
+
+        mockMvc.perform(request)
+            .andExpect(status().isOk())
+            .andExpect(content().contentType(MediaType.APPLICATION_JSON))
+            .andExpect(jsonPath("$").value(executionId.toString()));
 
-        verify(monitorService).executeProcess(eq(caseUuid), any(String.class), any(SecurityAnalysisConfig.class));
+        verify(monitorService).executeProcess(eq(caseUuid), any(String.class), any(SecurityAnalysisConfig.class), eq(expectedDebugValue));
     }
 
     @Test

monitor-server/src/test/java/org/gridsuite/monitor/server/services/MonitorServiceTest.java

@@ -7,6 +7,7 @@
 package org.gridsuite.monitor.server.services;
 
 import org.gridsuite.monitor.commons.*;
+import org.gridsuite.monitor.commons.utils.S3PathUtils;
 import org.gridsuite.monitor.server.dto.ProcessExecution;
 import org.gridsuite.monitor.server.dto.ReportLog;
 import org.gridsuite.monitor.server.dto.ReportPage;
@@ -17,6 +18,9 @@
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.EnumSource;
+import org.junit.jupiter.params.provider.ValueSource;
 import org.mockito.InjectMocks;
 import org.mockito.Mock;
 import org.mockito.junit.jupiter.MockitoExtension;
@@ -69,8 +73,9 @@ void setUp() {
         );
     }
 
-    @Test
-    void executeProcessCreateExecutionAndSendNotification() {
+    @ParameterizedTest
+    @ValueSource(booleans = {true, false})
+    void executeProcessCreateExecutionAndSendNotification(boolean isDebug) {
         UUID expectedExecutionId = UUID.randomUUID();
         when(executionRepository.save(any(ProcessExecutionEntity.class)))
                 .thenAnswer(invocation -> {
@@ -79,7 +84,7 @@ void executeProcessCreateExecutionAndSendNotification() {
                     return entity;
                 });
 
-        UUID result = monitorService.executeProcess(caseUuid, userId, securityAnalysisConfig);
+        UUID result = monitorService.executeProcess(caseUuid, userId, securityAnalysisConfig, isDebug);
 
         assertThat(result).isNotNull();
         verify(executionRepository).save(argThat(execution ->
@@ -94,6 +99,7 @@ void executeProcessCreateExecutionAndSendNotification() {
         verify(notificationService).sendProcessRunMessage(
                 caseUuid,
                 securityAnalysisConfig,
+                isDebug,
                 result
         );
     }
@@ -145,6 +151,62 @@ void updateExecutionStatusShouldUpdateAllFields() {
         verify(executionRepository).save(execution);
     }
 
+    @ParameterizedTest
+    @EnumSource(value = ProcessStatus.class, names = {"COMPLETED", "FAILED"})
+    void updateExecutionStatusWithDebugOnAndProcessStatusDoneShouldUpdateDebugLocation(ProcessStatus processStatus) {
+        ProcessExecutionEntity execution = ProcessExecutionEntity.builder()
+            .id(executionId)
+            .type(ProcessType.SECURITY_ANALYSIS.name())
+            .caseUuid(caseUuid)
+            .userId(userId)
+            .status(ProcessStatus.RUNNING)
+            .scheduledAt(Instant.now())
+            .isDebug(true)
+            .build();
+        when(executionRepository.findById(executionId)).thenReturn(Optional.of(execution));
+        String envName = "production-env";
+        Instant startedAt = Instant.now().minusSeconds(60);
+        Instant completedAt = Instant.now();
+
+        monitorService.updateExecutionStatus(executionId, processStatus, envName, startedAt, completedAt);
+
+        verify(executionRepository).findById(executionId);
+        // assert standard fields
+        assertThat(execution.getStatus()).isEqualTo(processStatus);
+        assertThat(execution.getExecutionEnvName()).isEqualTo(envName);
+        assertThat(execution.getStartedAt()).isEqualTo(startedAt);
+        assertThat(execution.getCompletedAt()).isEqualTo(completedAt);
+
+        // assert debug location field
+        assertThat(execution.getDebugFileLocation()).isEqualTo(S3PathUtils.toDebugLocation(envName, ProcessType.SECURITY_ANALYSIS.name(), executionId));
+        verify(executionRepository).save(execution);
+    }
+
+    @ParameterizedTest
+    @EnumSource(value = ProcessStatus.class, names = {"RUNNING", "SCHEDULED"})
+    void updateExecutionStatusWithDebugOnAndProcessStatusNotDoneShouldNotUpdateDebugLocation(ProcessStatus processStatus) {
+        ProcessExecutionEntity execution = ProcessExecutionEntity.builder()
+            .id(executionId)
+            .type(ProcessType.SECURITY_ANALYSIS.name())
+            .caseUuid(caseUuid)
+            .userId(userId)
+            .status(ProcessStatus.RUNNING)
+            .scheduledAt(Instant.now())
+            .isDebug(true)
+            .build();
+        when(executionRepository.findById(executionId)).thenReturn(Optional.of(execution));
+        String envName = "production-env";
+        Instant startedAt = Instant.now().minusSeconds(60);
+        Instant completedAt = Instant.now();
+
+        monitorService.updateExecutionStatus(executionId, processStatus, envName, startedAt, completedAt);
+
+        verify(executionRepository).findById(executionId);
+        // assert debug location field
+        assertThat(execution.getDebugFileLocation()).isNull();
+        verify(executionRepository).save(execution);
+    }
+
     @Test
     void updateExecutionStatusShouldHandleExecutionNotFound() {
         when(executionRepository.findById(executionId)).thenReturn(Optional.empty());

monitor-server/src/test/java/org/gridsuite/monitor/server/services/NotificationServiceTest.java

@@ -9,8 +9,9 @@
 import org.gridsuite.monitor.commons.ProcessRunMessage;
 import org.gridsuite.monitor.commons.SecurityAnalysisConfig;
 import org.junit.jupiter.api.BeforeEach;
-import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.ValueSource;
 import org.mockito.InjectMocks;
 import org.mockito.Mock;
 import org.mockito.junit.jupiter.MockitoExtension;
@@ -53,16 +54,18 @@ void setUp() {
         );
     }
 
-    @Test
-    void sendProcessRunMessage() {
-        notificationService.sendProcessRunMessage(caseUuid, securityAnalysisConfig, executionId);
+    @ParameterizedTest
+    @ValueSource(booleans = {true, false})
+    void sendProcessRunMessage(boolean isDebug) {
+        notificationService.sendProcessRunMessage(caseUuid, securityAnalysisConfig, isDebug, executionId);
 
         verify(publisher).send(
                 eq("publishRunSecurityAnalysis-out-0"),
                 argThat((ProcessRunMessage<?> message) ->
                         message.executionId().equals(executionId) &&
                         message.caseUuid().equals(caseUuid) &&
-                        message.config().equals(securityAnalysisConfig))
+                        message.config().equals(securityAnalysisConfig) &&
+                        message.isDebug() == isDebug)
         );
     }
 }

monitor-worker-server/pom.xml

@@ -14,6 +14,7 @@
 
     <properties>
         <network-modification.version>0.61.0</network-modification.version>
+        <spring-cloud-aws-starter-s3>3.3.1</spring-cloud-aws-starter-s3>
     </properties>
 
     <build>
@@ -108,6 +109,11 @@
             <groupId>com.powsybl</groupId>
             <artifactId>powsybl-case-datasource-client</artifactId>
         </dependency>
+        <dependency>
+            <groupId>io.awspring.cloud</groupId>
+            <artifactId>spring-cloud-aws-starter-s3</artifactId>
+            <version>${spring-cloud-aws-starter-s3}</version>
+        </dependency>
 
         <!-- Runtime dependencies -->
         <dependency>