Skip to content
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

Add optional parameter to get complete data of modifications in a composite modification. #567

Merged
merged 2 commits into from
Dec 2, 2024
Merged

Add optional parameter to get complete data of modifications in a composite modification. #567

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
22e80c9
Add optional parameter to get complete data of modifications in a com…
FranckLecuyer Nov 27, 2024
e45967a
Change optional parameter name from 'completeData' to 'onlyMetadata'
FranckLecuyer Nov 29, 2024
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
5 changes: 3 additions & 2 deletions src/main/java/org/gridsuite/modification/server/NetworkModificationController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,10 +225,11 @@ public ResponseEntity<UUID> createNetworkCompositeModification(@RequestBody List
@GetMapping(value = "/network-composite-modification/{uuid}/network-modifications", produces = MediaType.APPLICATION_JSON_VALUE)
@Operation(summary = "Get the list of the network modifications inside a composite modification")
@ApiResponse(responseCode = "200", description = "List of the modifications inside the composite modification")
public ResponseEntity<List<ModificationInfos>> getNetworkModificationsFromComposite(@PathVariable("uuid") UUID compositeModificationUuid) {
public ResponseEntity<List<ModificationInfos>> getNetworkModificationsFromComposite(@PathVariable("uuid") UUID compositeModificationUuid,
@Parameter(description = "Only metadata") @RequestParam(name = "onlyMetadata", required = false, defaultValue = "true") Boolean onlyMetadata) {
return ResponseEntity.ok()
.contentType(MediaType.APPLICATION_JSON)
.body(networkModificationService.getNetworkModificationsFromComposite(compositeModificationUuid)
.body(networkModificationService.getNetworkModificationsFromComposite(compositeModificationUuid, onlyMetadata)
);
}

Expand Down
8 changes: 6 additions & 2 deletions src/main/java/org/gridsuite/modification/server/service/NetworkModificationService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,12 @@ public List<ModificationInfos> getNetworkModifications(UUID groupUuid, boolean o
}

@Transactional(readOnly = true)
public List<ModificationInfos> getNetworkModificationsFromComposite(UUID compositeModificationUuid) {
return networkModificationRepository.getBasicNetworkModificationsFromComposite(compositeModificationUuid);
public List<ModificationInfos> getNetworkModificationsFromComposite(UUID compositeModificationUuid, boolean onlyMetadata) {
if (onlyMetadata) {
return networkModificationRepository.getBasicNetworkModificationsFromComposite(compositeModificationUuid);
} else {
return networkModificationRepository.getCompositeModificationsInfos(List.of(compositeModificationUuid));
}
}

@Transactional(readOnly = true)
Expand Down
17 changes: 16 additions & 1 deletion src/test/java/org/gridsuite/modification/server/ModificationControllerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -717,11 +717,26 @@ void testNetworkCompositeModification() throws Exception {
assertThat(modificationRepository.getModificationInfo(compositeModificationUuid)).recursivelyEquals(compositeModificationInfos);
assertEquals(modificationsNumber, modificationRepository.getModifications(TEST_GROUP_ID, true, true).size());

// get the composite modification metadata
// get the composite modification (metadata only)
mvcResult = mockMvc.perform(get(URI_GET_COMPOSITE_NETWORK_MODIF_CONTENT + compositeModificationUuid + "/network-modifications"))
.andExpect(status().isOk()).andReturn();
List<ModificationInfos> compositeModificationContent = mapper.readValue(mvcResult.getResponse().getContentAsString(), new TypeReference<>() { });
assertEquals(modificationsNumber, compositeModificationContent.size());
assertNotNull(compositeModificationContent.get(0).getMessageType());
assertNotNull(compositeModificationContent.get(0).getMessageValues());
assertNull(((EquipmentAttributeModificationInfos) compositeModificationContent.get(0)).getEquipmentAttributeName());
assertNull(((EquipmentAttributeModificationInfos) compositeModificationContent.get(0)).getEquipmentAttributeValue());
assertNull(((EquipmentAttributeModificationInfos) compositeModificationContent.get(0)).getEquipmentType());
assertNull(((EquipmentAttributeModificationInfos) compositeModificationContent.get(0)).getEquipmentId());

// get the composite modification (complete data)
mvcResult = mockMvc.perform(get(URI_GET_COMPOSITE_NETWORK_MODIF_CONTENT + compositeModificationUuid + "/network-modifications?onlyMetadata=false"))
.andExpect(status().isOk()).andReturn();
compositeModificationContent = mapper.readValue(mvcResult.getResponse().getContentAsString(), new TypeReference<>() { });
assertEquals("open", ((EquipmentAttributeModificationInfos) compositeModificationContent.get(0)).getEquipmentAttributeName());
assertEquals(Boolean.TRUE, ((EquipmentAttributeModificationInfos) compositeModificationContent.get(0)).getEquipmentAttributeValue());
assertEquals(IdentifiableType.SWITCH, ((EquipmentAttributeModificationInfos) compositeModificationContent.get(0)).getEquipmentType());
assertEquals("v1b1", ((EquipmentAttributeModificationInfos) compositeModificationContent.get(0)).getEquipmentId());

// Insert the composite modification in the group
mvcResult = mockMvc.perform(
Expand Down