Update dl_vlan validation to allow mask

CHANGELOG.rst

@@ -7,6 +7,11 @@ file.
 [UNRELEASED] - Under development
 ********************************
 
+Added
+=====
+
+- Added support for VLAN with mask. ``dl_vlan`` now also supports a string ``"vlan/mask"``.
+
 Changed
 =======
 - Update endpoint ``GET v2/stored_flows`` to return the flows in descending order by `priority`.

db/models/__init__.py

@@ -6,7 +6,7 @@
 from datetime import datetime
 from decimal import Decimal
 from enum import Enum
-from typing import List, Optional
+from typing import List, Optional, Union
 
 from bson.decimal128 import Decimal128
 from pydantic import BaseModel, Field, validator
@@ -50,7 +50,7 @@ class MatchSubDoc(BaseModel):
     dl_src: Optional[str]
     dl_dst: Optional[str]
     dl_type: Optional[int]
-    dl_vlan: Optional[int]
+    dl_vlan: Optional[Union[int, str]]
     dl_vlan_pcp: Optional[int]
     nw_src: Optional[str]
     nw_dst: Optional[str]
@@ -87,6 +87,20 @@ class MatchSubDoc(BaseModel):
     metadata: Optional[int]
     tun_id: Optional[int]
 
+    @validator("dl_vlan")
+    def vlan_with_mask(cls, v):
+        """Validate vlan format"""
+        try:
+            return int(v)
+        except ValueError:
+            try:
+                [int(part) for part in v.split("/")]
+            except ValueError:
+                raise ValueError(
+                    "must be an integer or an integer with a mask in format vlan/mask"
+                )
+        return v
+
 
 class FlowSubDoc(BaseModel):
     """Flow DB SubDocument Model."""

openapi.yml

@@ -256,9 +256,11 @@ components:
           format: int16
           example: 2048
         dl_vlan:
-          type: integer
-          format: int16
-          example: 300
+          oneOf:
+            - type: string
+              example: "40/4088"
+            - type: integer
+              example: 40
         dl_vlan_pcp:
           type: integer
           format: int8

tests/unit/test_db_models.py

@@ -28,3 +28,28 @@ def test_flow_doct(self) -> None:
         flow_doc = FlowDoc(**data)
         assert flow_doc
         assert flow_doc.flow.instructions == flow_dict["instructions"]
+
+    def test_flow_vlan_range(self) -> None:
+        """Test a flow with a vlan range match."""
+        flow_dict = {
+            "match": {
+                "in_port": 9,
+                "dl_vlan": "24/4088",
+                "dl_type": 2048,
+                "nw_proto": 6,
+            },
+            "instructions": [
+                {
+                    "instruction_type": "apply_actions",
+                    "actions": [{"action_type": "output", "port": 4}],
+                },
+            ],
+        }
+        data = {
+            "switch": "00:00:00:00:00:00:00:02",
+            "flow_id": "1",
+            "id": "0",
+            "flow": flow_dict,
+        }
+        flow_doc = FlowDoc(**data)
+        assert flow_doc

tests/unit/test_utils.py

@@ -140,7 +140,6 @@ def test_validate_range_exceptions(self):
         test_data = [((1,), ValueError), ((2, 1), ValueError), ((1, "1"), TypeError)]
         for values, exception in test_data:
             with self.subTest(values=values, exception=exception):
-
                 with self.assertRaises(exception) as exc:
                     _validate_range(values)