ospf: T3267: move "interface ip ospf" configuration to "protocols ospf interface"

For easier maintenance and operability move the interface specific protocol
setting of OSPF to the OSPF protocol section. This is now also in-line with IS-IS.

This means to migrate:
 ethernet eth0 {
    vif 202 {
        ip {
            ospf {
                authentication {
                    md5 {
                        key-id 10 {
                            md5-key vyosvyos
                        }
                    }
                }
                dead-interval 40
                hello-interval 10
                priority 1
                retransmit-interval 5
                transmit-delay 1
            }
        }
    }
 }

to

 protocols {
    ospf {
        interface eth0.201 {
            authentication {
                md5 {
                    key-id 10 {
                        md5-key vyosvyos
                    }
                }
            }
            dead-interval 40
            hello-interval 10
            priority 1
            retransmit-interval 5
            transmit-delay 1
        }
 }

2 files changed, 95 insertions, 0 deletions

diff --git a/src/conf_mode/protocols_ospf.py b/src/conf_mode/protocols_ospf.py
index 7c0ffbd27..a1ca7725f 100755
--- a/src/conf_mode/protocols_ospf.py
+++ b/src/conf_mode/protocols_ospf.py
@@ -21,6 +21,7 @@ from sys import exit
 from vyos.config import Config
 from vyos.configdict import dict_merge
 from vyos.configverify import verify_route_maps
+from vyos.configverify import verify_interface_exists
 from vyos.template import render
 from vyos.template import render_to_string
 from vyos.util import call
@@ -76,6 +77,7 @@ def get_config(config=None):
     # clean them out and add them manually :(
     del default_values['neighbor']
     del default_values['area']['virtual_link']
+    del default_values['interface']
 
     # merge in remaining default values
     ospf = dict_merge(default_values, ospf)
@@ -94,6 +96,12 @@ def get_config(config=None):
                     ospf['area'][area]['virtual_link'][virtual_link] = dict_merge(
                         default_values, ospf['area'][area]['virtual_link'][virtual_link])
 
+    if 'interface' in ospf:
+        default_values = defaults(base + ['interface'])
+        for interface in ospf['interface']:
+            ospf['interface'][interface] = dict_merge(default_values,
+                ospf['interface'][interface])
+
     # We also need some additional information from the config, prefix-lists
     # and route-maps for instance. They will be used in verify()
     base = ['policy']
@@ -108,6 +116,11 @@ def verify(ospf):
         return None
 
     verify_route_maps(ospf)
+
+    if 'interface' in ospf:
+        for interface in ospf['interface']:
+            verify_interface_exists(interface)
+
     return None
 
 def generate(ospf):
diff --git a/src/migration-scripts/interfaces/19-to-20 b/src/migration-scripts/interfaces/19-to-20
new file mode 100755
index 000000000..7ea1ed267
--- /dev/null
+++ b/src/migration-scripts/interfaces/19-to-20
@@ -0,0 +1,82 @@
+#!/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/>.
+
+from sys import exit, argv
+from vyos.configtree import ConfigTree
+
+if __name__ == '__main__':
+    if (len(argv) < 1):
+        print("Must specify file name!")
+        exit(1)
+
+    file_name = argv[1]
+    with open(file_name, 'r') as f:
+        config_file = f.read()
+
+    config = ConfigTree(config_file)
+
+    #
+    # Migrate "interface ethernet eth0 ip ospf" to "protocols ospf interface eth0"
+    #
+    for type in config.list_nodes(['interfaces']):
+        for interface in config.list_nodes(['interfaces', type]):
+
+            ip_ospf = ['interfaces', type, interface, 'ip', 'ospf']
+            if config.exists(ip_ospf):
+                config.set(['protocols', 'ospf', 'interface'])
+                config.set_tag(['protocols', 'ospf', 'interface'])
+                config.copy(ip_ospf, ['protocols', 'ospf', 'interface', interface])
+                config.delete(ip_ospf)
+
+            vif_path = ['interfaces', type, interface, 'vif']
+            if config.exists(vif_path):
+                for vif in config.list_nodes(vif_path):
+                    vif_ospf_path = vif_path + [vif, 'ip', 'ospf']
+                    if config.exists(vif_ospf_path):
+                        config.set(['protocols', 'ospf', 'interface'])
+                        config.set_tag(['protocols', 'ospf', 'interface'])
+                        config.copy(vif_ospf_path, ['protocols', 'ospf', 'interface', f'{interface}.{vif}'])
+                        config.delete(vif_ospf_path)
+
+            vif_s_path = ['interfaces', type, interface, 'vif-s']
+            if config.exists(vif_s_path):
+                for vif_s in config.list_nodes(vif_s_path):
+                    vif_s_ospf_path = vif_s_path + [vif_s, 'ip', 'ospf']
+                    if config.exists(vif_s_ospf_path):
+                        config.set(['protocols', 'ospf', 'interface'])
+                        config.set_tag(['protocols', 'ospf', 'interface'])
+                        config.copy(vif_s_ospf_path, ['protocols', 'ospf', 'interface', f'{interface}.{vif_s}'])
+
+                        vif_c_path = ['interfaces', type, interface, 'vif-s', vif_s, 'vif-c']
+                        if config.exists(vif_c_path):
+                            for vif_c in config.list_nodes(vif_c_path):
+                                vif_c_ospf_path = vif_c_path + [vif_c, 'ip', 'ospf']
+                                print(vif_c_ospf_path)
+                                if config.exists(vif_c_ospf_path):
+                                    config.set(['protocols', 'ospf', 'interface'])
+                                    config.set_tag(['protocols', 'ospf', 'interface'])
+                                    config.copy(vif_c_ospf_path, ['protocols', 'ospf', 'interface', f'{interface}.{vif_s}.{vif_c}'])
+                                    config.delete(vif_c_ospf_path)
+
+                        config.delete(vif_s_ospf_path)
+
+    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)
+