ShortCircuitAnalysisResultExportersTest.java

/**
 * Copyright (c) 2021, RTE (http://www.rte-france.com)
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 * SPDX-License-Identifier: MPL-2.0
 */
package com.powsybl.shortcircuit.converter;

import com.powsybl.commons.test.AbstractSerDeTest;
import com.powsybl.commons.test.ComparisonUtils;
import com.powsybl.iidm.network.Network;
import com.powsybl.iidm.network.ThreeSides;
import com.powsybl.iidm.network.test.EurostagTutorialExample1Factory;
import com.powsybl.shortcircuit.*;
import com.powsybl.shortcircuit.json.ShortCircuitAnalysisResultDeserializer;
import org.junit.jupiter.api.Test;

import java.io.IOException;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

import static org.junit.jupiter.api.Assertions.assertEquals;

/**
 * @author Coline Piloquet {@literal <coline.piloquet at rte-france.com>}
 */
class ShortCircuitAnalysisResultExportersTest extends AbstractSerDeTest {

    @Test
    void testGetFormats() {
        assertEquals("[ASCII, CSV, JSON]", ShortCircuitAnalysisResultExporters.getFormats().toString());
    }

    @Test
    void testGetExporter() {
        assertEquals("ASCII", ShortCircuitAnalysisResultExporters.getExporter("ASCII").getFormat());
        assertEquals("CSV", ShortCircuitAnalysisResultExporters.getExporter("CSV").getFormat());
        assertEquals("JSON", ShortCircuitAnalysisResultExporters.getExporter("JSON").getFormat());
    }

    @Test
    void testComment() {
        assertEquals("Export a result in ASCII tables", ShortCircuitAnalysisResultExporters.getExporter("ASCII").getComment());
        assertEquals("Export a result in a CSV-like format", ShortCircuitAnalysisResultExporters.getExporter("CSV").getComment());
        assertEquals("Export a result in JSON format", ShortCircuitAnalysisResultExporters.getExporter("JSON").getComment());
    }

    void writeJson(ShortCircuitAnalysisResult results, Path path) {
        ShortCircuitAnalysisResultExporters.export(results, path, "JSON", null);
    }

    @Test
    void testWriteJson() throws IOException {
        ShortCircuitAnalysisResult result = TestingResultFactory.createResultWithExtension();
        writeTest(result, this::writeJson, ComparisonUtils::assertTxtEquals, "/shortcircuit-with-extensions-results.json");
    }

    @Test
    void roundTripJson() throws IOException {
        ShortCircuitAnalysisResult result = TestingResultFactory.createResultWithExtension();
        roundTripTest(result, this::writeJson, ShortCircuitAnalysisResultDeserializer::read, "/shortcircuit-with-extensions-results.json");
    }

    @Test
    void testJsonWithFeederResult() throws IOException {
        ShortCircuitAnalysisResult result = TestingResultFactory.createWithFeederResults(ThreeSides.ONE);
        writeTest(result, this::writeJson, ComparisonUtils::assertTxtEquals, "/shortcircuit-results-with-feeder-result.json");
    }

    @Test
    void roundTripJsonWithFeederResult() throws IOException {
        ShortCircuitAnalysisResult result = TestingResultFactory.createWithFeederResults(ThreeSides.ONE);
        roundTripTest(result, this::writeJson, ShortCircuitAnalysisResultDeserializer::read, "/shortcircuit-results-with-feeder-result.json");
    }

    @Test
    void readJsonFaultResultVersion10() {
        ShortCircuitAnalysisResult result = ShortCircuitAnalysisResultDeserializer
                .read(getClass().getResourceAsStream("/shortcircuit-results-version10.json"));
        assertEquals(1, result.getFaultResults().size());
        FortescueFaultResult faultResult = (FortescueFaultResult) result.getFaultResult("id");
        assertEquals(1.0, faultResult.getCurrent().getPositiveMagnitude(), 0);
        assertEquals(1, faultResult.getLimitViolations().size());
        assertEquals(1, faultResult.getFeederResults().size());
    }

    @Test
    void readJsonFaultResultVersion11() {
        ShortCircuitAnalysisResult result = ShortCircuitAnalysisResultDeserializer
                .read(getClass().getResourceAsStream("/shortcircuit-results-version11.json"));
        assertEquals(1, result.getFaultResults().size());
        MagnitudeFaultResult faultResult = (MagnitudeFaultResult) result.getFaultResult("id");
        assertEquals(1.0, faultResult.getCurrent(), 0);
        assertEquals(1, faultResult.getLimitViolations().size());
        assertEquals(1, faultResult.getFeederResults().size());
        assertEquals(2.0, faultResult.getVoltage(), 0);
    }

    void writeCsv(ShortCircuitAnalysisResult result, Path path) {
        Network network = EurostagTutorialExample1Factory.create();
        ShortCircuitAnalysisResultExporters.export(result, path, "CSV", network);
    }

    @Test
    void testWriteCsv() throws IOException {
        ShortCircuitAnalysisResult result = TestingResultFactory.createResult();
        writeTest(result, this::writeCsv, ComparisonUtils::assertTxtEquals, "/shortcircuit-results.csv");
    }

    @Test
    void roundtripTestWithTwoFaults() throws IOException {
        ShortCircuitAnalysisResult result = TestingResultFactory.createResultWithTwoFaultResults();
        roundTripTest(result, this::writeJson, ShortCircuitAnalysisResultDeserializer::read, "/shortcircuit-results-with-two-faults.json");
    }

    @Test
    void roundTripJsonMagnitudeResults() throws IOException {
        ShortCircuitAnalysisResult result = TestingResultFactory.createMagnitudeResult();
        roundTripTest(result, this::writeJson, ShortCircuitAnalysisResultDeserializer::read, "/shortcircuit-magnitude-results.json");
    }

    @Test
    void roundTripJsonFortescueResults() throws IOException {
        ShortCircuitAnalysisResult result = TestingResultFactory.createFortescueResult();
        roundTripTest(result, this::writeJson, ShortCircuitAnalysisResultDeserializer::read, "/shortcircuit-fortescue-results.json");
    }

    @Test
    void roundTripJsonFailedResults() throws IOException {
        ShortCircuitAnalysisResult result = new ShortCircuitAnalysisResult(Collections.singletonList(new FailedFaultResult(new BusFault("id", "elementId"), FaultResult.Status.FAILURE)));
        roundTripTest(result, this::writeJson, ShortCircuitAnalysisResultDeserializer::read, "/shortcircuit-failed-result.json");
    }

    @Test
    void roundTripWithMultipleFeederResults() throws IOException {
        List<FeederResult> feederResults = new ArrayList<>();
        feederResults.add(new MagnitudeFeederResult("connectableId1", 10));
        feederResults.add(new MagnitudeFeederResult("connectableId2", 20));
        MagnitudeFaultResult faultResult = new MagnitudeFaultResult(new BusFault("faultId", "busId"), 100, feederResults, Collections.EMPTY_LIST, 200, FaultResult.Status.SUCCESS);
        ShortCircuitAnalysisResult result = new ShortCircuitAnalysisResult(Collections.singletonList(faultResult));
        roundTripTest(result, this::writeJson, ShortCircuitAnalysisResultDeserializer::read, "/shortcircuit-multiple-feeder-results.json");
    }
}