ospf: add skeleton for new XML/Python based implementation

4 files changed, 185 insertions, 0 deletions

diff --git a/Makefile b/Makefile
index 00d7b5e21..2ba640d5b 100644
--- a/Makefile
+++ b/Makefile
@@ -45,6 +45,7 @@ interface_definitions: $(config_xml_obj)
 	rm -f $(TMPL_DIR)/vpn/node.def
 	rm -f $(TMPL_DIR)/vpn/ipsec/node.def
 	rm -rf $(TMPL_DIR)/vpn/nipsec
+	rm -rf $(TMPL_DIR)/vpn/nospf
 
 	# XXX: required until OSPF and RIP is migrated from vyatta-cfg-quagga to vyos-1x
 	mkdir $(TMPL_DIR)/interfaces/loopback/node.tag/ipv6
diff --git a/data/templates/frr/ospf.frr.tmpl b/data/templates/frr/ospf.frr.tmpl
new file mode 100644
index 000000000..465034f15
--- /dev/null
+++ b/data/templates/frr/ospf.frr.tmpl
@@ -0,0 +1,2 @@
+!
+!
diff --git a/interface-definitions/protocols-ospf.xml b/interface-definitions/protocols-ospf.xml
new file mode 100644
index 000000000..13652ad8d
--- /dev/null
+++ b/interface-definitions/protocols-ospf.xml
@@ -0,0 +1,79 @@
+<?xml version="1.0"?>
+<interfaceDefinition>
+  <node name="protocols">
+    <children>
+      <node name="nospf" owner="${vyos_conf_scripts_dir}/protocols_ospf.py">
+        <properties>
+          <help>Open Shortest Path First (OSPF)</help>
+          <priority>620</priority>
+        </properties>
+        <children>
+          <tagNode name="access-list">
+            <properties>
+              <help>Access list to filter networks in routing updates</help>
+              <valueHelp>
+                <format>u32</format>
+                <description>Access-list number</description>
+              </valueHelp>
+              <constraint>
+                <validator name="numeric" argument="--range 0-4294967295"/>
+              </constraint>
+            </properties>
+            <children>
+              <leafNode name="export">
+                <properties>
+                  <help>Filter for outgoing routing update [REQUIRED]</help>
+                  <completionHelp>
+                    <list>bgp connected kernel rip static</list>
+                  </completionHelp>
+                  <valueHelp>
+                    <format>bgp</format>
+                    <description>Filter BGP routes</description>
+                  </valueHelp>
+                  <valueHelp>
+                    <format>connected</format>
+                    <description>Filter connected routes</description>
+                  </valueHelp>
+                  <valueHelp>
+                    <format>kernel</format>
+                    <description>Filter Kernel routes</description>
+                  </valueHelp>
+                  <valueHelp>
+                    <format>rip</format>
+                    <description>Filter RIP routes</description>
+                  </valueHelp>
+                  <valueHelp>
+                    <format>static</format>
+                    <description>Filter static routes</description>
+                  </valueHelp>
+                  <constraint>
+                    <regex>^(bgp|connected|kernel|rip|static)$</regex>
+                  </constraint>
+                  <constraintErrorMessage>Must be bgp, connected, kernel, rip, or static</constraintErrorMessage>
+                  <multi/>
+                </properties>
+              </leafNode>
+            </children>
+          </tagNode>
+          <tagNode name="area">
+            <properties>
+              <help>OSPF Area</help>
+              <valueHelp>
+                <format>u32</format>
+                <description>OSPF area in decimal notation</description>
+              </valueHelp>
+              <valueHelp>
+                <format>ipv4</format>
+                <description>OSPF area in dotted decimal notation</description>
+              </valueHelp>
+              <constraint>
+                <validator name="numeric" argument="--range 0-4294967295"/>
+                <validator name="ip-address"/>
+              </constraint>
+            </properties>
+          </tagNode>
+        </children>
+      </node>
+    </children>
+  </node>
+</interfaceDefinition>
diff --git a/src/conf_mode/protocols_ospf.py b/src/conf_mode/protocols_ospf.py
new file mode 100644
index 000000000..73c244571
--- /dev/null
+++ b/src/conf_mode/protocols_ospf.py
@@ -0,0 +1,103 @@
+#!/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.configdict import dict_merge
+from vyos.template import render
+from vyos.template import render_to_string
+from vyos.util import call
+from vyos.util import dict_search
+from vyos import ConfigError
+from vyos import frr
+from vyos import airbag
+airbag.enable()
+
+config_file = r'/tmp/ospf.frr'
+
+DEBUG = os.path.exists('/tmp/ospf.debug')
+if DEBUG:
+    import logging
+    lg = logging.getLogger("vyos.frr")
+    lg.setLevel(logging.DEBUG)
+    ch = logging.StreamHandler()
+    lg.addHandler(ch)
+
+def get_config():
+    conf = Config()
+    base = ['protocols', 'ospf']
+    ospf = conf.get_config_dict(base, key_mangling=('-', '_'), get_first_key=True)
+    return ospf
+
+def verify(ospf):
+    if not ospf:
+        return None
+
+    return None
+
+def generate(ospf):
+    if not ospf:
+        ospf['new_frr_config'] = ''
+        return None
+
+    # render(config) not needed, its only for debug
+    render(config_file, 'frr/ospf.frr.tmpl', ospf)
+    ospf['new_frr_config'] = render_to_string('frr/ospf.frr.tmpl', ospf)
+
+    return None
+
+def apply(ospf):
+    # Save original configuration prior to starting any commit actions
+    frr_cfg = frr.FRRConfig()
+    frr_cfg.load_configuration(daemon='ospfd')
+    frr_cfg.modify_section(f'router ospf', '')
+
+    # Debugging
+    if DEBUG:
+        from pprint import pprint
+        print('')
+        print('--------- DEBUGGING ----------')
+        pprint(dir(frr_cfg))
+        print('Existing config:\n')
+        for line in frr_cfg.original_config:
+            print(line)
+        print(f'Replacement config:\n')
+        print(f'{ospf["new_frr_config"]}')
+        print(f'Modified config:\n')
+        print(f'{frr_cfg}')
+
+    frr_cfg.commit_configuration(daemon='ospfd')
+
+    # 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 ospf['new_frr_config'] == '':
+        for a in range(5):
+            frr_cfg.commit_configuration(daemon='ospfd')
+
+    return None
+
+if __name__ == '__main__':
+    try:
+        c = get_config()
+        verify(c)
+        generate(c)
+        apply(c)
+    except ConfigError as e:
+        print(e)
+        exit(1)