ReplaceTeePointByVoltageLevelOnLineTest.java

/**
 * Copyright (c) 2022, 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.iidm.modification.topology;

import com.powsybl.commons.PowsyblException;
import com.powsybl.commons.report.PowsyblCoreReportResourceBundle;
import com.powsybl.commons.test.PowsyblCoreTestReportResourceBundle;
import com.powsybl.commons.report.ReportNode;
import com.powsybl.iidm.modification.AbstractNetworkModification;
import com.powsybl.iidm.modification.NetworkModification;
import com.powsybl.iidm.network.*;
import com.powsybl.iidm.network.extensions.BusbarSectionPositionAdder;
import org.junit.jupiter.api.Test;

import java.io.IOException;

import static com.powsybl.iidm.modification.topology.TopologyTestUtils.*;
import static org.junit.jupiter.api.Assertions.*;
import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;

/**
 * @author Franck Lecuyer {@literal <franck.lecuyer at rte-france.com>}
 */
class ReplaceTeePointByVoltageLevelOnLineTest extends AbstractModificationTest {

    private static LineAdder createLineAdder(Line line, Network network) {
        return network.newLine()
                .setId("testLine")
                .setR(line.getR())
                .setX(line.getX())
                .setB1(line.getB1())
                .setG1(line.getG1())
                .setB2(line.getB2())
                .setG2(line.getG2());
    }

    private static Network createAdditionalLine(Network network) {

        // create additional line to test bad configuration
        VoltageLevel vl = network.newVoltageLevel().setId("VL3").setNominalV(380).setTopologyKind(TopologyKind.NODE_BREAKER).add();
        vl.getNodeBreakerView().newBusbarSection().setId("bbs3").setNode(0).add();
        vl.getNodeBreakerView().newSwitch().setId("breaker3").setName("breaker3").setKind(SwitchKind.BREAKER).setRetained(false).setOpen(true).setFictitious(false).setNode1(0).setNode2(1).add();
        vl = network.newVoltageLevel().setId("VL4").setNominalV(380).setTopologyKind(TopologyKind.NODE_BREAKER).add();
        vl.getNodeBreakerView().newBusbarSection().setId("bbs4").setNode(0).add();
        vl.getNodeBreakerView().newSwitch().setId("breaker4").setName("breaker4").setKind(SwitchKind.BREAKER).setRetained(false).setOpen(true).setFictitious(false).setNode1(0).setNode2(1).add();
        network.newLine().setId("LINE34").setR(0.1).setX(0.1).setG1(0.0).setB1(0.0).setG2(0.0).setB2(0.0).setNode1(1).setVoltageLevel1("VL3").setNode2(1).setVoltageLevel2("VL4").add();
        return network;
    }

    private static Network createNetworkAdditionalLine() {

        Network network = createNbNetworkWithBusbarSection();
        Line line = network.getLine("CJ");
        LineAdder adder = createLineAdder(line, network);
        NetworkModification modification = new CreateLineOnLineBuilder().withBusbarSectionOrBusId(BBS).withLine(line).withLineAdder(adder).build();
        modification.apply(network);
        createAdditionalLine(network);
        return network;
    }

