CRAI suggestions and feedback

CoMPaTech · CoMPaTech · commit 0d1f83181859 · 2025-08-06T19:34:20.000+02:00
diff --git a/airos/data.py b/airos/data.py
@@ -19,6 +19,7 @@
 MAC_ADDRESS_MASK_REGEX = re.compile(r"^(00:){4}[0-9a-fA-F]{2}[:-][0-9a-fA-F]{2}$")
 
 
+# Helper functions
 def is_mac_address(value: str) -> bool:
     """Check if a string is a valid MAC address."""
     return bool(MAC_ADDRESS_REGEX.match(value))
@@ -38,27 +39,6 @@ def is_ip_address(value: str) -> bool:
         return False
 
 
-def _check_and_log_unknown_enum_value(
-    data_dict: dict[str, Any],
-    key: str,
-    enum_class: type[Enum],
-    dataclass_name: str,
-    field_name: str,
-) -> None:
-    """Clean unsupported parameters with logging."""
-    value = data_dict.get(key)
-    if value is not None and isinstance(value, str):
-        if value not in [e.value for e in enum_class]:
-            logger.warning(
-                "Unknown value '%s' for %s.%s. Please report at "
-                "https://github.com/CoMPaTech/python-airos/issues so we can add support.",
-                value,
-                dataclass_name,
-                field_name,
-            )
-            del data_dict[key]
-
-
 def redact_data_smart(data: dict) -> dict:
     """Recursively redacts sensitive keys in a dictionary."""
     sensitive_keys = {
@@ -85,7 +65,7 @@ def _redact(d: dict):
             if k in sensitive_keys:
                 if isinstance(v, str) and (is_mac_address(v) or is_mac_address_mask(v)):
                     # Redact only the first 6 hex characters of a MAC address
-                    redacted_d[k] = "00:00:00:00:" + v.replace("-", ":").upper()[-5:]
+                    redacted_d[k] = "00:11:22:33:" + v.replace("-", ":").upper()[-5:]
                 elif isinstance(v, str) and is_ip_address(v):
                     # Redact to a dummy local IP address
                     redacted_d[k] = "127.0.0.3"
@@ -109,46 +89,28 @@ def _redact(d: dict):
     return _redact(data)
 
 
-def _redact_ip_addresses(addresses: str | list[str]) -> str | list[str]:
-    """Redacts the first three octets of an IPv4 address."""
-    if isinstance(addresses, str):
-        addresses = [addresses]
+# Data class start
 
-    redacted_list = []
-    for ip in addresses:
-        try:
-            parts = ip.split(".")
-            if len(parts) == 4:
-                # Keep the last octet, but replace the rest with a placeholder.
-                redacted_list.append(f"127.0.0.{parts[3]}")
-            else:
-                # Handle non-standard IPs or IPv6 if it shows up here
-                redacted_list.append("REDACTED")
-        except (IndexError, ValueError):
-            # In case the IP string is malformed
-            redacted_list.append("REDACTED")
-
-    return redacted_list if isinstance(addresses, list) else redacted_list[0]
-
-
-def _redact_mac_addresses(macs: str | list[str]) -> str | list[str]:
-    """Redacts the first four octets of a MAC address."""
-    if isinstance(macs, str):
-        macs = [macs]
-
-    redacted_list = []
-    for mac in macs:
-        try:
-            parts = mac.split(":")
-            if len(parts) == 6:
-                # Keep the last two octets, replace the rest with a placeholder
-                redacted_list.append(f"00:11:22:33:{parts[4]}:{parts[5]}")
-            else:
-                redacted_list.append("REDACTED")
-        except (IndexError, ValueError):
-            redacted_list.append("REDACTED")
 
-    return redacted_list if isinstance(macs, list) else redacted_list[0]
+def _check_and_log_unknown_enum_value(
+    data_dict: dict[str, Any],
+    key: str,
+    enum_class: type[Enum],
+    dataclass_name: str,
+    field_name: str,
+) -> None:
+    """Clean unsupported parameters with logging."""
+    value = data_dict.get(key)
+    if value is not None and isinstance(value, str):
+        if value not in [e.value for e in enum_class]:
+            logger.warning(
+                "Unknown value '%s' for %s.%s. Please report at "
+                "https://github.com/CoMPaTech/python-airos/issues so we can add support.",
+                value,
+                dataclass_name,
+                field_name,
+            )
+            del data_dict[key]
 
 
 class IeeeMode(Enum):
@@ -328,8 +290,8 @@ class EthList:
 class GPSData:
     """Leaf definition."""
 
-    lat: str | None = None
-    lon: str | None = None
+    lat: float | None = None
+    lon: float | None = None
     fix: int | None = None
     sats: int | None = None  # LiteAP GPS
     dim: int | None = None  # LiteAP GPS
diff --git a/fixtures/airos_liteapgps_ap_ptmp_40mhz.json b/fixtures/airos_liteapgps_ap_ptmp_40mhz.json
@@ -535,8 +535,8 @@
             "dim": null,
             "dop": null,
             "fix": 0,
-            "lat": "52.379894",
-            "lon": "4.901608",
+            "lat": 52.379894,
+            "lon": 4.901608,
             "sats": null,
             "time_synced": null
           },
