mir/kea
2
0
Fork 0
mirror of https://gitlab.isc.org/isc-projects/kea synced 2025-08-31 22:15:23 +00:00
Code Issues Releases Wiki Activity

[#2601] rename TranslatorBasic to Translator

Browse Source
This commit is contained in:
Andrei Pavel
2022-11-07 09:52:21 +02:00
committed by Razvan Becheriu
parent d6f69df968
commit ec27d6a73c
25 changed files with 143 additions and 142 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/bin/netconf/netconf.cc
View File

@@ -713,8 +713,8 @@ NetconfAgent::logChanges(Session sess, string_view const& model) {
msg << " (list)"; msg << " (list)";
} else { } else {
optional<string> const str( optional<string> const str(
TranslatorBasic::translateToYang(TranslatorBasic::translateFromYang(change.node), Translator::translateToYang(Translator::translateFromYang(change.node),
LeafBaseType::Unknown)); LeafBaseType::Unknown));
if (str) { if (str) {
msg << " = " << *str; msg << " = " << *str;
} }

4
src/lib/yang/tests/config_unittests.cc
View File

@@ -62,7 +62,7 @@ public:
virtual ~ConfigTest() = default; virtual ~ConfigTest() = default;
void SetUp() override { void SetUp() override {
translator_.reset(new TranslatorBasic(session_, model_)); translator_.reset(new Translator(session_, model_));
cleanModelData(); cleanModelData();
} }
@@ -181,7 +181,7 @@ public:
/// @brief The sysrepo session. /// @brief The sysrepo session.
Session session_; Session session_;
std::unique_ptr<TranslatorBasic> translator_; std::unique_ptr<Translator> translator_;
}; // ConfigTest }; // ConfigTest
struct ConfigTestKeaV4 : ConfigTest { struct ConfigTestKeaV4 : ConfigTest {

64
src/lib/yang/tests/translator_unittests.cc
View File

@@ -20,7 +20,7 @@ using namespace isc::yang::test;
using namespace libyang; using namespace libyang;
using namespace sysrepo; using namespace sysrepo;
struct TranslatorBasicTest : ::testing::Test { struct TranslatorTest : ::testing::Test {
void SetUp() override { void SetUp() override {
SysrepoSetup::cleanSharedMemory(); SysrepoSetup::cleanSharedMemory();
cleanUp(); cleanUp();
@@ -42,27 +42,27 @@ private:
session.deleteItem("/keatest-module:presence-container"); session.deleteItem("/keatest-module:presence-container");
session.applyChanges(); session.applyChanges();
} }
}; // TranslatorBasicTest }; // TranslatorTest
namespace { namespace {
// Test constructor. // Test constructor.
TEST_F(TranslatorBasicTest, constructor) { TEST_F(TranslatorTest, constructor) {
// Get a session. // Get a session.
Session sess(Connection{}.sessionStart()); Session sess(Connection{}.sessionStart());
sess.switchDatastore(sysrepo::Datastore::Candidate); sess.switchDatastore(sysrepo::Datastore::Candidate);
// Get a translator object. // Get a translator object.
std::unique_ptr<TranslatorBasic> t_obj; std::unique_ptr<Translator> t_obj;
EXPECT_NO_THROW_LOG(t_obj.reset(new TranslatorBasic(sess, ""))); EXPECT_NO_THROW_LOG(t_obj.reset(new Translator(sess, "")));
} }
// Test basic YANG to JSON value conversion using sysrepo test models. // Test basic YANG to JSON value conversion using sysrepo test models.
TEST_F(TranslatorBasicTest, getItem) { TEST_F(TranslatorTest, getItem) {
// Get a translator object to play with. // Get a translator object to play with.
Session sess(Connection{}.sessionStart()); Session sess(Connection{}.sessionStart());
sess.switchDatastore(sysrepo::Datastore::Candidate); sess.switchDatastore(sysrepo::Datastore::Candidate);
std::unique_ptr<TranslatorBasic> t_obj; std::unique_ptr<Translator> t_obj;
ASSERT_NO_THROW_LOG(t_obj.reset(new TranslatorBasic(sess, ""))); ASSERT_NO_THROW_LOG(t_obj.reset(new Translator(sess, "")));
string value; string value;
ConstElementPtr elem; ConstElementPtr elem;
string xpath; string xpath;
@@ -237,100 +237,100 @@ TEST_F(TranslatorBasicTest, getItem) {
} }
// Test JSON to basic YANG value conversion using the static method. // Test JSON to basic YANG value conversion using the static method.
TEST_F(TranslatorBasicTest, valueTo) { TEST_F(TranslatorTest, valueTo) {
optional<string> value; optional<string> value;
// Null. // Null.
ConstElementPtr elem; ConstElementPtr elem;
EXPECT_NO_THROW_LOG(value = TranslatorBasic::translateToYang(elem, LeafBaseType::String)); EXPECT_NO_THROW_LOG(value = Translator::translateToYang(elem, LeafBaseType::String));
EXPECT_EQ(nullopt, value); EXPECT_EQ(nullopt, value);
EXPECT_FALSE(elem); EXPECT_FALSE(elem);
// Container. // Container.
elem = Element::createMap(); elem = Element::createMap();
EXPECT_THROW_MSG(TranslatorBasic::translateToYang(elem, LeafBaseType::Unknown), NotImplemented, EXPECT_THROW_MSG(Translator::translateToYang(elem, LeafBaseType::Unknown), NotImplemented,
"TranslatorBasic::value(): map element"); "Translator::value(): map element");
// List. // List.
elem = Element::createList(); elem = Element::createList();
EXPECT_THROW_MSG(TranslatorBasic::translateToYang(elem, LeafBaseType::Unknown), NotImplemented, EXPECT_THROW_MSG(Translator::translateToYang(elem, LeafBaseType::Unknown), NotImplemented,
"TranslatorBasic::value(): list element"); "Translator::value(): list element");
// String. // String.
string str("foo"); string str("foo");
elem = Element::create(str); elem = Element::create(str);
EXPECT_NO_THROW_LOG(value = TranslatorBasic::translateToYang(elem, LeafBaseType::String)); EXPECT_NO_THROW_LOG(value = Translator::translateToYang(elem, LeafBaseType::String));
EXPECT_EQ(elem->stringValue(), value); EXPECT_EQ(elem->stringValue(), value);
// Bool. // Bool.
elem = Element::create(false); elem = Element::create(false);
EXPECT_NO_THROW_LOG(value = TranslatorBasic::translateToYang(elem, LeafBaseType::Bool)); EXPECT_NO_THROW_LOG(value = Translator::translateToYang(elem, LeafBaseType::Bool));
EXPECT_EQ(elem->str(), value); EXPECT_EQ(elem->str(), value);
// Unsigned 8 bit integer. // Unsigned 8 bit integer.
elem = Element::create(123); elem = Element::create(123);
EXPECT_NO_THROW_LOG(value = TranslatorBasic::translateToYang(elem, LeafBaseType::Uint8)); EXPECT_NO_THROW_LOG(value = Translator::translateToYang(elem, LeafBaseType::Uint8));
EXPECT_EQ(elem->str(), value); EXPECT_EQ(elem->str(), value);
elem.reset(); elem.reset();
// Unsigned 16 bit integer. // Unsigned 16 bit integer.
elem = Element::create(12345); elem = Element::create(12345);
EXPECT_NO_THROW_LOG(value = TranslatorBasic::translateToYang(elem, LeafBaseType::Uint16)); EXPECT_NO_THROW_LOG(value = Translator::translateToYang(elem, LeafBaseType::Uint16));
EXPECT_EQ(elem->str(), value); EXPECT_EQ(elem->str(), value);
elem.reset(); elem.reset();
// Unsigned 32 bit integer. // Unsigned 32 bit integer.
elem = Element::create(123456789); elem = Element::create(123456789);
EXPECT_NO_THROW_LOG(value = TranslatorBasic::translateToYang(elem, LeafBaseType::Uint32)); EXPECT_NO_THROW_LOG(value = Translator::translateToYang(elem, LeafBaseType::Uint32));
EXPECT_EQ(elem->str(), value); EXPECT_EQ(elem->str(), value);
elem.reset(); elem.reset();
// Signed 8 bit integer. // Signed 8 bit integer.
elem = Element::create(-123); elem = Element::create(-123);
EXPECT_NO_THROW_LOG(value = TranslatorBasic::translateToYang(elem, LeafBaseType::Int8)); EXPECT_NO_THROW_LOG(value = Translator::translateToYang(elem, LeafBaseType::Int8));
EXPECT_EQ(elem->str(), value); EXPECT_EQ(elem->str(), value);
elem.reset(); elem.reset();
// Signed 16 bit integer. // Signed 16 bit integer.
elem = Element::create(-12345); elem = Element::create(-12345);
EXPECT_NO_THROW_LOG(value = TranslatorBasic::translateToYang(elem, LeafBaseType::Int16)); EXPECT_NO_THROW_LOG(value = Translator::translateToYang(elem, LeafBaseType::Int16));
EXPECT_EQ(elem->str(), value); EXPECT_EQ(elem->str(), value);
elem.reset(); elem.reset();
// Signed 32 bit integer. // Signed 32 bit integer.
elem = Element::create(-123456789); elem = Element::create(-123456789);
EXPECT_NO_THROW_LOG(value = TranslatorBasic::translateToYang(elem, LeafBaseType::Int32)); EXPECT_NO_THROW_LOG(value = Translator::translateToYang(elem, LeafBaseType::Int32));
EXPECT_EQ(elem->str(), value); EXPECT_EQ(elem->str(), value);
elem.reset(); elem.reset();
// Identity reference. // Identity reference.
elem = Element::create(str); elem = Element::create(str);
EXPECT_NO_THROW_LOG(value = TranslatorBasic::translateToYang(elem, LeafBaseType::IdentityRef)); EXPECT_NO_THROW_LOG(value = Translator::translateToYang(elem, LeafBaseType::IdentityRef));
EXPECT_EQ(elem->stringValue(), value); EXPECT_EQ(elem->stringValue(), value);
// Enumeration item. // Enumeration item.
EXPECT_NO_THROW_LOG(value = TranslatorBasic::translateToYang(elem, LeafBaseType::Enum)); EXPECT_NO_THROW_LOG(value = Translator::translateToYang(elem, LeafBaseType::Enum));
EXPECT_EQ(elem->stringValue(), value); EXPECT_EQ(elem->stringValue(), value);
// Binary. // Binary.
elem = Element::create(string("foobar")); elem = Element::create(string("foobar"));
EXPECT_NO_THROW_LOG(value = TranslatorBasic::translateToYang(elem, LeafBaseType::Binary)); EXPECT_NO_THROW_LOG(value = Translator::translateToYang(elem, LeafBaseType::Binary));
EXPECT_EQ("Zm9vYmFy", value); EXPECT_EQ("Zm9vYmFy", value);
// Decimal 64. // Decimal 64.
double d64(.1234); double d64(.1234);
elem = Element::create(d64); elem = Element::create(d64);
EXPECT_NO_THROW_LOG(value = TranslatorBasic::translateToYang(elem, LeafBaseType::Dec64)); EXPECT_NO_THROW_LOG(value = Translator::translateToYang(elem, LeafBaseType::Dec64));
EXPECT_EQ(elem->str(), value); EXPECT_EQ(elem->str(), value);
} }
// Test JSON to basic YANG value conversion using sysrepo test models. // Test JSON to basic YANG value conversion using sysrepo test models.
TEST_F(TranslatorBasicTest, setItem) { TEST_F(TranslatorTest, setItem) {
// Get a translator object to play with. // Get a translator object to play with.
Session sess(Connection{}.sessionStart()); Session sess(Connection{}.sessionStart());
sess.switchDatastore(sysrepo::Datastore::Candidate); sess.switchDatastore(sysrepo::Datastore::Candidate);
std::unique_ptr<TranslatorBasic> t_obj; std::unique_ptr<Translator> t_obj;
ASSERT_NO_THROW_LOG(t_obj.reset(new TranslatorBasic(sess, ""))); ASSERT_NO_THROW_LOG(t_obj.reset(new Translator(sess, "")));
ElementPtr elem; ElementPtr elem;
string xpath; string xpath;
@@ -519,12 +519,12 @@ TEST_F(TranslatorBasicTest, setItem) {
} }
// Test YANG list item retrieval. // Test YANG list item retrieval.
TEST_F(TranslatorBasicTest, list) { TEST_F(TranslatorTest, list) {
// Get a translator object to play with. // Get a translator object to play with.
Session sess(Connection{}.sessionStart()); Session sess(Connection{}.sessionStart());
sess.switchDatastore(sysrepo::Datastore::Candidate); sess.switchDatastore(sysrepo::Datastore::Candidate);
std::unique_ptr<TranslatorBasic> t_obj; std::unique_ptr<Translator> t_obj;
ASSERT_NO_THROW_LOG(t_obj.reset(new TranslatorBasic(sess, ""))); ASSERT_NO_THROW_LOG(t_obj.reset(new Translator(sess, "")));
string xpath; string xpath;
// Empty list. // Empty list.

2
src/lib/yang/tests/translator_utils_unittests.cc
View File

@@ -240,7 +240,7 @@ void sanityCheckConfig(const std::string& model, const YRTree& tree) {
sess.switchDatastore(sysrepo::Datastore::Candidate); sess.switchDatastore(sysrepo::Datastore::Candidate);
// Cleanup. // Cleanup.
TranslatorBasic translator(sess, model); Translator translator(sess, model);
if (model == "keatest-module") { if (model == "keatest-module") {
translator.deleteItem("/keatest-module:container"); translator.deleteItem("/keatest-module:container");
translator.deleteItem("/keatest-module:kernel-modules"); translator.deleteItem("/keatest-module:kernel-modules");

4
src/lib/yang/testutils/translator_test.cc
View File

@@ -99,7 +99,7 @@ YangRepr::YangReprItem::get(const string& xpath, Session session) {
// Get the underlying type. // Get the underlying type.
type = data_node->schema().asLeaf().valueType().asLeafRef().resolvedType().base(); type = data_node->schema().asLeaf().valueType().asLeafRef().resolvedType().base();
} }
value = TranslatorBasic::translateToYang(TranslatorBasic::translateFromYang(data_node), value = Translator::translateToYang(Translator::translateFromYang(data_node),
type); type);
val_xpath = string(data_node->path()); val_xpath = string(data_node->path());
} catch (Error const& ex) { } catch (Error const& ex) {
@@ -113,7 +113,7 @@ YangRepr::Tree
YangRepr::get(Session session) const { YangRepr::get(Session session) const {
Tree result; Tree result;
try { try {
TranslatorBasic tb(session, model_); Translator tb(session, model_);
string const xpath0("/" + model_ + ":*//."); string const xpath0("/" + model_ + ":*//.");
tb.forAll(xpath0, [&](libyang::DataNode const& node) { tb.forAll(xpath0, [&](libyang::DataNode const& node) {
string const& xpath(node.path()); string const& xpath(node.path());

117
src/lib/yang/translator.cc
View File

@@ -24,14 +24,14 @@ using namespace sysrepo;
namespace isc { namespace isc {
namespace yang { namespace yang {
TranslatorBasic::TranslatorBasic(Session session, const string& model) Translator::Translator(Session session, const string& model)
: session_(session), model_(model) { : session_(session), model_(model) {
} }
void void
TranslatorBasic::checkAndGetLeaf(ElementPtr& storage, Translator::checkAndGetLeaf(ElementPtr& storage,
DataNode const& data_node, DataNode const& data_node,
string const& name) const { string const& name) const {
ElementPtr const& x(getItem(data_node, name)); ElementPtr const& x(getItem(data_node, name));
if (x) { if (x) {
storage->set(name, x); storage->set(name, x);
@@ -39,10 +39,10 @@ TranslatorBasic::checkAndGetLeaf(ElementPtr& storage,
} }
void void
TranslatorBasic::checkAndGetDivergingLeaf(ElementPtr& storage, Translator::checkAndGetDivergingLeaf(ElementPtr& storage,
DataNode const& data_node, DataNode const& data_node,
string const& name, string const& name,
string const& yang_name) const { string const& yang_name) const {
ElementPtr const& x(getItem(data_node, yang_name)); ElementPtr const& x(getItem(data_node, yang_name));
if (x) { if (x) {
storage->set(name, x); storage->set(name, x);
@@ -50,9 +50,9 @@ TranslatorBasic::checkAndGetDivergingLeaf(ElementPtr& storage,
} }
void void
TranslatorBasic::checkAndGetAndJsonifyLeaf(ElementPtr& storage, Translator::checkAndGetAndJsonifyLeaf(ElementPtr& storage,
DataNode const& data_node, DataNode const& data_node,
string const& name) const { string const& name) const {
ElementPtr const& x(getItem(data_node, name)); ElementPtr const& x(getItem(data_node, name));
if (x) { if (x) {
storage->set(name, Element::fromJSON(x->stringValue())); storage->set(name, Element::fromJSON(x->stringValue()));
@@ -60,9 +60,9 @@ TranslatorBasic::checkAndGetAndJsonifyLeaf(ElementPtr& storage,
} }
void void
TranslatorBasic::checkAndJsonifyAndSetLeaf(ConstElementPtr const& from, Translator::checkAndJsonifyAndSetLeaf(ConstElementPtr const& from,
string const& xpath, string const& xpath,
string const& name) { string const& name) {
ConstElementPtr const& x(from->get(name)); ConstElementPtr const& x(from->get(name));
if (x) { if (x) {
ElementPtr const& json(Element::create(x->str())); ElementPtr const& json(Element::create(x->str()));
@@ -70,31 +70,31 @@ TranslatorBasic::checkAndJsonifyAndSetLeaf(ConstElementPtr const& from,
} }
} }
void TranslatorBasic::checkAndSetLeaf(ConstElementPtr const& from, void Translator::checkAndSetLeaf(ConstElementPtr const& from,
string const& xpath, string const& xpath,
string const& name, string const& name,
LeafBaseType const type) { LeafBaseType const type) {
ConstElementPtr const& x(from->get(name)); ConstElementPtr const& x(from->get(name));
if (x) { if (x) {
setItem(xpath + "/" + name, x, type); setItem(xpath + "/" + name, x, type);
} }
} }
void TranslatorBasic::checkAndSetDivergingLeaf(ConstElementPtr const& from, void Translator::checkAndSetDivergingLeaf(ConstElementPtr const& from,
string const& xpath, string const& xpath,
string const& name, string const& name,
string const& yang_name, string const& yang_name,
LeafBaseType const type) { LeafBaseType const type) {
ConstElementPtr const& x(from->get(name)); ConstElementPtr const& x(from->get(name));
if (x) { if (x) {
setItem(xpath + "/" + yang_name, x, type); setItem(xpath + "/" + yang_name, x, type);
} }
} }
void TranslatorBasic::checkAndSetLeafList(ConstElementPtr const& from, void Translator::checkAndSetLeafList(ConstElementPtr const& from,
string const& xpath, string const& xpath,
string const& name, string const& name,
LeafBaseType const type) { LeafBaseType const type) {
ConstElementPtr const& leaf_list(from->get(name)); ConstElementPtr const& leaf_list(from->get(name));
if (leaf_list && !leaf_list->empty()) { if (leaf_list && !leaf_list->empty()) {
for (ElementPtr const& leaf : leaf_list->listValue()) { for (ElementPtr const& leaf : leaf_list->listValue()) {
@@ -103,8 +103,8 @@ void TranslatorBasic::checkAndSetLeafList(ConstElementPtr const& from,
} }
} }
void TranslatorBasic::checkAndSetUserContext(ConstElementPtr const& from, void Translator::checkAndSetUserContext(ConstElementPtr const& from,
string const& xpath) { string const& xpath) {
ConstElementPtr const& user_context(Adaptor::getContext(from)); ConstElementPtr const& user_context(Adaptor::getContext(from));
if (user_context) { if (user_context) {
setItem(xpath + "/user-context", Element::create(user_context->str()), setItem(xpath + "/user-context", Element::create(user_context->str()),
@@ -113,7 +113,7 @@ void TranslatorBasic::checkAndSetUserContext(ConstElementPtr const& from,
} }
string string
TranslatorBasic::decode64(string const& input) { Translator::decode64(string const& input) {
vector<uint8_t> binary; vector<uint8_t> binary;
decodeBase64(input, binary); decodeBase64(input, binary);
string result; string result;
@@ -123,7 +123,7 @@ TranslatorBasic::decode64(string const& input) {
} }
void void
TranslatorBasic::deleteItem(string const& xpath) { Translator::deleteItem(string const& xpath) {
/// @todo: Remove this if convenient. It is not strictly required and only done to detect /// @todo: Remove this if convenient. It is not strictly required and only done to detect
/// missing schema nodes and throw an exception to keep old behavior. /// missing schema nodes and throw an exception to keep old behavior.
try { try {
@@ -148,7 +148,7 @@ TranslatorBasic::deleteItem(string const& xpath) {
string string
TranslatorBasic::encode64(string const& input) { Translator::encode64(string const& input) {
vector<uint8_t> binary; vector<uint8_t> binary;
binary.resize(input.size()); binary.resize(input.size());
memmove(&binary[0], input.c_str(), binary.size()); memmove(&binary[0], input.c_str(), binary.size());
@@ -156,7 +156,7 @@ TranslatorBasic::encode64(string const& input) {
} }
DataNode DataNode
TranslatorBasic::findXPath(string const& xpath) { Translator::findXPath(string const& xpath) {
optional<DataNode> const& data_node(getData(xpath)); optional<DataNode> const& data_node(getData(xpath));
if (!data_node) { if (!data_node) {
isc_throw(NetconfError, "no data"); isc_throw(NetconfError, "no data");
@@ -169,7 +169,7 @@ TranslatorBasic::findXPath(string const& xpath) {
} }
optional<DataNode> optional<DataNode>
TranslatorBasic::getData(string const& xpath) const { Translator::getData(string const& xpath) const {
/// @todo: Remove this if convenient. It is not strictly required and only done to detect /// @todo: Remove this if convenient. It is not strictly required and only done to detect
/// missing schema nodes and throw an exception to keep old behavior. /// missing schema nodes and throw an exception to keep old behavior.
try { try {
@@ -192,7 +192,8 @@ TranslatorBasic::getData(string const& xpath) const {
} }
ElementPtr ElementPtr
TranslatorBasic::getItem(DataNode const& data_node, string const& xpath) const { Translator::getItem(DataNode const& data_node,
string const& xpath) const {
try { try {
Set<DataNode> const& nodes(data_node.findXPath(xpath)); Set<DataNode> const& nodes(data_node.findXPath(xpath));
if (nodes.empty()) { if (nodes.empty()) {
@@ -227,7 +228,7 @@ TranslatorBasic::getItem(DataNode const& data_node, string const& xpath) const {
} }
ElementPtr ElementPtr
TranslatorBasic::getItemFromAbsoluteXpath(string const& xpath) const { Translator::getItemFromAbsoluteXpath(string const& xpath) const {
optional<DataNode> const& data_node(getData(xpath)); optional<DataNode> const& data_node(getData(xpath));
if (!data_node) { if (!data_node) {
/// @todo: /// @todo:
@@ -238,9 +239,9 @@ TranslatorBasic::getItemFromAbsoluteXpath(string const& xpath) const {
} }
void void
TranslatorBasic::getMandatoryLeaf(ElementPtr& storage, Translator::getMandatoryLeaf(ElementPtr& storage,
DataNode const& data_node, DataNode const& data_node,
string const& name) const { string const& name) const {
ElementPtr const& x(getItem(data_node, name)); ElementPtr const& x(getItem(data_node, name));
if (!x) { if (!x) {
isc_throw(MissingNode, name); isc_throw(MissingNode, name);
@@ -250,10 +251,10 @@ TranslatorBasic::getMandatoryLeaf(ElementPtr& storage,
void void
TranslatorBasic::getMandatoryDivergingLeaf(ElementPtr& storage, Translator::getMandatoryDivergingLeaf(ElementPtr& storage,
DataNode const& data_node, DataNode const& data_node,
string const& name, string const& name,
string const& yang_name) const { string const& yang_name) const {
ElementPtr const& x(getItem(data_node, yang_name)); ElementPtr const& x(getItem(data_node, yang_name));
if (!x) { if (!x) {
isc_throw(MissingNode, yang_name); isc_throw(MissingNode, yang_name);
@@ -262,7 +263,7 @@ TranslatorBasic::getMandatoryDivergingLeaf(ElementPtr& storage,
} }
void void
TranslatorBasic::setItem(const string& xpath, ConstElementPtr elem, Translator::setItem(const string& xpath, ConstElementPtr elem,
LeafBaseType type) { LeafBaseType type) {
optional<string> const value(translateToYang(elem, type)); optional<string> const value(translateToYang(elem, type));
try { try {
@@ -275,10 +276,10 @@ TranslatorBasic::setItem(const string& xpath, ConstElementPtr elem,
} }
void void
TranslatorBasic::setMandatoryLeaf(ConstElementPtr const& from, Translator::setMandatoryLeaf(ConstElementPtr const& from,
string const& xpath, string const& xpath,
string const& name, string const& name,
LeafBaseType const type) { LeafBaseType const type) {
ConstElementPtr const& x(from->get(name)); ConstElementPtr const& x(from->get(name));
if (!x) { if (!x) {
isc_throw(MissingNode, "xpath: " << xpath << ", name: " << name); isc_throw(MissingNode, "xpath: " << xpath << ", name: " << name);
@@ -287,11 +288,11 @@ TranslatorBasic::setMandatoryLeaf(ConstElementPtr const& from,
} }
void void
TranslatorBasic::setMandatoryDivergingLeaf(ConstElementPtr const& from, Translator::setMandatoryDivergingLeaf(ConstElementPtr const& from,
string const& xpath, string const& xpath,
string const& name, string const& name,
string const& yang_name, string const& yang_name,
LeafBaseType const type) { LeafBaseType const type) {
ConstElementPtr const& x(from->get(name)); ConstElementPtr const& x(from->get(name));
if (!x) { if (!x) {
isc_throw(MissingNode, "xpath: " << xpath << ", name: " << name); isc_throw(MissingNode, "xpath: " << xpath << ", name: " << name);
@@ -300,7 +301,7 @@ TranslatorBasic::setMandatoryDivergingLeaf(ConstElementPtr const& from,
} }
ElementPtr ElementPtr
TranslatorBasic::translateFromYang(optional<DataNode> data_node) { Translator::translateFromYang(optional<DataNode> data_node) {
NodeType const node_type(data_node->schema().nodeType()); NodeType const node_type(data_node->schema().nodeType());
if (node_type == NodeType::Leaf || node_type == NodeType::Leaflist) { if (node_type == NodeType::Leaf || node_type == NodeType::Leaflist) {
DataNodeTerm const& leaf(data_node->asTerm()); DataNodeTerm const& leaf(data_node->asTerm());
@@ -322,8 +323,8 @@ TranslatorBasic::translateFromYang(optional<DataNode> data_node) {
} }
optional<string> optional<string>
TranslatorBasic::translateToYang(ConstElementPtr const& element, Translator::translateToYang(ConstElementPtr const& element,
LeafBaseType const type) { LeafBaseType const type) {
if (!element) { if (!element) {
// A null ElementPtr is how we signal that this item requires no value. // A null ElementPtr is how we signal that this item requires no value.
// Useful when setting YANG lists which is the only way to set their // Useful when setting YANG lists which is the only way to set their
@@ -331,10 +332,10 @@ TranslatorBasic::translateToYang(ConstElementPtr const& element,
return nullopt; return nullopt;
} else if (element->getType() == Element::map) { } else if (element->getType() == Element::map) {
/// @todo: implement /// @todo: implement
isc_throw(NotImplemented, "TranslatorBasic::value(): map element"); isc_throw(NotImplemented, "Translator::value(): map element");
} else if (element->getType() == Element::list) { } else if (element->getType() == Element::list) {
/// @todo: implement /// @todo: implement
isc_throw(NotImplemented, "TranslatorBasic::value(): list element"); isc_throw(NotImplemented, "Translator::value(): list element");
} }
if (type == LeafBaseType::Enum || if (type == LeafBaseType::Enum ||
type == LeafBaseType::String || type == LeafBaseType::String ||

8
src/lib/yang/translator.h
View File

@@ -17,16 +17,16 @@ namespace isc {
namespace yang { namespace yang {
/// @brief Between YANG and JSON translator class for basic values. /// @brief Between YANG and JSON translator class for basic values.
class TranslatorBasic { class Translator {
public: public:
/// @brief Constructor. /// @brief Constructor.
/// ///
/// @param session Sysrepo session. /// @param session Sysrepo session.
/// @param model Model name (used and shared by derived classes). /// @param model Model name (used and shared by derived classes).
TranslatorBasic(sysrepo::Session session, const std::string& model); Translator(sysrepo::Session session, const std::string& model);
/// @brief Destructor. /// @brief Destructor.
virtual ~TranslatorBasic() = default; virtual ~Translator() = default;
/// @brief Retrieves a child YANG data node identified by name from the /// @brief Retrieves a child YANG data node identified by name from the
/// given parent YANG container node and stores it in the specified storage. /// given parent YANG container node and stores it in the specified storage.
@@ -337,7 +337,7 @@ protected:
/// @brief The model. /// @brief The model.
std::string model_; std::string model_;
}; // TranslatorBasic }; // Translator
} // namespace yang } // namespace yang
} // namespace isc } // namespace isc

4
src/lib/yang/translator_class.cc
View File

@@ -20,7 +20,7 @@ namespace isc {
namespace yang { namespace yang {
TranslatorClass::TranslatorClass(Session session, const string& model) TranslatorClass::TranslatorClass(Session session, const string& model)
: TranslatorBasic(session, model), : Translator(session, model),
TranslatorOptionData(session, model), TranslatorOptionData(session, model),
TranslatorOptionDataList(session, model), TranslatorOptionDataList(session, model),
TranslatorOptionDef(session, model), TranslatorOptionDef(session, model),
@@ -142,7 +142,7 @@ TranslatorClass::setClassKea(string const& xpath, ConstElementPtr elem) {
} }
TranslatorClasses::TranslatorClasses(Session session, const string& model) TranslatorClasses::TranslatorClasses(Session session, const string& model)
: TranslatorBasic(session, model), : Translator(session, model),
TranslatorOptionData(session, model), TranslatorOptionData(session, model),
TranslatorOptionDataList(session, model), TranslatorOptionDataList(session, model),
TranslatorOptionDef(session, model), TranslatorOptionDef(session, model),

2
src/lib/yang/translator_config.cc
View File

@@ -21,7 +21,7 @@ namespace isc {
namespace yang { namespace yang {
TranslatorConfig::TranslatorConfig(Session session, const string& model) TranslatorConfig::TranslatorConfig(Session session, const string& model)
: TranslatorBasic(session, model), : Translator(session, model),
TranslatorControlSocket(session, model), TranslatorControlSocket(session, model),
TranslatorDatabase(session, model), TranslatorDatabase(session, model),
TranslatorDatabases(session, model), TranslatorDatabases(session, model),

2
src/lib/yang/translator_control_socket.cc
View File

@@ -21,7 +21,7 @@ namespace yang {
TranslatorControlSocket::TranslatorControlSocket(Session session, TranslatorControlSocket::TranslatorControlSocket(Session session,
const string& model) const string& model)
: TranslatorBasic(session, model) { : Translator(session, model) {
} }
ElementPtr ElementPtr

2
src/lib/yang/translator_control_socket.h
View File

@@ -65,7 +65,7 @@ namespace yang {
/// - kea-dhcp6-server /// - kea-dhcp6-server
/// - kea-dhcp-ddns /// - kea-dhcp-ddns
/// - kea-ctrl-agent /// - kea-ctrl-agent
class TranslatorControlSocket : virtual public TranslatorBasic { class TranslatorControlSocket : virtual public Translator {
public: public:
/// @brief Constructor. /// @brief Constructor.
/// ///

4
src/lib/yang/translator_database.cc
View File

@@ -20,7 +20,7 @@ namespace isc {
namespace yang { namespace yang {
TranslatorDatabase::TranslatorDatabase(Session session, const string& model) TranslatorDatabase::TranslatorDatabase(Session session, const string& model)
: TranslatorBasic(session, model) { : Translator(session, model) {
} }
ElementPtr ElementPtr
@@ -131,7 +131,7 @@ TranslatorDatabase::setDatabaseKea(string const& xpath,
TranslatorDatabases::TranslatorDatabases(Session session, TranslatorDatabases::TranslatorDatabases(Session session,
const string& model) const string& model)
: TranslatorBasic(session, model), : Translator(session, model),
TranslatorDatabase(session, model) { TranslatorDatabase(session, model) {
} }

2
src/lib/yang/translator_database.h
View File

@@ -101,7 +101,7 @@ namespace yang {
/// Supports the following models: /// Supports the following models:
/// - kea-dhcp4-server /// - kea-dhcp4-server
/// - kea-dhcp6-server /// - kea-dhcp6-server
class TranslatorDatabase : virtual public TranslatorBasic { class TranslatorDatabase : virtual public Translator {
public: public:
/// @brief Constructor. /// @brief Constructor.
/// ///

4
src/lib/yang/translator_host.cc
View File

@@ -20,7 +20,7 @@ namespace isc {
namespace yang { namespace yang {
TranslatorHost::TranslatorHost(Session session, const string& model) TranslatorHost::TranslatorHost(Session session, const string& model)
: TranslatorBasic(session, model), : Translator(session, model),
TranslatorOptionData(session, model), TranslatorOptionData(session, model),
TranslatorOptionDataList(session, model) { TranslatorOptionDataList(session, model) {
} }
@@ -128,7 +128,7 @@ TranslatorHost::setHostKea(string const& xpath, ConstElementPtr elem) {
} }
TranslatorHosts::TranslatorHosts(Session session, const string& model) TranslatorHosts::TranslatorHosts(Session session, const string& model)
: TranslatorBasic(session, model), : Translator(session, model),
TranslatorOptionData(session, model), TranslatorOptionData(session, model),
TranslatorOptionDataList(session, model), TranslatorOptionDataList(session, model),
TranslatorHost(session, model) { TranslatorHost(session, model) {

4
src/lib/yang/translator_logger.cc
View File

@@ -20,7 +20,7 @@ namespace isc {
namespace yang { namespace yang {
TranslatorLogger::TranslatorLogger(Session session, const string& model) TranslatorLogger::TranslatorLogger(Session session, const string& model)
: TranslatorBasic(session, model) { : Translator(session, model) {
} }
ElementPtr ElementPtr
@@ -139,7 +139,7 @@ TranslatorLogger::setOutputOptions(string const& xpath, ConstElementPtr elem) {
} }
TranslatorLoggers::TranslatorLoggers(Session session, const string& model) TranslatorLoggers::TranslatorLoggers(Session session, const string& model)
: TranslatorBasic(session, model), : Translator(session, model),
TranslatorLogger(session, model) { TranslatorLogger(session, model) {
} }

2
src/lib/yang/translator_logger.h
View File

@@ -90,7 +90,7 @@ namespace yang {
/// - kea-dhcp6-server /// - kea-dhcp6-server
/// - kea-dhcp-ddns /// - kea-dhcp-ddns
/// - kea-ctrl-agent /// - kea-ctrl-agent
class TranslatorLogger : virtual public TranslatorBasic { class TranslatorLogger : virtual public Translator {
public: public:
/// @brief Constructor. /// @brief Constructor.
/// ///

4
src/lib/yang/translator_option_data.cc
View File

@@ -21,7 +21,7 @@ namespace yang {
TranslatorOptionData::TranslatorOptionData(Session session, TranslatorOptionData::TranslatorOptionData(Session session,
const string& model) const string& model)
: TranslatorBasic(session, model) { : Translator(session, model) {
} }
ElementPtr ElementPtr
@@ -100,7 +100,7 @@ TranslatorOptionData::setOptionDataKea(string const& xpath,
TranslatorOptionDataList::TranslatorOptionDataList(Session session, TranslatorOptionDataList::TranslatorOptionDataList(Session session,
const string& model) const string& model)
: TranslatorBasic(session, model), : Translator(session, model),
TranslatorOptionData(session, model) { TranslatorOptionData(session, model) {
} }

2
src/lib/yang/translator_option_data.h
View File

@@ -72,7 +72,7 @@ namespace yang {
/// YANG and JSON. /// YANG and JSON.
/// ///
/// Currently supports on kea-dhcp[46]-server, not yet ietf-dhcpv6-server. /// Currently supports on kea-dhcp[46]-server, not yet ietf-dhcpv6-server.
class TranslatorOptionData : virtual public TranslatorBasic { class TranslatorOptionData : virtual public Translator {
public: public:
/// @brief Constructor. /// @brief Constructor.
/// ///

4
src/lib/yang/translator_option_def.cc
View File

@@ -21,7 +21,7 @@ namespace yang {
TranslatorOptionDef::TranslatorOptionDef(Session session, TranslatorOptionDef::TranslatorOptionDef(Session session,
const string& model) const string& model)
: TranslatorBasic(session, model) { : Translator(session, model) {
} }
ElementPtr ElementPtr
@@ -102,7 +102,7 @@ TranslatorOptionDef::setOptionDefKea(string const& xpath,
TranslatorOptionDefList::TranslatorOptionDefList(Session session, TranslatorOptionDefList::TranslatorOptionDefList(Session session,
const string& model) const string& model)
: TranslatorBasic(session, model), : Translator(session, model),
TranslatorOptionDef(session, model) { TranslatorOptionDef(session, model) {
} }

2
src/lib/yang/translator_option_def.h
View File

@@ -76,7 +76,7 @@ namespace yang {
/// ///
/// Currently supports kea-dhcp[46]-server models. /// Currently supports kea-dhcp[46]-server models.
/// @todo: Support for ietf-dhcpv6-server model. /// @todo: Support for ietf-dhcpv6-server model.
class TranslatorOptionDef : virtual public TranslatorBasic { class TranslatorOptionDef : virtual public Translator {
public: public:
/// @brief Constructor. /// @brief Constructor.
/// ///

4
src/lib/yang/translator_pd_pool.cc
View File

@@ -22,7 +22,7 @@ namespace isc {
namespace yang { namespace yang {
TranslatorPdPool::TranslatorPdPool(Session session, const string& model) TranslatorPdPool::TranslatorPdPool(Session session, const string& model)
: TranslatorBasic(session, model), : Translator(session, model),
TranslatorOptionData(session, model), TranslatorOptionData(session, model),
TranslatorOptionDataList(session, model) { TranslatorOptionDataList(session, model) {
} }
@@ -234,7 +234,7 @@ TranslatorPdPool::setPdPoolKea(string const& xpath, ConstElementPtr elem) {
} }
TranslatorPdPools::TranslatorPdPools(Session session, const string& model) TranslatorPdPools::TranslatorPdPools(Session session, const string& model)
: TranslatorBasic(session, model), : Translator(session, model),
TranslatorOptionData(session, model), TranslatorOptionData(session, model),
TranslatorOptionDataList(session, model), TranslatorOptionDataList(session, model),
TranslatorPdPool(session, model) { TranslatorPdPool(session, model) {

4
src/lib/yang/translator_pool.cc
View File

@@ -25,7 +25,7 @@ namespace isc {
namespace yang { namespace yang {
TranslatorPool::TranslatorPool(Session session, const string& model) TranslatorPool::TranslatorPool(Session session, const string& model)
: TranslatorBasic(session, model), : Translator(session, model),
TranslatorOptionData(session, model), TranslatorOptionData(session, model),
TranslatorOptionDataList(session, model) { TranslatorOptionDataList(session, model) {
} }
@@ -225,7 +225,7 @@ TranslatorPool::getAddresses(const string& prefix,
} }
TranslatorPools::TranslatorPools(Session session, const string& model) TranslatorPools::TranslatorPools(Session session, const string& model)
: TranslatorBasic(session, model), : Translator(session, model),
TranslatorOptionData(session, model), TranslatorOptionData(session, model),
TranslatorOptionDataList(session, model), TranslatorOptionDataList(session, model),
TranslatorPool(session, model) { TranslatorPool(session, model) {

4
src/lib/yang/translator_shared_network.cc
View File

@@ -21,7 +21,7 @@ namespace yang {
TranslatorSharedNetwork::TranslatorSharedNetwork(Session session, TranslatorSharedNetwork::TranslatorSharedNetwork(Session session,
const string& model) const string& model)
: TranslatorBasic(session, model), : Translator(session, model),
TranslatorOptionData(session, model), TranslatorOptionData(session, model),
TranslatorOptionDataList(session, model), TranslatorOptionDataList(session, model),
TranslatorPool(session, model), TranslatorPool(session, model),
@@ -232,7 +232,7 @@ TranslatorSharedNetwork::setSharedNetworkKea(string const& xpath,
TranslatorSharedNetworks::TranslatorSharedNetworks(Session session, TranslatorSharedNetworks::TranslatorSharedNetworks(Session session,
const string& model) const string& model)
: TranslatorBasic(session, model), : Translator(session, model),
TranslatorOptionData(session, model), TranslatorOptionData(session, model),
TranslatorOptionDataList(session, model), TranslatorOptionDataList(session, model),
TranslatorPool(session, model), TranslatorPool(session, model),

4
src/lib/yang/translator_subnet.cc
View File

@@ -21,7 +21,7 @@ namespace isc {
namespace yang { namespace yang {
TranslatorSubnet::TranslatorSubnet(Session session, const string& model) TranslatorSubnet::TranslatorSubnet(Session session, const string& model)
: TranslatorBasic(session, model), : Translator(session, model),
TranslatorOptionData(session, model), TranslatorOptionData(session, model),
TranslatorOptionDataList(session, model), TranslatorOptionDataList(session, model),
TranslatorPool(session, model), TranslatorPool(session, model),
@@ -333,7 +333,7 @@ TranslatorSubnet::setSubnetKea(string const& xpath, ConstElementPtr elem) {
} }
TranslatorSubnets::TranslatorSubnets(Session session, const string& model) TranslatorSubnets::TranslatorSubnets(Session session, const string& model)
: TranslatorBasic(session, model), : Translator(session, model),
TranslatorOptionData(session, model), TranslatorOptionData(session, model),
TranslatorOptionDataList(session, model), TranslatorOptionDataList(session, model),
TranslatorPool(session, model), TranslatorPool(session, model),

28
src/lib/yang/yang.dox
View File

@@ -16,7 +16,7 @@ data between YANG and JSON that is understandable by Kea.
An essential concept is the idea of translator. It is a primitive that is able An essential concept is the idea of translator. It is a primitive that is able
to convert certain data structure between YANG and JSON. It is envisaged to convert certain data structure between YANG and JSON. It is envisaged
that more complex translators will use other translators to handle more that more complex translators will use other translators to handle more
complex data structures. For details, see @ref isc::yang::TranslatorBasic. complex data structures. For details, see @ref isc::yang::Translator.
It is also envisioned that translators could do the translation automatically by It is also envisioned that translators could do the translation automatically by
relying on capabilities of iterating through data, retrieving data type relying on capabilities of iterating through data, retrieving data type
information and value information from nodes through the libyang and sysrepo information and value information from nodes through the libyang and sysrepo
@@ -43,24 +43,24 @@ All translators take a Session pointer (a structure provided by Sysrepo that
is responsible for maintaining a connection) in constructors and derive from is responsible for maintaining a connection) in constructors and derive from
the basic / base class and recursively from translators for embedded parts. the basic / base class and recursively from translators for embedded parts.
@c isc::yang::TranslatorBasic provides some methods: @c isc::yang::Translator provides some methods:
- @c isc::yang::TranslatorBasic::checkAndGetLeaf() is a convenience wrapper - @c isc::yang::Translator::checkAndGetLeaf() is a convenience wrapper
over @c isc::yang::TranslatorBasic::getItem(). over @c isc::yang::Translator::getItem().
- @c isc::yang::TranslatorBasic::checkAndSetLeaf() is a convenience wrapper - @c isc::yang::Translator::checkAndSetLeaf() is a convenience wrapper
over @c isc::yang::TranslatorBasic::setItem(). over @c isc::yang::Translator::setItem().
- @c isc::yang::TranslatorBasic::deleteItem() deletes the data node found at - @c isc::yang::Translator::deleteItem() deletes the data node found at
given xpth. given xpth.
- @c isc::yang::TranslatorBasic::forAll() iterates over the node found at - @c isc::yang::Translator::forAll() iterates over the node found at
given xpath and all its descendants and calls the given function. given xpath and all its descendants and calls the given function.
- @c isc::yang::TranslatorBasic::getItem() retrieves and translates a leaf - @c isc::yang::Translator::getItem() retrieves and translates a leaf
from YANG to JSON. from YANG to JSON.
- @c isc::yang::TranslatorBasic::getList() retrieves a list from Sysrepo and - @c isc::yang::Translator::getList() retrieves a list from Sysrepo and
translates it form YANG to JSON. translates it form YANG to JSON.
- @c isc::yang::TranslatorBasic::setItem() translates a leaf from JSON to - @c isc::yang::Translator::setItem() translates a leaf from JSON to
YANG and sets it in Sysrepo. YANG and sets it in Sysrepo.
- @c isc::yang::TranslatorBasic::translateFromYang(optional<DataNode>, string) translates a YANG - @c isc::yang::Translator::translateFromYang(optional<DataNode>, string) translates a YANG
leaf to a JSON node. leaf to a JSON node.
- @c isc::yang::TranslatorBasic::translateToYang(ConstElementPtr, LeafBaseType) - @c isc::yang::Translator::translateToYang(ConstElementPtr, LeafBaseType)
translates a JSON leaf to a string. translates a JSON leaf to a string.
@section yangTranslatorPool Pool translator @section yangTranslatorPool Pool translator
@@ -78,7 +78,7 @@ Note pools show two shortcomings in IETF modules:
- prefix and start - end forms of pool ranges are both mandatory. - prefix and start - end forms of pool ranges are both mandatory.
(reported to authors' so should be fixed in the next version). (reported to authors' so should be fixed in the next version).
All structure translators depend on @c isc::yang::TranslatorBasic and All structure translators depend on @c isc::yang::Translator and
some of them depend on other structures, for instance some of them depend on other structures, for instance
@c isc::yang::TranslatorPool depends on @c isc::yang::TranslatorPool depends on
@c isc::yang::TranslatorOptionDataList which itself, as all list translators, @c isc::yang::TranslatorOptionDataList which itself, as all list translators,