ospfv3: T3928: add VRF support

set vrf name foo protocols ospfv3

6 files changed, 331 insertions, 248 deletions

diff --git a/data/templates/frr/ospf6d.frr.tmpl b/data/templates/frr/ospf6d.frr.tmpl
index 5871b3d7a..10a6d9b4b 100644
--- a/data/templates/frr/ospf6d.frr.tmpl
+++ b/data/templates/frr/ospf6d.frr.tmpl
@@ -1,7 +1,7 @@
 !
 {% if interface is defined and interface is not none %}
 {%   for iface, iface_config in interface.items() %}
-interface {{ iface }}
+interface {{ iface }} {{ 'vrf ' + vrf if vrf is defined and vrf is not none }}
 {%     if iface_config.area is defined and iface_config.area is not none %}
  ipv6 ospf6 area {{ iface_config.area }}
 {%     endif %}
@@ -46,7 +46,7 @@ exit
 {%   endfor %}
 {% endif %}
 !
-router ospf6
+router ospf6 {{ 'vrf ' + vrf if vrf is defined and vrf is not none }}
 {% if area is defined and area is not none %}
 {%   for area_id, area_config in area.items() %}
 {%     if area_config.area_type is defined and area_config.area_type is not none %}
diff --git a/interface-definitions/include/ospfv3/protocol-common-config.xml.i b/interface-definitions/include/ospfv3/protocol-common-config.xml.i
new file mode 100644
index 000000000..a93939a34
--- /dev/null
+++ b/interface-definitions/include/ospfv3/protocol-common-config.xml.i
@@ -0,0 +1,241 @@
+<!-- include start from ospfv3/protocol-common-config.xml.i -->
+<tagNode name="area">
+  <properties>
+    <help>OSPFv3 Area</help>
+    <valueHelp>
+      <format>u32</format>
+      <description>Area ID as a decimal value</description>
+    </valueHelp>
+    <valueHelp>
+      <format>ipv4</format>
+      <description>Area ID in IP address forma</description>
+    </valueHelp>
+    <constraint>
+      <validator name="numeric" argument="--range 0-4294967295"/>
+      <validator name="ip-address"/>
+    </constraint>
+  </properties>
+  <children>
+    <node name="area-type">
+      <properties>
+        <help>OSPFv3 Area type</help>
+      </properties>
+      <children>
+        <node name="stub">
+          <properties>
+            <help>Stub OSPFv3 area</help>
+          </properties>
+          <children>
+            <leafNode name="no-summary">
+              <properties>
+                <help>Do not inject inter-area routes into the stub</help>
+                <valueless/>
+              </properties>
+            </leafNode>
+          </children>
+        </node>
+      </children>
+    </node>
+    <leafNode name="export-list">
+      <properties>
+        <help>Name of export-list</help>
+        <completionHelp>
+          <path>policy access-list6</path>
+        </completionHelp>
+      </properties>
+    </leafNode>
+    <leafNode name="import-list">
+      <properties>
+        <help>Name of import-list</help>
+        <completionHelp>
+          <path>policy access-list6</path>
+        </completionHelp>
+      </properties>
+    </leafNode>
+    <tagNode name="range">
+      <properties>
+        <help>Specify IPv6 prefix (border routers only)</help>
+        <valueHelp>
+          <format>ipv6net</format>
+          <description>Specify IPv6 prefix (border routers only)</description>
+        </valueHelp>
+        <constraint>
+          <validator name="ipv6-prefix"/>
+        </constraint>
+      </properties>
+      <children>
+        <leafNode name="advertise">
+          <properties>
+            <help>Advertise this range</help>
+            <valueless/>
+          </properties>
+        </leafNode>
+        <leafNode name="not-advertise">
+          <properties>
+            <help>Do not advertise this range</help>
+            <valueless/>
+          </properties>
+        </leafNode>
+      </children>
+    </tagNode>
+  </children>
+</tagNode>
+<node name="distance">
+  <properties>
+    <help>Administrative distance</help>
+  </properties>
+  <children>
+    #include <include/ospf/distance-global.xml.i>
+    <node name="ospfv3">
+      <properties>
+        <help>OSPFv3 administrative distance</help>
+      </properties>
+      <children>
+        #include <include/ospf/distance-per-protocol.xml.i>
+      </children>
+    </node>
+  </children>
+</node>
+<tagNode name="interface">
+  <properties>
+    <help>Enable routing on an IPv6 interface</help>
+    <completionHelp>
+      <script>${vyos_completion_dir}/list_interfaces.py</script>
+    </completionHelp>
+    <valueHelp>
+      <format>txt</format>
+      <description>Interface used for routing information exchange</description>
+    </valueHelp>
+    <constraint>
+      <validator name="interface-name"/>
+    </constraint>
+  </properties>
+  <children>
+    <leafNode name="area">
+      <properties>
+        <help>Enable OSPF on this interface</help>
+        <completionHelp>
+          <path>protocols ospfv3 area</path>
+        </completionHelp>
+        <valueHelp>
+          <format>u32</format>
+          <description>OSPF area ID as decimal notation</description>
+        </valueHelp>
+        <valueHelp>
+          <format>ipv4</format>
+          <description>OSPF area ID in IP address notation</description>
+        </valueHelp>
+        <constraint>
+          <validator name="numeric" argument="--range 0-4294967295"/>
+          <validator name="ip-address"/>
+        </constraint>
+      </properties>
+    </leafNode>
+    #include <include/ospf/intervals.xml.i>
+    #include <include/ospf/interface-common.xml.i>
+    <leafNode name="ifmtu">
+      <properties>
+        <help>Interface MTU</help>
+        <valueHelp>
+          <format>u32:1-65535</format>
+          <description>Interface MTU</description>
+        </valueHelp>
+        <constraint>
+          <validator name="numeric" argument="--range 1-65535"/>
+        </constraint>
+      </properties>
+    </leafNode>
+    <leafNode name="instance-id">
+      <properties>
+        <help>Instance Id (default: 0)</help>
+        <valueHelp>
+          <format>u32:0-255</format>
+          <description>Instance Id</description>
+        </valueHelp>
+        <constraint>
+          <validator name="numeric" argument="--range 0-255"/>
+        </constraint>
+      </properties>
+      <defaultValue>0</defaultValue>
+    </leafNode>
+    <leafNode name="network">
+      <properties>
+        <help>Network type</help>
+        <completionHelp>
+          <list>broadcast point-to-point</list>
+        </completionHelp>
+        <valueHelp>
+          <format>broadcast</format>
+          <description>Broadcast network type</description>
+        </valueHelp>
+        <valueHelp>
+          <format>point-to-point</format>
+          <description>Point-to-point network type</description>
+        </valueHelp>
+        <constraint>
+          <regex>^(broadcast|point-to-point)$</regex>
+        </constraint>
+        <constraintErrorMessage>Must be broadcast or point-to-point</constraintErrorMessage>
+      </properties>
+    </leafNode>
+    #include <include/isis/passive.xml.i>
+  </children>
+</tagNode>
+#include <include/ospf/log-adjacency-changes.xml.i>
+<node name="parameters">
+  <properties>
+    <help>OSPFv3 specific parameters</help>
+  </properties>
+  <children>
+    #include <include/router-id.xml.i>
+  </children>
+</node>
+<node name="redistribute">
+  <properties>
+    <help>Redistribute information from another routing protocol</help>
+  </properties>
+  <children>
+    <node name="bgp">
+      <properties>
+        <help>Redistribute BGP routes</help>
+      </properties>
+      <children>
+        #include <include/route-map.xml.i>
+      </children>
+    </node>
+    <node name="connected">
+      <properties>
+        <help>Redistribute connected routes</help>
+      </properties>
+      <children>
+        #include <include/route-map.xml.i>
+      </children>
+    </node>
+    <node name="kernel">
+      <properties>
+        <help>Redistribute kernel routes</help>
+      </properties>
+      <children>
+        #include <include/route-map.xml.i>
+      </children>
+    </node>
+    <node name="ripng">
+      <properties>
+        <help>Redistribute RIPNG routes</help>
+      </properties>
+      <children>
+        #include <include/route-map.xml.i>
+      </children>
+    </node>
+    <node name="static">
+      <properties>
+        <help>Redistribute static routes</help>
+      </properties>
+      <children>
+        #include <include/route-map.xml.i>
+      </children>
+    </node>
+  </children>
+</node>
+#include <include/route-map.xml.i>
+<!-- include end -->
diff --git a/interface-definitions/protocols-ospfv3.xml.in b/interface-definitions/protocols-ospfv3.xml.in
index c7a94d58c..2b98ffa7b 100644
--- a/interface-definitions/protocols-ospfv3.xml.in
+++ b/interface-definitions/protocols-ospfv3.xml.in
@@ -8,245 +8,7 @@
           <priority>620</priority>
         </properties>
         <children>