@@ -977,8 +977,8 @@
             "dim": null,
             "dop": null,
             "fix": 0,
-            "lat": "52.379894",
-            "lon": "4.901608",
+            "lat": 52.379894,
+            "lon": 4.901608,
             "sats": null,
             "time_synced": null
           },
diff --git a/fixtures/airos_loco5ac_ap-ptp.json b/fixtures/airos_loco5ac_ap-ptp.json
@@ -524,8 +524,8 @@
             "dim": null,
             "dop": null,
             "fix": 0,
-            "lat": "52.379894",
-            "lon": "4.901608",
+            "lat": 52.379894,
+            "lon": 4.901608,
             "sats": null,
             "time_synced": null
           },
diff --git a/fixtures/airos_loco5ac_sta-ptp.json b/fixtures/airos_loco5ac_sta-ptp.json
@@ -524,8 +524,8 @@
             "dim": null,
             "dop": null,
             "fix": 0,
-            "lat": "52.379894",
-            "lon": "4.901608",
+            "lat": 52.379894,
+            "lon": 4.901608,
             "sats": null,
             "time_synced": null
           },
diff --git a/fixtures/airos_mocked_sta-ptmp.json b/fixtures/airos_mocked_sta-ptmp.json
@@ -524,8 +524,8 @@
             "dim": null,
             "dop": null,
             "fix": 0,
-            "lat": "52.379894",
-            "lon": "4.901608",
+            "lat": 52.379894,
+            "lon": 4.901608,
             "sats": null,
             "time_synced": null
           },
@@ -954,8 +954,8 @@
             "dim": null,
             "dop": null,
             "fix": 0,
-            "lat": "52.379894",
-            "lon": "4.901608",
+            "lat": 52.379894,
+            "lon": 4.901608,
             "sats": null,
             "time_synced": null
           },
diff --git a/fixtures/airos_nanobeam5ac_sta_ptmp_40mhz.json b/fixtures/airos_nanobeam5ac_sta_ptmp_40mhz.json
@@ -549,8 +549,8 @@
             "dim": 3,
             "dop": 0.96,
             "fix": 1,
-            "lat": "52.379894",
-            "lon": "4.901608",
+            "lat": 52.379894,
+            "lon": 4.901608,
             "sats": 9,
             "time_synced": 0
           },
diff --git a/tests/test_discovery.py b/tests/test_discovery.py
@@ -246,7 +246,7 @@ async def _simulate_discovery():
 
             mock_protocol_factory(MagicMock()).callback(parsed_data)
 
-        with patch("asyncio.sleep", new=AsyncMock()):
+        with patch("airos.discovery.asyncio.sleep", new=AsyncMock()):
             discovery_task = asyncio.create_task(airos_discover_devices(timeout=1))
 
             await _simulate_discovery()
@@ -263,7 +263,7 @@ async def test_async_discover_devices_no_devices(mock_datagram_endpoint):
     """Test discovery returns an empty dict if no devices are found."""
     mock_transport, _ = mock_datagram_endpoint
 
-    with patch("asyncio.sleep", new=AsyncMock()):
+    with patch("airos.discovery.asyncio.sleep", new=AsyncMock()):
         result = await airos_discover_devices(timeout=1)
 
     assert result == {}
diff --git a/tests/test_stations.py b/tests/test_stations.py
@@ -76,9 +76,18 @@ async def test_status_logs_redacted_data_on_invalid_value(mock_logger, airos_dev
     logged_data = mock_logger.exception.call_args[0][1]
 
     # Assert that the dictionary has been redacted
+    assert "wireless" in logged_data
+    assert "essid" in logged_data["wireless"]
     assert logged_data["wireless"]["essid"] == "REDACTED"
+    assert "host" in logged_data
+    assert "hostname" in logged_data["host"]
     assert logged_data["host"]["hostname"] == "REDACTED"
-    assert logged_data["wireless"]["apmac"] == "00:00:00:00:89:AB"
+    assert "apmac" in logged_data["wireless"]
+    assert logged_data["wireless"]["apmac"] == "00:11:22:33:89:AB"
+    assert "interfaces" in logged_data
+    assert len(logged_data["interfaces"]) > 2
+    assert "status" in logged_data["interfaces"][2]
+    assert "ipaddr" in logged_data["interfaces"][2]["status"]
     assert logged_data["interfaces"][2]["status"]["ipaddr"] == "127.0.0.3"
 
 
