Fix VlanRange json schema regex

Author: Mark90

nwastdlib/vlans.py

@@ -25,6 +25,8 @@
 from pydantic.json_schema import JsonSchemaValue
 from pydantic_core import CoreSchema, SchemaSerializer, core_schema
 
+VLAN_RANGE_JSON_SCHEMA_REGEX = r"^(?:([1-9]|[1-9]\d{1,2}|[1-4]\d{3})(?:-(?:[1-9]|[1-9]\d{1,2}|[1-4]\d{3}))?)$"
+
 
 def to_ranges(i: Iterable[int]) -> Iterable[range]:
     """Convert a sorted iterable of ints to an iterable of range objects.
@@ -277,7 +279,7 @@ def __get_pydantic_json_schema__(cls, core_schema_: CoreSchema, handler: GetJson
         schema_override = {
             "type": "string",
             "format": "vlan",
-            "pattern": "^([1-4][0-9]{0,3}(-[1-4][0-9]{0,3})?,?)+$",
+            "pattern": VLAN_RANGE_JSON_SCHEMA_REGEX,
             "examples": ["345", "20-23,45,50-100"],
         }
         return json_schema_resolved | schema_override

pyproject.toml

@@ -60,6 +60,7 @@ test = [
 ]
 dev = [
     "bumpversion",
+    "jsonschema",
     "pre-commit",
     "types-redis"
 ]

tests/test_vlans.py

@@ -1,7 +1,8 @@
+import jsonschema
 import pytest
 from pydantic import BaseModel, ConfigDict, ValidationError
 
-from nwastdlib.vlans import VlanRanges
+from nwastdlib.vlans import VLAN_RANGE_JSON_SCHEMA_REGEX, VlanRanges
 
 
 def test_vlan_ranges_instantiation():
@@ -235,7 +236,7 @@ class MyModel(BaseModel):
                 "title": "Vlanranges",
                 "type": "string",
                 "format": "vlan",
-                "pattern": "^([1-4][0-9]{0,3}(-[1-4][0-9]{0,3})?,?)+$",
+                "pattern": VLAN_RANGE_JSON_SCHEMA_REGEX,
                 "examples": ["345", "20-23,45,50-100"],
             },
         },
@@ -293,3 +294,37 @@ def get_dummy_model():
 
     response = fastapi_test_client.get("/dynamic_model")
     assert response.json() == {"name": "DummyModel", "vlanrange": "10"}
+
+
+@pytest.fixture(scope="module")
+def vr_schema():
+    class MyModel(BaseModel):
+        vr: VlanRanges
+
+    return MyModel.model_json_schema()
+
+
+@pytest.mark.parametrize("vlan", [1, 9, 10, 49, 50, 99, 100, 101, 499, 500, 999, 1000, 3999, 4000, 4999])
+def test_vlan_allowed_by_schema(vlan, vr_schema):
+    """Test vlans which should be allowed by the JSON Schema."""
+    assert jsonschema.validate({"vr": str(vlan)}, vr_schema) is None
+
+
+@pytest.mark.parametrize("vlan", [-5000, -50, -1, 0, 5000, 5001, 9999, 10000, 14999])
+def test_vlan_rejected_by_schema(vlan, vr_schema):
+    """Test vlans which should be rejected by the JSON Schema."""
+    with pytest.raises(jsonschema.ValidationError):
+        jsonschema.validate({"vr": str(vlan)}, vr_schema)
+
+
+@pytest.mark.parametrize("vlanrange", ["1-1", "9-9", "49-59", "99-300", "999-1001", "3999-4999"])
+def test_vlan_ranges_allowed_by_schema(vlanrange, vr_schema):
+    """Test vlan ranges which should be allowed by the JSON Schema."""
+    assert jsonschema.validate({"vr": vlanrange}, vr_schema) is None
+
+
+@pytest.mark.parametrize("vlanrange", ["-1", "-10-0", "0-1", "4999-5000", "5000-5002"])
+def test_vlan_ranges_rejected_by_schema(vlanrange, vr_schema):
+    """Test vlan ranges which should be rejected by the JSON Schema."""
+    with pytest.raises(jsonschema.ValidationError):
+        jsonschema.validate({"vr": vlanrange}, vr_schema)