Remove legacy script mode and simplify remaining modes (#37729)
This commit is contained in:
1 parent
8a8289b1a4
commit
63e55bff52
11 files changed
+407
-959
No files matched your search
@@ -17,6 +17,7 @@ from homeassistant.const import (
|
||||
)
|
||||
from homeassistant.core import Context, callback, split_entity_id
|
||||
from homeassistant.exceptions import ServiceNotFound
|
||||
from homeassistant.helpers.event import async_track_state_change
|
||||
from homeassistant.helpers.service import async_get_all_descriptions
|
||||
from homeassistant.loader import bind_hass
|
||||
from homeassistant.setup import async_setup_component, setup_component
|
||||
@@ -80,75 +81,6 @@ class TestScriptComponent(unittest.TestCase):
|
||||
"""Stop down everything that was started."""
|
||||
self.hass.stop()
|
||||
|
||||
def test_turn_on_service(self):
|
||||
"""Verify that the turn_on service."""
|
||||
event = "test_event"
|
||||
events = []
|
||||
|
||||
@callback
|
||||
def record_event(event):
|
||||
"""Add recorded event to set."""
|
||||
events.append(event)
|
||||
|
||||
self.hass.bus.listen(event, record_event)
|
||||
|
||||
assert setup_component(
|
||||
self.hass,
|
||||
"script",
|
||||
{
|
||||
"script": {
|
||||
"test": {"sequence": [{"delay": {"seconds": 5}}, {"event": event}]}
|
||||
}
|
||||
},
|
||||
)
|
||||
|
||||
turn_on(self.hass, ENTITY_ID)
|
||||
self.hass.block_till_done()
|
||||
assert script.is_on(self.hass, ENTITY_ID)
|
||||
assert 0 == len(events)
|
||||
|
||||
# Calling turn_on a second time should not advance the script
|
||||
turn_on(self.hass, ENTITY_ID)
|
||||
self.hass.block_till_done()
|
||||
assert 0 == len(events)
|
||||
|
||||
turn_off(self.hass, ENTITY_ID)
|
||||
self.hass.block_till_done()
|
||||
assert not script.is_on(self.hass, ENTITY_ID)
|
||||
assert 0 == len(events)
|
||||
|
||||
def test_toggle_service(self):
|
||||
"""Test the toggling of a service."""
|
||||
event = "test_event"
|
||||
events = []
|
||||
|
||||
@callback
|
||||
def record_event(event):
|
||||
"""Add recorded event to set."""
|
||||
events.append(event)
|
||||
|
||||
self.hass.bus.listen(event, record_event)
|
||||
|
||||
assert setup_component(
|
||||
self.hass,
|
||||
"script",
|
||||
{
|
||||
"script": {
|
||||
"test": {"sequence": [{"delay": {"seconds": 5}}, {"event": event}]}
|
||||
}
|
||||
},
|
||||
)
|
||||
|
||||
toggle(self.hass, ENTITY_ID)
|
||||
self.hass.block_till_done()
|
||||
assert script.is_on(self.hass, ENTITY_ID)
|
||||
assert 0 == len(events)
|
||||
|
||||
toggle(self.hass, ENTITY_ID)
|
||||
self.hass.block_till_done()
|
||||
assert not script.is_on(self.hass, ENTITY_ID)
|
||||
assert 0 == len(events)
|
||||
|
||||
def test_passing_variables(self):
|
||||
"""Test different ways of passing in variables."""
|
||||
calls = []
|
||||
@@ -195,17 +127,58 @@ class TestScriptComponent(unittest.TestCase):
|
||||
assert calls[1].data["hello"] == "universe"
|
||||
|
||||
|
||||
@pytest.mark.parametrize("toggle", [False, True])
|
||||
async def test_turn_on_off_toggle(hass, toggle):
|
||||
"""Verify turn_on, turn_off & toggle services."""
|
||||
event = "test_event"
|
||||
event_mock = Mock()
|
||||
|
||||
hass.bus.async_listen(event, event_mock)
|
||||
|
||||
was_on = False
|
||||
|
||||
@callback
|
||||
def state_listener(entity_id, old_state, new_state):
|
||||
nonlocal was_on
|
||||
was_on = True
|
||||
|
||||
async_track_state_change(hass, ENTITY_ID, state_listener, to_state="on")
|
||||
|
||||
if toggle:
|
||||
turn_off_step = {"service": "script.toggle", "entity_id": ENTITY_ID}
|
||||
else:
|
||||
turn_off_step = {"service": "script.turn_off", "entity_id": ENTITY_ID}
|
||||
assert await async_setup_component(
|
||||
hass,
|
||||
"script",
|
||||
{
|
||||
"script": {
|
||||
"test": {
|
||||
"sequence": [{"event": event}, turn_off_step, {"event": event}]
|
||||
}
|
||||
}
|
||||
},
|
||||
)
|
||||
|
||||
assert not script.is_on(hass, ENTITY_ID)
|
||||
|
||||
if toggle:
|
||||
await hass.services.async_call(
|
||||
DOMAIN, SERVICE_TOGGLE, {ATTR_ENTITY_ID: ENTITY_ID}
|
||||
)
|
||||
else:
|
||||
await hass.services.async_call(DOMAIN, split_entity_id(ENTITY_ID)[1])
|
||||
await hass.async_block_till_done()
|
||||
|
||||
assert not script.is_on(hass, ENTITY_ID)
|
||||
assert was_on
|
||||
assert 1 == event_mock.call_count
|
||||
|
||||
|
||||
invalid_configs = [
|
||||
{"test": {}},
|
||||
{"test hello world": {"sequence": [{"event": "bla"}]}},
|
||||
{"test": {"sequence": {"event": "test_event", "service": "homeassistant.turn_on"}}},
|
||||
{"test": {"sequence": [], "mode": "parallel", "queue_size": 5}},
|
||||
{
|
||||
"test": {
|
||||
"mode": "legacy",
|
||||
"sequence": [{"repeat": {"count": 5, "sequence": []}}],
|
||||
}
|
||||
},
|
||||
]
|
||||
|
||||
|
||||
@@ -222,8 +195,29 @@ async def test_setup_with_invalid_configs(hass, value):
|
||||
@pytest.mark.parametrize("running", ["no", "same", "different"])
|
||||
async def test_reload_service(hass, running):
|
||||
"""Verify the reload service."""
|
||||
event = "test_event"
|
||||
event_flag = asyncio.Event()
|
||||
|
||||
@callback
|
||||
def event_handler(event):
|
||||
event_flag.set()
|
||||
|
||||
hass.bus.async_listen_once(event, event_handler)
|
||||
hass.states.async_set("test.script", "off")
|
||||
|
||||
assert await async_setup_component(
|
||||
hass, "script", {"script": {"test": {"sequence": [{"delay": {"seconds": 5}}]}}}
|
||||
hass,
|
||||
"script",
|
||||
{
|
||||
"script": {
|
||||
"test": {
|
||||
"sequence": [
|
||||
{"event": event},
|
||||
{"wait_template": "{{ is_state('test.script', 'on') }}"},
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
)
|
||||
|
||||
assert hass.states.get(ENTITY_ID) is not None
|
||||
@@ -232,7 +226,7 @@ async def test_reload_service(hass, running):
|
||||
if running != "no":
|
||||
_, object_id = split_entity_id(ENTITY_ID)
|
||||
await hass.services.async_call(DOMAIN, object_id)
|
||||
await hass.async_block_till_done()
|
||||
await asyncio.wait_for(event_flag.wait(), 1)
|
||||
|
||||
assert script.is_on(hass, ENTITY_ID)
|
||||
|
||||
@@ -486,14 +480,6 @@ async def test_config_basic(hass):
|
||||
assert test_script.attributes["icon"] == "mdi:party"
|
||||
|
||||
|
||||
async def test_config_legacy(hass, caplog):
|
||||
"""Test config defaulting to legacy mode."""
|
||||
assert await async_setup_component(
|
||||
hass, "script", {"script": {"test_script": {"sequence": []}}}
|
||||
)
|
||||
assert "To continue using previous behavior, which is now deprecated" in caplog.text
|
||||
|
||||
|
||||
async def test_logbook_humanify_script_started_event(hass):
|
||||
"""Test humanifying script started event."""
|
||||
hass.config.components.add("recorder")
|
||||
|
||||
Reference in new issue
Block a user