"""Test Alexa config.""" import contextlib from unittest.mock import AsyncMock, Mock, patch import pytest from homeassistant.components.alexa import errors from homeassistant.components.cloud import ALEXA_SCHEMA, alexa_config from homeassistant.const import EntityCategory from homeassistant.core import HomeAssistant from homeassistant.helpers import entity_registry as er from homeassistant.helpers.aiohttp_client import async_get_clientsession from tests.common import async_fire_time_changed from tests.test_util.aiohttp import AiohttpClientMocker @pytest.fixture def cloud_stub(): """Stub the cloud.""" return Mock(is_logged_in=True, subscription_expired=False) async def test_alexa_config_expose_entity_prefs( hass: HomeAssistant, cloud_prefs, cloud_stub, entity_registry: er.EntityRegistry ) -> None: """Test Alexa config should expose using prefs.""" entity_entry1 = entity_registry.async_get_or_create( "light", "test", "light_config_id", suggested_object_id="config_light", entity_category=EntityCategory.CONFIG, ) entity_entry2 = entity_registry.async_get_or_create( "light", "test", "light_diagnostic_id", suggested_object_id="diagnostic_light", entity_category=EntityCategory.DIAGNOSTIC, ) entity_entry3 = entity_registry.async_get_or_create( "light", "test", "light_hidden_integration_id", suggested_object_id="hidden_integration_light", hidden_by=er.RegistryEntryHider.INTEGRATION, ) entity_entry4 = entity_registry.async_get_or_create( "light", "test", "light_hidden_user_id", suggested_object_id="hidden_user_light", hidden_by=er.RegistryEntryHider.USER, ) entity_conf = {"should_expose": False} await cloud_prefs.async_update( alexa_entity_configs={"light.kitchen": entity_conf}, alexa_default_expose=["light"], alexa_enabled=True, alexa_report_state=False, ) conf = alexa_config.CloudAlexaConfig( hass, ALEXA_SCHEMA({}), "mock-user-id", cloud_prefs, cloud_stub ) await conf.async_initialize() assert not conf.should_expose("light.kitchen") assert not conf.should_expose(entity_entry1.entity_id) assert not conf.should_expose(entity_entry2.entity_id) assert not conf.should_expose(entity_entry3.entity_id) assert not conf.should_expose(entity_entry4.entity_id) entity_conf["should_expose"] = True assert conf.should_expose("light.kitchen") # categorized and hidden entities should not be exposed assert not conf.should_expose(entity_entry1.entity_id) assert not conf.should_expose(entity_entry2.entity_id) assert not conf.should_expose(entity_entry3.entity_id) assert not conf.should_expose(entity_entry4.entity_id) entity_conf["should_expose"] = None assert conf.should_expose("light.kitchen") # categorized and hidden entities should not be exposed assert not conf.should_expose(entity_entry1.entity_id) assert not conf.should_expose(entity_entry2.entity_id) assert not conf.should_expose(entity_entry3.entity_id) assert not conf.should_expose(entity_entry4.entity_id) assert "alexa" not in hass.config.components await cloud_prefs.async_update( alexa_default_expose=["sensor"], ) await hass.async_block_till_done() assert "alexa" in hass.config.components assert not conf.should_expose("light.kitchen") async def test_alexa_config_report_state( hass: HomeAssistant, cloud_prefs, cloud_stub ) -> None: """Test Alexa config should expose using prefs.""" await cloud_prefs.async_update( alexa_report_state=False, ) conf = alexa_config.CloudAlexaConfig( hass, ALEXA_SCHEMA({}), "mock-user-id", cloud_prefs, cloud_stub ) await conf.async_initialize() await conf.set_authorized(True) assert cloud_prefs.alexa_report_state is False assert conf.should_report_state is False assert conf.is_reporting_states is False with patch.object(conf, "async_get_access_token", AsyncMock(return_value="hello")): await cloud_prefs.async_update(alexa_report_state=True) await hass.async_block_till_done() assert cloud_prefs.alexa_report_state is True assert conf.should_report_state is True assert conf.is_reporting_states is True await cloud_prefs.async_update(alexa_report_state=False) await hass.async_block_till_done() assert cloud_prefs.alexa_report_state is False assert conf.should_report_state is False assert conf.is_reporting_states is False async def test_alexa_config_invalidate_token( hass: HomeAssistant, cloud_prefs, aioclient_mock: AiohttpClientMocker ) -> None: """Test Alexa config should expose using prefs.""" aioclient_mock.post( "https://example/access_token", json={ "access_token": "mock-token", "event_endpoint": "http://example.com/alexa_endpoint", "expires_in": 30, }, ) conf = alexa_config.CloudAlexaConfig( hass, ALEXA_SCHEMA({}), "mock-user-id", cloud_prefs, Mock( alexa_server="example", auth=Mock(async_check_token=AsyncMock()), websession=async_get_clientsession(hass), ), ) token = await conf.async_get_access_token() assert token == "mock-token" assert len(aioclient_mock.mock_calls) == 1 token = await conf.async_get_access_token() assert token == "mock-token" assert len(aioclient_mock.mock_calls) == 1 assert conf._token_valid is not None conf.async_invalidate_access_token() assert conf._token_valid is None token = await conf.async_get_access_token() assert token == "mock-token" assert len(aioclient_mock.mock_calls) == 2 @pytest.mark.parametrize( ("reject_reason", "expected_exception"), [ ("RefreshTokenNotFound", errors.RequireRelink), ("UnknownRegion", errors.RequireRelink), ("OtherReason", errors.NoTokenAvailable), ], ) async def test_alexa_config_fail_refresh_token( hass: HomeAssistant, cloud_prefs, aioclient_mock: AiohttpClientMocker, reject_reason, expected_exception, ) -> None: """Test Alexa config failing to refresh token.""" aioclient_mock.post( "https://example/access_token", json={ "access_token": "mock-token", "event_endpoint": "http://example.com/alexa_endpoint", "expires_in": 30, }, ) aioclient_mock.post("http://example.com/alexa_endpoint", text="", status=202) await cloud_prefs.async_update( alexa_report_state=False, ) conf = alexa_config.CloudAlexaConfig( hass, ALEXA_SCHEMA({}), "mock-user-id", cloud_prefs, Mock( alexa_server="example", auth=Mock(async_check_token=AsyncMock()), websession=async_get_clientsession(hass), ), ) await conf.async_initialize() await conf.set_authorized(True) assert cloud_prefs.alexa_report_state is False assert conf.should_report_state is False assert conf.is_reporting_states is False hass.states.async_set("fan.test_fan", "off") # Enable state reporting await cloud_prefs.async_update(alexa_report_state=True) await hass.async_block_till_done() assert cloud_prefs.alexa_report_state is True assert conf.should_report_state is True assert conf.is_reporting_states is True # Change states to trigger event listener hass.states.async_set("fan.test_fan", "on") await hass.async_block_till_done() # Invalidate the token and try to fetch another conf.async_invalidate_access_token() aioclient_mock.clear_requests() aioclient_mock.post( "https://example/access_token", json={"reason": reject_reason}, status=400, ) # Change states to trigger event listener hass.states.async_set("fan.test_fan", "off") await hass.async_block_till_done() # Check state reporting is still wanted in cloud prefs, but disabled for Alexa assert cloud_prefs.alexa_report_state is True assert conf.should_report_state is False assert conf.is_reporting_states is False # Simulate we're again authorized, but token update fails with pytest.raises(expected_exception): await conf.set_authorized(True) assert cloud_prefs.alexa_report_state is True assert conf.should_report_state is False assert conf.is_reporting_states is False # Simulate we're again authorized and token update succeeds # State reporting should now be re-enabled for Alexa aioclient_mock.clear_requests() aioclient_mock.post( "https://example/access_token", json={ "access_token": "mock-token", "event_endpoint": "http://example.com/alexa_endpoint", "expires_in": 30, }, ) await conf.set_authorized(True) assert cloud_prefs.alexa_report_state is True assert conf.should_report_state is True assert conf.is_reporting_states is True @contextlib.contextmanager def patch_sync_helper(): """Patch sync helper.""" to_update = [] to_remove = [] def sync_helper(to_upd, to_rem): to_update.extend([ent_id for ent_id in to_upd if ent_id not in to_update]) to_remove.extend([ent_id for ent_id in to_rem if ent_id not in to_remove]) return True with patch("homeassistant.components.cloud.alexa_config.SYNC_DELAY", 0), patch( "homeassistant.components.cloud.alexa_config.CloudAlexaConfig._sync_helper", side_effect=sync_helper, ): yield to_update, to_remove async def test_alexa_update_expose_trigger_sync( hass: HomeAssistant, cloud_prefs, cloud_stub ) -> None: """Test Alexa config responds to updating exposed entities.""" hass.states.async_set("binary_sensor.door", "on") hass.states.async_set( "sensor.temp", "23", {"device_class": "temperature", "unit_of_measurement": "°C"}, ) hass.states.async_set("light.kitchen", "off") await cloud_prefs.async_update( alexa_enabled=True, alexa_report_state=False, ) conf = alexa_config.CloudAlexaConfig( hass, ALEXA_SCHEMA({}), "mock-user-id", cloud_prefs, cloud_stub ) await conf.async_initialize() with patch_sync_helper() as (to_update, to_remove): await cloud_prefs.async_update_alexa_entity_config( entity_id="light.kitchen", should_expose=True ) await hass.async_block_till_done() async_fire_time_changed(hass, fire_all=True) await hass.async_block_till_done() assert conf._alexa_sync_unsub is None assert to_update == ["light.kitchen"] assert to_remove == [] with patch_sync_helper() as (to_update, to_remove): await cloud_prefs.async_update_alexa_entity_config( entity_id="light.kitchen", should_expose=False ) await cloud_prefs.async_update_alexa_entity_config( entity_id="binary_sensor.door", should_expose=True ) await cloud_prefs.async_update_alexa_entity_config( entity_id="sensor.temp", should_expose=True ) await hass.async_block_till_done() async_fire_time_changed(hass, fire_all=True) await hass.async_block_till_done() assert conf._alexa_sync_unsub is None assert sorted(to_update) == ["binary_sensor.door", "sensor.temp"] assert to_remove == ["light.kitchen"] with patch_sync_helper() as (to_update, to_remove): await cloud_prefs.async_update( alexa_enabled=False, ) await hass.async_block_till_done() assert conf._alexa_sync_unsub is None assert to_update == [] assert to_remove == ["binary_sensor.door", "sensor.temp", "light.kitchen"] async def test_alexa_entity_registry_sync( hass: HomeAssistant, mock_cloud_login, cloud_prefs ) -> None: """Test Alexa config responds to entity registry.""" await alexa_config.CloudAlexaConfig( hass, ALEXA_SCHEMA({}), "mock-user-id", cloud_prefs, hass.data["cloud"] ).async_initialize() with patch_sync_helper() as (to_update, to_remove): hass.bus.async_fire( er.EVENT_ENTITY_REGISTRY_UPDATED, {"action": "create", "entity_id": "light.kitchen"}, ) await hass.async_block_till_done() assert to_update == ["light.kitchen"] assert to_remove == [] with patch_sync_helper() as (to_update, to_remove): hass.bus.async_fire( er.EVENT_ENTITY_REGISTRY_UPDATED, {"action": "remove", "entity_id": "light.kitchen"}, ) await hass.async_block_till_done() assert to_update == [] assert to_remove == ["light.kitchen"] with patch_sync_helper() as (to_update, to_remove): hass.bus.async_fire( er.EVENT_ENTITY_REGISTRY_UPDATED, { "action": "update", "entity_id": "light.kitchen", "changes": ["entity_id"], "old_entity_id": "light.living_room", }, ) await hass.async_block_till_done() assert to_update == ["light.kitchen"] assert to_remove == ["light.living_room"] with patch_sync_helper() as (to_update, to_remove): hass.bus.async_fire( er.EVENT_ENTITY_REGISTRY_UPDATED, {"action": "update", "entity_id": "light.kitchen", "changes": ["icon"]}, ) await hass.async_block_till_done() assert to_update == [] assert to_remove == [] async def test_alexa_update_report_state( hass: HomeAssistant, cloud_prefs, cloud_stub ) -> None: """Test Alexa config responds to reporting state.""" await cloud_prefs.async_update( alexa_report_state=False, ) conf = alexa_config.CloudAlexaConfig( hass, ALEXA_SCHEMA({}), "mock-user-id", cloud_prefs, cloud_stub ) await conf.async_initialize() await conf.set_authorized(True) with patch( "homeassistant.components.cloud.alexa_config.CloudAlexaConfig.async_sync_entities", ) as mock_sync, patch( "homeassistant.components.cloud.alexa_config.CloudAlexaConfig.async_enable_proactive_mode", ): await cloud_prefs.async_update(alexa_report_state=True) await hass.async_block_till_done() assert len(mock_sync.mock_calls) == 1 def test_enabled_requires_valid_sub( hass: HomeAssistant, mock_expired_cloud_login, cloud_prefs ) -> None: """Test that alexa config enabled requires a valid Cloud sub.""" assert cloud_prefs.alexa_enabled assert hass.data["cloud"].is_logged_in assert hass.data["cloud"].subscription_expired config = alexa_config.CloudAlexaConfig( hass, ALEXA_SCHEMA({}), "mock-user-id", cloud_prefs, hass.data["cloud"] ) assert not config.enabled async def test_alexa_handle_logout( hass: HomeAssistant, cloud_prefs, cloud_stub ) -> None: """Test Alexa config responds to logging out.""" aconf = alexa_config.CloudAlexaConfig( hass, ALEXA_SCHEMA({}), "mock-user-id", cloud_prefs, cloud_stub ) await aconf.async_initialize() with patch( "homeassistant.components.alexa.config.async_enable_proactive_mode", return_value=Mock(), ) as mock_enable: await aconf.async_enable_proactive_mode() # This will trigger a prefs update when we logout. await cloud_prefs.get_cloud_user() cloud_stub.is_logged_in = False with patch.object( cloud_stub.auth, "async_check_token", side_effect=AssertionError("Should not be called"), ): await cloud_prefs.async_set_username(None) await hass.async_block_till_done() assert len(mock_enable.return_value.mock_calls) == 1