core/tests/components/hive/test_init.py

"""Tests for the Hive integration __init__."""

from typing import Any
from unittest.mock import AsyncMock, MagicMock, patch

from homeassistant.components.hive.const import DOMAIN
from homeassistant.const import CONF_PASSWORD, CONF_USERNAME
from homeassistant.core import HomeAssistant
from homeassistant.helpers import device_registry as dr

from tests.common import MockConfigEntry

_ENTRY_DATA = {
    CONF_USERNAME: "user@example.com",
    CONF_PASSWORD: "password",
    "tokens": {
        "AuthenticationResult": {
            "AccessToken": "mock-access-token",
            "RefreshToken": "mock-refresh-token",
        },
        "ChallengeName": "SUCCESS",
    },
}

_HUB_BASE = {
    "device_id": "hive-hub-id",
    "hiveName": "Hive Hub",
    "deviceData": {
        "model": "Hub",
        "version": "1.2.3",
        "manufacturer": "Hive",
        "online": True,
    },
}

_CHILD_BINARY_SENSOR = {
    "device_id": "hive-child-id",
    "hiveID": "hive-child-id",
    "hiveName": "Hive Hub Connectivity",
    "haName": "Hub Connectivity",
    "device_name": "Hive Hub",
    "hiveType": "Connectivity",
    "parentDevice": "hive-hub-id",
    "deviceData": {
        "model": "Hub",
        "version": "1.2.3",
        "manufacturer": "Hive",
        "online": True,
    },
    "status": {"state": True},
}


def _make_mock_hive(
    hub_extra: dict, extra_devices: dict[str, list[dict[str, Any]]] | None = None
) -> MagicMock:
    """Return a mocked Hive instance.

    startSession returns a minimal devices dict.
    """
    hub_data = {**_HUB_BASE, **hub_extra}
    devices = {"parent": [hub_data], **(extra_devices or {})}
    mock_hive = MagicMock()
    mock_hive.session.startSession = AsyncMock(return_value=devices)
    mock_hive.session.deviceList = devices
    return mock_hive


async def test_hub_device_registers_mac_connection(
    hass: HomeAssistant,
    device_registry: dr.DeviceRegistry,
) -> None:
    """Hub device entry includes a MAC connection when macAddress is present."""
    entry = MockConfigEntry(domain=DOMAIN, data=_ENTRY_DATA)
    entry.add_to_hass(hass)

    mock_hive = _make_mock_hive({"macAddress": "00:1C:2B:1C:2E:68"})

    with patch(
        "homeassistant.components.hive.Hive",
        return_value=mock_hive,
    ):
        await hass.config_entries.async_setup(entry.entry_id)
        await hass.async_block_till_done()

    device = device_registry.async_get_device(identifiers={(DOMAIN, "hive-hub-id")})
    assert device is not None
    assert (dr.CONNECTION_NETWORK_MAC, "00:1c:2b:1c:2e:68") in device.connections


async def test_hub_device_no_mac_connection_when_absent(
    hass: HomeAssistant,
    device_registry: dr.DeviceRegistry,
) -> None:
    """Hub device entry has no MAC connection when macAddress is absent."""
    entry = MockConfigEntry(domain=DOMAIN, data=_ENTRY_DATA)
    entry.add_to_hass(hass)

    mock_hive = _make_mock_hive({})  # no macAddress key

    with patch(
        "homeassistant.components.hive.Hive",
        return_value=mock_hive,
    ):
        await hass.config_entries.async_setup(entry.entry_id)
        await hass.async_block_till_done()

    device = device_registry.async_get_device(identifiers={(DOMAIN, "hive-hub-id")})
    assert device is not None
    assert not any(
        conn_type == dr.CONNECTION_NETWORK_MAC for conn_type, _ in device.connections
    )


async def test_child_device_links_to_hub_via_device_id(
    hass: HomeAssistant,
    device_registry: dr.DeviceRegistry,
) -> None:
    """A child device's via_device_id should point at the hub device's id."""
    entry = MockConfigEntry(domain=DOMAIN, data=_ENTRY_DATA)
    entry.add_to_hass(hass)

    mock_hive = _make_mock_hive(
        {"macAddress": "00:1C:2B:1C:2E:68"},
        {"binary_sensor": [_CHILD_BINARY_SENSOR], "sensor": []},
    )
    mock_hive.session.updateData = AsyncMock()
    mock_hive.sensor.getSensor = AsyncMock(side_effect=lambda device: device)

    with patch(
        "homeassistant.components.hive.Hive",
        return_value=mock_hive,
    ):
        await hass.config_entries.async_setup(entry.entry_id)
        await hass.async_block_till_done()

    hub_device = device_registry.async_get_device_by_identifier(
        (DOMAIN, "hive-hub-id"), entry.entry_id
    )
    child_device = device_registry.async_get_device_by_identifier(
        (DOMAIN, "hive-child-id"), entry.entry_id
    )
    assert hub_device is not None
    assert child_device is not None
    assert child_device.via_device_id == hub_device.id