Implement "float" and "time" data types (ipspace#2620)

Author: ipspace

docs/dev/validation.md

@@ -83,7 +83,7 @@ The dictionary-based approach allows in-depth validation of nested attributes, w
 (dev-valid-data-types)=
 ## Valid Data Types
 
-Validator recognizes standard Python data types (**str**, **int**, **bool**, **list** or **dict**) and the following networking-specific data types:
+Validator recognizes standard Python data types (**str**, **int**, **float**, **bool**, **list** or **dict**) and the following networking-specific data types:
 
 | Data type.     | Meaning |
 |----------------|---------|
@@ -102,6 +102,7 @@ Validator recognizes standard Python data types (**str**, **int**, **bool**, **l
 | **prefix_str** | An IPv4 or IPv6 prefix |
 | **rd**         | Route distinguisher (ASN:ID or IP:ID) |
 | **r_proto**    | Routing protocol identifier |
+| **time**       | Time duration specified in seconds (`s`) or milliseconds (`ms`) |
 
 The data type can be specified as a string (without additional parameters) or a dictionary with a **type** attribute (data type as a string) and other type-specific validation parameters.
 
@@ -145,6 +146,8 @@ When an attribute has a data type defined with the **type** attribute, you can u
 |           | **_subtype** -- validate values as belonging to the specified subtype |
 |           | **_keytype** -- validate keys as belonging to the specified scalar type |
 |           | **_list_to_dict** -- [value can be specified as a list](validation-list-to-dict) |
+| **float** | **min_value** -- minimum parameter value |
+|           | **max_value** -- maximum parameter value |
 | **id**    | **max_length** -- maximum identifier length |
 | **int**   | **min_value** -- minimum parameter value |
 |           | **max_value** -- maximum parameter value |

netsim/data/types.py

@@ -6,6 +6,7 @@
 import functools
 import ipaddress
 import netaddr
+import datetime
 import re
 import textwrap
 
@@ -491,31 +492,34 @@ def must_be_id(value: typing.Any, max_length: typing.Union[int,str] = 16) -> dic
 
   return { '_valid': True } 
 
-def check_int_type(
+def check_num_type(
       value: typing.Any,
       min_value:  typing.Optional[int] = None,          # Minimum value
       max_value:  typing.Optional[int] = None,          # Maximum value
-                ) -> dict:
-  if not isinstance(value,int):                         # value must be an int
-    return { '_type': 'an integer' }
+      datatype:   typing.Type = int,
+      dataname:   str = 'an integer') -> dict:
+  
+  # Value must be an integer or the specified data type
+  if not isinstance(value,(int,datatype)):
+    return { '_type': dataname }
 
   if isinstance(value,bool):                            # but not a bool
-    return { '_value': 'a true integer (not a bool)' }
+    return { '_value': 'a true number (not a bool)' }
 
   if isinstance(max_value,str):
     max_value = resolve_const_value(max_value,None)
   if isinstance(min_value,str):
     min_value = resolve_const_value(min_value,None)
 
-  if isinstance(min_value,int) and isinstance(max_value,int):
+  if isinstance(min_value,(int,datatype)) and isinstance(max_value,(int,datatype)):
     if value < min_value or value > max_value:
-      return { '_value': f'an integer between {min_value} and {max_value}' }
-  elif isinstance(min_value,int):
+      return { '_value': f'{dataname} between {min_value} and {max_value}' }
+  elif isinstance(min_value,(int,datatype)):
     if value < min_value:
-      return { '_value': f'an integer larger or equal to {min_value}' }
-  elif isinstance(max_value,int):
+      return { '_value': f'{dataname} larger or equal to {min_value}' }
+  elif isinstance(max_value,(int,datatype)):
     if value > max_value:
-      return { '_value': f'an integer less than or equal to {max_value}' }
+      return { '_value': f'{dataname} less than or equal to {max_value}' }
 
   return { '_valid': True } 
 
@@ -536,7 +540,26 @@ def transform_to_int(value: typing.Any) -> int:
     except:
       pass
 
-  return(check_int_type(value,min_value,max_value))
+  return(check_num_type(value,min_value,max_value))
+
+@type_test()
+def must_be_float(
+      value: typing.Any,
+      min_value:  typing.Optional[int] = None,          # Minimum value
+      max_value:  typing.Optional[int] = None,          # Maximum value
+                ) -> dict:
+
+  def transform_to_float(value: typing.Any) -> float:
+    return float(value)
+
+  if isinstance(value,str):                             # Try to convert STR to INT
+    try:
+      transform_to_float(value)
+      return { '_valid': True, '_transform': transform_to_float }
+    except:
+      pass
+
+  return(check_num_type(value,min_value,max_value,float,'a number'))
 
 @type_test(false_value=False)
 def must_be_bool(value: typing.Any) -> dict:
@@ -564,6 +587,30 @@ def must_be_bool_false(value: typing.Any) -> dict:
 
   return { '_valid': True } if value is False else { '_type': 'False' }
 
+@type_test()
+def must_be_time(value: typing.Any) -> dict:
+
+  def transform_to_msec(duration: str) -> int:
+    # Regex to capture number + unit (e.g. "200ms", "1s", "5m")
+    match = re.fullmatch(r"(\d+(?:\.\d+)?)(ms|s)", duration.strip())
+    if not match:
+      raise ValueError(f"Invalid duration format: '{duration}'")
+    
+    value, unit = match.groups()
+    return int(value) if unit == 'ms' else int(1000 * float(value))
+
+  if isinstance(value,(int,float)) and not isinstance(value,bool):
+    return { '_valid': True }
+
+  if isinstance(value,str):                             # Try to convert STR to delta time
+    try:
+      transform_to_msec(value)
+      return { '_valid': True, '_transform': transform_to_msec }
+    except Exception as ex:
+      pass
+
+  return { '_type': 'a time interval'}
+
 @type_test()
 def must_be_asn2(value: typing.Any) -> dict:                          # 2-octet ASN (in case we need it somewhere)
   err = 'an AS number (integer between 1 and 65535)'

netsim/extra/bgp.policy/plugin.py

@@ -23,7 +23,7 @@ def must_be_autobw(
     if value == 'auto':
       return { '_valid': True } 
 
-  result = types.check_int_type(value,min_value,max_value)
+  result = types.check_num_type(value,min_value,max_value)
   return expected_type if '_type' in result else result
 
 types.register_type('autobw',must_be_autobw)

tests/errors/ia-bfd.log

@@ -3,7 +3,7 @@ IncorrectType in bfd: attribute 'bfd.min_tx' must be an integer, found BoxList
 IncorrectType in bfd: attribute 'bfd.min_rx' must be an integer, found str
 IncorrectValue in bfd: attribute 'nodes.r1.bfd.min_echo_rx' must be an integer larger or equal to 0
 ... use 'netlab show attributes --module bfd node' to display valid attributes
-IncorrectValue in bfd: attribute 'nodes.r1.bfd.multiplier' must be a true integer (not a bool)
+IncorrectValue in bfd: attribute 'nodes.r1.bfd.multiplier' must be a true number (not a bool)
 IncorrectType in bfd: attribute 'nodes.r1.bfd.min_tx' must be an integer, found BoxList
 IncorrectType in bfd: attribute 'nodes.r1.bfd.min_rx' must be an integer, found str
 IncorrectType in bfd: attribute 'nodes.r2.bfd.min_tx' must be an integer, found NoneType

tests/errors/link-invalid-attr.log

@@ -3,6 +3,10 @@ IncorrectAttr in links: Invalid link attribute 'wtf' found in links[1]
 IncorrectAttr in ospf: Invalid ospf link attribute 'wtf' found in links[1].ospf
 ... use 'netlab show attributes --module ospf link' to display valid attributes
 IncorrectAttr in links: links[1] uses an attribute from module bgp which is not enabled in topology
+IncorrectType in links: attribute 'links[1].tc.x_float' must be a number, found str
+IncorrectValue in links: attribute 'links[1].tc.loss' must be a number between 0 and 100
+IncorrectType in links: attribute 'links[1].tc.delay' must be a time interval, found str
+IncorrectType in links: attribute 'links[1].tc.jitter' must be a time interval, found str
 IncorrectAttr in links: Invalid interface attribute 'wtf' found in links[1].r1
 ... use 'netlab show attributes interface' to display valid attributes
 IncorrectAttr in ospf: Invalid ospf interface attribute 'process' found in links[1].r1.ospf

tests/errors/link-invalid-attr.yml

@@ -2,10 +2,18 @@
 # Invalid link attribute
 #
 ---
-module: [ ospf ]
-
 defaults:
-  device: iosv
+  device: none
+  attributes:
+    link:
+      tc:
+        delay: time
+        jitter: time
+        loss: { type: float, min_value: 0, max_value: 100 }
+        x_float: float
+        rate: { type: int, min_value: 1 }
+
+module: [ ospf ]
 
 nodes:
   r1:
@@ -29,3 +37,8 @@ links:
   ospf.cost: 10
   ospf.wtf: 20
   bgp.advertise: True
+  tc:
+    x_float: really
+    loss: 107.3
+    delay: 2m
+    jitter: 0,2ms

tests/topology/expected/link-bw.yml

@@ -20,6 +20,11 @@ links:
   prefix:
     ipv4: 192.168.23.0/24
     ipv6: 2001:db8:cafe:2::/64
+  tc:
+    delay: 2
+    jitter: 13
+    loss: 0.3
+    rate: 2000
   type: p2p
 name: input
 nodes:
@@ -43,6 +48,11 @@ nodes:
         ipv4: 192.168.23.2/24
         ipv6: 2001:db8:cafe:2::2/64
         node: e2
+      tc:
+        delay: 2
+        jitter: 13
+        loss: 0.3
+        rate: 2000
       type: p2p
     loopback:
       ifindex: 0
@@ -77,6 +87,11 @@ nodes:
         ipv4: 192.168.23.1/24
         ipv6: 2001:db8:cafe:2::1/64
         node: e1
+      tc:
+        delay: 2
+        jitter: 13
+        loss: 0.3
+        rate: 2000
       type: p2p
     loopback:
       ifindex: 0

tests/topology/input/link-bw.yml

@@ -1,6 +1,13 @@
 defaults:
   device: iosv
   inventory: dump
+  attributes:
+    link:
+      tc:
+        delay: time
+        jitter: time
+        loss: { type: float, min_value: 0, max_value: 100 }
+        rate: { type: int, min_value: 1 }
 
 nodes:
   e1:
@@ -13,3 +20,8 @@ links:
     ipv4: 192.168.23.0/24
     ipv6: 2001:db8:cafe:2::/64
   bandwidth: 100000
+  tc:
+    delay: 2ms
+    jitter: 0.013s
+    loss: 0.3
+    rate: 2000