"""The tests for Core components.""" # pylint: disable=protected-access import asyncio import unittest from unittest.mock import Mock, patch import pytest import voluptuous as vol import yaml from homeassistant import config import homeassistant.components as comps from homeassistant.components.homeassistant import ( ATTR_ENTRY_ID, SERVICE_CHECK_CONFIG, SERVICE_RELOAD_CORE_CONFIG, SERVICE_SET_LOCATION, ) from homeassistant.const import ( ATTR_ENTITY_ID, ENTITY_MATCH_ALL, ENTITY_MATCH_NONE, EVENT_CORE_CONFIG_UPDATE, SERVICE_HOMEASSISTANT_RESTART, SERVICE_HOMEASSISTANT_STOP, SERVICE_SAVE_PERSISTENT_STATES, SERVICE_TOGGLE, SERVICE_TURN_OFF, SERVICE_TURN_ON, STATE_OFF, STATE_ON, ) import homeassistant.core as ha from homeassistant.exceptions import HomeAssistantError, Unauthorized from homeassistant.helpers import entity from homeassistant.setup import async_setup_component from tests.common import ( MockConfigEntry, async_capture_events, async_mock_service, get_test_home_assistant, mock_registry, mock_service, patch_yaml_files, ) def turn_on(hass, entity_id=None, **service_data): """Turn specified entity on if possible. This is a legacy helper method. Do not use it for new tests. """ if entity_id is not None: service_data[ATTR_ENTITY_ID] = entity_id hass.services.call(ha.DOMAIN, SERVICE_TURN_ON, service_data) def turn_off(hass, entity_id=None, **service_data): """Turn specified entity off. This is a legacy helper method. Do not use it for new tests. """ if entity_id is not None: service_data[ATTR_ENTITY_ID] = entity_id hass.services.call(ha.DOMAIN, SERVICE_TURN_OFF, service_data) def toggle(hass, entity_id=None, **service_data): """Toggle specified entity. This is a legacy helper method. Do not use it for new tests. """ if entity_id is not None: service_data[ATTR_ENTITY_ID] = entity_id hass.services.call(ha.DOMAIN, SERVICE_TOGGLE, service_data) def stop(hass): """Stop Home Assistant. This is a legacy helper method. Do not use it for new tests. """ hass.services.call(ha.DOMAIN, SERVICE_HOMEASSISTANT_STOP) def restart(hass): """Stop Home Assistant. This is a legacy helper method. Do not use it for new tests. """ hass.services.call(ha.DOMAIN, SERVICE_HOMEASSISTANT_RESTART) def check_config(hass): """Check the config files. This is a legacy helper method. Do not use it for new tests. """ hass.services.call(ha.DOMAIN, SERVICE_CHECK_CONFIG) def reload_core_config(hass): """Reload the core config. This is a legacy helper method. Do not use it for new tests. """ hass.services.call(ha.DOMAIN, SERVICE_RELOAD_CORE_CONFIG) class TestComponentsCore(unittest.TestCase): """Test homeassistant.components module.""" # pylint: disable=invalid-name def setUp(self): """Set up things to be run when tests are started.""" self.hass = get_test_home_assistant() assert asyncio.run_coroutine_threadsafe( async_setup_component(self.hass, "homeassistant", {}), self.hass.loop ).result() self.hass.states.set("light.Bowl", STATE_ON) self.hass.states.set("light.Ceiling", STATE_OFF) self.addCleanup(self.hass.stop) def test_is_on(self): """Test is_on method.""" assert comps.is_on(self.hass, "light.Bowl") assert not comps.is_on(self.hass, "light.Ceiling") assert comps.is_on(self.hass) assert not comps.is_on(self.hass, "non_existing.entity") def test_turn_on_without_entities(self): """Test turn_on method without entities.""" calls = mock_service(self.hass, "light", SERVICE_TURN_ON) turn_on(self.hass) self.hass.block_till_done() assert len(calls) == 0 def test_turn_on(self): """Test turn_on method.""" calls = mock_service(self.hass, "light", SERVICE_TURN_ON) turn_on(self.hass, "light.Ceiling") self.hass.block_till_done() assert len(calls) == 1 def test_turn_off(self): """Test turn_off method.""" calls = mock_service(self.hass, "light", SERVICE_TURN_OFF) turn_off(self.hass, "light.Bowl") self.hass.block_till_done() assert len(calls) == 1 def test_toggle(self): """Test toggle method.""" calls = mock_service(self.hass, "light", SERVICE_TOGGLE) toggle(self.hass, "light.Bowl") self.hass.block_till_done() assert len(calls) == 1 @patch("homeassistant.config.os.path.isfile", Mock(return_value=True)) def test_reload_core_conf(self): """Test reload core conf service.""" ent = entity.Entity() ent.entity_id = "test.entity" ent.hass = self.hass ent.schedule_update_ha_state() self.hass.block_till_done() state = self.hass.states.get("test.entity") assert state is not None assert state.state == "unknown" assert state.attributes == {} files = { config.YAML_CONFIG_FILE: yaml.dump( { ha.DOMAIN: { "latitude": 10, "longitude": 20, "customize": {"test.Entity": {"hello": "world"}}, } } ) } with patch_yaml_files(files, True): reload_core_config(self.hass) self.hass.block_till_done() assert self.hass.config.latitude == 10 assert self.hass.config.longitude == 20 ent.schedule_update_ha_state() self.hass.block_till_done() state = self.hass.states.get("test.entity") assert state is not None assert state.state == "unknown" assert state.attributes.get("hello") == "world" @patch("homeassistant.config.os.path.isfile", Mock(return_value=True)) @patch("homeassistant.components.homeassistant._LOGGER.error") @patch("homeassistant.config.async_process_ha_core_config") def test_reload_core_with_wrong_conf(self, mock_process, mock_error): """Test reload core conf service.""" files = {config.YAML_CONFIG_FILE: yaml.dump(["invalid", "config"])} with patch_yaml_files(files, True): reload_core_config(self.hass) self.hass.block_till_done() assert mock_error.called assert mock_process.called is False @patch("homeassistant.core.HomeAssistant.async_stop", return_value=None) @patch( "homeassistant.config.async_check_ha_config_file", side_effect=HomeAssistantError("Test error"), ) def test_restart_homeassistant_wrong_conf(self, mock_check, mock_restart): """Test stop service.""" restart(self.hass) self.hass.block_till_done() assert mock_check.called assert not mock_restart.called @patch("homeassistant.core.HomeAssistant.async_stop", return_value=None) @patch("homeassistant.config.async_check_ha_config_file", return_value=None) def test_check_config(self, mock_check, mock_stop): """Test stop service.""" check_config(self.hass) self.hass.block_till_done() assert mock_check.called assert not mock_stop.called async def test_turn_on_skips_domains_without_service(hass, caplog): """Test if turn_on is blocking domain with no service.""" await async_setup_component(hass, "homeassistant", {}) async_mock_service(hass, "light", SERVICE_TURN_ON) hass.states.async_set("light.Bowl", STATE_ON) hass.states.async_set("light.Ceiling", STATE_OFF) # We can't test if our service call results in services being called # because by mocking out the call service method, we mock out all # So we mimic how the service registry calls services service_call = ha.ServiceCall( "homeassistant", "turn_on", {"entity_id": ["light.test", "sensor.bla", "binary_sensor.blub", "light.bla"]}, ) service = hass.services._services["homeassistant"]["turn_on"] with patch( "homeassistant.core.ServiceRegistry.async_call", return_value=None, ) as mock_call: await service.job.target(service_call) assert mock_call.call_count == 1 assert mock_call.call_args_list[0][0] == ( "light", "turn_on", {"entity_id": ["light.bla", "light.test"]}, ) assert mock_call.call_args_list[0][1] == { "blocking": True, "context": service_call.context, } assert ( "The service homeassistant.turn_on does not support entities binary_sensor.blub, sensor.bla" in caplog.text ) async def test_entity_update(hass): """Test being able to call entity update.""" await async_setup_component(hass, "homeassistant", {}) with patch( "homeassistant.helpers.entity_component.async_update_entity", return_value=None, ) as mock_update: await hass.services.async_call( "homeassistant", "update_entity", {"entity_id": ["light.kitchen"]}, blocking=True, ) assert len(mock_update.mock_calls) == 1 assert mock_update.mock_calls[0][1][1] == "light.kitchen" async def test_setting_location(hass): """Test setting the location.""" await async_setup_component(hass, "homeassistant", {}) events = async_capture_events(hass, EVENT_CORE_CONFIG_UPDATE) # Just to make sure that we are updating values. assert hass.config.latitude != 30 assert hass.config.longitude != 40 await hass.services.async_call( "homeassistant", "set_location", {"latitude": 30, "longitude": 40}, blocking=True, ) assert len(events) == 1 assert hass.config.latitude == 30 assert hass.config.longitude == 40 async def test_require_admin(hass, hass_read_only_user): """Test services requiring admin.""" await async_setup_component(hass, "homeassistant", {}) for service in ( SERVICE_HOMEASSISTANT_RESTART, SERVICE_HOMEASSISTANT_STOP, SERVICE_CHECK_CONFIG, SERVICE_RELOAD_CORE_CONFIG, ): with pytest.raises(Unauthorized): await hass.services.async_call( ha.DOMAIN, service, {}, context=ha.Context(user_id=hass_read_only_user.id), blocking=True, ) assert False, f"Should have raises for {service}" with pytest.raises(Unauthorized): await hass.services.async_call( ha.DOMAIN, SERVICE_SET_LOCATION, {"latitude": 0, "longitude": 0}, context=ha.Context(user_id=hass_read_only_user.id), blocking=True, ) async def test_turn_on_off_toggle_schema(hass, hass_read_only_user): """Test the schemas for the turn on/off/toggle services.""" await async_setup_component(hass, "homeassistant", {}) for service in SERVICE_TURN_ON, SERVICE_TURN_OFF, SERVICE_TOGGLE: for invalid in None, "nothing", ENTITY_MATCH_ALL, ENTITY_MATCH_NONE: with pytest.raises(vol.Invalid): await hass.services.async_call( ha.DOMAIN, service, {"entity_id": invalid}, context=ha.Context(user_id=hass_read_only_user.id), blocking=True, ) async def test_not_allowing_recursion(hass, caplog): """Test we do not allow recursion.""" await async_setup_component(hass, "homeassistant", {}) for service in SERVICE_TURN_ON, SERVICE_TURN_OFF, SERVICE_TOGGLE: await hass.services.async_call( ha.DOMAIN, service, {"entity_id": "homeassistant.light"}, blocking=True, ) assert ( f"Called service homeassistant.{service} with invalid entities homeassistant.light" in caplog.text ), service async def test_reload_config_entry_by_entity_id(hass): """Test being able to reload a config entry by entity_id.""" await async_setup_component(hass, "homeassistant", {}) entity_reg = mock_registry(hass) entry1 = MockConfigEntry(domain="mockdomain") entry1.add_to_hass(hass) entry2 = MockConfigEntry(domain="mockdomain") entry2.add_to_hass(hass) reg_entity1 = entity_reg.async_get_or_create( "binary_sensor", "powerwall", "battery_charging", config_entry=entry1 ) reg_entity2 = entity_reg.async_get_or_create( "binary_sensor", "powerwall", "battery_status", config_entry=entry2 ) with patch( "homeassistant.config_entries.ConfigEntries.async_reload", return_value=None, ) as mock_reload: await hass.services.async_call( "homeassistant", "reload_config_entry", {"entity_id": f"{reg_entity1.entity_id},{reg_entity2.entity_id}"}, blocking=True, ) assert len(mock_reload.mock_calls) == 2 assert {mock_reload.mock_calls[0][1][0], mock_reload.mock_calls[1][1][0]} == { entry1.entry_id, entry2.entry_id, } with pytest.raises(ValueError): await hass.services.async_call( "homeassistant", "reload_config_entry", {"entity_id": "unknown.entity_id"}, blocking=True, ) async def test_reload_config_entry_by_entry_id(hass): """Test being able to reload a config entry by config entry id.""" await async_setup_component(hass, "homeassistant", {}) with patch( "homeassistant.config_entries.ConfigEntries.async_reload", return_value=None, ) as mock_reload: await hass.services.async_call( "homeassistant", "reload_config_entry", {ATTR_ENTRY_ID: "8955375327824e14ba89e4b29cc3ec9a"}, blocking=True, ) assert len(mock_reload.mock_calls) == 1 assert mock_reload.mock_calls[0][1][0] == "8955375327824e14ba89e4b29cc3ec9a" @pytest.mark.parametrize( "service", [SERVICE_HOMEASSISTANT_RESTART, SERVICE_HOMEASSISTANT_STOP] ) async def test_raises_when_db_upgrade_in_progress(hass, service, caplog): """Test an exception is raised when the database migration is in progress.""" await async_setup_component(hass, "homeassistant", {}) with pytest.raises(HomeAssistantError), patch( "homeassistant.helpers.recorder.async_migration_in_progress", return_value=True, ) as mock_async_migration_in_progress: await hass.services.async_call( "homeassistant", service, blocking=True, ) assert "The system cannot" in caplog.text assert "while a database upgrade in progress" in caplog.text assert mock_async_migration_in_progress.called caplog.clear() with patch( "homeassistant.helpers.recorder.async_migration_in_progress", return_value=False, ) as mock_async_migration_in_progress, patch( "homeassistant.config.async_check_ha_config_file", return_value=None ): await hass.services.async_call( "homeassistant", service, blocking=True, ) assert "The system cannot" not in caplog.text assert "while a database upgrade in progress" not in caplog.text assert mock_async_migration_in_progress.called async def test_raises_when_config_is_invalid(hass, caplog): """Test an exception is raised when the configuration is invalid.""" await async_setup_component(hass, "homeassistant", {}) with pytest.raises(HomeAssistantError), patch( "homeassistant.helpers.recorder.async_migration_in_progress", return_value=False, ), patch( "homeassistant.config.async_check_ha_config_file", return_value=["Error 1"] ) as mock_async_check_ha_config_file: await hass.services.async_call( "homeassistant", SERVICE_HOMEASSISTANT_RESTART, blocking=True, ) assert "The system cannot" in caplog.text assert "because the configuration is not valid" in caplog.text assert "Error 1" in caplog.text assert mock_async_check_ha_config_file.called caplog.clear() with patch( "homeassistant.helpers.recorder.async_migration_in_progress", return_value=False, ), patch( "homeassistant.config.async_check_ha_config_file", return_value=None ) as mock_async_check_ha_config_file: await hass.services.async_call( "homeassistant", SERVICE_HOMEASSISTANT_RESTART, blocking=True, ) assert mock_async_check_ha_config_file.called async def test_restart_homeassistant(hass): """Test we can restart when there is no configuration error.""" await async_setup_component(hass, "homeassistant", {}) with patch( "homeassistant.config.async_check_ha_config_file", return_value=None ) as mock_check, patch( "homeassistant.core.HomeAssistant.async_stop", return_value=None ) as mock_restart: await hass.services.async_call( "homeassistant", SERVICE_HOMEASSISTANT_RESTART, blocking=True, ) assert mock_check.called await hass.async_block_till_done() assert mock_restart.called async def test_stop_homeassistant(hass): """Test we can stop when there is a configuration error.""" await async_setup_component(hass, "homeassistant", {}) with patch( "homeassistant.config.async_check_ha_config_file", return_value=None ) as mock_check, patch( "homeassistant.core.HomeAssistant.async_stop", return_value=None ) as mock_restart: await hass.services.async_call( "homeassistant", SERVICE_HOMEASSISTANT_STOP, blocking=True, ) assert not mock_check.called await hass.async_block_till_done() assert mock_restart.called async def test_save_persistent_states(hass): """Test we can call save_persistent_states.""" await async_setup_component(hass, "homeassistant", {}) with patch( "homeassistant.helpers.restore_state.RestoreStateData.async_save_persistent_states", return_value=None, ) as mock_save: await hass.services.async_call( "homeassistant", SERVICE_SAVE_PERSISTENT_STATES, blocking=True, ) assert mock_save.called