Code cleanup to correct issues reported by Sonar (Severity: high - part 2)

action-api/src/test/java/com/powsybl/action/json/JsonActionTest.java

@@ -92,7 +92,7 @@ void actionsReadV10() {
         ActionList actionList = ActionList.readJsonInputStream(getClass().getResourceAsStream("/ActionFileTestV1.0.json"));
         try (ByteArrayOutputStream bos = new ByteArrayOutputStream()) {
             actionList.writeJsonOutputStream(bos);
-            ComparisonUtils.compareTxt(getClass().getResourceAsStream("/ActionFileTest.json"), new ByteArrayInputStream(bos.toByteArray()));
+            ComparisonUtils.assertTxtEquals(getClass().getResourceAsStream("/ActionFileTest.json"), new ByteArrayInputStream(bos.toByteArray()));
         } catch (Exception e) {
             // Should not happen
             fail();

ampl-converter/src/test/java/com/powsybl/ampl/converter/AmplNetworkWriterTest.java

@@ -23,7 +23,7 @@
 import java.io.InputStream;
 import java.util.Properties;
 
-import static com.powsybl.commons.test.ComparisonUtils.compareTxt;
+import static com.powsybl.commons.test.ComparisonUtils.assertTxtEquals;
 import static org.junit.jupiter.api.Assertions.*;
 
 /**
@@ -33,7 +33,7 @@ class AmplNetworkWriterTest extends AbstractSerDeTest {
 
     private void assertEqualsToRef(MemDataSource dataSource, String suffix, String refFileName) throws IOException {
         try (InputStream actual = new ByteArrayInputStream(dataSource.getData(suffix, "txt"))) {
-            compareTxt(getClass().getResourceAsStream("/" + refFileName), actual);
+            assertTxtEquals(getClass().getResourceAsStream("/" + refFileName), actual);
         }
     }
 

commons-test/src/main/java/com/powsybl/commons/test/AbstractSerDeTest.java

@@ -49,38 +49,38 @@ public void tearDown() throws IOException {
      *     <li>Transform the given data with the transformer function provided. This might be used to add a roundtrip on
      *     other formats prior to the XML roundtrip.</li>
      *     <li>Write the transformed data to a temporary XML file thanks to the given write function.</li>
-     *     <li>Compare the obtained XML file with the given reference file thanks to {@link ComparisonUtils#compareXml}.</li>
+     *     <li>Compare the obtained XML file with the given reference file thanks to {@link ComparisonUtils#assertXmlEquals}.</li>
      *     <li>Read the same XML file with the given read function.</li>
      *     <li>Write the data read in the previous step to a new temporary XML file.</li>
      *     <li>Compare the new obtained XML file with the first obtained XML file byte by byte using {@link Files#mismatch}.</li>
      *     <li>Return the data read 3 steps above.</li>
      * </ul>
      */
     protected <T> T roundTripXmlTest(T data, BiFunction<T, Path, T> transformer, BiConsumer<T, Path> write, Function<Path, T> read, String ref) throws IOException {
-        return roundTripTest(data, transformer, write, read, ComparisonUtils::compareXml, ref);
+        return roundTripTest(data, transformer, write, read, ComparisonUtils::assertXmlEquals, ref);
     }
 
     /**
      * Roundtrip test on the given data. The following steps occur:
      * <ul>
      *     <li>Write the given data to a temporary file thanks to the given write function.</li>
-     *     <li>Compare the obtained file with the given reference file thanks to {@link ComparisonUtils#compareTxt}.</li>
+     *     <li>Compare the obtained file with the given reference file thanks to {@link ComparisonUtils#assertTxtEquals}.</li>
      *     <li>Read the same file with the given read function.</li>
      *     <li>Write the data read in the previous step to a new temporary file.</li>
      *     <li>Compare the new obtained file with the first obtained file byte by byte using {@link Files#mismatch}.</li>
      *     <li>Return the data read 3 steps above.</li>
      * </ul>
      */
     protected <T> T roundTripTest(T data, BiConsumer<T, Path> write, Function<Path, T> read, String ref) throws IOException {
-        return roundTripTest(data, write, read, ComparisonUtils::compareTxt, ref);
+        return roundTripTest(data, write, read, ComparisonUtils::assertTxtEquals, ref);
     }
 
     /**
      * Write the given data with given write function, and compare the resulting XML file to given reference.
      * @return the path of written file.
      */
     protected <T> Path writeXmlTest(T data, BiConsumer<T, Path> write, String ref) throws IOException {
-        return writeTest(data, write, ComparisonUtils::compareXml, ref);
+        return writeTest(data, write, ComparisonUtils::assertXmlEquals, ref);
     }
 
     /**

commons-test/src/main/java/com/powsybl/commons/test/ComparisonUtils.java

@@ -29,7 +29,7 @@ public final class ComparisonUtils {
     private ComparisonUtils() {
     }
 
-    public static void compareXml(InputStream expected, InputStream actual) {
+    public static void assertXmlEquals(InputStream expected, InputStream actual) {
         Diff myDiff = DiffBuilder.compare(expected).withTest(actual).ignoreWhitespace().ignoreComments().build();
         boolean hasDiff = myDiff.hasDifferences();
         if (hasDiff) {
@@ -38,23 +38,23 @@ public static void compareXml(InputStream expected, InputStream actual) {
         assertFalse(hasDiff);
     }
 
-    public static void compareTxt(InputStream expected, InputStream actual) {
+    public static void assertTxtEquals(InputStream expected, InputStream actual) {
         try {
-            compareTxt(expected, new String(ByteStreams.toByteArray(actual), StandardCharsets.UTF_8));
+            assertTxtEquals(expected, new String(ByteStreams.toByteArray(actual), StandardCharsets.UTF_8));
         } catch (IOException e) {
             throw new UncheckedIOException(e);
         }
     }
 
-    public static void compareBytes(InputStream expected, InputStream actual) {
+    public static void assertBytesEquals(InputStream expected, InputStream actual) {
         try {
             assertArrayEquals(expected.readAllBytes(), actual.readAllBytes());
         } catch (IOException e) {
             throw new UncheckedIOException(e);
         }
     }
 
-    public static void compareTxt(InputStream expected, InputStream actual, List<Integer> excludedLines) {
+    public static void assertTxtEquals(InputStream expected, InputStream actual, List<Integer> excludedLines) {
         BufferedReader expectedReader = new BufferedReader(new InputStreamReader(expected));
         List<String> expectedLines = expectedReader.lines().toList();
         BufferedReader actualReader = new BufferedReader(new InputStreamReader(actual));
@@ -67,23 +67,23 @@ public static void compareTxt(InputStream expected, InputStream actual, List<Int
         }
     }
 
-    public static void compareTxt(InputStream expected, String actual) {
+    public static void assertTxtEquals(InputStream expected, String actual) {
         try {
-            compareTxt(new String(ByteStreams.toByteArray(expected), StandardCharsets.UTF_8), actual);
+            assertTxtEquals(new String(ByteStreams.toByteArray(expected), StandardCharsets.UTF_8), actual);
         } catch (IOException e) {
             throw new UncheckedIOException(e);
         }
     }
 
-    public static void compareTxt(String expected, InputStream actual) {
+    public static void assertTxtEquals(String expected, InputStream actual) {
         try {
-            compareTxt(expected, new String(ByteStreams.toByteArray(actual), StandardCharsets.UTF_8));
+            assertTxtEquals(expected, new String(ByteStreams.toByteArray(actual), StandardCharsets.UTF_8));
         } catch (IOException e) {
             throw new UncheckedIOException(e);
         }
     }
 
-    public static void compareTxt(String expected, String actual) {
+    public static void assertTxtEquals(String expected, String actual) {
         String expectedStr = TestUtil.normalizeLineSeparator(expected);
         String actualStr = TestUtil.normalizeLineSeparator(actual);
         assertEquals(expectedStr, actualStr);

commons/src/test/java/com/powsybl/commons/config/MapModuleConfigTest.java → commons/src/test/java/com/powsybl/commons/config/AbstractMapModuleConfigTest.java

@@ -11,7 +11,6 @@
 import com.google.common.jimfs.Jimfs;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
-import org.junit.jupiter.api.Test;
 
 import java.io.IOException;
 import java.nio.file.FileSystem;
@@ -28,12 +27,12 @@
 /**
  * @author Yichen TANG {@literal <yichen.tang at rte-france.com>}
  */
-class MapModuleConfigTest {
+abstract class AbstractMapModuleConfigTest {
 
     protected FileSystem fileSystem;
 
     @BeforeEach
-    void setUp() throws IOException {
+    void setUp() {
         fileSystem = Jimfs.newFileSystem(Configuration.unix());
     }
 
@@ -42,11 +41,6 @@ void tearDown() throws IOException {
         fileSystem.close();
     }
 
-    @Test
-    void emptyTest() {
-        // sonar issue
-    }
-
     protected void assertModConfig(ModuleConfig modConfig) {
         Path p = fileSystem.getPath("/tmp");
         Path p2 = fileSystem.getPath("/home");

commons/src/test/java/com/powsybl/commons/config/EnvironmentModuleConfigRepositoryTest.java

@@ -22,7 +22,7 @@
 /**
  * @author Yichen TANG {@literal <yichen.tang at rte-france.com>}
  */
-class EnvironmentModuleConfigRepositoryTest extends MapModuleConfigTest {
+class EnvironmentModuleConfigRepositoryTest extends AbstractMapModuleConfigTest {
 
     @Test
     void test() {

commons/src/test/java/com/powsybl/commons/config/PropertiesPlatformConfigTest.java

@@ -27,7 +27,7 @@
  *
  * @author Geoffroy Jamgotchian {@literal <geoffroy.jamgotchian at rte-france.com>}
  */
-class PropertiesPlatformConfigTest extends MapModuleConfigTest {
+class PropertiesPlatformConfigTest extends AbstractMapModuleConfigTest {
 
     PropertiesPlatformConfigTest() {
     }

commons/src/test/java/com/powsybl/commons/util/StringToIntMapperTest.java

@@ -18,7 +18,7 @@
 import java.nio.file.Files;
 import java.nio.file.Path;
 
-import static com.powsybl.commons.test.ComparisonUtils.compareTxt;
+import static com.powsybl.commons.test.ComparisonUtils.assertTxtEquals;
 import static org.junit.Assert.assertThrows;
 import static org.junit.jupiter.api.Assertions.*;
 
@@ -71,7 +71,7 @@ void testDump() throws IOException {
 
             String expectedStr = "TYPE;value1;1" + System.lineSeparator();
             try (InputStream in = Files.newInputStream(outputFile)) {
-                compareTxt(expectedStr, in);
+                assertTxtEquals(expectedStr, in);
             } catch (Exception e) {
                 fail(e);
             }

computation-local/src/main/java/com/powsybl/computation/local/LocalComputationManager.java

@@ -155,37 +155,9 @@ private ExecutionReport execute(Path workingDir, List<CommandExecution> commandE
         for (CommandExecution commandExecution : commandExecutionList) {
             Command command = commandExecution.getCommand();
             CountDownLatch latch = new CountDownLatch(commandExecution.getExecutionCount());
-            IntStream.range(0, commandExecution.getExecutionCount()).forEach(idx ->
-                    executionSubmitter.execute(() -> {
-                        try {
-                            enter();
-                            if (LOGGER.isDebugEnabled()) {
-                                LOGGER.debug("Executing command {} in working directory {}",
-                                        command.toString(idx), workingDir);
-                            }
-                            preProcess(workingDir, command, idx);
-                            Stopwatch stopwatch = null;
-                            if (LOGGER.isDebugEnabled()) {
-                                stopwatch = Stopwatch.createStarted();
-                            }
-                            int exitValue = process(workingDir, commandExecution, idx, variables, computationParameters);
-                            if (stopwatch != null) {
-                                stopwatch.stop();
-                                LOGGER.debug("Command {} executed in {} ms",
-                                        command.toString(idx), stopwatch.elapsed(TimeUnit.MILLISECONDS));
-                            }
-                            postProcess(workingDir, commandExecution, idx, exitValue, errors, monitor);
-                        } catch (InterruptedException e) {
-                            Thread.currentThread().interrupt();
-                            LOGGER.warn(e.getMessage(), e);
-                        } catch (Exception e) {
-                            LOGGER.warn(e.getMessage(), e);
-                        } finally {
-                            latch.countDown();
-                            exit();
-                        }
-                    })
-            );
+            ExecutionParameters executionParameters = new ExecutionParameters(workingDir, commandExecution, variables, computationParameters, executionSubmitter,
+                command, latch, errors, monitor);
+            IntStream.range(0, commandExecution.getExecutionCount()).forEach(idx -> performSingleExecution(executionParameters, idx));
             latch.await();
         }
 
@@ -201,6 +173,46 @@ private ExecutionReport execute(Path workingDir, List<CommandExecution> commandE
         return new DefaultExecutionReport(workingDir, errors);
     }
 
+    private record ExecutionParameters(Path workingDir, CommandExecution commandExecution,
+                                       Map<String, String> variables, ComputationParameters computationParameters,
+                                       ExecutorService executionSubmitter, Command command, CountDownLatch latch,
+                                       List<ExecutionError> errors, ExecutionMonitor monitor) {
+    }
+
+    private void performSingleExecution(ExecutionParameters executionParameters, int idx) {
+        executionParameters.executionSubmitter.execute(() -> {
+            try {
+                enter();
+                if (LOGGER.isDebugEnabled()) {
+                    LOGGER.debug("Executing command {} in working directory {}",
+                        executionParameters.command.toString(idx), executionParameters.workingDir);
+                }
+                preProcess(executionParameters.workingDir, executionParameters.command, idx);
+                Stopwatch stopwatch = null;
+                if (LOGGER.isDebugEnabled()) {
+                    stopwatch = Stopwatch.createStarted();
+                }
+                int exitValue = process(executionParameters.workingDir, executionParameters.commandExecution, idx,
+                    executionParameters.variables, executionParameters.computationParameters);
+                if (stopwatch != null) {
+                    stopwatch.stop();
+                    LOGGER.debug("Command {} executed in {} ms",
+                        executionParameters.command.toString(idx), stopwatch.elapsed(TimeUnit.MILLISECONDS));
+                }
+                postProcess(executionParameters.workingDir, executionParameters.commandExecution, idx, exitValue,
+                    executionParameters.errors, executionParameters.monitor);
+            } catch (InterruptedException e) {
+                Thread.currentThread().interrupt();
+                LOGGER.warn(e.getMessage(), e);
+            } catch (Exception e) {
+                LOGGER.warn(e.getMessage(), e);
+            } finally {
+                executionParameters.latch.countDown();
+                exit();
+            }
+        });
+    }
+
     private void preProcess(Path workingDir, Command command, int executionIndex) throws IOException {
         // pre-processing
         for (InputFile file : command.getInputFiles()) {

contingency/contingency-api/src/test/java/com/powsybl/contingency/json/NetworkElementIdentifierContingencyListJsonTest.java

@@ -60,7 +60,7 @@ void readVersion11() {
                         .getResourceAsStream("/identifierContingencyListv1_1.json")));
         try (ByteArrayOutputStream bos = new ByteArrayOutputStream()) {
             WRITER.writeValue(bos, contingencyList);
-            ComparisonUtils.compareTxt(getClass().getResourceAsStream("/identifierContingencyListReferenceForLessThan1_2.json"), new ByteArrayInputStream(bos.toByteArray()));
+            ComparisonUtils.assertTxtEquals(getClass().getResourceAsStream("/identifierContingencyListReferenceForLessThan1_2.json"), new ByteArrayInputStream(bos.toByteArray()));
         } catch (IOException e) {
             throw new RuntimeException(e);
         }
@@ -73,7 +73,7 @@ void readVersion10() {
                         .getResourceAsStream("/identifierContingencyListv1_0.json")));
         try (ByteArrayOutputStream bos = new ByteArrayOutputStream()) {
             WRITER.writeValue(bos, contingencyList);
-            ComparisonUtils.compareTxt(getClass().getResourceAsStream("/identifierContingencyListReferenceForLessThan1_2.json"), new ByteArrayInputStream(bos.toByteArray()));
+            ComparisonUtils.assertTxtEquals(getClass().getResourceAsStream("/identifierContingencyListReferenceForLessThan1_2.json"), new ByteArrayInputStream(bos.toByteArray()));
         } catch (IOException e) {
             throw new RuntimeException(e);
         }

dynamic-simulation/dynamic-simulation-api/src/test/java/com/powsybl/dynamicsimulation/json/JsonDynamicSimulationParametersTest.java

@@ -39,7 +39,7 @@ void roundTrip() throws IOException {
     void writeExtension() throws IOException {
         DynamicSimulationParameters parameters = new DynamicSimulationParameters();
         parameters.addExtension(DummyExtension.class, new DummyExtension());
-        writeTest(parameters, JsonDynamicSimulationParameters::write, ComparisonUtils::compareTxt, "/DynamicSimulationParametersWithExtension.json");
+        writeTest(parameters, JsonDynamicSimulationParameters::write, ComparisonUtils::assertTxtEquals, "/DynamicSimulationParametersWithExtension.json");
     }
 
     @Test

dynamic-simulation/dynamic-simulation-tool/src/main/java/com/powsybl/dynamicsimulation/tool/DynamicSimulationTool.java

@@ -47,6 +47,7 @@ public class DynamicSimulationTool implements Tool {
     private static final String PARAMETERS_FILE = "parameters-file";
     private static final String OUTPUT_FILE = "output-file";
     private static final String OUTPUT_LOG_FILE = "output-log-file";
+    private static final String GROOVY = "groovy";
 
     @Override
     public Command getCommand() {
@@ -175,7 +176,7 @@ public void run(CommandLine line, ToolRunningContext context) throws Exception {
 
     private DynamicModelsSupplier createDynamicModelsSupplier(Path path, String providerName) {
         String extension = FilenameUtils.getExtension(path.toString());
-        if (extension.equals("groovy")) {
+        if (extension.equals(GROOVY)) {
             return new GroovyDynamicModelsSupplier(path, GroovyExtension.find(DynamicModelGroovyExtension.class, providerName));
         } else {
             throw new PowsyblException("Unsupported dynamic model format: " + extension);
@@ -184,7 +185,7 @@ private DynamicModelsSupplier createDynamicModelsSupplier(Path path, String prov
 
     private EventModelsSupplier createEventModelsSupplier(Path path, String providerName) {
         String extension = FilenameUtils.getExtension(path.toString());
-        if (extension.equals("groovy")) {
+        if (extension.equals(GROOVY)) {
             return new GroovyEventModelsSupplier(path, GroovyExtension.find(EventModelGroovyExtension.class, providerName));
         } else {
             throw new PowsyblException("Unsupported events format: " + extension);
@@ -193,7 +194,7 @@ private EventModelsSupplier createEventModelsSupplier(Path path, String provider
 
     private CurvesSupplier createCurvesSupplier(Path path, String providerName) {
         String extension = FilenameUtils.getExtension(path.toString());
-        if (extension.equals("groovy")) {
+        if (extension.equals(GROOVY)) {
             return new GroovyCurvesSupplier(path, GroovyExtension.find(CurveGroovyExtension.class, providerName));
         } else {
             throw new PowsyblException("Unsupported curves format: " + extension);

dynamic-simulation/dynamic-simulation-tool/src/test/java/com/powsybl/dynamicsimulation/tool/DynamicSimulationToolTest.java

@@ -94,7 +94,7 @@ void testDynamicSimulationWithOutputFile() throws IOException {
                           "timeLine" : [ ]
                         }""";
         assertCommandSuccessful(new String[]{"dynamic-simulation", "--case-file", "/network.xiidm", "--dynamic-models-file", "/dynamicModels.groovy", "--output-file", "outputTest.json"}, expectedOut);
-        ComparisonUtils.compareTxt(expectedOutputFile, Files.newInputStream(fileSystem.getPath("outputTest.json")));
+        ComparisonUtils.assertTxtEquals(expectedOutputFile, Files.newInputStream(fileSystem.getPath("outputTest.json")));
     }
 
     @Test
@@ -110,7 +110,7 @@ void testDynamicSimulationWithOutputLogFile() throws IOException {
                 "+---------+" + System.lineSeparator());
         String expectedOutputFile = "Dynamic Simulation Tool\n";
         assertCommandSuccessful(new String[]{"dynamic-simulation", "--case-file", "/network.xiidm", "--dynamic-models-file", "/dynamicModels.groovy", "--output-log-file", "outputTest.log"}, expectedOut);
-        ComparisonUtils.compareTxt(expectedOutputFile, Files.newInputStream(fileSystem.getPath("outputTest.log")));
+        ComparisonUtils.assertTxtEquals(expectedOutputFile, Files.newInputStream(fileSystem.getPath("outputTest.log")));
     }
 
     @Test