Add support for HomeKit (#12488)
* Basic Homekit support * Added Temperatur Sensor * Added Window Cover * Code refactored * Added class HomeAccessory(Accessory) * Added class HomeBridge(Bridge) * Changed homekit imports to relative, to enable use in custom_components * Updated requirements * Added docs * Other smaller changes * Changed Homekit from entity to class * Changes based on feedback * Updated config schema * Add only covers that support set_cover_position * Addressed comments, updated to pyhap==1.1.5 * For lint: added files to gen_requirements_all * Added codeowner * Small change to Wrapper classes * Moved imports to import_types, small changes * Small changes, added tests * Homekit class: removed add_accessory since it's already covered by pyhap * Added test requirement: HAP-python * Added test suit for homekit setup and interaction between HA and pyhap * Added test suit for get_accessories function * Test bugfix * Added validate pincode, tests for cover and sensor types
This commit is contained in:
1 parent
dc21c61a44
commit
eec3bad94f
14 files changed
+642
No files matched your search
@@ -0,0 +1 @@
|
||||
"""The tests for the homekit component."""
|
||||
@@ -0,0 +1,83 @@
|
||||
"""Test different accessory types: Covers."""
|
||||
import unittest
|
||||
|
||||
from homeassistant.core import callback
|
||||
from homeassistant.components.cover import (
|
||||
ATTR_POSITION, ATTR_CURRENT_POSITION)
|
||||
from homeassistant.components.homekit.covers import Window
|
||||
from homeassistant.const import (
|
||||
STATE_UNKNOWN, STATE_OPEN,
|
||||
ATTR_SERVICE, ATTR_SERVICE_DATA, EVENT_CALL_SERVICE)
|
||||
|
||||
from tests.common import get_test_home_assistant
|
||||
|
||||
|
||||
class TestHomekitSensors(unittest.TestCase):
|
||||
"""Test class for all accessory types regarding covers."""
|
||||
|
||||
def setUp(self):
|
||||
"""Setup things to be run when tests are started."""
|
||||
self.hass = get_test_home_assistant()
|
||||
self.events = []
|
||||
|
||||
@callback
|
||||
def record_event(event):
|
||||
"""Track called event."""
|
||||
self.events.append(event)
|
||||
|
||||
self.hass.bus.listen(EVENT_CALL_SERVICE, record_event)
|
||||
|
||||
def tearDown(self):
|
||||
"""Stop down everthing that was started."""
|
||||
self.hass.stop()
|
||||
|
||||
def test_window_set_cover_position(self):
|
||||
"""Test if accessory and HA are updated accordingly."""
|
||||
window_cover = 'cover.window'
|
||||
|
||||
acc = Window(self.hass, window_cover, 'Cover')
|
||||
acc.run()
|
||||
|
||||
self.assertEqual(acc.char_current_position.value, 0)
|
||||
self.assertEqual(acc.char_target_position.value, 0)
|
||||
self.assertEqual(acc.char_position_state.value, 0)
|
||||
|
||||
self.hass.states.set(window_cover, STATE_UNKNOWN,
|
||||
{ATTR_CURRENT_POSITION: None})
|
||||
self.hass.block_till_done()
|
||||
|
||||
self.assertEqual(acc.char_current_position.value, 0)
|
||||
self.assertEqual(acc.char_target_position.value, 0)
|
||||
self.assertEqual(acc.char_position_state.value, 0)
|
||||
|
||||
self.hass.states.set(window_cover, STATE_OPEN,
|
||||
{ATTR_CURRENT_POSITION: 50})
|
||||
self.hass.block_till_done()
|
||||
|
||||
self.assertEqual(acc.char_current_position.value, 50)
|
||||
self.assertEqual(acc.char_target_position.value, 50)
|
||||
self.assertEqual(acc.char_position_state.value, 2)
|
||||
|
||||
# Set from HomeKit
|
||||
acc.char_target_position.set_value(25)
|
||||
self.hass.block_till_done()
|
||||
self.assertEqual(
|
||||
self.events[0].data[ATTR_SERVICE], 'set_cover_position')
|
||||
self.assertEqual(
|
||||
self.events[0].data[ATTR_SERVICE_DATA][ATTR_POSITION], 25)
|
||||
|
||||
self.assertEqual(acc.char_current_position.value, 50)
|
||||
self.assertEqual(acc.char_target_position.value, 25)
|
||||
self.assertEqual(acc.char_position_state.value, 0)
|
||||
|
||||
# Set from HomeKit
|
||||
acc.char_target_position.set_value(75)
|
||||
self.hass.block_till_done()
|
||||
self.assertEqual(
|
||||
self.events[0].data[ATTR_SERVICE], 'set_cover_position')
|
||||
self.assertEqual(
|
||||
self.events[1].data[ATTR_SERVICE_DATA][ATTR_POSITION], 75)
|
||||
|
||||
self.assertEqual(acc.char_current_position.value, 50)
|
||||
self.assertEqual(acc.char_target_position.value, 75)
|
||||
self.assertEqual(acc.char_position_state.value, 1)
|
||||
@@ -0,0 +1,46 @@
|
||||
"""Package to test the get_accessory method."""
|
||||
from unittest.mock import patch, MagicMock
|
||||
|
||||
from homeassistant.core import State
|
||||
from homeassistant.components.homekit import (
|
||||
TYPES, get_accessory, import_types)
|
||||
from homeassistant.const import (
|
||||
ATTR_UNIT_OF_MEASUREMENT, ATTR_SUPPORTED_FEATURES,
|
||||
TEMP_CELSIUS, STATE_UNKNOWN)
|
||||
|
||||
|
||||
def test_import_types():
|
||||
"""Test if all type files are imported correctly."""
|
||||
try:
|
||||
import_types()
|
||||
assert True
|
||||
# pylint: disable=broad-except
|
||||
except Exception:
|
||||
assert False
|
||||
|
||||
|
||||
def test_component_not_supported():
|
||||
"""Test with unsupported component."""
|
||||
state = State('demo.unsupported', STATE_UNKNOWN)
|
||||
|
||||
assert True if get_accessory(None, state) is None else False
|
||||
|
||||
|
||||
def test_sensor_temperatur_celsius():
|
||||
"""Test temperature sensor with celsius as unit."""
|
||||
mock_type = MagicMock()
|
||||
with patch.dict(TYPES, {'TemperatureSensor': mock_type}):
|
||||
state = State('sensor.temperatur', '23',
|
||||
{ATTR_UNIT_OF_MEASUREMENT: TEMP_CELSIUS})
|
||||
get_accessory(None, state)
|
||||
assert len(mock_type.mock_calls) == 1
|
||||
|
||||
|
||||
def test_cover_set_position():
|
||||
"""Test cover with support for set_cover_position."""
|
||||
mock_type = MagicMock()
|
||||
with patch.dict(TYPES, {'Window': mock_type}):
|
||||
state = State('cover.setposition', 'open',
|
||||
{ATTR_SUPPORTED_FEATURES: 4})
|
||||
get_accessory(None, state)
|
||||
assert len(mock_type.mock_calls) == 1
|
||||
@@ -0,0 +1,124 @@
|
||||
"""Tests for the homekit component."""
|
||||
|
||||
import unittest
|
||||
from unittest.mock import patch
|
||||
|
||||
import voluptuous as vol
|
||||
|
||||
from homeassistant import setup
|
||||
from homeassistant.core import Event
|
||||
from homeassistant.components.homekit import (
|
||||
CONF_PIN_CODE, BRIDGE_NAME, Homekit, valid_pin)
|
||||
from homeassistant.components.homekit.covers import Window
|
||||
from homeassistant.components.homekit.sensors import TemperatureSensor
|
||||
from homeassistant.const import (
|
||||
CONF_PORT, EVENT_HOMEASSISTANT_START, EVENT_HOMEASSISTANT_STOP)
|
||||
|
||||
from tests.common import get_test_home_assistant
|
||||
|
||||
HOMEKIT_PATH = 'homeassistant.components.homekit'
|
||||
|
||||
CONFIG_MIN = {'homekit': {}}
|
||||
CONFIG = {
|
||||
'homekit': {
|
||||
CONF_PORT: 11111,
|
||||
CONF_PIN_CODE: '987-65-432',
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
class TestHomekit(unittest.TestCase):
|
||||
"""Test the Multicover component."""
|
||||
|
||||
def setUp(self):
|
||||
"""Setup things to be run when tests are started."""
|
||||
self.hass = get_test_home_assistant()
|
||||
|
||||
def tearDown(self):
|
||||
"""Stop down everthing that was started."""
|
||||
self.hass.stop()
|
||||
|
||||
@patch(HOMEKIT_PATH + '.Homekit.start_driver')
|
||||
@patch(HOMEKIT_PATH + '.Homekit.setup_bridge')
|
||||
@patch(HOMEKIT_PATH + '.Homekit.__init__')
|
||||
def test_setup_min(self, mock_homekit, mock_setup_bridge,
|
||||
mock_start_driver):
|
||||
"""Test async_setup with minimal config option."""
|
||||
mock_homekit.return_value = None
|
||||
|
||||
self.assertTrue(setup.setup_component(
|
||||
self.hass, 'homekit', CONFIG_MIN))
|
||||
|
||||
mock_homekit.assert_called_once_with(self.hass, 51826)
|
||||
mock_setup_bridge.assert_called_with(b'123-45-678')
|
||||
mock_start_driver.assert_not_called()
|
||||
|
||||
self.hass.start()
|
||||
self.hass.block_till_done()
|
||||
mock_start_driver.assert_called_once()
|
||||
|
||||
@patch(HOMEKIT_PATH + '.Homekit.start_driver')
|
||||
@patch(HOMEKIT_PATH + '.Homekit.setup_bridge')
|
||||
@patch(HOMEKIT_PATH + '.Homekit.__init__')
|
||||
def test_setup_parameters(self, mock_homekit, mock_setup_bridge,
|
||||
mock_start_driver):
|
||||
"""Test async_setup with full config option."""
|
||||
mock_homekit.return_value = None
|
||||
|
||||
self.assertTrue(setup.setup_component(
|
||||
self.hass, 'homekit', CONFIG))
|
||||
|
||||
mock_homekit.assert_called_once_with(self.hass, 11111)
|
||||
mock_setup_bridge.assert_called_with(b'987-65-432')
|
||||
|
||||
def test_validate_pincode(self):
|
||||
"""Test async_setup with invalid config option."""
|
||||
schema = vol.Schema(valid_pin)
|
||||
|
||||
for value in ('', '123-456-78', 'a23-45-678', '12345678'):
|
||||
with self.assertRaises(vol.MultipleInvalid):
|
||||
schema(value)
|
||||
|
||||
for value in ('123-45-678', '234-56-789'):
|
||||
self.assertTrue(schema(value))
|
||||
|
||||
@patch('pyhap.accessory_driver.AccessoryDriver.persist')
|
||||
@patch('pyhap.accessory_driver.AccessoryDriver.stop')
|
||||
@patch('pyhap.accessory_driver.AccessoryDriver.start')
|
||||
@patch(HOMEKIT_PATH + '.import_types')
|
||||
@patch(HOMEKIT_PATH + '.get_accessory')
|
||||
def test_homekit_pyhap_interaction(
|
||||
self, mock_get_accessory, mock_import_types,
|
||||
mock_driver_start, mock_driver_stop, mock_file_persist):
|
||||
"""Test the interaction between the homekit class and pyhap."""
|
||||
acc1 = TemperatureSensor(self.hass, 'sensor.temp', 'Temperature')
|
||||
acc2 = Window(self.hass, 'cover.hall_window', 'Cover')
|
||||
mock_get_accessory.side_effect = [acc1, acc2]
|
||||
|
||||
homekit = Homekit(self.hass, 51826)
|
||||
homekit.setup_bridge(b'123-45-678')
|
||||
|
||||
self.assertEqual(homekit.bridge.display_name, BRIDGE_NAME)
|
||||
|
||||
self.hass.states.set('demo.demo1', 'on')
|
||||
self.hass.states.set('demo.demo2', 'off')
|
||||
|
||||
self.hass.start()
|
||||
self.hass.block_till_done()
|
||||
|
||||
homekit.start_driver(Event(EVENT_HOMEASSISTANT_START))
|
||||
|
||||
self.assertEqual(mock_get_accessory.call_count, 2)
|
||||
mock_import_types.assert_called_once()
|
||||
mock_driver_start.assert_called_once()
|
||||
|
||||
accessories = homekit.bridge.accessories
|
||||
self.assertEqual(accessories[2], acc1)
|
||||
self.assertEqual(accessories[3], acc2)
|
||||
|
||||
mock_driver_stop.assert_not_called()
|
||||
|
||||
self.hass.bus.fire(EVENT_HOMEASSISTANT_STOP)
|
||||
self.hass.block_till_done()
|
||||
|
||||
mock_driver_stop.assert_called_once()
|
||||
@@ -0,0 +1,37 @@
|
||||
"""Test different accessory types: Sensors."""
|
||||
import unittest
|
||||
|
||||
from homeassistant.components.homekit.sensors import TemperatureSensor
|
||||
from homeassistant.const import (
|
||||
ATTR_UNIT_OF_MEASUREMENT, TEMP_CELSIUS, STATE_UNKNOWN)
|
||||
|
||||
from tests.common import get_test_home_assistant
|
||||
|
||||
|
||||
class TestHomekitSensors(unittest.TestCase):
|
||||
"""Test class for all accessory types regarding sensors."""
|
||||
|
||||
def setUp(self):
|
||||
"""Setup things to be run when tests are started."""
|
||||
self.hass = get_test_home_assistant()
|
||||
|
||||
def tearDown(self):
|
||||
"""Stop down everthing that was started."""
|
||||
self.hass.stop()
|
||||
|
||||
def test_temperature_celsius(self):
|
||||
"""Test if accessory is updated after state change."""
|
||||
temperature_sensor = 'sensor.temperature'
|
||||
|
||||
self.hass.states.set(temperature_sensor, STATE_UNKNOWN,
|
||||
{ATTR_UNIT_OF_MEASUREMENT: TEMP_CELSIUS})
|
||||
self.hass.block_till_done()
|
||||
|
||||
acc = TemperatureSensor(self.hass, temperature_sensor, 'Temperature')
|
||||
acc.run()
|
||||
|
||||
self.assertEqual(acc.char_temp.value, 0.0)
|
||||
|
||||
self.hass.states.set(temperature_sensor, '20')
|
||||
self.hass.block_till_done()
|
||||
self.assertEqual(acc.char_temp.value, 20)
|
||||
Reference in new issue
Block a user