Drop support for CIM14 #3375

quinarygio · 2025-03-20T10:39:31Z

Please check if the PR fulfills these requirements

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) --> The documentation mentions only version 2.4.15 (CIM 16) and 3.0 (CIM 100). CIM 14 was not mentioned.
A PR or issue has been opened in all impacted repositories (if any)

Does this PR already have an issue describing the problem?

Fixes #3290

Does this PR introduce a breaking change or deprecate an API?

Yes
No

If yes, please check if the following requirements are fulfilled

The Breaking Change or Deprecated label has been added
The migration steps are described in the following section

What changes might users need to make in their application due to this PR? (migration steps)

CIM 14 CGMES files are not supported anymore. Please use CIM16 (2.4.15) or CIM100 (3.0) files.
As a direct consequence, the followings were removed:
- CgmesModel.CIM_14_NAMESPACE,
- CgmesModel.CIM_14,
- CgmesOnDataSource.existsCim14() : now it would have always returned false,
- CgmesModel.Cim.hasProfiles(): now it would have always returned true.
The CgmesModel interface was also modified. The method modelProfiles is no longer a default method, meaning that you have now to implement it if you designed your own implementation of the interface.
The public constant CIM_LIST from the CgmesNamespace class has gone from List.of(CIM_14, CIM_16, CIM_100) to List.of(CIM_16, CIM_100)
Deleted CIM14 network files are available in previous releases ( $vX.Y.Z \leq v6.7.0$) if needed.

Signed-off-by: Giovanni Ferrari <[email protected]>

So-Fras

Thanks for your work! I left a few comments and some questions for @rcourtier :)

...ersion/src/main/java/com/powsybl/cgmes/conversion/elements/SynchronousMachineConversion.java

cgmes/cgmes-model/src/test/java/com/powsybl/cgmes/model/CgmesOnDataSourceTest.java

cgmes/cgmes-model/src/test/java/com/powsybl/cgmes/model/WindingTypeTest.java

...-conversion/src/test/java/com/powsybl/cgmes/conversion/test/ImportExportPerformanceTest.java

cgmes/cgmes-model/src/main/java/com/powsybl/cgmes/model/triplestore/CgmesModelTripleStore.java

...onversion/src/test/java/com/powsybl/cgmes/conversion/test/export/CgmesExportContextTest.java

...ersion/src/main/java/com/powsybl/cgmes/conversion/elements/SynchronousMachineConversion.java

...-conversion/src/test/java/com/powsybl/cgmes/conversion/test/ImportExportPerformanceTest.java

cgmes/cgmes-model-test/src/main/java/com/powsybl/cgmes/model/test/Cim14SmallCasesCatalog.java

...onversion/src/test/java/com/powsybl/cgmes/conversion/test/export/CgmesExportContextTest.java

cgmes/cgmes-model/src/main/java/com/powsybl/cgmes/model/CgmesNamespace.java

cgmes/cgmes-model/src/main/java/com/powsybl/cgmes/model/WindingType.java

cgmes/cgmes-model/src/main/java/com/powsybl/cgmes/model/triplestore/CgmesModelTripleStore.java

cgmes/cgmes-model/src/test/java/com/powsybl/cgmes/model/CgmesOnDataSourceTest.java

Signed-off-by: Giovanni Ferrari <[email protected]>

So-Fras · 2025-03-27T11:58:37Z

Thanks for the changes, I left new comments too (things I missed the first time).

There are also 2 test resources files that you can delete: empty_cim14_EQ.xml and empty_cim14_SV.xml.

There are also tests where "cim14" still appears, namely:

CgmesNamingStrategyTest
EquipmentExportTest
EquipementExportTest
CgmesOnDataSourceTest

(the cgmes-conversion module test resources cim14 folder should be deleted too)

In the OperationalLimitConversion class, there is a comment mentioning CIM14 (line 52).

The file invalidContent_EQ in the cgmes-model-test still mentions "cim14" as well.

quinarygio · 2025-03-27T17:24:26Z

Thanks for the changes, I left new comments too (things I missed the first time).

There are also 2 test resources files that you can delete: empty_cim14_EQ.xml and empty_cim14_SV.xml.

There are also tests where "cim14" still appears, namely:

