Merge UniFi device tracker to config entry (#24367)
* Move device tracker to use config entry * Remove monitored conditions attributes based on ADR0003 * Add support for import of device tracker config to be backwards compatible * Remove unnecessary configuration options from device tracker * Add component configuration support
This commit is contained in:
1 parent
3480e6229a
commit
01b890f426
11 files changed
+493
-449
No files matched your search
@@ -1,267 +1,160 @@
|
||||
"""The tests for the Unifi WAP device tracker platform."""
|
||||
from unittest import mock
|
||||
from datetime import datetime, timedelta
|
||||
from collections import deque
|
||||
from copy import copy
|
||||
from unittest.mock import Mock
|
||||
from datetime import timedelta
|
||||
|
||||
import pytest
|
||||
import voluptuous as vol
|
||||
|
||||
import homeassistant.util.dt as dt_util
|
||||
from homeassistant.components.device_tracker import DOMAIN
|
||||
import homeassistant.components.unifi.device_tracker as unifi
|
||||
from homeassistant.const import (CONF_HOST, CONF_USERNAME, CONF_PASSWORD,
|
||||
CONF_PLATFORM, CONF_VERIFY_SSL,
|
||||
CONF_MONITORED_CONDITIONS)
|
||||
|
||||
from tests.common import mock_coro
|
||||
from asynctest import CoroutineMock
|
||||
from aiounifi.clients import Clients
|
||||
from aiounifi.devices import Devices
|
||||
|
||||
from homeassistant import config_entries
|
||||
from homeassistant.components import unifi
|
||||
from homeassistant.components.unifi.const import (
|
||||
CONF_CONTROLLER, CONF_SITE_ID, UNIFI_CONFIG)
|
||||
from homeassistant.const import (
|
||||
CONF_HOST, CONF_PASSWORD, CONF_PORT, CONF_USERNAME, CONF_VERIFY_SSL)
|
||||
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
|
||||
|
||||
DEFAULT_DETECTION_TIME = timedelta(seconds=300)
|
||||
|
||||
CLIENT_1 = {
|
||||
'essid': 'ssid',
|
||||
'hostname': 'client_1',
|
||||
'ip': '10.0.0.1',
|
||||
'is_wired': False,
|
||||
'last_seen': 1562600145,
|
||||
'mac': '00:00:00:00:00:01',
|
||||
}
|
||||
CLIENT_2 = {
|
||||
'hostname': 'client_2',
|
||||
'ip': '10.0.0.2',
|
||||
'is_wired': True,
|
||||
'last_seen': 1562600145,
|
||||
'mac': '00:00:00:00:00:02',
|
||||
'name': 'Wired Client',
|
||||
}
|
||||
CLIENT_3 = {
|
||||
'essid': 'ssid2',
|
||||
'hostname': 'client_3',
|
||||
'ip': '10.0.0.3',
|
||||
'is_wired': False,
|
||||
'last_seen': 1562600145,
|
||||
'mac': '00:00:00:00:00:03',
|
||||
}
|
||||
|
||||
@pytest.fixture
|
||||
def mock_ctrl():
|
||||
"""Mock pyunifi."""
|
||||
with mock.patch('aiounifi.Controller') as mock_control:
|
||||
mock_control.return_value.login.return_value = mock_coro()
|
||||
mock_control.return_value.initialize.return_value = mock_coro()
|
||||
yield mock_control
|
||||
CONTROLLER_DATA = {
|
||||
CONF_HOST: 'mock-host',
|
||||
CONF_USERNAME: 'mock-user',
|
||||
CONF_PASSWORD: 'mock-pswd',
|
||||
CONF_PORT: 1234,
|
||||
CONF_SITE_ID: 'mock-site',
|
||||
CONF_VERIFY_SSL: True
|
||||
}
|
||||
|
||||
ENTRY_CONFIG = {
|
||||
CONF_CONTROLLER: CONTROLLER_DATA
|
||||
}
|
||||
|
||||
CONTROLLER_ID = unifi.CONTROLLER_ID.format(host='mock-host', site='mock-site')
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def mock_scanner():
|
||||
"""Mock UnifyScanner."""
|
||||
with mock.patch('homeassistant.components.unifi.device_tracker'
|
||||
'.UnifiScanner') as scanner:
|
||||
yield scanner
|
||||
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()
|
||||
|
||||
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()
|
||||
return None
|
||||
|
||||
controller.api.clients = Clients({}, mock_request)
|
||||
controller.api.devices = Devices({}, mock_request)
|
||||
|
||||
return controller
|
||||
|
||||
|
||||
@mock.patch('os.access', return_value=True)
|
||||
@mock.patch('os.path.isfile', mock.Mock(return_value=True))
|
||||
async def test_config_valid_verify_ssl(hass, mock_scanner, mock_ctrl):
|
||||
"""Test the setup with a string for ssl_verify.
|
||||
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(
|
||||
1, unifi.DOMAIN, 'Mock Title', ENTRY_CONFIG, 'test',
|
||||
config_entries.CONN_CLASS_LOCAL_POLL)
|
||||
mock_controller.config_entry = config_entry
|
||||
|
||||
Representing the absolute path to a CA certificate bundle.
|
||||
"""
|
||||
config = {
|
||||
DOMAIN: unifi.PLATFORM_SCHEMA({
|
||||
CONF_PLATFORM: unifi.DOMAIN,
|
||||
CONF_USERNAME: 'foo',
|
||||
CONF_PASSWORD: 'password',
|
||||
CONF_VERIFY_SSL: "/tmp/unifi.crt"
|
||||
})
|
||||
}
|
||||
result = await unifi.async_get_scanner(hass, config)
|
||||
assert mock_scanner.return_value == result
|
||||
assert mock_ctrl.call_count == 1
|
||||
await mock_controller.async_update()
|
||||
await hass.config_entries.async_forward_entry_setup(
|
||||
config_entry, device_tracker.DOMAIN)
|
||||
|
||||
assert mock_scanner.call_count == 1
|
||||
assert mock_scanner.call_args == mock.call(mock_ctrl.return_value,
|
||||
DEFAULT_DETECTION_TIME,
|
||||
None, None)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
|
||||
async def test_config_minimal(hass, mock_scanner, mock_ctrl):
|
||||
"""Test the setup with minimal configuration."""
|
||||
config = {
|
||||
DOMAIN: unifi.PLATFORM_SCHEMA({
|
||||
CONF_PLATFORM: unifi.DOMAIN,
|
||||
CONF_USERNAME: 'foo',
|
||||
CONF_PASSWORD: 'password',
|
||||
})
|
||||
}
|
||||
|
||||
result = await unifi.async_get_scanner(hass, config)
|
||||
assert mock_scanner.return_value == result
|
||||
assert mock_ctrl.call_count == 1
|
||||
|
||||
assert mock_scanner.call_count == 1
|
||||
assert mock_scanner.call_args == mock.call(mock_ctrl.return_value,
|
||||
DEFAULT_DETECTION_TIME,
|
||||
None, None)
|
||||
|
||||
|
||||
async def test_config_full(hass, mock_scanner, mock_ctrl):
|
||||
"""Test the setup with full configuration."""
|
||||
config = {
|
||||
DOMAIN: unifi.PLATFORM_SCHEMA({
|
||||
CONF_PLATFORM: unifi.DOMAIN,
|
||||
CONF_USERNAME: 'foo',
|
||||
CONF_PASSWORD: 'password',
|
||||
CONF_HOST: 'myhost',
|
||||
CONF_VERIFY_SSL: False,
|
||||
CONF_MONITORED_CONDITIONS: ['essid', 'signal'],
|
||||
'port': 123,
|
||||
'site_id': 'abcdef01',
|
||||
'detection_time': 300,
|
||||
})
|
||||
}
|
||||
result = await unifi.async_get_scanner(hass, config)
|
||||
assert mock_scanner.return_value == result
|
||||
assert mock_ctrl.call_count == 1
|
||||
|
||||
assert mock_scanner.call_count == 1
|
||||
assert mock_scanner.call_args == mock.call(
|
||||
mock_ctrl.return_value,
|
||||
DEFAULT_DETECTION_TIME,
|
||||
None,
|
||||
config[DOMAIN][CONF_MONITORED_CONDITIONS])
|
||||
|
||||
|
||||
def test_config_error():
|
||||
"""Test for configuration errors."""
|
||||
with pytest.raises(vol.Invalid):
|
||||
unifi.PLATFORM_SCHEMA({
|
||||
# no username
|
||||
CONF_PLATFORM: unifi.DOMAIN,
|
||||
CONF_HOST: 'myhost',
|
||||
'port': 123,
|
||||
})
|
||||
with pytest.raises(vol.Invalid):
|
||||
unifi.PLATFORM_SCHEMA({
|
||||
CONF_PLATFORM: unifi.DOMAIN,
|
||||
CONF_USERNAME: 'foo',
|
||||
CONF_PASSWORD: 'password',
|
||||
CONF_HOST: 'myhost',
|
||||
'port': 'foo', # bad port!
|
||||
})
|
||||
with pytest.raises(vol.Invalid):
|
||||
unifi.PLATFORM_SCHEMA({
|
||||
CONF_PLATFORM: unifi.DOMAIN,
|
||||
CONF_USERNAME: 'foo',
|
||||
CONF_PASSWORD: 'password',
|
||||
CONF_VERIFY_SSL: "dfdsfsdfsd", # Invalid ssl_verify (no file)
|
||||
})
|
||||
|
||||
|
||||
async def test_config_controller_failed(hass, mock_ctrl, mock_scanner):
|
||||
"""Test for controller failure."""
|
||||
config = {
|
||||
'device_tracker': {
|
||||
CONF_PLATFORM: unifi.DOMAIN,
|
||||
CONF_USERNAME: 'foo',
|
||||
CONF_PASSWORD: 'password',
|
||||
async def test_platform_manually_configured(hass):
|
||||
"""Test that we do not discover anything or try to set up a bridge."""
|
||||
assert await async_setup_component(hass, device_tracker.DOMAIN, {
|
||||
device_tracker.DOMAIN: {
|
||||
'platform': 'unifi'
|
||||
}
|
||||
}
|
||||
mock_ctrl.side_effect = unifi.CannotConnect
|
||||
result = await unifi.async_get_scanner(hass, config)
|
||||
assert result is False
|
||||
}) is True
|
||||
assert unifi.DOMAIN not in hass.data
|
||||
|
||||
|
||||
async def test_scanner_update():
|
||||
"""Test the scanner update."""
|
||||
ctrl = mock.MagicMock()
|
||||
fake_clients = [
|
||||
{'mac': '123', 'essid': 'barnet',
|
||||
'last_seen': dt_util.as_timestamp(dt_util.utcnow())},
|
||||
{'mac': '234', 'essid': 'barnet',
|
||||
'last_seen': dt_util.as_timestamp(dt_util.utcnow())},
|
||||
]
|
||||
ctrl.clients = Clients([], CoroutineMock(return_value=fake_clients))
|
||||
scnr = unifi.UnifiScanner(ctrl, DEFAULT_DETECTION_TIME, None, None)
|
||||
await scnr.async_update()
|
||||
assert len(scnr._clients) == 2
|
||||
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({})
|
||||
await setup_controller(hass, mock_controller)
|
||||
assert len(mock_controller.mock_requests) == 2
|
||||
assert len(hass.states.async_all()) == 2
|
||||
|
||||
|
||||
def test_scanner_update_error():
|
||||
"""Test the scanner update for error."""
|
||||
ctrl = mock.MagicMock()
|
||||
ctrl.get_clients.side_effect = unifi.aiounifi.AiounifiException
|
||||
unifi.UnifiScanner(ctrl, DEFAULT_DETECTION_TIME, None, None)
|
||||
async def test_tracked_devices(hass, mock_controller):
|
||||
"""Test the update_items function with some clients."""
|
||||
mock_controller.mock_client_responses.append(
|
||||
[CLIENT_1, CLIENT_2, CLIENT_3])
|
||||
mock_controller.mock_device_responses.append({})
|
||||
mock_controller.unifi_config = {unifi_dt.CONF_SSID_FILTER: ['ssid']}
|
||||
|
||||
await setup_controller(hass, mock_controller)
|
||||
assert len(mock_controller.mock_requests) == 2
|
||||
assert len(hass.states.async_all()) == 4
|
||||
|
||||
async def test_scan_devices():
|
||||
"""Test the scanning for devices."""
|
||||
ctrl = mock.MagicMock()
|
||||
fake_clients = [
|
||||
{'mac': '123', 'essid': 'barnet',
|
||||
'last_seen': dt_util.as_timestamp(dt_util.utcnow())},
|
||||
{'mac': '234', 'essid': 'barnet',
|
||||
'last_seen': dt_util.as_timestamp(dt_util.utcnow())},
|
||||
]
|
||||
ctrl.clients = Clients([], CoroutineMock(return_value=fake_clients))
|
||||
scnr = unifi.UnifiScanner(ctrl, DEFAULT_DETECTION_TIME, None, None)
|
||||
await scnr.async_update()
|
||||
assert set(await scnr.async_scan_devices()) == set(['123', '234'])
|
||||
device_1 = hass.states.get('device_tracker.client_1')
|
||||
assert device_1 is not None
|
||||
assert device_1.state == 'not_home'
|
||||
|
||||
device_2 = hass.states.get('device_tracker.wired_client')
|
||||
assert device_2 is not None
|
||||
assert device_2.state == 'not_home'
|
||||
|
||||
async def test_scan_devices_filtered():
|
||||
"""Test the scanning for devices based on SSID."""
|
||||
ctrl = mock.MagicMock()
|
||||
fake_clients = [
|
||||
{'mac': '123', 'essid': 'foonet',
|
||||
'last_seen': dt_util.as_timestamp(dt_util.utcnow())},
|
||||
{'mac': '234', 'essid': 'foonet',
|
||||
'last_seen': dt_util.as_timestamp(dt_util.utcnow())},
|
||||
{'mac': '567', 'essid': 'notnet',
|
||||
'last_seen': dt_util.as_timestamp(dt_util.utcnow())},
|
||||
{'mac': '890', 'essid': 'barnet',
|
||||
'last_seen': dt_util.as_timestamp(dt_util.utcnow())},
|
||||
]
|
||||
device_3 = hass.states.get('device_tracker.client_3')
|
||||
assert device_3 is None
|
||||
|
||||
ssid_filter = ['foonet', 'barnet']
|
||||
ctrl.clients = Clients([], CoroutineMock(return_value=fake_clients))
|
||||
scnr = unifi.UnifiScanner(ctrl, DEFAULT_DETECTION_TIME, ssid_filter, None)
|
||||
await scnr.async_update()
|
||||
assert set(await scnr.async_scan_devices()) == set(['123', '234', '890'])
|
||||
client_1 = copy(CLIENT_1)
|
||||
client_1['last_seen'] = dt_util.as_timestamp(dt_util.utcnow())
|
||||
mock_controller.mock_client_responses.append([client_1])
|
||||
mock_controller.mock_device_responses.append({})
|
||||
await mock_controller.async_update()
|
||||
await hass.async_block_till_done()
|
||||
|
||||
|
||||
async def test_get_device_name():
|
||||
"""Test the getting of device names."""
|
||||
ctrl = mock.MagicMock()
|
||||
fake_clients = [
|
||||
{'mac': '123',
|
||||
'hostname': 'foobar',
|
||||
'essid': 'barnet',
|
||||
'last_seen': dt_util.as_timestamp(dt_util.utcnow())},
|
||||
{'mac': '234',
|
||||
'name': 'Nice Name',
|
||||
'essid': 'barnet',
|
||||
'last_seen': dt_util.as_timestamp(dt_util.utcnow())},
|
||||
{'mac': '456',
|
||||
'essid': 'barnet',
|
||||
'last_seen': '1504786810'},
|
||||
]
|
||||
ctrl.clients = Clients([], CoroutineMock(return_value=fake_clients))
|
||||
scnr = unifi.UnifiScanner(ctrl, DEFAULT_DETECTION_TIME, None, None)
|
||||
await scnr.async_update()
|
||||
assert scnr.get_device_name('123') == 'foobar'
|
||||
assert scnr.get_device_name('234') == 'Nice Name'
|
||||
assert scnr.get_device_name('456') is None
|
||||
assert scnr.get_device_name('unknown') is None
|
||||
|
||||
|
||||
async def test_monitored_conditions():
|
||||
"""Test the filtering of attributes."""
|
||||
ctrl = mock.MagicMock()
|
||||
fake_clients = [
|
||||
{'mac': '123',
|
||||
'hostname': 'foobar',
|
||||
'essid': 'barnet',
|
||||
'signal': -60,
|
||||
'last_seen': dt_util.as_timestamp(dt_util.utcnow()),
|
||||
'latest_assoc_time': 946684800.0},
|
||||
{'mac': '234',
|
||||
'name': 'Nice Name',
|
||||
'essid': 'barnet',
|
||||
'signal': -42,
|
||||
'last_seen': dt_util.as_timestamp(dt_util.utcnow())},
|
||||
{'mac': '456',
|
||||
'hostname': 'wired',
|
||||
'essid': 'barnet',
|
||||
'last_seen': dt_util.as_timestamp(dt_util.utcnow())},
|
||||
]
|
||||
ctrl.clients = Clients([], CoroutineMock(return_value=fake_clients))
|
||||
scnr = unifi.UnifiScanner(ctrl, DEFAULT_DETECTION_TIME, None,
|
||||
['essid', 'signal', 'latest_assoc_time'])
|
||||
await scnr.async_update()
|
||||
assert scnr.get_extra_attributes('123') == {
|
||||
'essid': 'barnet',
|
||||
'signal': -60,
|
||||
'latest_assoc_time': datetime(2000, 1, 1, 0, 0, tzinfo=dt_util.UTC)
|
||||
}
|
||||
assert scnr.get_extra_attributes('234') == {
|
||||
'essid': 'barnet',
|
||||
'signal': -42
|
||||
}
|
||||
assert scnr.get_extra_attributes('456') == {'essid': 'barnet'}
|
||||
device_1 = hass.states.get('device_tracker.client_1')
|
||||
assert device_1.state == 'home'
|
||||
Reference in new issue
Block a user