ZHA tests refactoring (#31682)
* Fixtures for restoring/joning a device. * binary_sensor.zha tests. * cover.zha platform tests. * device_tracker.zha platform tests. * fan.zha platform tests. * switch.zha platform tests. * Update light.zha platform tests. * Update sensor.zha platform tests. * ZHA api tests refactoring. * Update lock.zha platform tests. * Update ZHA gateway tests. * Update zha device action tests. * Update zha device trigger tests. * Cleanup.
This commit is contained in:
1 parent
118ba10442
commit
28eeed1db3
14 files changed
+648
-741
No files matched your search
+113
-155
@@ -11,7 +11,6 @@ import zigpy.zcl.foundation as zcl_f
|
||||
from homeassistant.components.sensor import DOMAIN
|
||||
import homeassistant.config as config_util
|
||||
from homeassistant.const import (
|
||||
ATTR_ENTITY_ID,
|
||||
ATTR_UNIT_OF_MEASUREMENT,
|
||||
CONF_UNIT_SYSTEM,
|
||||
CONF_UNIT_SYSTEM_IMPERIAL,
|
||||
@@ -26,160 +25,43 @@ from homeassistant.util import dt as dt_util
|
||||
|
||||
from .common import (
|
||||
async_enable_traffic,
|
||||
async_init_zigpy_device,
|
||||
async_test_device_join,
|
||||
find_entity_id,
|
||||
make_attribute,
|
||||
make_zcl_header,
|
||||
)
|
||||
|
||||
|
||||
async def test_sensor(hass, config_entry, zha_gateway):
|
||||
"""Test zha sensor platform."""
|
||||
|
||||
# list of cluster ids to create devices and sensor entities for
|
||||
cluster_ids = [
|
||||
measurement.RelativeHumidity.cluster_id,
|
||||
measurement.TemperatureMeasurement.cluster_id,
|
||||
measurement.PressureMeasurement.cluster_id,
|
||||
measurement.IlluminanceMeasurement.cluster_id,
|
||||
smartenergy.Metering.cluster_id,
|
||||
homeautomation.ElectricalMeasurement.cluster_id,
|
||||
]
|
||||
|
||||
# devices that were created from cluster_ids list above
|
||||
zigpy_device_infos = await async_build_devices(
|
||||
hass, zha_gateway, config_entry, cluster_ids
|
||||
)
|
||||
|
||||
# ensure the sensor entity was created for each id in cluster_ids
|
||||
for cluster_id in cluster_ids:
|
||||
zigpy_device_info = zigpy_device_infos[cluster_id]
|
||||
entity_id = zigpy_device_info[ATTR_ENTITY_ID]
|
||||
assert hass.states.get(entity_id).state == STATE_UNAVAILABLE
|
||||
|
||||
# allow traffic to flow through the gateway and devices
|
||||
await async_enable_traffic(
|
||||
hass,
|
||||
zha_gateway,
|
||||
[
|
||||
zigpy_device_info["zha_device"]
|
||||
for zigpy_device_info in zigpy_device_infos.values()
|
||||
],
|
||||
)
|
||||
|
||||
# test that the sensors now have a state of unknown
|
||||
for cluster_id in cluster_ids:
|
||||
zigpy_device_info = zigpy_device_infos[cluster_id]
|
||||
entity_id = zigpy_device_info[ATTR_ENTITY_ID]
|
||||
assert hass.states.get(entity_id).state == STATE_UNKNOWN
|
||||
|
||||
# get the humidity device info and test the associated sensor logic
|
||||
device_info = zigpy_device_infos[measurement.RelativeHumidity.cluster_id]
|
||||
await async_test_humidity(hass, device_info)
|
||||
|
||||
# get the temperature device info and test the associated sensor logic
|
||||
device_info = zigpy_device_infos[measurement.TemperatureMeasurement.cluster_id]
|
||||
await async_test_temperature(hass, device_info)
|
||||
|
||||
# get the pressure device info and test the associated sensor logic
|
||||
device_info = zigpy_device_infos[measurement.PressureMeasurement.cluster_id]
|
||||
await async_test_pressure(hass, device_info)
|
||||
|
||||
# get the illuminance device info and test the associated sensor logic
|
||||
device_info = zigpy_device_infos[measurement.IlluminanceMeasurement.cluster_id]
|
||||
await async_test_illuminance(hass, device_info)
|
||||
|
||||
# get the metering device info and test the associated sensor logic
|
||||
device_info = zigpy_device_infos[smartenergy.Metering.cluster_id]
|
||||
await async_test_metering(hass, device_info)
|
||||
|
||||
# get the electrical_measurement device info and test the associated
|
||||
# sensor logic
|
||||
device_info = zigpy_device_infos[homeautomation.ElectricalMeasurement.cluster_id]
|
||||
await async_test_electrical_measurement(hass, device_info)
|
||||
|
||||
# test joining a new temperature sensor to the network
|
||||
await async_test_device_join(
|
||||
hass, zha_gateway, measurement.TemperatureMeasurement.cluster_id, entity_id
|
||||
)
|
||||
|
||||
|
||||
async def async_build_devices(hass, zha_gateway, config_entry, cluster_ids):
|
||||
"""Build a zigpy device for each cluster id.
|
||||
|
||||
This will build devices for all cluster ids that exist in cluster_ids.
|
||||
They get added to the network and then the sensor component is loaded
|
||||
which will cause sensor entities to get created for each device.
|
||||
A dict containing relevant device info for testing is returned. It contains
|
||||
the entity id, zigpy device, and the zigbee cluster for the sensor.
|
||||
"""
|
||||
|
||||
device_infos = {}
|
||||
counter = 0
|
||||
for cluster_id in cluster_ids:
|
||||
# create zigpy device
|
||||
device_infos[cluster_id] = {"zigpy_device": None}
|
||||
device_infos[cluster_id]["zigpy_device"] = await async_init_zigpy_device(
|
||||
hass,
|
||||
[cluster_id, general.Basic.cluster_id],
|
||||
[],
|
||||
None,
|
||||
zha_gateway,
|
||||
ieee=f"00:15:8d:00:02:32:4f:0{counter}",
|
||||
manufacturer=f"Fake{cluster_id}",
|
||||
model=f"FakeModel{cluster_id}",
|
||||
)
|
||||
|
||||
counter += 1
|
||||
|
||||
# load up sensor domain
|
||||
await hass.config_entries.async_forward_entry_setup(config_entry, DOMAIN)
|
||||
await hass.async_block_till_done()
|
||||
|
||||
# put the other relevant info in the device info dict
|
||||
for cluster_id in cluster_ids:
|
||||
device_info = device_infos[cluster_id]
|
||||
zigpy_device = device_info["zigpy_device"]
|
||||
device_info["cluster"] = zigpy_device.endpoints.get(1).in_clusters[cluster_id]
|
||||
zha_device = zha_gateway.get_device(zigpy_device.ieee)
|
||||
device_info["zha_device"] = zha_device
|
||||
device_info[ATTR_ENTITY_ID] = await find_entity_id(DOMAIN, zha_device, hass)
|
||||
await hass.async_block_till_done()
|
||||
return device_infos
|
||||
|
||||
|
||||
async def async_test_humidity(hass, device_info):
|
||||
async def async_test_humidity(hass, cluster, entity_id):
|
||||
"""Test humidity sensor."""
|
||||
await send_attribute_report(hass, device_info["cluster"], 0, 1000)
|
||||
assert_state(hass, device_info, "10.0", "%")
|
||||
await send_attribute_report(hass, cluster, 0, 1000)
|
||||
assert_state(hass, entity_id, "10.0", "%")
|
||||
|
||||
|
||||
async def async_test_temperature(hass, device_info):
|
||||
async def async_test_temperature(hass, cluster, entity_id):
|
||||
"""Test temperature sensor."""
|
||||
await send_attribute_report(hass, device_info["cluster"], 0, 2900)
|
||||
assert_state(hass, device_info, "29.0", "°C")
|
||||
await send_attribute_report(hass, cluster, 0, 2900)
|
||||
assert_state(hass, entity_id, "29.0", "°C")
|
||||
|
||||
|
||||
async def async_test_pressure(hass, device_info):
|
||||
async def async_test_pressure(hass, cluster, entity_id):
|
||||
"""Test pressure sensor."""
|
||||
await send_attribute_report(hass, device_info["cluster"], 0, 1000)
|
||||
assert_state(hass, device_info, "1000", "hPa")
|
||||
await send_attribute_report(hass, cluster, 0, 1000)
|
||||
assert_state(hass, entity_id, "1000", "hPa")
|
||||
|
||||
|
||||
async def async_test_illuminance(hass, device_info):
|
||||
async def async_test_illuminance(hass, cluster, entity_id):
|
||||
"""Test illuminance sensor."""
|
||||
await send_attribute_report(hass, device_info["cluster"], 0, 10)
|
||||
assert_state(hass, device_info, "1.0", "lx")
|
||||
await send_attribute_report(hass, cluster, 0, 10)
|
||||
assert_state(hass, entity_id, "1.0", "lx")
|
||||
|
||||
|
||||
async def async_test_metering(hass, device_info):
|
||||
async def async_test_metering(hass, cluster, entity_id):
|
||||
"""Test metering sensor."""
|
||||
await send_attribute_report(hass, device_info["cluster"], 1024, 12345)
|
||||
assert_state(hass, device_info, "12345.0", "unknown")
|
||||
await send_attribute_report(hass, cluster, 1024, 12345)
|
||||
assert_state(hass, entity_id, "12345.0", "unknown")
|
||||
|
||||
|
||||
async def async_test_electrical_measurement(hass, device_info):
|
||||
async def async_test_electrical_measurement(hass, cluster, entity_id):
|
||||
"""Test electrical measurement sensor."""
|
||||
with mock.patch(
|
||||
(
|
||||
@@ -189,18 +71,81 @@ async def async_test_electrical_measurement(hass, device_info):
|
||||
new_callable=mock.PropertyMock,
|
||||
) as divisor_mock:
|
||||
divisor_mock.return_value = 1
|
||||
await send_attribute_report(hass, device_info["cluster"], 1291, 100)
|
||||
assert_state(hass, device_info, "100", "W")
|
||||
await send_attribute_report(hass, cluster, 1291, 100)
|
||||
assert_state(hass, entity_id, "100", "W")
|
||||
|
||||
await send_attribute_report(hass, device_info["cluster"], 1291, 99)
|
||||
assert_state(hass, device_info, "99", "W")
|
||||
await send_attribute_report(hass, cluster, 1291, 99)
|
||||
assert_state(hass, entity_id, "99", "W")
|
||||
|
||||
divisor_mock.return_value = 10
|
||||
await send_attribute_report(hass, device_info["cluster"], 1291, 1000)
|
||||
assert_state(hass, device_info, "100", "W")
|
||||
await send_attribute_report(hass, cluster, 1291, 1000)
|
||||
assert_state(hass, entity_id, "100", "W")
|
||||
|
||||
await send_attribute_report(hass, device_info["cluster"], 1291, 99)
|
||||
assert_state(hass, device_info, "9.9", "W")
|
||||
await send_attribute_report(hass, cluster, 1291, 99)
|
||||
assert_state(hass, entity_id, "9.9", "W")
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"cluster_id, test_func, report_count",
|
||||
(
|
||||
(measurement.RelativeHumidity.cluster_id, async_test_humidity, 1),
|
||||
(measurement.TemperatureMeasurement.cluster_id, async_test_temperature, 1),
|
||||
(measurement.PressureMeasurement.cluster_id, async_test_pressure, 1),
|
||||
(measurement.IlluminanceMeasurement.cluster_id, async_test_illuminance, 1),
|
||||
(smartenergy.Metering.cluster_id, async_test_metering, 1),
|
||||
(
|
||||
homeautomation.ElectricalMeasurement.cluster_id,
|
||||
async_test_electrical_measurement,
|
||||
1,
|
||||
),
|
||||
),
|
||||
)
|
||||
async def test_sensor(
|
||||
hass,
|
||||
zha_gateway,
|
||||
zigpy_device_mock,
|
||||
zha_device_joined_restored,
|
||||
cluster_id,
|
||||
test_func,
|
||||
report_count,
|
||||
):
|
||||
"""Test zha sensor platform."""
|
||||
|
||||
zigpy_device = zigpy_device_mock(
|
||||
{
|
||||
1: {
|
||||
"in_clusters": [cluster_id, general.Basic.cluster_id],
|
||||
"out_cluster": [],
|
||||
"device_type": 0x0000,
|
||||
}
|
||||
}
|
||||
)
|
||||
cluster = zigpy_device.endpoints[1].in_clusters[cluster_id]
|
||||
zha_device = await zha_device_joined_restored(zigpy_device)
|
||||
entity_id = await find_entity_id(DOMAIN, zha_device, hass)
|
||||
|
||||
# ensure the sensor entity was created
|
||||
assert hass.states.get(entity_id).state == STATE_UNAVAILABLE
|
||||
|
||||
# allow traffic to flow through the gateway and devices
|
||||
await async_enable_traffic(hass, zha_gateway, [zha_device])
|
||||
|
||||
# test that the sensor now have a state of unknown
|
||||
assert hass.states.get(entity_id).state == STATE_UNKNOWN
|
||||
|
||||
# test sensor associated logic
|
||||
await test_func(hass, cluster, entity_id)
|
||||
|
||||
# test rejoin
|
||||
cluster.bind.reset_mock()
|
||||
cluster.configure_reporting.reset_mock()
|
||||
await zha_gateway.async_device_initialized(zigpy_device)
|
||||
await hass.async_block_till_done()
|
||||
await test_func(hass, cluster, entity_id)
|
||||
assert cluster.bind.call_count == 1
|
||||
assert cluster.bind.await_count == 1
|
||||
assert cluster.configure_reporting.call_count == report_count
|
||||
assert cluster.configure_reporting.await_count == report_count
|
||||
|
||||
|
||||
async def send_attribute_report(hass, cluster, attrid, value):
|
||||
@@ -215,13 +160,13 @@ async def send_attribute_report(hass, cluster, attrid, value):
|
||||
await hass.async_block_till_done()
|
||||
|
||||
|
||||
def assert_state(hass, device_info, state, unit_of_measurement):
|
||||
def assert_state(hass, entity_id, state, unit_of_measurement):
|
||||
"""Check that the state is what is expected.
|
||||
|
||||
This is used to ensure that the logic in each sensor class handled the
|
||||
attribute report it received correctly.
|
||||
"""
|
||||
hass_state = hass.states.get(device_info[ATTR_ENTITY_ID])
|
||||
hass_state = hass.states.get(entity_id)
|
||||
assert hass_state.state == state
|
||||
assert hass_state.attributes.get(ATTR_UNIT_OF_MEASUREMENT) == unit_of_measurement
|
||||
|
||||
@@ -282,7 +227,15 @@ def core_rs(hass_storage):
|
||||
],
|
||||
)
|
||||
async def test_temp_uom(
|
||||
uom, raw_temp, expected, restore, hass_ms, config_entry, zha_gateway, core_rs
|
||||
uom,
|
||||
raw_temp,
|
||||
expected,
|
||||
restore,
|
||||
hass_ms,
|
||||
zha_gateway,
|
||||
core_rs,
|
||||
zigpy_device_mock,
|
||||
zha_device_restored,
|
||||
):
|
||||
"""Test zha temperature sensor unit of measurement."""
|
||||
|
||||
@@ -294,17 +247,22 @@ async def test_temp_uom(
|
||||
CONF_UNIT_SYSTEM_METRIC if uom == TEMP_CELSIUS else CONF_UNIT_SYSTEM_IMPERIAL
|
||||
)
|
||||
|
||||
# list of cluster ids to create devices and sensor entities for
|
||||
temp_cluster = measurement.TemperatureMeasurement
|
||||
cluster_ids = [temp_cluster.cluster_id]
|
||||
|
||||
# devices that were created from cluster_ids list above
|
||||
zigpy_device_infos = await async_build_devices(
|
||||
hass, zha_gateway, config_entry, cluster_ids
|
||||
zigpy_device = zigpy_device_mock(
|
||||
{
|
||||
1: {
|
||||
"in_clusters": [
|
||||
measurement.TemperatureMeasurement.cluster_id,
|
||||
general.Basic.cluster_id,
|
||||
],
|
||||
"out_cluster": [],
|
||||
"device_type": 0x0000,
|
||||
}
|
||||
}
|
||||
)
|
||||
cluster = zigpy_device.endpoints[1].temperature
|
||||
zha_device = await zha_device_restored(zigpy_device)
|
||||
entity_id = await find_entity_id(DOMAIN, zha_device, hass)
|
||||
|
||||
zigpy_device_info = zigpy_device_infos[temp_cluster.cluster_id]
|
||||
zha_device = zigpy_device_info["zha_device"]
|
||||
if not restore:
|
||||
assert hass.states.get(entity_id).state == STATE_UNAVAILABLE
|
||||
|
||||
@@ -315,7 +273,7 @@ async def test_temp_uom(
|
||||
if not restore:
|
||||
assert hass.states.get(entity_id).state == STATE_UNKNOWN
|
||||
|
||||
await send_attribute_report(hass, zigpy_device_info["cluster"], 0, raw_temp)
|
||||
await send_attribute_report(hass, cluster, 0, raw_temp)
|
||||
await hass.async_block_till_done()
|
||||
state = hass.states.get(entity_id)
|
||||
assert state is not None
|
||||
|
||||
Reference in new issue
Block a user