aiohomematic-test-support 2025.11.11__tar.gz → 2025.12.3__tar.gz

{aiohomematic_test_support-2025.11.11/aiohomematic_test_support.egg-info → aiohomematic_test_support-2025.12.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aiohomematic-test-support
-Version: 2025.11.11
+Version: 2025.12.3
 Summary: Support-only package for AioHomematic (tests/dev). Not part of production builds.
 Author-email: SukramJ <sukramj@icloud.com>
 Project-URL: Homepage, https://github.com/SukramJ/aiohomematic

aiohomematic_test_support-2025.12.3/__init__.py

@@ -0,0 +1,48 @@
+"""
+Test support infrastructure for aiohomematic.
+
+Overview
+--------
+This package provides reusable test utilities for testing aiohomematic functionality
+without requiring a live Homematic backend. It includes factories for creating test
+instances, mock implementations for RPC communication, and session playback capabilities
+for reproducible testing.
+
+Key Components
+--------------
+- **factory**: Factory classes for creating CentralUnit and Client instances with
+  pre-recorded or mocked backend responses.
+- **mock**: Mock implementations for XML-RPC and JSON-RPC clients with session
+  playback support for deterministic testing.
+- **helper**: Test helper utilities for common testing operations.
+- **const**: Test-specific constants and configuration values.
+
+Usage Example
+-------------
+Using the factory to create a test central with session playback:
+
+    from aiohomematic_test_support.factory import FactoryWithClient
+    from aiohomematic_test_support.mock import SessionPlayer
+
+    player = SessionPlayer(session_data_path="tests/data/ccu_session.zip")
+    factory = FactoryWithClient(player=player)
+    central, client = await factory()
+
+    # Test operations
+    await central.start()
+    device = central.get_device_by_address("VCU0000001")
+    await central.stop()
+
+The session player replays pre-recorded backend responses, enabling fast and
+reproducible tests without backend dependencies.
+
+Notes
+-----
+This is a separate package from the main aiohomematic library. Install with
+test dependencies to access test support functionality.
+
+"""
+
+from __future__ import annotations
+
+__version__ = "2025.12.3"

{aiohomematic_test_support-2025.11.11 → aiohomematic_test_support-2025.12.3/aiohomematic_test_support.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aiohomematic-test-support
-Version: 2025.11.11
+Version: 2025.12.3
 Summary: Support-only package for AioHomematic (tests/dev). Not part of production builds.
 Author-email: SukramJ <sukramj@icloud.com>
 Project-URL: Homepage, https://github.com/SukramJ/aiohomematic

{aiohomematic_test_support-2025.11.11 → aiohomematic_test_support-2025.12.3}/const.py

@@ -13,6 +13,13 @@ CCU_PORT = 2002
 CCU_MINI_PORT = 2003
 INTERFACE_ID = f"{CENTRAL_NAME}-{Interface.BIDCOS_RF}"
 
+# Backend info response for get_backend_info.fn script
+BACKEND_INFO_JSON = {
+    "version": "3.75.6.20240316",
+    "product": "CCU3",
+    "hostname": "ccu-test",
+}
+
 FULL_SESSION_RANDOMIZED_PYDEVCCU = "full_session_randomized_pydevccu.zip"
 FULL_SESSION_RANDOMIZED_CCU = "full_session_randomized_ccu.zip"
 

{aiohomematic_test_support-2025.11.11 → aiohomematic_test_support-2025.12.3}/factory.py

@@ -1,26 +1,56 @@
-"""Factories for tests."""
+"""
+Test factories for creating CentralUnit and Client instances.
+
+This module provides factory classes that simplify the creation of test instances
+with pre-configured mocks and session playback. Factories handle the complexity of
+setting up CentralConfig, InterfaceConfig, and mock RPC clients.
+
+Key Classes
+-----------
+- **FactoryWithClient**: Factory for creating a CentralUnit with a single mocked client.
+- **CentralClientFactory**: Factory for creating central with multiple clients.
+
+Usage Pattern
+-------------
+Factories use the builder pattern with fluent configuration:
+
+    factory = FactoryWithClient(
+        player=session_player,
+        do_mock_client=True,
+        ignore_devices_on_create=["VCU0000099"],
+    )
+    central, client = await factory()
+
+    # Use central and client for testing
+    await central.start()
+    # ... test operations ...
+    await central.stop()
+
+Public API of this module is defined by __all__.
+"""
 
 from __future__ import annotations
 
 import asyncio
-from collections.abc import AsyncGenerator
+from collections.abc import AsyncGenerator, Callable
 import contextlib
 import logging
-from typing import Any, Self, cast
+from typing import Self, cast
 from unittest.mock import MagicMock, Mock, patch
 
 from aiohttp import ClientSession
 
 from aiohomematic.central import CentralConfig, CentralUnit
-from aiohomematic.client import Client, ClientConfig, InterfaceConfig
+from aiohomematic.central.event_bus import BackendSystemEventData, HomematicEvent
+from aiohomematic.client import ClientConfig, InterfaceConfig
 from aiohomematic.const import LOCAL_HOST, BackendSystemEvent, Interface, OptionalSettings
+from aiohomematic.interfaces import ClientProtocol
 from aiohomematic_test_support import const
 from aiohomematic_test_support.mock import SessionPlayer, get_client_session, get_mock, get_xml_rpc_proxy
 
 _LOGGER = logging.getLogger(__name__)
 
 
-# pylint: disable=protected-access
 class FactoryWithClient:
     """Factory for a central with one local client."""
 
@@ -51,6 +81,13 @@ class FactoryWithClient:
         )
         self.system_event_mock = MagicMock()
         self.ha_event_mock = MagicMock()
+        self._event_bus_unsubscribe_handlers: list[Callable[[], None]] = []
+
+    def cleanup_event_bus_subscriptions(self) -> None:
+        """Clean up all event bus subscriptions."""
+        for unsubscribe in self._event_bus_unsubscribe_handlers:
+            unsubscribe()
+        self._event_bus_unsubscribe_handlers.clear()
 
     async def get_default_central(self, *, start: bool = True) -> CentralUnit:
         """Return a central based on give address_device_translation."""
@@ -64,7 +101,7 @@ class FactoryWithClient:
         if self._do_mock_client:
             _orig_create_client = ClientConfig.create_client
 
-            async def _mocked_create_client(config: ClientConfig) -> Client | Mock:
+            async def _mocked_create_client(config: ClientConfig) -> ClientProtocol | Mock:
                 real_client = await _orig_create_client(config)
                 return cast(
                     Mock,
@@ -79,7 +116,7 @@ class FactoryWithClient:
 
         if start:
             await central.start()
-            await central._init_hub()
+            await central.hub_coordinator.init_hub()
         assert central
         return central
 
@@ -100,8 +137,23 @@ class FactoryWithClient:
             optional_settings=(OptionalSettings.ENABLE_LINKED_ENTITY_CLIMATE_ACTIVITY,),
         ).create_central()
 
-        central.register_backend_system_callback(cb=self.system_event_mock)
-        central.register_homematic_callback(cb=self.ha_event_mock)
+        # Subscribe to events via event bus
+        def _system_event_handler(event: BackendSystemEventData) -> None:
+            """Handle backend system events."""
+            self.system_event_mock(event)
+
+        def _ha_event_handler(event: HomematicEvent) -> None:
+            """Handle homematic events."""
+            self.ha_event_mock(event)
+
+        self._event_bus_unsubscribe_handlers.append(
+            central.event_bus.subscribe(
+                event_type=BackendSystemEventData, event_key=None, handler=_system_event_handler
+            )
+        )
+        self._event_bus_unsubscribe_handlers.append(
+            central.event_bus.subscribe(event_type=HomematicEvent, event_key=None, handler=_ha_event_handler)
+        )
 
         assert central
         self._client_session.set_central(central=central)  # type: ignore[attr-defined]
@@ -160,7 +212,7 @@ async def get_central_client_factory(
     ignore_devices_on_create: list[str] | None,
     ignore_custom_device_definition_models: list[str] | None,
     un_ignore_list: list[str] | None,
-) -> AsyncGenerator[tuple[CentralUnit, Client | Mock, FactoryWithClient]]:
+) -> AsyncGenerator[tuple[CentralUnit, ClientProtocol | Mock, FactoryWithClient]]:
     """Return central factory."""
     factory = FactoryWithClient(
         player=player,
@@ -176,6 +228,7 @@ async def get_central_client_factory(
     try:
         yield central, client, factory
     finally:
+        factory.cleanup_event_bus_subscriptions()
         await central.stop()
         await central.clear_files()
 
@@ -188,8 +241,9 @@ async def get_pydev_ccu_central_unit_full(
     """Create and yield central, after all devices have been created."""
     device_event = asyncio.Event()
 
-    def systemcallback(system_event: Any, *args: Any, **kwargs: Any) -> None:
-        if system_event == BackendSystemEvent.DEVICES_CREATED:
+    def system_event_handler(event: BackendSystemEventData) -> None:
+        """Handle backend system events."""
+        if event.system_event == BackendSystemEvent.DEVICES_CREATED:
             device_event.set()
 
     interface_configs = {
@@ -211,7 +265,7 @@ async def get_pydev_ccu_central_unit_full(
         program_markers=(),
         sysvar_markers=(),
     ).create_central()
-    central.register_backend_system_callback(cb=systemcallback)
+    central.event_bus.subscribe(event_type=BackendSystemEventData, event_key=None, handler=system_event_handler)
     await central.start()
 
     # Wait up to 60 seconds for the DEVICES_CREATED event which signals that all devices are available

{aiohomematic_test_support-2025.11.11 → aiohomematic_test_support-2025.12.3}/helper.py

@@ -11,7 +11,7 @@ import orjson
 
 from aiohomematic.central import CentralUnit
 from aiohomematic.const import UTF_8
-from aiohomematic.model.custom import CustomDataPoint
+from aiohomematic.interfaces import CustomDataPointProtocol
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -29,10 +29,12 @@ def _load_json_file(anchor: str, resource: str, file_name: str) -> Any | None:
         return orjson.loads(fptr.read())
 
 
-def get_prepared_custom_data_point(central: CentralUnit, address: str, channel_no: int) -> CustomDataPoint | None:
+def get_prepared_custom_data_point(
+    central: CentralUnit, address: str, channel_no: int
+) -> CustomDataPointProtocol | None:
     """Return the hm custom_data_point."""
     if cdp := central.get_custom_data_point(address=address, channel_no=channel_no):
-        for dp in cdp._data_points.values():
+        for dp in cdp._data_points.values():  # type: ignore[attr-defined]
             dp._state_uncertain = False
         return cdp
     return None

{aiohomematic_test_support-2025.11.11 → aiohomematic_test_support-2025.12.3}/mock.py

@@ -1,4 +1,37 @@
-"""Mocks for tests."""
+"""
+Mock implementations for RPC clients with session playback.
+
+This module provides mock RPC proxy implementations that replay pre-recorded
+backend responses from session data files. This enables deterministic, fast
+testing without live Homematic backend dependencies.
+
+Key Classes
+-----------
+- **SessionPlayer**: Loads and plays back recorded RPC session data from ZIP archives.
+- **get_mock**: Creates mock instances of data points and devices with configurable
+  method/property exclusions.
+- **get_xml_rpc_proxy**: Returns mock XML-RPC proxy with session playback.
+- **get_client_session**: Returns mock aiohttp ClientSession for JSON-RPC tests.
+
+Session Playback
+----------------
+Session data is stored in ZIP archives containing JSON files with recorded
+RPC method calls and responses. The SessionPlayer replays these responses
+when tests invoke RPC methods:
+
+    player = SessionPlayer(session_data_path="tests/data/ccu_full.zip")
+    proxy = get_xml_rpc_proxy(player=player, interface="BidCos-RF")
+
+    # Calls return pre-recorded responses
+    devices = await proxy.listDevices()
+
+This approach provides:
+- Fast test execution (no network I/O)
+- Reproducible results (same responses every time)
+- Offline testing (no backend required)
+
+Public API of this module is defined by __all__.
+"""
 
 from __future__ import annotations
 
@@ -141,6 +174,15 @@ def get_client_session(  # noqa: C901
                             }
                         )
 
+                    if "get_backend_info" in params[_JsonKey.SCRIPT]:
+                        return _MockResponse(
+                            json_data={
+                                _JsonKey.ID: 0,
+                                _JsonKey.RESULT: const.BACKEND_INFO_JSON,
+                                _JsonKey.ERROR: None,
+                            }
+                        )
+
                 if method == _JsonRpcMethod.INTERFACE_SET_VALUE:
                     await self._central.data_point_event(
                         interface_id=params[_JsonKey.INTERFACE],
@@ -491,7 +533,6 @@ class SessionPlayer:
         When a ZIP archive is provided, the first JSON member inside the archive
         will be loaded.
         """
-
         if self.supports_file_id(file_id=file_id):
             return DataOperationResult.NO_LOAD
 

aiohomematic_test_support-2025.11.11/__init__.py

@@ -1,2 +0,0 @@
-__version__ = "2025.11.11"
-"""Module to support aiohomematic testing with a local client."""