add a test for better covarge

Signed-off-by: David BRAQUART <[email protected]>

Author: dbraquart

src/test/java/org/gridsuite/securityanalysis/server/SecurityAnalysisControllerTest.java

@@ -44,6 +44,8 @@
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.mockito.MockitoAnnotations;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
 import org.springframework.boot.test.context.SpringBootTest;
@@ -73,6 +75,7 @@
 import static org.gridsuite.computation.service.NotificationService.*;
 import static org.gridsuite.securityanalysis.server.SecurityAnalysisProviderMock.*;
 import static org.gridsuite.securityanalysis.server.service.SecurityAnalysisService.COMPUTATION_TYPE;
+import static org.gridsuite.securityanalysis.server.util.CsvExportUtils.csvRowsToZippedCsv;
 import static org.gridsuite.securityanalysis.server.util.DatabaseQueryUtils.assertRequestsCount;
 import static org.gridsuite.securityanalysis.server.util.TestUtils.assertLogMessage;
 import static org.gridsuite.securityanalysis.server.util.TestUtils.readLinesFromFilePath;
@@ -94,6 +97,7 @@
 @SpringBootTest
 @ContextConfigurationWithTestChannel
 class SecurityAnalysisControllerTest {
+    private static final Logger LOGGER = LoggerFactory.getLogger(SecurityAnalysisControllerTest.class);
 
     private static final UUID NETWORK_UUID = UUID.fromString("7928181c-7977-4592-ba19-88027e4254e4");
     private static final UUID NETWORK_STOP_UUID = UUID.fromString("7928181c-7977-4592-ba19-88027e4254e6");
@@ -857,6 +861,41 @@ void getZippedCsvResults() throws Exception {
         checkAllZippedCsvResults();
     }
 
+    @Test
+    void getZippedCsvResultsFromCustomData() throws Exception {
+        final String expectedCsvFile = "/results/n-result-fr-custom.csv";
+        final String lang = "fr";
+        final List<String> header = getCsvHeaderFromResource(expectedCsvFile, lang);
+
+        // Build binary/zipped data from custom DTOs rather than from AS results.
+        PreContingencyLimitViolationResultDTO dto = PreContingencyLimitViolationResultDTO.builder()
+                .subjectId("Ouvrage")
+                .limitViolation(LimitViolationDTO.builder()
+                    .locationId("BUS")
+                    .limitName("lim_name")
+                    .acceptableDuration(100)
+                    .patlLoading(111.5)
+                    .patlLimit(80.66)
+                    .upcomingAcceptableDuration(Integer.MAX_VALUE)
+                    .build())
+                .build();
+        PreContingencyLimitViolationResultDTO dto2 = PreContingencyLimitViolationResultDTO.builder()
+                .subjectId("Ouvrage2")
+                .limitViolation(LimitViolationDTO.builder()
+                        .locationId("BUS2")
+                        .limitName("lim_name2")
+                        .acceptableDuration(100)
+                        .patlLoading(111.5)
+                        .patlLimit(80.66)
+                        .upcomingAcceptableDuration(1000)
+                        .build())
+                .build();
+        List<List<String>> csvRows = List.of(dto.toCsvRow(ENUM_TRANSLATIONS_FR, lang), dto2.toCsvRow(ENUM_TRANSLATIONS_FR, lang));
+        byte[] resultAsByteArray = csvRowsToZippedCsv(header, lang, csvRows);
+        // and compare with the expected file
+        checkCsvResultFromBytes(expectedCsvFile, resultAsByteArray);
+    }
+
     private List<String> getCsvHeaderFromResource(String resourcePath, String lang) {
         List<String> lines = readLinesFromFilePath(resourcePath, 1);
         String header = lines.isEmpty() ? "" : lines.getFirst();
@@ -908,26 +947,11 @@ private void checkAllZippedCsvResults() throws Exception {
         assertRequestsCount(4, 0, 0, 0);
     }
 
-    private void checkZippedCsvResult(String resultType, String resourcePath, String lang) throws Exception {
-        CsvTranslationDTO csvTranslationDTO = CsvTranslationDTO.builder()
-                .headers(getCsvHeaderFromResource(resourcePath, lang))
-                .enumValueTranslations("en".equalsIgnoreCase(lang) ? ENUM_TRANSLATIONS_EN : ENUM_TRANSLATIONS_FR)
-                .language(lang)
-                .build();
-
-        // get csv file
-        byte[] resultAsByteArray = mockMvc.perform(post("/" + VERSION + "/results/" + RESULT_UUID + "/" + resultType + "/csv")
-                .contentType(MediaType.APPLICATION_JSON)
-                .content(mapper.writeValueAsString(csvTranslationDTO)))
-            .andExpectAll(
-                status().isOk(),
-                content().contentType(APPLICATION_OCTET_STREAM_VALUE)
-            ).andReturn().getResponse().getContentAsByteArray();
-
+    private void checkCsvResultFromBytes(String expectedCsvResource, byte[] resultAsByteArray) throws Exception {
         // get zip file stream
         try (ZipInputStream zin = new ZipInputStream(new ByteArrayInputStream(resultAsByteArray));
-             ByteArrayOutputStream contentOutputStream = new ByteArrayOutputStream();
-             ByteArrayOutputStream expectedContentOutputStream = new ByteArrayOutputStream()) {
+            ByteArrayOutputStream contentOutputStream = new ByteArrayOutputStream();
+            ByteArrayOutputStream expectedContentOutputStream = new ByteArrayOutputStream()) {
             // get first entry
             ZipEntry zipEntry = zin.getNextEntry();
             // check zip entry name
@@ -936,15 +960,38 @@ private void checkZippedCsvResult(String resultType, String resourcePath, String
             StreamUtils.copy(zin, contentOutputStream);
 
             // get expected content as outputStream
-            InputStream csvStream = getClass().getResourceAsStream(resourcePath);
+            InputStream csvStream = getClass().getResourceAsStream(expectedCsvResource);
             StreamUtils.copy(csvStream, expectedContentOutputStream);
 
+            // For debug
+            LOGGER.info("CSV result  :\n {}", contentOutputStream);
+            LOGGER.info("CSV expected:\n {}", expectedContentOutputStream);
+
             // using bytearray comparison to check BOM presence in CSV files
             Assertions.assertThat(contentOutputStream.toByteArray()).isEqualTo(expectedContentOutputStream.toByteArray());
             zin.closeEntry();
         }
     }
 
+    private void checkZippedCsvResult(String resultType, String expectedCsvResource, String lang) throws Exception {
+        CsvTranslationDTO csvTranslationDTO = CsvTranslationDTO.builder()
+                .headers(getCsvHeaderFromResource(expectedCsvResource, lang))
+                .enumValueTranslations("en".equalsIgnoreCase(lang) ? ENUM_TRANSLATIONS_EN : ENUM_TRANSLATIONS_FR)
+                .language(lang)
+                .build();
+
+        // get csv file as binary (zip)
+        byte[] resultAsByteArray = mockMvc.perform(post("/" + VERSION + "/results/" + RESULT_UUID + "/" + resultType + "/csv")
+                .contentType(MediaType.APPLICATION_JSON)
+                .content(mapper.writeValueAsString(csvTranslationDTO)))
+            .andExpectAll(
+                status().isOk(),
+                content().contentType(APPLICATION_OCTET_STREAM_VALUE)
+            ).andReturn().getResponse().getContentAsByteArray();
+
+        checkCsvResultFromBytes(expectedCsvResource, resultAsByteArray);
+    }
+
     private void assertResultNotFound(UUID resultUuid) throws Exception {
         mockMvc.perform(get("/" + VERSION + "/results/" + resultUuid + "/n-result"))
                 .andExpect(status().isNotFound());

src/test/resources/results/n-result-fr-custom.csv

@@ -0,0 +1,3 @@
+Ouvrage;Type de contrainte;Noeud électrique;Nom de la limite;Charge (% limite);Charge (% IST);Tempo effective;Tempo imminente;Nom de la limite suivante;Limite (A ou kV);IST (A);Valeur calculée (A ou kV);Côté
+Ouvrage;;BUS;lim_name;;111,5;100;;;0;80,66;0;
+Ouvrage2;;BUS2;lim_name2;;111,5;100;1000;;0;80,66;0;