test + doc + review changes -> fix tests related to fileSystem

Signed-off-by: Samir Romdhani <samir.romdhani_externe@rte-france.com>

add doc

Signed-off-by: Samir Romdhani <samir.romdhani_externe@rte-france.com>

test

Signed-off-by: Samir Romdhani <samir.romdhani_externe@rte-france.com>

fix

fix test

Signed-off-by: Samir Romdhani <samir.romdhani_externe@rte-france.com>

test

Signed-off-by: Samir Romdhani <samir.romdhani_externe@rte-france.com>

Author: samirromdhani

docs/user/itools/loadflow-validation.md

@@ -14,6 +14,7 @@ usage: itools [OPTIONS] loadflow-validation --case-file <FILE>
        [--load-flow] --output-folder <FOLDER> [--output-format
        <VALIDATION_WRITER>] [--run-computation <COMPUTATION>] [--types
        <VALIDATION_TYPE,VALIDATION_TYPE,...>] [--verbose]
+       [--with-extensions-validation]
 
 Available options are:
     --config-name <CONFIG_NAME>   Override configuration file name
@@ -86,6 +87,9 @@ Use the `--load-flow` parameter to run a load-flow before the validation. This o
 `--output-format`<br>
 Use the `--output-format` parameter to specify the format of the output files. The available output formats are `CSV` or `CSV_MULTILINE`.
 
+`--with-extensions-validation`<br>
+Use the `--with-extensions-validation` parameter to perform extensions validation.
+
 If this parameter is set to `CSV`, in the output files a line contains all values of validated equipment. If the parameter
 is set to `CSV_MULTILINE`, in the output files the values of a piece of equipment are split in multiple lines, one value for each
 line, see examples below:

loadflow/loadflow-validation/note.md

@@ -9,7 +9,6 @@
 
 import com.google.auto.service.AutoService;
 import com.google.common.base.Preconditions;
-import com.google.common.collect.Sets;
 import com.powsybl.commons.PowsyblException;
 import com.powsybl.iidm.network.ImportConfig;
 import com.powsybl.iidm.network.Network;
@@ -29,11 +28,8 @@
 import java.io.IOException;
 import java.nio.file.Files;
 import java.nio.file.Path;
-import java.nio.file.Paths;
-import java.util.Arrays;
-import java.util.Objects;
-import java.util.Properties;
-import java.util.Set;
+
+import java.util.*;
 import java.util.stream.Collectors;
 
 import static com.powsybl.iidm.network.tools.ConversionToolUtils.*;
