Skip to content

Avoid create operation on NP containers #162

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Avoid create operation on NP containers #162

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
add7ec1
Avoid create operation on NP containers
May 2, 2025
50f0531
Prevent default in use gets "create" operation
May 7, 2025
ab52be8
Avoid "delete" operation on NP containers
May 22, 2025
4e2a0c7
Resolved confilct with main
May 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
97 changes: 91 additions & 6 deletions ncdiff/src/yang/ncdiff/netconf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -352,7 +352,6 @@ def get_config_replace(self, node_self, node_other):

for child_other in in_o_not_in_s:
child_self = etree.Element(child_other.tag,
{operation_tag: self.preferred_delete},
nsmap=child_other.nsmap)
siblings = list(node_self.iterchildren(tag=child_other.tag))
if siblings:
Expand All @@ -361,14 +360,24 @@ def get_config_replace(self, node_self, node_other):
node_self.append(child_self)
s_node = self.device.get_schema_node(child_other)
if s_node.get('type') == 'leaf-list':
child_self.set(operation_tag, self.preferred_delete)
self._merge_text(child_other, child_self)
elif s_node.get('type') == 'list':
child_self.set(operation_tag, self.preferred_delete)
keys = self._get_list_keys(s_node)
for key in keys:
key_node = child_other.find(key)
e = etree.SubElement(
child_self, key, nsmap=key_node.nsmap)
e.text = key_node.text
elif (
s_node.get('type') == 'container' and
s_node.get('presence') != 'true' and
self.preferred_delete == 'delete'
):
self.set_delete_operation(child_self, child_other)
else:
child_self.set(operation_tag, self.preferred_delete)

