ospf: T3236: provide full protocol support in XML and Python

This commit provides the implementation of the OSPF CLI with a Jinja2 template
that is loaded by FRR reload. It also contains some initial smoketests.

There is yet no verify() implementation!

2 files changed, 411 insertions, 0 deletions

diff --git a/smoketest/configs/ospf-config b/smoketest/configs/ospf-config
new file mode 100644
index 000000000..9e18e6155
--- /dev/null
+++ b/smoketest/configs/ospf-config
@@ -0,0 +1,115 @@
+interfaces {
+    dummy dum0 {
+        address 172.18.254.201/32
+    }
+    ethernet eth0 {
+        duplex auto
+        smp-affinity auto
+        speed auto
+        vif 201 {
+            address 172.18.201.10/24
+            ip {
+                ospf {
+                    authentication {
+                        md5 {
+                            key-id 10 {
+                                md5-key OSPFVyOSNET
+                            }
+                        }
+                    }
+                    dead-interval 40
+                    hello-interval 10
+                    priority 1
+                    retransmit-interval 5
+                    transmit-delay 1
+                }
+            }
+        }
+    }
+    ethernet eth1 {
+        duplex auto
+        smp-affinity auto
+        speed auto
+    }
+}
+protocols {
+    ospf {
+        area 0 {
+            network 172.18.201.0/24
+            network 172.18.254.201/32
+        }
+        log-adjacency-changes {
+        }
+        parameters {
+            abr-type cisco
+            router-id 172.18.254.201
+        }
+        passive-interface default
+        passive-interface-exclude eth0.201
+    }
+    static {
+        route 0.0.0.0/0 {
+            next-hop 172.18.201.254 {
+                distance 10
+            }
+        }
+    }
+}
+service {
+    lldp {
+        interface all {
+        }
+    }
+    snmp {
+        community public {
+            authorization ro
+            network 172.16.100.0/24
+        }
+        contact "VyOS maintainers and contributors <maintainers@vyos.io>"
+        location "Jenkins"
+    }
+    ssh {
+        disable-host-validation
+        port 22
+    }
+}
+system {
+    config-management {
+        commit-revisions 200
+    }
+    domain-name vyos.net
+    host-name vyos
+    login {
+        user vyos {
+            authentication {
+                encrypted-password $6$2Ta6TWHd/U$NmrX0x9kexCimeOcYK1MfhMpITF9ELxHcaBU/znBq.X2ukQOj61fVI2UYP/xBzP4QtiTcdkgs7WOQMHWsRymO/
+                plaintext-password ""
+            }
+            level admin
+        }
+    }
+    name-server 172.16.254.30
+    ntp {
+        server 0.pool.ntp.org {
+        }
+        server 1.pool.ntp.org {
+        }
+        server 2.pool.ntp.org {
+        }
+    }
+    syslog {
+        global {
+            facility all {
+                level info
+            }
+            facility protocols {
+                level debug
+            }
+        }
+    }
+    time-zone Europe/Berlin
+}
+
+/* Warning: Do not remove the following line. */
+/* === vyatta-config-version: "broadcast-relay@1:cluster@1:config-management@1:conntrack-sync@1:conntrack@1:dhcp-relay@2:dhcp-server@5:dns-forwarding@1:firewall@5:ipsec@5:l2tp@1:mdns@1:nat@4:ntp@1:pptp@1:qos@1:quagga@6:snmp@1:ssh@1:system@9:vrrp@2:wanloadbalance@3:webgui@1:webproxy@1:webproxy@2:zone-policy@1" === */
+/* Release version: 1.2.6 */
diff --git a/smoketest/scripts/cli/test_protocols_ospf.py b/smoketest/scripts/cli/test_protocols_ospf.py
new file mode 100755
index 000000000..f5fc75084
--- /dev/null
+++ b/smoketest/scripts/cli/test_protocols_ospf.py
@@ -0,0 +1,296 @@
+#!/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
+import unittest
+
+from vyos.configsession import ConfigSession
+from vyos.ifconfig import Section
+from vyos.util import cmd
+from vyos.util import process_named_running
+
+PROCESS_NAME = 'ospfd'
+base_path = ['protocols', 'ospf']
+
+route_map = 'foobarbaz'
+route_map_seq = '10'
+
+def getFRROSPFconfig():
+    return cmd('vtysh -c "show run" | sed -n "/router ospf/,/^!/p"')
+
+class TestProtocolsOSPF(unittest.TestCase):
+    def setUp(self):
+        self.session = ConfigSession(os.getpid())
+        self.session.set(['policy', 'route-map', route_map, 'rule', route_map_seq, 'action', 'permit'])
+
+    def tearDown(self):
+        self.session.delete(['policy', 'route-map', route_map])
+        self.session.delete(base_path)
+        self.session.commit()
+        del self.session
+
+    def test_ospf_01_defaults(self):
+        # commit changes
+        self.session.set(base_path)
+        self.session.commit()
+
+        # Verify FRR ospfd configuration
+        frrconfig = getFRROSPFconfig()
+        self.assertIn(f'router ospf', frrconfig)
+        self.assertIn(f' auto-cost reference-bandwidth 100', frrconfig)
+        self.assertIn(f' timers throttle spf 200 1000 10000', frrconfig) # defaults
+
+        # Check for running process
+        self.assertTrue(process_named_running(PROCESS_NAME))
+
+    def test_ospf_02_simple(self):
+        router_id = '127.0.0.1'
+        abr_type = 'ibm'
+        bandwidth = '1000'
+        metric = '123'
+
+        self.session.set(base_path + ['auto-cost', 'reference-bandwidth', bandwidth])
+        self.session.set(base_path + ['parameters', 'router-id', router_id])
+        self.session.set(base_path + ['parameters', 'abr-type', abr_type])
+        self.session.set(base_path + ['log-adjacency-changes', 'detail'])
+        self.session.set(base_path + ['default-metric', metric])
+
+        # commit changes
+        self.session.commit()
+
+        # Verify FRR ospfd configuration
+        frrconfig = getFRROSPFconfig()
+        self.assertIn(f'router ospf', frrconfig)
+        self.assertIn(f' auto-cost reference-bandwidth {bandwidth}', frrconfig)
+        self.assertIn(f' ospf router-id {router_id}', frrconfig)
+        self.assertIn(f' ospf abr-type {abr_type}', frrconfig)
+        self.assertIn(f' timers throttle spf 200 1000 10000', frrconfig) # defaults
+        self.assertIn(f' default-metric {metric}', frrconfig)
+
+        # Check for running process
+        self.assertTrue(process_named_running(PROCESS_NAME))
+
+    def test_ospf_03_access_list(self):
+        acl = '100'
+        seq = '10'
+        protocols = ['bgp', 'connected', 'kernel', 'rip', 'static']
+
+        self.session.set(['policy', 'access-list', acl, 'rule', seq, 'action', 'permit'])
+        self.session.set(['policy', 'access-list', acl, 'rule', seq, 'source', 'any'])
+        self.session.set(['policy', 'access-list', acl, 'rule', seq, 'destination', 'any'])
+        for ptotocol in protocols:
+            self.session.set(base_path + ['access-list', acl, 'export', ptotocol])
+
+        # commit changes
+        self.session.commit()
+
+        # Verify FRR ospfd configuration
+        frrconfig = getFRROSPFconfig()
+        self.assertIn(f'router ospf', frrconfig)
+        self.assertIn(f' timers throttle spf 200 1000 10000', frrconfig) # defaults
+        for ptotocol in protocols:
+            self.assertIn(f' distribute-list {acl} out {ptotocol}', frrconfig) # defaults
+
+        # Check for running process
+        self.assertTrue(process_named_running(PROCESS_NAME))
+
+        self.session.delete(['policy', 'access-list', acl])
+
+    def test_ospf_04_default_originate(self):
+        seq = '100'
+        metric = '50'
+        metric_type = '1'
+
+        self.session.set(base_path + ['default-information', 'originate', 'metric', metric])
+        self.session.set(base_path + ['default-information', 'originate', 'metric-type', metric_type])
+        self.session.set(base_path + ['default-information', 'originate', 'route-map', route_map])
+
+        # commit changes
+        self.session.commit()
+
+        # Verify FRR ospfd configuration
+        frrconfig = getFRROSPFconfig()
+        self.assertIn(f'router ospf', frrconfig)
+        self.assertIn(f' timers throttle spf 200 1000 10000', frrconfig) # defaults
+        self.assertIn(f' default-information originate metric {metric} metric-type {metric_type} route-map {route_map}', frrconfig)
+
+        # Now set 'always'
+        self.session.set(base_path + ['default-information', 'originate', 'always'])
+        self.session.commit()
+
+        # Verify FRR ospfd configuration
+        frrconfig = getFRROSPFconfig()
+        self.assertIn(f' default-information originate always metric {metric} metric-type {metric_type} route-map {route_map}', frrconfig)
+
+        # Check for running process
+        self.assertTrue(process_named_running(PROCESS_NAME))
+
+    def test_ospf_05_options(self):
+        global_distance = '128'
+        intra_area = '100'
+        inter_area = '110'
+        external = '120'
+        on_startup = '30'
+        on_shutdown = '60'
+        refresh = '50'
+
+        self.session.set(base_path + ['distance', 'global', global_distance])
+        self.session.set(base_path + ['distance', 'ospf', 'external', external])
+        self.session.set(base_path + ['distance', 'ospf', 'intra-area', intra_area])
+
+        self.session.set(base_path + ['max-metric', 'router-lsa', 'on-startup', on_startup])
+        self.session.set(base_path + ['max-metric', 'router-lsa', 'on-shutdown', on_shutdown])
+
+        self.session.set(base_path + ['mpls-te', 'enable'])
+        self.session.set(base_path + ['refresh', 'timers', refresh])
+
+        # commit changes
+        self.session.commit()
+
+        # Verify FRR ospfd configuration
+        frrconfig = getFRROSPFconfig()
+        self.assertIn(f'router ospf', frrconfig)
+        self.assertIn(f' mpls-te on', frrconfig)
+        self.assertIn(f' mpls-te router-address 0.0.0.0', frrconfig) # default
+        self.assertIn(f' distance {global_distance}', frrconfig)
+        self.assertIn(f' distance ospf intra-area {intra_area} external {external}', frrconfig)
+        self.assertIn(f' max-metric router-lsa on-startup {on_startup}', frrconfig)
+        self.assertIn(f' max-metric router-lsa on-shutdown {on_shutdown}', frrconfig)
+        self.assertIn(f' refresh timer {refresh}', frrconfig)
+
+
+        # enable inter-area
+        self.session.set(base_path + ['distance', 'ospf', 'inter-area', inter_area])
+        self.session.commit()
+
+        frrconfig = getFRROSPFconfig()
+        self.assertIn(f' distance ospf intra-area {intra_area} inter-area {inter_area} external {external}', frrconfig)
+
+        # Check for running process
+        self.assertTrue(process_named_running(PROCESS_NAME))
+
+    def test_ospf_06_neighbor(self):
+        priority = '10'
+        poll_interval = '20'
+        neighbors = ['1.1.1.1', '2.2.2.2', '3.3.3.3']
+        for neighbor in neighbors:
+            self.session.set(base_path + ['neighbor', neighbor, 'priority', priority])
+            self.session.set(base_path + ['neighbor', neighbor, 'poll-interval', poll_interval])
+
+        # commit changes
+        self.session.commit()
+
+        # Verify FRR ospfd configuration
+        frrconfig = getFRROSPFconfig()
+        self.assertIn(f'router ospf', frrconfig)
+        for neighbor in neighbors:
+            self.assertIn(f' neighbor {neighbor} priority {priority} poll-interval {poll_interval}', frrconfig) # default
+
+        # Check for running process
+        self.assertTrue(process_named_running(PROCESS_NAME))
+
+    def test_ospf_07_passive_interface(self):
+        self.session.set(base_path + ['passive-interface', 'default'])
+        interfaces = Section.interfaces('ethernet')
+        for interface in interfaces:
+            self.session.set(base_path + ['passive-interface-exclude', interface])
+
+        # commit changes
+        self.session.commit()
+
+        # Verify FRR ospfd configuration
+        frrconfig = getFRROSPFconfig()
+        self.assertIn(f'router ospf', frrconfig)
+        self.assertIn(f' passive-interface default', frrconfig) # default
+        for interface in interfaces:
+            self.assertIn(f' no passive-interface {interface}', frrconfig) # default
+
+        # Check for running process
+        self.assertTrue(process_named_running(PROCESS_NAME))
+
+    def test_ospf_08_redistribute(self):
+        metric = '15'
+        metric_type = '1'
+        redistribute = ['bgp', 'connected', 'kernel', 'rip', 'static']
+
+        for protocol in redistribute:
+            self.session.set(base_path + ['redistribute', protocol, 'metric', metric])
+            self.session.set(base_path + ['redistribute', protocol, 'route-map', route_map])
+            if protocol not in ['kernel', 'static']:
+                self.session.set(base_path + ['redistribute', protocol, 'metric-type', metric_type])
+
+        # commit changes
+        self.session.commit()
+
+        # Verify FRR ospfd configuration
+        frrconfig = getFRROSPFconfig()
+        self.assertIn(f'router ospf', frrconfig)
+        for protocol in redistribute:
+            if protocol in ['kernel', 'static']:
+                self.assertIn(f' redistribute {protocol} metric {metric} route-map {route_map}', frrconfig)
+            else:
+                self.assertIn(f' redistribute {protocol} metric {metric} metric-type {metric_type} route-map {route_map}', frrconfig)
+
+        # Check for running process
+        self.assertTrue(process_named_running(PROCESS_NAME))
+
+    def test_ospf_09_area(self):
+        area = '0'
+        networks = ['10.0.0.0/8', '172.16.0.0/12', '192.168.0.0/16']
+        for network in networks:
+            self.session.set(base_path + ['area', area, 'network', network])
+
+        # commit changes
+        self.session.commit()
+
+        # Verify FRR ospfd configuration
+        frrconfig = getFRROSPFconfig()
+        self.assertIn(f'router ospf', frrconfig)
+        for network in networks:
+            self.assertIn(f' network {network} area {area}', frrconfig)
+
+        # Check for running process
+        self.assertTrue(process_named_running(PROCESS_NAME))
+
+    def test_ospf_10_virtual_link(self):
+        area = '10'
+        shortcut = 'enable'
+        virtual_link = '192.0.2.1'
+        hello = '6'
+        retransmit = '5'
+        transmit = '5'
+        dead = '40'
+
+        self.session.set(base_path + ['area', area, 'shortcut', shortcut])
+        self.session.set(base_path + ['area', area, 'virtual-link', virtual_link, 'hello-interval', hello])
+        self.session.set(base_path + ['area', area, 'virtual-link', virtual_link, 'retransmit-interval', retransmit])
+        self.session.set(base_path + ['area', area, 'virtual-link', virtual_link, 'transmit-delay', transmit])
+        self.session.set(base_path + ['area', area, 'virtual-link', virtual_link, 'dead-interval', dead])
+
+        # commit changes
+        self.session.commit()
+
+        # Verify FRR ospfd configuration
+        frrconfig = getFRROSPFconfig()
+        self.assertIn(f'router ospf', frrconfig)
+        self.assertIn(f' area {area} shortcut {shortcut}', frrconfig)
+        self.assertIn(f' area {area} virtual-link {virtual_link} hello-interval {hello} retransmit-interval {retransmit} transmit-delay {transmit} dead-interval {dead}', frrconfig)
+
+        # Check for running process
+        self.assertTrue(process_named_running(PROCESS_NAME))
+
+if __name__ == '__main__':
+    unittest.main(verbosity=2)