T7731: Static ARP entries are missing after an interface status change

Author: natali-rs1985

data/config-mode-dependencies/vyos-1x.json

@@ -8,11 +8,40 @@
         "group_resync": ["system_conntrack", "nat", "policy_route", "load-balancing_wan"]
     },
     "interfaces_bonding": {
-        "ethernet": ["interfaces_ethernet"]
+        "ethernet": ["interfaces_ethernet"],
+        "static_arp": ["protocols_static_arp"]
     },
     "interfaces_bridge": {
         "vxlan": ["interfaces_vxlan"],
-        "wlan": ["interfaces_wireless"]
+        "wlan": ["interfaces_wireless"],
+        "static_arp": ["protocols_static_arp"]
+    },
+    "interfaces_ethernet": {
+        "static_arp": ["protocols_static_arp"]
+    },
+    "interfaces_geneve": {
+        "static_arp": ["protocols_static_arp"]
+    },
+    "interfaces_l2tpv3": {
+        "static_arp": ["protocols_static_arp"]
+    },
+    "interfaces_macsec": {
+        "static_arp": ["protocols_static_arp"]
+    },
+    "interfaces_pseudo_ethernet": {
+        "static_arp": ["protocols_static_arp"]
+    },
+    "interfaces_virtual_ethernet": {
+        "static_arp": ["protocols_static_arp"]
+    },
+    "interfaces_vxlan": {
+        "static_arp": ["protocols_static_arp"]
+    },
+    "interfaces_wireless": {
+        "static_arp": ["protocols_static_arp"]
+    },
+    "interfaces_wwan": {
+        "static_arp": ["protocols_static_arp"]
     },
     "interfaces_wireguard": {
         "vxlan": ["interfaces_vxlan"]

python/vyos/configdict.py

@@ -613,6 +613,16 @@ def get_interface_dict(config, base, ifname='', recursive_defaults=True, with_pk
 
     # Check vif, vif-s/vif-c VLAN interfaces for removal
     dict = get_removed_vlans(config, base + [ifname], dict)
+
+    # Checks for the presence of static ARP entries on a given interface or VLAN
+    static_arp = config.get_config_dict(
+        ['protocols', 'static', 'arp', 'interface'],
+        key_mangling=('-', '_'),
+        get_first_key=True,
+    )
+    if any(key == ifname or key.startswith(f'{ifname}.') for key in static_arp.keys()):
+        dict.update({'static_arp': {}})
+
     return ifname, dict
 
 def get_vlan_ids(interface):

smoketest/scripts/cli/test_vpp.py

@@ -1595,6 +1595,30 @@ def test_20_kernel_options_hugepages(self):
         self.assertIn(f' hugepagesz={hp_size_1g} hugepages={hp_count_1g}', tmp)
         self.assertIn(f' hugepagesz={hp_size_2m} hugepages={hp_count_2m}', tmp)
 
+    def test_21_static_arp(self):
+        host = '192.0.2.10'
+        mac = '00:01:02:03:04:0a'
+        path_static_arp = ['protocols', 'static', 'arp']
+
+        self.cli_set(['interfaces', 'ethernet', interface, 'address', '192.0.2.1/24'])
+        self.cli_set(
+            path_static_arp + ['interface', interface, 'address', host, 'mac', mac]
+        )
+        self.cli_commit()
+
+        # Change VPP configuration
+        self.cli_set(base_path + ['settings', 'unix', 'poll-sleep-usec', '50'])
+
+        # Ensure arp entry is not disappeared
+        _, neighbors = rc_cmd('sudo ip neighbor')
+        self.assertIn(f'{host} dev {interface} lladdr {mac}', neighbors)
+
+        # Check VPP IP neighbors
+        _, vpp_neighbors = rc_cmd('sudo vppctl show ip neighbors')
+        self.assertRegex(vpp_neighbors, rf'{host}\s+S\s+{mac}\s+{interface}')
+
+        self.cli_delete(path_static_arp)
+
 
 if __name__ == '__main__':
     unittest.main(verbosity=2, failfast=VyOSUnitTestSHIM.TestCase.debug_on())

src/conf_mode/interfaces_bonding.py

@@ -175,6 +175,10 @@ def get_config(config=None):
             tmp = has_vrf_configured(conf, interface)
             if tmp: bond['member']['interface'][interface].update({'has_vrf' : ''})
 
+    # Protocols static arp dependency
+    if 'static_arp' in bond:
+        set_dependents('static_arp', conf)
+
     return bond
 
 
@@ -279,7 +283,7 @@ def apply(bond):
     else:
         b.update(bond)
 
-    if dict_search('member.interface_remove', bond):
+    if dict_search('member.interface_remove', bond) or 'static_arp' in bond:
         try:
             call_dependents()
         except ConfigError:

src/conf_mode/interfaces_bridge.py

@@ -124,6 +124,10 @@ def get_config(config=None):
         if len(bridge['member']) == 0:
             del bridge['member']
 
+    # Protocols static arp dependency
+    if 'static_arp' in bridge:
+        set_dependents('static_arp', conf)
+
     return bridge
 
 def verify(bridge):
@@ -220,6 +224,9 @@ def apply(bridge):
             except ConfigError:
                 raise ConfigError(f'Error updating member interface {interface} configuration after changing bridge!')
 
+    if 'static_arp' in bridge:
+        call_dependents()
+
     return None
 
 if __name__ == '__main__':

src/conf_mode/interfaces_ethernet.py

@@ -20,6 +20,8 @@
 
 from vyos.base import Warning
 from vyos.config import Config
+from vyos.configdep import set_dependents
+from vyos.configdep import call_dependents
 from vyos.configdict import get_interface_dict
 from vyos.configdict import is_node_changed
 from vyos.configdict import get_flowtable_interfaces
@@ -171,6 +173,10 @@ def get_config(config=None):
 
     ethernet['flowtable_interfaces'] = get_flowtable_interfaces(conf)
 
+    # Protocols static arp dependency
+    if 'static_arp' in ethernet:
+        set_dependents('static_arp', conf)
+
     return ethernet
 
 def verify_speed_duplex(ethernet: dict, ethtool: Ethtool):
@@ -368,6 +374,7 @@ def apply(ethernet):
         e.remove()
     else:
         e.update(ethernet)
+    call_dependents()
     return None
 
 if __name__ == '__main__':

src/conf_mode/interfaces_geneve.py

@@ -17,6 +17,8 @@
 from sys import exit
 
 from vyos.config import Config
+from vyos.configdep import set_dependents
+from vyos.configdep import call_dependents
 from vyos.configdict import get_interface_dict
 from vyos.configdict import is_node_changed
 from vyos.configverify import verify_address
@@ -51,6 +53,10 @@ def get_config(config=None):
         if is_node_changed(conf, base + [ifname, cli_option]):
             geneve.update({'rebuild_required': {}})
 
+    # Protocols static arp dependency
+    if 'static_arp' in geneve:
+        set_dependents('static_arp', conf)
+
     return geneve
 
 def verify(geneve):
@@ -90,6 +96,8 @@ def apply(geneve):
         g = GeneveIf(**geneve)
         g.update(geneve)
 
+    call_dependents()
+
     return None
 
 

src/conf_mode/interfaces_l2tpv3.py

@@ -17,6 +17,8 @@
 from sys import exit
 
 from vyos.config import Config
+from vyos.configdep import set_dependents
+from vyos.configdep import call_dependents
 from vyos.configdict import get_interface_dict
 from vyos.configdict import leaf_node_changed
 from vyos.configverify import verify_address
@@ -56,6 +58,10 @@ def get_config(config=None):
         tmp = leaf_node_changed(conf, base + [ifname, 'session-id'])
         l2tpv3.update({'session_id': tmp[0]})
 
+    # Protocols static arp dependency
+    if 'static_arp' in l2tpv3:
+        set_dependents('static_arp', conf)
+
     return l2tpv3
 
 def verify(l2tpv3):
@@ -100,6 +106,8 @@ def apply(l2tpv3):
         l = L2TPv3If(**l2tpv3)
         l.update(l2tpv3)
 
+    call_dependents()
+
     return None
 
 if __name__ == '__main__':

src/conf_mode/interfaces_macsec.py

@@ -19,6 +19,8 @@
 from sys import exit
 
 from vyos.config import Config
+from vyos.configdep import set_dependents
+from vyos.configdep import call_dependents
 from vyos.configdict import get_interface_dict
 from vyos.configdict import is_node_changed
 from vyos.configdict import is_source_interface
@@ -78,6 +80,10 @@ def get_config(config=None):
         tmp = is_source_interface(conf, macsec['source_interface'], ['macsec', 'pseudo-ethernet'])
         if tmp and tmp != ifname: macsec.update({'is_source_interface' : tmp})
 
+    # Protocols static arp dependency
+    if 'static_arp' in macsec:
+        set_dependents('static_arp', conf)
+
     return macsec
 
 
@@ -193,6 +199,8 @@ def apply(macsec):
         if not is_systemd_service_running(systemd_service) or 'shutdown_required' in macsec:
             call(f'systemctl reload-or-restart {systemd_service}')
 
+    call_dependents()
+
     return None
 
 

src/conf_mode/interfaces_pseudo-ethernet.py

@@ -17,8 +17,9 @@
 from sys import exit
 
 from vyos.config import Config
+from vyos.configdep import set_dependents
+from vyos.configdep import call_dependents
 from vyos.configdict import get_interface_dict
-from vyos.configdict import is_node_changed
 from vyos.configdict import is_source_interface
 from vyos.configdict import is_node_changed
 from vyos.configverify import verify_vrf
@@ -61,6 +62,10 @@ def get_config(config=None):
         tmp = is_source_interface(conf, peth['source_interface'], ['macsec'])
         if tmp and tmp != ifname: peth.update({'is_source_interface' : tmp})
 
+    # Protocols static arp dependency
+    if 'static_arp' in peth:
+        set_dependents('static_arp', conf)
+
     return peth
 
 def verify(peth):
@@ -95,6 +100,8 @@ def apply(peth):
         p = MACVLANIf(**peth)
         p.update(peth)
 
+    call_dependents()
+
     return None
 
 if __name__ == '__main__':