Skip to content

Improve test quality #877

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 9 commits into
base: main
Choose a base branch
from
Open

Improve test quality #877

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
9d7f929
fix: move 'testSearch' into a new test class
Nov 7, 2025
7b5cf86
fix: clean studyTest
Nov 7, 2025
85a01c0
fix: improve wiremock stubs + regroup study creation tests
Nov 7, 2025
a33a641
test: improve tests
Nov 12, 2025
d1bb821
Merge branch 'main' into improve-test-quality
klesaulnier Nov 12, 2025
2be8b61
fix: checkstyle
Nov 12, 2025
9e4f779
fix: mocks
Nov 12, 2025
d7ab73d
fix: checkstyle
Nov 12, 2025
9067213
fix: sonar issues
Nov 12, 2025
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
2 changes: 1 addition & 1 deletion src/main/java/org/gridsuite/study/server/elasticsearch/EquipmentInfosService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -374,7 +374,7 @@ public List<EquipmentInfos> searchEquipments(@lombok.NonNull UUID networkUuid, @
BoolQuery query = buildSearchEquipmentsQuery(userInput, fieldSelector, networkUuid,
variantId, equipmentType);
List<EquipmentInfos> equipmentInfos = searchEquipments(query);
return variantId.equals(VariantManagerConstants.INITIAL_VARIANT_ID) ? equipmentInfos : cleanModifiedAndRemovedEquipments(networkUuid, effectiveVariantId, equipmentInfos);
return effectiveVariantId.equals(VariantManagerConstants.INITIAL_VARIANT_ID) ? equipmentInfos : cleanModifiedAndRemovedEquipments(networkUuid, effectiveVariantId, equipmentInfos);
}

