fix: conversion for port number (#1309)

* fix: conversion for port number

* fix: correct order for valid port range

* refactor: tabs and spaces     Sorry

* fix: calling port within if in dict

* fix: forcing int to bypass wrong error

* feat: add util port tests

* fix: tests assertRaises with correct syntax

* refactor: using black

* make mypy happy

Co-authored-by: Federico Bregant <[email protected]>
Co-authored-by: zariiii9003 <[email protected]>

Author: 3 people

can/util.py

@@ -211,6 +211,20 @@ def _create_bus_config(config: Dict[str, Any]) -> typechecking.BusConfig:
         raise CanInterfaceNotImplementedError(
             f'Unknown interface type "{config["interface"]}"'
         )
+    if "port" in config:
+        # convert port to integer if necessary
+        if isinstance(config["port"], int):
+            port = config["port"]
+        elif isinstance(config["port"], str):
+            if config["port"].isnumeric():
+                config["port"] = port = int(config["port"])
+            else:
+                raise ValueError("Port config must be a number!")
+        else:
+            raise TypeError("Port config must be string or integer!")
+
+        if not 0 < port < 65535:
+            raise ValueError("Port config must be inside 0-65535 range!")
 
     if "bitrate" in config:
         config["bitrate"] = int(config["bitrate"])

test/test_util.py

@@ -53,6 +53,9 @@ def test_with_new_and_alias_present(self):
 
 class TestBusConfig(unittest.TestCase):
     base_config = dict(interface="socketcan", bitrate=500_000)
+    port_alpha_config = dict(interface="socketcan", bitrate=500_000, port="fail123")
+    port_to_high_config = dict(interface="socketcan", bitrate=500_000, port="999999")
+    port_wrong_type_config = dict(interface="socketcan", bitrate=500_000, port=(1234,))
 
     def test_timing_can_use_int(self):
         """
@@ -64,6 +67,17 @@ def test_timing_can_use_int(self):
             _create_bus_config({**self.base_config, **timing_conf})
         except TypeError as e:
             self.fail(e)
+        self.assertRaises(
+            ValueError, _create_bus_config, {**self.port_alpha_config, **timing_conf}
+        )
+        self.assertRaises(
+            ValueError, _create_bus_config, {**self.port_to_high_config, **timing_conf}
+        )
+        self.assertRaises(
+            TypeError,
+            _create_bus_config,
+            {**self.port_wrong_type_config, **timing_conf},
+        )
 
 
 class TestChannel2Int(unittest.TestCase):