Skip to content

Clean orphans when updating composite modifications #843

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Meklo wants to merge 1 commit into
base: main
Choose a base branch
from
+47 −31
Open

Clean orphans when updating composite modifications #843

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions ...in/java/org/gridsuite/modification/server/repositories/NetworkModificationRepository.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,10 @@ public void updateCompositeModification(@NonNull UUID compositeUuid, @NonNull Li
ModificationEntity::getId,
e -> ModificationEntity.fromDTO(toModificationsInfosOptimized(e))
));

//Delete previously held modifications
deleteModifications(compositeEntity.getModifications());

// Reorder clones to match caller-specified order
List<ModificationEntity> copyEntities = modificationUuids.stream()
.map(cloneByUuid::get)
Expand Down
74 changes: 43 additions & 31 deletions src/test/java/org/gridsuite/modification/server/CompositeControllerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
import org.gridsuite.modification.server.entities.CompositeModificationEntity;
import org.gridsuite.modification.server.entities.ModificationEntity;
import org.gridsuite.modification.server.repositories.CompositeModificationRepository;
import org.gridsuite.modification.server.repositories.ModificationRepository;
import org.gridsuite.modification.server.repositories.NetworkModificationRepository;
import org.gridsuite.modification.server.service.ReportService;
import org.gridsuite.modification.server.utils.NetworkCreation;
Expand Down Expand Up @@ -72,7 +73,10 @@ class CompositeControllerTest {
private ObjectWriter objectWriter;

@Autowired
private NetworkModificationRepository modificationRepository;
private NetworkModificationRepository networkModificationRepository;

@Autowired
private ModificationRepository modificationRepository;

@Autowired
private CompositeModificationRepository compositeRepository;
Expand All @@ -93,21 +97,21 @@ void setUp() {
objectWriter = mapper.writer().withDefaultPrettyPrinter();
network = NetworkCreation.create(TEST_NETWORK_ID, true);
when(networkStoreService.getNetwork(eq(TEST_NETWORK_ID), nullable(PreloadingStrategy.class))).then((Answer<Network>) invocation -> network);
modificationRepository.deleteAll();
networkModificationRepository.deleteAll();
}

@AfterEach
void tearOff() {
// clean DB
modificationRepository.deleteAll();
networkModificationRepository.deleteAll();
}

@Test
void testSplit() throws Exception {
// Insert some switch modifications in the group
int modificationsNumber = 2;
List<ModificationInfos> modificationList = createSomeSwitchModifications(TEST_GROUP_ID, modificationsNumber);
assertEquals(modificationsNumber, modificationRepository.getModifications(TEST_GROUP_ID, true, true).size());
assertEquals(modificationsNumber, networkModificationRepository.getModifications(TEST_GROUP_ID, true, true).size());

// Create a composite modification with the switch modification
List<UUID> modificationUuids = modificationList.stream().map(ModificationInfos::getUuid).toList();
Expand All @@ -119,9 +123,9 @@ void testSplit() throws Exception {
.modificationsInfos(modificationList)
.build();
UUID compositeModificationUuid = mapper.readValue(mvcResult.getResponse().getContentAsString(), new TypeReference<>() { });
assertThat(modificationRepository.getModificationInfo(compositeModificationUuid)).recursivelyEquals(compositeModificationInfos);
assertThat(networkModificationRepository.getModificationInfo(compositeModificationUuid)).recursivelyEquals(compositeModificationInfos);

List<ModificationInfos> modificationInfosList = modificationRepository.getModifications(TEST_GROUP_ID, true, true);
List<ModificationInfos> modificationInfosList = networkModificationRepository.getModifications(TEST_GROUP_ID, true, true);
assertEquals(modificationsNumber, modificationInfosList.size());

// get the composite modification (metadata only)
Expand All @@ -148,7 +152,7 @@ void testSplit() throws Exception {
.modificationsInfos(otherModificationList)
.build();
UUID otherCompositeModificationUuid = mapper.readValue(mvcResult.getResponse().getContentAsString(), new TypeReference<>() { });
assertThat(modificationRepository.getModificationInfo(otherCompositeModificationUuid)).recursivelyEquals(otherCompositeModificationInfos);
assertThat(networkModificationRepository.getModificationInfo(otherCompositeModificationUuid)).recursivelyEquals(otherCompositeModificationInfos);

// get both composite modifications
mvcResult = mockMvc.perform(get(URI_GET_COMPOSITE_NETWORK_MODIF_CONTENT + "/network-modifications?uuids=" + compositeModificationUuid + "&uuids=" + otherCompositeModificationUuid))
Expand Down Expand Up @@ -177,7 +181,7 @@ void testSplit() throws Exception {

assertApplicationStatusOK(mvcResult);

List<ModificationInfos> newModificationList = modificationRepository.getModifications(TEST_GROUP_ID, false, true);
List<ModificationInfos> newModificationList = networkModificationRepository.getModifications(TEST_GROUP_ID, false, true);
assertEquals(modificationsNumber * 2, newModificationList.size());
List<UUID> newModificationUuidList = newModificationList.stream().map(ModificationInfos::getUuid).toList();
assertEquals(modificationUuids.getFirst(), newModificationUuidList.getFirst());
Expand All @@ -198,7 +202,7 @@ void testInsert() throws Exception {
.andExpect(status().isOk()).andReturn();
UUID compositeModificationUuid = mapper.readValue(mvcResult.getResponse().getContentAsString(), new TypeReference<>() { });

List<ModificationInfos> modificationInfosList = modificationRepository.getModifications(TEST_GROUP_ID, true, true);
List<ModificationInfos> modificationInfosList = networkModificationRepository.getModifications(TEST_GROUP_ID, true, true);
assertEquals(modificationsNumber, modificationInfosList.size());

// Insert the composite modification in the group
Expand All @@ -212,7 +216,7 @@ void testInsert() throws Exception {
.content(bodyJson).contentType(MediaType.APPLICATION_JSON), status().isOk()
);
assertApplicationStatusOK(mvcResult);
List<ModificationInfos> newModificationList = modificationRepository.getModifications(TEST_GROUP_ID, false, true);
List<ModificationInfos> newModificationList = networkModificationRepository.getModifications(TEST_GROUP_ID, false, true);
assertEquals(modificationsNumber + 1, newModificationList.size());
CompositeModificationInfos insertedComposite = (CompositeModificationInfos) newModificationList.stream().filter(modificationInfos ->
modificationInfos.getType().equals(COMPOSITE_MODIFICATION)).findFirst().orElseThrow();
Expand Down Expand Up @@ -241,7 +245,7 @@ private List<ModificationInfos> createSomeSwitchModifications(UUID groupId, int
mvcResult = runRequestAsync(mockMvc, post(URI_NETWORK_MODIF_BASE + "?groupUuid=" + groupId).content(bodyJson).contentType(MediaType.APPLICATION_JSON), status().isOk());
assertApplicationStatusOK(mvcResult);
}
var modificationList = modificationRepository.getModifications(groupId, false, true);
var modificationList = networkModificationRepository.getModifications(groupId, false, true);
assertEquals(number, modificationList.size());
return modificationList;
}
Expand Down Expand Up @@ -285,12 +289,12 @@ void testDuplicateCompositeModification() throws Exception {
assertNotEquals(returnedSourceId, returnedNewId);
assertEquals(compositeModificationUuid, returnedSourceId);

ModificationInfos sourceModificationInfos = modificationRepository.getModificationInfo(compositeModificationUuid);
ModificationInfos newModificationInfos = modificationRepository.getModificationInfo(returnedNewId);
ModificationInfos sourceModificationInfos = networkModificationRepository.getModificationInfo(compositeModificationUuid);
ModificationInfos newModificationInfos = networkModificationRepository.getModificationInfo(returnedNewId);
// compare duplicate with the source (same data except uuid)
assertThat(sourceModificationInfos).recursivelyEquals(newModificationInfos);
// source group has not changed
List<ModificationInfos> groupModifications = modificationRepository.getModifications(TEST_GROUP_ID, true, true, false);
List<ModificationInfos> groupModifications = networkModificationRepository.getModifications(TEST_GROUP_ID, true, true, false);
assertEquals(1, groupModifications.size());
assertEquals(modificationUuidList.getFirst(), groupModifications.getFirst().getUuid());

Expand All @@ -300,20 +304,20 @@ void testDuplicateCompositeModification() throws Exception {
.andExpect(status().isOk());

// source group has not changed
groupModifications = modificationRepository.getModifications(TEST_GROUP_ID, true, true, false);
groupModifications = networkModificationRepository.getModifications(TEST_GROUP_ID, true, true, false);
assertEquals(1, groupModifications.size());
assertEquals(modificationUuidList.getFirst(), groupModifications.getFirst().getUuid());
// duplicate has been deleted
assertEquals("MODIFICATION_NOT_FOUND : " + returnedNewId, assertThrows(NetworkModificationException.class, ()
-> modificationRepository.getModificationInfo(returnedNewId)).getMessage());
-> networkModificationRepository.getModificationInfo(returnedNewId)).getMessage());
}

@Test
void testUpdateNetworkCompositeModification() throws Exception {
// Insert some switch modifications in the group
int modificationsNumber = 3;
List<ModificationInfos> modificationList = createSomeSwitchModifications(TEST_GROUP_ID, modificationsNumber);
assertEquals(modificationsNumber, modificationRepository.getModifications(TEST_GROUP_ID, true, true).size());
assertEquals(modificationsNumber, networkModificationRepository.getModifications(TEST_GROUP_ID, true, true).size());

// Create a composite modification with the switch modifications
List<UUID> modificationUuids = modificationList.stream().map(ModificationInfos::getUuid).toList();
Expand All @@ -327,11 +331,19 @@ void testUpdateNetworkCompositeModification() throws Exception {
List<ModificationInfos> newModificationList = createSomeSwitchModifications(TEST_GROUP2_ID, newModificationsNumber);
List<UUID> newModificationUuids = newModificationList.stream().map(ModificationInfos::getUuid).toList();

mvcResult = mockMvc.perform(get(URI_GET_COMPOSITE_NETWORK_MODIF_CONTENT + "/network-modifications?uuids={id}&onlyMetadata=false", compositeModificationUuid))
.andExpect(status().isOk()).andReturn();
Map<UUID, List<ModificationInfos>> compositeContentMap = mapper.readValue(mvcResult.getResponse().getContentAsString(), new TypeReference<>() { });
List<UUID> baseCompositeContent = compositeContentMap.get(compositeModificationUuid).stream().map(ModificationInfos::getUuid).toList();

// Update the composite modification with the new modifications
mockMvc.perform(put(URI_COMPOSITE_NETWORK_MODIF_BASE + "/" + compositeModificationUuid)
.content(mapper.writeValueAsString(newModificationUuids)).contentType(MediaType.APPLICATION_JSON))
.andExpect(status().isOk());

// Check the previously held modifications were deleted
assertEquals(0, modificationRepository.findAllByIdIn(baseCompositeContent).size());

// Get the composite modification content and verify it has been updated
mvcResult = mockMvc.perform(get(URI_GET_COMPOSITE_NETWORK_MODIF_CONTENT + "/network-modifications?uuids={id}&onlyMetadata=false", compositeModificationUuid))
.andExpect(status().isOk()).andReturn();
Expand Down Expand Up @@ -457,7 +469,7 @@ void testMoveSubModificationFromCompositeToRoot() throws Exception {
List<UUID> actualSubUuids = initialMap.get(compositeUuid).stream().map(ModificationInfos::getUuid).toList();
assertEquals(2, actualSubUuids.size());

int rootSizeBefore = modificationRepository.getModifications(TEST_GROUP_ID, true, true).size();
int rootSizeBefore = networkModificationRepository.getModifications(TEST_GROUP_ID, true, true).size();

// Move first sub-modification from composite to root level (no targetCompositeUuid)
UUID movingUuid = actualSubUuids.get(0);
Expand All @@ -475,15 +487,15 @@ void testMoveSubModificationFromCompositeToRoot() throws Exception {
assertEquals(actualSubUuids.get(1), resultMap.get(compositeUuid).get(0).getUuid());

// Root group should have one more modification
assertEquals(rootSizeBefore + 1, modificationRepository.getModifications(TEST_GROUP_ID, true, true).size());
assertEquals(rootSizeBefore + 1, networkModificationRepository.getModifications(TEST_GROUP_ID, true, true).size());

// The moved modification must now belong to TEST_GROUP_ID (has a group at root level)
ModificationEntity movedEntity = modificationRepository.getModificationEntity(movingUuid);
ModificationEntity movedEntity = networkModificationRepository.getModificationEntity(movingUuid);
assertNotNull(movedEntity.getGroup());
assertEquals(TEST_GROUP_ID, movedEntity.getGroup().getId());

// The remaining sub-modification must still have no group (still owned by the composite)
ModificationEntity remainingEntity = modificationRepository.getModificationEntity(actualSubUuids.get(1));
ModificationEntity remainingEntity = networkModificationRepository.getModificationEntity(actualSubUuids.get(1));
assertNull(remainingEntity.getGroup());
}

Expand All @@ -493,7 +505,7 @@ void testAssembleNetworkModificationsIntoNewComposite() throws Exception {
List<ModificationInfos> rootMods = createSomeSwitchModifications(TEST_GROUP_ID, 3);
final List<UUID> originalRootModUuids = rootMods.stream().map(ModificationInfos::getUuid).toList();

assertEquals(3, modificationRepository.getModifications(TEST_GROUP_ID, true, true).size());
assertEquals(3, networkModificationRepository.getModifications(TEST_GROUP_ID, true, true).size());

// ---- 1. Assemble the first 2 root-level modifications into a new composite
List<UUID> assembledModificationUuids = originalRootModUuids.subList(0, 2);
Expand All @@ -506,7 +518,7 @@ void testAssembleNetworkModificationsIntoNewComposite() throws Exception {
assertNotNull(firstCompositeUuid);

// The root group should now contain the new composite and the remaining non-assembled modification
List<ModificationInfos> rootModificationsAfterAssemble = modificationRepository.getModifications(TEST_GROUP_ID, true, true);
List<ModificationInfos> rootModificationsAfterAssemble = networkModificationRepository.getModifications(TEST_GROUP_ID, true, true);
assertEquals(2, rootModificationsAfterAssemble.size());
assertEquals(firstCompositeUuid, rootModificationsAfterAssemble.getFirst().getUuid());
assertEquals(COMPOSITE_MODIFICATION, rootModificationsAfterAssemble.getFirst().getType());
Expand All @@ -529,13 +541,13 @@ void testAssembleNetworkModificationsIntoNewComposite() throws Exception {
assertEquals(TEST_GROUP_ID, firstComposite.getGroup().getId());

// The assembled modifications must no longer belong directly to the group
ModificationEntity firstAssembledEntity = modificationRepository.getModificationEntity(originalRootModUuids.get(0));
ModificationEntity secondAssembledEntity = modificationRepository.getModificationEntity(originalRootModUuids.get(1));
ModificationEntity firstAssembledEntity = networkModificationRepository.getModificationEntity(originalRootModUuids.get(0));
ModificationEntity secondAssembledEntity = networkModificationRepository.getModificationEntity(originalRootModUuids.get(1));
assertNull(firstAssembledEntity.getGroup());
assertNull(secondAssembledEntity.getGroup());

// The non-assembled modification must still belong to TEST_GROUP_ID
ModificationEntity remainingInGroupEntity = modificationRepository.getModificationEntity(originalRootModUuids.get(2));
ModificationEntity remainingInGroupEntity = networkModificationRepository.getModificationEntity(originalRootModUuids.get(2));
assertNotNull(remainingInGroupEntity.getGroup());
assertEquals(TEST_GROUP_ID, remainingInGroupEntity.getGroup().getId());

Expand All @@ -551,7 +563,7 @@ void testAssembleNetworkModificationsIntoNewComposite() throws Exception {
assertNotNull(twodepthCompositeUuid);

// The root group should now contain the new composite and nothing else
rootModificationsAfterAssemble = modificationRepository.getModifications(TEST_GROUP_ID, true, true);
rootModificationsAfterAssemble = networkModificationRepository.getModifications(TEST_GROUP_ID, true, true);
assertEquals(1, rootModificationsAfterAssemble.size());

// The first composite should contain the new composite, then the other untouched modification
Expand Down Expand Up @@ -669,7 +681,7 @@ void testMoveSubModificationFromRootToComposite() throws Exception {
List<UUID> actualSubUuids = initialMap.get(compositeUuid).stream().map(ModificationInfos::getUuid).toList();
assertEquals(1, actualSubUuids.size());

int rootSizeBefore = modificationRepository.getModifications(TEST_GROUP_ID, true, true).size();
int rootSizeBefore = networkModificationRepository.getModifications(TEST_GROUP_ID, true, true).size();

// Move root-level modification into the composite (no sourceCompositeUuid), append at end
mockMvc.perform(put(URI_COMPOSITE_NETWORK_MODIF_BASE + "/groups/{groupUuid}/sub-modifications/{modificationUuid}",
Expand All @@ -688,10 +700,10 @@ void testMoveSubModificationFromRootToComposite() throws Exception {
assertEquals(rootModUuid, newSubUuids.get(1));

// Root group should have one less modification
assertEquals(rootSizeBefore - 1, modificationRepository.getModifications(TEST_GROUP_ID, true, true).size());
assertEquals(rootSizeBefore - 1, networkModificationRepository.getModifications(TEST_GROUP_ID, true, true).size());

// The moved modification must now have no group (owned by the composite, not the group)
ModificationEntity movedEntity = modificationRepository.getModificationEntity(rootModUuid);
ModificationEntity movedEntity = networkModificationRepository.getModificationEntity(rootModUuid);
assertNull(movedEntity.getGroup());
}

Expand Down Expand Up @@ -787,7 +799,7 @@ void testCreateCompositeFromSingleCompositeDoesNotWrap() throws Exception {
UUID resultUuid = mapper.readValue(mvcResult.getResponse().getContentAsString(), new TypeReference<>() { });

// The result must be a composite (not wrapped in another composite)
ModificationInfos resultInfos = modificationRepository.getModificationInfo(resultUuid);
ModificationInfos resultInfos = networkModificationRepository.getModificationInfo(resultUuid);
assertInstanceOf(CompositeModificationInfos.class, resultInfos);

// Its direct children must be the 2 leaf modifications, not another composite layer
Expand Down
Loading