    @Test
    void replaceTeePointByVoltageLevelOnLineNb1Test() {

        Network network = createNetworkAdditionalLine();

        ReportNode reportNode2 = ReportNode.newRootReportNode()
                .withResourceBundles(PowsyblCoreTestReportResourceBundle.TEST_BASE_NAME, PowsyblCoreReportResourceBundle.BASE_NAME)
                .withMessageTemplate("reportTestLineNotFound2")
                .build();
        NetworkModification modificationWithError2 = new ReplaceTeePointByVoltageLevelOnLineBuilder()
                .withTeePointLine1("CJ_1")
                .withTeePointLine2("line2NotFound")
                .withTeePointLineToRemove("testLine")
                .withBbsOrBusId(BBS)
                .withNewLine1Id("NEW LINE1")
                .withNewLine2Id("NEW LINE2").build();
        assertDoesNotThrow(() -> modificationWithError2.apply(network, false, ReportNode.NO_OP));
        assertTrue(assertThrows(PowsyblException.class, () -> modificationWithError2.apply(network, true, reportNode2)).getMessage().contains("Line line2NotFound is not found"));
        assertEquals("core.iidm.modification.lineNotFound", reportNode2.getChildren().get(0).getMessageKey());

        ReportNode reportNode3 = ReportNode.newRootReportNode()
                .withResourceBundles(PowsyblCoreTestReportResourceBundle.TEST_BASE_NAME, PowsyblCoreReportResourceBundle.BASE_NAME)
                .withMessageTemplate("reportTestLineNotFound")
                .build();
        NetworkModification modificationWithError3 = new ReplaceTeePointByVoltageLevelOnLineBuilder()
                .withTeePointLine1("CJ_1")
                .withTeePointLine2("CJ_2")
                .withTeePointLineToRemove("line3NotFound")
                .withBbsOrBusId(BBS)
                .withNewLine1Id("NEW LINE1")
                .withNewLine2Id("NEW LINE2").build();
        assertDoesNotThrow(() -> modificationWithError3.apply(network, false, ReportNode.NO_OP));
        assertTrue(assertThrows(PowsyblException.class, () -> modificationWithError3.apply(network, true, reportNode3)).getMessage().contains("Line line3NotFound is not found"));
        assertEquals("core.iidm.modification.lineNotFound", reportNode3.getChildren().get(0).getMessageKey());

        ReportNode reportNode4 = ReportNode.newRootReportNode()
                .withResourceBundles(PowsyblCoreTestReportResourceBundle.TEST_BASE_NAME, PowsyblCoreReportResourceBundle.BASE_NAME)
                .withMessageTemplate("reportTestBbsNotFound")
                .build();
        NetworkModification modificationWithError4 = new ReplaceTeePointByVoltageLevelOnLineBuilder()
                .withTeePointLine1("CJ_1")
                .withTeePointLine2("CJ_2")
                .withTeePointLineToRemove("testLine")
                .withBbsOrBusId("notFoundBusbarSection")
                .withNewLine1Id("NEW LINE1")
                .withNewLine2Id("NEW LINE2").build();
        assertDoesNotThrow(() -> modificationWithError4.apply(network, false, ReportNode.NO_OP));
        assertTrue(assertThrows(PowsyblException.class, () -> modificationWithError4.apply(network, true, reportNode4)).getMessage().contains("Busbar section notFoundBusbarSection is not found in voltage level VLTEST"));
        assertEquals("core.iidm.modification.busbarSectionNotFound", reportNode4.getChildren().get(0).getMessageKey());

        ReportNode reportNode5 = ReportNode.newRootReportNode()
                .withResourceBundles(PowsyblCoreTestReportResourceBundle.TEST_BASE_NAME, PowsyblCoreReportResourceBundle.BASE_NAME)
                .withMessageTemplate("reportTestWrongTeePoint")
                .build();
        NetworkModification modificationWithError5 = new ReplaceTeePointByVoltageLevelOnLineBuilder()
                .withTeePointLine1("CJ_1")
                .withTeePointLine2("CJ_2")
                .withTeePointLineToRemove("LINE34")
                .withBbsOrBusId(BBS)
                .withNewLine1Id("NEW LINE1")
                .withNewLine2Id("NEW LINE2").build();
        assertDoesNotThrow(() -> modificationWithError5.apply(network, false, ReportNode.NO_OP));
        assertTrue(assertThrows(PowsyblException.class, () -> modificationWithError5.apply(network, true, reportNode5)).getMessage().contains("Unable to find the tee point and the tapped voltage level from lines CJ_1, CJ_2 and LINE34"));
        assertEquals("core.iidm.modification.noTeePointAndOrTappedVoltageLevel", reportNode5.getChildren().get(0).getMessageKey());

        ReportNode reportNode6 = ReportNode.newRootReportNode()
                .withResourceBundles(PowsyblCoreTestReportResourceBundle.TEST_BASE_NAME, PowsyblCoreReportResourceBundle.BASE_NAME)
                .withMessageTemplate("reportTestBbsInWrongVL")
                .build();
        NetworkModification modificationWithError6 = new ReplaceTeePointByVoltageLevelOnLineBuilder()
                .withTeePointLine1("CJ_1")
                .withTeePointLine2("CJ_2")
                .withTeePointLineToRemove("testLine")
                .withBbsOrBusId("bbs3")
                .withNewLine1Id("NEW LINE1")
                .withNewLine2Id("NEW LINE2").build();
        assertDoesNotThrow(() -> modificationWithError6.apply(network, false, ReportNode.NO_OP));
        assertTrue(assertThrows(PowsyblException.class, () -> modificationWithError6.apply(network, true, reportNode6)).getMessage().contains("Busbar section bbs3 is not found in voltage level VLTEST"));
        assertEquals("core.iidm.modification.busbarSectionNotFound", reportNode6.getChildren().get(0).getMessageKey());
    }