-          <tagNode name="area">
-            <properties>
-              <help>OSPFv3 Area</help>
-              <valueHelp>
-                <format>u32</format>
-                <description>Area ID as a decimal value</description>
-              </valueHelp>
-              <valueHelp>
-                <format>ipv4</format>
-                <description>Area ID in IP address forma</description>
-              </valueHelp>
-              <constraint>
-                <validator name="numeric" argument="--range 0-4294967295"/>
-                <validator name="ip-address"/>
-              </constraint>
-            </properties>
-            <children>
-              <node name="area-type">
-                <properties>
-                  <help>OSPFv3 Area type</help>
-                </properties>
-                <children>
-                  <node name="stub">
-                    <properties>
-                      <help>Stub OSPFv3 area</help>
-                    </properties>
-                    <children>
-                      <leafNode name="no-summary">
-                        <properties>
-                          <help>Do not inject inter-area routes into the stub</help>
-                          <valueless/>
-                        </properties>
-                      </leafNode>
-                    </children>
-                  </node>
-                </children>
-              </node>
-              <leafNode name="export-list">
-                <properties>
-                  <help>Name of export-list</help>
-                  <completionHelp>
-                    <path>policy access-list6</path>
-                  </completionHelp>
-                </properties>
-              </leafNode>
-              <leafNode name="import-list">
-                <properties>
-                  <help>Name of import-list</help>
-                  <completionHelp>
-                    <path>policy access-list6</path>
-                  </completionHelp>
-                </properties>
-              </leafNode>
-              <tagNode name="range">
-                <properties>
-                  <help>Specify IPv6 prefix (border routers only)</help>
-                  <valueHelp>
-                    <format>ipv6net</format>
-                    <description>Specify IPv6 prefix (border routers only)</description>
-                  </valueHelp>
-                  <constraint>
-                    <validator name="ipv6-prefix"/>
-                  </constraint>
-                </properties>
-                <children>
-                  <leafNode name="advertise">
-                    <properties>
-                      <help>Advertise this range</help>
-                      <valueless/>
-                    </properties>
-                  </leafNode>
-                  <leafNode name="not-advertise">
-                    <properties>
-                      <help>Do not advertise this range</help>
-                      <valueless/>
-                    </properties>
-                  </leafNode>
-                </children>
-              </tagNode>
-            </children>
-          </tagNode>
-          <node name="distance">
-            <properties>
-              <help>Administrative distance</help>
-            </properties>
-            <children>
-              #include <include/ospf/distance-global.xml.i>
-              <node name="ospfv3">
-                <properties>
-                  <help>OSPFv3 administrative distance</help>
-                </properties>
-                <children>
-                  #include <include/ospf/distance-per-protocol.xml.i>
-                </children>
-              </node>
-            </children>
-          </node>
-          <tagNode name="interface">
-            <properties>
-              <help>Enable routing on an IPv6 interface</help>
-              <completionHelp>
-                <script>${vyos_completion_dir}/list_interfaces.py</script>
-              </completionHelp>
-              <valueHelp>
-                <format>txt</format>
-                <description>Interface used for routing information exchange</description>
-              </valueHelp>
-              <constraint>
-                <validator name="interface-name"/>
-              </constraint>
-            </properties>
-            <children>
-              <leafNode name="area">
-                <properties>
-                  <help>Enable OSPF on this interface</help>
-                  <completionHelp>
-                    <path>protocols ospfv3 area</path>
-                  </completionHelp>
-                  <valueHelp>
-                    <format>u32</format>
-                    <description>OSPF area ID as decimal notation</description>
-                  </valueHelp>
-                  <valueHelp>
-                    <format>ipv4</format>
-                    <description>OSPF area ID in IP address notation</description>
-                  </valueHelp>
-                  <constraint>
-                    <validator name="numeric" argument="--range 0-4294967295"/>
-                    <validator name="ip-address"/>
-                  </constraint>
-                </properties>
-              </leafNode>
-              #include <include/ospf/intervals.xml.i>
-              #include <include/ospf/interface-common.xml.i>
-              <leafNode name="ifmtu">
-                <properties>
-                  <help>Interface MTU</help>
-                  <valueHelp>
-                    <format>u32:1-65535</format>
-                    <description>Interface MTU</description>
-                  </valueHelp>
-                  <constraint>
-                    <validator name="numeric" argument="--range 1-65535"/>
-                  </constraint>
-                </properties>
-              </leafNode>
-              <leafNode name="instance-id">
-                <properties>
-                  <help>Instance Id (default: 0)</help>
-                  <valueHelp>
-                    <format>u32:0-255</format>
-                    <description>Instance Id</description>
-                  </valueHelp>
-                  <constraint>
-                    <validator name="numeric" argument="--range 0-255"/>
-                  </constraint>
-                </properties>
-                <defaultValue>0</defaultValue>
-              </leafNode>
-              <leafNode name="network">
-                <properties>
-                  <help>Network type</help>
-                  <completionHelp>
-                    <list>broadcast point-to-point</list>
-                  </completionHelp>
-                  <valueHelp>
-                    <format>broadcast</format>
-                    <description>Broadcast network type</description>
-                  </valueHelp>
-                  <valueHelp>
-                    <format>point-to-point</format>
-                    <description>Point-to-point network type</description>
-                  </valueHelp>
-                  <constraint>
-                    <regex>^(broadcast|point-to-point)$</regex>
-                  </constraint>
-                  <constraintErrorMessage>Must be broadcast or point-to-point</constraintErrorMessage>
-                </properties>
-              </leafNode>
-              #include <include/isis/passive.xml.i>
-            </children>
-          </tagNode>
-          #include <include/ospf/log-adjacency-changes.xml.i>
-          <node name="parameters">
-            <properties>
-              <help>OSPFv3 specific parameters</help>
-            </properties>
-            <children>
-              #include <include/router-id.xml.i>
-            </children>
-          </node>
-          <node name="redistribute">
-            <properties>
-              <help>Redistribute information from another routing protocol</help>
-            </properties>
-            <children>
-              <node name="bgp">
-                <properties>
-                  <help>Redistribute BGP routes</help>
-                </properties>
-                <children>
-                  #include <include/route-map.xml.i>
-                </children>
-              </node>
-              <node name="connected">
-                <properties>
-                  <help>Redistribute connected routes</help>
-                </properties>
-                <children>
-                  #include <include/route-map.xml.i>
-                </children>
-              </node>
-              <node name="kernel">
-                <properties>
-                  <help>Redistribute kernel routes</help>
-                </properties>
-                <children>
-                  #include <include/route-map.xml.i>
-                </children>
-              </node>
-              <node name="ripng">
-                <properties>
-                  <help>Redistribute RIPNG routes</help>
-                </properties>
-                <children>
-                  #include <include/route-map.xml.i>
-                </children>
-              </node>
-              <node name="static">
-                <properties>
-                  <help>Redistribute static routes</help>
-                </properties>
-                <children>
-                  #include <include/route-map.xml.i>
-                </children>
-              </node>
-            </children>
-          </node>
-          #include <include/route-map.xml.i>
+          #include <include/ospfv3/protocol-common-config.xml.i>
         </children>
       </node>
     </children>
