hass-core/tests/components/homekit/test_diagnostics.py

"""Test homekit diagnostics."""

from unittest.mock import ANY, MagicMock, patch

import pytest

from homeassistant.components.homekit.const import (
    CONF_DEVICES,
    CONF_HOMEKIT_MODE,
    DOMAIN,
    HOMEKIT_MODE_ACCESSORY,
)
from homeassistant.const import CONF_NAME, CONF_PORT, EVENT_HOMEASSISTANT_STARTED
from homeassistant.core import HomeAssistant
from homeassistant.helpers import device_registry as dr, entity_registry as er
from homeassistant.setup import async_setup_component

from .util import async_init_integration

from tests.common import MockConfigEntry
from tests.components.diagnostics import get_diagnostics_for_config_entry
from tests.typing import ClientSessionGenerator


@pytest.mark.usefixtures("mock_async_zeroconf")
async def test_config_entry_not_running(
    hass: HomeAssistant,
    hass_client: ClientSessionGenerator,
    hk_driver,
) -> None:
    """Test generating diagnostics for a config entry."""
    entry = await async_init_integration(hass)
    diag = await get_diagnostics_for_config_entry(hass, hass_client, entry)
    assert diag == {
        "config-entry": {
            "data": {"name": "mock_name", "port": 12345},
            "options": {},
            "title": "Mock Title",
            "version": 1,
        },
        "status": 0,
    }


@pytest.mark.usefixtures("mock_async_zeroconf")
async def test_config_entry_running(
    hass: HomeAssistant,
    hass_client: ClientSessionGenerator,
    hk_driver,
) -> None:
    """Test generating diagnostics for a bridge config entry."""
    entry = MockConfigEntry(
        domain=DOMAIN, data={CONF_NAME: "mock_name", CONF_PORT: 12345}
    )
    entry.add_to_hass(hass)
    assert await hass.config_entries.async_setup(entry.entry_id)
    hass.bus.async_fire(EVENT_HOMEASSISTANT_STARTED)
    await hass.async_block_till_done()
    diag = await get_diagnostics_for_config_entry(hass, hass_client, entry)
    assert diag == {
        "bridge": {},
        "iid_storage": {
            "1": {
                "3E__14_": 2,
                "3E__20_": 3,
                "3E__21_": 4,
                "3E__23_": 5,
                "3E__30_": 6,
                "3E__52_": 7,
                "A2__37_": 9,
                "A2___": 8,
            }
        },
        "accessories": [
            {
                "aid": 1,
                "services": [
                    {
                        "characteristics": [
                            {"format": "bool", "iid": 2, "perms": ["pw"], "type": "14"},
                            {
                                "format": "string",
                                "iid": 3,
                                "perms": ["pr"],
                                "type": "20",
                                "value": "Home Assistant",
                            },
                            {
                                "format": "string",
                                "iid": 4,
                                "perms": ["pr"],
                                "type": "21",
                                "value": "Bridge",
                            },
                            {
                                "format": "string",
                                "iid": 5,
                                "perms": ["pr"],
                                "type": "23",
                                "value": "mock_name",
                            },
                            {
                                "format": "string",
                                "iid": 6,
                                "perms": ["pr"],
                                "type": "30",
                                "value": "homekit.bridge",
                            },
                            {
                                "format": "string",
                                "iid": 7,
                                "perms": ["pr"],
                                "type": "52",
                                "value": ANY,
                            },
                        ],
                        "iid": 1,
                        "type": "3E",
                    },
                    {
                        "characteristics": [
                            {
                                "format": "string",
                                "iid": 9,
                                "perms": ["pr", "ev"],
                                "type": "37",
                                "value": "01.01.00",
                            }
                        ],
                        "iid": 8,
                        "type": "A2",
                    },
                ],
            }
        ],
        "client_properties": {},
        "config-entry": {
            "data": {"name": "mock_name", "port": 12345},
            "options": {},
            "title": "Mock Title",
            "version": 1,
        },
        "config_version": 2,
        "pairing_id": ANY,
        "status": 1,
    }

    with (
        patch("pyhap.accessory_driver.AccessoryDriver.async_start"),
        patch("homeassistant.components.homekit.HomeKit.async_stop"),
        patch("homeassistant.components.homekit.async_port_is_available"),
    ):
        assert await hass.config_entries.async_unload(entry.entry_id)
        await hass.async_block_till_done()


