igmp: T5736: migrate "protocols igmp" to "protocols pim"

IGMP and PIM are two different but related things.

FRR has both combined in pimd. As we use get_config_dict() and FRR reload it
is better to have both centrally stored under the same CLI node (as FRR does,
too) to just "fire and forget" the commit to the daemon.

"set protocols igmp interface eth1" -> "set protocols pim interface eth1 igmp"

3 files changed, 90 insertions, 156 deletions

diff --git a/src/conf_mode/protocols_igmp.py b/src/conf_mode/protocols_igmp.py
deleted file mode 100755
index 435189025..000000000
--- a/src/conf_mode/protocols_igmp.py
+++ /dev/null
@@ -1,140 +0,0 @@
-#!/usr/bin/env python3
-#
-# Copyright (C) 2020-2023 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 ipaddress import IPv4Address
-from sys import exit
-
-from vyos import ConfigError
-from vyos.config import Config
-from vyos.utils.process import process_named_running
-from vyos.utils.process import call
-from vyos.template import render
-from signal import SIGTERM
-
-from vyos import airbag
-airbag.enable()
-
-# Required to use the full path to pimd, in another case daemon will not be started
-pimd_cmd = f'/usr/lib/frr/pimd -d -F traditional --daemon -A 127.0.0.1'
-
-config_file = r'/tmp/igmp.frr'
-
-def get_config(config=None):
-    if config:
-        conf = config
-    else:
-        conf = Config()
-    igmp_conf = {
-        'igmp_conf' : False,
-        'pim_conf'  : False,
-        'igmp_proxy_conf' : False,
-        'old_ifaces'    : {},
-        'ifaces'    : {}
-    }
-    if not (conf.exists('protocols igmp') or conf.exists_effective('protocols igmp')):
-        return None
-
-    if conf.exists('protocols igmp-proxy'):
-        igmp_conf['igmp_proxy_conf'] = True
-
-    if conf.exists('protocols pim'):
-        igmp_conf['pim_conf'] = True
-
-    if conf.exists('protocols igmp'):
-        igmp_conf['igmp_conf'] = True
-
-    conf.set_level('protocols igmp')
-
-    # # Get interfaces
-    for iface in conf.list_effective_nodes('interface'):
-        igmp_conf['old_ifaces'].update({
-            iface : {
-                'version' : conf.return_effective_value('interface {0} version'.format(iface)),
-                'query_interval' : conf.return_effective_value('interface {0} query-interval'.format(iface)),
-                'query_max_resp_time' : conf.return_effective_value('interface {0} query-max-response-time'.format(iface)),
-                'gr_join' : {}
-            }
-        })
-        for gr_join in conf.list_effective_nodes('interface {0} join'.format(iface)):
-            igmp_conf['old_ifaces'][iface]['gr_join'][gr_join] = conf.return_effective_values('interface {0} join {1} source'.format(iface, gr_join))
-
-    for iface in conf.list_nodes('interface'):
-        igmp_conf['ifaces'].update({
-            iface : {
-                'version' : conf.return_value('interface {0} version'.format(iface)),
-                'query_interval' : conf.return_value('interface {0} query-interval'.format(iface)),
-                'query_max_resp_time' : conf.return_value('interface {0} query-max-response-time'.format(iface)),
-                'gr_join' : {}
-            }
-        })
-        for gr_join in conf.list_nodes('interface {0} join'.format(iface)):
-            igmp_conf['ifaces'][iface]['gr_join'][gr_join] = conf.return_values('interface {0} join {1} source'.format(iface, gr_join))
-
-    return igmp_conf
-
-def verify(igmp):
-    if igmp is None:
-        return None
-
-    if igmp['igmp_conf']:
-        # Check conflict with IGMP-Proxy
-        if igmp['igmp_proxy_conf']:
-            raise ConfigError(f"IGMP proxy and PIM cannot be both configured at the same time")
-
-        # Check interfaces
-        if not igmp['ifaces']:
-            raise ConfigError(f"IGMP require defined interfaces!")
-        # Check, is this multicast group
-        for intfc in igmp['ifaces']:
-            for gr_addr in igmp['ifaces'][intfc]['gr_join']:
-                if not IPv4Address(gr_addr).is_multicast:
-                    raise ConfigError(gr_addr + " not a multicast group")
-
-def generate(igmp):
-    if igmp is None:
-        return None
-
-    render(config_file, 'frr/igmp.frr.j2', igmp)
-    return None
-
-def apply(igmp):
-    if igmp is None:
-        return None
-
-    pim_pid = process_named_running('pimd')
-    if igmp['igmp_conf'] or igmp['pim_conf']:
-        if not pim_pid:
-            call(pimd_cmd)
-
-        if os.path.exists(config_file):
-            call(f'vtysh -d pimd -f {config_file}')
-            os.remove(config_file)
-    elif pim_pid:
-        os.kill(int(pim_pid), SIGTERM)
-
-    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/conf_mode/protocols_pim.py b/src/conf_mode/protocols_pim.py
index 89db69b87..fbe95c404 100755
--- a/src/conf_mode/protocols_pim.py
+++ b/src/conf_mode/protocols_pim.py
@@ -93,22 +93,24 @@ def verify(pim):
     if 'interface' not in pim:
         raise ConfigError('PIM require defined interfaces!')
 
