Prefer more targeted matchers in USB discovery (#56142)

- If there is a more targeted match it should win discovery
This commit is contained in:
J. Nick Koston 2021-09-12 12:07:40 -10:00 committed by GitHub
parent 0fc89780e9
commit 673519f6bf
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 54 additions and 0 deletions

View file

@ -161,6 +161,7 @@ class USBDiscovery:
if device_tuple in self.seen:
return
self.seen.add(device_tuple)
matched = []
for matcher in self.usb:
if "vid" in matcher and device.vid != matcher["vid"]:
continue
@ -178,6 +179,20 @@ class USBDiscovery:
device.description, matcher["description"]
):
continue
matched.append(matcher)
if not matched:
return
sorted_by_most_targeted = sorted(matched, key=lambda item: -len(item))
most_matched_fields = len(sorted_by_most_targeted[0])
for matcher in sorted_by_most_targeted:
# If there is a less targeted match, we only
# want the most targeted match
if len(matcher) < most_matched_fields:
break
flow: USBFlow = {
"domain": matcher["domain"],
"context": {"source": config_entries.SOURCE_USB},

View file

@ -176,6 +176,45 @@ async def test_discovered_by_websocket_scan_limited_by_description_matcher(
assert mock_config_flow.mock_calls[0][1][0] == "test1"
async def test_most_targeted_matcher_wins(hass, hass_ws_client):
"""Test that the most targeted matcher is used."""
new_usb = [
{"domain": "less", "vid": "3039", "pid": "3039"},
{"domain": "more", "vid": "3039", "pid": "3039", "description": "*2652*"},
]
mock_comports = [
MagicMock(
device=slae_sh_device.device,
vid=12345,
pid=12345,
serial_number=slae_sh_device.serial_number,
manufacturer=slae_sh_device.manufacturer,
description=slae_sh_device.description,
)
]
with patch("pyudev.Context", side_effect=ImportError), patch(
"homeassistant.components.usb.async_get_usb", return_value=new_usb
), patch(
"homeassistant.components.usb.comports", return_value=mock_comports
), patch.object(
hass.config_entries.flow, "async_init"
) as mock_config_flow:
assert await async_setup_component(hass, "usb", {"usb": {}})
await hass.async_block_till_done()
hass.bus.async_fire(EVENT_HOMEASSISTANT_STARTED)
await hass.async_block_till_done()
ws_client = await hass_ws_client(hass)
await ws_client.send_json({"id": 1, "type": "usb/scan"})
response = await ws_client.receive_json()
assert response["success"]
await hass.async_block_till_done()
assert len(mock_config_flow.mock_calls) == 1
assert mock_config_flow.mock_calls[0][1][0] == "more"
async def test_discovered_by_websocket_scan_rejected_by_description_matcher(
hass, hass_ws_client
):