Allow DeleteNode on root element if it is settable/error out otherwise (

#904) * Allow DeleteNode on root element if it is settable/error out otherwise * Copying Daniel's code from https://github.com/openconfig/ygot/pull/649/files
openconfig · Aug 1, 2023 · df0faa5 · df0faa5
1 parent e0445ce
commit df0faa5
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 0 deletions.
diff --git a/ytypes/node.go b/ytypes/node.go
@@ -106,6 +106,16 @@ func retrieveNode(schema *yang.Entry, root interface{}, path, traversedPath *gpb
 				return nil, status.Errorf(codes.Unknown, "path %v points to a node with non-leaf schema %v", traversedPath, schema)
 			}
 		}
+		if args.delete {
+			if util.IsValueNil(root) {
+				return nil, nil
+			}
+			if rt, rv := reflect.TypeOf(root), reflect.ValueOf(root); rt.Kind() == reflect.Pointer && rv.Elem().CanSet() {
+				rv.Elem().Set(reflect.Zero(rv.Elem().Type()))
+			} else {
+				return nil, fmt.Errorf("cannot delete on unsettable element: (%T, %v)", root, root)
+			}
+		}
 		return []*TreeNode{{
 			Path:   traversedPath,
 			Schema: schema,

diff --git a/ytypes/node_test.go b/ytypes/node_test.go
@@ -2740,6 +2740,29 @@ func TestDeleteNode(t *testing.T) {
 		inRoot:   &ListElemStruct1{Key1: ygot.String("hello"), Outer: &OuterContainerType1{Inner: &InnerContainerType1{Int32LeafListName: []int32{42, 43, 44}, Int32LeafName: ygot.Int32(5)}}},
 		inPath:   mustPath("/outer"),
 		want:     &ListElemStruct1{Key1: ygot.String("hello")},
+	}, {
+		name:     "deleting on root struct element",
+		inSchema: simpleSchema(),
+		inRoot:   &ListElemStruct1{Key1: ygot.String("hello"), Outer: &OuterContainerType1{Inner: &InnerContainerType1{Int32LeafListName: []int32{42, 43, 44}, Int32LeafName: ygot.Int32(5)}}},
+		inPath:   mustPath("/"),
+		want:     &ListElemStruct1{},
+	}, {
+		name:     "deleting on nil root struct element",
+		inSchema: simpleSchema(),
+		inRoot:   (*ListElemStruct1)(nil),
+		inPath:   mustPath("/"),
+		want:     (*ListElemStruct1)(nil),
+	}, {
+		name:             "deleting on non-deletable element",
+		inRoot:           42,
+		inPath:           mustPath("/"),
+		wantErrSubstring: "cannot delete on unsettable element",
+	}, {
+		name:     "deleting on root leaf element",
+		inSchema: simpleSchema(),
+		inRoot:   &ListElemStruct1{Key1: ygot.String("hello"), Outer: &OuterContainerType1{Inner: &InnerContainerType1{Int32LeafListName: []int32{42, 43, 44}, Int32LeafName: ygot.Int32(5)}}},
+		inPath:   mustPath("/"),
+		want:     &ListElemStruct1{},
 	}, {
 		name:     "deleting int32 leaf in inner node",
 		inSchema: simpleSchema(),