@@ -54,7 +50,7 @@ public class ValidationTool implements Tool {
     private static final String COMPARE_RESULTS = "compare-results";
     private static final String RUN_COMPUTATION = "run-computation";
     private static final String COMPARE_CASE_FILE = "compare-case-file";
-    public static final String WITH_EXTENSIONS_OPTION = "with-extensions";
+    public static final String WITH_EXTENSIONS_OPTION = "with-extensions-validation";
 
     private static final Command COMMAND = new Command() {
 
@@ -144,8 +140,8 @@ public Command getCommand() {
 
     @Override
     public void run(CommandLine line, ToolRunningContext context) throws Exception {
-        Path caseFile = Paths.get(line.getOptionValue(CASE_FILE));
-        Path outputFolder = Paths.get(line.getOptionValue(OUTPUT_FOLDER));
+        Path caseFile = context.getFileSystem().getPath(line.getOptionValue(CASE_FILE));
+        Path outputFolder = context.getFileSystem().getPath(line.getOptionValue(OUTPUT_FOLDER));
         if (!Files.exists(outputFolder)) {
             Files.createDirectories(outputFolder);
         }
@@ -156,23 +152,18 @@ public void run(CommandLine line, ToolRunningContext context) throws Exception {
         if (line.hasOption(OUTPUT_FORMAT)) {
             config.setValidationOutputWriter(ValidationOutputWriter.valueOf(line.getOptionValue(OUTPUT_FORMAT)));
         }
-
         ComparisonType comparisonType = null;
         if (line.hasOption(COMPARE_RESULTS)) {
             config.setCompareResults(true);
             comparisonType = ComparisonType.valueOf(line.getOptionValue(COMPARE_RESULTS));
         }
-        Set<ValidationType> validationTypes = Sets.newHashSet(ValidationType.values());
+        Set<ValidationType> validationTypes = new TreeSet<>(Arrays.asList(ValidationType.values()));
         if (line.hasOption(TYPES)) {
             validationTypes = Arrays.stream(line.getOptionValue(TYPES).split(","))
-                                    .map(ValidationType::valueOf)
-                                    .collect(Collectors.toSet());
+                    .map(ValidationType::valueOf)
+                    .collect(Collectors.toCollection(TreeSet::new));
         }
         Network network = loadNetwork(caseFile, line, context);
-        if (line.hasOption(WITH_EXTENSIONS_OPTION)) {
-            ExtensionsValidation extensionsValidation = new ExtensionsValidation();
-            extensionsValidation.runExtensionValidations(network, config, outputFolder, context);
-        }
         try (ValidationWriters validationWriters = new ValidationWriters(network.getId(), validationTypes, outputFolder, config)) {
             if (config.isCompareResults() && ComparisonType.COMPUTATION.equals(comparisonType)) {
                 Preconditions.checkArgument(line.hasOption(LOAD_FLOW) || line.hasOption(RUN_COMPUTATION),
@@ -194,12 +185,16 @@ public void run(CommandLine line, ToolRunningContext context) throws Exception {
 
             if (config.isCompareResults() && ComparisonType.BASECASE.equals(comparisonType)) {
                 Preconditions.checkArgument(line.hasOption(COMPARE_CASE_FILE),
-                        "Basecases comparison requires to provide a second basecase (option --" + COMPARE_CASE_FILE + ").");
-                Path compareCaseFile = Paths.get(line.getOptionValue(COMPARE_CASE_FILE));
+                        "Base cases comparison requires to provide a second basecase (option --" + COMPARE_CASE_FILE + ").");
+                Path compareCaseFile = context.getFileSystem().getPath(line.getOptionValue(COMPARE_CASE_FILE));
                 Network compareNetwork = loadNetwork(compareCaseFile, line, context);
                 context.getOutputStream().println("Running validation on network " + compareNetwork.getId() + " to compare");
                 runValidation(compareNetwork, config, validationTypes, validationWriters, context);
             }
+            if (line.hasOption(WITH_EXTENSIONS_OPTION)) {
+                ExtensionsValidation extensionsValidation = new ExtensionsValidation();
+                extensionsValidation.runExtensionValidations(network, config, context);
+            }
         }
     }
 

loadflow/loadflow-validation/src/main/java/com/powsybl/loadflow/validation/ValidationTool.java

@@ -5,27 +5,18 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  * SPDX-License-Identifier: MPL-2.0
  */
-package com.powsybl.loadflow.validation.extension; import com.powsybl.iidm.network.Network;
+package com.powsybl.loadflow.validation.extension;
+import com.powsybl.iidm.network.Network;
 import com.powsybl.loadflow.validation.ValidationConfig;
 
-import java.io.IOException;
-import java.nio.file.Path;
-import java.util.Objects;
-
 /**
  *
  * @author Samir Romdhani {@literal <samir.romdhani at rte-france.com>}
  */
 public interface ExtensionValidation {
 
-    String getType();
-
     String getName();
 
-    boolean check(Network network, ValidationConfig config, Path outputFile) throws IOException;
+    boolean check(Network network, ValidationConfig config);
 
-    default Path getOutputFile(Path folder) {
-        Objects.requireNonNull(folder);
-        return folder.resolve(getName() + ".csv");
-    }
 }

loadflow/loadflow-validation/src/main/java/com/powsybl/loadflow/validation/extension/ExtensionValidation.java

@@ -7,18 +7,16 @@
  */
 package com.powsybl.loadflow.validation.extension;
 
-import com.google.common.base.Supplier;
 import com.google.common.base.Suppliers;
 import com.google.common.collect.Lists;
 import com.powsybl.iidm.network.Network;
 import com.powsybl.loadflow.validation.ValidationConfig;
 import com.powsybl.tools.ToolRunningContext;
 
-import java.io.IOException;
-import java.nio.file.Path;
 import java.util.List;
 import java.util.Optional;
 import java.util.ServiceLoader;
+import java.util.function.Supplier;
 
 /**
  * @author Samir Romdhani {@literal <samir.romdhani at rte-france.com>}
@@ -40,18 +38,12 @@ public static Optional<ExtensionValidation> getExtension(String name) {
         return getExtensions().stream().filter(v -> v.getName().equals(name)).findFirst();
     }
 
-    public void runExtensionValidations(Network network, ValidationConfig config, Path outputFolder, ToolRunningContext context) {
-
+    public void runExtensionValidations(Network network, ValidationConfig config, ToolRunningContext context) {
         getExtensions().forEach(extensionValidation -> {
-            try {
-                boolean success = extensionValidation.check(network, config, extensionValidation.getOutputFile(outputFolder));
-                String message = "Validate extension behaviour of network " + network.getId()
-                        + " - extension validation type: " + extensionValidation.getType()
-                        + " - result: " + (success ? "success" : "fail");
-                context.getOutputStream().println(message);
-            } catch (IOException e) {
-                throw new java.io.UncheckedIOException(e);
-            }
+            boolean success = extensionValidation.check(network, config);
+            context.getOutputStream().println("Validate load-flow results of network " + network.getId()
+                    + " - validation type: Extension/" + extensionValidation.getName()
+                    + " - result: " + (success ? "success" : "fail"));
         });
     }
 }

loadflow/loadflow-validation/src/main/java/com/powsybl/loadflow/validation/extension/ExtensionsValidation.java

@@ -10,10 +10,8 @@
 import com.powsybl.tools.Tool;
 import com.powsybl.tools.test.AbstractToolTest;
 import org.junit.jupiter.api.BeforeEach;
-import org.junit.jupiter.api.Disabled;
 import org.junit.jupiter.api.Test;
 
-import java.io.IOException;
 import java.nio.file.Files;
 import java.util.Collections;
 import java.util.Objects;
@@ -29,6 +27,7 @@ class ValidationToolTest extends AbstractToolTest {
     private static final String COMMAND_NAME = "loadflow-validation";
     private final ValidationTool tool = new ValidationTool();
 
+    @Override
     @BeforeEach
     public void setUp() throws Exception {
         super.setUp();
@@ -51,7 +50,7 @@ public void assertCommand() {
         assertOption(tool.getCommand().getOptions(), "output-folder", true, true);
         assertOption(tool.getCommand().getOptions(), "load-flow", false, false);
         assertOption(tool.getCommand().getOptions(), "types", false, true);
-        assertOption(tool.getCommand().getOptions(), "with-extensions", false, false);
+        assertOption(tool.getCommand().getOptions(), "with-extensions-validation", false, false);
     }
 
     @Test
@@ -60,9 +59,31 @@ void testCommand() {
     }
 
     @Test
-    @Disabled
-    void test() throws IOException {
-        //TODO  File network.xiidm does not exist !!!!!
-        assertCommandErrorMatch(new String[]{"loadflow-validation", "--case-file", "network.xiidm", "--output-folder", "result"}, "");
+    void loadFlowValidationShouldSucceedWithRequiredOption() {
+        String expectedOut = String.join(System.lineSeparator(),
+                "Loading case network.xiidm",
+                "Validate load-flow results of network network - validation type: FLOWS - result: success",
+                "Validate load-flow results of network network - validation type: GENERATORS - result: success",
+                "Validate load-flow results of network network - validation type: BUSES - result: success",
+                "Validate load-flow results of network network - validation type: SVCS - result: success",
+                "Validate load-flow results of network network - validation type: SHUNTS - result: success",
+                "Validate load-flow results of network network - validation type: TWTS - result: success",
+                "Validate load-flow results of network network - validation type: TWTS3W - result: success" + System.lineSeparator());
+        assertCommandSuccessfulMatch(new String[]{"loadflow-validation", "--case-file", "network.xiidm", "--output-folder", "test"}, expectedOut);
+    }
+
+    @Test
+    void loadFlowValidationShouldComputePrivateValidation() {
+        String expectedOut = String.join(System.lineSeparator(),
+                "Loading case network.xiidm",
+                "Validate load-flow results of network network - validation type: FLOWS - result: success",
+                "Validate load-flow results of network network - validation type: GENERATORS - result: success",
+                "Validate load-flow results of network network - validation type: BUSES - result: success",
+                "Validate load-flow results of network network - validation type: SVCS - result: success",
+                "Validate load-flow results of network network - validation type: SHUNTS - result: success",
+                "Validate load-flow results of network network - validation type: TWTS - result: success",
+                "Validate load-flow results of network network - validation type: TWTS3W - result: success",
+                "Validate load-flow results of network network - validation type: Extension/extensionValidationMock1 - result: success" + System.lineSeparator());
+        assertCommandSuccessfulMatch(new String[]{"loadflow-validation", "--case-file", "network.xiidm", "--output-folder", "test", "--with-extensions-validation"}, expectedOut);
     }
 }

loadflow/loadflow-validation/src/test/java/com/powsybl/loadflow/validation/ValidationToolTest.java

@@ -5,32 +5,26 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  * SPDX-License-Identifier: MPL-2.0
  */
-package com.powsybl.loadflow.validation.extension; import com.google.auto.service.AutoService;
+package com.powsybl.loadflow.validation.extension;
+import com.google.auto.service.AutoService;
 import com.powsybl.iidm.network.Network;
 import com.powsybl.loadflow.validation.ValidationConfig;
 
-import java.io.IOException;
-import java.nio.file.Path;
-
 /**
  *
  * @author Samir Romdhani {@literal <samir.romdhani at rte-france.com>}
  */
 @AutoService(ExtensionValidation.class)
 public class ExtensionValidationMock implements ExtensionValidation {
 
-    @Override
-    public String getType() {
-        return "private1";
-    }
-
     @Override
     public String getName() {
         return "extensionValidationMock1";
     }
 
     @Override
-    public boolean check(Network network, ValidationConfig config, Path outputFile) throws IOException {
+    public boolean check(Network network, ValidationConfig config) {
         return true;
     }
+
 }

loadflow/loadflow-validation/src/test/java/com/powsybl/loadflow/validation/extension/ExtensionValidationMock.java

@@ -16,10 +16,8 @@
 import org.mockito.ArgumentCaptor;
 import org.mockito.MockedStatic;
 
-import java.io.IOException;
 import java.io.PrintStream;
 import java.nio.file.FileSystem;
-import java.nio.file.Path;
 import java.util.List;
 
 import static org.junit.jupiter.api.Assertions.*;
@@ -34,59 +32,51 @@ class ExtensionsValidationTest {
 
     ExtensionsValidation extensionsValidation = new ExtensionsValidation();
     private final Network network = EurostagTutorialExample1Factory.create();
-    private final Path outputFolder = mock(Path.class);
 
     @Test
     void getExtensionsShouldSucceed() {
         assertEquals(1, ExtensionsValidation.getExtensions().size());
     }
 
     @Test
-    void getExtensionsNamesShouldSucceed() {
+    void getExtensionsNamesShouldReturnExistingExtension() {
         assertEquals(List.of("extensionValidationMock1"), ExtensionsValidation.getExtensionsNames());
     }
 
     @Test
     void getExtensionShouldReturnExistingExtension() {
         assertTrue(ExtensionsValidation.getExtension("extensionValidationMock1").isPresent());
         assertEquals("extensionValidationMock1", ExtensionsValidation.getExtension("extensionValidationMock1").get().getName());
-        assertEquals("private1", ExtensionsValidation.getExtension("extensionValidationMock1").get().getType());
-        when(outputFolder.resolve(anyString())).thenReturn(outputFolder);
-        assertNotNull(ExtensionsValidation.getExtension("extensionValidationMock1").get().getOutputFile(outputFolder));
     }
 
     @Test
-    void testRunExtensionValidationsShouldSucceed() throws IOException {
+    void runExtensionValidationsShouldSucceed() {
         //Given
         ValidationConfig config = ValidationConfig.load();
         ToolRunningContext context = new ToolRunningContext(mock(PrintStream.class), mock(PrintStream.class), mock(FileSystem.class), mock(ComputationManager.class), mock(ComputationManager.class));
 
         ExtensionValidation extension1 = mock(ExtensionValidation.class);
         ExtensionValidation extension2 = mock(ExtensionValidation.class);
 
-        when(extension1.getType()).thenReturn("type1");
-        when(extension1.getOutputFile(outputFolder)).thenReturn(mock(Path.class));
-        when(extension1.check(any(), any(), any())).thenReturn(true);
+        when(extension1.getName()).thenReturn("ExtensionName1");
+        when(extension1.check(any(), any())).thenReturn(true);
 
-        when(extension2.getType()).thenReturn("type2");
-        when(extension2.getOutputFile(outputFolder)).thenReturn(mock(Path.class));
-        when(extension2.check(any(), any(), any())).thenReturn(false);
+        when(extension2.getName()).thenReturn("ExtensionName2");
+        when(extension2.check(any(), any())).thenReturn(false);
 
         try (MockedStatic<ExtensionsValidation> mocked = mockStatic(ExtensionsValidation.class)) {
             mocked.when(ExtensionsValidation::getExtensions).thenReturn(List.of(extension1, extension2));
             // When
-            extensionsValidation.runExtensionValidations(network, config, outputFolder, context);
+            extensionsValidation.runExtensionValidations(network, config, context);
             // Then
-
             ArgumentCaptor<String> captor = ArgumentCaptor.forClass(String.class);
             verify(context.getOutputStream(), times(2)).println(captor.capture());
             List<String> messages = captor.getAllValues();
-            assertTrue(messages.get(0).contains("success"));
-            assertTrue(messages.get(1).contains("fail"));
-
-            // check() was called on extensions
-            verify(extension1, times(1)).check(eq(network), eq(config), any());
-            verify(extension2, times(1)).check(eq(network), eq(config), any());
+            assertTrue(messages.get(0).contains("validation type: Extension/ExtensionName1 - result: success"));
+            assertTrue(messages.get(1).contains("validation type: Extension/ExtensionName2 - result: fail"));
+            // check method was called on extensions
+            verify(extension1, times(1)).check(network, config);
+            verify(extension2, times(1)).check(network, config);
         }
     }
 }