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, 21 insertions, 103 deletions

diff --git a/src/conf_mode/protocols_ospfv3.py b/src/conf_mode/protocols_ospfv3.py
index 7bdab3017..038fcd2b4 100755
--- a/src/conf_mode/protocols_ospfv3.py
+++ b/src/conf_mode/protocols_ospfv3.py
@@ -18,96 +18,41 @@ from sys import exit
 from sys import argv
 
 from vyos.config import Config
-from vyos.config import config_dict_merge
-from vyos.configdict import dict_merge
-from vyos.configdict import node_changed
+from vyos.configdict import get_frrender_dict
 from vyos.configverify import verify_common_route_maps
 from vyos.configverify import verify_route_map
 from vyos.configverify import verify_interface_exists
-from vyos.template import render_to_string
+from vyos.configverify import has_frr_protocol_in_dict
+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 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', 'ospfv3']
+def verify(config_dict):
+    global vrf
+    if not has_frr_protocol_in_dict(config_dict, 'ospfv3', vrf):
+        return None
 
     # eqivalent of the C foo ? 'a' : 'b' statement
-    base = vrf and ['vrf', 'name', vrf, 'protocols', 'ospfv3'] or base_path
-    ospfv3 = conf.get_config_dict(base, key_mangling=('-', '_'), get_first_key=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: ospfv3['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:
-        ospfv3['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):
-        ospfv3.update({'deleted' : ''})
-        return ospfv3
-
-    # We have gathered the dict representation of the CLI, but there are default
-    # options which we need to update into the dictionary retrived.
-    default_values = conf.get_config_defaults(**ospfv3.kwargs,
-                                              recursive=True)
-
-    # We have to cleanup the default dict, as default values could enable features
-    # which are not explicitly enabled on the CLI. Example: default-information
-    # originate comes with a default metric-type of 2, which will enable the
-    # entire default-information originate tree, even when not set via CLI so we
-    # need to check this first and probably drop that key.
-    if dict_search('default_information.originate', ospfv3) is None:
-        del default_values['default_information']
-    if 'graceful_restart' not in ospfv3:
-        del default_values['graceful_restart']
-
-    for protocol in ['babel', 'bgp', 'connected', 'isis', 'kernel', 'ripng', 'static']:
-        if dict_search(f'redistribute.{protocol}', ospfv3) is None:
-            del default_values['redistribute'][protocol]
-    if not bool(default_values['redistribute']):
-        del default_values['redistribute']
-
-    default_values.pop('interface', {})
-
-    # merge in remaining default values
-    ospfv3 = config_dict_merge(default_values, ospfv3)
-
-    # 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
-    ospfv3 = dict_merge(tmp, ospfv3)
-
-    return ospfv3
-
-def verify(ospfv3):
-    if not ospfv3:
-        return None
+    ospfv3 = vrf and config_dict['vrf']['name'][vrf]['protocols']['ospfv3'] or config_dict['ospfv3']
+    ospfv3['policy'] = config_dict['policy']
 
     verify_common_route_maps(ospfv3)
 
@@ -137,45 +82,18 @@ def verify(ospfv3):
             # interface is bound to our requesting VRF. Due to the VyOS
             # priorities the interface is bound to the VRF after creation of
             # the VRF itself, and before any routing protocol is configured.
-            if 'vrf' in ospfv3:
-                vrf = ospfv3['vrf']
+            if vrf:
                 tmp = get_interface_config(interface)
                 if 'master' not in tmp or tmp['master'] != vrf:
                     raise ConfigError(f'Interface "{interface}" is not a member of VRF "{vrf}"!')
 
     return None
 
-def generate(ospfv3):
-    if not ospfv3 or 'deleted' in ospfv3:
-        return None
-
-    ospfv3['new_frr_config'] = render_to_string('frr/ospf6d.frr.j2', ospfv3)
-    return None
-
-def apply(ospfv3):
-    # 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 ospfv3:
-        vrf = ' vrf ' + ospfv3['vrf']
-
-    frr_cfg.load_configuration(frr.ospf6_daemon)
-    frr_cfg.modify_section(f'^router ospf6{vrf}', stop_pattern='^exit', remove_stop_mark=True)
-
-    for key in ['interface', 'interface_removed']:
-        if key not in ospfv3:
-            continue
-        for interface in ospfv3[key]:
-            frr_cfg.modify_section(f'^interface {interface}', stop_pattern='^exit', remove_stop_mark=True)
-
-    if 'new_frr_config' in ospfv3:
-        frr_cfg.add_before(frr.default_add_before, ospfv3['new_frr_config'])
-
-    frr_cfg.commit_configuration(frr.ospf6_daemon)
+def generate(config_dict):
+    frrender.generate(config_dict)
 
+def apply(config_dict):
+    frrender.apply()
     return None
 
 if __name__ == '__main__':