Fix: make "bgp._session_clear" VRF-aware (#2630)

Fixes #2619
---------
Co-authored-by: Ivan Pepelnjak <ip@ipspace.net>

Author: michelredondo

netsim/extra/bgp.policy/plugin.py

@@ -160,8 +160,12 @@ def apply_config(node: Box, ngb: Box) -> None:
   global _config_name
   api.node_config(node,_config_name)                    # Remember that we have to do extra configuration
   for af in ('ipv4','ipv6'):                            # ... and add sessions that have to be cleared
-    if af in ngb:
+    if af in ngb and '_src_vrf' not in ngb:
       data.append_to_list(node.bgp,'_session_clear',ngb[af])
+    elif af in ngb and '_src_vrf' in ngb:
+      for vname,vdata in node.vrfs.items():
+        if vname == ngb['_src_vrf']:
+          data.append_to_list(node.vrfs[vname].bgp,'_session_clear',ngb[af])
 
 '''
 Apply attributes supported by bgp.policy plugin to a single neighbor

netsim/extra/bgp.session/arubacx.j2

@@ -71,6 +71,7 @@ router bgp {{ bgp.as }}
 {% endfor %}
 {% endif %}
 !
-{% for ngb in bgp._session_clear|default([]) %}
-do clear bgp {{ ngb }}
+do clear bgp *
+{% for vname,vdata in (vrfs|default({})).items() if vdata.bgp is defined %}
+do clear bgp vrf {{vname}} *
 {% endfor %}

netsim/extra/bgp.session/plugin.py

@@ -35,8 +35,12 @@ def mark_plugin_config(node: Box, ngb: Box) -> None:
 
   api.node_config(node,_config_name)                  # Remember that we have to do extra configuration
   for af in ('ipv4','ipv6'):                          # ... and add sessions that have to be cleared
-    if af in ngb:
+    if af in ngb and '_src_vrf' not in ngb:
       data.append_to_list(node.bgp,'_session_clear',ngb[af])
+    elif af in ngb and '_src_vrf' in ngb:
+      for vname,vdata in node.vrfs.items():
+        if vname == ngb['_src_vrf']:
+          data.append_to_list(node.vrfs[vname].bgp,'_session_clear',ngb[af])
 
 '''
 Apply attributes supported by bgp.session plugin to a single neighbor

netsim/extra/bgp.session/srlinux.j2

@@ -78,6 +78,15 @@
 updates:
 {% for addr in bgp._session_clear|default([]) %}
 {{   bgp_admin_state(addr,'default','disable') }}
+
+{% if vrfs is defined %}
+{% for vname,vdata in vrfs.items() if vdata.bgp is defined %}
+{%   for addr in vdata.bgp._session_clear|default([]) %}
+{{     bgp_admin_state(addr,vname,'disable') }}
+{%   endfor %}
+{% endfor %}
+{% endif %}
+
 {% endfor %}
 {% for af in ['ipv4','ipv6'] %}
 {%   for n in bgp.neighbors if n[af] is defined and (n[af] is string or (af=='ipv6' and n.ipv6)) %}
@@ -98,3 +107,11 @@ updates:
 {% for addr in bgp._session_clear|default([]) %}
 {{   bgp_admin_state(addr,'default','enable') }}
 {% endfor %}
+
+{% if vrfs is defined %}
+{% for vname,vdata in vrfs.items() if vdata.bgp is defined %}
+{%   for addr in vdata.bgp._session_clear|default([]) %}
+{{     bgp_admin_state(addr,vname,'enable') }}
+{%   endfor %}
+{% endfor %}
+{% endif %}

tests/topology/expected/ebgp.utils.yml

@@ -143,7 +143,6 @@ nodes:
       - 10.0.0.4
       - 10.1.0.2
       - 10.1.0.6
-      - 10.1.0.14
       advertise_loopback: true
       as: 65001
       community:
@@ -297,6 +296,8 @@ nodes:
         af:
           ipv4: true
         bgp:
+          _session_clear:
+          - 10.1.0.14
           import:
             connected:
               auto: true
@@ -333,7 +334,6 @@ nodes:
       - link-bandwidth
       _session_clear:
       - 10.1.0.1
-      - 10.1.0.13
       - 10.0.0.3
       advertise_loopback: true
       as: 65002
@@ -448,6 +448,8 @@ nodes:
         af:
           ipv4: true
         bgp:
+          _session_clear:
+          - 10.1.0.13
           import:
             connected:
               auto: true