Merge pull request #331 from thomas-mangin/T2223-register

completion: T2238: use interface data

6 files changed, 70 insertions, 45 deletions

diff --git a/python/vyos/ifconfig/__init__.py b/python/vyos/ifconfig/__init__.py
index 1f9956af0..cd1696ca1 100644
--- a/python/vyos/ifconfig/__init__.py
+++ b/python/vyos/ifconfig/__init__.py
@@ -14,6 +14,7 @@
 # License along with this library.  If not, see <http://www.gnu.org/licenses/>.
 
 
+from vyos.ifconfig.section import Section
 from vyos.ifconfig.interface import Interface
 
 from vyos.ifconfig.bond import BondIf
diff --git a/python/vyos/ifconfig/control.py b/python/vyos/ifconfig/control.py
index c7a2fa2d6..464cd585e 100644
--- a/python/vyos/ifconfig/control.py
+++ b/python/vyos/ifconfig/control.py
@@ -18,10 +18,10 @@ import os
 
 from vyos.util import debug, debug_msg
 from vyos.util import popen, cmd
-from vyos.ifconfig.register import Register
+from vyos.ifconfig.section import Section
 
 
-class Control(Register):
+class Control(Section):
     _command_get = {}
     _command_set = {}
 
diff --git a/python/vyos/ifconfig/register.py b/python/vyos/ifconfig/section.py
index c90782b70..234c9a6cc 100644
--- a/python/vyos/ifconfig/register.py
+++ b/python/vyos/ifconfig/section.py
@@ -16,9 +16,10 @@
 import netifaces
 
 
-class Register:
+class Section:
     # the known interface prefixes
     _prefixes = {}
+    _classes = []
 
     # class need to define: definition['prefixes']
     # the interface prefixes declared by a class used to name interface with
@@ -26,9 +27,16 @@ class Register:
 
     @classmethod
     def register(cls, klass):
+        """
+        A function to use as decorator the interfaces classes
+        It register the prefix for the interface (eth, dum, vxlan, ...)
+        with the class which can handle it (EthernetIf, DummyIf,VXLANIf, ...)
+        """
         if not klass.definition.get('prefixes',[]):
             raise RuntimeError(f'valid interface prefixes not defined for {klass.__name__}')
 
+        cls._classes.append(klass)
+
         for ifprefix in klass.definition['prefixes']:
             if ifprefix in cls._prefixes:
                 raise RuntimeError(f'only one class can be registered for prefix "{ifprefix}" type')
@@ -38,7 +46,11 @@ class Register:
 
     @classmethod
     def _basename (cls, name, vlan):
-        # remove number from interface name
+        """
+        remove the number at the end of interface name
+        name: name of the interface
+        vlan: if vlan is True, do not stop at the vlan number
+        """
         name = name.rstrip('0123456789')
         name = name.rstrip('.')
         if vlan:
@@ -47,7 +59,11 @@ class Register:
 
     @classmethod
     def section(cls, name, vlan=True):
-        # return the name of a section an interface should be under
+        """
+        return the name of a section an interface should be under
+        name: name of the interface (eth0, dum1, ...)
+        vlan: should we try try to remove the VLAN from the number
+        """
         name = cls._basename(name, vlan)
 
         # XXX: To leave as long as vti and input are not moved to vyos
@@ -68,7 +84,10 @@ class Register:
         raise ValueError(f'No type found for interface name: {name}')
 
     @classmethod
-    def _listing (cls,section=''):
+    def _intf_under_section (cls,section=''):
+        """
+        return a generator with the name of the interface which are under a section
+        """
         interfaces = netifaces.interfaces()
 
         for ifname in interfaces:
@@ -87,9 +106,29 @@ class Register:
             yield ifname
 
     @classmethod
-    def listing(cls, section=''):
-        return list(cls._listing(section))
-
+    def interfaces(cls, section=''):
+        """
+        return a list of the name of the interface which are under a section
+        if no section is provided, then it returns all configured interfaces
+        """
+        return list(cls._intf_under_section(section))
 
-# XXX: TODO - limit name for VRF interfaces
+    @classmethod
+    def _intf_with_feature(cls, feature=''):
+        """
+        return a generator with the name of the interface which have 
+        a particular feature set in their definition such as:
+        bondable, broadcast, bridgeable, ...
+        """
+        for klass in cls._classes:
+            if klass.definition[feature]:
+                yield klass.definition['section']
 
+    @classmethod
+    def feature(cls, feature=''):
+        """
+        return list with the name of the interface which have 
+        a particular feature set in their definition such as:
+        bondable, broadcast, bridgeable, ...
+        """
+        return list(cls._intf_with_feature(feature))
diff --git a/src/completion/list_interfaces.py b/src/completion/list_interfaces.py
index 98b32797a..e27281433 100755
--- a/src/completion/list_interfaces.py
+++ b/src/completion/list_interfaces.py
@@ -2,7 +2,14 @@
 
 import sys
 import argparse
