frr: T7896: Adding profile selection templating in frr.conf

frr: T7896: Simplifying code and adhere to already existing design / coding rules

Author: bl0way

interface-definitions/system_frr.xml.in

@@ -37,17 +37,17 @@
           </leafNode>
           <leafNode name="profile">
             <properties>
-              <help>Configuration profiles to adapt different defaults</help>
+              <help>Select configuration profile to adapt different defaults</help>
               <completionHelp>
                 <list>traditional datacenter</list>
               </completionHelp>
               <valueHelp>
                 <format>traditional</format>
-                <description>Reflects defaults adhering mostly to IETF standards or common practices in wide-area internet routing</description>
+                <description>Adhere mostly to IETF standards or common practices in wide-area internet routing</description>
               </valueHelp>
               <valueHelp>
                 <format>datacenter</format>
-                <description>Reflects a single administrative domain with intradomain links using aggressive timers</description>
+                <description>Single administrative domain using aggressive timers</description>
               </valueHelp>
               <constraint>
                 <regex>(datacenter|traditional)</regex>

python/vyos/frrender.py

@@ -233,6 +233,11 @@ def dict_helper_nhrp_defaults(nhrp):
             ip_dict['afi'] = ip_version
             dict.update({ip_version : ip_dict})
 
+    # Get FRR profile
+    frr_system_cli_path = ['system', 'frr']
+    dict['system_frr'] = conf.get_config_dict(frr_system_cli_path , key_mangling=('-', '_'),
+                                               get_first_key=True, with_recursive_defaults=True)
+
     # Enable SNMP agentx support
     # SNMP AgentX support cannot be disabled once enabled
     if conf.exists(['service', 'snmp']):
@@ -733,6 +738,10 @@ def inline_helper(config_dict) -> str:
         # we can not reload an empty file, thus we always embed the marker
         output = '!\n'
 
+        # FRR profile configuration
+        tmp = dict_search('system_frr.profile', config_dict)
+        if tmp: output += f'frr defaults {tmp}\n'
+
         # Enable FRR logging
         output += 'log facility daemon\n'
         output += 'log timestamp precision 3\n'

smoketest/scripts/cli/test_system_frr.py

@@ -159,12 +159,18 @@ def test_frr_profile_add_remove(self):
             self.cli_commit()
             # read the config file and check content
             self.assertIn(f'frr_profile="{profile}"', read_file(config_file))
+            # read the frr.conf file and check content
+            frrconfig = self.getFRRconfig()
+            self.assertIn(f'frr defaults {profile}', frrconfig)
 
         # test remove profile
         self.cli_delete(base_path + ['profile'])
         self.cli_commit()
         # read the config file and check content
         self.assertIn(f'frr_profile="{frr_profiles[0]}"', read_file(config_file))
+        # read the frr.conf file and check content
+        frrconfig = self.getFRRconfig()
+        self.assertIn(f'frr defaults {profile}', frrconfig)
 
     def test_frr_file_descriptors(self):
         file_descriptors = '4096'

src/conf_mode/system_frr.py

@@ -19,18 +19,21 @@
 from vyos import ConfigError
 from vyos.base import Warning
 from vyos.config import Config
+from vyos.frrender import FRRender
+from vyos.frrender import get_frrender_dict
 from vyos.logger import syslog
 from vyos.template import render_to_string
 from vyos.utils.boot import boot_configuration_complete
 from vyos.utils.file import read_file
 from vyos.utils.file import write_file
 from vyos.utils.process import call
+from vyos.utils.process import is_systemd_service_running
 
 from vyos import airbag
 airbag.enable()
 
 # path to daemons config and config status files
-config_file = '/etc/frr/daemons'
+daemon_config_file = '/etc/frr/daemons'
 
 def get_config(config=None):
     if config:
@@ -42,6 +45,8 @@ def get_config(config=None):
     frr_config = conf.get_config_dict(base, key_mangling=('-', '_'),
                                       get_first_key=True,
                                       with_recursive_defaults=True)
+    # get FRR configuration
+    frr_config['frrender'] = get_frrender_dict(conf)
 
     return frr_config
 
@@ -51,15 +56,25 @@ def verify(frr_config):
 
 def generate(frr_config):
     # read daemons config file
-    daemons_config_current = read_file(config_file)
+    daemons_config_current = read_file(daemon_config_file)
     # generate new config file
     daemons_config_new = render_to_string('frr/daemons.frr.tmpl', frr_config)
     # update configuration file if this is necessary
     if daemons_config_new != daemons_config_current:
         syslog.warning('FRR daemons configuration file need to be changed')
-        write_file(config_file, daemons_config_new)
+        write_file(daemon_config_file, daemons_config_new)
         frr_config['config_file_changed'] = True
 
+    # profile could be automatically generated by frr in frr.conf
+    # and needs to be updated as it is taking precedence
+    if 'frrender' in frr_config and 'profile' in frr_config['frrender']:
+        frr_config['frrender']['profile'] = frr_config['profile']
+        if frr_config['frrender'] and not is_systemd_service_running('vyos-configd.service'):
+            FRRender().generate(frr_config['frrender'])
+            # apply here to keep consistency with the generated daemons
+            # config file
+            FRRender().apply()
+
 def apply(frr_config):
     # display warning to user
     if boot_configuration_complete() and frr_config.get('config_file_changed'):