Merge branch 'dhcpv6-pd-cli-adjustment' of github.com:c-po/vyos-1x into current

* 'dhcpv6-pd-cli-adjustment' of github.com:c-po/vyos-1x:
  dhcpv6-pd: T2677: add support for rapid-commit option
  dhcpv6-pd: T2821: support dhcpv6-pd without "address dhcpv6"
  ifconfig: T2653: drop unused vyos.ifconfig.pppoe
  dhcpv6-pd: T2677: optimize CLI interface for PD configuration

4 files changed, 65 insertions, 58 deletions

diff --git a/python/vyos/configdict.py b/python/vyos/configdict.py
index 010eda45c..c1e93955e 100644
--- a/python/vyos/configdict.py
+++ b/python/vyos/configdict.py
@@ -93,7 +93,7 @@ def dict_merge(source, destination):
     tmp = deepcopy(destination)
 
     for key, value in source.items():
-        if key not in tmp.keys():
+        if key not in tmp:
             tmp[key] = value
         elif isinstance(source[key], dict):
             tmp[key] = dict_merge(source[key], tmp[key])
@@ -109,15 +109,15 @@ def T2665_default_dict_cleanup(dict):
     """ Cleanup default keys for tag nodes https://phabricator.vyos.net/T2665. """
     # Cleanup
     for vif in ['vif', 'vif_s']:
-        if vif in dict.keys():
-            for key in ['ip', 'mtu']:
-                if key in dict[vif].keys():
+        if vif in dict:
+            for key in ['ip', 'mtu', 'dhcpv6_options']:
+                if key in dict[vif]:
                     del dict[vif][key]
 
             # cleanup VIF-S defaults
-            if 'vif_c' in dict[vif].keys():
-                for key in ['ip', 'mtu']:
-                    if key in dict[vif]['vif_c'].keys():
+            if 'vif_c' in dict[vif]:
+                for key in ['ip', 'mtu', 'dhcpv6_options']:
+                    if key in dict[vif]['vif_c']:
                         del dict[vif]['vif_c'][key]
                 # If there is no vif-c defined and we just cleaned the default
                 # keys - we can clean the entire vif-c dict as it's useless
@@ -129,6 +129,21 @@ def T2665_default_dict_cleanup(dict):
             if not dict[vif]:
                 del dict[vif]
 
+    if 'dhcpv6_options' in dict and 'pd' in dict['dhcpv6_options']:
+        if 'length' in dict['dhcpv6_options']['pd']:
+            del dict['dhcpv6_options']['pd']['length']
+
+    # delete empty dicts
+    if 'dhcpv6_options' in dict:
+        if 'pd' in dict['dhcpv6_options']:
+            # test if 'pd' is an empty node so we can remove it
+            if not dict['dhcpv6_options']['pd']:
+                del dict['dhcpv6_options']['pd']
+
+        # test if 'dhcpv6_options' is an empty node so we can remove it
+        if not dict['dhcpv6_options']:
+            del dict['dhcpv6_options']
+
     return dict
 
 def leaf_node_changed(conf, path):
@@ -193,6 +208,16 @@ def get_removed_vlans(conf, dict):
 
     return dict
 
