409 lines
13 KiB
Python
409 lines
13 KiB
Python
"""The tests for the integration sensor platform."""
|
|
from datetime import timedelta
|
|
from unittest.mock import patch
|
|
|
|
from homeassistant.components.sensor import SensorDeviceClass, SensorStateClass
|
|
from homeassistant.const import (
|
|
ENERGY_KILO_WATT_HOUR,
|
|
ENERGY_WATT_HOUR,
|
|
POWER_WATT,
|
|
STATE_UNKNOWN,
|
|
TIME_SECONDS,
|
|
)
|
|
from homeassistant.core import HomeAssistant, State
|
|
from homeassistant.setup import async_setup_component
|
|
import homeassistant.util.dt as dt_util
|
|
|
|
from tests.common import mock_restore_cache
|
|
|
|
|
|
async def test_state(hass) -> None:
|
|
"""Test integration sensor state."""
|
|
config = {
|
|
"sensor": {
|
|
"platform": "integration",
|
|
"name": "integration",
|
|
"source": "sensor.power",
|
|
"unit": ENERGY_KILO_WATT_HOUR,
|
|
"round": 2,
|
|
}
|
|
}
|
|
|
|
now = dt_util.utcnow()
|
|
with patch("homeassistant.util.dt.utcnow", return_value=now):
|
|
assert await async_setup_component(hass, "sensor", config)
|
|
|
|
entity_id = config["sensor"]["source"]
|
|
hass.states.async_set(entity_id, 1, {})
|
|
await hass.async_block_till_done()
|
|
|
|
state = hass.states.get("sensor.integration")
|
|
assert state is not None
|
|
assert state.attributes.get("state_class") is SensorStateClass.TOTAL
|
|
assert "device_class" not in state.attributes
|
|
|
|
future_now = dt_util.utcnow() + timedelta(seconds=3600)
|
|
with patch("homeassistant.util.dt.utcnow", return_value=future_now):
|
|
hass.states.async_set(
|
|
entity_id, 1, {"device_class": SensorDeviceClass.POWER}, force_update=True
|
|
)
|
|
await hass.async_block_till_done()
|
|
|
|
state = hass.states.get("sensor.integration")
|
|
assert state is not None
|
|
|
|
# Testing a power sensor at 1 KiloWatts for 1hour = 1kWh
|
|
assert round(float(state.state), config["sensor"]["round"]) == 1.0
|
|
|
|
assert state.attributes.get("unit_of_measurement") == ENERGY_KILO_WATT_HOUR
|
|
assert state.attributes.get("device_class") == SensorDeviceClass.ENERGY
|
|
assert state.attributes.get("state_class") is SensorStateClass.TOTAL
|
|
|
|
|
|
async def test_restore_state(hass: HomeAssistant) -> None:
|
|
"""Test integration sensor state is restored correctly."""
|
|
mock_restore_cache(
|
|
hass,
|
|
(
|
|
State(
|
|
"sensor.integration",
|
|
"100.0",
|
|
{
|
|
"device_class": SensorDeviceClass.ENERGY,
|
|
"unit_of_measurement": ENERGY_KILO_WATT_HOUR,
|
|
},
|
|
),
|
|
),
|
|
)
|
|
|
|
config = {
|
|
"sensor": {
|
|
"platform": "integration",
|
|
"name": "integration",
|
|
"source": "sensor.power",
|
|
"round": 2,
|
|
}
|
|
}
|
|
|
|
assert await async_setup_component(hass, "sensor", config)
|
|
await hass.async_block_till_done()
|
|
|
|
state = hass.states.get("sensor.integration")
|
|
assert state
|
|
assert state.state == "100.00"
|
|
assert state.attributes.get("unit_of_measurement") == ENERGY_KILO_WATT_HOUR
|
|
assert state.attributes.get("device_class") == SensorDeviceClass.ENERGY
|
|
|
|
|
|
async def test_restore_state_failed(hass: HomeAssistant) -> None:
|
|
"""Test integration sensor state is restored correctly."""
|
|
mock_restore_cache(
|
|
hass,
|
|
(
|
|
State(
|
|
"sensor.integration",
|
|
"INVALID",
|
|
{
|
|
"last_reset": "2019-10-06T21:00:00.000000",
|
|
},
|
|
),
|
|
),
|
|
)
|
|
|
|
config = {
|
|
"sensor": {
|
|
"platform": "integration",
|
|
"name": "integration",
|
|
"source": "sensor.power",
|
|
}
|
|
}
|
|
|
|
assert await async_setup_component(hass, "sensor", config)
|
|
await hass.async_block_till_done()
|
|
|
|
state = hass.states.get("sensor.integration")
|
|
assert state
|
|
assert state.state == "unknown"
|
|
assert state.attributes.get("unit_of_measurement") is None
|
|
assert state.attributes.get("state_class") is SensorStateClass.TOTAL
|
|
|
|
assert "device_class" not in state.attributes
|
|
|
|
|
|
async def test_trapezoidal(hass):
|
|
"""Test integration sensor state."""
|
|
config = {
|
|
"sensor": {
|
|
"platform": "integration",
|
|
"name": "integration",
|
|
"source": "sensor.power",
|
|
"unit": ENERGY_KILO_WATT_HOUR,
|
|
"round": 2,
|
|
}
|
|
}
|
|
|
|
assert await async_setup_component(hass, "sensor", config)
|
|
|
|
entity_id = config["sensor"]["source"]
|
|
hass.states.async_set(entity_id, 0, {})
|
|
await hass.async_block_till_done()
|
|
|
|
# Testing a power sensor with non-monotonic intervals and values
|
|
for time, value in [(20, 10), (30, 30), (40, 5), (50, 0)]:
|
|
now = dt_util.utcnow() + timedelta(minutes=time)
|
|
with patch("homeassistant.util.dt.utcnow", return_value=now):
|
|
hass.states.async_set(entity_id, value, {}, force_update=True)
|
|
await hass.async_block_till_done()
|
|
|
|
state = hass.states.get("sensor.integration")
|
|
assert state is not None
|
|
|
|
assert round(float(state.state), config["sensor"]["round"]) == 8.33
|
|
|
|
assert state.attributes.get("unit_of_measurement") == ENERGY_KILO_WATT_HOUR
|
|
|
|
|
|
async def test_left(hass):
|
|
"""Test integration sensor state with left reimann method."""
|
|
config = {
|
|
"sensor": {
|
|
"platform": "integration",
|
|
"name": "integration",
|
|
"method": "left",
|
|
"source": "sensor.power",
|
|
"unit": ENERGY_KILO_WATT_HOUR,
|
|
"round": 2,
|
|
}
|
|
}
|
|
|
|
assert await async_setup_component(hass, "sensor", config)
|
|
|
|
entity_id = config["sensor"]["source"]
|
|
hass.states.async_set(entity_id, 0, {})
|
|
await hass.async_block_till_done()
|
|
|
|
# Testing a power sensor with non-monotonic intervals and values
|
|
for time, value in [(20, 10), (30, 30), (40, 5), (50, 0)]:
|
|
now = dt_util.utcnow() + timedelta(minutes=time)
|
|
with patch("homeassistant.util.dt.utcnow", return_value=now):
|
|
hass.states.async_set(entity_id, value, {}, force_update=True)
|
|
await hass.async_block_till_done()
|
|
|
|
state = hass.states.get("sensor.integration")
|
|
assert state is not None
|
|
|
|
assert round(float(state.state), config["sensor"]["round"]) == 7.5
|
|
|
|
assert state.attributes.get("unit_of_measurement") == ENERGY_KILO_WATT_HOUR
|
|
|
|
|
|
async def test_right(hass):
|
|
"""Test integration sensor state with left reimann method."""
|
|
config = {
|
|
"sensor": {
|
|
"platform": "integration",
|
|
"name": "integration",
|
|
"method": "right",
|
|
"source": "sensor.power",
|
|
"unit": ENERGY_KILO_WATT_HOUR,
|
|
"round": 2,
|
|
}
|
|
}
|
|
|
|
assert await async_setup_component(hass, "sensor", config)
|
|
|
|
entity_id = config["sensor"]["source"]
|
|
hass.states.async_set(entity_id, 0, {})
|
|
await hass.async_block_till_done()
|
|
|
|
# Testing a power sensor with non-monotonic intervals and values
|
|
for time, value in [(20, 10), (30, 30), (40, 5), (50, 0)]:
|
|
now = dt_util.utcnow() + timedelta(minutes=time)
|
|
with patch("homeassistant.util.dt.utcnow", return_value=now):
|
|
hass.states.async_set(entity_id, value, {}, force_update=True)
|
|
await hass.async_block_till_done()
|
|
|
|
state = hass.states.get("sensor.integration")
|
|
assert state is not None
|
|
|
|
assert round(float(state.state), config["sensor"]["round"]) == 9.17
|
|
|
|
assert state.attributes.get("unit_of_measurement") == ENERGY_KILO_WATT_HOUR
|
|
|
|
|
|
async def test_prefix(hass):
|
|
"""Test integration sensor state using a power source."""
|
|
config = {
|
|
"sensor": {
|
|
"platform": "integration",
|
|
"name": "integration",
|
|
"source": "sensor.power",
|
|
"round": 2,
|
|
"unit_prefix": "k",
|
|
}
|
|
}
|
|
|
|
assert await async_setup_component(hass, "sensor", config)
|
|
|
|
entity_id = config["sensor"]["source"]
|
|
hass.states.async_set(entity_id, 1000, {"unit_of_measurement": POWER_WATT})
|
|
await hass.async_block_till_done()
|
|
|
|
now = dt_util.utcnow() + timedelta(seconds=3600)
|
|
with patch("homeassistant.util.dt.utcnow", return_value=now):
|
|
hass.states.async_set(
|
|
entity_id, 1000, {"unit_of_measurement": POWER_WATT}, force_update=True
|
|
)
|
|
await hass.async_block_till_done()
|
|
|
|
state = hass.states.get("sensor.integration")
|
|
assert state is not None
|
|
|
|
# Testing a power sensor at 1000 Watts for 1hour = 1kWh
|
|
assert round(float(state.state), config["sensor"]["round"]) == 1.0
|
|
assert state.attributes.get("unit_of_measurement") == ENERGY_KILO_WATT_HOUR
|
|
|
|
|
|
async def test_suffix(hass):
|
|
"""Test integration sensor state using a network counter source."""
|
|
config = {
|
|
"sensor": {
|
|
"platform": "integration",
|
|
"name": "integration",
|
|
"source": "sensor.bytes_per_second",
|
|
"round": 2,
|
|
"unit_prefix": "k",
|
|
"unit_time": TIME_SECONDS,
|
|
}
|
|
}
|
|
|
|
assert await async_setup_component(hass, "sensor", config)
|
|
|
|
entity_id = config["sensor"]["source"]
|
|
hass.states.async_set(entity_id, 1000, {})
|
|
await hass.async_block_till_done()
|
|
|
|
now = dt_util.utcnow() + timedelta(seconds=10)
|
|
with patch("homeassistant.util.dt.utcnow", return_value=now):
|
|
hass.states.async_set(entity_id, 1000, {}, force_update=True)
|
|
await hass.async_block_till_done()
|
|
|
|
state = hass.states.get("sensor.integration")
|
|
assert state is not None
|
|
|
|
# Testing a network speed sensor at 1000 bytes/s over 10s = 10kbytes
|
|
assert round(float(state.state)) == 10
|
|
|
|
|
|
async def test_units(hass):
|
|
"""Test integration sensor units using a power source."""
|
|
config = {
|
|
"sensor": {
|
|
"platform": "integration",
|
|
"name": "integration",
|
|
"source": "sensor.power",
|
|
}
|
|
}
|
|
|
|
assert await async_setup_component(hass, "sensor", config)
|
|
|
|
entity_id = config["sensor"]["source"]
|
|
# This replicates the current sequence when HA starts up in a real runtime
|
|
# by updating the base sensor state before the base sensor's units
|
|
# or state have been correctly populated. Those interim updates
|
|
# include states of None and Unknown
|
|
hass.states.async_set(entity_id, 100, {"unit_of_measurement": None})
|
|
await hass.async_block_till_done()
|
|
hass.states.async_set(entity_id, 200, {"unit_of_measurement": None})
|
|
await hass.async_block_till_done()
|
|
hass.states.async_set(entity_id, 300, {"unit_of_measurement": POWER_WATT})
|
|
await hass.async_block_till_done()
|
|
|
|
state = hass.states.get("sensor.integration")
|
|
assert state is not None
|
|
|
|
# Testing the sensor ignored the source sensor's units until
|
|
# they became valid
|
|
assert state.attributes.get("unit_of_measurement") == ENERGY_WATT_HOUR
|
|
|
|
|
|
async def test_device_class(hass):
|
|
"""Test integration sensor units using a power source."""
|
|
config = {
|
|
"sensor": {
|
|
"platform": "integration",
|
|
"name": "integration",
|
|
"source": "sensor.power",
|
|
}
|
|
}
|
|
|
|
assert await async_setup_component(hass, "sensor", config)
|
|
|
|
entity_id = config["sensor"]["source"]
|
|
# This replicates the current sequence when HA starts up in a real runtime
|
|
# by updating the base sensor state before the base sensor's units
|
|
# or state have been correctly populated. Those interim updates
|
|
# include states of None and Unknown
|
|
hass.states.async_set(entity_id, STATE_UNKNOWN, {})
|
|
await hass.async_block_till_done()
|
|
hass.states.async_set(entity_id, 100, {"device_class": None})
|
|
await hass.async_block_till_done()
|
|
hass.states.async_set(entity_id, 200, {"device_class": None})
|
|
await hass.async_block_till_done()
|
|
|
|
state = hass.states.get("sensor.integration")
|
|
assert "device_class" not in state.attributes
|
|
|
|
hass.states.async_set(
|
|
entity_id, 300, {"device_class": SensorDeviceClass.POWER}, force_update=True
|
|
)
|
|
await hass.async_block_till_done()
|
|
|
|
state = hass.states.get("sensor.integration")
|
|
assert state is not None
|
|
# Testing the sensor ignored the source sensor's device class until
|
|
# it became valid
|
|
assert state.attributes.get("device_class") == SensorDeviceClass.ENERGY
|
|
|
|
|
|
async def test_calc_errors(hass):
|
|
"""Test integration sensor units using a power source."""
|
|
config = {
|
|
"sensor": {
|
|
"platform": "integration",
|
|
"name": "integration",
|
|
"source": "sensor.power",
|
|
}
|
|
}
|
|
|
|
assert await async_setup_component(hass, "sensor", config)
|
|
|
|
entity_id = config["sensor"]["source"]
|
|
|
|
hass.states.async_set(entity_id, None, {})
|
|
await hass.async_block_till_done()
|
|
|
|
state = hass.states.get("sensor.integration")
|
|
# With the source sensor in a None state, the Reimann sensor should be
|
|
# unknown
|
|
assert state is not None
|
|
assert state.state == STATE_UNKNOWN
|
|
|
|
# Moving from an unknown state to a value is a calc error and should
|
|
# not change the value of the Reimann sensor.
|
|
hass.states.async_set(entity_id, 0, {"device_class": None})
|
|
await hass.async_block_till_done()
|
|
|
|
state = hass.states.get("sensor.integration")
|
|
assert state is not None
|
|
assert state.state == STATE_UNKNOWN
|
|
|
|
# With the source sensor updated successfully, the Reimann sensor
|
|
# should have a zero (known) value.
|
|
hass.states.async_set(entity_id, 1, {"device_class": None})
|
|
await hass.async_block_till_done()
|
|
|
|
state = hass.states.get("sensor.integration")
|
|
assert state is not None
|
|
assert round(float(state.state)) == 0
|