esphome/tests/component_tests/template/test_template_climate.py

"""Tests for template climate config validation."""

import pytest

from esphome import config_validation as cv
from esphome.components.template.climate import (
    CONF_SET_TARGET_HUMIDITY_ACTION,
    CONF_SET_TARGET_TEMPERATURE_ACTION,
    CONF_SET_TARGET_TEMPERATURE_HIGH_ACTION,
    CONF_SET_TARGET_TEMPERATURE_LOW_ACTION,
    CONF_SUPPORTS_CURRENT_HUMIDITY,
    CONF_SUPPORTS_CURRENT_TEMPERATURE,
    CONF_SUPPORTS_TARGET_HUMIDITY,
    CONF_SUPPORTS_TWO_POINT_TARGET_TEMPERATURE,
    CONF_TARGET_HUMIDITY,
    _resolve_supports,
    _validate_initial_state,
    _validate_set_actions,
)
from esphome.const import (
    CONF_HUMIDITY_SENSOR,
    CONF_INITIAL_STATE,
    CONF_SENSOR,
    CONF_TARGET_TEMPERATURE,
    CONF_TARGET_TEMPERATURE_HIGH,
    CONF_TARGET_TEMPERATURE_LOW,
)
from esphome.types import ConfigType


def test_supports_current_temperature_derived_from_sensor() -> None:
    config: ConfigType = {CONF_SENSOR: "some_sensor"}
    assert _resolve_supports(config)[CONF_SUPPORTS_CURRENT_TEMPERATURE] is True


def test_supports_current_temperature_false_without_sensor() -> None:
    assert _resolve_supports({})[CONF_SUPPORTS_CURRENT_TEMPERATURE] is False


def test_supports_current_temperature_explicit_true_without_sensor_allowed() -> None:
    # The value can still be reported with climate.template.publish.
    config: ConfigType = {CONF_SUPPORTS_CURRENT_TEMPERATURE: True}
    assert _resolve_supports(config)[CONF_SUPPORTS_CURRENT_TEMPERATURE] is True


def test_supports_current_temperature_false_with_sensor_rejected() -> None:
    config: ConfigType = {
        CONF_SENSOR: "some_sensor",
        CONF_SUPPORTS_CURRENT_TEMPERATURE: False,
    }
    with pytest.raises(cv.Invalid, match="cannot be false"):
        _resolve_supports(config)


def test_supports_current_humidity_false_with_sensor_rejected() -> None:
    config: ConfigType = {
        CONF_HUMIDITY_SENSOR: "some_sensor",
        CONF_SUPPORTS_CURRENT_HUMIDITY: False,
    }
    with pytest.raises(cv.Invalid, match="cannot be false"):
        _resolve_supports(config)


def test_two_point_derived_from_set_actions() -> None:
    config: ConfigType = {
        CONF_SET_TARGET_TEMPERATURE_LOW_ACTION: [{}],
        CONF_SET_TARGET_TEMPERATURE_HIGH_ACTION: [{}],
    }
    assert _resolve_supports(config)[CONF_SUPPORTS_TWO_POINT_TARGET_TEMPERATURE] is True


def test_two_point_false_with_set_action_rejected() -> None:
    config: ConfigType = {
        CONF_SET_TARGET_TEMPERATURE_LOW_ACTION: [{}],
        CONF_SUPPORTS_TWO_POINT_TARGET_TEMPERATURE: False,
    }
    with pytest.raises(cv.Invalid, match="cannot be false"):
        _resolve_supports(config)


def test_target_humidity_derived_from_set_action() -> None:
    config: ConfigType = {CONF_SET_TARGET_HUMIDITY_ACTION: [{}]}
    assert _resolve_supports(config)[CONF_SUPPORTS_TARGET_HUMIDITY] is True


def test_set_target_temperature_low_requires_high() -> None:
    config: ConfigType = {CONF_SET_TARGET_TEMPERATURE_LOW_ACTION: [{}]}
    with pytest.raises(cv.Invalid, match="must be used together"):
        _validate_set_actions(config)


def test_set_target_temperature_conflicts_with_two_point_actions() -> None:
    config: ConfigType = {
        CONF_SET_TARGET_TEMPERATURE_ACTION: [{}],
        CONF_SET_TARGET_TEMPERATURE_LOW_ACTION: [{}],
        CONF_SET_TARGET_TEMPERATURE_HIGH_ACTION: [{}],
    }
    with pytest.raises(cv.Invalid, match="cannot be used together"):
        _validate_set_actions(config)


def test_initial_state_target_temperature_rejected_with_two_point() -> None:
    config: ConfigType = {
        CONF_SUPPORTS_TWO_POINT_TARGET_TEMPERATURE: True,
        CONF_SUPPORTS_TARGET_HUMIDITY: False,
        CONF_INITIAL_STATE: {CONF_TARGET_TEMPERATURE: 21.0},
    }
    with pytest.raises(cv.Invalid, match="is not available"):
        _validate_initial_state(config)


def test_initial_state_two_point_values_rejected_without_two_point() -> None:
    config: ConfigType = {
        CONF_SUPPORTS_TWO_POINT_TARGET_TEMPERATURE: False,
        CONF_SUPPORTS_TARGET_HUMIDITY: False,
        CONF_INITIAL_STATE: {
            CONF_TARGET_TEMPERATURE_LOW: 18.0,
            CONF_TARGET_TEMPERATURE_HIGH: 24.0,
        },
    }
    with pytest.raises(cv.Invalid, match="requires"):
        _validate_initial_state(config)


def test_initial_state_target_humidity_rejected_without_support() -> None:
    config: ConfigType = {
        CONF_SUPPORTS_TWO_POINT_TARGET_TEMPERATURE: False,
        CONF_SUPPORTS_TARGET_HUMIDITY: False,
        CONF_INITIAL_STATE: {CONF_TARGET_HUMIDITY: 50},
    }
    with pytest.raises(cv.Invalid, match="requires"):
        _validate_initial_state(config)


def test_initial_state_matching_two_point_accepted() -> None:
    config: ConfigType = {
        CONF_SUPPORTS_TWO_POINT_TARGET_TEMPERATURE: True,
        CONF_SUPPORTS_TARGET_HUMIDITY: True,
        CONF_INITIAL_STATE: {
            CONF_TARGET_TEMPERATURE_LOW: 18.0,
            CONF_TARGET_TEMPERATURE_HIGH: 24.0,
            CONF_TARGET_HUMIDITY: 50,
        },
    }
    assert _validate_initial_state(config) is config