Fix #719: convert macaddr in all sorts of forms to std format

Signed-off-by: Dinesh Dutt <[email protected]>

Author: ddutt

suzieq/shared/utils.py

@@ -452,7 +452,10 @@ def get_timestamp_from_junos_time(in_data, timestamp: int):
 
 
 def convert_macaddr_format_to_colon(macaddr: str) -> str:
-    """Convert NXOS/EOS . macaddr form to standard : format, lowecase
+    """Convert various macaddr forms to standard ':' format, lowecase
+
+    One unexpected side-effect, it'll convert the given string to lowercase
+    even if it doesn't match a macaddr.
 
     :param macaddr: str, the macaddr string to convert
     :returns: the converted macaddr string or all 0s string if arg not str
@@ -471,15 +474,16 @@ def convert_macaddr_format_to_colon(macaddr: str) -> str:
         if re.match(r'[0-9a-f]{4}:[0-9a-f]{4}:[0-9a-f]{4}', macaddr):
             return (':'.join([f'{x[:2]}:{x[2:]}'
                               for x in macaddr.split(':')]))
-        if re.match(r'[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}', macaddr):
-            return (':'.join([f'{x[:2]}:{x[2:]}'
-                              for x in macaddr.split('-')]))
         if ':' not in macaddr and re.match(r'[0-9a-f]{12}', macaddr):
             newmac = ''
             for i in range(0, 12, 2):
                 newmac += f'{macaddr[i:i+2]}:'
             newmac = newmac[:-1]  # remove the trailing ':'
             return newmac
+        if re.match(r'[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}', macaddr):
+            return (':'.join([f'{x[:2]}:{x[2:]}'
+                              for x in macaddr.split('-')]))
+        return macaddr
 
     return '00:00:00:00:00:00'
 

tests/unit/test_mac_convert.py

@@ -21,5 +21,15 @@ def test_mac_convert():
     assert convert_macaddr_format_to_colon('50-9A-4C-36-A1-DF') == result, \
         'failed to convert 50-9A-4C-36-A1-DF'
 
-    assert convert_macaddr_format_to_colon('50-9Z-4C-36-A1-DF') == nullmac, \
+    assert convert_macaddr_format_to_colon(
+        '50-9Z-4C-36-A1-DF') == '50-9z-4c-36-a1-df', \
         'Incorrect conversion of 50-9Z-4C-36-A1-DF'
+
+    assert convert_macaddr_format_to_colon(result) == result, \
+        f'Failed to return {result} as is'
+
+    assert convert_macaddr_format_to_colon(1) == nullmac, \
+        f'Incorrect handling when int is passed'
+
+    assert convert_macaddr_format_to_colon([1]) == nullmac, \
+        f'Incorrect handling when list is passed'