From 54c36e435049ed8f7f248adab171cb114eab1e10 Mon Sep 17 00:00:00 2001
From: Christian Breunig <christian@breunig.cc>
Date: Sat, 25 Feb 2023 22:40:12 +0100
Subject: tunnel: T5034: migrate "multicast enable" CLI node to
 enable-multicast

Tunnel interface multicast settings can be "enabled or disabled". As we prefer
valueless nodes, and the linux kernel default is "disabled" we should add a

set interfaces tunnel tunXX enable-multicast

command
---
 .../include/version/interfaces-version.xml.i       |  2 +-
 interface-definitions/interfaces-tunnel.xml.in     | 20 ++------
 python/vyos/ifconfig/tunnel.py                     | 22 +++------
 src/migration-scripts/interfaces/27-to-28          | 55 ++++++++++++++++++++++
 4 files changed, 66 insertions(+), 33 deletions(-)
 create mode 100755 src/migration-scripts/interfaces/27-to-28

diff --git a/interface-definitions/include/version/interfaces-version.xml.i b/interface-definitions/include/version/interfaces-version.xml.i
index a351515f1..e5e81d316 100644
--- a/interface-definitions/include/version/interfaces-version.xml.i
+++ b/interface-definitions/include/version/interfaces-version.xml.i
@@ -1,3 +1,3 @@
 <!-- include start from include/version/interfaces-version.xml.i -->
-<syntaxVersion component='interfaces' version='27'></syntaxVersion>
+<syntaxVersion component='interfaces' version='28'></syntaxVersion>
 <!-- include end -->
diff --git a/interface-definitions/interfaces-tunnel.xml.in b/interface-definitions/interfaces-tunnel.xml.in
index 17fe1e285..58f95dddb 100644
--- a/interface-definitions/interfaces-tunnel.xml.in
+++ b/interface-definitions/interfaces-tunnel.xml.in
@@ -106,24 +106,10 @@
             </properties>
           </leafNode>
           #include <include/interface/mirror.xml.i>
-          <leafNode name="multicast">
+          <leafNode name="enable-multicast">
             <properties>
-              <help>Multicast operation over tunnel</help>
-              <completionHelp>
-                <list>enable disable</list>
-              </completionHelp>
-              <valueHelp>
-                <format>enable</format>
-                <description>Enable multicast</description>
-              </valueHelp>
-              <valueHelp>
-                <format>disable</format>
-                <description>Disable multicast (default)</description>
-              </valueHelp>
-              <constraint>
-                <regex>(enable|disable)</regex>
-              </constraint>
-              <constraintErrorMessage>Must be 'disable' or 'enable'</constraintErrorMessage>
+              <help>Enable multicast operation over tunnel</help>
+              <valueless/>
             </properties>
           </leafNode>
           <node name="parameters">
diff --git a/python/vyos/ifconfig/tunnel.py b/python/vyos/ifconfig/tunnel.py
index f776240a1..b7bf7d982 100644
--- a/python/vyos/ifconfig/tunnel.py
+++ b/python/vyos/ifconfig/tunnel.py
@@ -83,11 +83,6 @@ class TunnelIf(Interface):
                 'convert': enable_to_on,
                 'shellcmd': 'ip link set dev {ifname} multicast {value}',
             },
-            'allmulticast': {
-                'validate': lambda v: assert_list(v, ['enable', 'disable']),
-                'convert': enable_to_on,
-                'shellcmd': 'ip link set dev {ifname} allmulticast {value}',
-            },
         }
     }
 
@@ -162,14 +157,9 @@ class TunnelIf(Interface):
         """ Get a synthetic MAC address. """
         return self.get_mac_synthetic()
 
-    def set_multicast(self):
-        """ Set multicast """
-        if self.config.get('multicast', 'disable') == 'enable':
-            cmd = 'ip link set dev {ifname} multicast on'
-        else:
-            cmd = 'ip link set dev {ifname} multicast off'
-
-        self._cmd(cmd.format(**self.config))
+    def set_multicast(self, enable):
+        """ Change the MULTICAST flag on the device """
+        return self.set_interface('multicast', enable)
 
     def update(self, config):
         """ General helper function which works on a dictionary retrived by
@@ -179,8 +169,10 @@ class TunnelIf(Interface):
         # Adjust iproute2 tunnel parameters if necessary
         self._change_options()
 
-        # Add multicast
-        self.set_multicast()
+        # IP Multicast
+        tmp = dict_search('enable_multicast', config)
+        value = 'enable' if (tmp != None) else 'disable'
+        self.set_multicast(value)
 
         # call base class first
         super().update(config)
diff --git a/src/migration-scripts/interfaces/27-to-28 b/src/migration-scripts/interfaces/27-to-28
new file mode 100755
index 000000000..6225d6414
--- /dev/null
+++ b/src/migration-scripts/interfaces/27-to-28
@@ -0,0 +1,55 @@
+#!/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/>.
+
+# T5034: tunnel: rename "multicast enable" CLI node to "enable-multicast"
+#        valueless node.
+
+from sys import argv
+
+from vyos.ethtool import Ethtool
+from vyos.configtree import ConfigTree
+
+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()
+
+base = ['interfaces', 'tunnel']
+config = ConfigTree(config_file)
+
+if not config.exists(base):
+    exit(0)
+
+for ifname in config.list_nodes(base):
+    print(ifname)
+    multicast_base = base + [ifname, 'multicast']
+    if config.exists(multicast_base):
+        tmp = config.return_value(multicast_base)
+        print(tmp)
+        # Delete old Config node
+        config.delete(multicast_base)
+        if tmp == 'enable':
+            config.set(base + [ifname, 'enable-multicast'])
+
+try:
+    with open(file_name, 'w') as f:
+        f.write(config.to_string())
+except OSError as e:
+    print(f'Failed to save the modified config: {e}')
+    exit(1)
-- 
cgit v1.2.3