2019-01-27 11:34:49 +00:00
|
|
|
"""Code to support homekit_controller tests."""
|
2019-03-19 07:58:56 +00:00
|
|
|
import json
|
2019-01-27 11:34:49 +00:00
|
|
|
from datetime import timedelta
|
|
|
|
from unittest import mock
|
|
|
|
|
2019-01-28 12:20:32 +00:00
|
|
|
from homekit.model.services import AbstractService, ServicesTypes
|
|
|
|
from homekit.model.characteristics import (
|
|
|
|
AbstractCharacteristic, CharacteristicPermissions, CharacteristicsTypes)
|
|
|
|
from homekit.model import Accessory, get_id
|
2019-03-13 01:45:34 +00:00
|
|
|
from homekit.exceptions import AccessoryNotFoundError
|
2019-01-27 11:34:49 +00:00
|
|
|
from homeassistant.components.homekit_controller import (
|
2019-01-28 16:21:20 +00:00
|
|
|
DOMAIN, HOMEKIT_ACCESSORY_DISPATCH, SERVICE_HOMEKIT)
|
2019-01-27 11:34:49 +00:00
|
|
|
from homeassistant.setup import async_setup_component
|
|
|
|
import homeassistant.util.dt as dt_util
|
|
|
|
from tests.common import async_fire_time_changed, fire_service_discovered
|
|
|
|
|
|
|
|
|
|
|
|
class FakePairing:
|
|
|
|
"""
|
|
|
|
A test fake that pretends to be a paired HomeKit accessory.
|
|
|
|
|
|
|
|
This only contains methods and values that exist on the upstream Pairing
|
|
|
|
class.
|
|
|
|
"""
|
|
|
|
|
2019-03-07 03:44:52 +00:00
|
|
|
def __init__(self, accessories):
|
2019-01-27 11:34:49 +00:00
|
|
|
"""Create a fake pairing from an accessory model."""
|
2019-03-07 03:44:52 +00:00
|
|
|
self.accessories = accessories
|
|
|
|
self.pairing_data = {}
|
2019-03-13 01:45:34 +00:00
|
|
|
self.available = True
|
2019-01-27 11:34:49 +00:00
|
|
|
|
|
|
|
def list_accessories_and_characteristics(self):
|
|
|
|
"""Fake implementation of list_accessories_and_characteristics."""
|
2019-03-07 03:44:52 +00:00
|
|
|
accessories = [
|
|
|
|
a.to_accessory_and_service_list() for a in self.accessories
|
|
|
|
]
|
|
|
|
# replicate what happens upstream right now
|
|
|
|
self.pairing_data['accessories'] = accessories
|
|
|
|
return accessories
|
2019-01-27 11:34:49 +00:00
|
|
|
|
|
|
|
def get_characteristics(self, characteristics):
|
|
|
|
"""Fake implementation of get_characteristics."""
|
2019-03-13 01:45:34 +00:00
|
|
|
if not self.available:
|
|
|
|
raise AccessoryNotFoundError('Accessory not found')
|
|
|
|
|
2019-01-27 11:34:49 +00:00
|
|
|
results = {}
|
|
|
|
for aid, cid in characteristics:
|
2019-03-07 03:44:52 +00:00
|
|
|
for accessory in self.accessories:
|
|
|
|
if aid != accessory.aid:
|
|
|
|
continue
|
|
|
|
for service in accessory.services:
|
|
|
|
for char in service.characteristics:
|
|
|
|
if char.iid != cid:
|
|
|
|
continue
|
|
|
|
results[(aid, cid)] = {
|
|
|
|
'value': char.get_value()
|
|
|
|
}
|
2019-01-27 11:34:49 +00:00
|
|
|
return results
|
|
|
|
|
|
|
|
def put_characteristics(self, characteristics):
|
|
|
|
"""Fake implementation of put_characteristics."""
|
2019-03-07 03:44:52 +00:00
|
|
|
for aid, cid, new_val in characteristics:
|
|
|
|
for accessory in self.accessories:
|
|
|
|
if aid != accessory.aid:
|
|
|
|
continue
|
|
|
|
for service in accessory.services:
|
|
|
|
for char in service.characteristics:
|
|
|
|
if char.iid != cid:
|
|
|
|
continue
|
|
|
|
char.set_value(new_val)
|
2019-01-27 11:34:49 +00:00
|
|
|
|
|
|
|
|
|
|
|
class FakeController:
|
|
|
|
"""
|
|
|
|
A test fake that pretends to be a paired HomeKit accessory.
|
|
|
|
|
|
|
|
This only contains methods and values that exist on the upstream Controller
|
|
|
|
class.
|
|
|
|
"""
|
|
|
|
|
|
|
|
def __init__(self):
|
|
|
|
"""Create a Fake controller with no pairings."""
|
|
|
|
self.pairings = {}
|
|
|
|
|
2019-03-07 03:44:52 +00:00
|
|
|
def add(self, accessories):
|
2019-01-27 11:34:49 +00:00
|
|
|
"""Create and register a fake pairing for a simulated accessory."""
|
2019-03-07 03:44:52 +00:00
|
|
|
pairing = FakePairing(accessories)
|
2019-01-27 11:34:49 +00:00
|
|
|
self.pairings['00:00:00:00:00:00'] = pairing
|
|
|
|
return pairing
|
|
|
|
|
|
|
|
|
|
|
|
class Helper:
|
|
|
|
"""Helper methods for interacting with HomeKit fakes."""
|
|
|
|
|
|
|
|
def __init__(self, hass, entity_id, pairing, accessory):
|
|
|
|
"""Create a helper for a given accessory/entity."""
|
|
|
|
self.hass = hass
|
|
|
|
self.entity_id = entity_id
|
|
|
|
self.pairing = pairing
|
|
|
|
self.accessory = accessory
|
|
|
|
|
|
|
|
self.characteristics = {}
|
|
|
|
for service in self.accessory.services:
|
|
|
|
service_name = ServicesTypes.get_short(service.type)
|
|
|
|
for char in service.characteristics:
|
|
|
|
char_name = CharacteristicsTypes.get_short(char.type)
|
|
|
|
self.characteristics[(service_name, char_name)] = char
|
|
|
|
|
|
|
|
async def poll_and_get_state(self):
|
|
|
|
"""Trigger a time based poll and return the current entity state."""
|
|
|
|
next_update = dt_util.utcnow() + timedelta(seconds=60)
|
|
|
|
async_fire_time_changed(self.hass, next_update)
|
|
|
|
await self.hass.async_block_till_done()
|
|
|
|
|
|
|
|
state = self.hass.states.get(self.entity_id)
|
|
|
|
assert state is not None
|
|
|
|
return state
|
|
|
|
|
|
|
|
|
2019-01-28 12:20:32 +00:00
|
|
|
class FakeCharacteristic(AbstractCharacteristic):
|
|
|
|
"""
|
|
|
|
A model of a generic HomeKit characteristic.
|
|
|
|
|
|
|
|
Base is abstract and can't be instanced directly so this subclass is
|
|
|
|
needed even though it doesn't add any methods.
|
|
|
|
"""
|
|
|
|
|
|
|
|
pass
|
|
|
|
|
|
|
|
|
|
|
|
class FakeService(AbstractService):
|
|
|
|
"""A model of a generic HomeKit service."""
|
|
|
|
|
|
|
|
def __init__(self, service_name):
|
|
|
|
"""Create a fake service by its short form HAP spec name."""
|
|
|
|
char_type = ServicesTypes.get_uuid(service_name)
|
|
|
|
super().__init__(char_type, get_id())
|
|
|
|
|
|
|
|
def add_characteristic(self, name):
|
|
|
|
"""Add a characteristic to this service by name."""
|
|
|
|
full_name = 'public.hap.characteristic.' + name
|
|
|
|
char = FakeCharacteristic(get_id(), full_name, None)
|
|
|
|
char.perms = [
|
|
|
|
CharacteristicPermissions.paired_read,
|
|
|
|
CharacteristicPermissions.paired_write
|
|
|
|
]
|
|
|
|
self.characteristics.append(char)
|
|
|
|
return char
|
|
|
|
|
|
|
|
|
2019-03-19 07:58:56 +00:00
|
|
|
def setup_accessories_from_file(path):
|
|
|
|
"""Load an collection of accessory defs from JSON data."""
|
|
|
|
with open(path, 'r') as accessories_data:
|
|
|
|
accessories_json = json.load(accessories_data)
|
|
|
|
|
|
|
|
accessories = []
|
|
|
|
|
|
|
|
for accessory_data in accessories_json:
|
|
|
|
accessory = Accessory('Name', 'Mfr', 'Model', '0001', '0.1')
|
|
|
|
accessory.services = []
|
|
|
|
accessory.aid = accessory_data['aid']
|
|
|
|
for service_data in accessory_data['services']:
|
|
|
|
service = FakeService('public.hap.service.accessory-information')
|
|
|
|
service.type = service_data['type']
|
|
|
|
service.iid = service_data['iid']
|
|
|
|
|
|
|
|
for char_data in service_data['characteristics']:
|
|
|
|
char = FakeCharacteristic(1, '23', None)
|
|
|
|
char.type = char_data['type']
|
|
|
|
char.iid = char_data['iid']
|
|
|
|
char.perms = char_data['perms']
|
|
|
|
char.format = char_data['format']
|
|
|
|
if 'description' in char_data:
|
|
|
|
char.description = char_data['description']
|
|
|
|
if 'value' in char_data:
|
|
|
|
char.value = char_data['value']
|
|
|
|
service.characteristics.append(char)
|
|
|
|
|
|
|
|
accessory.services.append(service)
|
|
|
|
|
|
|
|
accessories.append(accessory)
|
|
|
|
|
|
|
|
return accessories
|
|
|
|
|
|
|
|
|
2019-03-07 03:44:52 +00:00
|
|
|
async def setup_platform(hass):
|
|
|
|
"""Load the platform but with a fake Controller API."""
|
|
|
|
config = {
|
|
|
|
'discovery': {
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
with mock.patch('homekit.Controller') as controller:
|
|
|
|
fake_controller = controller.return_value = FakeController()
|
|
|
|
await async_setup_component(hass, DOMAIN, config)
|
|
|
|
|
|
|
|
return fake_controller
|
|
|
|
|
|
|
|
|
2019-03-19 07:58:56 +00:00
|
|
|
async def setup_test_accessories(hass, accessories, capitalize=False):
|
|
|
|
"""Load a fake homekit accessory based on a homekit accessory model.
|
|
|
|
|
|
|
|
If capitalize is True, property names will be in upper case.
|
|
|
|
"""
|
|
|
|
fake_controller = await setup_platform(hass)
|
|
|
|
pairing = fake_controller.add(accessories)
|
|
|
|
|
|
|
|
discovery_info = {
|
|
|
|
'host': '127.0.0.1',
|
|
|
|
'port': 8080,
|
|
|
|
'properties': {
|
|
|
|
('MD' if capitalize else 'md'): 'TestDevice',
|
|
|
|
('ID' if capitalize else 'id'): '00:00:00:00:00:00',
|
|
|
|
('C#' if capitalize else 'c#'): 1,
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
fire_service_discovered(hass, SERVICE_HOMEKIT, discovery_info)
|
|
|
|
await hass.async_block_till_done()
|
|
|
|
|
|
|
|
return pairing
|
|
|
|
|
|
|
|
|
2019-02-28 18:09:04 +00:00
|
|
|
async def setup_test_component(hass, services, capitalize=False, suffix=None):
|
2019-02-24 12:56:52 +00:00
|
|
|
"""Load a fake homekit accessory based on a homekit accessory model.
|
|
|
|
|
|
|
|
If capitalize is True, property names will be in upper case.
|
2019-02-28 18:09:04 +00:00
|
|
|
|
|
|
|
If suffix is set, entityId will include the suffix
|
2019-02-24 12:56:52 +00:00
|
|
|
"""
|
2019-01-27 11:34:49 +00:00
|
|
|
domain = None
|
|
|
|
for service in services:
|
|
|
|
service_name = ServicesTypes.get_short(service.type)
|
|
|
|
if service_name in HOMEKIT_ACCESSORY_DISPATCH:
|
|
|
|
domain = HOMEKIT_ACCESSORY_DISPATCH[service_name]
|
|
|
|
break
|
|
|
|
|
|
|
|
assert domain, 'Cannot map test homekit services to homeassistant domain'
|
|
|
|
|
|
|
|
accessory = Accessory('TestDevice', 'example.com', 'Test', '0001', '0.1')
|
|
|
|
accessory.services.extend(services)
|
|
|
|
|
2019-03-19 07:58:56 +00:00
|
|
|
pairing = await setup_test_accessories(hass, [accessory], capitalize)
|
2019-01-27 11:34:49 +00:00
|
|
|
|
2019-02-28 18:09:04 +00:00
|
|
|
entity = 'testdevice' if suffix is None else 'testdevice_{}'.format(suffix)
|
|
|
|
return Helper(hass, '.'.join((domain, entity)), pairing, accessory)
|