-    if dict_search('rp.address', pim) == None:
-        raise ConfigError('PIM rendezvous point needs to be defined!')
-
-    # Check unique multicast groups
-    unique = []
-    for address, address_config in pim['rp']['address'].items():
-        if 'group' not in address_config:
-            raise ConfigError(f'PIM rendezvous point group should be defined for "{address}"!')
-
-        # Check if it is a multicast group
-        for gr_addr in address_config['group']:
-            if not IPv4Network(gr_addr).is_multicast:
-                raise ConfigError(f'PIM rendezvous point group "{gr_addr}" is not a multicast group!')
-            if gr_addr in unique:
-                raise ConfigError('PIM rendezvous point group must be unique!')
-            unique.append(gr_addr)
+    if 'rp' in pim:
+        if 'address' not in pim['rp']:
+            raise ConfigError('PIM rendezvous point needs to be defined!')
+
+        # Check unique multicast groups
+        unique = []
+        pim_base_error = 'PIM rendezvous point group'
+        for address, address_config in pim['rp']['address'].items():
+            if 'group' not in address_config:
+                raise ConfigError(f'{pim_base_error} should be defined for "{address}"!')
+
+            # Check if it is a multicast group
+            for gr_addr in address_config['group']:
+                if not IPv4Network(gr_addr).is_multicast:
+                    raise ConfigError(f'{pim_base_error} "{gr_addr}" is not a multicast group!')
+                if gr_addr in unique:
+                    raise ConfigError(f'{pim_base_error} must be unique!')
+                unique.append(gr_addr)
 
 def generate(pim):
     if not pim or 'deleted' in pim:
diff --git a/src/migration-scripts/pim/0-to-1 b/src/migration-scripts/pim/0-to-1
new file mode 100755
index 000000000..bf8af733c
--- /dev/null
+++ b/src/migration-scripts/pim/0-to-1
@@ -0,0 +1,72 @@
+#!/usr/bin/env python3
+#
+# Copyright (C) 2023 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/>.
+
+# T5736: igmp: migrate "protocols igmp" to "protocols pim"
+
+import sys
+from vyos.configtree import ConfigTree
+
+if len(sys.argv) < 2:
+    print("Must specify file name!")
+    sys.exit(1)
+
+file_name = sys.argv[1]
+
+with open(file_name, 'r') as f:
+    config_file = f.read()
+
+config = ConfigTree(config_file)
+
+base = ['protocols', 'igmp']
+pim_base = ['protocols', 'pim']
+if not config.exists(base):
+    # Nothing to do
+    sys.exit(0)
+
+for interface in config.list_nodes(base + ['interface']):
+    base_igmp_iface = base + ['interface', interface]
+    pim_base_iface = pim_base + ['interface', interface]
+
+    # Create IGMP note under PIM interface
+    if not config.exists(pim_base_iface + ['igmp']):
+        config.set(pim_base_iface + ['igmp'])
+
+    if config.exists(base_igmp_iface + ['join']):
+        config.copy(base_igmp_iface + ['join'], pim_base_iface + ['igmp', 'join'])
+        config.set_tag(pim_base_iface + ['igmp', 'join'])
+
+        new_join_base = pim_base_iface + ['igmp', 'join']
+        for address in config.list_nodes(new_join_base):
+            if config.exists(new_join_base + [address, 'source']):
+                config.rename(new_join_base + [address, 'source'], 'source-address')
+
+    if config.exists(base_igmp_iface + ['query-interval']):
+        config.copy(base_igmp_iface + ['query-interval'], pim_base_iface + ['igmp', 'query-interval'])
+
+    if config.exists(base_igmp_iface + ['query-max-response-time']):
+        config.copy(base_igmp_iface + ['query-max-response-time'], pim_base_iface + ['igmp', 'query-max-response-time'])
+
+    if config.exists(base_igmp_iface + ['version']):
+        config.copy(base_igmp_iface + ['version'], pim_base_iface + ['igmp', 'version'])
+
+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))
+    sys.exit(1)