2016-03-09 10:25:50 +01:00
|
|
|
"""The tests for the Unifi WAP device tracker platform."""
|
2019-07-14 21:57:09 +02:00
|
|
|
from collections import deque
|
|
|
|
from copy import copy
|
|
|
|
from unittest.mock import Mock
|
|
|
|
from datetime import timedelta
|
2016-02-19 15:19:03 -08:00
|
|
|
|
2017-05-13 21:25:54 -07:00
|
|
|
import pytest
|
2016-09-04 10:06:16 +02:00
|
|
|
|
2019-07-29 23:13:04 +02:00
|
|
|
from aiounifi.clients import Clients, ClientsAll
|
2019-07-14 21:57:09 +02:00
|
|
|
from aiounifi.devices import Devices
|
|
|
|
|
|
|
|
from homeassistant import config_entries
|
|
|
|
from homeassistant.components import unifi
|
|
|
|
from homeassistant.components.unifi.const import (
|
2019-07-31 12:25:30 -07:00
|
|
|
CONF_CONTROLLER,
|
|
|
|
CONF_SITE_ID,
|
|
|
|
UNIFI_CONFIG,
|
|
|
|
)
|
2019-07-14 21:57:09 +02:00
|
|
|
from homeassistant.const import (
|
2019-07-31 12:25:30 -07:00
|
|
|
CONF_HOST,
|
|
|
|
CONF_PASSWORD,
|
|
|
|
CONF_PORT,
|
|
|
|
CONF_USERNAME,
|
|
|
|
CONF_VERIFY_SSL,
|
2019-08-02 10:13:00 +02:00
|
|
|
STATE_UNAVAILABLE,
|
2019-07-31 12:25:30 -07:00
|
|
|
)
|
2019-07-29 23:13:04 +02:00
|
|
|
from homeassistant.helpers import entity_registry
|
2019-07-14 21:57:09 +02:00
|
|
|
from homeassistant.setup import async_setup_component
|
|
|
|
|
|
|
|
import homeassistant.components.device_tracker as device_tracker
|
|
|
|
import homeassistant.components.unifi.device_tracker as unifi_dt
|
|
|
|
import homeassistant.util.dt as dt_util
|
2019-06-02 18:24:13 +02:00
|
|
|
|
2017-10-13 04:13:58 -04:00
|
|
|
DEFAULT_DETECTION_TIME = timedelta(seconds=300)
|
2016-02-19 15:19:03 -08:00
|
|
|
|
2019-07-14 21:57:09 +02:00
|
|
|
CLIENT_1 = {
|
2019-07-31 12:25:30 -07:00
|
|
|
"essid": "ssid",
|
|
|
|
"hostname": "client_1",
|
|
|
|
"ip": "10.0.0.1",
|
|
|
|
"is_wired": False,
|
|
|
|
"last_seen": 1562600145,
|
|
|
|
"mac": "00:00:00:00:00:01",
|
2019-07-14 21:57:09 +02:00
|
|
|
}
|
|
|
|
CLIENT_2 = {
|
2019-07-31 12:25:30 -07:00
|
|
|
"hostname": "client_2",
|
|
|
|
"ip": "10.0.0.2",
|
|
|
|
"is_wired": True,
|
|
|
|
"last_seen": 1562600145,
|
|
|
|
"mac": "00:00:00:00:00:02",
|
|
|
|
"name": "Wired Client",
|
2019-07-14 21:57:09 +02:00
|
|
|
}
|
|
|
|
CLIENT_3 = {
|
2019-07-31 12:25:30 -07:00
|
|
|
"essid": "ssid2",
|
|
|
|
"hostname": "client_3",
|
|
|
|
"ip": "10.0.0.3",
|
|
|
|
"is_wired": False,
|
|
|
|
"last_seen": 1562600145,
|
|
|
|
"mac": "00:00:00:00:00:03",
|
2019-07-14 21:57:09 +02:00
|
|
|
}
|
|
|
|
|
2019-07-30 10:05:51 +02:00
|
|
|
DEVICE_1 = {
|
2019-07-31 12:25:30 -07:00
|
|
|
"board_rev": 3,
|
|
|
|
"device_id": "mock-id",
|
|
|
|
"has_fan": True,
|
|
|
|
"fan_level": 0,
|
|
|
|
"ip": "10.0.1.1",
|
|
|
|
"last_seen": 1562600145,
|
|
|
|
"mac": "00:00:00:00:01:01",
|
|
|
|
"model": "US16P150",
|
|
|
|
"name": "device_1",
|
|
|
|
"overheating": False,
|
2019-08-11 22:40:44 +02:00
|
|
|
"state": 1,
|
2019-07-31 12:25:30 -07:00
|
|
|
"type": "usw",
|
|
|
|
"upgradable": False,
|
|
|
|
"version": "4.0.42.10433",
|
2019-07-30 10:05:51 +02:00
|
|
|
}
|
2019-08-06 23:55:36 +02:00
|
|
|
DEVICE_2 = {
|
|
|
|
"board_rev": 3,
|
|
|
|
"device_id": "mock-id",
|
|
|
|
"has_fan": True,
|
|
|
|
"ip": "10.0.1.1",
|
|
|
|
"mac": "00:00:00:00:01:01",
|
|
|
|
"model": "US16P150",
|
|
|
|
"name": "device_1",
|
2019-08-11 22:40:44 +02:00
|
|
|
"state": 0,
|
2019-08-06 23:55:36 +02:00
|
|
|
"type": "usw",
|
|
|
|
"version": "4.0.42.10433",
|
|
|
|
}
|
2019-07-30 10:05:51 +02:00
|
|
|
|
2019-07-14 21:57:09 +02:00
|
|
|
CONTROLLER_DATA = {
|
2019-07-31 12:25:30 -07:00
|
|
|
CONF_HOST: "mock-host",
|
|
|
|
CONF_USERNAME: "mock-user",
|
|
|
|
CONF_PASSWORD: "mock-pswd",
|
2019-07-14 21:57:09 +02:00
|
|
|
CONF_PORT: 1234,
|
2019-07-31 12:25:30 -07:00
|
|
|
CONF_SITE_ID: "mock-site",
|
|
|
|
CONF_VERIFY_SSL: True,
|
2019-07-14 21:57:09 +02:00
|
|
|
}
|
|
|
|
|
2019-07-31 12:25:30 -07:00
|
|
|
ENTRY_CONFIG = {CONF_CONTROLLER: CONTROLLER_DATA}
|
2019-07-14 21:57:09 +02:00
|
|
|
|
2019-07-31 12:25:30 -07:00
|
|
|
CONTROLLER_ID = unifi.CONTROLLER_ID.format(host="mock-host", site="mock-site")
|
2016-03-09 10:25:50 +01:00
|
|
|
|
2016-12-04 01:11:52 -05:00
|
|
|
|
2017-05-13 21:25:54 -07:00
|
|
|
@pytest.fixture
|
2019-07-14 21:57:09 +02:00
|
|
|
def mock_controller(hass):
|
|
|
|
"""Mock a UniFi Controller."""
|
|
|
|
hass.data[UNIFI_CONFIG] = {}
|
|
|
|
controller = unifi.UniFiController(hass, None)
|
|
|
|
|
|
|
|
controller.api = Mock()
|
|
|
|
controller.mock_requests = []
|
|
|
|
|
|
|
|
controller.mock_client_responses = deque()
|
|
|
|
controller.mock_device_responses = deque()
|
2019-07-29 23:13:04 +02:00
|
|
|
controller.mock_client_all_responses = deque()
|
2019-07-14 21:57:09 +02:00
|
|
|
|
|
|
|
async def mock_request(method, path, **kwargs):
|
2019-07-31 12:25:30 -07:00
|
|
|
kwargs["method"] = method
|
|
|
|
kwargs["path"] = path
|
2019-07-14 21:57:09 +02:00
|
|
|
controller.mock_requests.append(kwargs)
|
2019-07-31 12:25:30 -07:00
|
|
|
if path == "s/{site}/stat/sta":
|
2019-07-14 21:57:09 +02:00
|
|
|
return controller.mock_client_responses.popleft()
|
2019-07-31 12:25:30 -07:00
|
|
|
if path == "s/{site}/stat/device":
|
2019-07-14 21:57:09 +02:00
|
|
|
return controller.mock_device_responses.popleft()
|
2019-07-31 12:25:30 -07:00
|
|
|
if path == "s/{site}/rest/user":
|
2019-07-29 23:13:04 +02:00
|
|
|
return controller.mock_client_all_responses.popleft()
|
2019-07-14 21:57:09 +02:00
|
|
|
return None
|
|
|
|
|
|
|
|
controller.api.clients = Clients({}, mock_request)
|
|
|
|
controller.api.devices = Devices({}, mock_request)
|
2019-07-29 23:13:04 +02:00
|
|
|
controller.api.clients_all = ClientsAll({}, mock_request)
|
2019-07-14 21:57:09 +02:00
|
|
|
|
|
|
|
return controller
|
|
|
|
|
|
|
|
|
|
|
|
async def setup_controller(hass, mock_controller):
|
|
|
|
"""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(
|
2019-07-31 12:25:30 -07:00
|
|
|
1,
|
|
|
|
unifi.DOMAIN,
|
|
|
|
"Mock Title",
|
|
|
|
ENTRY_CONFIG,
|
|
|
|
"test",
|
|
|
|
config_entries.CONN_CLASS_LOCAL_POLL,
|
|
|
|
entry_id=1,
|
|
|
|
)
|
2019-07-14 21:57:09 +02:00
|
|
|
mock_controller.config_entry = config_entry
|
|
|
|
|
|
|
|
await mock_controller.async_update()
|
|
|
|
await hass.config_entries.async_forward_entry_setup(
|
2019-07-31 12:25:30 -07:00
|
|
|
config_entry, device_tracker.DOMAIN
|
|
|
|
)
|
2019-07-14 21:57:09 +02:00
|
|
|
|
|
|
|
await hass.async_block_till_done()
|
|
|
|
|
|
|
|
|
|
|
|
async def test_platform_manually_configured(hass):
|
|
|
|
"""Test that we do not discover anything or try to set up a bridge."""
|
2019-07-31 12:25:30 -07:00
|
|
|
assert (
|
|
|
|
await async_setup_component(
|
|
|
|
hass, device_tracker.DOMAIN, {device_tracker.DOMAIN: {"platform": "unifi"}}
|
|
|
|
)
|
|
|
|
is True
|
|
|
|
)
|
2019-07-14 21:57:09 +02:00
|
|
|
assert unifi.DOMAIN not in hass.data
|
|
|
|
|
|
|
|
|
|
|
|
async def test_no_clients(hass, mock_controller):
|
|
|
|
"""Test the update_clients function when no clients are found."""
|
|
|
|
mock_controller.mock_client_responses.append({})
|
|
|
|
mock_controller.mock_device_responses.append({})
|
2019-07-25 16:56:56 +02:00
|
|
|
|
2019-07-14 21:57:09 +02:00
|
|
|
await setup_controller(hass, mock_controller)
|
|
|
|
assert len(mock_controller.mock_requests) == 2
|
|
|
|
assert len(hass.states.async_all()) == 2
|
|
|
|
|
|
|
|
|
|
|
|
async def test_tracked_devices(hass, mock_controller):
|
|
|
|
"""Test the update_items function with some clients."""
|
2019-07-31 12:25:30 -07:00
|
|
|
mock_controller.mock_client_responses.append([CLIENT_1, CLIENT_2, CLIENT_3])
|
2019-08-06 23:55:36 +02:00
|
|
|
mock_controller.mock_device_responses.append([DEVICE_1, DEVICE_2])
|
2019-07-31 12:25:30 -07:00
|
|
|
mock_controller.unifi_config = {unifi_dt.CONF_SSID_FILTER: ["ssid"]}
|
2019-07-14 21:57:09 +02:00
|
|
|
|
|
|
|
await setup_controller(hass, mock_controller)
|
|
|
|
assert len(mock_controller.mock_requests) == 2
|
2019-07-30 10:05:51 +02:00
|
|
|
assert len(hass.states.async_all()) == 5
|
2019-07-14 21:57:09 +02:00
|
|
|
|
2019-07-31 12:25:30 -07:00
|
|
|
client_1 = hass.states.get("device_tracker.client_1")
|
2019-07-30 10:05:51 +02:00
|
|
|
assert client_1 is not None
|
2019-07-31 12:25:30 -07:00
|
|
|
assert client_1.state == "not_home"
|
2019-07-14 21:57:09 +02:00
|
|
|
|
2019-07-31 12:25:30 -07:00
|
|
|
client_2 = hass.states.get("device_tracker.wired_client")
|
2019-07-30 10:05:51 +02:00
|
|
|
assert client_2 is not None
|
2019-07-31 12:25:30 -07:00
|
|
|
assert client_2.state == "not_home"
|
2019-07-14 21:57:09 +02:00
|
|
|
|
2019-07-31 12:25:30 -07:00
|
|
|
client_3 = hass.states.get("device_tracker.client_3")
|
2019-07-30 10:05:51 +02:00
|
|
|
assert client_3 is None
|
2019-07-14 21:57:09 +02:00
|
|
|
|
2019-07-31 12:25:30 -07:00
|
|
|
device_1 = hass.states.get("device_tracker.device_1")
|
2019-07-30 10:05:51 +02:00
|
|
|
assert device_1 is not None
|
2019-07-31 12:25:30 -07:00
|
|
|
assert device_1.state == "not_home"
|
2019-07-30 10:05:51 +02:00
|
|
|
|
|
|
|
client_1_copy = copy(CLIENT_1)
|
2019-07-31 12:25:30 -07:00
|
|
|
client_1_copy["last_seen"] = dt_util.as_timestamp(dt_util.utcnow())
|
2019-07-30 10:05:51 +02:00
|
|
|
device_1_copy = copy(DEVICE_1)
|
2019-07-31 12:25:30 -07:00
|
|
|
device_1_copy["last_seen"] = dt_util.as_timestamp(dt_util.utcnow())
|
2019-07-30 10:05:51 +02:00
|
|
|
mock_controller.mock_client_responses.append([client_1_copy])
|
|
|
|
mock_controller.mock_device_responses.append([device_1_copy])
|
2019-07-14 21:57:09 +02:00
|
|
|
await mock_controller.async_update()
|
|
|
|
await hass.async_block_till_done()
|
|
|
|
|
2019-07-31 12:25:30 -07:00
|
|
|
client_1 = hass.states.get("device_tracker.client_1")
|
|
|
|
assert client_1.state == "home"
|
2019-07-30 10:05:51 +02:00
|
|
|
|
2019-07-31 12:25:30 -07:00
|
|
|
device_1 = hass.states.get("device_tracker.device_1")
|
|
|
|
assert device_1.state == "home"
|
2019-07-29 23:13:04 +02:00
|
|
|
|
2019-08-01 17:22:08 +02:00
|
|
|
device_1_copy = copy(DEVICE_1)
|
|
|
|
device_1_copy["disabled"] = True
|
|
|
|
mock_controller.mock_client_responses.append({})
|
|
|
|
mock_controller.mock_device_responses.append([device_1_copy])
|
|
|
|
await mock_controller.async_update()
|
|
|
|
await hass.async_block_till_done()
|
|
|
|
|
|
|
|
device_1 = hass.states.get("device_tracker.device_1")
|
2019-08-02 10:13:00 +02:00
|
|
|
assert device_1.state == STATE_UNAVAILABLE
|
2019-08-01 17:22:08 +02:00
|
|
|
|
2019-07-29 23:13:04 +02:00
|
|
|
|
|
|
|
async def test_restoring_client(hass, mock_controller):
|
|
|
|
"""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])
|
2019-07-31 12:25:30 -07:00
|
|
|
mock_controller.unifi_config = {unifi.CONF_BLOCK_CLIENT: True}
|
2019-07-29 23:13:04 +02:00
|
|
|
|
|
|
|
registry = await entity_registry.async_get_registry(hass)
|
|
|
|
registry.async_get_or_create(
|
2019-07-31 12:25:30 -07:00
|
|
|
device_tracker.DOMAIN,
|
|
|
|
unifi_dt.UNIFI_DOMAIN,
|
|
|
|
"{}-mock-site".format(CLIENT_1["mac"]),
|
|
|
|
suggested_object_id=CLIENT_1["hostname"],
|
|
|
|
config_entry_id=1,
|
|
|
|
)
|
2019-07-29 23:13:04 +02:00
|
|
|
registry.async_get_or_create(
|
2019-07-31 12:25:30 -07:00
|
|
|
device_tracker.DOMAIN,
|
|
|
|
unifi_dt.UNIFI_DOMAIN,
|
|
|
|
"{}-mock-site".format(CLIENT_2["mac"]),
|
|
|
|
suggested_object_id=CLIENT_2["hostname"],
|
|
|
|
config_entry_id=1,
|
|
|
|
)
|
2019-07-29 23:13:04 +02:00
|
|
|
|
|
|
|
await setup_controller(hass, mock_controller)
|
|
|
|
assert len(mock_controller.mock_requests) == 3
|
|
|
|
assert len(hass.states.async_all()) == 4
|
|
|
|
|
2019-07-31 12:25:30 -07:00
|
|
|
device_1 = hass.states.get("device_tracker.client_1")
|
2019-07-29 23:13:04 +02:00
|
|
|
assert device_1 is not None
|
2019-08-02 10:13:00 +02:00
|
|
|
|
|
|
|
|
|
|
|
async def test_dont_track_clients(hass, mock_controller):
|
|
|
|
"""Test dont track clients config works."""
|
|
|
|
mock_controller.mock_client_responses.append([CLIENT_1])
|
|
|
|
mock_controller.mock_device_responses.append([DEVICE_1])
|
|
|
|
mock_controller.unifi_config = {unifi.CONF_DONT_TRACK_CLIENTS: True}
|
|
|
|
|
|
|
|
await setup_controller(hass, mock_controller)
|
|
|
|
assert len(mock_controller.mock_requests) == 2
|
|
|
|
assert len(hass.states.async_all()) == 3
|
|
|
|
|
|
|
|
client_1 = hass.states.get("device_tracker.client_1")
|
|
|
|
assert client_1 is None
|
|
|
|
|
|
|
|
device_1 = hass.states.get("device_tracker.device_1")
|
|
|
|
assert device_1 is not None
|
|
|
|
assert device_1.state == "not_home"
|
|
|
|
|
|
|
|
|
|
|
|
async def test_dont_track_devices(hass, mock_controller):
|
|
|
|
"""Test dont track devices config works."""
|
|
|
|
mock_controller.mock_client_responses.append([CLIENT_1])
|
|
|
|
mock_controller.mock_device_responses.append([DEVICE_1])
|
|
|
|
mock_controller.unifi_config = {unifi.CONF_DONT_TRACK_DEVICES: True}
|
|
|
|
|
|
|
|
await setup_controller(hass, mock_controller)
|
|
|
|
assert len(mock_controller.mock_requests) == 2
|
|
|
|
assert len(hass.states.async_all()) == 3
|
|
|
|
|
|
|
|
client_1 = hass.states.get("device_tracker.client_1")
|
|
|
|
assert client_1 is not None
|
|
|
|
assert client_1.state == "not_home"
|
|
|
|
|
|
|
|
device_1 = hass.states.get("device_tracker.device_1")
|
|
|
|
assert device_1 is None
|
2019-08-02 23:51:06 +02:00
|
|
|
|
|
|
|
|
|
|
|
async def test_dont_track_wired_clients(hass, mock_controller):
|
|
|
|
"""Test dont track wired clients config works."""
|
|
|
|
mock_controller.mock_client_responses.append([CLIENT_1, CLIENT_2])
|
|
|
|
mock_controller.mock_device_responses.append({})
|
|
|
|
mock_controller.unifi_config = {unifi.CONF_DONT_TRACK_WIRED_CLIENTS: True}
|
|
|
|
|
|
|
|
await setup_controller(hass, mock_controller)
|
|
|
|
assert len(mock_controller.mock_requests) == 2
|
|
|
|
assert len(hass.states.async_all()) == 3
|
|
|
|
|
|
|
|
client_1 = hass.states.get("device_tracker.client_1")
|
|
|
|
assert client_1 is not None
|
|
|
|
assert client_1.state == "not_home"
|
|
|
|
|
|
|
|
client_2 = hass.states.get("device_tracker.client_2")
|
|
|
|
assert client_2 is None
|