tools, northbound: improve reserved keyword handling in code generation

Use an external crate to handle all possible reserved keywords (including "as", present in the BGP YANG model). Signed-off-by: Renato Westphal <[email protected]>
holo-routing · Nov 20, 2023 · 0431911 · 0431911
1 parent 609f4c7
commit 0431911
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 7 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -30,6 +30,7 @@ async-trait = "0.1"
 bitflags = { version = "2.4", features = ["serde"] }
 bytes = { version = "1", features = ["serde"] }
 capctl = "0.2"
+check_keyword = "0.2"
 clap = "2.33"
 chrono = { version = "0.4", features = ["serde"] }
 criterion = "0.4"

diff --git a/holo-northbound/Cargo.toml b/holo-northbound/Cargo.toml
@@ -24,5 +24,6 @@ holo-yang = { path = "../holo-yang" }
 holo-utils = { path = "../holo-utils" }
 
 [build-dependencies]
+check_keyword.workspace = true
 yang2.workspace = true
 holo-yang = { path = "../holo-yang" }
diff --git a/holo-northbound/build.rs b/holo-northbound/build.rs
@@ -8,6 +8,7 @@ use std::env;
 use std::fmt::Write;
 use std::path::PathBuf;
 
+use check_keyword::CheckKeyword;
 use holo_yang as yang;
 use holo_yang::YANG_IMPLEMENTED_MODULES;
 use yang2::schema::{DataValue, SchemaNode, SchemaNodeKind, SchemaPathFormat};
@@ -19,9 +20,7 @@ fn snode_normalized_name(snode: &SchemaNode<'_>) -> String {
     name = str::replace(&name, "-", "_");
 
     // Handle Rust reserved keywords.
-    if name == "type" {
-        name = "r#type".to_owned();
-    }
+    name = name.into_safe();
 
     // HACK: distinguish nodes with the same names but different namespaces.
     if matches!(

diff --git a/holo-tools/Cargo.toml b/holo-tools/Cargo.toml
@@ -6,6 +6,7 @@ license.workspace = true
 edition.workspace = true
 
 [dependencies]
+check_keyword.workspace = true
 clap.workspace = true
 num-traits.workspace = true
 serde_json.workspace = true

diff --git a/holo-tools/src/yang_callbacks.rs b/holo-tools/src/yang_callbacks.rs
@@ -6,6 +6,7 @@
 
 use std::fmt::Write;
 
+use check_keyword::CheckKeyword;
 use clap::{App, Arg};
 use holo_northbound::CallbackOp;
 use holo_yang as yang;
@@ -23,10 +24,7 @@ fn snode_module_path(snode: &SchemaNode<'_>) -> String {
             // Replace hyphens by underscores.
             name = str::replace(&name, "-", "_");
             // Handle Rust reserved keywords.
-            if name == "type" {
-                name = "r#type".to_owned();
-            }
-            name
+            name.into_safe()
         })
         .collect::<Vec<String>>()
         .join("::");