Use enum to describe possible values

inventory_provider/routes/poller.py

@@ -120,10 +120,16 @@ class BRIAN_DASHBOARDS(Enum):
     # NREN customer
     NREN = auto()
 
+class PORT_TYPES(Enum):
+    ACCESS = auto()
+    SERVICE = auto()
+    UNKNOWN = auto()
 
 # only used in INTERFACE_LIST_SCHEMA and sphinx docs
 _DASHBOARD_IDS = [d.name for d in list(BRIAN_DASHBOARDS)]
 
+_PORT_TYPES = [t.name for t in list(PORT_TYPES)]
+
 _INTERFACE_TYPES = [i.name for i in list(INTERFACE_TYPES)]
 
 INTERFACE_LIST_SCHEMA = {
@@ -183,7 +189,7 @@ INTERFACE_LIST_SCHEMA = {
                     'type': 'array',
                     'items': {'$ref': '#/definitions/db_info'}
                 },
-                'port_type': {'type': 'string'}
+                'port_type': {'enum': _PORT_TYPES}
             },
             'required': [
                 'router', 'name', 'description',
@@ -719,10 +725,10 @@ def _get_port_type(description):
     if rex:
         sid = rex.group(1)
         if 'GA' in sid:
-            return 'access'
+            return PORT_TYPES.ACCESS.name
         elif 'GS' in sid:
-            return 'service'
-    return 'unknown'
+            return PORT_TYPES.SERVICE.name
+    return PORT_TYPES.UNKNOWN.name
 
 
 def load_interfaces_to_poll(

test/test_general_poller_routes.py

@@ -413,9 +413,9 @@ def test_description_dashboard_parsing(
 
 
 @pytest.mark.parametrize('description,expected_port_type', [
-    ('SRV_IAS CUSTOMER JISC #JISC-AP1-IAS IASPS | ASN786', 'unknown'),
-    ('SRV_GLOBAL CUSTOMER RENATER #RENATER-AP1 $GS-00505 | ASN2200 |', 'service'),  # noqa: E501
-    ('PHY CUSTOMER AZSCIENCENET SRF19095 $GA-01599 | GEANT-10G-Baku-CO-Interxion|', 'access')  # noqa: E501
+    ('SRV_IAS CUSTOMER JISC #JISC-AP1-IAS IASPS | ASN786', 'UNKNOWN'),
+    ('SRV_GLOBAL CUSTOMER RENATER #RENATER-AP1 $GS-00505 | ASN2200 |', 'SERVICE'),  # noqa: E501
+    ('PHY CUSTOMER AZSCIENCENET SRF19095 $GA-01599 | GEANT-10G-Baku-CO-Interxion|', 'ACCESS')  # noqa: E501
 
 ])
 def test_description_port_type_parsing(

[Erik Reid]

enum.Enum is of course ok, too ... but I think it's mainly nice (in Python) if we're doing real mypy checking

[Erik Reid]

not happy with 'enum': ['service', 'access', 'unknown'] ...?

[Bjarke Madsen]

I thought it was more consistent to go the same route as with the dashboard names