frr: T6747: migrate protocols to unified FRRender class

With FRR 10.0 daemons started to be migrated to integrated FRR mgmtd and a
northbound interface. This led to some drawbacks in the current state how
changes to FRR are handled. The current implementation will use frr-reload.py
and specifies excatly WHICH daemon needs a config update and will only replace
this part inside FRR.

With FRR10 and mgmtd when a partial configuration is sent to mgmtd, it will
remove configuration parts from other daemons like bgpd or ospfd which have
not yet been migrated to mgmtd.

It's not possible to call frr-reload.py with daemon mgmtd - it will error out.

This commit will also change the CLI for static routes:

CLI command "set protocols static route 10.0.0.0/8 next-hop 1.2.3.4 bfd multi-hop
source 1.1.1.1" will be split into:
* set protocols static route 10.0.0.0/8 next-hop 1.2.3.4 bfd source-address 1.1.1.1
* set protocols static route 10.0.0.0/8 next-hop 1.2.3.4 bfd multi-hop

To make the XML blocks reusable, and comply with the FRR CLI - this was actually
a wrong implementation from the beginning as you can not have multiple BFD
source addresses.

CLI command "set protocols static route 10.0.0.0/8 next-hop 1.2.3.4 bfd multi-hop
source 1.1.1.1 profile bar" is changed to:
* set protocols static route 10.0.0.0/8 next-hop 1.2.3.4 bfd profile bar

CLI commands "set protocols static multicast interface-route" is moved to:
* set protocols static multicast route <x.x.x.x/x> interface

To have an identical look and feel with regular static routes.

1 files changed, 65 insertions, 77 deletions

diff --git a/src/conf_mode/protocols_isis.py b/src/conf_mode/protocols_isis.py
index 9b70c7329..e812770bc 100755
--- a/src/conf_mode/protocols_isis.py
+++ b/src/conf_mode/protocols_isis.py
@@ -18,75 +18,89 @@ from sys import exit
 from sys import argv
 
 from vyos.config import Config
-from vyos.configdict import dict_merge
-from vyos.configdict import node_changed
+from vyos.configdict import get_frrender_dict
+from vyos.configverify import has_frr_protocol_in_dict
 from vyos.configverify import verify_common_route_maps
 from vyos.configverify import verify_interface_exists
+from vyos.frrender import FRRender
 from vyos.ifconfig import Interface
 from vyos.utils.dict import dict_search
 from vyos.utils.network import get_interface_config
-from vyos.template import render_to_string
 from vyos import ConfigError
-from vyos import frr
 from vyos import airbag
 airbag.enable()
 
+frrender = FRRender()
+
+vrf = None
+if len(argv) > 1:
+    vrf = argv[1]
+
 def get_config(config=None):
     if config:
         conf = config
     else:
         conf = Config()
 
-    vrf = None
-    if len(argv) > 1:
-        vrf = argv[1]
+    return get_frrender_dict(conf)
 
-    base_path = ['protocols', 'isis']
 
