jeans/core
jeans/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-07-23 13:17:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve device tracker tests (#27159)

Browse Source
This commit is contained in:
Robert Svensson 2019-10-03 22:23:25 +02:00 committed by Paulus Schoutsen
parent 9902209ad2
commit 565302ed34
1 changed files with 137 additions and 127 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

264
tests/components/unifi/test_device_tracker.py
View File

@ -4,12 +4,7 @@ from copy import copy
from datetime import timedelta from datetime import timedelta
from asynctest import Mock from asynctest import patch
import pytest
from aiounifi.clients import Clients, ClientsAll
from aiounifi.devices import Devices
from homeassistant import config_entries from homeassistant import config_entries
from homeassistant.components import unifi from homeassistant.components import unifi
@ -107,64 +102,63 @@ ENTRY_CONFIG = {CONF_CONTROLLER: CONTROLLER_DATA}
CONTROLLER_ID = CONF_CONTROLLER_ID.format(host="mock-host", site="mock-site") CONTROLLER_ID = CONF_CONTROLLER_ID.format(host="mock-host", site="mock-site")
@pytest.fixture async def setup_unifi_integration(
def mock_controller(hass): hass, config, options, clients_response, devices_response, clients_all_response
"""Mock a UniFi Controller.""" ):
hass.data[UNIFI_CONFIG] = {} """Create the UniFi controller."""
hass.data[UNIFI_WIRELESS_CLIENTS] = Mock() hass.data[UNIFI_CONFIG] = []
controller = unifi.UniFiController(hass, None) hass.data[UNIFI_WIRELESS_CLIENTS] = unifi.UnifiWirelessClients(hass)
controller.wireless_clients = set()
controller.api = Mock()
controller.mock_requests = []
controller.mock_client_responses = deque()
controller.mock_device_responses = deque()
controller.mock_client_all_responses = deque()
async def mock_request(method, path, **kwargs):
kwargs["method"] = method
kwargs["path"] = path
controller.mock_requests.append(kwargs)
if path == "s/{site}/stat/sta":
return controller.mock_client_responses.popleft()
if path == "s/{site}/stat/device":
return controller.mock_device_responses.popleft()
if path == "s/{site}/rest/user":
return controller.mock_client_all_responses.popleft()
return None
controller.api.clients = Clients({}, mock_request)
controller.api.devices = Devices({}, mock_request)
controller.api.clients_all = ClientsAll({}, mock_request)
return controller
async def setup_controller(hass, mock_controller, options={}):
"""Load the UniFi switch platform with the provided controller."""
hass.config.components.add(unifi.DOMAIN)
hass.data[unifi.DOMAIN] = {CONTROLLER_ID: mock_controller}
config_entry = config_entries.ConfigEntry( config_entry = config_entries.ConfigEntry(
1, version=1,
unifi.DOMAIN, domain=unifi.DOMAIN,
"Mock Title", title="Mock Title",
ENTRY_CONFIG, data=config,
"test", source="test",
config_entries.CONN_CLASS_LOCAL_POLL, connection_class=config_entries.CONN_CLASS_LOCAL_POLL,
entry_id=1,
system_options={}, system_options={},
options=options, options=options,
) entry_id=1,
hass.config_entries._entries.append(config_entry)
mock_controller.config_entry = config_entry
await mock_controller.async_update()
await hass.config_entries.async_forward_entry_setup(
config_entry, device_tracker.DOMAIN
) )
sites = {"Site name": {"desc": "Site name", "name": "mock-site", "role": "viewer"}}
mock_client_responses = deque()
mock_client_responses.append(clients_response)
mock_device_responses = deque()
mock_device_responses.append(devices_response)
mock_client_all_responses = deque()
mock_client_all_responses.append(clients_all_response)
mock_requests = []
async def mock_request(self, method, path, json=None):
mock_requests.append({"method": method, "path": path, "json": json})
print(mock_requests, mock_client_responses, mock_device_responses)
if path == "s/{site}/stat/sta" and mock_client_responses:
return mock_client_responses.popleft()
if path == "s/{site}/stat/device" and mock_device_responses:
return mock_device_responses.popleft()
if path == "s/{site}/rest/user" and mock_client_all_responses:
return mock_client_all_responses.popleft()
return {}
with patch("aiounifi.Controller.login", return_value=True), patch(
"aiounifi.Controller.sites", return_value=sites
), patch("aiounifi.Controller.request", new=mock_request):
await unifi.async_setup_entry(hass, config_entry)
await hass.async_block_till_done() await hass.async_block_till_done()
hass.config_entries._entries.append(config_entry)
controller_id = unifi.get_controller_id_from_config_entry(config_entry)
controller = hass.data[unifi.DOMAIN][controller_id]
controller.mock_client_responses = mock_client_responses
controller.mock_device_responses = mock_device_responses
controller.mock_client_all_responses = mock_client_all_responses
return controller
async def test_platform_manually_configured(hass): async def test_platform_manually_configured(hass):
@ -178,24 +172,30 @@ async def test_platform_manually_configured(hass):
assert unifi.DOMAIN not in hass.data assert unifi.DOMAIN not in hass.data
async def test_no_clients(hass, mock_controller): async def test_no_clients(hass):
"""Test the update_clients function when no clients are found.""" """Test the update_clients function when no clients are found."""
mock_controller.mock_client_responses.append({}) await setup_unifi_integration(
mock_controller.mock_device_responses.append({}) hass,
ENTRY_CONFIG,
options={},
clients_response={},
devices_response={},
clients_all_response={},
)
await setup_controller(hass, mock_controller)
assert len(mock_controller.mock_requests) == 2
assert len(hass.states.async_all()) == 2 assert len(hass.states.async_all()) == 2
async def test_tracked_devices(hass, mock_controller): async def test_tracked_devices(hass):
"""Test the update_items function with some clients.""" """Test the update_items function with some clients."""
mock_controller.mock_client_responses.append([CLIENT_1, CLIENT_2, CLIENT_3]) controller = await setup_unifi_integration(
mock_controller.mock_device_responses.append([DEVICE_1, DEVICE_2]) hass,
options = {CONF_SSID_FILTER: ["ssid"]} ENTRY_CONFIG,
options={CONF_SSID_FILTER: ["ssid"]},
await setup_controller(hass, mock_controller, options) clients_response=[CLIENT_1, CLIENT_2, CLIENT_3],
assert len(mock_controller.mock_requests) == 2 devices_response=[DEVICE_1, DEVICE_2],
clients_all_response={},
)
assert len(hass.states.async_all()) == 5 assert len(hass.states.async_all()) == 5
client_1 = hass.states.get("device_tracker.client_1") client_1 = hass.states.get("device_tracker.client_1")
@ -217,9 +217,9 @@ async def test_tracked_devices(hass, mock_controller):
client_1_copy["last_seen"] = dt_util.as_timestamp(dt_util.utcnow()) client_1_copy["last_seen"] = dt_util.as_timestamp(dt_util.utcnow())
device_1_copy = copy(DEVICE_1) device_1_copy = copy(DEVICE_1)
device_1_copy["last_seen"] = dt_util.as_timestamp(dt_util.utcnow()) device_1_copy["last_seen"] = dt_util.as_timestamp(dt_util.utcnow())
mock_controller.mock_client_responses.append([client_1_copy]) controller.mock_client_responses.append([client_1_copy])
mock_controller.mock_device_responses.append([device_1_copy]) controller.mock_device_responses.append([device_1_copy])
await mock_controller.async_update() await controller.async_update()
await hass.async_block_till_done() await hass.async_block_till_done()
client_1 = hass.states.get("device_tracker.client_1") client_1 = hass.states.get("device_tracker.client_1")
@ -230,19 +230,17 @@ async def test_tracked_devices(hass, mock_controller):
device_1_copy = copy(DEVICE_1) device_1_copy = copy(DEVICE_1)
device_1_copy["disabled"] = True device_1_copy["disabled"] = True
mock_controller.mock_client_responses.append({}) controller.mock_client_responses.append({})
mock_controller.mock_device_responses.append([device_1_copy]) controller.mock_device_responses.append([device_1_copy])
await mock_controller.async_update() await controller.async_update()
await hass.async_block_till_done() await hass.async_block_till_done()
device_1 = hass.states.get("device_tracker.device_1") device_1 = hass.states.get("device_tracker.device_1")
assert device_1.state == STATE_UNAVAILABLE assert device_1.state == STATE_UNAVAILABLE
mock_controller.config_entry.add_update_listener( controller.config_entry.add_update_listener(controller.async_options_updated)
mock_controller.async_options_updated
)
hass.config_entries.async_update_entry( hass.config_entries.async_update_entry(
mock_controller.config_entry, controller.config_entry,
options={ options={
CONF_SSID_FILTER: [], CONF_SSID_FILTER: [],
CONF_TRACK_WIRED_CLIENTS: False, CONF_TRACK_WIRED_CLIENTS: False,
@ -258,18 +256,22 @@ async def test_tracked_devices(hass, mock_controller):
assert device_1 is None assert device_1 is None
async def test_wireless_client_go_wired_issue(hass, mock_controller): async def test_wireless_client_go_wired_issue(hass):
"""Test the solution to catch wireless device go wired UniFi issue. """Test the solution to catch wireless device go wired UniFi issue.
UniFi has a known issue that when a wireless device goes away it sometimes gets marked as wired. UniFi has a known issue that when a wireless device goes away it sometimes gets marked as wired.
""" """
client_1_client = copy(CLIENT_1) client_1_client = copy(CLIENT_1)
client_1_client["last_seen"] = dt_util.as_timestamp(dt_util.utcnow()) client_1_client["last_seen"] = dt_util.as_timestamp(dt_util.utcnow())
mock_controller.mock_client_responses.append([client_1_client])
mock_controller.mock_device_responses.append({})
await setup_controller(hass, mock_controller) controller = await setup_unifi_integration(
assert len(mock_controller.mock_requests) == 2 hass,
ENTRY_CONFIG,
options={},
clients_response=[client_1_client],
devices_response={},
clients_all_response={},
)
assert len(hass.states.async_all()) == 3 assert len(hass.states.async_all()) == 3
client_1 = hass.states.get("device_tracker.client_1") client_1 = hass.states.get("device_tracker.client_1")
@ -278,9 +280,9 @@ async def test_wireless_client_go_wired_issue(hass, mock_controller):
client_1_client["is_wired"] = True client_1_client["is_wired"] = True
client_1_client["last_seen"] = dt_util.as_timestamp(dt_util.utcnow()) client_1_client["last_seen"] = dt_util.as_timestamp(dt_util.utcnow())
mock_controller.mock_client_responses.append([client_1_client]) controller.mock_client_responses.append([client_1_client])
mock_controller.mock_device_responses.append({}) controller.mock_device_responses.append({})
await mock_controller.async_update() await controller.async_update()
await hass.async_block_till_done() await hass.async_block_till_done()
client_1 = hass.states.get("device_tracker.client_1") client_1 = hass.states.get("device_tracker.client_1")
@ -288,31 +290,27 @@ async def test_wireless_client_go_wired_issue(hass, mock_controller):
client_1_client["is_wired"] = False client_1_client["is_wired"] = False
client_1_client["last_seen"] = dt_util.as_timestamp(dt_util.utcnow()) client_1_client["last_seen"] = dt_util.as_timestamp(dt_util.utcnow())
mock_controller.mock_client_responses.append([client_1_client]) controller.mock_client_responses.append([client_1_client])
mock_controller.mock_device_responses.append({}) controller.mock_device_responses.append({})
await mock_controller.async_update() await controller.async_update()
await hass.async_block_till_done() await hass.async_block_till_done()
client_1 = hass.states.get("device_tracker.client_1") client_1 = hass.states.get("device_tracker.client_1")
assert client_1.state == "home" assert client_1.state == "home"
async def test_restoring_client(hass, mock_controller): async def test_restoring_client(hass):
"""Test the update_items function with some clients.""" """Test the update_items function with some clients."""
mock_controller.mock_client_responses.append([CLIENT_2])
mock_controller.mock_device_responses.append({})
mock_controller.mock_client_all_responses.append([CLIENT_1])
options = {unifi.CONF_BLOCK_CLIENT: True}
config_entry = config_entries.ConfigEntry( config_entry = config_entries.ConfigEntry(
1, version=1,
unifi.DOMAIN, domain=unifi.DOMAIN,
"Mock Title", title="Mock Title",
ENTRY_CONFIG, data=ENTRY_CONFIG,
"test", source="test",
config_entries.CONN_CLASS_LOCAL_POLL, connection_class=config_entries.CONN_CLASS_LOCAL_POLL,
entry_id=1,
system_options={}, system_options={},
options={},
entry_id=1,
) )
registry = await entity_registry.async_get_registry(hass) registry = await entity_registry.async_get_registry(hass)
@ -331,22 +329,30 @@ async def test_restoring_client(hass, mock_controller):
config_entry=config_entry, config_entry=config_entry,
) )
await setup_controller(hass, mock_controller, options) await setup_unifi_integration(
assert len(mock_controller.mock_requests) == 3 hass,
ENTRY_CONFIG,
options={unifi.CONF_BLOCK_CLIENT: True},
clients_response=[CLIENT_2],
devices_response={},
clients_all_response=[CLIENT_1],
)
assert len(hass.states.async_all()) == 4 assert len(hass.states.async_all()) == 4
device_1 = hass.states.get("device_tracker.client_1") device_1 = hass.states.get("device_tracker.client_1")
assert device_1 is not None assert device_1 is not None
async def test_dont_track_clients(hass, mock_controller): async def test_dont_track_clients(hass):
"""Test dont track clients config works.""" """Test dont track clients config works."""
mock_controller.mock_client_responses.append([CLIENT_1]) await setup_unifi_integration(
mock_controller.mock_device_responses.append([DEVICE_1]) hass,
options = {unifi.controller.CONF_TRACK_CLIENTS: False} ENTRY_CONFIG,
options={unifi.controller.CONF_TRACK_CLIENTS: False},
await setup_controller(hass, mock_controller, options) clients_response=[CLIENT_1],
assert len(mock_controller.mock_requests) == 2 devices_response=[DEVICE_1],
clients_all_response={},
)
assert len(hass.states.async_all()) == 3 assert len(hass.states.async_all()) == 3
client_1 = hass.states.get("device_tracker.client_1") client_1 = hass.states.get("device_tracker.client_1")
@ -357,14 +363,16 @@ async def test_dont_track_clients(hass, mock_controller):
assert device_1.state == "not_home" assert device_1.state == "not_home"
async def test_dont_track_devices(hass, mock_controller): async def test_dont_track_devices(hass):
"""Test dont track devices config works.""" """Test dont track devices config works."""
mock_controller.mock_client_responses.append([CLIENT_1]) await setup_unifi_integration(
mock_controller.mock_device_responses.append([DEVICE_1]) hass,
options = {unifi.controller.CONF_TRACK_DEVICES: False} ENTRY_CONFIG,
options={unifi.controller.CONF_TRACK_DEVICES: False},
await setup_controller(hass, mock_controller, options) clients_response=[CLIENT_1],
assert len(mock_controller.mock_requests) == 2 devices_response=[DEVICE_1],
clients_all_response={},
)
assert len(hass.states.async_all()) == 3 assert len(hass.states.async_all()) == 3
client_1 = hass.states.get("device_tracker.client_1") client_1 = hass.states.get("device_tracker.client_1")
@ -375,14 +383,16 @@ async def test_dont_track_devices(hass, mock_controller):
assert device_1 is None assert device_1 is None
async def test_dont_track_wired_clients(hass, mock_controller): async def test_dont_track_wired_clients(hass):
"""Test dont track wired clients config works.""" """Test dont track wired clients config works."""
mock_controller.mock_client_responses.append([CLIENT_1, CLIENT_2]) await setup_unifi_integration(
mock_controller.mock_device_responses.append({}) hass,
options = {unifi.controller.CONF_TRACK_WIRED_CLIENTS: False} ENTRY_CONFIG,
options={unifi.controller.CONF_TRACK_WIRED_CLIENTS: False},
await setup_controller(hass, mock_controller, options) clients_response=[CLIENT_1, CLIENT_2],
assert len(mock_controller.mock_requests) == 2 devices_response={},
clients_all_response={},
)
assert len(hass.states.async_all()) == 3 assert len(hass.states.async_all()) == 3
client_1 = hass.states.get("device_tracker.client_1") client_1 = hass.states.get("device_tracker.client_1")