Skip to content

[WIP] Add allResults parameter #28

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
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[WIP] Add allResults parameter #28

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
06d684d
Add allResults parameter
etiennehomer Aug 22, 2023
ab515ed
Adapt tests
etiennehomer Aug 22, 2023
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: 3 additions & 1 deletion src/main/java/org/gridsuite/shortcircuit/server/ShortCircuitController.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.shortcircuit.server.service.ShortCircuitRunContext;
import org.gridsuite.shortcircuit.server.service.ShortCircuitService;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.PageRequest;
import org.springframework.data.domain.Pageable;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
Expand Down Expand Up @@ -103,8 +104,9 @@ public ResponseEntity<ShortCircuitAnalysisResult> getResult(@Parameter(descripti
@ApiResponse(responseCode = "404", description = "Short circuit analysis result has not been found")})
public ResponseEntity<Page<FaultResult>> getPagedFaultResults(@Parameter(description = "Result UUID") @PathVariable("resultUuid") UUID resultUuid,
@Parameter(description = "Full or only those with limit violations or none fault results") @RequestParam(name = "mode", required = false, defaultValue = "WITH_LIMIT_VIOLATIONS") FaultResultsMode mode,
@Parameter(description = "Fetch all results or paged results") @RequestParam(name = "allResults", required = false, defaultValue = "false") boolean allResults,
Pageable pageable) {
Page<FaultResult> faultResultsPage = shortCircuitService.getFaultResultsPage(resultUuid, mode, pageable);
Page<FaultResult> faultResultsPage = shortCircuitService.getFaultResultsPage(resultUuid, mode, allResults ? PageRequest.of(0, Integer.MAX_VALUE, pageable.getSort()) : pageable);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe add check on pageable.getSort() : it should not be null
if it's null, use Sort.unsorted()

return faultResultsPage != null ? ResponseEntity.ok().contentType(MediaType.APPLICATION_JSON).body(faultResultsPage)
: ResponseEntity.notFound().build();
}
Expand Down
26 changes: 20 additions & 6 deletions src/test/java/org/gridsuite/shortcircuit/server/ShortCircuitAnalysisControllerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ private static final class ShortCircuitAnalysisResultMock {
List.of(), List.of(LIMIT_VIOLATION_1, LIMIT_VIOLATION_2, LIMIT_VIOLATION_3),
49.3, FaultResult.Status.SUCCESS);