@pytest.mark.usefixtures("mock_async_zeroconf")
async def test_config_entry_accessory(
    hass: HomeAssistant,
    hass_client: ClientSessionGenerator,
    hk_driver,
) -> None:
    """Test generating diagnostics for an accessory config entry."""
    hass.states.async_set("light.demo", "on")

    entry = MockConfigEntry(
        domain=DOMAIN,
        data={
            CONF_NAME: "mock_name",
            CONF_PORT: 12345,
            CONF_HOMEKIT_MODE: HOMEKIT_MODE_ACCESSORY,
            "filter": {
                "exclude_domains": [],
                "exclude_entities": [],
                "include_domains": [],
                "include_entities": ["light.demo"],
            },
        },
    )
    entry.add_to_hass(hass)
    assert await hass.config_entries.async_setup(entry.entry_id)
    hass.bus.async_fire(EVENT_HOMEASSISTANT_STARTED)
    await hass.async_block_till_done()
    diag = await get_diagnostics_for_config_entry(hass, hass_client, entry)
    assert diag == {
        "accessories": [
            {
                "aid": 1,
                "services": [
                    {
                        "characteristics": [
                            {"format": "bool", "iid": 2, "perms": ["pw"], "type": "14"},
                            {
                                "format": "string",
                                "iid": 3,
                                "perms": ["pr"],
                                "type": "20",
                                "value": "Home Assistant Light",
                            },
                            {
                                "format": "string",
                                "iid": 4,
                                "perms": ["pr"],
                                "type": "21",
                                "value": "Light",
                            },
                            {
                                "format": "string",
                                "iid": 5,
                                "perms": ["pr"],
                                "type": "23",
                                "value": "demo",
                            },
                            {
                                "format": "string",
                                "iid": 6,
                                "perms": ["pr"],
                                "type": "30",
                                "value": "light.demo",
                            },
                            {
                                "format": "string",
                                "iid": 7,
                                "perms": ["pr"],
                                "type": "52",
                                "value": ANY,
                            },
                        ],
                        "iid": 1,
                        "type": "3E",
                    },
                    {
                        "characteristics": [
                            {
                                "format": "string",
                                "iid": 9,
                                "perms": ["pr", "ev"],
                                "type": "37",
                                "value": "01.01.00",
                            }
                        ],
                        "iid": 8,
                        "type": "A2",
                    },
                    {
                        "characteristics": [
                            {
                                "format": "bool",
                                "iid": 11,
                                "perms": ["pr", "pw", "ev"],
                                "type": "25",
                                "value": True,
                            }
                        ],
                        "iid": 10,
                        "type": "43",
                    },
                ],
            }
        ],
        "accessory": {
            "aid": 1,
            "category": 5,
            "config": {},
            "entity_id": "light.demo",
            "entity_state": {
                "attributes": {},
                "context": {"id": ANY, "parent_id": None, "user_id": None},
                "entity_id": "light.demo",
                "last_changed": ANY,
                "last_reported": ANY,
                "last_updated": ANY,
                "state": "on",
            },
            "name": "demo",
        },
        "client_properties": {},
        "config-entry": {
            "data": {"name": "mock_name", "port": 12345},
            "options": {
                "filter": {
                    "exclude_domains": [],
                    "exclude_entities": [],
                    "include_domains": [],
                    "include_entities": ["light.demo"],
                },
                "mode": "accessory",
            },
            "title": "Mock Title",
            "version": 1,
        },
        "config_version": 2,
        "pairing_id": ANY,
        "iid_storage": {
            "1": {
                "3E__14_": 2,
                "3E__20_": 3,
                "3E__21_": 4,
                "3E__23_": 5,
                "3E__30_": 6,
                "3E__52_": 7,
                "43__25_": 11,
                "43___": 10,
                "A2__37_": 9,
                "A2___": 8,
            }
        },
        "status": 1,
    }
    with (
        patch("pyhap.accessory_driver.AccessoryDriver.async_start"),
        patch("homeassistant.components.homekit.HomeKit.async_stop"),
        patch("homeassistant.components.homekit.async_port_is_available"),
    ):
        assert await hass.config_entries.async_unload(entry.entry_id)
        await hass.async_block_till_done()