diff --git a/interface-definitions/vrf.xml.in b/interface-definitions/vrf.xml.in
index d6a602f53..14c31fa8a 100644
--- a/interface-definitions/vrf.xml.in
+++ b/interface-definitions/vrf.xml.in
@@ -60,6 +60,15 @@
                   #include <include/ospf/protocol-common-config.xml.i>
                 </children>
               </node>
+              <node name="ospfv3" owner="${vyos_conf_scripts_dir}/protocols_ospfv3.py $VAR(../../@)">
+                <properties>
+                  <help>Open Shortest Path First (OSPF) for IPv6</help>
+                  <priority>621</priority>
+                </properties>
+                <children>
+                  #include <include/ospfv3/protocol-common-config.xml.i>
+                </children>
+              </node>
               <node name="static" owner="${vyos_conf_scripts_dir}/protocols_static.py $VAR(../../@)">
                 <properties>
                   <help>Static route parameters</help>
diff --git a/smoketest/scripts/cli/test_protocols_ospfv3.py b/smoketest/scripts/cli/test_protocols_ospfv3.py
index 8e12990d5..f0557f640 100755
--- a/smoketest/scripts/cli/test_protocols_ospfv3.py
+++ b/smoketest/scripts/cli/test_protocols_ospfv3.py
@@ -167,5 +167,44 @@ class TestProtocolsOSPFv3(VyOSUnitTestSHIM.TestCase):
         self.assertIn(f' area {area_stub} stub', frrconfig)
         self.assertIn(f' area {area_stub_nosum} stub no-summary', frrconfig)
 