-from vyos.ifconfig import Interface
+from vyos.ifconfig import Section
+
+
+def matching(feature):
+    for section in Section.feature(feature):
+        for intf in Section.interfaces(section):
+            yield intf
+
 
 parser = argparse.ArgumentParser()
 group = parser.add_mutually_exclusive_group()
@@ -13,46 +20,23 @@ group.add_argument("-bo", "--bondable", action="store_true", help="List all bond
 
 args = parser.parse_args()
 
-# XXX: Need to be rewritten using the data in the class definition
-# XXX: It can be done once vti and input are moved into vyos
-# XXX: We store for each class what type they are (broadcast, bridgeabe, ...)
-
 if args.type:
     try:
-        interfaces = Interface.listing(args.type)
-
+        interfaces = Section.interfaces(args.type)
+        print(" ".join(interfaces))
     except ValueError as e:
         print(e, file=sys.stderr)
         print("")
 
 elif args.broadcast:
-    eth = Interface.listing("ethernet")
-    bridge = Interface.listing("bridge")
-    bond = Interface.listing("bonding")
-    interfaces = eth + bridge + bond
+    print(" ".join(matching("broadcast")))
 
 elif args.bridgeable:
-    eth = Interface.listing("ethernet")
-    bond = Interface.listing("bonding")
-    l2tpv3 = Interface.listing("l2tpv3")
-    openvpn = Interface.listing("openvpn")
-    wireless = Interface.listing("wireless")
-    tunnel = Interface.listing("tunnel")
-    vxlan = Interface.listing("vxlan")
-    geneve = Interface.listing("geneve")
-
-    interfaces = eth + bond + l2tpv3 + openvpn + vxlan + tunnel + wireless + geneve
+    print(" ".join(matching("bridgeable")))
 
 elif args.bondable:
-    interfaces = []
-    eth = Interface.listing("ethernet")
-
     # we need to filter out VLAN interfaces identified by a dot (.) in their name
-    for intf in eth:
-        if not '.' in intf:
-            interfaces.append(intf)
+    print(" ".join([intf for intf in matching("bondable") if '.' not in intf]))
 
 else:
-    interfaces = Interface.listing()
-
-print(" ".join(interfaces))
+    print(" ".join(Section.interfaces()))
diff --git a/src/completion/list_openvpn_clients.py b/src/completion/list_openvpn_clients.py
index 17b0c7008..177ac90c9 100755
--- a/src/completion/list_openvpn_clients.py
+++ b/src/completion/list_openvpn_clients.py
@@ -18,7 +18,7 @@ import os
 import sys
 import argparse
 
-from vyos.ifconfig import Interface
+from vyos.ifconfig import Section
 
 def get_client_from_interface(interface):
     clients = []
@@ -50,7 +50,7 @@ if __name__ == "__main__":
     if args.interface:
         clients = get_client_from_interface(args.interface)
     elif args.all:
-        for interface in Interface.listing("openvpn"):
+        for interface in Section.interfaces("openvpn"):
             clients += get_client_from_interface(interface)
 
     print(" ".join(clients))
diff --git a/src/conf_mode/flow_accounting_conf.py b/src/conf_mode/flow_accounting_conf.py
index 1008f3fae..eef32687e 100755
--- a/src/conf_mode/flow_accounting_conf.py
+++ b/src/conf_mode/flow_accounting_conf.py
@@ -22,6 +22,7 @@ from ipaddress import ip_address
 from jinja2 import FileSystemLoader, Environment
 from sys import exit
 
+from vyos.ifconfig import Section
 from vyos.ifconfig import Interface
 from vyos.config import Config
 from vyos.defaults import directories as vyos_data_dir
@@ -60,7 +61,7 @@ def _sflow_default_agentip(config):
         return config.return_value('protocols ospfv3 parameters router-id')
 
     # if router-id was not found, use first available ip of any interface
-    for iface in Interface.listing():
+    for iface in Section.interfaces():
         for address in Interface(iface).get_addr():
             # return an IP, if this is not loopback
             regex_filter = re.compile('^(?!(127)|(::1)|(fe80))(?P<ipaddr>[a-f\d\.:]+)/\d+$')
@@ -234,7 +235,7 @@ def verify(config):
 
     # check that all configured interfaces exists in the system
     for iface in config['interfaces']:
-        if not iface in Interface.listing():
+        if not iface in Section.interfaces():
             # chnged from error to warning to allow adding dynamic interfaces and interface templates
             # raise ConfigError("The {} interface is not presented in the system".format(iface))
             print("Warning: the {} interface is not presented in the system".format(iface))
@@ -262,7 +263,7 @@ def verify(config):
 
         # check if configured sFlow agent-id exist in the system
         agent_id_presented = None
-        for iface in Interface.listing():
+        for iface in Section.interfaces():
             for address in Interface(iface).get_addr():
                 # check an IP, if this is not loopback
                 regex_filter = re.compile('^(?!(127)|(::1)|(fe80))(?P<ipaddr>[a-f\d\.:]+)/\d+$')