From 49478298ccfdc2dbaed74a19775cb790e49cf4b0 Mon Sep 17 00:00:00 2001 From: "J. Nick Koston" Date: Thu, 13 Aug 2020 22:00:39 -0500 Subject: [PATCH] Ensure service browser does not collapse on bad dns names (#38851) If a device on the network presented a bad name, zeroconf would throw zeroconf.BadTypeInNameException and the service browser would die off. We now trap the exception and continue. --- homeassistant/components/zeroconf/__init__.py | 8 ++++++- tests/components/zeroconf/test_init.py | 22 ++++++++++++++++++- 2 files changed, 28 insertions(+), 2 deletions(-) diff --git a/homeassistant/components/zeroconf/__init__.py b/homeassistant/components/zeroconf/__init__.py index 5bbc87f3da8..1eeef3917d7 100644 --- a/homeassistant/components/zeroconf/__init__.py +++ b/homeassistant/components/zeroconf/__init__.py @@ -8,6 +8,7 @@ import voluptuous as vol from zeroconf import ( DNSPointer, DNSRecord, + Error as ZeroconfError, InterfaceChoice, IPVersion, NonUniqueNameException, @@ -212,7 +213,12 @@ def setup(hass, config): if state_change != ServiceStateChange.Added: return - service_info = zeroconf.get_service_info(service_type, name) + try: + service_info = zeroconf.get_service_info(service_type, name) + except ZeroconfError: + _LOGGER.exception("Failed to get info for device %s", name) + return + if not service_info: # Prevent the browser thread from collapsing as # service_info can be None diff --git a/tests/components/zeroconf/test_init.py b/tests/components/zeroconf/test_init.py index 2ced2fac8ea..32891a04262 100644 --- a/tests/components/zeroconf/test_init.py +++ b/tests/components/zeroconf/test_init.py @@ -1,5 +1,11 @@ """Test Zeroconf component setup process.""" -from zeroconf import InterfaceChoice, IPVersion, ServiceInfo, ServiceStateChange +from zeroconf import ( + BadTypeInNameException, + InterfaceChoice, + IPVersion, + ServiceInfo, + ServiceStateChange, +) from homeassistant.components import zeroconf from homeassistant.components.zeroconf import CONF_DEFAULT_INTERFACE, CONF_IPV6 @@ -167,6 +173,20 @@ async def test_setup_with_ipv6_default(hass, mock_zeroconf): assert mock_zeroconf.called_with() +async def test_service_with_invalid_name(hass, mock_zeroconf, caplog): + """Test we do not crash on service with an invalid name.""" + with patch.object( + zeroconf, "HaServiceBrowser", side_effect=service_update_mock + ) as mock_service_browser: + mock_zeroconf.get_service_info.side_effect = BadTypeInNameException + assert await async_setup_component(hass, zeroconf.DOMAIN, {zeroconf.DOMAIN: {}}) + hass.bus.async_fire(EVENT_HOMEASSISTANT_STARTED) + await hass.async_block_till_done() + + assert len(mock_service_browser.mock_calls) == 1 + assert "Failed to get info for device name" in caplog.text + + async def test_homekit_match_partial_space(hass, mock_zeroconf): """Test configured options for a device are loaded via config entry.""" with patch.dict(