71af0fac16
* Improve error handling user experience This is meant to make the nest integration quieter. Exceptions are handled with a single log error message. Co-authored-by: j-stienstra <65826735+j-stienstra@users.noreply.github.com>
90 lines
3.1 KiB
Python
90 lines
3.1 KiB
Python
"""
|
|
Test for setup methods for the SDM API.
|
|
|
|
The tests fake out the subscriber/devicemanager and simulate setup behavior
|
|
and failure modes.
|
|
"""
|
|
|
|
import logging
|
|
|
|
from google_nest_sdm.exceptions import GoogleNestException
|
|
|
|
from homeassistant.components.nest import DOMAIN
|
|
from homeassistant.config_entries import (
|
|
ENTRY_STATE_LOADED,
|
|
ENTRY_STATE_SETUP_ERROR,
|
|
ENTRY_STATE_SETUP_RETRY,
|
|
)
|
|
from homeassistant.setup import async_setup_component
|
|
|
|
from .common import CONFIG, CONFIG_ENTRY_DATA, async_setup_sdm_platform
|
|
|
|
from tests.async_mock import patch
|
|
from tests.common import MockConfigEntry
|
|
|
|
PLATFORM = "sensor"
|
|
|
|
|
|
async def test_setup_success(hass, caplog):
|
|
"""Test successful setup."""
|
|
with caplog.at_level(logging.ERROR, logger="homeassistant.components.nest"):
|
|
await async_setup_sdm_platform(hass, PLATFORM)
|
|
assert not caplog.records
|
|
|
|
entries = hass.config_entries.async_entries(DOMAIN)
|
|
assert len(entries) == 1
|
|
assert entries[0].state == ENTRY_STATE_LOADED
|
|
|
|
|
|
async def async_setup_sdm(hass, config=CONFIG):
|
|
"""Prepare test setup."""
|
|
MockConfigEntry(domain=DOMAIN, data=CONFIG_ENTRY_DATA).add_to_hass(hass)
|
|
with patch(
|
|
"homeassistant.helpers.config_entry_oauth2_flow.async_get_config_entry_implementation"
|
|
):
|
|
await async_setup_component(hass, DOMAIN, config)
|
|
|
|
|
|
async def test_setup_configuration_failure(hass, caplog):
|
|
"""Test configuration error."""
|
|
config = CONFIG.copy()
|
|
config[DOMAIN]["subscriber_id"] = "invalid-subscriber-format"
|
|
|
|
await async_setup_sdm(hass, config)
|
|
|
|
entries = hass.config_entries.async_entries(DOMAIN)
|
|
assert len(entries) == 1
|
|
assert entries[0].state == ENTRY_STATE_SETUP_ERROR
|
|
|
|
# This error comes from the python google-nest-sdm library, as a check added
|
|
# to prevent common misconfigurations (e.g. confusing topic and subscriber)
|
|
assert "Subscription misconfigured. Expected subscriber_id" in caplog.text
|
|
|
|
|
|
async def test_setup_susbcriber_failure(hass, caplog):
|
|
"""Test configuration error."""
|
|
with patch(
|
|
"homeassistant.components.nest.GoogleNestSubscriber.start_async",
|
|
side_effect=GoogleNestException(),
|
|
), caplog.at_level(logging.ERROR, logger="homeassistant.components.nest"):
|
|
await async_setup_sdm(hass)
|
|
assert "Subscriber error:" in caplog.text
|
|
|
|
entries = hass.config_entries.async_entries(DOMAIN)
|
|
assert len(entries) == 1
|
|
assert entries[0].state == ENTRY_STATE_SETUP_RETRY
|
|
|
|
|
|
async def test_setup_device_manager_failure(hass, caplog):
|
|
"""Test configuration error."""
|
|
with patch("homeassistant.components.nest.GoogleNestSubscriber.start_async"), patch(
|
|
"homeassistant.components.nest.GoogleNestSubscriber.async_get_device_manager",
|
|
side_effect=GoogleNestException(),
|
|
), caplog.at_level(logging.ERROR, logger="homeassistant.components.nest"):
|
|
await async_setup_sdm(hass)
|
|
assert len(caplog.messages) == 1
|
|
assert "Device manager error:" in caplog.text
|
|
|
|
entries = hass.config_entries.async_entries(DOMAIN)
|
|
assert len(entries) == 1
|
|
assert entries[0].state == ENTRY_STATE_SETUP_RETRY
|