CgmesNamingStrategyTest

EquipmentExportTest

EquipementExportTest

CgmesOnDataSourceTest

(the cgmes-conversion module test resources cim14 folder should be deleted too)

In the OperationalLimitConversion class, there is a comment mentioning CIM14 (line 52).

The file invalidContent_EQ in the cgmes-model-test still mentions "cim14" as well.

CgmesNamingStrategyTest and EquipmentExportTest use files nordic32.xiidm and ieee14.xiidm from cim14 folder, but the files are in XIIDM format. What should I do ?

CgmesOnDataSourceTest.testExists() test is using empty_cim14_EQ.xml to test that CIM14 is not supported

OperationalLimitConversion what should I do with this check ?

 if (limitSubclass == null) {
                // Support for CIM14, all limits are assumed to be current
                limitSubclass = CgmesNames.CURRENT_LIMIT;
 }

rcourtier · 2025-03-28T08:04:52Z

In CgmesNamespace class, can you please remove the hasProfiles() from the Cim interface and AbstractCim implementation?
It was intended to highlight the difference between CIM14 which has no profiles and CIM16 and above which have profiles. Now the method always return true, so it has lost its interest.

cgmes/cgmes-model/src/test/java/com/powsybl/cgmes/model/CgmesOnDataSourceTest.java

...n/java/com/powsybl/cgmes/conversion/elements/transformers/AbstractTransformerConversion.java

rcourtier · 2025-03-28T10:39:27Z

CgmesNamingStrategyTest and EquipmentExportTest use files nordic32.xiidm and ieee14.xiidm from cim14 folder, but the files are in XIIDM format. What should I do ?

You can remove the files (the whole folder cim14 actually) and the corresponding tests in CgmesNamingStrategyTest and EquipmentExportTest

CgmesOnDataSourceTest.testExists() test is using empty_cim14_EQ.xml to test that CIM14 is not supported

You can keep empty_cim14_EQ.xml as you said to highlight the fact that CIM14 is not supported.

OperationalLimitConversion what should I do with this check ?

 if (limitSubclass == null) {
                // Support for CIM14, all limits are assumed to be current
                limitSubclass = CgmesNames.CURRENT_LIMIT;
 }

You can consider that limitSubclass is not null:

