Review comments

Author: CoMPaTech

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.4.1] - 2025-08-17
+
+### Changed
+
+- Further refactoring of the code (HA compatibility)
+
 ## [0.4.0] - 2025-08-16
 
 ### Added

airos/airos8.py

@@ -69,20 +69,6 @@ def __init__(
 
         self._use_json_for_login_post = False
 
-        self._common_headers = {
-            "Accept": "application/json, text/javascript, */*; q=0.01",
-            "Sec-Fetch-Site": "same-origin",
-            "Accept-Language": "en-US,nl;q=0.9",
-            "Accept-Encoding": "gzip, deflate, br",
-            "Sec-Fetch-Mode": "cors",
-            "Origin": self.base_url,
-            "User-Agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/18.5 Safari/605.1.15",
-            "Referer": self.base_url + "/",
-            "Connection": "keep-alive",
-            "Sec-Fetch-Dest": "empty",
-            "X-Requested-With": "XMLHttpRequest",
-        }
-
         self._auth_cookie: str | None = None
         self._csrf_id: str | None = None
         self.connected: bool = False
@@ -171,15 +157,14 @@ def _store_auth_data(self, response: aiohttp.ClientResponse) -> None:
         """Parse the response from a successful login and store auth data."""
         self._csrf_id = response.headers.get("X-CSRF-ID")
 
-        set_cookie_header = response.headers.get("Set-Cookie")
-        if set_cookie_header:
-            cookie = SimpleCookie()
-            cookie.load(set_cookie_header)
-
-            for key, morsel in cookie.items():
-                if key.startswith("AIROS_"):
-                    self._auth_cookie = morsel.key[6:] + "=" + morsel.value
-                    break
+        # Parse all Set-Cookie headers to ensure we don't miss AIROS_* cookie
+        cookie = SimpleCookie()
+        for set_cookie in response.headers.getall("Set-Cookie", []):
+            cookie.load(set_cookie)
+        for key, morsel in cookie.items():
+            if key.startswith("AIROS_"):
+                self._auth_cookie = morsel.key[6:] + "=" + morsel.value
+                break
 
     async def _request_json(
         self,
@@ -216,7 +201,7 @@ async def _request_json(
             ) as response:
                 response.raise_for_status()
                 response_text = await response.text()
-                _LOGGER.info("Successfully fetched JSON from %s", url)
+                _LOGGER.debug("Successfully fetched JSON from %s", url)
 
                 # If this is the login request, we need to store the new auth data
                 if url == self._login_url:
@@ -234,14 +219,11 @@ async def _request_json(
         except (TimeoutError, aiohttp.ClientError) as err:
             _LOGGER.exception("Error during API call to %s: %s", url, err)
             raise AirOSDeviceConnectionError from err
-        except aiohttp.ClientError as err:
-            _LOGGER.error("Aiohttp client error for %s: %s", url, err)
-            raise AirOSDeviceConnectionError from err
         except json.JSONDecodeError as err:
             _LOGGER.error("Failed to decode JSON from %s", url)
             raise AirOSDataMissingError from err
         except asyncio.CancelledError:
-            _LOGGER.info("Request to %s was cancelled", url)
+            _LOGGER.warning("Request to %s was cancelled", url)
             raise
 
     async def login(self) -> None:

tests/test_airos8.py

@@ -1,5 +1,6 @@
 """Additional tests for airos8 module."""
 
+from http.cookies import SimpleCookie
 import json
 from unittest.mock import AsyncMock, MagicMock, patch
 
@@ -11,8 +12,8 @@
 import aiohttp
 from mashumaro.exceptions import MissingField
 
-# pylint: disable=pointless-string-statement
-'''
+
+@pytest.mark.skip(reason="broken, needs investigation")
 @pytest.mark.asyncio
 async def test_login_no_csrf_token(airos_device: AirOS) -> None:
     """Test login response without a CSRF token header."""
@@ -26,11 +27,11 @@ async def test_login_no_csrf_token(airos_device: AirOS) -> None:
     mock_login_response.cookies = cookie  # Use the SimpleCookie object
     mock_login_response.headers = {}  # Simulate missing X-CSRF-ID
 
-    with patch.object(airos_device.session, "request", return_value=mock_login_response):
+    with patch.object(
+        airos_device.session, "request", return_value=mock_login_response
+    ):
         # We expect a return of None as the CSRF token is missing
-        result = await airos_device.login()
-        assert result is False
-'''
+        await airos_device.login()
 
 
 @pytest.mark.asyncio
@@ -149,8 +150,7 @@ async def test_stakick_no_mac_address(airos_device: AirOS) -> None:
         await airos_device.stakick(None)
 
 
-# pylint: disable=pointless-string-statement
-'''
+@pytest.mark.skip(reason="broken, needs investigation")
 @pytest.mark.asyncio
 async def test_stakick_non_200_response(airos_device: AirOS) -> None:
     """Test stakick() with a non-successful HTTP response."""
@@ -160,9 +160,10 @@ async def test_stakick_non_200_response(airos_device: AirOS) -> None:
     mock_stakick_response.text = AsyncMock(return_value="Error")
     mock_stakick_response.status = 500
 
-    with patch.object(airos_device.session, "request", return_value=mock_stakick_response):
+    with patch.object(
+        airos_device.session, "request", return_value=mock_stakick_response
+    ):
         assert not await airos_device.stakick("01:23:45:67:89:aB")
-'''
 
 
 @pytest.mark.asyncio
@@ -185,8 +186,7 @@ async def test_provmode_when_not_connected(airos_device: AirOS) -> None:
         await airos_device.provmode(active=True)
 
 
-# pylint: disable=pointless-string-statement
-'''
+@pytest.mark.skip(reason="broken, needs investigation")
 @pytest.mark.asyncio
 async def test_provmode_activate_success(airos_device: AirOS) -> None:
     """Test successful activation of provisioning mode."""
@@ -197,12 +197,13 @@ async def test_provmode_activate_success(airos_device: AirOS) -> None:
     mock_provmode_response.text = AsyncMock()
     mock_provmode_response.text.return_value = ""
 
-    with (
-        patch.object(airos_device.session, "request", return_value=mock_provmode_response)
+    with patch.object(
+        airos_device.session, "request", return_value=mock_provmode_response
     ):
         assert await airos_device.provmode(active=True)
 
 
+@pytest.mark.skip(reason="broken, needs investigation")
 @pytest.mark.asyncio
 async def test_provmode_deactivate_success(airos_device: AirOS) -> None:
     """Test successful deactivation of provisioning mode."""
@@ -219,6 +220,7 @@ async def test_provmode_deactivate_success(airos_device: AirOS) -> None:
         assert await airos_device.provmode(active=False)
 
 
+@pytest.mark.skip(reason="broken, needs investigation")
 @pytest.mark.asyncio
 async def test_provmode_non_200_response(airos_device: AirOS) -> None:
     """Test provmode() with a non-successful HTTP response."""
@@ -232,7 +234,6 @@ async def test_provmode_non_200_response(airos_device: AirOS) -> None:
         airos_device.session, "request", return_value=mock_provmode_response
     ):
         assert not await airos_device.provmode(active=True)
-'''
 
 
 @pytest.mark.asyncio

tests/test_stations.py

@@ -4,13 +4,15 @@
 import json
 import os
 from typing import Any
-from unittest.mock import AsyncMock, patch
+from unittest.mock import AsyncMock, MagicMock, patch
 
 from airos.airos8 import AirOS
-from airos.data import AirOS8Data as AirOSData
+from airos.data import AirOS8Data as AirOSData, Wireless
+from airos.exceptions import AirOSDeviceConnectionError, AirOSKeyDataMissingError
 import pytest
 
 import aiofiles
+from mashumaro import MissingField
 
 
 async def _read_fixture(fixture: str = "loco5ac_ap-ptp") -> Any:
@@ -26,8 +28,7 @@ async def _read_fixture(fixture: str = "loco5ac_ap-ptp") -> Any:
         pytest.fail(f"Invalid JSON in fixture file {path}: {e}")
 
 
-# pylint: disable=pointless-string-statement
-'''
+@pytest.mark.skip(reason="broken, needs investigation")
 @patch("airos.airos8._LOGGER")
 @pytest.mark.asyncio
 async def test_status_logs_redacted_data_on_invalid_value(
@@ -91,11 +92,9 @@ async def test_status_logs_redacted_data_on_invalid_value(
     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"
-'''
 
 
-# pylint: disable=pointless-string-statement
-'''
+@pytest.mark.skip(reason="broken, needs investigation")
 @patch("airos.airos8._LOGGER")
 @pytest.mark.asyncio
 async def test_status_logs_exception_on_missing_field(
@@ -139,7 +138,6 @@ async def test_status_logs_exception_on_missing_field(
     assert log_args[0] == "API call to %s failed with status %d: %s"
     assert log_args[2] == 500
     assert log_args[3] == "Error"
-'''
 
 
 @pytest.mark.parametrize(
@@ -157,8 +155,6 @@ async def test_status_logs_exception_on_missing_field(
 async def test_ap_object(
     airos_device: AirOS, base_url: str, mode: str, fixture: str
 ) -> None:
-    """Test device operation."""
-
     """Test device operation using the new _request_json method."""
     fixture_data = await _read_fixture(fixture)
 
@@ -190,8 +186,7 @@ async def test_ap_object(
     cookie["AIROS_TOKEN"] = "abc123"
 
 
-# pylint: disable=pointless-string-statement
-'''
+@pytest.mark.skip(reason="broken, needs investigation")
 @pytest.mark.asyncio
 async def test_reconnect(airos_device: AirOS, base_url: str) -> None:
     """Test reconnect client."""
@@ -209,82 +204,3 @@ async def test_reconnect(airos_device: AirOS, base_url: str) -> None:
         patch.object(airos_device, "connected", True),
     ):
         assert await airos_device.stakick("01:23:45:67:89:aB")
-'''
-
-
-# pylint: disable=pointless-string-statement
-'''
-@pytest.mark.asyncio
-async def test_ap_corners(
-    airos_device: AirOS, base_url: str, mode: str = "ap-ptp"
-) -> None:
-    """Test device operation."""
-    cookie = SimpleCookie()
-    cookie["session_id"] = "test-cookie"
-    cookie["AIROS_TOKEN"] = "abc123"
-
-    mock_login_response = MagicMock()
-    mock_login_response.__aenter__.return_value = mock_login_response
-    mock_login_response.text = AsyncMock(return_value="{}")
-    mock_login_response.status = 200
-    mock_login_response.cookies = cookie
-    mock_login_response.headers = {"X-CSRF-ID": "test-csrf-token"}
-
-    # Test case 1: Successful login
-    with (
-        patch.object(airos_device.session, "post", return_value=mock_login_response),
-        patch.object(airos_device, "_use_json_for_login_post", return_value=True),
-    ):
-        assert await airos_device.login()
-
-    # Test case 2: Login fails with missing cookies (expects an exception)
-    mock_login_response.cookies = {}
-    with (
-        patch.object(airos_device.session, "post", return_value=mock_login_response),
-        patch.object(airos_device, "_use_json_for_login_post", return_value=True),
-        pytest.raises(AirOSConnectionSetupError),
-    ):
-        # Only call the function; no return value to assert.
-        await airos_device.login()
-
-    # Test case 3: Login successful, returns None due to missing headers
-    mock_login_response.cookies = cookie
-    mock_login_response.headers = {}
-    with (
-        patch.object(airos_device.session, "post", return_value=mock_login_response),
-        patch.object(airos_device, "_use_json_for_login_post", return_value=True),
-    ):
-        result = await airos_device.login()
-        assert result is False
-
-    # Test case 4: Login fails with bad data from the API (expects an exception)
-    mock_login_response.headers = {"X-CSRF-ID": "test-csrf-token"}
-    mock_login_response.text = AsyncMock(return_value="abc123")
-    with (
-        patch.object(airos_device.session, "post", return_value=mock_login_response),
-        patch.object(airos_device, "_use_json_for_login_post", return_value=True),
-        pytest.raises(AirOSDataMissingError),
-    ):
-        # Only call the function; no return value to assert.
-        await airos_device.login()
-
-    # Test case 5: Login fails due to HTTP status code (expects an exception)
-    mock_login_response.text = AsyncMock(return_value="{}")
-    mock_login_response.status = 400
-    with (
-        patch.object(airos_device.session, "post", return_value=mock_login_response),
-        patch.object(airos_device, "_use_json_for_login_post", return_value=True),
-        pytest.raises(AirOSConnectionAuthenticationError),
-    ):
-        # Only call the function; no return value to assert.
-        await airos_device.login()
-
-    # Test case 6: Login fails due to client-level connection error (expects an exception)
-    mock_login_response.status = 200
-    with (
-        patch.object(airos_device.session, "post", side_effect=aiohttp.ClientError),
-        pytest.raises(AirOSDeviceConnectionError),
-    ):
-        # Only call the function; no return value to assert.
-        await airos_device.login()
-'''