migrate condition

Author: jeyrb

CHANGELOG.md

@@ -8,6 +8,7 @@ Fixes and improvements contributed by [@lollox80](https://github.com/lollox80)
 - URLs in action groups allow `homeassistant://` deep links
 - Suppress repeating `condition_variables` from archived envelopes
 - Expand templated values in `data` for archiving
+- Migrate old `condition` to `conditions`
 ## 1.11.0
 ### Dupe Checking
 - `force_resend` can be set in `data` section to override dupe handling ( contribution by [@lollox80](https://github.com/lollox80))

custom_components/supernotify/delivery.py

@@ -7,7 +7,6 @@
     ATTR_NAME,
     CONF_ACTION,
     CONF_ALIAS,
-    CONF_CONDITION,
     CONF_CONDITIONS,
     CONF_DEBUG,
     CONF_ENABLED,
@@ -77,8 +76,6 @@ def __init__(self, name: str, conf: ConfigType, transport: "Transport") -> None:
         self.enabled: bool = conf.get(CONF_ENABLED, self.transport.enabled)
         self.occupancy: str = conf.get(CONF_OCCUPANCY, OCCUPANCY_ALL)
         self.conditions_config: list[ConfigType] | None = conf.get(CONF_CONDITIONS)
-        if not conf.get(CONF_CONDITIONS) and conf.get(CONF_CONDITION):
-            self.conditions_config = conf.get(CONF_CONDITION)
         self.conditions: ConditionsFunc | None = None
         self.transport_data: dict[str, Any] = {}
         if self.options.get(OPTION_TARGET_SELECT):

custom_components/supernotify/scenario.py

@@ -23,7 +23,7 @@
 # type: ignore[attr-defined,unused-ignore]
 from homeassistant.components.trace import async_store_trace
 from homeassistant.components.trace.models import ActionTrace
-from homeassistant.const import ATTR_FRIENDLY_NAME, ATTR_NAME, CONF_ALIAS, CONF_CONDITION, CONF_CONDITIONS
+from homeassistant.const import ATTR_FRIENDLY_NAME, ATTR_NAME, CONF_ALIAS, CONF_CONDITIONS
 from homeassistant.core import Context, HomeAssistant
 from homeassistant.helpers.typing import ConfigType
 
@@ -65,8 +65,6 @@ def __init__(
         self.alias: str | None = scenario_definition.get(CONF_ALIAS)
         self.conditions: ConditionsFunc | None = None
         self.conditions_config: list[ConfigType] | None = scenario_definition.get(CONF_CONDITIONS)
-        if not scenario_definition.get(CONF_CONDITIONS) and scenario_definition.get(CONF_CONDITION):
-            self.conditions_config = scenario_definition.get(CONF_CONDITION)
         self.media: dict[str, Any] | None = scenario_definition.get(CONF_MEDIA)
         self.action_groups: list[str] = scenario_definition.get(CONF_ACTION_GROUP_NAMES, [])
         self._config_delivery: dict[str, DeliveryCustomization]

custom_components/supernotify/schema.py

@@ -293,8 +293,17 @@ def validate_scenario_names(scenarios: dict) -> dict:
 })
 
 
+def _migrate_condition(config: dict) -> dict:
+    """Migrate deprecated 'condition' key to 'conditions'."""
+    if CONF_CONDITION in config:
+        if CONF_CONDITIONS not in config:
+            config = {**config, CONF_CONDITIONS: config[CONF_CONDITION]}
+        config = {k: v for k, v in config.items() if k != CONF_CONDITION}
+    return config
+
+
 DELIVERY_SCHEMA = vol.All(
-    cv.deprecated(key=CONF_CONDITION),
+    _migrate_condition,
     DELIVERY_CONFIG_SCHEMA.extend({
         vol.Required(CONF_TRANSPORT): vol.In(TRANSPORT_VALUES),
         vol.Optional(CONF_ALIAS): cv.string,
@@ -303,7 +312,6 @@ def validate_scenario_names(scenarios: dict) -> dict:
         vol.Optional(CONF_TITLE): vol.Any(None, cv.string),
         vol.Optional(CONF_ENABLED): cv.boolean,
         vol.Optional(CONF_OCCUPANCY, default=OCCUPANCY_ALL): vol.In(OCCUPANCY_VALUES),
-        vol.Optional(CONF_CONDITION): cv.CONDITIONS_SCHEMA,
         vol.Optional(CONF_CONDITIONS): cv.CONDITIONS_SCHEMA,
     }),
 )
@@ -367,12 +375,11 @@ def validate_scenario_names(scenarios: dict) -> dict:
 
 
 SCENARIO_SCHEMA = vol.All(
-    cv.deprecated(key=CONF_CONDITION),
+    _migrate_condition,
     cv.deprecated(key="delivery_selection"),
     vol.Schema({
         vol.Optional(CONF_ALIAS): cv.string,
         vol.Optional(CONF_ENABLED, default=True): cv.boolean,
-        vol.Optional(CONF_CONDITION): cv.CONDITIONS_SCHEMA,
         vol.Optional(CONF_CONDITIONS): cv.CONDITIONS_SCHEMA,
         vol.Optional(CONF_MEDIA): MEDIA_SCHEMA,
         vol.Optional(CONF_ACTION_GROUP_NAMES, default=[]): vol.All(cv.ensure_list, [cv.string]),

tests/components/supernotify/test_delivery.py

@@ -1,6 +1,6 @@
 from unittest.mock import AsyncMock, Mock
 
-from homeassistant.const import CONF_ACTION, CONF_CONDITION
+from homeassistant.const import CONF_ACTION, CONF_CONDITIONS
 
 from custom_components.supernotify.const import (
     CONF_DELIVERY_DEFAULTS,
@@ -73,14 +73,14 @@ async def test_repair_for_bad_conditions(mock_context: Context) -> None:
     mock_context.hass_api.build_conditions = AsyncMock(side_effect=Exception("integrations"))  # type: ignore
     uut = Delivery(
         "generic",
-        {CONF_CONDITION: {"condition": "xor"}},
+        {CONF_CONDITIONS: [{"condition": "xor"}]},
         GenericTransport(mock_context, {CONF_DELIVERY_DEFAULTS: {CONF_ACTION: "notify.notify"}}),
     )
     assert await uut.initialize(mock_context) is False
     mock_context.hass_api.raise_issue.assert_called_with(  # type: ignore
         "delivery_generic_invalid_condition",
         issue_key="delivery_invalid_condition",
-        issue_map={"delivery": "generic", "condition": "{'condition': 'xor'}", "exception": "integrations"},
+        issue_map={"delivery": "generic", "condition": "[{'condition': 'xor'}]", "exception": "integrations"},
         learn_more_url="https://supernotify.rhizomatics.org.uk/deliveries",
     )