-    # eqivalent of the C foo ? 'a' : 'b' statement
-    base = vrf and ['vrf', 'name', vrf, 'protocols', 'isis'] or base_path
-    isis = conf.get_config_dict(base, key_mangling=('-', '_'),
-                                get_first_key=True,
-                                no_tag_node_value_mangle=True)
-
-    # Assign the name of our VRF context. This MUST be done before the return
-    # statement below, else on deletion we will delete the default instance
-    # instead of the VRF instance.
-    if vrf: isis['vrf'] = vrf
-
-    # FRR has VRF support for different routing daemons. As interfaces belong
-    # to VRFs - or the global VRF, we need to check for changed interfaces so
-    # that they will be properly rendered for the FRR config. Also this eases
-    # removal of interfaces from the running configuration.
-    interfaces_removed = node_changed(conf, base + ['interface'])
-    if interfaces_removed:
-        isis['interface_removed'] = list(interfaces_removed)
-
-    # Bail out early if configuration tree does no longer exist. this must
-    # be done after retrieving the list of interfaces to be removed.
-    if not conf.exists(base):
-        isis.update({'deleted' : ''})
-        return isis
-
-    # merge in default values
-    isis = conf.merge_defaults(isis, recursive=True)
-
-    # We also need some additional information from the config, prefix-lists
-    # and route-maps for instance. They will be used in verify().
-    #
-    # XXX: one MUST always call this without the key_mangling() option! See
-    # vyos.configverify.verify_common_route_maps() for more information.
-    tmp = conf.get_config_dict(['policy'])
-    # Merge policy dict into "regular" config dict
-    isis = dict_merge(tmp, isis)
+    # base_path = ['protocols', 'isis']
+
+    # # eqivalent of the C foo ? 'a' : 'b' statement
+    # base = vrf and ['vrf', 'name', vrf, 'protocols', 'isis'] or base_path
+    # isis = conf.get_config_dict(base, key_mangling=('-', '_'),
+    #                             get_first_key=True,
+    #                             no_tag_node_value_mangle=True)
+
+    # # Assign the name of our VRF context. This MUST be done before the return
+    # # statement below, else on deletion we will delete the default instance
+    # # instead of the VRF instance.
+    # if vrf: isis['vrf'] = vrf
+
+    # # FRR has VRF support for different routing daemons. As interfaces belong
+    # # to VRFs - or the global VRF, we need to check for changed interfaces so
+    # # that they will be properly rendered for the FRR config. Also this eases
+    # # removal of interfaces from the running configuration.
+    # interfaces_removed = node_changed(conf, base + ['interface'])
+    # if interfaces_removed:
+    #     isis['interface_removed'] = list(interfaces_removed)
+
+    # # Bail out early if configuration tree does no longer exist. this must
+    # # be done after retrieving the list of interfaces to be removed.
+    # if not conf.exists(base):
+    #     isis.update({'deleted' : ''})
+    #     return isis
+
+    # # merge in default values
+    # isis = conf.merge_defaults(isis, recursive=True)
+
+    # # We also need some additional information from the config, prefix-lists
+    # # and route-maps for instance. They will be used in verify().
+    # #
+    # # XXX: one MUST always call this without the key_mangling() option! See
+    # # vyos.configverify.verify_common_route_maps() for more information.
+    # tmp = conf.get_config_dict(['policy'])
+    # # Merge policy dict into "regular" config dict
+    # isis = dict_merge(tmp, isis)
 
     return isis
 
-def verify(isis):
-    # bail out early - looks like removal from running config
-    if not isis or 'deleted' in isis:
+def verify(config_dict):
+    global vrf
+    if not has_frr_protocol_in_dict(config_dict, 'isis', vrf):
         return None
 
+    # eqivalent of the C foo ? 'a' : 'b' statement
+    isis = vrf and config_dict['vrf']['name'][vrf]['protocols']['isis'] or config_dict['isis']
+    isis['policy'] = config_dict['policy']
+
+    if 'deleted' in isis:
+        return None
+
+    if vrf:
+        isis['vrf'] = vrf
+
     if 'net' not in isis:
         raise ConfigError('Network entity is mandatory!')
 
@@ -266,37 +280,11 @@ def verify(isis):
 
     return None
 
-def generate(isis):
-    if not isis or 'deleted' in isis:
-        return None
-
-    isis['frr_isisd_config'] = render_to_string('frr/isisd.frr.j2', isis)
-    return None
-
-def apply(isis):
-    # Save original configuration prior to starting any commit actions
-    frr_cfg = frr.FRRConfig()
-
-    # Generate empty helper string which can be ammended to FRR commands, it
-    # will be either empty (default VRF) or contain the "vrf <name" statement
-    vrf = ''
-    if 'vrf' in isis:
-        vrf = ' vrf ' + isis['vrf']
-
-    frr_cfg.load_configuration(frr.isis_daemon)
-    frr_cfg.modify_section(f'^router isis VyOS{vrf}', stop_pattern='^exit', remove_stop_mark=True)
-
-    for key in ['interface', 'interface_removed']:
-        if key not in isis:
-            continue
-        for interface in isis[key]:
-            frr_cfg.modify_section(f'^interface {interface}', stop_pattern='^exit', remove_stop_mark=True)
-
-    if 'frr_isisd_config' in isis:
-        frr_cfg.add_before(frr.default_add_before, isis['frr_isisd_config'])
-
-    frr_cfg.commit_configuration(frr.isis_daemon)
+def generate(config_dict):
+    frrender.generate(config_dict)
 
+def apply(config_dict):
+    frrender.apply()
     return None
 
 if __name__ == '__main__':