+
+def dict_add_dhcpv6pd_defaults(defaults, config_dict):
+    # Implant default dictionary for DHCPv6-PD instances
+    if 'dhcpv6_options' in config_dict and 'pd' in config_dict['dhcpv6_options']:
+        for pd, pd_config in config_dict['dhcpv6_options']['pd'].items():
+            config_dict['dhcpv6_options']['pd'][pd] = dict_merge(
+                defaults, pd_config)
+
+    return config_dict
+
 def get_interface_dict(config, base, ifname=''):
     """
     Common utility function to retrieve and mandgle the interfaces available
@@ -257,15 +282,30 @@ def get_interface_dict(config, base, ifname=''):
     # remove wrongly inserted values
     dict = T2665_default_dict_cleanup(dict)
 
-    # The values are identical for vif, vif-s and vif-c as the all include the same
-    # XML definitions which hold the defaults
+    # Implant default dictionary for DHCPv6-PD instances
+    default_pd_values = defaults(base + ['dhcpv6-options', 'pd'])
+    dict = dict_add_dhcpv6pd_defaults(default_pd_values, dict)
+
+    # Implant default dictionary in vif/vif-s VLAN interfaces. Values are
+    # identical for all types of VLAN interfaces as they all include the same
+    # XML definitions which hold the defaults.
     default_vif_values = defaults(base + ['vif'])
     for vif, vif_config in dict.get('vif', {}).items():
-        vif_config = dict_merge(default_vif_values, vif_config)
+        dict['vif'][vif] = dict_add_dhcpv6pd_defaults(
+                default_pd_values, vif_config)
+        dict['vif'][vif] = T2665_default_dict_cleanup(
+                dict_merge(default_vif_values, vif_config))
+
     for vif_s, vif_s_config in dict.get('vif_s', {}).items():
-        vif_s_config = dict_merge(default_vif_values, vif_s_config)
+        dict['vif_s'][vif_s] = dict_add_dhcpv6pd_defaults(
+                default_pd_values, vif_s_config)
+        dict['vif_s'][vif_s] = T2665_default_dict_cleanup(
+                dict_merge(default_vif_values, vif_s_config))
         for vif_c, vif_c_config in vif_s_config.get('vif_c', {}).items():
-            vif_c_config = dict_merge(default_vif_values, vif_c_config)
+            dict['vif_s'][vif_s]['vif_c'][vif_c] = dict_add_dhcpv6pd_defaults(
+                    default_pd_values, vif_c_config)
+            dict['vif_s'][vif_s]['vif_c'][vif_c] = T2665_default_dict_cleanup(
+                    dict_merge(default_vif_values, vif_c_config))
 
     # Check vif, vif-s/vif-c VLAN interfaces for removal
     dict = get_removed_vlans(config, dict)
diff --git a/python/vyos/ifconfig/__init__.py b/python/vyos/ifconfig/__init__.py
index 9cd8d44c1..f4b504ebd 100644
--- a/python/vyos/ifconfig/__init__.py
+++ b/python/vyos/ifconfig/__init__.py
@@ -30,7 +30,6 @@ from vyos.ifconfig.vxlan import VXLANIf
 from vyos.ifconfig.wireguard import WireGuardIf
 from vyos.ifconfig.vtun import VTunIf
 from vyos.ifconfig.vti import VTIIf
-from vyos.ifconfig.pppoe import PPPoEIf
 from vyos.ifconfig.tunnel import GREIf
 from vyos.ifconfig.tunnel import GRETapIf
 from vyos.ifconfig.tunnel import IP6GREIf
diff --git a/python/vyos/ifconfig/interface.py b/python/vyos/ifconfig/interface.py
index 892495dec..537c4bc2d 100644
--- a/python/vyos/ifconfig/interface.py
+++ b/python/vyos/ifconfig/interface.py
@@ -901,10 +901,15 @@ class Interface(Control):
         if isinstance(new_addr, str):
             new_addr = [new_addr]
 
-        # ensure DHCP/DHCPv6 is stopped (when not configured explicitly)
-        for proto in ['dhcp', 'dhcpv6']:
-            if proto not in new_addr:
-                self.del_addr(proto)
+        # always ensure DHCP client is stopped (when not configured explicitly)
+        if 'dhcp' not in new_addr:
+            self.del_addr('dhcp')
+
+        # always ensure DHCPv6 client is stopped (when not configured as client
+        # for IPv6 address or prefix delegation
+        dhcpv6pd = jmespath.search('dhcpv6_options.pd', config)
+        if 'dhcpv6' not in new_addr or dhcpv6pd == None:
+            self.del_addr('dhcpv6')
 
         # determine IP addresses which are assigned to the interface and build a
         # list of addresses which are no longer in the dict so they can be removed
@@ -915,6 +920,10 @@ class Interface(Control):
         for addr in new_addr:
             self.add_addr(addr)
 
+        # start DHCPv6 client when only PD was configured
+        if dhcpv6pd != None:
+            self.set_dhcpv6(True)
+
         # There are some items in the configuration which can only be applied
         # if this instance is not bound to a bridge. This should be checked
         # by the caller but better save then sorry!
diff --git a/python/vyos/ifconfig/pppoe.py b/python/vyos/ifconfig/pppoe.py
deleted file mode 100644
index 787245696..000000000
--- a/python/vyos/ifconfig/pppoe.py
+++ /dev/null
@@ -1,41 +0,0 @@
-# Copyright 2020 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/>.
-
-
-from vyos.ifconfig.interface import Interface
-
-
-@Interface.register
-class PPPoEIf(Interface):
-    default = {
-        'type': 'pppoe',
-    }
-    definition = {
-        **Interface.definition,
-        **{
-            'section': 'pppoe',
-            'prefixes': ['pppoe', ],
-        },
-    }
-
-    # stub this interface is created in the configure script
-
-    def _create(self):
-        # we can not create this interface as it is managed outside
-        pass
-
-    def _delete(self):
-        # we can not create this interface as it is managed outside
-        pass