From 8a7033c10e9444321ebe83642992bc65a9203945 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Laigre?= <slaigre@silicom.fr>
Date: Mon, 31 May 2021 23:38:01 +0200
Subject: [PATCH] Throw a comprehensive exception when a terminal ref of a
 busbar section on is written in bus-breaker or bus-branch (#295) (#323)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Sébastien LAIGRE <slaigre@silicom.fr>
Signed-off-by: Mathieu BAGUE <mathieu.bague@rte-france.com>
---
 src/iidm/converter/xml/TerminalRefXml.cpp |  7 +++++++
 test/iidm/NodeBreakerVoltageLevelTest.cpp | 24 +++++++++++++++++++++++
 2 files changed, 31 insertions(+)

diff --git a/src/iidm/converter/xml/TerminalRefXml.cpp b/src/iidm/converter/xml/TerminalRefXml.cpp
index c8777a177..1b149dac8 100644
--- a/src/iidm/converter/xml/TerminalRefXml.cpp
+++ b/src/iidm/converter/xml/TerminalRefXml.cpp
@@ -9,6 +9,7 @@
 
 #include <powsybl/AssertionError.hpp>
 #include <powsybl/iidm/Branch.hpp>
+#include <powsybl/iidm/BusbarSection.hpp>
 #include <powsybl/iidm/Enum.hpp>
 #include <powsybl/iidm/Network.hpp>
 #include <powsybl/iidm/PhaseTapChanger.hpp>
@@ -18,6 +19,7 @@
 #include <powsybl/iidm/converter/Anonymizer.hpp>
 #include <powsybl/iidm/converter/Constants.hpp>
 #include <powsybl/iidm/converter/xml/NetworkXmlWriterContext.hpp>
+#include <powsybl/stdcxx/instanceof.hpp>
 #include <powsybl/xml/XmlStreamWriter.hpp>
 
 namespace powsybl {
@@ -57,6 +59,11 @@ void TerminalRefXml::writeTerminalRef(const Terminal& terminal, NetworkXmlWriter
     if (!context.getFilter().test(c)) {
         throw PowsyblException(stdcxx::format("Oups, terminal ref point to a filtered equipment %1%", c.get().getId()));
     }
+    if (terminal.getVoltageLevel().getTopologyKind() == TopologyKind::NODE_BREAKER &&
+            context.getOptions().getTopologyLevel() != TopologyLevel::NODE_BREAKER &&
+            stdcxx::isInstanceOf<BusbarSection>(terminal.getConnectable())) {
+        throw PowsyblException(stdcxx::format("Terminal ref should not point to a busbar section (here %1%). Try to export in node-breaker or delete this terminal ref.", terminal.getConnectable().get().getId()));
+    }
     writer.writeStartElement(nsPrefix, elementName);
     writer.writeAttribute(ID, context.getAnonymizer().anonymizeString(c.get().getId()));
     if (c.get().getTerminals().size() > 1) {
diff --git a/test/iidm/NodeBreakerVoltageLevelTest.cpp b/test/iidm/NodeBreakerVoltageLevelTest.cpp
index 947065dc6..1f848dfe1 100644
--- a/test/iidm/NodeBreakerVoltageLevelTest.cpp
+++ b/test/iidm/NodeBreakerVoltageLevelTest.cpp
@@ -19,8 +19,10 @@
 #include <powsybl/iidm/Network.hpp>
 #include <powsybl/iidm/Substation.hpp>
 #include <powsybl/iidm/Switch.hpp>
+#include <powsybl/iidm/TwoWindingsTransformer.hpp>
 #include <powsybl/iidm/VoltageLevel.hpp>
 #include <powsybl/iidm/VoltageLevelAdder.hpp>
+#include <powsybl/network/FourSubstationsNodeBreakerFactory.hpp>
 
 #include <powsybl/test/AssertionUtils.hpp>
 
@@ -1220,6 +1222,28 @@ BOOST_AUTO_TEST_CASE(issue318_invalidateCache) {
     BOOST_CHECK(!bbs2.getTerminal().getBusView().getBus());
 }
 
+BOOST_AUTO_TEST_CASE(NbkComprehensiveErrorMessage) {
+    Network network = powsybl::network::FourSubstationsNodeBreakerFactory::create();
+    BusbarSection& busbarSection = network.getBusbarSection("S1VL2_BBS1");
+    TwoWindingsTransformer& twt = network.getTwoWindingsTransformer("TWT");
+    twt.getPhaseTapChanger().setRegulationTerminal(stdcxx::ref(busbarSection.getTerminal()));
+
+    stdcxx::Properties properties;
+    properties.set(converter::ExportOptions::TOPOLOGY_LEVEL, "NODE_BREAKER");
+
+    std::stringstream ss;
+
+    // make sure no error is thrown while exporting to NODE_BREAKER topology
+    BOOST_CHECK_NO_THROW({
+         Network::writeXml("network.xiidm", ss, network, converter::ExportOptions(properties));
+         Network::readXml("network.xiidm", ss);
+    });
+
+    // make sure an error is thrown when exporting to BUS_BREAKER topology (see #295)
+    properties.set(converter::ExportOptions::TOPOLOGY_LEVEL, "BUS_BREAKER");
+    POWSYBL_ASSERT_THROW(Network::writeXml("network.xiidm", ss, network, converter::ExportOptions(properties)), PowsyblException, "Terminal ref should not point to a busbar section (here S1VL2_BBS1). Try to export in node-breaker or delete this terminal ref.");
+}
+
 BOOST_AUTO_TEST_SUITE_END()
 
 }  // namespace iidm