public List<EquipmentInfos> searchEquipments(@NonNull final BoolQuery query) {
Expand Down
42 changes: 21 additions & 21 deletions src/test/java/org/gridsuite/study/server/FilterServiceTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
import org.gridsuite.study.server.service.FilterService;
import org.gridsuite.study.server.service.NetworkModificationTreeService;
import org.gridsuite.study.server.utils.TestUtils;
import org.gridsuite.study.server.utils.WireMockUtils;
import org.gridsuite.study.server.utils.wiremock.WireMockStubs;
import org.gridsuite.study.server.utils.elasticsearch.DisableElasticsearch;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.Assertions;
Expand Down Expand Up @@ -69,7 +69,7 @@ class FilterServiceTest {

private WireMockServer wireMockServer;

private WireMockUtils wireMockUtils;
private WireMockStubs wireMockStubs;

@MockitoSpyBean
private FilterService filterService;
Expand All @@ -89,7 +89,7 @@ class FilterServiceTest {
@BeforeEach
void setup() {
wireMockServer = new WireMockServer(wireMockConfig().dynamicPort());
wireMockUtils = new WireMockUtils(wireMockServer);
wireMockStubs = new WireMockStubs(wireMockServer);

// start server
wireMockServer.start();
Expand Down Expand Up @@ -160,7 +160,7 @@ void testEvaluateFilter() throws Exception {
]
""";

UUID stubUuid = wireMockUtils.stubFilterEvaluate(NETWORK_UUID_STRING, responseBody);
UUID stubUuid = wireMockStubs.stubFilterEvaluate(NETWORK_UUID_STRING, responseBody);

MvcResult mvcResult = mockMvc.perform(post("/v1/studies/{studyUuid}/root-networks/{rootNetworkUuid}/nodes/{nodeUuid}/filters/evaluate",
studyNameUserIdUuid, firstRootNetworkUuid, rootNodeUuid)
Expand All @@ -170,7 +170,7 @@ void testEvaluateFilter() throws Exception {
String resultAsString = mvcResult.getResponse().getContentAsString();
assertEquals(responseBody, resultAsString);

wireMockUtils.verifyFilterEvaluate(stubUuid, NETWORK_UUID_STRING);
wireMockStubs.verifyFilterEvaluate(stubUuid, NETWORK_UUID_STRING);

// evaluate on first node
mvcResult = mockMvc.perform(post("/v1/studies/{studyUuid}/root-networks/{rootNetworkUuid}/nodes/{nodeUuid}/filters/evaluate",
Expand All @@ -181,7 +181,7 @@ void testEvaluateFilter() throws Exception {
resultAsString = mvcResult.getResponse().getContentAsString();
assertEquals(responseBody, resultAsString);

wireMockUtils.verifyFilterEvaluate(stubUuid, NETWORK_UUID_STRING);
wireMockStubs.verifyFilterEvaluate(stubUuid, NETWORK_UUID_STRING);
}

@Test
Expand All @@ -203,7 +203,7 @@ void testEvaluateGlobalFilter() throws Exception {

String responseBody = "[\"GEN\"]";

UUID stubUuid = wireMockUtils.stubGlobalFilterEvaluate(NETWORK_UUID_STRING, List.of(EquipmentType.GENERATOR), responseBody);
UUID stubUuid = wireMockStubs.stubGlobalFilterEvaluate(NETWORK_UUID_STRING, List.of(EquipmentType.GENERATOR), responseBody);

MvcResult mvcResult = mockMvc.perform(post("/v1/studies/{studyUuid}/root-networks/{rootNetworkUuid}/nodes/{nodeUuid}/global-filter/evaluate?equipmentTypes=GENERATOR",
studyNameUserIdUuid, firstRootNetworkUuid, rootNodeUuid)
Expand All @@ -213,12 +213,12 @@ void testEvaluateGlobalFilter() throws Exception {
String resultAsString = mvcResult.getResponse().getContentAsString();
assertEquals(responseBody, resultAsString);

wireMockUtils.verifyGlobalFilterEvaluate(stubUuid, NETWORK_UUID_STRING, List.of(EquipmentType.GENERATOR));
wireMockStubs.verifyGlobalFilterEvaluate(stubUuid, NETWORK_UUID_STRING, List.of(EquipmentType.GENERATOR));
}

@Test
void testEvaluateFilterNotFoundError() throws Exception {
UUID stubUuid = wireMockUtils.stubFilterEvaluateNotFoundError(NETWORK_UUID_STRING);
UUID stubUuid = wireMockStubs.stubFilterEvaluateNotFoundError(NETWORK_UUID_STRING);

StudyEntity studyEntity = insertDummyStudy(UUID.fromString(NETWORK_UUID_STRING), CASE_UUID);
UUID studyNameUserIdUuid = studyEntity.getId();
Expand Down Expand Up @@ -251,12 +251,12 @@ void testEvaluateFilterNotFoundError() throws Exception {
.andExpect(status().is5xxServerError())
.andReturn();

wireMockUtils.verifyFilterEvaluate(stubUuid, NETWORK_UUID_STRING);
wireMockStubs.verifyFilterEvaluate(stubUuid, NETWORK_UUID_STRING);
}

@Test
void testEvaluateFilterError() throws Exception {
UUID stubUuid = wireMockUtils.stubFilterEvaluateError(NETWORK_UUID_STRING);
UUID stubUuid = wireMockStubs.stubFilterEvaluateError(NETWORK_UUID_STRING);

StudyEntity studyEntity = insertDummyStudy(UUID.fromString(NETWORK_UUID_STRING), CASE_UUID);
UUID studyNameUserIdUuid = studyEntity.getId();
Expand Down Expand Up @@ -289,7 +289,7 @@ void testEvaluateFilterError() throws Exception {
.andExpect(status().is5xxServerError())
.andReturn();

wireMockUtils.verifyFilterEvaluate(stubUuid, NETWORK_UUID_STRING);
wireMockStubs.verifyFilterEvaluate(stubUuid, NETWORK_UUID_STRING);
}

@Test
Expand All @@ -304,7 +304,7 @@ void testExportFilter() throws Exception {
{"id":"MANDA7COND.31","type":"SHUNT_COMPENSATOR","distributionKey":null}
]
""";
UUID stubUuid = wireMockUtils.stubFilterExport(NETWORK_UUID_STRING, FILTER_UUID_STRING, responseBody);
UUID stubUuid = wireMockStubs.stubFilterExport(NETWORK_UUID_STRING, FILTER_UUID_STRING, responseBody);

MvcResult mvcResult = mockMvc.perform(get("/v1/studies/{studyUuid}/root-networks/{rootNetworkUuid}/filters/{filterId}/elements",
studyUuid, firstRootNetworkUuid, FILTER_UUID_STRING))
Expand All @@ -313,7 +313,7 @@ void testExportFilter() throws Exception {
String resultAsString = mvcResult.getResponse().getContentAsString();
assertEquals(responseBody, resultAsString);

wireMockUtils.verifyFilterExport(stubUuid, FILTER_UUID_STRING, NETWORK_UUID_STRING);
wireMockStubs.verifyFilterExport(stubUuid, FILTER_UUID_STRING, NETWORK_UUID_STRING);
}

@Test
Expand All @@ -328,7 +328,7 @@ void exportFilterFromFirstRootNetwork() throws Exception {
{"id":"MANDA7COND.31","type":"SHUNT_COMPENSATOR","distributionKey":null}
]
""";
UUID stubUuid = wireMockUtils.stubFilterExport(studyFirstRootNetworkUuid.toString(), FILTER_UUID_STRING, responseBody);
UUID stubUuid = wireMockStubs.stubFilterExport(studyFirstRootNetworkUuid.toString(), FILTER_UUID_STRING, responseBody);

MvcResult mvcResult = mockMvc.perform(get("/v1/studies/{studyUuid}/filters/{filterId}/elements",
studyUuid, FILTER_UUID_STRING))
Expand All @@ -337,7 +337,7 @@ void exportFilterFromFirstRootNetwork() throws Exception {
String resultAsString = mvcResult.getResponse().getContentAsString();
Assertions.assertEquals(responseBody, resultAsString);

wireMockUtils.verifyFilterExport(stubUuid, FILTER_UUID_STRING, studyFirstRootNetworkUuid.toString());
wireMockStubs.verifyFilterExport(stubUuid, FILTER_UUID_STRING, studyFirstRootNetworkUuid.toString());
}

@Test
Expand All @@ -360,7 +360,7 @@ void evaluateFiltersWithEquipmentsOnFirstRootNetworkTest() throws Exception {
{"id":"MANDA7COND.31","type":"SHUNT_COMPENSATOR","distributionKey":null}
]
""";
UUID stubUuid = wireMockUtils.stubFiltersEvaluate(studyFirstRootNetworkUuid.toString(), filtersBody, responseBody);
UUID stubUuid = wireMockStubs.stubFiltersEvaluate(studyFirstRootNetworkUuid.toString(), filtersBody, responseBody);

MvcResult mvcResult = mockMvc.perform(post("/v1/studies/{studyUuid}/filters/elements", studyUuid)
.content(filtersBody).contentType(MediaType.APPLICATION_JSON))
Expand All @@ -370,7 +370,7 @@ void evaluateFiltersWithEquipmentsOnFirstRootNetworkTest() throws Exception {
String resultAsString = mvcResult.getResponse().getContentAsString();
Assertions.assertEquals(responseBody, resultAsString);

wireMockUtils.verifyFiltersEvaluate(stubUuid, filtersBody, studyFirstRootNetworkUuid.toString());
wireMockStubs.verifyFiltersEvaluate(stubUuid, filtersBody, studyFirstRootNetworkUuid.toString());
}

@Test
Expand Down Expand Up @@ -412,7 +412,7 @@ void testExportFilters() throws Exception {
}
]
""";
UUID stubUuid = wireMockUtils.stubFiltersExport(NETWORK_UUID_STRING, FILTERS_UUID_STRING, responseBody);
UUID stubUuid = wireMockStubs.stubFiltersExport(NETWORK_UUID_STRING, FILTERS_UUID_STRING, responseBody);

MvcResult mvcResult = mockMvc.perform(get("/v1/studies/{studyUuid}/root-networks/{rootNetworkUuid}/nodes/{nodeUuid}/filters/elements?filtersUuid=" + FILTERS_UUID_STRING.stream().collect(Collectors.joining(",")),
studyUuid, firstRootNetworkUuid, rootNodeUuid))
Expand All @@ -421,7 +421,7 @@ void testExportFilters() throws Exception {
String resultAsString = mvcResult.getResponse().getContentAsString();
assertEquals(responseBody, resultAsString);

wireMockUtils.verifyFiltersExport(stubUuid, FILTERS_UUID_STRING, NETWORK_UUID_STRING);
wireMockStubs.verifyFiltersExport(stubUuid, FILTERS_UUID_STRING, NETWORK_UUID_STRING);

// export on first node
mvcResult = mockMvc.perform(get("/v1/studies/{studyUuid}/root-networks/{rootNetworkUuid}/nodes/{nodeUuid}/filters/elements?filtersUuid=" + FILTERS_UUID_STRING.stream().collect(Collectors.joining(",")),
Expand All @@ -431,6 +431,6 @@ void testExportFilters() throws Exception {
resultAsString = mvcResult.getResponse().getContentAsString();
assertEquals(responseBody, resultAsString);

wireMockUtils.verifyFiltersExport(stubUuid, FILTERS_UUID_STRING, NETWORK_UUID_STRING);
wireMockStubs.verifyFiltersExport(stubUuid, FILTERS_UUID_STRING, NETWORK_UUID_STRING);
}
}
34 changes: 17 additions & 17 deletions src/test/java/org/gridsuite/study/server/LoadFLowIntegrationTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
import org.gridsuite.study.server.repository.voltageinit.StudyVoltageInitParametersEntity;
import org.gridsuite.study.server.service.*;
import org.gridsuite.study.server.utils.TestUtils;
import org.gridsuite.study.server.utils.WireMockUtils;
import org.gridsuite.study.server.utils.wiremock.WireMockStubs;
import org.gridsuite.study.server.utils.elasticsearch.DisableElasticsearch;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
Expand Down Expand Up @@ -131,15 +131,15 @@ class LoadFLowIntegrationTest {
LoadFlowService loadFlowService;

private WireMockServer wireMockServer;
private WireMockUtils wireMockUtils;
private WireMockStubs wireMockStubs;

@BeforeEach
void setup() {
wireMockServer = new WireMockServer(wireMockConfig().dynamicPort());
wireMockServer.start();
String baseUrlWireMock = wireMockServer.baseUrl();
loadFlowService.setLoadFlowServerBaseUri(baseUrlWireMock);
wireMockUtils = new WireMockUtils(wireMockServer);
wireMockStubs = new WireMockStubs(wireMockServer);

rootNodeInfoRepository.deleteAll();
networkModificationNodeInfoRepository.deleteAll();
Expand Down Expand Up @@ -190,14 +190,14 @@ private static Stream<Arguments> argumentsProvider() {

@Test
void testDynaFlowNotAllowed() throws Exception {
UUID loadFlowProviderStubUuid = wireMockUtils.stubLoadFlowProvider(parametersUuid, DYNA_FLOW_PROVIDER);
UUID loadFlowProviderStubUuid = wireMockStubs.stubLoadFlowProvider(parametersUuid, DYNA_FLOW_PROVIDER);
doNothing().when(studyService).sendLoadflowRequest(any(), any(), any(), any(), anyBoolean(), anyString());

// Construction node : forbidden
mockMvc.perform(put("/v1/studies/{studyUuid}/root-networks/{rootNetworkUuid}/nodes/{nodeUuid}/loadflow/run", studyUuid, rootNetworkUuid, constructionNodeUuid, userId)
.header("userId", userId))
.andExpect(status().isForbidden());
wireMockUtils.verifyLoadFlowProviderGet(loadFlowProviderStubUuid, parametersUuid);
wireMockStubs.verifyLoadFlowProviderGet(loadFlowProviderStubUuid, parametersUuid);

// Security node : ok
mockMvc.perform(put("/v1/studies/{studyUuid}/root-networks/{rootNetworkUuid}/nodes/{nodeUuid}/loadflow/run", studyUuid, rootNetworkUuid, securityNodeUuid, userId)
Expand All @@ -207,18 +207,18 @@ void testDynaFlowNotAllowed() throws Exception {

private void runLoadFlow(boolean withRatioTapChangers, boolean isSecurityNode) throws Exception {
UUID nodeUuid = isSecurityNode ? securityNodeUuid : constructionNodeUuid;
UUID runLoadflowStubUuid = wireMockUtils.stubRunLoadFlow(networkUuid, withRatioTapChangers, null, objectMapper.writeValueAsString(loadflowResultUuid));
UUID loadFlowProviderStubUuid = wireMockUtils.stubLoadFlowProvider(parametersUuid, testProvider);
UUID runLoadflowStubUuid = wireMockStubs.stubRunLoadFlow(networkUuid, withRatioTapChangers, null, objectMapper.writeValueAsString(loadflowResultUuid));
UUID loadFlowProviderStubUuid = wireMockStubs.stubLoadFlowProvider(parametersUuid, testProvider);

mockMvc.perform(put("/v1/studies/{studyUuid}/root-networks/{rootNetworkUuid}/nodes/{nodeUuid}/loadflow/run", studyUuid, rootNetworkUuid, nodeUuid, userId)
.param(QUERY_WITH_TAP_CHANGER, withRatioTapChangers ? "true" : "false")
.header("userId", userId))
.andExpect(status().isOk());
wireMockUtils.verifyRunLoadflow(runLoadflowStubUuid, networkUuid, withRatioTapChangers, null);
wireMockStubs.verifyRunLoadflow(runLoadflowStubUuid, networkUuid, withRatioTapChangers, null);
if (isSecurityNode) {
verify(networkModificationTreeService, times(1)).invalidateNodeTree(eq(nodeUuid), eq(rootNetworkUuid), any(InvalidateNodeTreeParameters.class));
} else {
wireMockUtils.verifyLoadFlowProviderGet(loadFlowProviderStubUuid, parametersUuid);
wireMockStubs.verifyLoadFlowProviderGet(loadFlowProviderStubUuid, parametersUuid);
}
verify(networkModificationService, times(isSecurityNode ? 1 : 0)).deleteIndexedModifications(any(), any(UUID.class));

Expand All @@ -240,10 +240,10 @@ private void rerunLoadFlow(boolean withRatioTapChangers, boolean isSecurityNode)
reset(networkModificationTreeService);
UUID nodeUuid = isSecurityNode ? securityNodeUuid : constructionNodeUuid;
UUID newLoadflowResultUuid = UUID.randomUUID();
UUID stubDeleteLoadflowResultUuid = wireMockUtils.stubDeleteLoadFlowResults(List.of(loadflowResultUuid));
UUID stubCreateRunningLoadflowStatusUuid = wireMockUtils.stubCreateRunningLoadflowStatus(objectMapper.writeValueAsString(newLoadflowResultUuid));
UUID loadFlowProviderStubUuid = wireMockUtils.stubLoadFlowProvider(parametersUuid, testProvider);
UUID runLoadflowStubUuid = wireMockUtils.stubRunLoadFlow(networkUuid, withRatioTapChangers, null, objectMapper.writeValueAsString(loadflowResultUuid));
UUID stubDeleteLoadflowResultUuid = wireMockStubs.stubDeleteLoadFlowResults(List.of(loadflowResultUuid));
UUID stubCreateRunningLoadflowStatusUuid = wireMockStubs.stubCreateRunningLoadflowStatus(objectMapper.writeValueAsString(newLoadflowResultUuid));
UUID loadFlowProviderStubUuid = wireMockStubs.stubLoadFlowProvider(parametersUuid, testProvider);
UUID runLoadflowStubUuid = wireMockStubs.stubRunLoadFlow(networkUuid, withRatioTapChangers, null, objectMapper.writeValueAsString(loadflowResultUuid));

doReturn(parametersUuid).when(loadFlowService).createDefaultLoadFlowParameters();

Expand All @@ -254,17 +254,17 @@ private void rerunLoadFlow(boolean withRatioTapChangers, boolean isSecurityNode)
.header("userId", userId))
.andExpect(status().isOk());

wireMockUtils.verifyDeleteLoadFlowResults(stubDeleteLoadflowResultUuid, List.of(loadflowResultUuid));
wireMockUtils.verifyCreateRunningLoadflowStatus(stubCreateRunningLoadflowStatusUuid);
wireMockStubs.verifyDeleteLoadFlowResults(stubDeleteLoadflowResultUuid, List.of(loadflowResultUuid));
wireMockStubs.verifyCreateRunningLoadflowStatus(stubCreateRunningLoadflowStatusUuid);

if (isSecurityNode) {
verify(networkModificationTreeService, times(1)).invalidateNodeTree(eq(nodeUuid), eq(rootNetworkUuid), any(InvalidateNodeTreeParameters.class));
ArgumentCaptor<RerunLoadFlowInfos> rerunLoadFlowWorkflowInfosArgumentCaptor = ArgumentCaptor.forClass(RerunLoadFlowInfos.class);
verify(networkModificationService, times(1)).buildNode(eq(nodeUuid), eq(rootNetworkUuid), any(BuildInfos.class), rerunLoadFlowWorkflowInfosArgumentCaptor.capture());
assertEquals(withRatioTapChangers, rerunLoadFlowWorkflowInfosArgumentCaptor.getValue().isWithRatioTapChangers());
} else {
wireMockUtils.verifyLoadFlowProviderGet(loadFlowProviderStubUuid, parametersUuid);
wireMockUtils.verifyRunLoadflow(runLoadflowStubUuid, networkUuid, withRatioTapChangers, null);
wireMockStubs.verifyLoadFlowProviderGet(loadFlowProviderStubUuid, parametersUuid);
wireMockStubs.verifyRunLoadflow(runLoadflowStubUuid, networkUuid, withRatioTapChangers, null);
}

// verify that the node is blocked
Expand Down
Loading