EMF module and merge tests #82

obrix · 2023-01-23T09:42:41Z

Add emf module (empty for now) with three tests for destructive merge, merging view merge and merge from CGMES loader.
EMF test written from powsybl tutorial to be done.

Please check if the PR fulfills these requirements (please use '[x]' to check the checkboxes, or submit the PR and then click the checkboxes)

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)

Does this PR already have an issue describing the problem ? If so, link to this issue using '#XXX' and skip the rest

What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)

What is the current behavior? (You can also link to an open issue here)

What is the new behavior (if this is a feature change)?

Does this PR introduce a breaking change or deprecate an API? If yes, check the following:

The Breaking Change or Deprecated label has been added
The migration guide has been updated in the github wiki (What changes might users need to make in their application due to this PR?)

Other information:

(if any of the questions/checkboxes don't apply, please delete them entirely)

Signed-off-by: Bertrand Rix <bertrand.rix@artelys.com>

miovd · 2023-01-23T14:53:19Z

emf/src/test/java/com/powsybl/emf/IGMmergeTests.java

+    @Test
+    void igmsDestructiveMerge() throws IOException {
+
+        FileSystem fs = Jimfs.newFileSystem(Configuration.unix());


You can put this initialization in a setUp method annotated @Before

miovd · 2023-01-23T14:53:35Z

emf/src/test/java/com/powsybl/emf/IGMmergeTests.java

+    @Test
+    void igmsMergeWithMergingView() throws IOException {
+
+        FileSystem fs = Jimfs.newFileSystem(Configuration.unix());


Same remark

miovd · 2023-01-23T15:00:17Z

emf/src/test/java/com/powsybl/emf/IGMmergeTests.java

+                CgmesConformity1Catalog.microGridBaseCaseBoundaries());
+        Network networkBENL = Network.read(mergedResourcesBENL.dataSource());
+
+        FileSystem fs = Jimfs.newFileSystem(Configuration.unix());


Same remark

miovd · 2023-01-23T15:00:42Z

emf/src/test/java/com/powsybl/emf/IGMmergeTests.java

+        validate(serializedMergedNetwork, branchIds, generatorsId, voltageLevelIds);
+    }
+
+    public void validate(Network n, Set<String> branchIds, Set<String> generatorsId, Set<String> voltageLevelIds) {


Can be static and private

miovd · 2023-01-23T15:01:07Z

emf/src/test/java/com/powsybl/emf/IGMmergeTests.java

+        voltageLevelIds.forEach(v -> assertNotNull(n.getVoltageLevel(v)));
+    }
+
+    public void exportNetwork(Network network, Path outputDir, String baseName, Map<String, Network> validNetworks, Set<String> profilesToExport) {


Can be static and private

miovd · 2023-01-24T09:18:10Z

emf/pom.xml

+            <scope>test</scope>
+        </dependency>
+
+        <!-- Runtime dependencies -->


You can move these dependencies in test scope rather than runtime

Signed-off-by: Bertrand Rix <bertrand.rix@artelys.com>

miovd

Some comments about technical changes!
Regarding the functional scope, I think this is good for a first version, we can merge it for it to be in the next release and start a new PR improving it (particularly checking xnode and tielines).

emf/src/test/java/com/powsybl/emf/IGMmergeTests.java

miovd · 2023-01-27T08:46:19Z

emf/src/test/java/com/powsybl/emf/IGMmergeTests.java

+    private static FileSystem fs;
+
+    @BeforeAll
+    static void setUp() {


can be public and not static (fs should not be static)

In fact BeforeAll force the setUp function to be static void, thus filesystem too. Should be fixed by moving to BeforeEach, not really necessary IMHO but could avoid read/write errors.

emf/src/test/java/com/powsybl/emf/IGMmergeTests.java

miovd · 2023-01-27T08:57:57Z

emf/src/test/java/com/powsybl/emf/IGMmergeTests.java

+        Set<String> generatorsId = new HashSet<>();
+        Set<String> voltageLevelIds = new HashSet<>();
+
+        networkBENL.getBranches().forEach(b -> branchIds.add(b.getId()));


To prevent the encoding error (it will not be added in this release), do

networkBENL.getBranches().forEach(b -> branchIds.add(b.getId().replace(" ", "%20)); // FIXME workaround before fixing CGMES export/import

miovd · 2023-01-27T09:17:02Z

emf/src/test/java/com/powsybl/emf/IGMmergeTests.java

+    private static void exportEquipment(Network network, CgmesExportContext context, Path file) {
+        try (OutputStream out = Files.newOutputStream(file)) {
+            XMLStreamWriter writer = XmlUtil.initializeWriter(true, "    ", out);
+            EquipmentExport.write(network, writer, context);
+        } catch (IOException | XMLStreamException e) {
+            throw new RuntimeException(e);
+        }
+    }
+
+    private static void exportTopology(Network network, CgmesExportContext context, Path file) {
+        try (OutputStream out = Files.newOutputStream(file)) {
+            XMLStreamWriter writer = XmlUtil.initializeWriter(true, "    ", out);
+            TopologyExport.write(network, writer, context);
+        } catch (IOException | XMLStreamException e) {
+            throw new RuntimeException(e);
+        }
+    }
+
+    private static void exportSteadyStateHypothesis(Network network, CgmesExportContext context, Path file) {
+        try (OutputStream out = Files.newOutputStream(file)) {
+            XMLStreamWriter writer = XmlUtil.initializeWriter(true, "    ", out);
+            SteadyStateHypothesisExport.write(network, writer, context);
+        } catch (XMLStreamException | IOException e) {
+            throw new RuntimeException(e);
+        }
+    }
+
+    private static void exportStateVariable(Network network, CgmesExportContext context, Path file) {
+        try (OutputStream out = Files.newOutputStream(file)) {
+            XMLStreamWriter writer = XmlUtil.initializeWriter(true, "    ", out);
+            StateVariablesExport.write(network, writer, context);
+        } catch (IOException | XMLStreamException e) {
+            throw new RuntimeException(e);
+        }
+    }


Those methods can be refactored by adding a Runnable in parameters

I did it with a consumer functionnal interface.

Signed-off-by: Bertrand Rix <bertrand.rix@artelys.com>

miovd · 2023-01-30T10:31:17Z

emf/src/test/java/com/powsybl/emf/IGMmergeTests.java

+
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+
+class IGMmergeTests {


Can you add your name as @author in the javadoc?

miovd · 2023-01-30T10:31:26Z

emf/src/test/java/com/powsybl/emf/IGMmergeTests.java

+ * 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/.
+ */


Can you add the SPDX?

miovd · 2023-01-30T10:31:31Z

emf/src/test/java/com/powsybl/emf/IGMmergeTests.java

@@ -0,0 +1,218 @@
+/*
+ * Copyright (c) 2022, RTE (http://www.rte-france.com)


Signed-off-by: Bertrand Rix <bertrand.rix@artelys.com>

sonarqubecloud · 2023-01-30T11:08:32Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

WIP, Add emf merge tests.

c58bb37

Signed-off-by: Bertrand Rix <bertrand.rix@artelys.com>

obrix requested a review from miovd January 23, 2023 09:42

Fix style.

bfbf3dd

Signed-off-by: Bertrand Rix <bertrand.rix@artelys.com>

miovd reviewed Jan 24, 2023

View reviewed changes

Some adjustments after review.

f6bea46

Signed-off-by: Bertrand Rix <bertrand.rix@artelys.com>

miovd requested changes Jan 27, 2023

View reviewed changes

obrix added 2 commits January 30, 2023 10:42

Some refactoring.

998badb

Signed-off-by: Bertrand Rix <bertrand.rix@artelys.com>

Clean lambdas.

84f10a6

Signed-off-by: Bertrand Rix <bertrand.rix@artelys.com>

miovd reviewed Jan 30, 2023

View reviewed changes

obrix added 2 commits January 30, 2023 11:55

Fix headers.

b817a92

Signed-off-by: Bertrand Rix <bertrand.rix@artelys.com>

2023.

fe467d8

Signed-off-by: Bertrand Rix <bertrand.rix@artelys.com>

miovd approved these changes Jan 30, 2023

View reviewed changes

miovd changed the title ~~[WIP] EMF module and merge tests~~ EMF module and merge tests Jan 30, 2023

miovd merged commit b74ac7c into main Jan 31, 2023

miovd deleted the emf-integration branch January 31, 2023 14:55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

EMF module and merge tests #82

EMF module and merge tests #82

obrix commented Jan 23, 2023

miovd Jan 23, 2023

miovd Jan 23, 2023

miovd Jan 23, 2023

miovd Jan 23, 2023

miovd Jan 23, 2023

miovd Jan 24, 2023

miovd left a comment

miovd Jan 27, 2023

obrix Jan 27, 2023

miovd Jan 27, 2023

obrix Jan 27, 2023

miovd Jan 27, 2023 •

edited

Loading

obrix Jan 30, 2023

miovd Jan 30, 2023

miovd Jan 30, 2023

miovd Jan 30, 2023

sonarqubecloud bot commented Jan 30, 2023


		import static org.junit.jupiter.api.Assertions.assertNotNull;

		class IGMmergeTests {

		@@ -0,0 +1,218 @@
		/*
		* Copyright (c) 2022, RTE (http://www.rte-france.com)

EMF module and merge tests #82

EMF module and merge tests #82

Conversation

obrix commented Jan 23, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

miovd left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

miovd Jan 27, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Jan 30, 2023

miovd Jan 27, 2023 •

edited

Loading