1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413
|
#
# Copyright 2019 aiohomekit team
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
from __future__ import annotations
import base64
from collections.abc import AsyncIterable
from dataclasses import dataclass
from datetime import timedelta
import logging
from aiohomekit import exceptions
from aiohomekit.characteristic_cache import CharacteristicCacheMemory
from aiohomekit.controller import TransportType
from aiohomekit.controller.abstract import (
AbstractController,
AbstractDiscovery,
AbstractPairing,
AbstractPairingData,
FinishPairing,
)
from aiohomekit.exceptions import AccessoryNotFoundError
from aiohomekit.model import Accessories, AccessoriesState, Transport
from aiohomekit.model.categories import Categories
from aiohomekit.model.characteristics import Characteristic, CharacteristicsTypes
from aiohomekit.model.characteristics.characteristic_formats import (
CharacteristicFormats,
)
from aiohomekit.model.status_flags import StatusFlags
from aiohomekit.protocol.statuscodes import HapStatusCode
from aiohomekit.uuid import normalize_uuid
_LOGGER = logging.getLogger(__name__)
FAKE_CAMERA_IMAGE = (
b"/9j/2wBDAAMCAgICAgMCAgIDAwMDBAYEBAQEBAgGBgUGCQgKCgkICQkKDA8MCgsOCwkJDRE"
b"NDg8QEBEQCgwSExIQEw8QEBD/yQALCAABAAEBAREA/8wABgAQEAX/2gAIAQEAAD8A0s8g/9k="
)
@dataclass
class FakeDescription:
name: str = "TestDevice"
id: str = "00:00:00:00:00:00"
model: str = "TestDevice"
status_flags: StatusFlags = StatusFlags.UNPAIRED
config_num: int = 1
state_num: int = 1
category: Categories = Categories.OTHER
class FakeDiscovery(AbstractDiscovery):
description = FakeDescription()
def __init__(
self, controller: FakeController, device_id: str, accessories: Accessories
):
self.controller = controller
self.accessories = accessories
self.pairing_code = "111-22-333"
@property
def status_flags(self) -> StatusFlags:
if self.description.id not in self.controller.pairings:
return StatusFlags.UNPAIRED
return StatusFlags(0)
async def async_start_pairing(self, alias: str) -> FinishPairing:
if self.description.id in self.controller.pairings:
raise exceptions.AlreadyPairedError(f"{self.description.id} already paired")
async def finish_pairing(pairing_code: str) -> FakePairing:
if pairing_code != self.pairing_code:
raise exceptions.AuthenticationError("M4")
discovery = self.controller.discoveries[self.description.id]
discovery.description = FakeDescription(status_flags=0)
pairing_data = {}
# pairing_data["AccessoryIP"] = self.address
# pairing_data["AccessoryPort"] = self.port
pairing_data["AccessoryPairingID"] = discovery.description.id
pairing_data["Connection"] = "Fake"
obj = FakePairing(self.controller, pairing_data, self.accessories)
self.controller.aliases[alias] = obj
self.controller.pairings[discovery.description.id] = obj
return obj
return finish_pairing
async def async_identify(self) -> None:
"""Trigger an identify routinue."""
class PairingTester:
"""
A holding class for test-only helpers.
This is done to minimize the difference between a FakePairing and a real pairing.
"""
def __init__(self, pairing: FakePairing, accessories: Accessories):
self.pairing = pairing
self.events_enabled = True
self.characteristics = {}
self.services = {}
for accessory in accessories:
for service in accessory.services:
service_map = {}
for char in service.characteristics:
self.characteristics[(accessory.aid, char.iid)] = char
service_map[char.type] = char
if char.type == CharacteristicsTypes.NAME:
self.services[char.get_value()] = service_map
def set_events_enabled(self, value):
self.events_enabled = value
def update_named_service(self, name: str, new_values):
"""
Finds a named service then sets characteristics by type.
pairing.test.update_named_service("kitchen lamp", {
CharacteristicsTypes.ON: True
})
Triggers events if enabled.
"""
if name not in self.services:
raise RuntimeError(f"Fake error: service {name!r} not found")
service = self.services[name]
changed = []
for uuid, value in new_values.items():
uuid = normalize_uuid(uuid)
if uuid not in service:
raise RuntimeError(
f"Unexpected characteristic {uuid!r} applied to service {name!r}"
)
char: Characteristic = service[uuid]
changed.append((char.service.accessory.aid, char.iid, value))
self._send_events(changed)
def update_aid_iid(self, characteristics):
self._send_events(characteristics)
def set_aid_iid_status(self, aid_iid_statuses: list[tuple[int, int, int]]):
"""Set status for an aid iid pair."""
event = {
(aid, iid): {"status": status} for aid, iid, status in aid_iid_statuses
}
if not event:
return
for listener in self.pairing.listeners:
try:
listener(event)
except Exception:
_LOGGER.exception("Unhandled error when processing event")
def _send_events(self, characteristics):
if not self.events_enabled:
return
event = {}
for aid, iid, value in characteristics:
char: Characteristic = self.characteristics[(aid, iid)]
if char.format == CharacteristicFormats.bool:
value = bool(value)
event[(aid, iid)] = {"value": value}
if not event:
return
for listener in self.pairing.listeners:
try:
listener(event)
except Exception:
_LOGGER.exception("Unhandled error when processing event")
class FakePairing(AbstractPairing):
"""
A test fake that pretends to be a paired HomeKit accessory.
This only contains methods and values that exist on the upstream Pairing
class.
"""
def __init__(
self,
controller: AbstractController,
pairing_data: AbstractPairingData,
accessories: Accessories,
) -> None:
"""Create a fake pairing from an accessory model."""
super().__init__(controller, pairing_data)
self._initial_accessories_state = AccessoriesState(accessories, 0)
self._accessories_state = None
self.pairing_data: dict[str, str] = {}
self.available = True
self.testing = PairingTester(self, accessories)
@property
def is_connected(self) -> bool:
return True
@property
def is_available(self) -> bool:
return True
@property
def transport(self) -> Transport:
transport_type = self.pairing_data.get("Connection", "IP")
return {
"BLE": Transport.BLE,
"CoAP": Transport.COAP,
"IP": Transport.IP,
}.get(transport_type, Transport.IP)
@property
def poll_interval(self) -> timedelta:
"""Returns how often the device should be polled."""
return timedelta(minutes=1)
async def close(self):
"""Close the connection."""
def _ensure_connected(self):
if not self.available:
raise AccessoryNotFoundError("Accessory not found")
if not self._accessories_state:
self._accessories_state = self._initial_accessories_state
self._update_accessories_state_cache()
async def identify(self):
"""Identify the accessory."""
self._ensure_connected()
async def list_pairings(self):
"""List pairing."""
return []
async def remove_pairing(self, pairing_id):
"""Remove a pairing."""
self._ensure_connected()
async def async_populate_accessories_state(
self, force_update: bool = False, attempts: int | None = None
) -> bool:
"""Populate the state of all accessories.
This method should try not to fetch all the accessories unless
we know the config num is out of date or force_update is True
"""
self._ensure_connected()
return True
async def _process_config_changed(self, config_num: int) -> None:
await self.list_accessories_and_characteristics()
self._accessories_state = AccessoriesState(
self._accessories_state.accessories, config_num
)
self._callback_and_save_config_changed(config_num)
async def _process_disconnected_events(self):
"""Process any events that happened while we were disconnected."""
async def list_accessories_and_characteristics(self):
"""Fake implementation of list_accessories_and_characteristics."""
self._ensure_connected()
return self.accessories.serialize()
async def get_characteristics(self, characteristics):
"""Fake implementation of get_characteristics."""
self._ensure_connected()
results = {}
for aid, cid in characteristics:
accessory = self.accessories.aid(aid)
char = accessory.characteristics.iid(cid)
if char.status != HapStatusCode.SUCCESS:
results[(aid, cid)] = {"status": char.status.value}
continue
results[(aid, cid)] = {"value": char.get_value()}
return results
async def put_characteristics(self, characteristics):
"""Fake implementation of put_characteristics."""
self._ensure_connected()
filtered = []
results = {}
for aid, cid, value in characteristics:
accessory = self.accessories.aid(aid)
char = accessory.characteristics.iid(cid)
if char.status != HapStatusCode.SUCCESS:
results[(aid, cid)] = {"status": char.status.value}
continue
filtered.append((aid, cid, value))
self.testing.update_aid_iid(filtered)
return results
async def thread_provision(
self,
dataset: str,
) -> None:
# This ultimately needs refactoring so that we can have multiple test transports loaded
# rather than patching this one to be COAP.
self.pairing_data["Connection"] = "CoAP"
self.controller.transport_type = TransportType.COAP
async def image(self, accessory: int, width: int, height: int) -> bytes:
self._ensure_connected()
return base64.b64decode(FAKE_CAMERA_IMAGE)
class FakeController(AbstractController):
"""
A test fake that pretends to be a paired HomeKit accessory.
This only contains methods and values that exist on the upstream Controller
class.
"""
started: bool
discoveries: dict[str, FakeDiscovery]
pairings: dict[str, FakePairing]
aliases: dict[str, FakePairing]
transport_type = TransportType.IP
def __init__(
self, async_zeroconf_instance=None, char_cache=None, bleak_scanner_instance=None
):
super().__init__(char_cache=char_cache or CharacteristicCacheMemory())
def add_device(self, accessories):
device_id = "00:00:00:00:00:00"
discovery = self.discoveries[device_id] = FakeDiscovery(
self,
device_id,
accessories=accessories,
)
return discovery
async def add_paired_device(self, accessories: Accessories, alias: str = None):
discovery = self.add_device(accessories)
finish_pairing = await discovery.async_start_pairing(
alias or discovery.description.id
)
return await finish_pairing(discovery.pairing_code)
async def async_start(self) -> None:
self.started = True
async def async_stop(self) -> None:
self.started = False
async def async_discover(
self, max_seconds: int = 10
) -> AsyncIterable[AbstractDiscovery]:
for discovery in self.discoveries.values():
yield discovery
async def async_find(self, device_id, timeout=10) -> AbstractDiscovery:
try:
return self.discoveries[device_id]
except KeyError:
raise AccessoryNotFoundError(device_id)
async def async_reachable(self, device_id: str, timeout=10) -> bool:
return True
async def remove_pairing(self, alias: str) -> None:
pairing = self.aliases[alias]
del self.pairings[self.aliases[alias].id]
del self.aliases[alias]
self._char_cache.async_delete_map(pairing.id)
def load_pairing(self, alias: str, pairing_data):
# This assumes a test has already preseed self.pairings with a fake via
# add_paired_device
pairing = self.aliases[alias]
pairing.pairing_data = pairing_data
return pairing
|