"""The tests for the MQTT device tracker platform using configuration.yaml with legacy schema.""" import json from unittest.mock import patch import pytest from homeassistant.components import device_tracker from homeassistant.components.device_tracker import SourceType from homeassistant.config_entries import ConfigEntryDisabler from homeassistant.const import CONF_PLATFORM, STATE_HOME, STATE_NOT_HOME, Platform from homeassistant.setup import async_setup_component from .test_common import ( MockConfigEntry, help_test_entry_reload_with_new_config, help_test_unload_config_entry, ) from tests.common import async_fire_mqtt_message @pytest.fixture(autouse=True) def device_tracker_platform_only(): """Only setup the device_tracker platform to speed up tests.""" with patch("homeassistant.components.mqtt.PLATFORMS", [Platform.DEVICE_TRACKER]): yield # Deprecated in HA Core 2022.6 async def test_legacy_ensure_device_tracker_platform_validation( hass, mqtt_mock_entry_with_yaml_config ): """Test if platform validation was done.""" async def mock_setup_scanner(hass, config, see, discovery_info=None): """Check that Qos was added by validation.""" assert "qos" in config with patch( "homeassistant.components.mqtt.device_tracker.async_setup_scanner", autospec=True, side_effect=mock_setup_scanner, ) as mock_sp: dev_id = "paulus" topic = "/location/paulus" assert await async_setup_component( hass, device_tracker.DOMAIN, { device_tracker.DOMAIN: { CONF_PLATFORM: "mqtt", "devices": {dev_id: topic}, } }, ) await hass.async_block_till_done() await mqtt_mock_entry_with_yaml_config() assert mock_sp.call_count == 1 # Deprecated in HA Core 2022.6 async def test_legacy_new_message( hass, mock_device_tracker_conf, mqtt_mock_entry_no_yaml_config ): """Test new message.""" await mqtt_mock_entry_no_yaml_config() dev_id = "paulus" entity_id = f"{device_tracker.DOMAIN}.{dev_id}" topic = "/location/paulus" location = "work" hass.config.components = {"mqtt", "zone"} assert await async_setup_component( hass, device_tracker.DOMAIN, {device_tracker.DOMAIN: {CONF_PLATFORM: "mqtt", "devices": {dev_id: topic}}}, ) async_fire_mqtt_message(hass, topic, location) await hass.async_block_till_done() assert hass.states.get(entity_id).state == location # Deprecated in HA Core 2022.6 async def test_legacy_single_level_wildcard_topic( hass, mock_device_tracker_conf, mqtt_mock_entry_no_yaml_config ): """Test single level wildcard topic.""" await mqtt_mock_entry_no_yaml_config() dev_id = "paulus" entity_id = f"{device_tracker.DOMAIN}.{dev_id}" subscription = "/location/+/paulus" topic = "/location/room/paulus" location = "work" hass.config.components = {"mqtt", "zone"} assert await async_setup_component( hass, device_tracker.DOMAIN, { device_tracker.DOMAIN: { CONF_PLATFORM: "mqtt", "devices": {dev_id: subscription}, } }, ) async_fire_mqtt_message(hass, topic, location) await hass.async_block_till_done() assert hass.states.get(entity_id).state == location # Deprecated in HA Core 2022.6 async def test_legacy_multi_level_wildcard_topic( hass, mock_device_tracker_conf, mqtt_mock_entry_no_yaml_config ): """Test multi level wildcard topic.""" await mqtt_mock_entry_no_yaml_config() dev_id = "paulus" entity_id = f"{device_tracker.DOMAIN}.{dev_id}" subscription = "/location/#" topic = "/location/room/paulus" location = "work" hass.config.components = {"mqtt", "zone"} assert await async_setup_component( hass, device_tracker.DOMAIN, { device_tracker.DOMAIN: { CONF_PLATFORM: "mqtt", "devices": {dev_id: subscription}, } }, ) async_fire_mqtt_message(hass, topic, location) await hass.async_block_till_done() assert hass.states.get(entity_id).state == location # Deprecated in HA Core 2022.6 async def test_legacy_single_level_wildcard_topic_not_matching( hass, mock_device_tracker_conf, mqtt_mock_entry_no_yaml_config ): """Test not matching single level wildcard topic.""" await mqtt_mock_entry_no_yaml_config() dev_id = "paulus" entity_id = f"{device_tracker.DOMAIN}.{dev_id}" subscription = "/location/+/paulus" topic = "/location/paulus" location = "work" hass.config.components = {"mqtt", "zone"} assert await async_setup_component( hass, device_tracker.DOMAIN, { device_tracker.DOMAIN: { CONF_PLATFORM: "mqtt", "devices": {dev_id: subscription}, } }, ) async_fire_mqtt_message(hass, topic, location) await hass.async_block_till_done() assert hass.states.get(entity_id) is None # Deprecated in HA Core 2022.6 async def test_legacy_multi_level_wildcard_topic_not_matching( hass, mock_device_tracker_conf, mqtt_mock_entry_no_yaml_config ): """Test not matching multi level wildcard topic.""" await mqtt_mock_entry_no_yaml_config() dev_id = "paulus" entity_id = f"{device_tracker.DOMAIN}.{dev_id}" subscription = "/location/#" topic = "/somewhere/room/paulus" location = "work" hass.config.components = {"mqtt", "zone"} assert await async_setup_component( hass, device_tracker.DOMAIN, { device_tracker.DOMAIN: { CONF_PLATFORM: "mqtt", "devices": {dev_id: subscription}, } }, ) async_fire_mqtt_message(hass, topic, location) await hass.async_block_till_done() assert hass.states.get(entity_id) is None # Deprecated in HA Core 2022.6 async def test_legacy_matching_custom_payload_for_home_and_not_home( hass, mock_device_tracker_conf, mqtt_mock_entry_no_yaml_config ): """Test custom payload_home sets state to home and custom payload_not_home sets state to not_home.""" await mqtt_mock_entry_no_yaml_config() dev_id = "paulus" entity_id = f"{device_tracker.DOMAIN}.{dev_id}" topic = "/location/paulus" payload_home = "present" payload_not_home = "not present" hass.config.components = {"mqtt", "zone"} assert await async_setup_component( hass, device_tracker.DOMAIN, { device_tracker.DOMAIN: { CONF_PLATFORM: "mqtt", "devices": {dev_id: topic}, "payload_home": payload_home, "payload_not_home": payload_not_home, } }, ) async_fire_mqtt_message(hass, topic, payload_home) await hass.async_block_till_done() assert hass.states.get(entity_id).state == STATE_HOME async_fire_mqtt_message(hass, topic, payload_not_home) await hass.async_block_till_done() assert hass.states.get(entity_id).state == STATE_NOT_HOME # Deprecated in HA Core 2022.6 async def test_legacy_not_matching_custom_payload_for_home_and_not_home( hass, mock_device_tracker_conf, mqtt_mock_entry_no_yaml_config ): """Test not matching payload does not set state to home or not_home.""" await mqtt_mock_entry_no_yaml_config() dev_id = "paulus" entity_id = f"{device_tracker.DOMAIN}.{dev_id}" topic = "/location/paulus" payload_home = "present" payload_not_home = "not present" payload_not_matching = "test" hass.config.components = {"mqtt", "zone"} assert await async_setup_component( hass, device_tracker.DOMAIN, { device_tracker.DOMAIN: { CONF_PLATFORM: "mqtt", "devices": {dev_id: topic}, "payload_home": payload_home, "payload_not_home": payload_not_home, } }, ) async_fire_mqtt_message(hass, topic, payload_not_matching) await hass.async_block_till_done() assert hass.states.get(entity_id).state != STATE_HOME assert hass.states.get(entity_id).state != STATE_NOT_HOME # Deprecated in HA Core 2022.6 async def test_legacy_matching_source_type( hass, mock_device_tracker_conf, mqtt_mock_entry_no_yaml_config ): """Test setting source type.""" await mqtt_mock_entry_no_yaml_config() dev_id = "paulus" entity_id = f"{device_tracker.DOMAIN}.{dev_id}" topic = "/location/paulus" source_type = SourceType.BLUETOOTH location = "work" hass.config.components = {"mqtt", "zone"} assert await async_setup_component( hass, device_tracker.DOMAIN, { device_tracker.DOMAIN: { CONF_PLATFORM: "mqtt", "devices": {dev_id: topic}, "source_type": source_type, } }, ) async_fire_mqtt_message(hass, topic, location) await hass.async_block_till_done() assert hass.states.get(entity_id).attributes["source_type"] == SourceType.BLUETOOTH # Deprecated in HA Core 2022.6 async def test_unload_entry( hass, mock_device_tracker_conf, mqtt_mock_entry_no_yaml_config, tmp_path ): """Test unloading the config entry.""" # setup through configuration.yaml await mqtt_mock_entry_no_yaml_config() dev_id = "jan" entity_id = f"{device_tracker.DOMAIN}.{dev_id}" topic = "/location/jan" location = "home" hass.config.components = {"mqtt", "zone"} assert await async_setup_component( hass, device_tracker.DOMAIN, {device_tracker.DOMAIN: {CONF_PLATFORM: "mqtt", "devices": {dev_id: topic}}}, ) async_fire_mqtt_message(hass, topic, location) await hass.async_block_till_done() assert hass.states.get(entity_id).state == location # setup through discovery dev_id = "piet" subscription = "/location/#" domain = device_tracker.DOMAIN discovery_config = { "devices": {dev_id: subscription}, "state_topic": "some-state", "name": "piet", } async_fire_mqtt_message( hass, f"homeassistant/{domain}/bla/config", json.dumps(discovery_config) ) await hass.async_block_till_done() # check that both entities were created config_setup_entity = hass.states.get(f"{domain}.jan") assert config_setup_entity discovery_setup_entity = hass.states.get(f"{domain}.piet") assert discovery_setup_entity await help_test_unload_config_entry(hass, tmp_path, {}) await hass.async_block_till_done() # check that both entities were unsubscribed and that the location was not processed async_fire_mqtt_message(hass, "some-state", "not_home") async_fire_mqtt_message(hass, "location/jan", "not_home") await hass.async_block_till_done() config_setup_entity = hass.states.get(f"{domain}.jan") assert config_setup_entity.state == location # the discovered tracker is an entity which state is removed at unload discovery_setup_entity = hass.states.get(f"{domain}.piet") assert discovery_setup_entity is None # Deprecated in HA Core 2022.6 async def test_reload_entry_legacy( hass, mock_device_tracker_conf, mqtt_mock_entry_no_yaml_config, tmp_path ): """Test reloading the config entry with manual MQTT items.""" # setup through configuration.yaml await mqtt_mock_entry_no_yaml_config() entity_id = f"{device_tracker.DOMAIN}.jan" topic = "location/jan" location = "home" config = { device_tracker.DOMAIN: {CONF_PLATFORM: "mqtt", "devices": {"jan": topic}}, } hass.config.components = {"mqtt", "zone"} assert await async_setup_component(hass, device_tracker.DOMAIN, config) await hass.async_block_till_done() async_fire_mqtt_message(hass, topic, location) await hass.async_block_till_done() assert hass.states.get(entity_id).state == location await help_test_entry_reload_with_new_config(hass, tmp_path, config) await hass.async_block_till_done() location = "not_home" async_fire_mqtt_message(hass, topic, location) await hass.async_block_till_done() assert hass.states.get(entity_id).state == location # Deprecated in HA Core 2022.6 async def test_setup_with_disabled_entry( hass, mock_device_tracker_conf, caplog ) -> None: """Test setting up the platform with a disabled config entry.""" # Try to setup the platform with a disabled config entry config_entry = MockConfigEntry( domain="mqtt", data={}, disabled_by=ConfigEntryDisabler.USER ) config_entry.add_to_hass(hass) topic = "location/jan" config = { device_tracker.DOMAIN: {CONF_PLATFORM: "mqtt", "devices": {"jan": topic}}, } hass.config.components = {"mqtt", "zone"} await async_setup_component(hass, device_tracker.DOMAIN, config) await hass.async_block_till_done() assert ( "MQTT device trackers will be not available until the config entry is enabled" in caplog.text )