@pytest.mark.usefixtures("mock_async_zeroconf")
async def test_config_entry_with_trigger_accessory(
    hass: HomeAssistant,
    hass_client: ClientSessionGenerator,
    hk_driver,
    events,
    demo_cleanup,
    device_registry: dr.DeviceRegistry,
    entity_registry: er.EntityRegistry,
) -> None:
    """Test generating diagnostics for a bridge config entry with a trigger accessory."""
    assert await async_setup_component(hass, "homeassistant", {})
    assert await async_setup_component(hass, "demo", {"demo": {}})
    hk_driver.publish = MagicMock()

    demo_config_entry = MockConfigEntry(domain="domain")
    demo_config_entry.add_to_hass(hass)
    assert await async_setup_component(hass, "demo", {"demo": {}})
    await hass.async_block_till_done()

    entry = entity_registry.async_get("light.ceiling_lights")
    assert entry is not None
    device_id = entry.device_id

    entry = MockConfigEntry(
        domain=DOMAIN,
        data={
            CONF_NAME: "mock_name",
            CONF_PORT: 12345,
            CONF_DEVICES: [device_id],
            "filter": {
                "exclude_domains": [],
                "exclude_entities": [],
                "include_domains": [],
                "include_entities": ["light.none"],
            },
        },
    )
    entry.add_to_hass(hass)
    assert await hass.config_entries.async_setup(entry.entry_id)
    hass.bus.async_fire(EVENT_HOMEASSISTANT_STARTED)
    await hass.async_block_till_done()
    diag = await get_diagnostics_for_config_entry(hass, hass_client, entry)
    diag.pop("iid_storage")
    diag.pop("bridge")
    assert diag == {
        "accessories": [
            {
                "aid": 1,
                "services": [
                    {
                        "characteristics": [
                            {"format": "bool", "iid": 2, "perms": ["pw"], "type": "14"},
                            {
                                "format": "string",
                                "iid": 3,
                                "perms": ["pr"],
                                "type": "20",
                                "value": "Home Assistant",
                            },
                            {
                                "format": "string",
                                "iid": 4,
                                "perms": ["pr"],
                                "type": "21",
                                "value": "Bridge",
                            },
                            {
                                "format": "string",
                                "iid": 5,
                                "perms": ["pr"],
                                "type": "23",
                                "value": "mock_name",
                            },
                            {
                                "format": "string",
                                "iid": 6,
                                "perms": ["pr"],
                                "type": "30",
                                "value": "homekit.bridge",
                            },
                            {
                                "format": "string",
                                "iid": 7,
                                "perms": ["pr"],
                                "type": "52",
                                "value": ANY,
                            },
                        ],
                        "iid": 1,
                        "type": "3E",
                    },
                    {
                        "characteristics": [
                            {
                                "format": "string",
                                "iid": 9,
                                "perms": ["pr", "ev"],
                                "type": "37",
                                "value": "01.01.00",
                            }
                        ],
                        "iid": 8,
                        "type": "A2",
                    },
                ],
            },
            {
                "aid": ANY,
                "services": [
                    {
                        "characteristics": [
                            {"format": "bool", "iid": 2, "perms": ["pw"], "type": "14"},
                            {
                                "format": "string",
                                "iid": 3,
                                "perms": ["pr"],
                                "type": "20",
                                "value": "Demo",
                            },
                            {
                                "format": "string",
                                "iid": 4,
                                "perms": ["pr"],
                                "type": "21",
                                "value": "Home Assistant",
                            },
                            {
                                "format": "string",
                                "iid": 5,
                                "perms": ["pr"],
                                "type": "23",
                                "value": "Ceiling Lights",
                            },
                            {
                                "format": "string",
                                "iid": 6,
                                "perms": ["pr"],
                                "type": "30",
                                "value": ANY,
                            },
                            {
                                "format": "string",
                                "iid": 7,
                                "perms": ["pr"],
                                "type": "52",
                                "value": ANY,
                            },
                        ],
                        "iid": 1,
                        "type": "3E",
                    },
                    {
                        "characteristics": [
                            {
                                "format": "uint8",
                                "iid": 9,
                                "perms": ["pr", "ev"],
                                "type": "73",
                                "valid-values": [0],
                                "value": None,
                            },
                            {
                                "format": "string",
                                "iid": 10,
                                "perms": ["pr"],
                                "type": "23",
                                "value": "Ceiling Lights Changed States",
                            },
                            {
                                "format": "uint8",
                                "iid": 11,
                                "maxValue": 255,
                                "minStep": 1,
                                "minValue": 1,
                                "perms": ["pr"],
                                "type": "CB",
                                "value": 1,
                            },
                        ],
                        "iid": 8,
                        "linked": [12],
                        "type": "89",
                    },
                    {
                        "characteristics": [
                            {
                                "format": "uint8",
                                "iid": 13,
                                "perms": ["pr"],
                                "type": "CD",
                                "valid-values": [0, 1],
                                "value": 1,
                            }
                        ],
                        "iid": 12,
                        "type": "CC",
                    },
                    {
                        "characteristics": [
                            {
                                "format": "uint8",
                                "iid": 15,
                                "perms": ["pr", "ev"],
                                "type": "73",
                                "valid-values": [0],
                                "value": None,
                            },
                            {
                                "format": "string",
                                "iid": 16,
                                "perms": ["pr"],
                                "type": "23",
                                "value": "Ceiling Lights Turned Off",
                            },
                            {
                                "format": "uint8",
                                "iid": 17,
                                "maxValue": 255,
                                "minStep": 1,
                                "minValue": 1,
                                "perms": ["pr"],
                                "type": "CB",
                                "value": 2,
                            },
                        ],
                        "iid": 14,
                        "linked": [18],
                        "type": "89",
                    },
                    {
                        "characteristics": [
                            {
                                "format": "uint8",
                                "iid": 19,
                                "perms": ["pr"],
                                "type": "CD",
                                "valid-values": [0, 1],
                                "value": 1,
                            }
                        ],
                        "iid": 18,
                        "type": "CC",
                    },
                    {
                        "characteristics": [
                            {
                                "format": "uint8",
                                "iid": 21,
                                "perms": ["pr", "ev"],
                                "type": "73",
                                "valid-values": [0],
                                "value": None,
                            },
                            {
                                "format": "string",
                                "iid": 22,
                                "perms": ["pr"],
                                "type": "23",
                                "value": "Ceiling Lights Turned On",
                            },
                            {
                                "format": "uint8",
                                "iid": 23,
                                "maxValue": 255,
                                "minStep": 1,
                                "minValue": 1,
                                "perms": ["pr"],
                                "type": "CB",
                                "value": 3,
                            },
                        ],
                        "iid": 20,
                        "linked": [24],
                        "type": "89",
                    },
                    {
                        "characteristics": [
                            {
                                "format": "uint8",
                                "iid": 25,
                                "perms": ["pr"],
                                "type": "CD",
                                "valid-values": [0, 1],
                                "value": 1,
                            }
                        ],
                        "iid": 24,
                        "type": "CC",
                    },
                ],
            },
        ],
        "client_properties": {},
        "config-entry": {
            "data": {"name": "mock_name", "port": 12345},
            "options": {
                "devices": [device_id],
                "filter": {
                    "exclude_domains": [],
                    "exclude_entities": [],
                    "include_domains": [],
                    "include_entities": ["light.none"],
                },
            },
            "title": "Mock Title",
            "version": 1,
        },
        "config_version": 2,
        "pairing_id": ANY,
        "status": 1,
    }
    with (
        patch("pyhap.accessory_driver.AccessoryDriver.async_start"),
        patch("homeassistant.components.homekit.HomeKit.async_stop"),
        patch("homeassistant.components.homekit.async_port_is_available"),
    ):
        assert await hass.config_entries.async_unload(entry.entry_id)
        await hass.async_block_till_done()