Add Fakeroot to NodeDataMap return value for ypathgen's GeneratePathC…

…ode. (#550) This helps the consuming code process the fake root as well.
openconfig · Jun 28, 2021 · 5ba0876 · 5ba0876
1 parent 926dd30
commit 5ba0876
Show file tree

Hide file tree

Showing 2 changed files with 63 additions and 6 deletions.
diff --git a/ypathgen/pathgen.go b/ypathgen/pathgen.go
@@ -256,6 +256,12 @@ func (cg *GenConfig) GeneratePathCode(yangFiles, includePaths []string) (*Genera
 		schemaStructPkgAccessor = schemaStructPkgAlias + "."
 	}
 
+	// Get NodeDataMap for the schema.
+	nodeDataMap, es := getNodeDataMap(directories, leafTypeMap, schemaStructPkgAccessor, cg.PathStructSuffix)
+	if es != nil {
+		errs = util.AppendErrs(errs, es)
+	}
+
 	// Generate struct code.
 	var structSnippets []GoPathStructCodeSnippet
 	for _, directoryName := range orderedDirNames {
@@ -265,6 +271,21 @@ func (cg *GenConfig) GeneratePathCode(yangFiles, includePaths []string) (*Genera
 				util.NewErrs(fmt.Errorf("GeneratePathCode: Implementation bug -- node %s not found in dirNameMap", directoryName)))
 		}
 
+		if ygen.IsFakeRoot(directory.Entry) {
+			// Since we always generate the fake root, we add the
+			// fake root GoStruct to the data map as well.
+			nodeDataMap[directory.Name+cg.PathStructSuffix] = &NodeData{
+				GoTypeName:            "*" + schemaStructPkgAccessor + yang.CamelCase(cg.FakeRootName),
+				LocalGoTypeName:       "*" + yang.CamelCase(cg.FakeRootName),
+				GoFieldName:           "",
+				SubsumingGoStructName: yang.CamelCase(cg.FakeRootName),
+				IsLeaf:                false,
+				IsScalarField:         false,
+				YANGTypeName:          "",
+				YANGPath:              "/",
+			}
+		}
+
 		var listBuilderKeyThreshold uint
 		if cg.GenerateWildcardPaths {
 			listBuilderKeyThreshold = cg.ListBuilderKeyThreshold
@@ -277,12 +298,6 @@ func (cg *GenConfig) GeneratePathCode(yangFiles, includePaths []string) (*Genera
 	}
 	genCode.Structs = structSnippets
 
-	// Get NodeDataMap for the schema.
-	nodeDataMap, es := getNodeDataMap(directories, leafTypeMap, schemaStructPkgAccessor, cg.PathStructSuffix)
-	if es != nil {
-		errs = util.AppendErrs(errs, es)
-	}
-
 	if len(errs) == 0 {
 		errs = nil
 	}

diff --git a/ypathgen/pathgen_test.go b/ypathgen/pathgen_test.go
@@ -81,6 +81,12 @@ func TestGeneratePathCode(t *testing.T) {
 		inPathStructSuffix:       "Path",
 		checkYANGPath:            true,
 		wantNodeDataMap: NodeDataMap{
+			"DevicePath": {
+				GoTypeName:            "*Device",
+				LocalGoTypeName:       "*Device",
+				SubsumingGoStructName: "Device",
+				YANGPath:              "/",
+			},
 			"ParentPath": {
 				GoTypeName:            "*Parent",
 				LocalGoTypeName:       "*Parent",
@@ -168,6 +174,12 @@ func TestGeneratePathCode(t *testing.T) {
 		inSchemaStructPkgPath:                  "",
 		inPathStructSuffix:                     "Path",
 		wantNodeDataMap: NodeDataMap{
+			"DevicePath": {
+				GoTypeName:            "*Device",
+				LocalGoTypeName:       "*Device",
+				SubsumingGoStructName: "Device",
+				YANGPath:              "/",
+			},
 			"ParentPath": {
 				GoTypeName:            "*Parent",
 				LocalGoTypeName:       "*Parent",
@@ -248,6 +260,12 @@ func TestGeneratePathCode(t *testing.T) {
 		inSchemaStructPkgPath:                  "",
 		inPathStructSuffix:                     "Path",
 		wantNodeDataMap: NodeDataMap{
+			"DevicePath": {
+				GoTypeName:            "*Device",
+				LocalGoTypeName:       "*Device",
+				SubsumingGoStructName: "Device",
+				YANGPath:              "/",
+			},
 			"ParentPath": {
 				GoTypeName:            "*Parent",
 				LocalGoTypeName:       "*Parent",
@@ -371,6 +389,12 @@ func TestGeneratePathCode(t *testing.T) {
 		inPathStructSuffix:                     "Path",
 		wantStructsCodeFile:                    filepath.Join(TestRoot, "testdata/structs/openconfig-unione.path-txt"),
 		wantNodeDataMap: NodeDataMap{
+			"DevicePath": {
+				GoTypeName:            "*Device",
+				LocalGoTypeName:       "*Device",
+				SubsumingGoStructName: "Device",
+				YANGPath:              "/",
+			},
 			"DupEnumPath": {
 				GoTypeName:            "*DupEnum",
 				LocalGoTypeName:       "*DupEnum",
@@ -467,6 +491,12 @@ func TestGeneratePathCode(t *testing.T) {
 		inPathStructSuffix:       "Path",
 		wantStructsCodeFile:      filepath.Join(TestRoot, "testdata/structs/openconfig-unione.path-txt"),
 		wantNodeDataMap: NodeDataMap{
+			"DevicePath": {
+				GoTypeName:            "*Device",
+				LocalGoTypeName:       "*Device",
+				SubsumingGoStructName: "Device",
+				YANGPath:              "/",
+			},
 			"DupEnumPath": {
 				GoTypeName:            "*DupEnum",
 				LocalGoTypeName:       "*DupEnum",
@@ -565,6 +595,12 @@ func TestGeneratePathCode(t *testing.T) {
 		inPathStructSuffix:                     "Path",
 		wantStructsCodeFile:                    filepath.Join(TestRoot, "testdata/structs/enum-module.path-txt"),
 		wantNodeDataMap: NodeDataMap{
+			"DevicePath": {
+				GoTypeName:            "*Device",
+				LocalGoTypeName:       "*Device",
+				SubsumingGoStructName: "Device",
+				YANGPath:              "/",
+			},
 			"AListPath": {
 				GoTypeName:            "*AList",
 				LocalGoTypeName:       "*AList",
@@ -692,6 +728,12 @@ func TestGeneratePathCode(t *testing.T) {
 		inPathStructSuffix:                     "",
 		wantStructsCodeFile:                    filepath.Join(TestRoot, "testdata/structs/openconfig-augmented.path-txt"),
 		wantNodeDataMap: NodeDataMap{
+			"Device": {
+				GoTypeName:            "*oc.Device",
+				LocalGoTypeName:       "*Device",
+				SubsumingGoStructName: "Device",
+				YANGPath:              "/",
+			},
 			"Native": {
 				GoTypeName:            "*oc.Native",
 				LocalGoTypeName:       "*Native",