starred/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2026-09-24 15:31:52 -05:00
Code Issues Packages Projects Releases Wiki Activity

Add nest device level diagnostics (#68024)

Browse Source
This commit is contained in:
Allen Porter
2022-03-29 16:56:03 -10:00
committed by GitHub
parent 7e40594748
commit 66a183cfe3
2 changed files with 136 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tests/components/nest/test_diagnostics.py
+105 -49
View File
@@ -2,73 +2,103 @@
from unittest.mock import patch
from google_nest_sdm.exceptions import SubscriberException
from google_nest_sdm.exceptions import ApiException, SubscriberException
import pytest
from homeassistant.components.nest.const import DOMAIN
from homeassistant.config_entries import ConfigEntryState
from homeassistant.helpers import device_registry as dr
from .common import TEST_CONFIG_LEGACY
from tests.components.diagnostics import get_diagnostics_for_config_entry
from tests.components.diagnostics import (
get_diagnostics_for_config_entry,
get_diagnostics_for_device,
)
NEST_DEVICE_ID = "enterprises/project-id/devices/device-id"
DEVICE_API_DATA = {
"name": NEST_DEVICE_ID,
"type": "sdm.devices.types.THERMOSTAT",
"assignee": "enterprises/project-id/structures/structure-id/rooms/room-id",
"traits": {
"sdm.devices.traits.Info": {
"customName": "My Sensor",
},
"sdm.devices.traits.Temperature": {
"ambientTemperatureCelsius": 25.1,
},
"sdm.devices.traits.Humidity": {
"ambientHumidityPercent": 35.0,
},
},
"parentRelations": [
{
"parent": "enterprises/project-id/structures/structure-id/rooms/room-id",
"displayName": "Lobby",
}
],
}
DEVICE_DIAGNOSTIC_DATA = {
"data": {
"assignee": "**REDACTED**",
"name": "**REDACTED**",
"parentRelations": [{"displayName": "**REDACTED**", "parent": "**REDACTED**"}],
"traits": {
"sdm.devices.traits.Info": {"customName": "**REDACTED**"},
"sdm.devices.traits.Humidity": {"ambientHumidityPercent": 35.0},
"sdm.devices.traits.Temperature": {"ambientTemperatureCelsius": 25.1},
},
"type": "sdm.devices.types.THERMOSTAT",
}
}
@pytest.fixture
def platforms() -> list[str]:
"""Fixture to specify platforms to test."""
return ["sensor"]
async def test_entry_diagnostics(
hass, hass_client, create_device, setup_platform, config_entry
):
"""Test config entry diagnostics."""
create_device.create(
raw_data={
"name": "enterprises/project-id/devices/device-id",
"type": "sdm.devices.types.THERMOSTAT",
"assignee": "enterprises/project-id/structures/structure-id/rooms/room-id",
"traits": {
"sdm.devices.traits.Info": {
"customName": "My Sensor",
},
"sdm.devices.traits.Temperature": {
"ambientTemperatureCelsius": 25.1,
},
"sdm.devices.traits.Humidity": {
"ambientHumidityPercent": 35.0,
},
},
"parentRelations": [
{
"parent": "enterprises/project-id/structures/structure-id/rooms/room-id",
"displayName": "Lobby",
}
],
}
)
create_device.create(raw_data=DEVICE_API_DATA)
await setup_platform()
assert config_entry.state is ConfigEntryState.LOADED
# Test that only non identifiable device information is returned
assert await get_diagnostics_for_config_entry(hass, hass_client, config_entry) == {
"devices": [
{
"data": {
"assignee": "**REDACTED**",
"name": "**REDACTED**",
"parentRelations": [
{"displayName": "**REDACTED**", "parent": "**REDACTED**"}
],
"traits": {
"sdm.devices.traits.Info": {"customName": "**REDACTED**"},
"sdm.devices.traits.Humidity": {"ambientHumidityPercent": 35.0},
"sdm.devices.traits.Temperature": {
"ambientTemperatureCelsius": 25.1
},
},
"type": "sdm.devices.types.THERMOSTAT",
}
}
],
"devices": [DEVICE_DIAGNOSTIC_DATA]
}
async def test_device_diagnostics(
hass, hass_client, create_device, setup_platform, config_entry
):
"""Test config entry diagnostics."""
create_device.create(raw_data=DEVICE_API_DATA)
await setup_platform()
assert config_entry.state is ConfigEntryState.LOADED
device_registry = dr.async_get(hass)
device = device_registry.async_get_device({(DOMAIN, NEST_DEVICE_ID)})
assert device is not None
assert (
await get_diagnostics_for_device(hass, hass_client, config_entry, device)
== DEVICE_DIAGNOSTIC_DATA
)
async def test_setup_susbcriber_failure(
hass, hass_client, config_entry, setup_base_platform
hass,
hass_client,
config_entry,
setup_base_platform,
):
"""Test configuration error."""
with patch(
@@ -81,9 +111,35 @@ async def test_setup_susbcriber_failure(
assert config_entry.state is ConfigEntryState.SETUP_RETRY
assert await get_diagnostics_for_config_entry(hass, hass_client, config_entry) == {
"error": "No subscriber configured"
}
assert await get_diagnostics_for_config_entry(hass, hass_client, config_entry) == {}
async def test_device_manager_failure(
hass,
hass_client,
config_entry,
setup_platform,
create_device,
):
"""Test configuration error."""
create_device.create(raw_data=DEVICE_API_DATA)
await setup_platform()
assert config_entry.state is ConfigEntryState.LOADED
device_registry = dr.async_get(hass)
device = device_registry.async_get_device({(DOMAIN, NEST_DEVICE_ID)})
assert device is not None
with patch(
"homeassistant.components.nest.diagnostics._get_nest_devices",
side_effect=ApiException("Device manager failure"),
):
assert await get_diagnostics_for_config_entry(
hass, hass_client, config_entry
) == {"error": "Device manager failure"}
assert await get_diagnostics_for_device(
hass, hass_client, config_entry, device
) == {"error": "Device manager failure"}
@pytest.mark.parametrize("nest_test_config", [TEST_CONFIG_LEGACY])