vrf: T3344: move dynamic routing protocols under "vrf name <name> protocols"

Instead of having the dynamic routing protocols OSPF and BGP residing under
the "protocols vrf <name> [ospf|bgp]" nodes, rather move them directly under
the "vrf name <name> protocols [ospf|bgp]" node. Now all VRF related parts
are placed under the same root node.

This eases the verify steps tremendously, as we do not need to check wheter a
VRF eists or not, it will always exist as we operate under a child node.

5 files changed, 98 insertions, 87 deletions

diff --git a/src/conf_mode/protocols_bgp.py b/src/conf_mode/protocols_bgp.py
index 34b829f08..43ca37f9d 100755
--- a/src/conf_mode/protocols_bgp.py
+++ b/src/conf_mode/protocols_bgp.py
@@ -21,7 +21,6 @@ from sys import argv
 
 from vyos.config import Config
 from vyos.configdict import dict_merge
-from vyos.configverify import verify_vrf
 from vyos.template import is_ip
 from vyos.template import render_to_string
 from vyos.util import call
@@ -47,15 +46,14 @@ def get_config(config=None):
     base_path = ['protocols', 'bgp']
 
     # eqivalent of the C foo ? 'a' : 'b' statement
-    base = vrf and ['protocols', 'vrf', vrf, 'bgp'] or base_path
+    base = vrf and ['vrf', 'name', vrf, 'protocols', 'bgp'] or base_path
     bgp = 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: bgp[asn]['vrf'] = vrf
+    if vrf: bgp.update({'vrf' : vrf})
 
-    # Bail out early if configuration tree does not exist
     if not conf.exists(base):
         bgp.update({'deleted' : ''})
         return bgp
@@ -96,13 +94,19 @@ def verify(bgp):
     if not bgp:
         return None
 
-    # Check if declared more than one ASN
-    if len(bgp) > 1:
-        raise ConfigError('Only one BGP AS number can be defined!')
+    # FRR bgpd only supports one Autonomous System Number, verify this!
+    asn = 0
+    for key in bgp:
+        if key.isnumeric():
+            asn +=1
+        if asn > 1:
+            raise ConfigError('Only one BGP AS number can be defined!')
 
     for asn, asn_config in bgp.items():
-
-        verify_vrf(asn_config)
+        # Workaround for https://phabricator.vyos.net/T1711
+        # We also have a vrf, and deleted key now - so we can only veriy "numbers"
+        if not asn.isnumeric():
+            continue
 
         # Common verification for both peer-group and neighbor statements
         for neighbor in ['neighbor', 'peer_group']:
@@ -202,6 +206,8 @@ def generate(bgp):
     # of the config dict
     asn = list(bgp.keys())[0]
     bgp[asn]['asn'] = asn
+    if 'vrf' in bgp:
+        bgp[asn]['vrf'] = bgp['vrf']
 
     bgp['new_frr_config'] = render_to_string('frr/bgp.frr.tmpl', bgp[asn])
     return None
diff --git a/src/conf_mode/protocols_ospf.py b/src/conf_mode/protocols_ospf.py
index 8c2372bd9..e0dc4e7bf 100755
--- a/src/conf_mode/protocols_ospf.py
+++ b/src/conf_mode/protocols_ospf.py
@@ -24,7 +24,6 @@ from vyos.configdict import dict_merge
 from vyos.configdict import node_changed
 from vyos.configverify import verify_route_maps
 from vyos.configverify import verify_interface_exists
-from vyos.configverify import verify_vrf
 from vyos.template import render_to_string
 from vyos.util import call
 from vyos.util import dict_search
@@ -50,7 +49,7 @@ def get_config(config=None):
     base_path = ['protocols', 'ospf']
 
     # eqivalent of the C foo ? 'a' : 'b' statement
-    base = vrf and ['protocols', 'vrf', vrf, 'ospf'] or base_path
+    base = vrf and ['vrf', 'name', vrf, 'protocols', 'ospf'] or base_path
     ospf = 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
@@ -141,7 +140,6 @@ def verify(ospf):
     if not ospf:
         return None
 
-    verify_vrf(ospf)
     verify_route_maps(ospf)
 
     if 'interface' in ospf:
diff --git a/src/conf_mode/protocols_static.py b/src/conf_mode/protocols_static.py
index 5d101b33e..51b4acfc8 100755
--- a/src/conf_mode/protocols_static.py
+++ b/src/conf_mode/protocols_static.py
@@ -17,6 +17,7 @@
 import os
 
 from sys import exit
+from sys import argv
 
 from vyos.config import Config
 from vyos.template import render_to_string
@@ -34,8 +35,19 @@ def get_config(config=None):
         conf = config
     else:
         conf = Config()
-    base = ['protocols', 'static']
+
+    vrf = None
+    if len(argv) > 1:
+        vrf = argv[1]
+
+    base_path = ['protocols', 'static']
+    # eqivalent of the C foo ? 'a' : 'b' statement
+    base = vrf and ['vrf', 'name', vrf, 'protocols', 'static'] or base_path
     static = conf.get_config_dict(base, key_mangling=('-', '_'), get_first_key=True)