    @Test
    void replaceTeePointByVoltageLevelOnLineNb2Test() throws IOException {

        Network network = createNetworkAdditionalLine();

        ReportNode reportNode = ReportNode.newRootReportNode()
                .withResourceBundles(PowsyblCoreTestReportResourceBundle.TEST_BASE_NAME, PowsyblCoreReportResourceBundle.BASE_NAME)
                .withMessageTemplate("reportTestReplaceTeePointByVoltageLevelOnLineNB")
                .build();
        NetworkModification modification = new ReplaceTeePointByVoltageLevelOnLineBuilder()
                .withTeePointLine1("CJ_1")
                .withTeePointLine2("CJ_2")
                .withTeePointLineToRemove("testLine")
                .withBbsOrBusId(BBS)
                .withNewLine1Id("NEW LINE1")
                .withNewLine2Id("NEW LINE2").build();
        modification.apply(network, true, reportNode);
        writeXmlTest(network, "/fictitious-replace-tee-point-by-voltage-level-on-line-nb.xml");
        testReportNode(reportNode, "/reportNode/replace-tee-point-by-vl-on-line-nb-report.txt");
    }

    @Test
    void replaceTeePointByVoltageLevelOnLineNbBbTest() throws IOException {
        Network network = createNbBbNetwork();
        Line line = network.getLine("NHV1_NHV2_1");
        LineAdder adder = createLineAdder(line, network);
        NetworkModification modification = new CreateLineOnLineBuilder().withBusbarSectionOrBusId(BBS).withLine(line).withLineAdder(adder).build();
        modification.apply(network);

        BusbarSection bbs = network.getBusbarSection("bbs");
        bbs.newExtension(BusbarSectionPositionAdder.class)
            .withBusbarIndex(1)
            .withSectionIndex(1)
            .add();

        ReportNode reportNode = ReportNode.newRootReportNode()
                .withResourceBundles(PowsyblCoreTestReportResourceBundle.TEST_BASE_NAME, PowsyblCoreReportResourceBundle.BASE_NAME)
                .withMessageTemplate("reportTestReplaceTeePointByVoltageLevelOnLineNBBb")
                .build();
        modification = new ReplaceTeePointByVoltageLevelOnLineBuilder()
                .withTeePointLine1("NHV1_NHV2_1_1")
                .withTeePointLine2("NHV1_NHV2_1_2")
                .withTeePointLineToRemove("testLine")
                .withBbsOrBusId(BBS)
                .withNewLine1Id("NEW LINE1")
                .withNewLine2Id("NEW LINE2").build();
        modification.apply(network, true, reportNode);
        writeXmlTest(network, "/eurostag-replace-tee-point-by-voltage-level-on-line-nbbb.xml");
        testReportNode(reportNode, "/reportNode/replace-tee-point-by-vl-on-line-nb-bb-report.txt");
    }