if (limitSubclass.equals(CgmesNames.ACTIVE_POWER_LIMIT) || limitSubclass.equals(CgmesNames.APPARENT_POWER_LIMIT) || limitSubclass.equals(CgmesNames.CURRENT_LIMIT)) {
    if (terminalId != null) {
    ...

Signed-off-by: Giovanni Ferrari <[email protected]>

...nversion/src/main/java/com/powsybl/cgmes/conversion/elements/OperationalLimitConversion.java

...nversion/src/test/java/com/powsybl/cgmes/conversion/test/export/CgmesNamingStrategyTest.java

Signed-off-by: Giovanni Ferrari <[email protected]>

rcourtier

Thank you for your work!

olperr1 · 2025-04-03T14:51:25Z

...nversion/src/main/java/com/powsybl/cgmes/conversion/elements/OperationalLimitConversion.java

-                // Support for CIM14, all limits are assumed to be current
-                limitSubclass = CgmesNames.CURRENT_LIMIT;
-            }
+        if (limitSubclass.equals(CgmesNames.ACTIVE_POWER_LIMIT) || limitSubclass.equals(CgmesNames.APPARENT_POWER_LIMIT) || limitSubclass.equals(CgmesNames.CURRENT_LIMIT)) {


It would be cleaner this way:

Suggested change

if (limitSubclass.equals(CgmesNames.ACTIVE_POWER_LIMIT) || limitSubclass.equals(CgmesNames.APPARENT_POWER_LIMIT) || limitSubclass.equals(CgmesNames.CURRENT_LIMIT)) {

if (CgmesNames.ACTIVE_POWER_LIMIT.equals(limitSubclass) || CgmesNames.APPARENT_POWER_LIMIT.equals(limitSubclass) || CgmesNames.CURRENT_LIMIT.equals(limitSubclass)) {

olperr1 · 2025-04-03T14:52:31Z

...ersion/src/main/java/com/powsybl/cgmes/conversion/elements/SynchronousMachineConversion.java

@@ -30,8 +30,7 @@ public class SynchronousMachineConversion extends AbstractReactiveLimitsOwnerCon
    public SynchronousMachineConversion(PropertyBag sm, Context context) {
        super(CgmesNames.SYNCHRONOUS_MACHINE, sm, context);
        String type = p.getLocal("type");
-        // CIM14 uses Type.condenser, CIM16 and CIM100 use Kind.condenser
-        isCondenser = type != null && type.endsWith(".condenser");
+        isCondenser = type.equals("SynchronousMachineKind.condenser");


Suggested change

isCondenser = type.equals("SynchronousMachineKind.condenser");

isCondenser = "SynchronousMachineKind.condenser".equals(type);

olperr1 · 2025-04-03T15:35:29Z

cgmes/cgmes-model/src/test/java/com/powsybl/cgmes/model/CgmesOnDataSourceTest.java

-                Arguments.of("rdf cim16 not cim14", "empty_cim16_EQ.xml", "14", false),
-                Arguments.of("rdf cim14 not cim16", "empty_cim14_EQ.xml", "16", false)
-        );
+                Arguments.of("EQ cim14", "empty_cim14_EQ.xml", false),


Just to be clear why we have kept this test:

Suggested change

Arguments.of("EQ cim14", "empty_cim14_EQ.xml", false),

Arguments.of("EQ cim14", "empty_cim14_EQ.xml", false), // CIM14 is not supported

olperr1 · 2025-04-03T15:41:05Z

...nversion/src/test/java/com/powsybl/cgmes/conversion/test/export/CgmesNamingStrategyTest.java

@@ -41,23 +37,6 @@
 */
 class CgmesNamingStrategyTest extends AbstractSerDeTest {

-    @Test


Shouldn't we keep an equivalent of the deleted tests, but in another CIM version?

A test with NamingStrategyFactory.CGMES has been kept (testExportUsingCgmesNamingStrategyMicroGrid()). It was deemed complete enough to test the naming strategy.

olperr1 · 2025-04-03T15:51:08Z

...s-conversion/src/test/java/com/powsybl/cgmes/conversion/test/export/EquipmentExportTest.java

@@ -199,145 +194,6 @@ void microGridCreateEquivalentInjectionAliases() throws IOException, XMLStreamEx
        assertTrue(compareNetworksEQdata(expected, actual));
    }

-    @Test
-    void nordic32() throws IOException, XMLStreamException {


Shouldn't we also try to keep these tests?

(On a note side, there's still a CIM16 nordic32.xml file in the resources which doesn't seem to be called.)

Signed-off-by: Giovanni Ferrari <[email protected]>

sonarqubecloud · 2025-04-10T10:36:31Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

Drop support for CIM14

367fce2

Signed-off-by: Giovanni Ferrari <[email protected]>

quinarygio linked an issue Mar 20, 2025 that may be closed by this pull request

Drop support for CIM14 #3290

Open

quinarygio marked this pull request as draft March 20, 2025 10:39

quinarygio added 3 commits March 20, 2025 12:15

ExportToCimVersionTest: remove unused method

3b489a4

Signed-off-by: Giovanni Ferrari <[email protected]>

CgmesPhaseTapChangerBuilder: remove useless method

fb429c0

Signed-off-by: Giovanni Ferrari <[email protected]>

Remove comments about CIM14

b3ca323

Signed-off-by: Giovanni Ferrari <[email protected]>

quinarygio changed the title ~~[WIP] Drop support for CIM14~~ Drop support for CIM14 Mar 20, 2025

quinarygio marked this pull request as ready for review March 20, 2025 13:51

So-Fras added the Release 06/2025 label Mar 20, 2025

So-Fras requested changes Mar 20, 2025

View reviewed changes

So-Fras requested a review from rcourtier March 20, 2025 16:07

rcourtier requested changes Mar 26, 2025

View reviewed changes

Fixes after review

99f2d47

Signed-off-by: Giovanni Ferrari <[email protected]>

rcourtier requested changes Mar 28, 2025

View reviewed changes

quinarygio added 2 commits March 31, 2025 14:30

Fixes after review

6a0e1cf

Signed-off-by: Giovanni Ferrari <[email protected]>

Fix sonar issues

f3bef18

Signed-off-by: Giovanni Ferrari <[email protected]>

rcourtier requested changes Mar 31, 2025

View reviewed changes

...nversion/src/main/java/com/powsybl/cgmes/conversion/elements/OperationalLimitConversion.java Outdated Show resolved Hide resolved

...nversion/src/test/java/com/powsybl/cgmes/conversion/test/export/CgmesNamingStrategyTest.java Show resolved Hide resolved

quinarygio and others added 2 commits April 1, 2025 14:27

More fixes

d3dcbde

Signed-off-by: Giovanni Ferrari <[email protected]>

Merge branch 'main' into drop-support-for-cim14

07e1c71

So-Fras added the Breaking Change API is broken label Apr 2, 2025

So-Fras previously approved these changes Apr 2, 2025

View reviewed changes

rcourtier previously approved these changes Apr 3, 2025

View reviewed changes

So-Fras requested review from olperr1 and flo-dup April 3, 2025 12:30

olperr1 changed the title ~~Drop support for CIM14~~ Drop support for CIM14 Apr 3, 2025

olperr1 requested changes Apr 3, 2025

View reviewed changes

Changes after review

eb95a36

Signed-off-by: Giovanni Ferrari <[email protected]>

quinarygio dismissed stale reviews from rcourtier and So-Fras via eb95a36 April 10, 2025 10:24

alicecaron assigned quinarygio Apr 10, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Drop support for CIM14 #3375

Drop support for CIM14 #3375

quinarygio commented Mar 20, 2025 •

edited by olperr1

Loading

So-Fras left a comment

So-Fras commented Mar 27, 2025

quinarygio commented Mar 27, 2025

rcourtier commented Mar 28, 2025

rcourtier commented Mar 28, 2025 •

edited

Loading

rcourtier left a comment

olperr1 Apr 3, 2025

olperr1 Apr 3, 2025

olperr1 Apr 3, 2025

olperr1 Apr 3, 2025

So-Fras Apr 4, 2025

olperr1 Apr 3, 2025

sonarqubecloud bot commented Apr 10, 2025

	if (limitSubclass.equals(CgmesNames.ACTIVE_POWER_LIMIT) \|\| limitSubclass.equals(CgmesNames.APPARENT_POWER_LIMIT) \|\| limitSubclass.equals(CgmesNames.CURRENT_LIMIT)) {
	if (CgmesNames.ACTIVE_POWER_LIMIT.equals(limitSubclass) \|\| CgmesNames.APPARENT_POWER_LIMIT.equals(limitSubclass) \|\| CgmesNames.CURRENT_LIMIT.equals(limitSubclass)) {

	isCondenser = type.equals("SynchronousMachineKind.condenser");
	isCondenser = "SynchronousMachineKind.condenser".equals(type);

	Arguments.of("EQ cim14", "empty_cim14_EQ.xml", false),
	Arguments.of("EQ cim14", "empty_cim14_EQ.xml", false), // CIM14 is not supported

Drop support for CIM14 #3375

Are you sure you want to change the base?

Drop support for CIM14 #3375

Conversation

quinarygio commented Mar 20, 2025 • edited by olperr1 Loading

So-Fras left a comment

Choose a reason for hiding this comment

So-Fras commented Mar 27, 2025

quinarygio commented Mar 27, 2025

rcourtier commented Mar 28, 2025

rcourtier commented Mar 28, 2025 • edited Loading

rcourtier left a comment

Choose a reason for hiding this comment

olperr1 Apr 3, 2025

Choose a reason for hiding this comment

olperr1 Apr 3, 2025

Choose a reason for hiding this comment

olperr1 Apr 3, 2025

Choose a reason for hiding this comment

olperr1 Apr 3, 2025

Choose a reason for hiding this comment

So-Fras Apr 4, 2025

Choose a reason for hiding this comment

olperr1 Apr 3, 2025

Choose a reason for hiding this comment

sonarqubecloud bot commented Apr 10, 2025

Quality Gate passed

quinarygio commented Mar 20, 2025 •

edited by olperr1

Loading

rcourtier commented Mar 28, 2025 •

edited

Loading