core/tests/components/nice_go/test_light.py

246 lines
7.7 KiB
Python

"""Test Nice G.O. light."""
from unittest.mock import AsyncMock
from aiohttp import ClientError
from nice_go import ApiError, AuthFailedError
import pytest
from syrupy import SnapshotAssertion
from homeassistant.components.light import (
DOMAIN as LIGHT_DOMAIN,
SERVICE_TURN_OFF,
SERVICE_TURN_ON,
)
from homeassistant.components.nice_go.const import DOMAIN
from homeassistant.const import ATTR_ENTITY_ID, STATE_OFF, STATE_ON, Platform
from homeassistant.core import HomeAssistant
from homeassistant.exceptions import HomeAssistantError
from homeassistant.helpers import entity_registry as er
from . import setup_integration
from tests.common import MockConfigEntry, load_json_object_fixture, snapshot_platform
async def test_data(
hass: HomeAssistant,
mock_nice_go: AsyncMock,
entity_registry: er.EntityRegistry,
snapshot: SnapshotAssertion,
mock_config_entry: MockConfigEntry,
) -> None:
"""Test that data gets parsed and returned appropriately."""
await setup_integration(hass, mock_config_entry, [Platform.LIGHT])
await snapshot_platform(hass, entity_registry, snapshot, mock_config_entry.entry_id)
async def test_turn_on(
hass: HomeAssistant, mock_nice_go: AsyncMock, mock_config_entry: MockConfigEntry
) -> None:
"""Test that turning on the light works as intended."""
await setup_integration(hass, mock_config_entry, [Platform.LIGHT])
await hass.services.async_call(
LIGHT_DOMAIN,
SERVICE_TURN_ON,
{ATTR_ENTITY_ID: "light.test_garage_2_light"},
blocking=True,
)
assert mock_nice_go.light_on.call_count == 1
async def test_turn_off(
hass: HomeAssistant, mock_nice_go: AsyncMock, mock_config_entry: MockConfigEntry
) -> None:
"""Test that turning off the light works as intended."""
await setup_integration(hass, mock_config_entry, [Platform.LIGHT])
await hass.services.async_call(
LIGHT_DOMAIN,
SERVICE_TURN_OFF,
{ATTR_ENTITY_ID: "light.test_garage_1_light"},
blocking=True,
)
assert mock_nice_go.light_off.call_count == 1
async def test_update_light_state(
hass: HomeAssistant,
mock_nice_go: AsyncMock,
mock_config_entry: MockConfigEntry,
) -> None:
"""Test that turning off the light works as intended."""
await setup_integration(hass, mock_config_entry, [Platform.LIGHT])
assert hass.states.get("light.test_garage_1_light").state == STATE_ON
assert hass.states.get("light.test_garage_2_light").state == STATE_OFF
assert hass.states.get("light.test_garage_3_light") is None
device_update = load_json_object_fixture("device_state_update.json", DOMAIN)
await mock_config_entry.runtime_data.on_data(device_update)
device_update_1 = load_json_object_fixture("device_state_update_1.json", DOMAIN)
await mock_config_entry.runtime_data.on_data(device_update_1)
assert hass.states.get("light.test_garage_1_light").state == STATE_OFF
assert hass.states.get("light.test_garage_2_light").state == STATE_ON
assert hass.states.get("light.test_garage_3_light") is None
@pytest.mark.parametrize(
("action", "error", "entity_id", "expected_error"),
[
(
SERVICE_TURN_OFF,
ApiError,
"light.test_garage_1_light",
"Error while turning off the light",
),
(
SERVICE_TURN_ON,
ClientError,
"light.test_garage_2_light",
"Error while turning on the light",
),
],
)
async def test_error(
hass: HomeAssistant,
mock_nice_go: AsyncMock,
mock_config_entry: MockConfigEntry,
action: str,
error: Exception,
entity_id: str,
expected_error: str,
) -> None:
"""Test that errors are handled appropriately."""
await setup_integration(hass, mock_config_entry, [Platform.LIGHT])
mock_nice_go.light_on.side_effect = error
mock_nice_go.light_off.side_effect = error
with pytest.raises(HomeAssistantError, match=expected_error):
await hass.services.async_call(
LIGHT_DOMAIN,
action,
{ATTR_ENTITY_ID: entity_id},
blocking=True,
)
async def test_unsupported_device_type(
hass: HomeAssistant,
mock_nice_go: AsyncMock,
mock_config_entry: MockConfigEntry,
caplog: pytest.LogCaptureFixture,
) -> None:
"""Test that unsupported device types are handled appropriately."""
await setup_integration(hass, mock_config_entry, [Platform.LIGHT])
assert hass.states.get("light.test_garage_4_light") is None
assert (
"Device 'Test Garage 4' has unknown device type 'unknown-device-type'"
in caplog.text
)
assert "which is not supported by this integration" in caplog.text
assert (
"We try to support it with a cover and event entity, but nothing else."
in caplog.text
)
assert (
"Please create an issue with your device model in additional info"
in caplog.text
)
async def test_auth_failed_error(
hass: HomeAssistant,
mock_nice_go: AsyncMock,
mock_config_entry: MockConfigEntry,
) -> None:
"""Test that if an auth failed error occurs, the integration attempts a token refresh and a retry before throwing an error."""
await setup_integration(hass, mock_config_entry, [Platform.LIGHT])
def _on_side_effect(*args, **kwargs):
if mock_nice_go.light_on.call_count <= 3:
raise AuthFailedError
if mock_nice_go.light_on.call_count == 5:
raise AuthFailedError
if mock_nice_go.light_on.call_count == 6:
raise ApiError
def _off_side_effect(*args, **kwargs):
if mock_nice_go.light_off.call_count <= 3:
raise AuthFailedError
if mock_nice_go.light_off.call_count == 4:
raise ApiError
mock_nice_go.light_on.side_effect = _on_side_effect
mock_nice_go.light_off.side_effect = _off_side_effect
with pytest.raises(HomeAssistantError, match="Error while turning on the light"):
await hass.services.async_call(
LIGHT_DOMAIN,
SERVICE_TURN_ON,
{ATTR_ENTITY_ID: "light.test_garage_1_light"},
blocking=True,
)
assert mock_nice_go.authenticate.call_count == 1
assert mock_nice_go.light_on.call_count == 2
with pytest.raises(HomeAssistantError, match="Error while turning off the light"):
await hass.services.async_call(
LIGHT_DOMAIN,
SERVICE_TURN_OFF,
{ATTR_ENTITY_ID: "light.test_garage_2_light"},
blocking=True,
)
assert mock_nice_go.authenticate.call_count == 2
assert mock_nice_go.light_off.call_count == 2
# Try again, but this time the auth failed error should not be raised
await hass.services.async_call(
LIGHT_DOMAIN,
SERVICE_TURN_ON,
{ATTR_ENTITY_ID: "light.test_garage_1_light"},
blocking=True,
)
assert mock_nice_go.authenticate.call_count == 3
assert mock_nice_go.light_on.call_count == 4
# One more time but with an ApiError instead of AuthFailed
with pytest.raises(HomeAssistantError, match="Error while turning on the light"):
await hass.services.async_call(
LIGHT_DOMAIN,
SERVICE_TURN_ON,
{ATTR_ENTITY_ID: "light.test_garage_1_light"},
blocking=True,
)
with pytest.raises(HomeAssistantError, match="Error while turning off the light"):
await hass.services.async_call(
LIGHT_DOMAIN,
SERVICE_TURN_OFF,
{ATTR_ENTITY_ID: "light.test_garage_2_light"},
blocking=True,
)
assert mock_nice_go.authenticate.call_count == 5
assert mock_nice_go.light_on.call_count == 6
assert mock_nice_go.light_off.call_count == 4