256 lines
9.0 KiB
Python
256 lines
9.0 KiB
Python
"""The test for sensor entity."""
|
|
from datetime import date, datetime, timezone
|
|
|
|
import pytest
|
|
from pytest import approx
|
|
|
|
from homeassistant.components.sensor import SensorDeviceClass, SensorEntityDescription
|
|
from homeassistant.const import (
|
|
ATTR_UNIT_OF_MEASUREMENT,
|
|
STATE_UNKNOWN,
|
|
TEMP_CELSIUS,
|
|
TEMP_FAHRENHEIT,
|
|
)
|
|
from homeassistant.setup import async_setup_component
|
|
from homeassistant.util import dt as dt_util
|
|
from homeassistant.util.unit_system import IMPERIAL_SYSTEM, METRIC_SYSTEM
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"unit_system,native_unit,state_unit,native_value,state_value",
|
|
[
|
|
(IMPERIAL_SYSTEM, TEMP_FAHRENHEIT, TEMP_FAHRENHEIT, 100, 100),
|
|
(IMPERIAL_SYSTEM, TEMP_CELSIUS, TEMP_FAHRENHEIT, 38, 100),
|
|
(METRIC_SYSTEM, TEMP_FAHRENHEIT, TEMP_CELSIUS, 100, 38),
|
|
(METRIC_SYSTEM, TEMP_CELSIUS, TEMP_CELSIUS, 38, 38),
|
|
],
|
|
)
|
|
async def test_temperature_conversion(
|
|
hass,
|
|
enable_custom_integrations,
|
|
unit_system,
|
|
native_unit,
|
|
state_unit,
|
|
native_value,
|
|
state_value,
|
|
):
|
|
"""Test temperature conversion."""
|
|
hass.config.units = unit_system
|
|
platform = getattr(hass.components, "test.sensor")
|
|
platform.init(empty=True)
|
|
platform.ENTITIES["0"] = platform.MockSensor(
|
|
name="Test",
|
|
native_value=str(native_value),
|
|
native_unit_of_measurement=native_unit,
|
|
device_class=SensorDeviceClass.TEMPERATURE,
|
|
)
|
|
|
|
entity0 = platform.ENTITIES["0"]
|
|
assert await async_setup_component(hass, "sensor", {"sensor": {"platform": "test"}})
|
|
await hass.async_block_till_done()
|
|
|
|
state = hass.states.get(entity0.entity_id)
|
|
assert float(state.state) == approx(float(state_value))
|
|
assert state.attributes[ATTR_UNIT_OF_MEASUREMENT] == state_unit
|
|
|
|
|
|
async def test_deprecated_temperature_conversion(
|
|
hass, caplog, enable_custom_integrations
|
|
):
|
|
"""Test warning on deprecated temperature conversion."""
|
|
platform = getattr(hass.components, "test.sensor")
|
|
platform.init(empty=True)
|
|
platform.ENTITIES["0"] = platform.MockSensor(
|
|
name="Test", native_value="0.0", native_unit_of_measurement=TEMP_FAHRENHEIT
|
|
)
|
|
|
|
entity0 = platform.ENTITIES["0"]
|
|
assert await async_setup_component(hass, "sensor", {"sensor": {"platform": "test"}})
|
|
await hass.async_block_till_done()
|
|
|
|
state = hass.states.get(entity0.entity_id)
|
|
assert state.state == "-17.8"
|
|
assert state.attributes[ATTR_UNIT_OF_MEASUREMENT] == TEMP_CELSIUS
|
|
assert (
|
|
"Entity sensor.test (<class 'custom_components.test.sensor.MockSensor'>) "
|
|
"with device_class None reports a temperature in °F which will be converted to "
|
|
"°C. Temperature conversion for entities without correct device_class is "
|
|
"deprecated and will be removed from Home Assistant Core 2022.3. Please update "
|
|
"your configuration if device_class is manually configured, otherwise report it "
|
|
"to the custom component author."
|
|
) in caplog.text
|
|
|
|
|
|
@pytest.mark.parametrize("state_class", ("measurement", "total_increasing"))
|
|
async def test_deprecated_last_reset(
|
|
hass, caplog, enable_custom_integrations, state_class
|
|
):
|
|
"""Test warning on deprecated last reset."""
|
|
platform = getattr(hass.components, "test.sensor")
|
|
platform.init(empty=True)
|
|
platform.ENTITIES["0"] = platform.MockSensor(
|
|
name="Test", state_class=state_class, last_reset=dt_util.utc_from_timestamp(0)
|
|
)
|
|
|
|
assert await async_setup_component(hass, "sensor", {"sensor": {"platform": "test"}})
|
|
await hass.async_block_till_done()
|
|
|
|
assert (
|
|
"Entity sensor.test (<class 'custom_components.test.sensor.MockSensor'>) "
|
|
f"with state_class {state_class} has set last_reset. Setting last_reset for "
|
|
"entities with state_class other than 'total' is not supported. Please update "
|
|
"your configuration if state_class is manually configured, otherwise report it "
|
|
"to the custom component author."
|
|
) in caplog.text
|
|
|
|
state = hass.states.get("sensor.test")
|
|
assert "last_reset" not in state.attributes
|
|
|
|
|
|
async def test_deprecated_unit_of_measurement(hass, caplog, enable_custom_integrations):
|
|
"""Test warning on deprecated unit_of_measurement."""
|
|
SensorEntityDescription("catsensor", unit_of_measurement="cats")
|
|
assert (
|
|
"tests.components.sensor.test_init is setting 'unit_of_measurement' on an "
|
|
"instance of SensorEntityDescription"
|
|
) in caplog.text
|
|
|
|
|
|
async def test_datetime_conversion(hass, caplog, enable_custom_integrations):
|
|
"""Test conversion of datetime."""
|
|
test_timestamp = datetime(2017, 12, 19, 18, 29, 42, tzinfo=timezone.utc)
|
|
test_local_timestamp = test_timestamp.astimezone(
|
|
dt_util.get_time_zone("Europe/Amsterdam")
|
|
)
|
|
test_date = date(2017, 12, 19)
|
|
platform = getattr(hass.components, "test.sensor")
|
|
platform.init(empty=True)
|
|
platform.ENTITIES["0"] = platform.MockSensor(
|
|
name="Test",
|
|
native_value=test_timestamp,
|
|
device_class=SensorDeviceClass.TIMESTAMP,
|
|
)
|
|
platform.ENTITIES["1"] = platform.MockSensor(
|
|
name="Test", native_value=test_date, device_class=SensorDeviceClass.DATE
|
|
)
|
|
platform.ENTITIES["2"] = platform.MockSensor(
|
|
name="Test", native_value=None, device_class=SensorDeviceClass.TIMESTAMP
|
|
)
|
|
platform.ENTITIES["3"] = platform.MockSensor(
|
|
name="Test", native_value=None, device_class=SensorDeviceClass.DATE
|
|
)
|
|
platform.ENTITIES["4"] = platform.MockSensor(
|
|
name="Test",
|
|
native_value=test_local_timestamp,
|
|
device_class=SensorDeviceClass.TIMESTAMP,
|
|
)
|
|
|
|
assert await async_setup_component(hass, "sensor", {"sensor": {"platform": "test"}})
|
|
await hass.async_block_till_done()
|
|
|
|
state = hass.states.get(platform.ENTITIES["0"].entity_id)
|
|
assert state.state == test_timestamp.isoformat()
|
|
|
|
state = hass.states.get(platform.ENTITIES["1"].entity_id)
|
|
assert state.state == test_date.isoformat()
|
|
|
|
state = hass.states.get(platform.ENTITIES["2"].entity_id)
|
|
assert state.state == STATE_UNKNOWN
|
|
|
|
state = hass.states.get(platform.ENTITIES["3"].entity_id)
|
|
assert state.state == STATE_UNKNOWN
|
|
|
|
state = hass.states.get(platform.ENTITIES["4"].entity_id)
|
|
assert state.state == test_timestamp.isoformat()
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"device_class,native_value,state_value",
|
|
[
|
|
(SensorDeviceClass.DATE, "2021-11-09", "2021-11-09"),
|
|
(
|
|
SensorDeviceClass.DATE,
|
|
"2021-01-09T12:00:00+00:00",
|
|
"2021-01-09",
|
|
),
|
|
(
|
|
SensorDeviceClass.DATE,
|
|
"2021-01-09T00:00:00+01:00",
|
|
"2021-01-08",
|
|
),
|
|
(
|
|
SensorDeviceClass.TIMESTAMP,
|
|
"2021-01-09T12:00:00+00:00",
|
|
"2021-01-09T12:00:00+00:00",
|
|
),
|
|
(
|
|
SensorDeviceClass.TIMESTAMP,
|
|
"2021-01-09 12:00:00+00:00",
|
|
"2021-01-09T12:00:00+00:00",
|
|
),
|
|
(
|
|
SensorDeviceClass.TIMESTAMP,
|
|
"2021-01-09T12:00:00+04:00",
|
|
"2021-01-09T08:00:00+00:00",
|
|
),
|
|
(
|
|
SensorDeviceClass.TIMESTAMP,
|
|
"2021-01-09 12:00:00+01:00",
|
|
"2021-01-09T11:00:00+00:00",
|
|
),
|
|
(
|
|
SensorDeviceClass.TIMESTAMP,
|
|
"2021-01-09 12:00:00",
|
|
"2021-01-09T12:00:00",
|
|
),
|
|
(
|
|
SensorDeviceClass.TIMESTAMP,
|
|
"2021-01-09T12:00:00",
|
|
"2021-01-09T12:00:00",
|
|
),
|
|
],
|
|
)
|
|
async def test_deprecated_datetime_str(
|
|
hass, caplog, enable_custom_integrations, device_class, native_value, state_value
|
|
):
|
|
"""Test warning on deprecated str for a date(time) value."""
|
|
platform = getattr(hass.components, "test.sensor")
|
|
platform.init(empty=True)
|
|
platform.ENTITIES["0"] = platform.MockSensor(
|
|
name="Test", native_value=native_value, device_class=device_class
|
|
)
|
|
|
|
entity0 = platform.ENTITIES["0"]
|
|
assert await async_setup_component(hass, "sensor", {"sensor": {"platform": "test"}})
|
|
await hass.async_block_till_done()
|
|
|
|
state = hass.states.get(entity0.entity_id)
|
|
assert state.state == state_value
|
|
assert (
|
|
"is providing a string for its state, while the device class is "
|
|
f"'{device_class}', this is not valid and will be unsupported "
|
|
"from Home Assistant 2022.2."
|
|
) in caplog.text
|
|
|
|
|
|
async def test_reject_timezoneless_datetime_str(
|
|
hass, caplog, enable_custom_integrations
|
|
):
|
|
"""Test rejection of timezone-less datetime objects as timestamp."""
|
|
test_timestamp = datetime(2017, 12, 19, 18, 29, 42, tzinfo=None)
|
|
platform = getattr(hass.components, "test.sensor")
|
|
platform.init(empty=True)
|
|
platform.ENTITIES["0"] = platform.MockSensor(
|
|
name="Test",
|
|
native_value=test_timestamp,
|
|
device_class=SensorDeviceClass.TIMESTAMP,
|
|
)
|
|
|
|
assert await async_setup_component(hass, "sensor", {"sensor": {"platform": "test"}})
|
|
await hass.async_block_till_done()
|
|
|
|
assert (
|
|
"Invalid datetime: sensor.test provides state '2017-12-19 18:29:42', "
|
|
"which is missing timezone information"
|
|
) in caplog.text
|