for child_self, child_other in in_s_and_in_o:
child_self.set(operation_tag, 'replace')
Expand Down Expand Up @@ -1066,7 +1075,6 @@ def node_sub(self, node_self, node_other, depth=0):
choice_nodes = {}
for child_self in in_s_not_in_o:
child_other = etree.Element(child_self.tag,
{operation_tag: self.preferred_delete},
nsmap=child_self.nsmap)
if self.diff_type == 'replace':
child_self.set(operation_tag, 'replace')
Expand All @@ -1084,8 +1092,10 @@ def node_sub(self, node_self, node_other, depth=0):
if s_node.get('ordered-by') == 'user' and \
s_node.tag not in ordered_by_user:
ordered_by_user[s_node.tag] = 'leaf-list'
child_other.set(operation_tag, self.preferred_delete)
self._merge_text(child_self, child_other)
elif s_node.get('type') == 'list':
child_other.set(operation_tag, self.preferred_delete)
keys = self._get_list_keys(s_node)
if s_node.get('ordered-by') == 'user' and \
s_node.tag not in ordered_by_user:
Expand All @@ -1095,12 +1105,19 @@ def node_sub(self, node_self, node_other, depth=0):
e = etree.SubElement(
child_other, key, nsmap=key_node.nsmap)
e.text = key_node.text
elif (
s_node.get('type') == 'container' and
s_node.get('presence') != 'true' and
self.preferred_delete == 'delete'
):
self.set_delete_operation(child_other, child_self)
else:
child_other.set(operation_tag, self.preferred_delete)
if s_node.getparent().get('type') == 'case':
# key: choice node, value: case node
choice_nodes[s_node.getparent().getparent()] = s_node.getparent()
for child_other in in_o_not_in_s:
child_self = etree.Element(child_other.tag,
{operation_tag: self.preferred_delete},
nsmap=child_other.nsmap)
if self.preferred_create == 'replace':
child_other.set(operation_tag, self.preferred_create)
Expand All @@ -1126,8 +1143,10 @@ def node_sub(self, node_self, node_other, depth=0):
if s_node.get('ordered-by') == 'user' and \
s_node.tag not in ordered_by_user:
ordered_by_user[s_node.tag] = 'leaf-list'
child_self.set(operation_tag, self.preferred_delete)
self._merge_text(child_other, child_self)
elif s_node.get('type') == 'list':
child_self.set(operation_tag, self.preferred_delete)
keys = self._get_list_keys(s_node)
if s_node.get('ordered-by') == 'user' and \
s_node.tag not in ordered_by_user:
Expand All @@ -1136,6 +1155,14 @@ def node_sub(self, node_self, node_other, depth=0):
key_node = child_other.find(key)
e = etree.SubElement(child_self, key, nsmap=key_node.nsmap)
e.text = key_node.text
elif (
s_node.get('type') == 'container' and
s_node.get('presence') != 'true' and
self.preferred_delete == 'delete'
):
self.set_delete_operation(child_self, child_other)
else:
child_self.set(operation_tag, self.preferred_delete)
for child_self, child_other in in_s_and_in_o:
s_node = self.device.get_schema_node(child_self)
if s_node.get('type') == 'leaf':
Expand Down Expand Up @@ -1246,16 +1273,74 @@ def set_create_operation(self, node):
'''

schema_node = self.device.get_schema_node(node)

# Create operation on non-presence containers is not allowed as per
# ConfD implementation although the expected behavior is ambiguous in
# RFC7950. More discussion can be found in the Tail-F ticket PS-47089.
if (
schema_node.get('type') == 'container' and
schema_node.get('presence') != 'true' and
len(self.device.default_in_use(schema_node)) > 0
schema_node.get('presence') != 'true'
):
default_xpaths = [self.device.get_xpath(n)
for n in self.device.default_in_use(schema_node)]
for child in node:
self.set_create_operation(child)
child_xpath = self.device.get_xpath(
self.device.get_schema_node(child))
if child_xpath not in default_xpaths:
self.set_create_operation(child)
else:
node.set(operation_tag, 'create')

def set_delete_operation(self, node, reference_node):
'''set_delete_operation
Low-level api: Set the `operation` attribute of a node to `delete` when
it is not already set. This method is used when the preferred_delete is
`delete`.
Parameters
----------
node : `Element`
A config node in a config tree. `delete` operation will be set on
descendants of this node.
reference_node : `Element`
A config node in a config tree as a reference when building the
input parameter `node`. This node has descendants that `node` does
not have.
Returns
-------
None
There is no return of this method.
'''

# Delete operation on non-presence containers is allowed even there is
# nothing inside the non-presence container as per ConfD implementation
# although the expected behavior is ambiguous in RFC7950. More
# discussion can be found in the Tail-F ticket PS-47089. In negative
# testing case, if we want the delete operation to be rejected when
# there is nothing inside the non-presence container, we have to put
# delete operations on the descendants of the non-presence container,
# which are not non-presence containers.
for reference_child in reference_node:
child = etree.SubElement(node, reference_child.tag,
nsmap=reference_child.nsmap)
schema_node = self.device.get_schema_node(reference_child)
if schema_node.get('type') == 'leaf-list':
child.set(operation_tag, 'delete')
self._merge_text(reference_child, child)
elif schema_node.get('type') == 'list':
child.set(operation_tag, 'delete')
keys = self._get_list_keys(schema_node)
for key in keys:
key_node = reference_child.find(key)
e = etree.SubElement(child, key, nsmap=key_node.nsmap)
e.text = key_node.text
elif (
schema_node.get('type') == 'container' and
schema_node.get('presence') != 'true'
):
self.set_delete_operation(child, reference_child)
else:
child.set(operation_tag, 'delete')

@staticmethod
def _url_to_prefix(node, id):
'''_url_to_prefix
Expand Down
2 changes: 2 additions & 0 deletions ncdiff/src/yang/ncdiff/runningconfig.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,7 @@
(re.compile(r'^ *ospfv3 neighbor '), 1),
(re.compile(r'^ *ospfv3 \d+ ipv(\d) neighbor'), 1),
(re.compile(r'^ *ospfv3 \d+ neighbor '), 1),
(re.compile(r'^ *member vni '), 1),
(re.compile(r'^ *ipv6 route '), 0),
(re.compile(r'^ *ip route '), 0),
]
Expand Down Expand Up @@ -181,6 +182,7 @@
('exit-address-family', ' exit-address-family'),
]


class ListDiff(object):
'''ListDiff

Expand Down
Loading