+
+    def test_ospfv3_06_vrfs(self):
+        # It is safe to assume that when the basic VRF test works, all
+        # other OSPF related features work, as we entirely inherit the CLI
+        # templates and Jinja2 FRR template.
+        table = '1000'
+        vrf = 'blue'
+        vrf_base = ['vrf', 'name', vrf]
+        vrf_iface = 'eth1'
+        router_id = '1.2.3.4'
+        router_id_vrf = '1.2.3.5'
+
+        self.cli_set(vrf_base + ['table', table])
+        self.cli_set(vrf_base + ['protocols', 'ospfv3', 'interface', vrf_iface, 'bfd'])
+        self.cli_set(vrf_base + ['protocols', 'ospfv3', 'parameters', 'router-id', router_id_vrf])
+
+        self.cli_set(['interfaces', 'ethernet', vrf_iface, 'vrf', vrf])
+
+        # Also set a default VRF OSPF config
+        self.cli_set(base_path + ['parameters', 'router-id', router_id])
+        self.cli_commit()
+
+        # Verify FRR ospfd configuration
+        frrconfig = self.getFRRconfig('router ospf6')
+        self.assertIn(f'router ospf6', frrconfig)
+        self.assertIn(f' ospf6 router-id {router_id}', frrconfig)
+
+        frrconfig = self.getFRRconfig(f'interface {vrf_iface} vrf {vrf}')
+        self.assertIn(f'interface {vrf_iface} vrf {vrf}', frrconfig)
+        self.assertIn(f' ipv6 ospf6 bfd', frrconfig)
+
+        frrconfig = self.getFRRconfig(f'router ospf6 vrf {vrf}')
+        self.assertIn(f'router ospf6 vrf {vrf}', frrconfig)
+        self.assertIn(f' ospf6 router-id {router_id_vrf}', frrconfig)
+
+        # cleanup
+        self.cli_delete(['vrf', 'name', vrf])
+        self.cli_delete(['interfaces', 'ethernet', vrf_iface, 'vrf'])
+
 if __name__ == '__main__':
     unittest.main(verbosity=2)
