rectify code from Bassel comments

thangqp · thangqp · commit 4ab17ba9130d · 2025-02-05T16:41:34.000+01:00
Signed-off-by: Thang PHAM &lt;phamthang37@gmail.com&gt;
diff --git a/src/main/java/org/gridsuite/dynamicsecurityanalysis/server/config/RestTemplateConfig.java b/src/main/java/org/gridsuite/dynamicsecurityanalysis/server/config/RestTemplateConfig.java
@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2024, RTE (http://www.rte-france.com)
+ * 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/.
diff --git a/src/main/java/org/gridsuite/dynamicsecurityanalysis/server/controller/DynamicSecurityAnalysisController.java b/src/main/java/org/gridsuite/dynamicsecurityanalysis/server/controller/DynamicSecurityAnalysisController.java
@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2024, RTE (http://www.rte-france.com)
+ * 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/.
diff --git a/src/main/java/org/gridsuite/dynamicsecurityanalysis/server/dto/contingency/ContingencyInfos.java b/src/main/java/org/gridsuite/dynamicsecurityanalysis/server/dto/contingency/ContingencyInfos.java
@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2024, RTE (http://www.rte-france.com)
+ * 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/.
diff --git a/src/main/java/org/gridsuite/dynamicsecurityanalysis/server/dto/parameters/DynamicSecurityAnalysisParametersInfos.java b/src/main/java/org/gridsuite/dynamicsecurityanalysis/server/dto/parameters/DynamicSecurityAnalysisParametersInfos.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2024, RTE (http://www.rte-france.com)
+ * 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/.
diff --git a/src/main/java/org/gridsuite/dynamicsecurityanalysis/server/entities/DynamicSecurityAnalysisResultEntity.java b/src/main/java/org/gridsuite/dynamicsecurityanalysis/server/entities/DynamicSecurityAnalysisResultEntity.java
@@ -31,7 +31,7 @@ public DynamicSecurityAnalysisResultEntity(UUID id, DynamicSecurityAnalysisStatu
     }
 
     @Id
-    @Column(name = "resultUuid")
+    @Column(name = "result_uuid")
     private UUID id;
 
     @Column(name = "status")
diff --git a/src/main/java/org/gridsuite/dynamicsecurityanalysis/server/entities/parameters/DynamicSecurityAnalysisParametersEntity.java b/src/main/java/org/gridsuite/dynamicsecurityanalysis/server/entities/parameters/DynamicSecurityAnalysisParametersEntity.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2024, RTE (http://www.rte-france.com)
+ * 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/.
@@ -24,7 +24,7 @@
 @Getter
 @Setter
 @Entity
-@Table(name = "dynamicSecurityAnalysisParameters")
+@Table(name = "dynamic_security_analysis_parameters")
 public class DynamicSecurityAnalysisParametersEntity {
     @Id
     @GeneratedValue(strategy = GenerationType.AUTO)
@@ -34,10 +34,10 @@ public class DynamicSecurityAnalysisParametersEntity {
     @Column(name = "provider")
     private String provider;
 
-    @Column(name = "scenarioDuration")
+    @Column(name = "scenario_duration")
     private Double scenarioDuration;
 
-    @Column(name = "contingenciesStartTime")
+    @Column(name = "contingencies_start_time")
     private Double contingenciesStartTime;
 
     @ElementCollection(fetch = FetchType.EAGER)
diff --git a/src/main/java/org/gridsuite/dynamicsecurityanalysis/server/repositories/DynamicSecurityAnalysisParametersRepository.java b/src/main/java/org/gridsuite/dynamicsecurityanalysis/server/repositories/DynamicSecurityAnalysisParametersRepository.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2024, RTE (http://www.rte-france.com)
+ * 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/.
diff --git a/src/main/java/org/gridsuite/dynamicsecurityanalysis/server/service/DynamicSecurityAnalysisObserver.java b/src/main/java/org/gridsuite/dynamicsecurityanalysis/server/service/DynamicSecurityAnalysisObserver.java
@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2024, RTE (http://www.rte-france.com)
+ * 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/.
diff --git a/src/main/java/org/gridsuite/dynamicsecurityanalysis/server/service/DynamicSecurityAnalysisService.java b/src/main/java/org/gridsuite/dynamicsecurityanalysis/server/service/DynamicSecurityAnalysisService.java
@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2024, RTE (http://www.rte-france.com)
+ * 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/.
diff --git a/src/main/java/org/gridsuite/dynamicsecurityanalysis/server/service/DynamicSecurityAnalysisWorkerService.java b/src/main/java/org/gridsuite/dynamicsecurityanalysis/server/service/DynamicSecurityAnalysisWorkerService.java
@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2021, RTE (http://www.rte-france.com)
+ * 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/.
@@ -228,9 +228,9 @@ public Consumer<Message<String>> consumeCancel() {
     @Override
     protected void clean(AbstractResultContext<DynamicSecurityAnalysisRunContext> resultContext) {
         super.clean(resultContext);
-//        // clean working directory
-//        Path workDir = resultContext.getRunContext().getWorkDir();
-//        removeWorkingDirectory(workDir);
+        // clean working directory
+        Path workDir = resultContext.getRunContext().getWorkDir();
+        removeWorkingDirectory(workDir);
     }
 
     private Path createWorkingDirectory() {
diff --git a/src/main/java/org/gridsuite/dynamicsecurityanalysis/server/service/ParametersService.java b/src/main/java/org/gridsuite/dynamicsecurityanalysis/server/service/ParametersService.java
@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2024, RTE (http://www.rte-france.com)
+ * 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/.
diff --git a/src/main/java/org/gridsuite/dynamicsecurityanalysis/server/service/client/AbstractRestClient.java b/src/main/java/org/gridsuite/dynamicsecurityanalysis/server/service/client/AbstractRestClient.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2024, RTE (http://www.rte-france.com)
+ * 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/.
@@ -8,6 +8,7 @@
 package org.gridsuite.dynamicsecurityanalysis.server.service.client;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
+import lombok.Getter;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.web.client.RestTemplate;
@@ -19,10 +20,13 @@ public abstract class AbstractRestClient {
 
     protected final Logger logger = LoggerFactory.getLogger(this.getClass());
 
+    @Getter
     private final RestTemplate restTemplate;
 
+    @Getter
     private final String baseUri;
 
+    @Getter
     private final ObjectMapper objectMapper;
 
     protected AbstractRestClient(String baseUri, RestTemplate restTemplate, ObjectMapper objectMapper) {
@@ -31,15 +35,4 @@ protected AbstractRestClient(String baseUri, RestTemplate restTemplate, ObjectMa
         this.objectMapper = objectMapper;
     }
 
-    public RestTemplate getRestTemplate() {
-        return restTemplate;
-    }
-
-    public ObjectMapper getObjectMapper() {
-        return objectMapper;
-    }
-
-    public String getBaseUri() {
-        return baseUri;
-    }
 }
diff --git a/src/main/java/org/gridsuite/dynamicsecurityanalysis/server/service/client/ActionsClient.java b/src/main/java/org/gridsuite/dynamicsecurityanalysis/server/service/client/ActionsClient.java
@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2020, RTE (http://www.rte-france.com)
+ * 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/.
@@ -32,7 +32,7 @@
 import static org.gridsuite.dynamicsecurityanalysis.server.service.client.utils.UrlUtils.buildEndPointUrl;
 
 /**
- * @author Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>
+ * @author Thang PHAM <quyet-thang.pham at rte-france.com>
  */
 @Service
 public class ActionsClient extends AbstractRestClient {
diff --git a/src/main/java/org/gridsuite/dynamicsecurityanalysis/server/service/client/DynamicSimulationClient.java b/src/main/java/org/gridsuite/dynamicsecurityanalysis/server/service/client/DynamicSimulationClient.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2024, RTE (http://www.rte-france.com)
+ * 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/.
diff --git a/src/main/java/org/gridsuite/dynamicsecurityanalysis/server/service/client/utils/UrlUtils.java b/src/main/java/org/gridsuite/dynamicsecurityanalysis/server/service/client/utils/UrlUtils.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2024, RTE (http://www.rte-france.com)
+ * 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/.
diff --git a/src/main/java/org/gridsuite/dynamicsecurityanalysis/server/service/contexts/DynamicSecurityAnalysisResultContext.java b/src/main/java/org/gridsuite/dynamicsecurityanalysis/server/service/contexts/DynamicSecurityAnalysisResultContext.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2024, RTE (http://www.rte-france.com)
+ * 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/.
diff --git a/src/main/java/org/gridsuite/dynamicsecurityanalysis/server/service/contexts/DynamicSecurityAnalysisRunContext.java b/src/main/java/org/gridsuite/dynamicsecurityanalysis/server/service/contexts/DynamicSecurityAnalysisRunContext.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2021-2023, RTE (http://www.rte-france.com)
+ * 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/.
diff --git a/src/main/java/org/gridsuite/dynamicsecurityanalysis/server/utils/Utils.java b/src/main/java/org/gridsuite/dynamicsecurityanalysis/server/utils/Utils.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023, RTE (http://www.rte-france.com)
+ * 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/.
diff --git a/src/test/java/org/gridsuite/dynamicsecurityanalysis/server/controller/AbstractDynamicSecurityAnalysisControllerTest.java b/src/test/java/org/gridsuite/dynamicsecurityanalysis/server/controller/AbstractDynamicSecurityAnalysisControllerTest.java
@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2024, RTE (http://www.rte-france.com)
+ * 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/.
diff --git a/src/test/java/org/gridsuite/dynamicsecurityanalysis/server/controller/AbstractDynawoTest.java b/src/test/java/org/gridsuite/dynamicsecurityanalysis/server/controller/AbstractDynawoTest.java
@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2024, RTE (http://www.rte-france.com)
+ * 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/.
diff --git a/src/test/java/org/gridsuite/dynamicsecurityanalysis/server/controller/DynamicSecurityAnalysisControllerIEEE14Test.java b/src/test/java/org/gridsuite/dynamicsecurityanalysis/server/controller/DynamicSecurityAnalysisControllerIEEE14Test.java
@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2022, RTE (http://www.rte-france.com)
+ * 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/.
@@ -21,7 +21,6 @@
 import org.gridsuite.dynamicsecurityanalysis.server.entities.parameters.DynamicSecurityAnalysisParametersEntity;
 import org.junit.jupiter.api.Test;
 import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.cloud.stream.binder.test.InputDestination;
 import org.springframework.cloud.stream.binder.test.OutputDestination;
 import org.springframework.messaging.Message;
 import org.springframework.test.web.servlet.MvcResult;
@@ -57,7 +56,6 @@ public class DynamicSecurityAnalysisControllerIEEE14Test extends AbstractDynamic
     // directories
     public static final String DATA_IEEE14_BASE_DIR = RESOURCE_PATH_DELIMITER + "data" + RESOURCE_PATH_DELIMITER + "ieee14";
     public static final String INPUT = "input";
-    public static final String OUTPUT = "output";
     public static final String OUTPUT_STATE_DUMP_FILE = "outputState.dmp";
     public static final String DYNAMIC_MODEL_DUMP_FILE = "dynamicModel.dmp";
     public static final String DYNAMIC_SIMULATION_PARAMETERS_DUMP_FILE = "dynamicSimulationParameters.dmp";
@@ -74,9 +72,6 @@ public class DynamicSecurityAnalysisControllerIEEE14Test extends AbstractDynamic
     @Autowired
     private OutputDestination output;
 
-    @Autowired
-    private InputDestination input;
-
     @Override
     public OutputDestination getOutputDestination() {
         return output;
@@ -152,7 +147,6 @@ protected void initParametersServiceSpy() {
 
     @Test
     void test01IEEE14() throws Exception {
-        String testBaseDir = TEST_CASE_01;
 
         //run the dynamic security analysis (on a specific variant with variantId=" + VARIANT_1_ID + ")
         MvcResult result = mockMvc.perform(
@@ -168,8 +162,7 @@ void test01IEEE14() throws Exception {
 
         UUID runUuid = objectMapper.readValue(result.getResponse().getContentAsString(), UUID.class);
 
-        //TODO maybe find a more reliable way to test this : failed with 1000 * 30 timeout
-        Message<byte[]> messageSwitch = output.receive(1000 * 40, dsaResultDestination);
+        Message<byte[]> messageSwitch = output.receive(1000, dsaResultDestination);
         assertThat(messageSwitch.getHeaders()).containsEntry(HEADER_RESULT_UUID, runUuid.toString());
 
         // --- CHECK result --- //
diff --git a/src/test/java/org/gridsuite/dynamicsecurityanalysis/server/controller/DynamicSecurityAnalysisControllerTest.java b/src/test/java/org/gridsuite/dynamicsecurityanalysis/server/controller/DynamicSecurityAnalysisControllerTest.java
@@ -26,7 +26,6 @@
 import org.mockito.MockedStatic;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.test.mock.mockito.SpyBean;
-import org.springframework.cloud.stream.binder.test.InputDestination;
 import org.springframework.cloud.stream.binder.test.OutputDestination;
 import org.springframework.messaging.Message;
 import org.springframework.test.web.servlet.MvcResult;
@@ -67,13 +66,11 @@ public class DynamicSecurityAnalysisControllerTest extends AbstractDynamicSecuri
     // directories
     public static final String DATA_IEEE14_BASE_DIR = RESOURCE_PATH_DELIMITER + "data" + RESOURCE_PATH_DELIMITER + "ieee14";
     public static final String INPUT = "input";
-    public static final String OUTPUT = "output";
     public static final String OUTPUT_STATE_DUMP_FILE = "outputState.dmp";
     public static final String DYNAMIC_MODEL_DUMP_FILE = "dynamicModel.dmp";
     public static final String DYNAMIC_SIMULATION_PARAMETERS_DUMP_FILE = "dynamicSimulationParameters.dmp";
 
     private static final UUID NETWORK_UUID = UUID.randomUUID();
-    private static final UUID NETWORK_UUID_NOT_FOUND = UUID.randomUUID();
     private static final String VARIANT_1_ID = "variant_1";
     private static final String NETWORK_FILE = "IEEE14.iidm";
 
@@ -84,9 +81,6 @@ public class DynamicSecurityAnalysisControllerTest extends AbstractDynamicSecuri
     @Autowired
     private OutputDestination output;
 
-    @Autowired
-    private InputDestination input;
-
     @SpyBean
     private NotificationService notificationService;
 
@@ -365,7 +359,8 @@ void testStopEarly() throws Exception {
         assertThat(message.getHeaders())
                 .containsEntry(HEADER_RESULT_UUID, runUuid.toString())
                 .containsEntry(HEADER_MESSAGE, getCancelFailedMessage(COMPUTATION_TYPE));
-        // cancel failed so result still exist
+        // cancel failed so result still exist but status is still RUNNING
+        // TODO need to revisit the implementation in commons-ui, status must be NOT_DONE
         assertResultStatus(runUuid, DynamicSecurityAnalysisStatus.RUNNING);
     }
 
diff --git a/src/test/java/org/gridsuite/dynamicsecurityanalysis/server/controller/utils/TestUtils.java b/src/test/java/org/gridsuite/dynamicsecurityanalysis/server/controller/utils/TestUtils.java
@@ -1,19 +1,17 @@
 /**
- * Copyright (c) 2024, RTE (http://www.rte-france.com)
+ * 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 org.gridsuite.dynamicsecurityanalysis.server.controller.utils;
 
-import com.fasterxml.jackson.databind.ObjectMapper;
 import org.springframework.cloud.stream.binder.test.OutputDestination;
 
 import java.util.List;
 
-import static org.junit.Assert.assertNull;
-import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
+import static org.assertj.core.api.Assertions.assertThat;
 
 /**
  * @author Thang PHAM <quyet-thang.pham at rte-france.com>
@@ -28,15 +26,11 @@ private TestUtils() {
     public static void assertQueuesEmptyThenClear(List<String> destinations, OutputDestination output) throws InterruptedException {
         Thread.sleep(TIMEOUT);
         try {
-            destinations.forEach(destination -> assertNull("Should not be any messages in queue " + destination + " : ", output.receive(0, destination)));
+            destinations.forEach(destination -> assertThat(output.receive(0, destination)).as("Should not be any messages in queue " + destination + " : ").isNull());
         } catch (NullPointerException e) {
             // Ignoring
         } finally {
             output.clear(); // purge in order to not fail the other tests
         }
     }
-
-    public static void assertType(String response, Class<?> valueType, ObjectMapper objectMapper) {
-        assertDoesNotThrow(() -> objectMapper.readValue(response, valueType));
-    }
 }

Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ public DynamicSecurityAnalysisResultEntity(UUID id, DynamicSecurityAnalysisStatu`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`@Id`
`34`		`- @Column(name = "resultUuid")`
	`34`	`+ @Column(name = "result_uuid")`
`35`	`35`	`private UUID id;`
`36`	`36`
`37`	`37`	`@Column(name = "status")`