Add tests asserting air_quality trigger features (#168377)

Author: emontnemery

tests/components/air_quality/test_trigger.py

@@ -25,6 +25,7 @@
     assert_trigger_behavior_first,
     assert_trigger_behavior_last,
     assert_trigger_gated_by_labs_flag,
+    assert_trigger_options_supported,
     parametrize_numerical_state_value_changed_trigger_states,
     parametrize_numerical_state_value_crossed_threshold_trigger_states,
     parametrize_target_entities,
@@ -95,6 +96,83 @@ async def test_air_quality_triggers_gated_by_labs_flag(
     await assert_trigger_gated_by_labs_flag(hass, caplog, trigger_key)
 
 
+_CHANGED_THRESHOLD = {"threshold": {"type": "any"}}
+_PLAIN_CROSSED_THRESHOLD = {"threshold": {"type": "above", "value": {"number": 50}}}
+_PPB_CROSSED_THRESHOLD = {
+    "threshold": {
+        "type": "above",
+        "value": {
+            "number": 50,
+            "unit_of_measurement": CONCENTRATION_PARTS_PER_BILLION,
+        },
+    }
+}
+_UGM3_CROSSED_THRESHOLD = {
+    "threshold": {
+        "type": "above",
+        "value": {
+            "number": 50,
+            "unit_of_measurement": CONCENTRATION_MICROGRAMS_PER_CUBIC_METER,
+        },
+    }
+}
+
+
+@pytest.mark.usefixtures("enable_labs_preview_features")
+@pytest.mark.parametrize(
+    ("trigger_key", "base_options", "supports_behavior", "supports_duration"),
+    [
+        ("air_quality.gas_detected", {}, True, True),
+        ("air_quality.gas_cleared", {}, True, True),
+        ("air_quality.co_detected", {}, True, True),
+        ("air_quality.co_cleared", {}, True, True),
+        ("air_quality.smoke_detected", {}, True, True),
+        ("air_quality.smoke_cleared", {}, True, True),
+        ("air_quality.co_changed", _CHANGED_THRESHOLD, False, False),
+        ("air_quality.co_crossed_threshold", _UGM3_CROSSED_THRESHOLD, True, True),
+        ("air_quality.co2_changed", _CHANGED_THRESHOLD, False, False),
+        ("air_quality.co2_crossed_threshold", _PLAIN_CROSSED_THRESHOLD, True, True),
+        ("air_quality.pm1_changed", _CHANGED_THRESHOLD, False, False),
+        ("air_quality.pm1_crossed_threshold", _PLAIN_CROSSED_THRESHOLD, True, True),
+        ("air_quality.pm25_changed", _CHANGED_THRESHOLD, False, False),
+        ("air_quality.pm25_crossed_threshold", _PLAIN_CROSSED_THRESHOLD, True, True),
+        ("air_quality.pm4_changed", _CHANGED_THRESHOLD, False, False),
+        ("air_quality.pm4_crossed_threshold", _PLAIN_CROSSED_THRESHOLD, True, True),
+        ("air_quality.pm10_changed", _CHANGED_THRESHOLD, False, False),
+        ("air_quality.pm10_crossed_threshold", _PLAIN_CROSSED_THRESHOLD, True, True),
+        ("air_quality.ozone_changed", _CHANGED_THRESHOLD, False, False),
+        ("air_quality.ozone_crossed_threshold", _UGM3_CROSSED_THRESHOLD, True, True),
+        ("air_quality.voc_changed", _CHANGED_THRESHOLD, False, False),
+        ("air_quality.voc_crossed_threshold", _UGM3_CROSSED_THRESHOLD, True, True),
+        ("air_quality.voc_ratio_changed", _CHANGED_THRESHOLD, False, False),
+        ("air_quality.voc_ratio_crossed_threshold", _PPB_CROSSED_THRESHOLD, True, True),
+        ("air_quality.no_changed", _CHANGED_THRESHOLD, False, False),
+        ("air_quality.no_crossed_threshold", _UGM3_CROSSED_THRESHOLD, True, True),
+        ("air_quality.no2_changed", _CHANGED_THRESHOLD, False, False),
+        ("air_quality.no2_crossed_threshold", _UGM3_CROSSED_THRESHOLD, True, True),
+        ("air_quality.n2o_changed", _CHANGED_THRESHOLD, False, False),
+        ("air_quality.n2o_crossed_threshold", _PLAIN_CROSSED_THRESHOLD, True, True),
+        ("air_quality.so2_changed", _CHANGED_THRESHOLD, False, False),
+        ("air_quality.so2_crossed_threshold", _UGM3_CROSSED_THRESHOLD, True, True),
+    ],
+)
+async def test_air_quality_trigger_options_validation(
+    hass: HomeAssistant,
+    trigger_key: str,
+    base_options: dict[str, Any] | None,
+    supports_behavior: bool,
+    supports_duration: bool,
+) -> None:
+    """Test that air_quality triggers support the expected options."""
+    await assert_trigger_options_supported(
+        hass,
+        trigger_key,
+        base_options,
+        supports_behavior=supports_behavior,
+        supports_duration=supports_duration,
+    )
+
+
 @pytest.mark.usefixtures("enable_labs_preview_features")
 @pytest.mark.parametrize(
     ("trigger_target_config", "entity_id", "entities_in_target"),

tests/components/common.py

@@ -8,6 +8,7 @@
 from typing import Any, TypedDict
 
 import pytest
+import voluptuous as vol
 
 from homeassistant.const import (
     ATTR_AREA_ID,
@@ -1095,6 +1096,66 @@ async def assert_trigger_gated_by_labs_flag(
     ) in caplog.text
 
 
+async def _validate_trigger_options(
+    hass: HomeAssistant,
+    trigger: str,
+    options: dict[str, Any] | None,
+    *,
+    valid: bool,
+) -> None:
+    """Assert that a trigger accepts or rejects the given options during validation."""
+    trigger_config: dict[str, Any] = {
+        CONF_PLATFORM: trigger,
+        CONF_TARGET: {ATTR_LABEL_ID: "test_label"},
+    }
+    if options is not None:
+        trigger_config[CONF_OPTIONS] = options
+    if valid:
+        await async_validate_trigger_config(hass, [trigger_config])
+    else:
+        with pytest.raises(vol.Invalid):
+            await async_validate_trigger_config(hass, [trigger_config])
+
+
+async def assert_trigger_options_supported(
+    hass: HomeAssistant,
+    trigger: str,
+    base_options: dict[str, Any] | None,
+    *,
+    supports_behavior: bool,
+    supports_duration: bool,
+) -> None:
+    """Assert which options a trigger supports.
+
+    Tests that the trigger:
+    - Accepts the minimal config (base_options)
+    - Accepts/rejects behavior depending on supports_behavior
+    - Accepts/rejects duration depending on supports_duration
+    - Rejects unknown options
+    """
+    # Minimal config should always be valid
+    await _validate_trigger_options(hass, trigger, base_options, valid=True)
+
+    def _merge(extra: dict[str, Any]) -> dict[str, Any]:
+        return {**(base_options or {}), **extra}
+
+    # Behavior
+    for behavior in ("any", "first", "last"):
+        await _validate_trigger_options(
+            hass, trigger, _merge({"behavior": behavior}), valid=supports_behavior
+        )
+
+    # Duration
+    await _validate_trigger_options(
+        hass, trigger, _merge({"for": {"seconds": 5}}), valid=supports_duration
+    )
+
+    # Unknown option should always be rejected
+    await _validate_trigger_options(
+        hass, trigger, _merge({"unknown_option": True}), valid=False
+    )
+
+
 async def assert_condition_behavior_any(
     hass: HomeAssistant,
     *,