diff --git a/src/conf_mode/protocols_ospfv3.py b/src/conf_mode/protocols_ospfv3.py
index f1e490f48..d0460b830 100755
--- a/src/conf_mode/protocols_ospfv3.py
+++ b/src/conf_mode/protocols_ospfv3.py
@@ -17,6 +17,7 @@
 import os
 
 from sys import exit
+from sys import argv
 
 from vyos.config import Config
 from vyos.configdict import dict_merge
@@ -24,6 +25,7 @@ from vyos.configdict import node_changed
 from vyos.configverify import verify_common_route_maps
 from vyos.template import render_to_string
 from vyos.ifconfig import Interface
+from vyos.util import get_interface_config
 from vyos.xml import defaults
 from vyos import ConfigError
 from vyos import frr
@@ -35,9 +37,22 @@ def get_config(config=None):
         conf = config
     else:
         conf = Config()
-    base = ['protocols', 'ospfv3']
+
+    vrf = None
+    if len(argv) > 1:
+        vrf = argv[1]
+
+    base_path = ['protocols', 'ospfv3']
+
+    # 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
@@ -69,12 +84,22 @@ def verify(ospfv3):
     verify_common_route_maps(ospfv3)
 
     if 'interface' in ospfv3:
-        for ifname, if_config in ospfv3['interface'].items():
-            if 'ifmtu' in if_config:
-                mtu = Interface(ifname).get_mtu()
-                if int(if_config['ifmtu']) > int(mtu):
+        for interface, interface_config in ospfv3['interface'].items():
+            if 'ifmtu' in interface_config:
+                mtu = Interface(interface).get_mtu()
+                if int(interface_config['ifmtu']) > int(mtu):
                     raise ConfigError(f'OSPFv3 ifmtu can not exceed physical MTU of "{mtu}"')
 
+            # If interface specific options are set, we must ensure that the
+            # 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']
+                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):
@@ -89,14 +114,21 @@ 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(ospf6_daemon)
-    frr_cfg.modify_section('^router ospf6', stop_pattern='^exit', remove_stop_mark=True)
+    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)
+            frr_cfg.modify_section(f'^interface {interface}{vrf}', 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'])