+
+    # Assign the name of our VRF context
+    if vrf: static['vrf'] = vrf
+
     return static
 
 def verify(static):
@@ -50,8 +62,14 @@ def apply(static):
     # Save original configuration prior to starting any commit actions
     frr_cfg = frr.FRRConfig()
     frr_cfg.load_configuration(frr_daemon)
-    frr_cfg.modify_section(r'^ip route .*', '')
-    frr_cfg.modify_section(r'^ipv6 route .*', '')
+
+    if 'vrf' in static:
+        vrf = static['vrf']
+        frr_cfg.modify_section(f'^vrf {vrf}$', '')
+    else:
+        frr_cfg.modify_section(r'^ip route .*', '')
+        frr_cfg.modify_section(r'^ipv6 route .*', '')
+
     frr_cfg.add_before(r'(interface .*|line vty)', static['new_frr_config'])
     frr_cfg.commit_configuration(frr_daemon)
 
diff --git a/src/conf_mode/protocols_vrf.py b/src/conf_mode/protocols_vrf.py
deleted file mode 100755
index 227e7d5e1..000000000
--- a/src/conf_mode/protocols_vrf.py
+++ /dev/null
@@ -1,72 +0,0 @@
-#!/usr/bin/env python3
-#
-# Copyright (C) 2021 VyOS maintainers and contributors
-#
-# This program is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License version 2 or later as
-# published by the Free Software Foundation.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-import os
-
-from sys import exit
-
-from vyos.config import Config
-from vyos.template import render_to_string
-from vyos.util import call
-from vyos import ConfigError
-from vyos import frr
-from vyos import airbag
-airbag.enable()
-
-frr_daemon = 'staticd'
-
-def get_config(config=None):
-    if config:
-        conf = config
-    else:
-        conf = Config()
-    base = ['protocols', 'vrf']
-    vrf = conf.get_config_dict(base, key_mangling=('-', '_'))
-    return vrf
-
-def verify(vrf):
-
-    return None
-
-def generate(vrf):
-    vrf['new_frr_config'] = render_to_string('frr/vrf.frr.tmpl', vrf)
-    return None
-
-def apply(vrf):
-    # Save original configuration prior to starting any commit actions
-    frr_cfg = frr.FRRConfig()
-    frr_cfg.load_configuration(frr_daemon)
-    frr_cfg.modify_section(r'vrf \S+', '')
-    frr_cfg.add_before(r'(ip prefix-list .*|route-map .*|line vty)', vrf['new_frr_config'])
-    frr_cfg.commit_configuration(frr_daemon)
-
-    # If FRR config is blank, rerun the blank commit x times due to frr-reload
-    # behavior/bug not properly clearing out on one commit.
-    if vrf['new_frr_config'] == '':
-        for a in range(5):
-            frr_cfg.commit_configuration(frr_daemon)
-
-    return None
-
-if __name__ == '__main__':
-    try:
-        c = get_config()
-        verify(c)
-        generate(c)
-        apply(c)
-    except ConfigError as e:
-        print(e)
-        exit(1)
diff --git a/src/migration-scripts/vrf/1-to-2 b/src/migration-scripts/vrf/1-to-2
new file mode 100755
index 000000000..20128e957
--- /dev/null
+++ b/src/migration-scripts/vrf/1-to-2
@@ -0,0 +1,61 @@
+#!/usr/bin/env python3
+#
+# Copyright (C) 2021 VyOS maintainers and contributors
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 2 or later as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# - T3344: migrate routing options from "protocols vrf" to "vrf <name> protocols"
+
+from sys import argv
+from sys import exit
+from vyos.configtree import ConfigTree
+
+if (len(argv) < 2):
+    print("Must specify file name!")
+    exit(1)
+
+file_name = argv[1]
+
+with open(file_name, 'r') as f:
+    config_file = f.read()
+
+base = ['protocols', 'vrf']
+config = ConfigTree(config_file)
+
+if not config.exists(base):
+    # Nothing to do
+    exit(0)
+
+vrf_base = ['vrf', 'name']
+config.set(vrf_base)
+config.set_tag(vrf_base)
+
+# Copy all existing static routes to the new base node under "vrf name <name> protocols static"
+for vrf in config.list_nodes(base):
+    static_base = base + [vrf, 'static']
+    if not config.exists(static_base):
+        continue
+
+    new_static_base = vrf_base + [vrf, 'protocols']
+    config.set(new_static_base)
+    config.copy(static_base, new_static_base + ['static'])
+
+# Now delete the old configuration
+config.delete(base)
+
+try:
+    with open(file_name, 'w') as f:
+        f.write(config.to_string())
+except OSError as e:
+    print("Failed to save the modified config: {}".format(e))
+    exit(1)