# Copyright 2020-2024 VyOS maintainers and contributors <maintainers@vyos.io>
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library 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
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this library.  If not, see <http://www.gnu.org/licenses/>.

# Rename link nodes to source-interface for the following interface types:
# - vxlan
# - pseudo-ethernet

from vyos.configtree import ConfigTree

def migrate(config: ConfigTree) -> None:
    for if_type in ['vxlan', 'pseudo-ethernet']:
        base = ['interfaces', if_type]
        if not config.exists(base):
            # Nothing to do
            continue

        # list all individual interface isntance
        for i in config.list_nodes(base):
            iface = base + [i]
            if config.exists(iface + ['link']):
                config.rename(iface + ['link'], 'source-interface')