Change port and protocol to annotated validators

src/primaite/utils/validation/__init__.py

@@ -0,0 +1 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK

src/primaite/utils/validation/ip_protocol.py

@@ -0,0 +1,47 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+# Define a custom IP protocol validator
+from typing import Any
+
+from pydantic import BeforeValidator, TypeAdapter, ValidationError
+from typing_extensions import Annotated, Final
+
+PROTOCOL_LOOKUP: dict[str, str] = dict(
+    NONE="none",
+    TCP="tcp",
+    UDP="udp",
+    ICMP="icmp",
+)
+"""
+Lookup table used for compatibility with PrimAITE <= 3.3. Configs with the capitalised protocol names are converted
+to lowercase at runtime.
+"""
+VALID_PROTOCOLS = ["none", "tcp", "udp", "icmp"]
+"""Supported protocols."""
+
+
+def protocol_validator(v: Any) -> str:
+    """
+    Validate that IP Protocols are chosen from the list of supported IP Protocols.
+
+    The protocol list is dynamic because plugins are able to extend it, therefore it is necessary to use this custom
+    validator instead of being able to specify a union of string literals.
+    """
+    if isinstance(v, str) and v in PROTOCOL_LOOKUP:
+        return PROTOCOL_LOOKUP[v]
+    if v in VALID_PROTOCOLS:
+        return v
+    raise ValueError(f"{v} is not a valid IP Protocol. It must be one of the following: {VALID_PROTOCOLS}")
+
+
+IPProtocol: Final[Annotated] = Annotated[str, BeforeValidator(protocol_validator)]
+"""Validates that IP Protocols used in the simulation belong to the list of supported protocols."""
+_IPProtocolTypeAdapter = TypeAdapter(IPProtocol)
+
+
+def is_valid_protocol(v: Any) -> bool:
+    """Convenience method to return true if the value matches the schema, and false otherwise."""
+    try:
+        _IPProtocolTypeAdapter.validate_python(v)
+        return True
+    except ValidationError:
+        return False

src/primaite/utils/validation/ipv4_address.py

@@ -1,4 +1,6 @@
 # © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+
+
 from ipaddress import IPv4Address
 from typing import Any, Final
 
@@ -37,39 +39,3 @@ will automatically check and convert the input value to an instance of IPv4Addre
 any Pydantic model uses it. This ensures that any field marked with this type is not just
 an IPv4Address in form, but also valid according to the rules defined in ipv4_validator.
 """
-
-# Define a custom port validator
-Port: Final[Annotated] = Annotated[int, BeforeValidator(lambda n: 0 <= n <= 65535)]
-"""Validates that network ports lie in the appropriate range of [0,65535]."""
-
-# Define a custom IP protocol validator
-PROTOCOL_LOOKUP: dict[str, str] = dict(
-    NONE="none",
-    TCP="tcp",
-    UDP="udp",
-    ICMP="icmp",
-)
-"""
-Lookup table used for compatibility with PrimAITE <= 3.3. Configs with the capitalised protocol names are converted
-to lowercase at runtime.
-"""
-VALID_PROTOCOLS = ["none", "tcp", "udp", "icmp"]
-"""Supported protocols."""
-
-
-def protocol_validator(v: Any) -> str:
-    """
-    Validate that IP Protocols are chosen from the list of supported IP Protocols.
-
-    The protocol list is dynamic because plugins are able to extend it, therefore it is necessary to use this custom
-    validator instead of being able to specify a union of string literals.
-    """
-    if v in PROTOCOL_LOOKUP:
-        return PROTOCOL_LOOKUP(v)
-    if v in VALID_PROTOCOLS:
-        return v
-    raise ValueError(f"{v} is not a valid IP Protocol. It must be one of the following: {VALID_PROTOCOLS}")
-
-
-IPProtocol: Final[Annotated] = Annotated[str, BeforeValidator(protocol_validator)]
-"""Validates that IP Protocols used in the simulation belong to the list of supported protocols."""

src/primaite/utils/validation/port.py

@@ -0,0 +1,70 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+# Define a custom port validator
+from typing import Any
+
+from pydantic import BeforeValidator, TypeAdapter, ValidationError
+from typing_extensions import Annotated, Final
+
+PORT_LOOKUP: dict[str, int] = dict(
+    UNUSED=-1,
+    NONE=0,
+    WOL=9,
+    FTP_DATA=20,
+    FTP=21,
+    SSH=22,
+    SMTP=25,
+    DNS=53,
+    HTTP=80,
+    POP3=110,
+    SFTP=115,
+    NTP=123,
+    IMAP=143,
+    SNMP=161,
+    SNMP_TRAP=162,
+    ARP=219,
+    LDAP=389,
+    HTTPS=443,
+    SMB=445,
+    IPP=631,
+    SQL_SERVER=1433,
+    MYSQL=3306,
+    RDP=3389,
+    RTP=5004,
+    RTP_ALT=5005,
+    DNS_ALT=5353,
+    HTTP_ALT=8080,
+    HTTPS_ALT=8443,
+    POSTGRES_SERVER=5432,
+)
+"""
+Lookup table used for compatibility with PrimAITE <= 3.3. Configs with named ports names are converted
+to port integers at runtime.
+"""
+
+
+def port_validator(v: Any) -> int:
+    """
+    Validate that Ports are chosen from the list of supported Ports.
+
+    The protocol list is dynamic because plugins are able to extend it, therefore it is necessary to use this custom
+    validator instead of being able to specify a union of string literals.
+    """
+    if isinstance(v, str) and v in PORT_LOOKUP:
+        v = PORT_LOOKUP[v]
+    if isinstance(v, int) and (0 <= v <= 65535):
+        return v
+    raise ValueError(f"{v} is not a valid Port. It must be an integer in the range [0,65535] or ")
+
+
+Port: Final[Annotated] = Annotated[int, BeforeValidator(port_validator)]
+"""Validates that network ports lie in the appropriate range of [0,65535]."""
+_PortTypeAdapter = TypeAdapter(Port)
+
+
+def is_valid_port(v: Any) -> bool:
+    """Convenience method to return true if the value matches the schema, and false otherwise."""
+    try:
+        _PortTypeAdapter.validate_python(v)
+        return True
+    except ValidationError:
+        return False