jeans/core
jeans/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-07-14 16:57:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix thread leak in onvif discovery (#93742)

Browse Source
This commit is contained in:
J. Nick Koston 2023-05-29 10:06:13 -05:00 committed by GitHub
parent 3db59908ca
commit db931132a8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 28 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
homeassistant/components/onvif/config_flow.py
View File

@ -51,12 +51,15 @@ CONF_MANUAL_INPUT = "Manually configure ONVIF device"
def wsdiscovery() -> list[Service]: def wsdiscovery() -> list[Service]:
"""Get ONVIF Profile S devices from network.""" """Get ONVIF Profile S devices from network."""
discovery = WSDiscovery(ttl=4) discovery = WSDiscovery(ttl=4)
discovery.start() try:
services = discovery.searchServices( discovery.start()
scopes=[Scope("onvif://www.onvif.org/Profile/Streaming")] return discovery.searchServices(
) scopes=[Scope("onvif://www.onvif.org/Profile/Streaming")]
discovery.stop() )
return services finally:
discovery.stop()
# Stop the threads started by WSDiscovery since otherwise there is a leak.
discovery._stopThreads() # pylint: disable=protected-access
async def async_discovery(hass: HomeAssistant) -> list[dict[str, Any]]: async def async_discovery(hass: HomeAssistant) -> list[dict[str, Any]]:

32
tests/components/onvif/test_config_flow.py
View File

@ -60,10 +60,13 @@ def setup_mock_discovery(
with_mac=False, with_mac=False,
two_devices=False, two_devices=False,
with_hardware=True, with_hardware=True,
no_devices=False,
): ):
"""Prepare mock discovery result.""" """Prepare mock discovery result."""
services = [] services = []
for item in DISCOVERY: for item in DISCOVERY:
if no_devices:
continue
service = MagicMock() service = MagicMock()
service.getXAddrs = MagicMock( service.getXAddrs = MagicMock(
return_value=[ return_value=[
@ -92,7 +95,10 @@ def setup_mock_discovery(
scopes.append(scope) scopes.append(scope)
service.getScopes = MagicMock(return_value=scopes) service.getScopes = MagicMock(return_value=scopes)
services.append(service) services.append(service)
mock_discovery.return_value = services
mock_ws_discovery = MagicMock()
mock_ws_discovery.searchServices = MagicMock(return_value=services)
mock_discovery.return_value = mock_ws_discovery
async def test_flow_discovered_devices(hass: HomeAssistant) -> None: async def test_flow_discovered_devices(hass: HomeAssistant) -> None:
@ -108,7 +114,7 @@ async def test_flow_discovered_devices(hass: HomeAssistant) -> None:
with patch( with patch(
"homeassistant.components.onvif.config_flow.get_device" "homeassistant.components.onvif.config_flow.get_device"
) as mock_onvif_camera, patch( ) as mock_onvif_camera, patch(
"homeassistant.components.onvif.config_flow.wsdiscovery" "homeassistant.components.onvif.config_flow.WSDiscovery"
) as mock_discovery, patch( ) as mock_discovery, patch(
"homeassistant.components.onvif.ONVIFDevice" "homeassistant.components.onvif.ONVIFDevice"
) as mock_device: ) as mock_device:
@ -178,7 +184,7 @@ async def test_flow_discovered_devices_ignore_configured_manual_input(
with patch( with patch(
"homeassistant.components.onvif.config_flow.get_device" "homeassistant.components.onvif.config_flow.get_device"
) as mock_onvif_camera, patch( ) as mock_onvif_camera, patch(
"homeassistant.components.onvif.config_flow.wsdiscovery" "homeassistant.components.onvif.config_flow.WSDiscovery"
) as mock_discovery, patch( ) as mock_discovery, patch(
"homeassistant.components.onvif.ONVIFDevice" "homeassistant.components.onvif.ONVIFDevice"
) as mock_device: ) as mock_device:
@ -217,12 +223,12 @@ async def test_flow_discovered_no_device(hass: HomeAssistant) -> None:
with patch( with patch(
"homeassistant.components.onvif.config_flow.get_device" "homeassistant.components.onvif.config_flow.get_device"
) as mock_onvif_camera, patch( ) as mock_onvif_camera, patch(
"homeassistant.components.onvif.config_flow.wsdiscovery" "homeassistant.components.onvif.config_flow.WSDiscovery"
) as mock_discovery, patch( ) as mock_discovery, patch(
"homeassistant.components.onvif.ONVIFDevice" "homeassistant.components.onvif.ONVIFDevice"
) as mock_device: ) as mock_device:
setup_mock_onvif_camera(mock_onvif_camera) setup_mock_onvif_camera(mock_onvif_camera)
mock_discovery.return_value = [] setup_mock_discovery(mock_discovery, no_devices=True)
setup_mock_device(mock_device) setup_mock_device(mock_device)
result = await hass.config_entries.flow.async_configure( result = await hass.config_entries.flow.async_configure(
@ -259,7 +265,7 @@ async def test_flow_discovery_ignore_existing_and_abort(hass: HomeAssistant) ->
with patch( with patch(
"homeassistant.components.onvif.config_flow.get_device" "homeassistant.components.onvif.config_flow.get_device"
) as mock_onvif_camera, patch( ) as mock_onvif_camera, patch(
"homeassistant.components.onvif.config_flow.wsdiscovery" "homeassistant.components.onvif.config_flow.WSDiscovery"
) as mock_discovery, patch( ) as mock_discovery, patch(
"homeassistant.components.onvif.ONVIFDevice" "homeassistant.components.onvif.ONVIFDevice"
) as mock_device: ) as mock_device:
@ -302,7 +308,7 @@ async def test_flow_manual_entry(hass: HomeAssistant) -> None:
with patch( with patch(
"homeassistant.components.onvif.config_flow.get_device" "homeassistant.components.onvif.config_flow.get_device"
) as mock_onvif_camera, patch( ) as mock_onvif_camera, patch(
"homeassistant.components.onvif.config_flow.wsdiscovery" "homeassistant.components.onvif.config_flow.WSDiscovery"
) as mock_discovery, patch( ) as mock_discovery, patch(
"homeassistant.components.onvif.ONVIFDevice" "homeassistant.components.onvif.ONVIFDevice"
) as mock_device: ) as mock_device:
@ -359,7 +365,7 @@ async def test_flow_manual_entry_no_profiles(hass: HomeAssistant) -> None:
with patch( with patch(
"homeassistant.components.onvif.config_flow.get_device" "homeassistant.components.onvif.config_flow.get_device"
) as mock_onvif_camera, patch( ) as mock_onvif_camera, patch(
"homeassistant.components.onvif.config_flow.wsdiscovery" "homeassistant.components.onvif.config_flow.WSDiscovery"
) as mock_discovery, patch( ) as mock_discovery, patch(
"homeassistant.components.onvif.ONVIFDevice" "homeassistant.components.onvif.ONVIFDevice"
) as mock_device: ) as mock_device:
@ -399,7 +405,7 @@ async def test_flow_manual_entry_no_mac(hass: HomeAssistant) -> None:
with patch( with patch(
"homeassistant.components.onvif.config_flow.get_device" "homeassistant.components.onvif.config_flow.get_device"
) as mock_onvif_camera, patch( ) as mock_onvif_camera, patch(
"homeassistant.components.onvif.config_flow.wsdiscovery" "homeassistant.components.onvif.config_flow.WSDiscovery"
) as mock_discovery, patch( ) as mock_discovery, patch(
"homeassistant.components.onvif.ONVIFDevice" "homeassistant.components.onvif.ONVIFDevice"
) as mock_device: ) as mock_device:
@ -441,7 +447,7 @@ async def test_flow_manual_entry_fails(hass: HomeAssistant) -> None:
with patch( with patch(
"homeassistant.components.onvif.config_flow.get_device" "homeassistant.components.onvif.config_flow.get_device"
) as mock_onvif_camera, patch( ) as mock_onvif_camera, patch(
"homeassistant.components.onvif.config_flow.wsdiscovery" "homeassistant.components.onvif.config_flow.WSDiscovery"
) as mock_discovery, patch( ) as mock_discovery, patch(
"homeassistant.components.onvif.ONVIFDevice" "homeassistant.components.onvif.ONVIFDevice"
) as mock_device: ) as mock_device:
@ -549,7 +555,7 @@ async def test_flow_manual_entry_wrong_password(hass: HomeAssistant) -> None:
with patch( with patch(
"homeassistant.components.onvif.config_flow.get_device" "homeassistant.components.onvif.config_flow.get_device"
) as mock_onvif_camera, patch( ) as mock_onvif_camera, patch(
"homeassistant.components.onvif.config_flow.wsdiscovery" "homeassistant.components.onvif.config_flow.WSDiscovery"
) as mock_discovery, patch( ) as mock_discovery, patch(
"homeassistant.components.onvif.ONVIFDevice" "homeassistant.components.onvif.ONVIFDevice"
) as mock_device: ) as mock_device:
@ -826,7 +832,7 @@ async def test_flow_manual_entry_updates_existing_user_password(
with patch( with patch(
"homeassistant.components.onvif.config_flow.get_device" "homeassistant.components.onvif.config_flow.get_device"
) as mock_onvif_camera, patch( ) as mock_onvif_camera, patch(
"homeassistant.components.onvif.config_flow.wsdiscovery" "homeassistant.components.onvif.config_flow.WSDiscovery"
) as mock_discovery, patch( ) as mock_discovery, patch(
"homeassistant.components.onvif.ONVIFDevice" "homeassistant.components.onvif.ONVIFDevice"
) as mock_device: ) as mock_device:
@ -877,7 +883,7 @@ async def test_flow_manual_entry_wrong_port(hass: HomeAssistant) -> None:
with patch( with patch(
"homeassistant.components.onvif.config_flow.get_device" "homeassistant.components.onvif.config_flow.get_device"
) as mock_onvif_camera, patch( ) as mock_onvif_camera, patch(
"homeassistant.components.onvif.config_flow.wsdiscovery" "homeassistant.components.onvif.config_flow.WSDiscovery"
) as mock_discovery, patch( ) as mock_discovery, patch(
"homeassistant.components.onvif.ONVIFDevice" "homeassistant.components.onvif.ONVIFDevice"
) as mock_device: ) as mock_device: