Add node aliases to the spreadsheet config collection (#35)

Signed-off-by: Franck LECUYER <[email protected]>

Author: FranckLecuyer

src/main/java/org/gridsuite/studyconfig/server/dto/SpreadsheetConfigCollectionInfos.java

@@ -21,6 +21,9 @@ public record SpreadsheetConfigCollectionInfos(
     UUID id,
 
     @Schema(description = "List of spreadsheet configurations")
-    List<SpreadsheetConfigInfos> spreadsheetConfigs
+    List<SpreadsheetConfigInfos> spreadsheetConfigs,
+
+    @Schema(description = "List of node aliases")
+    List<String> nodeAliases
 ) {
 }

src/main/java/org/gridsuite/studyconfig/server/entities/SpreadsheetConfigCollectionEntity.java

@@ -35,4 +35,8 @@ public class SpreadsheetConfigCollectionEntity {
     @OrderColumn(name = "config_order")
     @Builder.Default
     private List<SpreadsheetConfigEntity> spreadsheetConfigs = new ArrayList<>();
+
+    @ElementCollection(fetch = FetchType.EAGER)
+    @CollectionTable(name = "node_aliases", foreignKey = @ForeignKey(name = "fk_spreadsheet_config_collection_node_aliases"))
+    private List<String> nodeAliases;
 }

src/main/java/org/gridsuite/studyconfig/server/service/SpreadsheetConfigService.java

@@ -137,6 +137,7 @@ public UUID createSpreadsheetConfigCollection(SpreadsheetConfigCollectionInfos d
         entity.setSpreadsheetConfigs(dto.spreadsheetConfigs().stream()
                 .map(SpreadsheetConfigMapper::toEntity)
                 .toList());
+        entity.setNodeAliases(dto.nodeAliases());
         return spreadsheetConfigCollectionRepository.save(entity).getId();
     }
 
@@ -155,7 +156,7 @@ public SpreadsheetConfigCollectionInfos getSpreadsheetConfigCollection(UUID id)
                 .orElseThrow(() -> new EntityNotFoundException(SPREADSHEET_CONFIG_COLLECTION_NOT_FOUND + id));
         return new SpreadsheetConfigCollectionInfos(entity.getId(), entity.getSpreadsheetConfigs().stream()
                 .map(SpreadsheetConfigMapper::toDto)
-                .toList());
+                .toList(), entity.getNodeAliases());
     }
 
     @Transactional
@@ -175,6 +176,7 @@ public void updateSpreadsheetConfigCollection(UUID id, SpreadsheetConfigCollecti
         entity.getSpreadsheetConfigs().addAll(dto.spreadsheetConfigs().stream()
                 .map(SpreadsheetConfigMapper::toEntity)
                 .toList());
+        entity.setNodeAliases(dto.nodeAliases());
     }
 
     @Transactional
@@ -202,6 +204,7 @@ public UUID duplicateSpreadsheetConfigCollection(UUID id) {
                     return configDuplicate;
                 })
                 .toList());
+        duplicate.setNodeAliases(new ArrayList<>(entity.getNodeAliases()));
         return spreadsheetConfigCollectionRepository.save(duplicate).getId();
     }
 

src/main/resources/db/changelog/changesets/changelog_20250317T082711Z.xml

@@ -0,0 +1,14 @@
+<?xml version="1.1" encoding="UTF-8" standalone="no"?>
+<databaseChangeLog xmlns="http://www.liquibase.org/xml/ns/dbchangelog" xmlns:ext="http://www.liquibase.org/xml/ns/dbchangelog-ext" xmlns:pro="http://www.liquibase.org/xml/ns/pro" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog-ext http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-ext.xsd http://www.liquibase.org/xml/ns/pro http://www.liquibase.org/xml/ns/pro/liquibase-pro-latest.xsd http://www.liquibase.org/xml/ns/dbchangelog http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-latest.xsd">
+    <changeSet author="lecuyerfra (generated)" id="1742200048214-1">
+        <createTable tableName="node_aliases">
+            <column name="spreadsheet_config_collection_entity_id" type="UUID">
+                <constraints nullable="false"/>
+            </column>
+            <column name="node_aliases" type="VARCHAR(255)"/>
+        </createTable>
+    </changeSet>
+    <changeSet author="lecuyerfra (generated)" id="1742200048214-2">
+        <addForeignKeyConstraint baseColumnNames="spreadsheet_config_collection_entity_id" baseTableName="node_aliases" constraintName="fk_spreadsheet_config_collection_node_aliases" deferrable="false" initiallyDeferred="false" referencedColumnNames="id" referencedTableName="spreadsheet_config_collection" validate="true"/>
+    </changeSet>
+</databaseChangeLog>

src/main/resources/db/changelog/db.changelog-master.yaml

@@ -29,3 +29,6 @@ databaseChangeLog:
   - include:
       file: changesets/changelog_20250319T134629Z.xml
       relativeToChangelogFile: true
+  - include:
+      file: changesets/changelog_20250317T082711Z.xml
+      relativeToChangelogFile: true

src/main/resources/default-spreadsheet-config-collection.json

