Add vyos-vpp CLI and python3 modules

1 files changed, 153 insertions, 0 deletions

diff --git a/src/conf_mode/vpp_interfaces_loopback.py b/src/conf_mode/vpp_interfaces_loopback.py
new file mode 100644
index 000000000..67fd049f0
--- /dev/null
+++ b/src/conf_mode/vpp_interfaces_loopback.py
@@ -0,0 +1,153 @@
+#!/usr/bin/env python3
+#
+# Copyright (C) 2023 VyOS Inc.
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# 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, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+import os
+
+from vyos import ConfigError
+
+from vyos.config import Config
+from vyos.configdict import leaf_node_changed
+from vyos.configdep import set_dependents, call_dependents
+from vyos.template import is_interface
+
+from vyos.vpp.interface import LoopbackInterface
+from vyos.vpp.config_verify import (
+    verify_vpp_remove_kernel_interface,
+    verify_vpp_change_kernel_interface,
+    verify_vpp_exists_kernel_interface,
+)
+from vyos.vpp.utils import cli_ifaces_lcp_kernel_list
+
+
+def get_config(config=None, recursive_defaults=True) -> dict:
+    """Get Loopback interface configuration
+
+    Args:
+        config (vyos.config.Config, optional): The VyOS configuration dictionary
+        recursive_defaults (bool, optional): Include recursive defaults
+    Returns:
+        dict: Loopback interface configuration
+    """
+    if config:
+        conf = config
+    else:
+        conf = Config()
+
+    base = ['vpp', 'interfaces', 'loopback']
+    base_kernel_interfaces = ['vpp', 'kernel-interfaces']
+
+    ifname = os.environ['VYOS_TAGNODE_VALUE']
+
+    # Get config_dict with default values
+    config = conf.get_config_dict(
+        base + [ifname],
+        key_mangling=('-', '_'),
+        get_first_key=True,
+        no_tag_node_value_mangle=True,
+        with_defaults=True,
+        with_recursive_defaults=recursive_defaults,
+    )
+
+    # Get effective config as we need full dicitonary per interface delete
+    effective_config = conf.get_config_dict(
+        base + [ifname],
+        key_mangling=('-', '_'),
+        effective=True,
+        get_first_key=True,
+        no_tag_node_value_mangle=True,
+    )
+
+    if effective_config:
+        config.update({'effective': effective_config})
+
+    if not conf.exists(base + [ifname]):
+        config['remove'] = True
+
+    # Get global 'vpp kernel-interfaces' for verify
+    config['vpp_kernel_interfaces'] = conf.get_config_dict(
+        base_kernel_interfaces,
+        key_mangling=('-', '_'),
+        get_first_key=True,
+        no_tag_node_value_mangle=True,
+    )
+
+    tmp = leaf_node_changed(conf, base + [ifname, 'kernel-interface'])
+    if tmp:
+        config['kernel_interface_removed'] = tmp
+
+    # list of all kernel interfaces `vpp interface xxx kernel-interface xxx`
+    config['candidate_kernel_interfaces'] = cli_ifaces_lcp_kernel_list(conf)
+
+    # Dependency
+    if effective_config.get('kernel_interface'):
+        if conf.exists(base + [ifname, 'kernel-interface']):
+            iface = config.get('kernel_interface')
+            if conf.exists(['vpp', 'kernel-interfaces', iface]):
+                set_dependents('vpp_kernel_interface', conf, iface)
+
+    config['ifname'] = ifname
+    return config
+
+
+def verify(config):
+    verify_vpp_remove_kernel_interface(config)
+
+    if 'remove' in config:
+        return None
+
+    verify_vpp_change_kernel_interface(config)
+    verify_vpp_exists_kernel_interface(config)
+
+
+def generate(config):
+    pass
+
+
+def apply(config):
+    ifname = config.get('ifname')
+    # Delete interface
+    if 'effective' in config:
+        i = LoopbackInterface(ifname)
+        i.delete()
+
+    if 'remove' in config:
+        return None
+
+    # Add interface
+    kernel_interface = config.get('kernel_interface', '')
+    i = LoopbackInterface(ifname, kernel_interface)
+    i.add()
+
+    # Add kernel-interface (LCP) if interface is not exist
+    if 'kernel_interface' in config and not is_interface(kernel_interface):
+        i.kernel_add()
+
+    call_dependents()
+
+    return None
+
+
+if __name__ == '__main__':
+    try:
+        c = get_config()
+        verify(c)
+        generate(c)
+        apply(c)
+    except ConfigError as e:
+        print(e)
+        exit(1)