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

completion: T2238: use interface data

3 files changed, 50 insertions, 10 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))