Fix find_children_w_parents to include only real descendants

changes/836.fixed.md

@@ -0,0 +1 @@
+Fixed `find_children_w_parents` to only return the matched child line and its actual descendants, instead of every sibling line under the same top-level parent.

netutils/config/parser.py

@@ -416,20 +416,18 @@ def find_children_w_parents(
             >>> print(bgp_conf)
             ['  address-family ipv4 unicast', '   neighbor 192.168.1.2 activate', '   network 172.17.1.0 mask']
         """
-        config = []
-        potential_parents = [
-            elem.parents[0]
-            for elem in self.build_config_relationship()
+        relationships = self.build_config_relationship()
+        matched_lines = {
+            elem.config_line
+            for elem in relationships
             if self._match_type_check(elem.config_line, child_pattern, match_type)
-        ]
-        for cfg_line in self.build_config_relationship():
-            parents = cfg_line.parents[0] if cfg_line.parents else None
-            if parents in potential_parents and self._match_type_check(
-                parents,  # type: ignore[arg-type]
-                parent_pattern,
-                match_type,
-            ):
-                config.append(cfg_line.config_line)
+            and elem.parents
+            and self._match_type_check(elem.parents[0], parent_pattern, match_type)
+        }
+        config = []
+        for elem in relationships:
+            if elem.config_line in matched_lines or any(parent in matched_lines for parent in elem.parents):
+                config.append(elem.config_line)
         return config
 
 

tests/unit/mock/config/parser/find_children_w_parents/cisco_ios/flat_siblings_args.json

@@ -0,0 +1,5 @@
+{
+    "parent_pattern": "context local",
+    "child_pattern": " logging",
+    "match_type": "regex"
+}

tests/unit/mock/config/parser/find_children_w_parents/cisco_ios/flat_siblings_received.txt

@@ -0,0 +1,2 @@
+ logging something
+ logging something else

tests/unit/mock/config/parser/find_children_w_parents/cisco_ios/flat_siblings_sent.txt

@@ -0,0 +1,5 @@
+context local
+ something not logging
+ logging something
+ logging something else
+ something else not logging

tests/unit/mock/config/parser/find_children_w_parents/cisco_ios/ios_full_received.txt

@@ -1,4 +1,3 @@
- contact-email-addr sch-smart-licensing@cisco.com
  profile "CiscoTAC-1"
   active
   destination transport-method http