static final ShortCircuitAnalysisResult RESULT_FULL = new ShortCircuitAnalysisResult(List.of(FAULT_RESULT_1, FAULT_RESULT_2, FAULT_RESULT_3));
static final ShortCircuitAnalysisResult ALL_RESULT = new ShortCircuitAnalysisResult(List.of(FAULT_RESULT_1, FAULT_RESULT_2, FAULT_RESULT_3));
static final ShortCircuitAnalysisResult RESULT_SORTED_PAGE_0 = new ShortCircuitAnalysisResult(List.of(FAULT_RESULT_1, FAULT_RESULT_3));
static final ShortCircuitAnalysisResult RESULT_SORTED_PAGE_1 = new ShortCircuitAnalysisResult(List.of(FAULT_RESULT_3));
static final ShortCircuitAnalysisResult RESULT = new ShortCircuitAnalysisResult(List.of(FAULT_RESULT_1, FAULT_RESULT_3));
Expand Down Expand Up @@ -264,7 +264,7 @@ public void runTest() throws Exception {
LocalDateTime testTime = LocalDateTime.now().truncatedTo(ChronoUnit.MICROS);
try (MockedStatic<ShortCircuitAnalysis> shortCircuitAnalysisMockedStatic = Mockito.mockStatic(ShortCircuitAnalysis.class)) {
shortCircuitAnalysisMockedStatic.when(() -> ShortCircuitAnalysis.runAsync(eq(network), anyList(), any(ShortCircuitParameters.class), any(ComputationManager.class), anyList(), any(Reporter.class)))
.thenReturn(CompletableFuture.completedFuture(ShortCircuitAnalysisResultMock.RESULT_FULL));
.thenReturn(CompletableFuture.completedFuture(ShortCircuitAnalysisResultMock.ALL_RESULT));

MvcResult result = mockMvc.perform(post(
"/" + VERSION + "/networks/{networkUuid}/run-and-save?receiver=me&variantId=" + VARIANT_2_ID, NETWORK_UUID)
Expand Down Expand Up @@ -293,7 +293,7 @@ public void runTest() throws Exception {
.andExpect(content().contentType(MediaType.APPLICATION_JSON))
.andReturn();
org.gridsuite.shortcircuit.server.dto.ShortCircuitAnalysisResult resultDtoFull = mapper.readValue(result.getResponse().getContentAsString(), org.gridsuite.shortcircuit.server.dto.ShortCircuitAnalysisResult.class);
assertResultsEquals(ShortCircuitAnalysisResultMock.RESULT_FULL, resultDtoFull);
assertResultsEquals(ShortCircuitAnalysisResultMock.ALL_RESULT, resultDtoFull);

result = mockMvc.perform(get(
"/" + VERSION + "/results/{resultUuid}/fault_results/paged", RESULT_UUID)
Expand Down Expand Up @@ -336,6 +336,20 @@ public void runTest() throws Exception {
List<org.gridsuite.shortcircuit.server.dto.FaultResult> faultResultsPageDto1Full = reader.readValue(faultResultsPageNode1.get("content"));
assertPagedResultsEquals(ShortCircuitAnalysisResultMock.RESULT_SORTED_PAGE_1, faultResultsPageDto1Full);

result = mockMvc.perform(get(
"/" + VERSION + "/results/{resultUuid}/fault_results/paged", RESULT_UUID)
.param("mode", "FULL")
.param("page", "0")
.param("size", "2")
.param("allResults", "true")
.param("sort", "fault.id"))
.andExpect(status().isOk())
.andExpect(content().contentType(MediaType.APPLICATION_JSON))
.andReturn();
JsonNode faultResultsPageNode2 = mapper.readTree(result.getResponse().getContentAsString());
List<org.gridsuite.shortcircuit.server.dto.FaultResult> faultResultsPageDto2Full = reader.readValue(faultResultsPageNode2.get("content"));
assertPagedResultsEquals(ShortCircuitAnalysisResultMock.ALL_RESULT, faultResultsPageDto2Full);

// should throw not found if result does not exist
mockMvc.perform(get("/" + VERSION + "/results/{resultUuid}", OTHER_RESULT_UUID))
.andExpect(status().isNotFound());
Expand All @@ -355,7 +369,7 @@ public void runWithBusIdTest() throws Exception {
LocalDateTime testTime = LocalDateTime.now().truncatedTo(ChronoUnit.MICROS);
try (MockedStatic<ShortCircuitAnalysis> shortCircuitAnalysisMockedStatic = Mockito.mockStatic(ShortCircuitAnalysis.class)) {
shortCircuitAnalysisMockedStatic.when(() -> ShortCircuitAnalysis.runAsync(eq(network), anyList(), any(ShortCircuitParameters.class), any(ComputationManager.class), anyList(), any(Reporter.class)))
.thenReturn(CompletableFuture.completedFuture(ShortCircuitAnalysisResultMock.RESULT_FULL));
.thenReturn(CompletableFuture.completedFuture(ShortCircuitAnalysisResultMock.ALL_RESULT));

MvcResult result = mockMvc.perform(post(
"/" + VERSION + "/networks/{networkUuid}/run-and-save?receiver=me&variantId=" + VARIANT_2_ID, NETWORK_UUID)
Expand Down Expand Up @@ -387,7 +401,7 @@ public void runWithBusBarSectionIdTest() throws Exception {
LocalDateTime testTime = LocalDateTime.now().truncatedTo(ChronoUnit.MICROS);
try (MockedStatic<ShortCircuitAnalysis> shortCircuitAnalysisMockedStatic = Mockito.mockStatic(ShortCircuitAnalysis.class)) {
shortCircuitAnalysisMockedStatic.when(() -> ShortCircuitAnalysis.runAsync(eq(nodeBreakerNetwork), anyList(), any(ShortCircuitParameters.class), any(ComputationManager.class), anyList(), any(Reporter.class)))
.thenReturn(CompletableFuture.completedFuture(ShortCircuitAnalysisResultMock.RESULT_FULL));
.thenReturn(CompletableFuture.completedFuture(ShortCircuitAnalysisResultMock.ALL_RESULT));

MvcResult result = mockMvc.perform(post(
"/" + VERSION + "/networks/{networkUuid}/run-and-save?receiver=me&variantId=" + NODE_BREAKER_NETWORK_VARIANT_ID, NODE_BREAKER_NETWORK_UUID)
Expand Down Expand Up @@ -419,7 +433,7 @@ public void runWithBusBarSectionIdAndErrorTest() throws Exception {
LocalDateTime testTime = LocalDateTime.now().truncatedTo(ChronoUnit.MICROS);
try (MockedStatic<ShortCircuitAnalysis> shortCircuitAnalysisMockedStatic = Mockito.mockStatic(ShortCircuitAnalysis.class)) {
shortCircuitAnalysisMockedStatic.when(() -> ShortCircuitAnalysis.runAsync(eq(nodeBreakerNetwork), anyList(), any(ShortCircuitParameters.class), any(ComputationManager.class), anyList(), any(Reporter.class)))
.thenReturn(CompletableFuture.completedFuture(ShortCircuitAnalysisResultMock.RESULT_FULL));
.thenReturn(CompletableFuture.completedFuture(ShortCircuitAnalysisResultMock.ALL_RESULT));

MvcResult result = mockMvc.perform(post(
"/" + VERSION + "/networks/{networkUuid}/run-and-save?receiver=me&variantId=" + NODE_BREAKER_NETWORK_VARIANT_ID, NODE_BREAKER_NETWORK_UUID)
Expand Down