    @Test
    void replaceTeePointByVoltageLevelOnLineBbTest() throws IOException {
        Network network = createBbNetwork();
        Line line = network.getLine("NHV1_NHV2_1");
        LineAdder adder = createLineAdder(line, network);
        NetworkModification modification = new CreateLineOnLineBuilder().withBusbarSectionOrBusId("bus").withLine(line).withLineAdder(adder).build();
        modification.apply(network);

        VoltageLevel vl = network.newVoltageLevel().setId("VL3").setNominalV(380).setTopologyKind(TopologyKind.BUS_BREAKER).add();
        vl.getBusBreakerView().newBus().setId("bus3").add();

        ReportNode reportNode1 = ReportNode.newRootReportNode()
                .withResourceBundles(PowsyblCoreTestReportResourceBundle.TEST_BASE_NAME, PowsyblCoreReportResourceBundle.BASE_NAME)
                .withMessageTemplate("reportTestUndefinedBus")
                .build();
        NetworkModification modificationWithError1 = new ReplaceTeePointByVoltageLevelOnLineBuilder()
                .withTeePointLine1("NHV1_NHV2_1_1")
                .withTeePointLine2("NHV1_NHV2_1_2")
                .withTeePointLineToRemove("testLine")
                .withBbsOrBusId("busNotFound")
                .withNewLine1Id("NEW LINE1")
                .withNewLine2Id("NEW LINE2").build();
        assertDoesNotThrow(() -> modificationWithError1.apply(network, false, ReportNode.NO_OP));
        assertTrue(assertThrows(PowsyblException.class, () -> modificationWithError1.apply(network, true, reportNode1)).getMessage().contains("Bus busNotFound is not found in voltage level " + VOLTAGE_LEVEL_ID));
        assertEquals("core.iidm.modification.busNotFound", reportNode1.getChildren().get(0).getMessageKey());

        ReportNode reportNode2 = ReportNode.newRootReportNode()
                .withResourceBundles(PowsyblCoreTestReportResourceBundle.TEST_BASE_NAME, PowsyblCoreReportResourceBundle.BASE_NAME)
                .withMessageTemplate("reportTestBusInWrongVl")
                .build();
        NetworkModification modificationWithError2 = new ReplaceTeePointByVoltageLevelOnLineBuilder()
                .withTeePointLine1("NHV1_NHV2_1_1")
                .withTeePointLine2("NHV1_NHV2_1_2")
                .withTeePointLineToRemove("testLine")
                .withBbsOrBusId("bus3")
                .withNewLine1Id("NEW LINE1")
                .withNewLine2Id("NEW LINE2").build();
        assertDoesNotThrow(() -> modificationWithError2.apply(network, false, ReportNode.NO_OP));
        assertTrue(assertThrows(PowsyblException.class, () -> modificationWithError2.apply(network, true, reportNode2)).getMessage().contains("Bus bus3 is not found in voltage level " + VOLTAGE_LEVEL_ID));
        assertEquals("core.iidm.modification.busNotFound", reportNode2.getChildren().get(0).getMessageKey());

        ReportNode reportNode3 = ReportNode.newRootReportNode()
                .withResourceBundles(PowsyblCoreTestReportResourceBundle.TEST_BASE_NAME, PowsyblCoreReportResourceBundle.BASE_NAME)
                .withMessageTemplate("reportTestReplaceTeePointByVoltageLevelOnLineBb")
                .build();
        modification = new ReplaceTeePointByVoltageLevelOnLineBuilder()
                .withTeePointLine1("NHV1_NHV2_1_1")
                .withTeePointLine2("NHV1_NHV2_1_2")
                .withTeePointLineToRemove("testLine")
                .withBbsOrBusId("bus")
                .withNewLine1Id("NEW LINE1")
                .withNewLine2Id("NEW LINE2").build();
        modification.apply(network, true, reportNode3);
        writeXmlTest(network, "/eurostag-replace-tee-point-by-voltage-level-on-line-bb.xml");
        testReportNode(reportNode3, "/reportNode/replace-tee-point-by-vl-on-line-bb-report.txt");
    }

    @Test
    void testConstructor() {
        ReplaceTeePointByVoltageLevelOnLine modification = new ReplaceTeePointByVoltageLevelOnLineBuilder()
                .withTeePointLine1("NHV1_NHV2_1")
                .withTeePointLine2("NHV1_NHV2_2")
                .withTeePointLineToRemove("NHV1_NHV2_3")
                .withBbsOrBusId("BBS")
                .withNewLine1Id("NEW LINE1 ID")
                .withNewLine2Id("NEW LINE2 ID").build();
        assertEquals("NHV1_NHV2_1", modification.getTeePointLine1Id());
        assertEquals("NHV1_NHV2_2", modification.getTeePointLine2Id());
        assertEquals("NHV1_NHV2_3", modification.getTeePointLineToRemoveId());
        assertEquals("BBS", modification.getBbsOrBusId());
        assertEquals("NEW LINE1 ID", modification.getNewLine1Id());
        assertNull(modification.getNewLine1Name());
        assertEquals("NEW LINE2 ID", modification.getNewLine2Id());
        assertNull(modification.getNewLine2Name());

        modification = new ReplaceTeePointByVoltageLevelOnLineBuilder()
                .withTeePointLine1("NHV1_NHV2_1")
                .withTeePointLine2("NHV1_NHV2_2")
                .withTeePointLineToRemove("NHV1_NHV2_3")
                .withBbsOrBusId("BBS")
                .withNewLine1Id("NEW LINE1 ID")
                .withNewLine1Name("NEW LINE1 NAME")
                .withNewLine2Id("NEW LINE2 ID")
                .withNewLine2Name("NEW LINE2 NAME").build();
        assertEquals("NEW LINE1 NAME", modification.getNewLine1Name());
        assertEquals("NEW LINE2 NAME", modification.getNewLine2Name());
    }

    @Test
    void testGetName() {
        AbstractNetworkModification networkModification = new ReplaceTeePointByVoltageLevelOnLineBuilder()
            .withTeePointLine1("NHV1_NHV2_1")
            .withTeePointLine2("NHV1_NHV2_2")
            .withTeePointLineToRemove("NHV1_NHV2_3")
            .withBbsOrBusId("BBS")
            .withNewLine1Id("NEW LINE1 ID")
            .withNewLine2Id("NEW LINE2 ID").build();
        assertEquals("ReplaceTeePointByVoltageLevelOnLine", networkModification.getName());
    }
}