@@ -1918,5 +1918,6 @@
         }
       ]
     }
-  ]
+  ],
+  "nodeAliases": []
 }

src/test/java/org/gridsuite/studyconfig/server/SpreadsheetConfigCollectionIntegrationTest.java

@@ -55,40 +55,57 @@ void tearDown() {
 
     @Test
     void testCreateCollection() throws Exception {
-        SpreadsheetConfigCollectionInfos collectionToCreate = new SpreadsheetConfigCollectionInfos(null, createSpreadsheetConfigs());
+        SpreadsheetConfigCollectionInfos collectionToCreate = new SpreadsheetConfigCollectionInfos(null, createSpreadsheetConfigs(), null);
 
         UUID collectionUuid = postSpreadsheetConfigCollection(collectionToCreate);
         SpreadsheetConfigCollectionInfos createdCollection = getSpreadsheetConfigCollection(collectionUuid);
 
         assertThat(createdCollection)
-                .usingRecursiveComparison()
-                .ignoringFields("spreadsheetConfigs.columns.uuid", "id", "spreadsheetConfigs.id")
-                .isEqualTo(collectionToCreate);
+            .usingRecursiveComparison()
+            .ignoringFields("spreadsheetConfigs.columns.uuid", "id", "spreadsheetConfigs.id")
+            .ignoringExpectedNullFields()
+            .isEqualTo(collectionToCreate);
+        assertThat(createdCollection.id()).isNotNull();
+    }
+
+    @Test
+    void testCreateCollectionWithAliases() throws Exception {
+        SpreadsheetConfigCollectionInfos collectionToCreate = new SpreadsheetConfigCollectionInfos(null, createSpreadsheetConfigs(), List.of("alias1", "alias2", "alias3"));
+
+        UUID collectionUuid = postSpreadsheetConfigCollection(collectionToCreate);
+        SpreadsheetConfigCollectionInfos createdCollection = getSpreadsheetConfigCollection(collectionUuid);
+
+        assertThat(createdCollection)
+            .usingRecursiveComparison()
+            .ignoringFields("spreadsheetConfigs.columns.uuid", "id", "spreadsheetConfigs.id")
+            .ignoringExpectedNullFields()
+            .isEqualTo(collectionToCreate);
         assertThat(createdCollection.id()).isNotNull();
     }
 
     @Test
     void testReadCollection() throws Exception {
-        SpreadsheetConfigCollectionInfos collectionToRead = new SpreadsheetConfigCollectionInfos(null, createSpreadsheetConfigs());
+        SpreadsheetConfigCollectionInfos collectionToRead = new SpreadsheetConfigCollectionInfos(null, createSpreadsheetConfigs(), null);
 
         UUID collectionUuid = saveAndReturnId(collectionToRead);
 
         SpreadsheetConfigCollectionInfos receivedCollection = getSpreadsheetConfigCollection(collectionUuid);
 
         assertThat(receivedCollection)
-                .usingRecursiveComparison()
-                .ignoringFields("spreadsheetConfigs.columns.uuid", "id", "spreadsheetConfigs.id")
-                .isEqualTo(collectionToRead);
+            .usingRecursiveComparison()
+            .ignoringFields("spreadsheetConfigs.columns.uuid", "id", "spreadsheetConfigs.id")
+            .ignoringExpectedNullFields()
+            .isEqualTo(collectionToRead);
         assertThat(receivedCollection.id()).isEqualTo(collectionUuid);
     }
 
     @Test
     void testUpdateCollection() throws Exception {
-        SpreadsheetConfigCollectionInfos collectionToUpdate = new SpreadsheetConfigCollectionInfos(null, createSpreadsheetConfigs());
+        SpreadsheetConfigCollectionInfos collectionToUpdate = new SpreadsheetConfigCollectionInfos(null, createSpreadsheetConfigs(), null);
 
         UUID collectionUuid = saveAndReturnId(collectionToUpdate);
 
-        SpreadsheetConfigCollectionInfos updatedCollection = new SpreadsheetConfigCollectionInfos(collectionUuid, createUpdatedSpreadsheetConfigs());
+        SpreadsheetConfigCollectionInfos updatedCollection = new SpreadsheetConfigCollectionInfos(collectionUuid, createUpdatedSpreadsheetConfigs(), null);
 
         String updatedCollectionJson = mapper.writeValueAsString(updatedCollection);
 
@@ -100,14 +117,15 @@ void testUpdateCollection() throws Exception {
         SpreadsheetConfigCollectionInfos retrievedCollection = getSpreadsheetConfigCollection(collectionUuid);
 
         assertThat(retrievedCollection)
-                .usingRecursiveComparison()
-                .ignoringFields("spreadsheetConfigs.columns.uuid", "spreadsheetConfigs.id")
-                .isEqualTo(updatedCollection);
+            .usingRecursiveComparison()
+            .ignoringFields("spreadsheetConfigs.columns.uuid", "spreadsheetConfigs.id")
+            .ignoringExpectedNullFields()
+            .isEqualTo(updatedCollection);
     }
 
     @Test
     void testDeleteCollection() throws Exception {
-        SpreadsheetConfigCollectionInfos collectionToDelete = new SpreadsheetConfigCollectionInfos(null, createSpreadsheetConfigs());
+        SpreadsheetConfigCollectionInfos collectionToDelete = new SpreadsheetConfigCollectionInfos(null, createSpreadsheetConfigs(), null);
 
         UUID collectionUuid = saveAndReturnId(collectionToDelete);
 
@@ -120,23 +138,24 @@ void testDeleteCollection() throws Exception {
 
     @Test
     void testDuplicateCollection() throws Exception {
-        SpreadsheetConfigCollectionInfos collectionToCreate = new SpreadsheetConfigCollectionInfos(null, createSpreadsheetConfigs());
+        SpreadsheetConfigCollectionInfos collectionToCreate = new SpreadsheetConfigCollectionInfos(null, createSpreadsheetConfigs(), null);
         UUID collectionUuid = postSpreadsheetConfigCollection(collectionToCreate);
 
         UUID duplicatedCollectionUuid = duplicateSpreadsheetConfigCollection(collectionUuid);
 
         SpreadsheetConfigCollectionInfos duplicatedCollection = getSpreadsheetConfigCollection(duplicatedCollectionUuid);
         assertThat(duplicatedCollection)
-                .usingRecursiveComparison()
-                .ignoringFields("spreadsheetConfigs.columns.uuid", "id", "spreadsheetConfigs.id")
-                .isEqualTo(collectionToCreate);
+            .usingRecursiveComparison()
+            .ignoringFields("spreadsheetConfigs.columns.uuid", "id", "spreadsheetConfigs.id")
+            .ignoringExpectedNullFields()
+            .isEqualTo(collectionToCreate);
         assertThat(duplicatedCollection.id()).isNotEqualTo(collectionUuid);
     }
 
     @Test
     void testMergeModelsIntoNewCollection() throws Exception {
         // create a first collection with 2 configs
-        SpreadsheetConfigCollectionInfos collectionToCreate = new SpreadsheetConfigCollectionInfos(null, createSpreadsheetConfigs());
+        SpreadsheetConfigCollectionInfos collectionToCreate = new SpreadsheetConfigCollectionInfos(null, createSpreadsheetConfigs(), null);
         UUID collectionUuid = postSpreadsheetConfigCollection(collectionToCreate);
         List<UUID> configIds = getSpreadsheetConfigCollection(collectionUuid).spreadsheetConfigs().stream().map(SpreadsheetConfigInfos::id).toList();
         assertThat(configIds).hasSize(2);
@@ -163,7 +182,7 @@ void testCreateDefaultCollection() throws Exception {
 
     @Test
     void testAddSpreadsheetConfigToCollection() throws Exception {
-        SpreadsheetConfigCollectionInfos initialCollection = new SpreadsheetConfigCollectionInfos(null, createSpreadsheetConfigs());
+        SpreadsheetConfigCollectionInfos initialCollection = new SpreadsheetConfigCollectionInfos(null, createSpreadsheetConfigs(), null);
         UUID collectionUuid = postSpreadsheetConfigCollection(initialCollection);
 
         List<ColumnInfos> columnInfos = Arrays.asList(
@@ -189,7 +208,7 @@ void testAddSpreadsheetConfigToCollection() throws Exception {
 
     @Test
     void testRemoveSpreadsheetConfigFromCollection() throws Exception {
-        SpreadsheetConfigCollectionInfos initialCollection = new SpreadsheetConfigCollectionInfos(null, createSpreadsheetConfigs());
+        SpreadsheetConfigCollectionInfos initialCollection = new SpreadsheetConfigCollectionInfos(null, createSpreadsheetConfigs(), null);
         UUID collectionUuid = postSpreadsheetConfigCollection(initialCollection);
 
         SpreadsheetConfigCollectionInfos createdCollection = getSpreadsheetConfigCollection(collectionUuid);
@@ -218,7 +237,7 @@ void testAddSpreadsheetConfigToNonExistentCollection() throws Exception {
 
     @Test
     void testRemoveNonExistentSpreadsheetConfig() throws Exception {
-        SpreadsheetConfigCollectionInfos collection = new SpreadsheetConfigCollectionInfos(null, createSpreadsheetConfigs());
+        SpreadsheetConfigCollectionInfos collection = new SpreadsheetConfigCollectionInfos(null, createSpreadsheetConfigs(), null);
         UUID collectionUuid = postSpreadsheetConfigCollection(collection);
 
         UUID nonExistentConfigId = UUID.randomUUID();
@@ -229,7 +248,7 @@ void testRemoveNonExistentSpreadsheetConfig() throws Exception {
     @Test
     void testReorderSpreadsheetConfigs() throws Exception {
         // Create a collection with multiple configs
-        SpreadsheetConfigCollectionInfos collection = new SpreadsheetConfigCollectionInfos(null, createSpreadsheetConfigs());
+        SpreadsheetConfigCollectionInfos collection = new SpreadsheetConfigCollectionInfos(null, createSpreadsheetConfigs(), null);
         UUID collectionId = postSpreadsheetConfigCollection(collection);
 
         // Get the created collection to get the config IDs