Add mysensors sensor platform test foundation (#51548)

tests/components/mysensors/conftest.py

@@ -1,10 +1,158 @@
 """Provide common mysensors fixtures."""
+from __future__ import annotations
+
+from collections.abc import AsyncGenerator, Generator
+import json
+from typing import Any
+from unittest.mock import MagicMock, patch
+
+from mysensors.persistence import MySensorsJSONDecoder
+from mysensors.sensor import Sensor
 import pytest
 
 from homeassistant.components.mqtt import DOMAIN as MQTT_DOMAIN
+from homeassistant.components.mysensors import CONF_VERSION, DEFAULT_BAUD_RATE
+from homeassistant.components.mysensors.const import (
+    CONF_BAUD_RATE,
+    CONF_DEVICE,
+    CONF_GATEWAY_TYPE,
+    CONF_GATEWAY_TYPE_SERIAL,
+    CONF_GATEWAYS,
+    DOMAIN,
+)
+from homeassistant.core import HomeAssistant
+from homeassistant.setup import async_setup_component
+
+from tests.common import MockConfigEntry, load_fixture
+
+
+@pytest.fixture(autouse=True)
+def device_tracker_storage(mock_device_tracker_conf):
+    """Mock out device tracker known devices storage."""
+    devices = mock_device_tracker_conf
+    return devices
 
 
 @pytest.fixture(name="mqtt")
-async def mock_mqtt_fixture(hass):
+def mock_mqtt_fixture(hass) -> None:
     """Mock the MQTT integration."""
     hass.config.components.add(MQTT_DOMAIN)
+
+
+@pytest.fixture(name="is_serial_port")
+def is_serial_port_fixture() -> Generator[MagicMock, None, None]:
+    """Patch the serial port check."""
+    with patch("homeassistant.components.mysensors.gateway.cv.isdevice") as is_device:
+        is_device.side_effect = lambda device: device
+        yield is_device
+
+
+@pytest.fixture(name="gateway_nodes")
+def gateway_nodes_fixture() -> dict[int, Sensor]:
+    """Return the gateway nodes dict."""
+    return {}
+
+
+@pytest.fixture(name="serial_transport")
+async def serial_transport_fixture(
+    gateway_nodes: dict[int, Sensor],
+    is_serial_port: MagicMock,
+) -> AsyncGenerator[dict[int, Sensor], None]:
+    """Mock a serial transport."""
+    with patch(
+        "mysensors.gateway_serial.AsyncTransport", autospec=True
+    ) as transport_class, patch("mysensors.AsyncTasks", autospec=True) as tasks_class:
+        tasks = tasks_class.return_value
+        tasks.persistence = MagicMock
+
+        mock_gateway_features(tasks, transport_class, gateway_nodes)
+
+        yield transport_class
+
+
+def mock_gateway_features(
+    tasks: MagicMock, transport_class: MagicMock, nodes: dict[int, Sensor]
+) -> None:
+    """Mock the gateway features."""
+
+    async def mock_start_persistence():
+        """Load nodes from via persistence."""
+        gateway = transport_class.call_args[0][0]
+        gateway.sensors.update(nodes)
+
+    tasks.start_persistence.side_effect = mock_start_persistence
+
+    async def mock_start():
+        """Mock the start method."""
+        gateway = transport_class.call_args[0][0]
+        gateway.on_conn_made(gateway)
+
+    tasks.start.side_effect = mock_start
+
+
+@pytest.fixture(name="transport")
+def transport_fixture(serial_transport: MagicMock) -> MagicMock:
+    """Return the default mocked transport."""
+    return serial_transport
+
+
+@pytest.fixture(name="serial_entry")
+async def serial_entry_fixture(hass) -> MockConfigEntry:
+    """Create a config entry for a serial gateway."""
+    entry = MockConfigEntry(
+        domain=DOMAIN,
+        data={
+            CONF_GATEWAY_TYPE: CONF_GATEWAY_TYPE_SERIAL,
+            CONF_VERSION: "2.3",
+            CONF_DEVICE: "/test/device",
+            CONF_BAUD_RATE: DEFAULT_BAUD_RATE,
+        },
+    )
+    return entry
+
+
+@pytest.fixture(name="config_entry")
+def config_entry_fixture(serial_entry: MockConfigEntry) -> MockConfigEntry:
+    """Provide the config entry used for integration set up."""
+    return serial_entry
+
+
+@pytest.fixture
+async def integration(
+    hass: HomeAssistant, transport: MagicMock, config_entry: MockConfigEntry
+) -> AsyncGenerator[MockConfigEntry, None]:
+    """Set up the mysensors integration with a config entry."""
+    device = config_entry.data[CONF_DEVICE]
+    config: dict[str, Any] = {DOMAIN: {CONF_GATEWAYS: [{CONF_DEVICE: device}]}}
+    config_entry.add_to_hass(hass)
+    with patch("homeassistant.components.mysensors.device.UPDATE_DELAY", new=0):
+        await async_setup_component(hass, DOMAIN, config)
+        await hass.async_block_till_done()
+        yield config_entry
+
+
+def load_nodes_state(fixture_path: str) -> dict:
+    """Load mysensors nodes fixture."""
+    return json.loads(load_fixture(fixture_path), cls=MySensorsJSONDecoder)
+
+
+def update_gateway_nodes(
+    gateway_nodes: dict[int, Sensor], nodes: dict[int, Sensor]
+) -> dict:
+    """Update the gateway nodes."""
+    gateway_nodes.update(nodes)
+    return nodes
+
+
+@pytest.fixture(name="gps_sensor_state", scope="session")
+def gps_sensor_state_fixture() -> dict:
+    """Load the gps sensor state."""
+    return load_nodes_state("mysensors/gps_sensor_state.json")
+
+
+@pytest.fixture
+def gps_sensor(gateway_nodes, gps_sensor_state) -> Sensor:
+    """Load the gps sensor."""
+    nodes = update_gateway_nodes(gateway_nodes, gps_sensor_state)
+    node = nodes[1]
+    return node

tests/components/mysensors/test_sensor.py

@@ -0,0 +1,10 @@
+"""Provide tests for mysensors sensor platform."""
+
+
+async def test_gps_sensor(hass, gps_sensor, integration):
+    """Test a gps sensor."""
+    entity_id = "sensor.gps_sensor_1_1"
+
+    state = hass.states.get(entity_id)
+
+    assert state.state == "40.741894,-73.989311,12"

tests/fixtures/mysensors/gps_sensor_state.json

@@ -0,0 +1,21 @@
+{
+    "1": {
+        "sensor_id": 1,
+        "children": {
+            "1": {
+                "id": 1,
+                "type": 38,
+                "description": "",
+                "values": {
+                    "49": "40.741894,-73.989311,12"
+                }
+            }
+        },
+        "type": 17,
+        "sketch_name": "GPS Sensor",
+        "sketch_version": "1.0",
+        "battery_level": 0,
+        "protocol_version": "2.3.2",
+        "heartbeat": 0
+    }
+}