ifconfig: T2653: move loopback interface to get_config_dict()

4 files changed, 43 insertions, 51 deletions

diff --git a/python/vyos/ifconfig/interface.py b/python/vyos/ifconfig/interface.py
index 19dc6e5bc..a9af6ffdf 100644
--- a/python/vyos/ifconfig/interface.py
+++ b/python/vyos/ifconfig/interface.py
@@ -760,7 +760,7 @@ class Interface(Control):
         return True
 
     def update(self, config):
-        """ A general helper function which works on a dictionary retrived by
+        """ General helper function which works on a dictionary retrived by
         get_config_dict(). It's main intention is to consolidate the scattered
         interface setup code and provide a single point of entry when workin
         on any interface. """
@@ -794,5 +794,8 @@ class Interface(Control):
             self.set_vrf(config.get('vrf', ''))
 
         # Interface administrative state
-        state = 'down' if 'disable' in config.items() else 'up'
+        state = 'down' if 'disable' in config.keys() else 'up'
         self.set_admin_state(state)
+
+        import pprint
+        pprint.pprint(config)
diff --git a/python/vyos/ifconfig/loopback.py b/python/vyos/ifconfig/loopback.py
index 8e4438662..7ebd13b54 100644
--- a/python/vyos/ifconfig/loopback.py
+++ b/python/vyos/ifconfig/loopback.py
@@ -23,7 +23,7 @@ class LoopbackIf(Interface):
     The loopback device is a special, virtual network interface that your router
     uses to communicate with itself.
     """
-
+    _persistent_addresses = ['127.0.0.1/8', '::1/128']
     default = {
         'type': 'loopback',
     }
@@ -49,10 +49,31 @@ class LoopbackIf(Interface):
         """
         # remove all assigned IP addresses from interface
         for addr in self.get_addr():
-            if addr in ["127.0.0.1/8", "::1/128"]:
+            if addr in self._persistent_addresses:
                 # Do not allow deletion of the default loopback addresses as
                 # this will cause weird system behavior like snmp/ssh no longer
                 # operating as expected, see https://phabricator.vyos.net/T2034.
                 continue
 
             self.del_addr(addr)
+
+    def update(self, config):
+        """ General helper function which works on a dictionary retrived by
+        get_config_dict(). It's main intention is to consolidate the scattered
+        interface setup code and provide a single point of entry when workin
+        on any interface. """
+
+        addr = config.get('address', [])
+        # XXX workaround for T2636, convert IP address string to a list
+        # with one element
+        if isinstance(addr, str):
+            addr = [addr]
+
+        # We must ensure that the loopback addresses are never deleted from the system
+        addr += self._persistent_addresses
+
+        # Update IP address entry in our dictionary
+        config.update({'address' : addr})
+
+        # now call the regular function from within our base class
+        super().update(config)
diff --git a/src/conf_mode/interfaces-dummy.py b/src/conf_mode/interfaces-dummy.py
index 749024e84..e95635835 100755
--- a/src/conf_mode/interfaces-dummy.py
+++ b/src/conf_mode/interfaces-dummy.py
@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 #
-# Copyright (C) 2019 VyOS maintainers and contributors
+# Copyright (C) 2019-2020 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
diff --git a/src/conf_mode/interfaces-loopback.py b/src/conf_mode/interfaces-loopback.py
index df268cec2..32e683c07 100755
--- a/src/conf_mode/interfaces-loopback.py
+++ b/src/conf_mode/interfaces-loopback.py
@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 #
-# Copyright (C) 2019 VyOS maintainers and contributors
+# Copyright (C) 2019-2020 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
@@ -17,54 +17,31 @@
 import os
 
 from sys import exit
-from copy import deepcopy
 
 from vyos.ifconfig import LoopbackIf
-from vyos.configdict import list_diff
 from vyos.config import Config
-from vyos import ConfigError
-
-from vyos import airbag
+from vyos import ConfigError, airbag
 airbag.enable()
 
-default_config_data = {
-    'address': [],
-    'address_remove': [],
-    'deleted': False,
-    'description': '',
-}
-
-
 def get_config():
-    loopback = deepcopy(default_config_data)
+    """ Retrive CLI config as dictionary. Dictionary can never be empty,
+        as at least the interface name will be added or a deleted flag """
     conf = Config()
 
     # determine tagNode instance
     if 'VYOS_TAGNODE_VALUE' not in os.environ:
         raise ConfigError('Interface (VYOS_TAGNODE_VALUE) not specified')
 
-    loopback['intf'] = os.environ['VYOS_TAGNODE_VALUE']
-
-    # Check if interface has been removed
-    if not conf.exists('interfaces loopback ' + loopback['intf']):
-        loopback['deleted'] = True
+    ifname = os.environ['VYOS_TAGNODE_VALUE']
+    base = ['interfaces', 'loopback', ifname]
 
-    # set new configuration level
-    conf.set_level('interfaces loopback ' + loopback['intf'])
+    loopback = conf.get_config_dict(base, key_mangling=('-', '_'))
+    # store interface instance name in dictionary
+    loopback.update({'ifname': ifname})
 
-    # retrieve configured interface addresses
-    if conf.exists('address'):
-        loopback['address'] = conf.return_values('address')
-
-    # retrieve interface description
-    if conf.exists('description'):
-        loopback['description'] = conf.return_value('description')
-
-    # Determine interface addresses (currently effective) - to determine which
-    # address is no longer valid and needs to be removed from the interface
-    eff_addr = conf.return_effective_values('address')
-    act_addr = conf.return_values('address')
-    loopback['address_remove'] = list_diff(eff_addr, act_addr)
+    # Check if interface has been removed
+    tmp = {'deleted' : not conf.exists(base)}
+    loopback.update(tmp)
 
     return loopback
 
@@ -75,20 +52,11 @@ def generate(loopback):
     return None
 
 def apply(loopback):
-    l = LoopbackIf(loopback['intf'])
+    l = LoopbackIf(loopback['ifname'])
     if loopback['deleted']:
         l.remove()
     else:
-        # update interface description used e.g. within SNMP
-        l.set_alias(loopback['description'])
-
-        # Configure interface address(es)
-        # - not longer required addresses get removed first
-        # - newly addresses will be added second
-        for addr in loopback['address_remove']:
-            l.del_addr(addr)
-        for addr in loopback['address']:
-            l.add_addr(addr)
+        l.update(loopback)
 
     return None