55b036ec5e
* improve device_automation trigger validation
Validates the trigger configuration against the device_trigger schema before trying to access any of the properties in order to provide better error messages.
Updates the error message to include an explicit indication that the error is coming from a trigger configuration. The inner error message from the validator can be accessed by viewing the stack trace.
Add test case for trigger missing domain.
Make action and condition validation consistent with trigger. This is not strictly necessary, but should be helpful for certain use cases that bypass some of the outer validation.
Removed redundant schema elements from humidifier device_trigger.
**Blueprint with missing `domain`**
```
2022-07-12 06:02:18.351 ERROR (MainThread) [homeassistant.setup] Error during setup of component automation
Traceback (most recent call last):
File "/workspaces/core/homeassistant/setup.py", line 235, in _async_setup_component
result = await task
File "/workspaces/core/homeassistant/components/automation/__init__.py", line 241, in async_setup
if not await _async_process_config(hass, config, component):
File "/workspaces/core/homeassistant/components/automation/__init__.py", line 648, in _async_process_config
await async_validate_config_item(hass, raw_config),
File "/workspaces/core/homeassistant/components/automation/config.py", line 74, in async_validate_config_item
config[CONF_TRIGGER] = await async_validate_trigger_config(
File "/workspaces/core/homeassistant/helpers/trigger.py", line 59, in async_validate_trigger_config
conf = await platform.async_validate_trigger_config(hass, conf)
File "/workspaces/core/homeassistant/components/device_automation/trigger.py", line 67, in async_validate_trigger_config
hass, config[CONF_DOMAIN], DeviceAutomationType.TRIGGER
KeyError: 'domain'
```
**Blueprint with missing `property` (specific to zwave_js event schema)**
```
2022-07-12 06:09:54.206 ERROR (MainThread) [homeassistant.components.automation] Blueprint Missing Property generated invalid automation with inputs OrderedDict([('control_switch', '498be56d796836a67406e9ad373d23db')]): required key not provided @ data['property']. Got None
```
**Blueprint with missing `domain`**
```
2022-07-12 06:12:16.080 ERROR (MainThread) [homeassistant.components.automation] Blueprint Missing Domain generated invalid automation with inputs OrderedDict([('control_switch', '498be56d796836a67406e9ad373d23db')]): invalid trigger configuration: required key not provided @ data['domain']. Got <homeassistant.components.blueprint.models.BlueprintInputs object at 0x7f581e097820>
```
**Blueprint with missing `property` (specific to zwave_js event schema)**
```
2022-07-12 06:12:16.680 ERROR (MainThread) [homeassistant.components.automation] Blueprint Missing Property generated invalid automation with inputs OrderedDict([('control_switch', '498be56d796836a67406e9ad373d23db')]): invalid trigger configuration: required key not provided @ data['property']. Got <homeassistant.components.blueprint.models.BlueprintInputs object at 0x7f581c0dc9d0>
```
* Revert humifidier TRIGGER_SCHEMA change.
72 lines
2.5 KiB
Python
72 lines
2.5 KiB
Python
"""Validate device conditions."""
|
|
from __future__ import annotations
|
|
|
|
from typing import TYPE_CHECKING, Any, Protocol, cast
|
|
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.const import CONF_DOMAIN
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.helpers import config_validation as cv
|
|
from homeassistant.helpers.typing import ConfigType
|
|
|
|
from . import DeviceAutomationType, async_get_device_automation_platform
|
|
from .exceptions import InvalidDeviceAutomationConfig
|
|
|
|
if TYPE_CHECKING:
|
|
from homeassistant.helpers import condition
|
|
|
|
|
|
class DeviceAutomationConditionProtocol(Protocol):
|
|
"""Define the format of device_condition modules.
|
|
|
|
Each module must define either CONDITION_SCHEMA or async_validate_condition_config.
|
|
"""
|
|
|
|
CONDITION_SCHEMA: vol.Schema
|
|
|
|
async def async_validate_condition_config(
|
|
self, hass: HomeAssistant, config: ConfigType
|
|
) -> ConfigType:
|
|
"""Validate config."""
|
|
|
|
def async_condition_from_config(
|
|
self, hass: HomeAssistant, config: ConfigType
|
|
) -> condition.ConditionCheckerType:
|
|
"""Evaluate state based on configuration."""
|
|
|
|
async def async_get_condition_capabilities(
|
|
self, hass: HomeAssistant, config: ConfigType
|
|
) -> dict[str, vol.Schema]:
|
|
"""List condition capabilities."""
|
|
|
|
async def async_get_conditions(
|
|
self, hass: HomeAssistant, device_id: str
|
|
) -> list[dict[str, Any]]:
|
|
"""List conditions."""
|
|
|
|
|
|
async def async_validate_condition_config(
|
|
hass: HomeAssistant, config: ConfigType
|
|
) -> ConfigType:
|
|
"""Validate device condition config."""
|
|
try:
|
|
config = cv.DEVICE_CONDITION_SCHEMA(config)
|
|
platform = await async_get_device_automation_platform(
|
|
hass, config[CONF_DOMAIN], DeviceAutomationType.CONDITION
|
|
)
|
|
if hasattr(platform, "async_validate_condition_config"):
|
|
return await platform.async_validate_condition_config(hass, config)
|
|
return cast(ConfigType, platform.CONDITION_SCHEMA(config))
|
|
except (vol.Invalid, InvalidDeviceAutomationConfig) as err:
|
|
raise vol.Invalid("invalid condition configuration: " + str(err)) from err
|
|
|
|
|
|
async def async_condition_from_config(
|
|
hass: HomeAssistant, config: ConfigType
|
|
) -> condition.ConditionCheckerType:
|
|
"""Test a device condition."""
|
|
platform = await async_get_device_automation_platform(
|
|
hass, config[CONF_DOMAIN], DeviceAutomationType.CONDITION
|
|
)
|
|
return platform.async_condition_from_config(hass, config)
|