602 lines
18 KiB
Python
602 lines
18 KiB
Python
"""The tests for the Script component."""
|
|
# pylint: disable=protected-access
|
|
import asyncio
|
|
import unittest
|
|
|
|
import pytest
|
|
|
|
from homeassistant.components import logbook, script
|
|
from homeassistant.components.script import DOMAIN, EVENT_SCRIPT_STARTED
|
|
from homeassistant.const import (
|
|
ATTR_ENTITY_ID,
|
|
ATTR_NAME,
|
|
SERVICE_RELOAD,
|
|
SERVICE_TOGGLE,
|
|
SERVICE_TURN_OFF,
|
|
SERVICE_TURN_ON,
|
|
)
|
|
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
|
|
|
|
from tests.async_mock import Mock, patch
|
|
from tests.common import get_test_home_assistant
|
|
from tests.components.logbook.test_init import MockLazyEventPartialState
|
|
|
|
ENTITY_ID = "script.test"
|
|
|
|
|
|
@bind_hass
|
|
def turn_on(hass, entity_id, variables=None, context=None):
|
|
"""Turn script on.
|
|
|
|
This is a legacy helper method. Do not use it for new tests.
|
|
"""
|
|
_, object_id = split_entity_id(entity_id)
|
|
|
|
hass.services.call(DOMAIN, object_id, variables, context=context)
|
|
|
|
|
|
@bind_hass
|
|
def turn_off(hass, entity_id):
|
|
"""Turn script on.
|
|
|
|
This is a legacy helper method. Do not use it for new tests.
|
|
"""
|
|
hass.services.call(DOMAIN, SERVICE_TURN_OFF, {ATTR_ENTITY_ID: entity_id})
|
|
|
|
|
|
@bind_hass
|
|
def toggle(hass, entity_id):
|
|
"""Toggle the script.
|
|
|
|
This is a legacy helper method. Do not use it for new tests.
|
|
"""
|
|
hass.services.call(DOMAIN, SERVICE_TOGGLE, {ATTR_ENTITY_ID: entity_id})
|
|
|
|
|
|
@bind_hass
|
|
def reload(hass):
|
|
"""Reload script component.
|
|
|
|
This is a legacy helper method. Do not use it for new tests.
|
|
"""
|
|
hass.services.call(DOMAIN, SERVICE_RELOAD)
|
|
|
|
|
|
class TestScriptComponent(unittest.TestCase):
|
|
"""Test the Script component."""
|
|
|
|
# pylint: disable=invalid-name
|
|
def setUp(self):
|
|
"""Set up things to be run when tests are started."""
|
|
self.hass = get_test_home_assistant()
|
|
|
|
self.addCleanup(self.tear_down_cleanup)
|
|
|
|
def tear_down_cleanup(self):
|
|
"""Stop down everything that was started."""
|
|
self.hass.stop()
|
|
|
|
def test_passing_variables(self):
|
|
"""Test different ways of passing in variables."""
|
|
calls = []
|
|
context = Context()
|
|
|
|
@callback
|
|
def record_call(service):
|
|
"""Add recorded event to set."""
|
|
calls.append(service)
|
|
|
|
self.hass.services.register("test", "script", record_call)
|
|
|
|
assert setup_component(
|
|
self.hass,
|
|
"script",
|
|
{
|
|
"script": {
|
|
"test": {
|
|
"sequence": {
|
|
"service": "test.script",
|
|
"data_template": {"hello": "{{ greeting }}"},
|
|
}
|
|
}
|
|
}
|
|
},
|
|
)
|
|
|
|
turn_on(self.hass, ENTITY_ID, {"greeting": "world"}, context=context)
|
|
|
|
self.hass.block_till_done()
|
|
|
|
assert len(calls) == 1
|
|
assert calls[0].context is context
|
|
assert calls[0].data["hello"] == "world"
|
|
|
|
self.hass.services.call(
|
|
"script", "test", {"greeting": "universe"}, context=context
|
|
)
|
|
|
|
self.hass.block_till_done()
|
|
|
|
assert len(calls) == 2
|
|
assert calls[1].context is context
|
|
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"}}},
|
|
]
|
|
|
|
|
|
@pytest.mark.parametrize("value", invalid_configs)
|
|
async def test_setup_with_invalid_configs(hass, value):
|
|
"""Test setup with invalid configs."""
|
|
assert not await async_setup_component(
|
|
hass, "script", {"script": value}
|
|
), f"Script loaded with wrong config {value}"
|
|
|
|
assert 0 == len(hass.states.async_entity_ids("script"))
|
|
|
|
|
|
@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": [
|
|
{"event": event},
|
|
{"wait_template": "{{ is_state('test.script', 'on') }}"},
|
|
]
|
|
}
|
|
}
|
|
},
|
|
)
|
|
|
|
assert hass.states.get(ENTITY_ID) is not None
|
|
assert hass.services.has_service(script.DOMAIN, "test")
|
|
|
|
if running != "no":
|
|
_, object_id = split_entity_id(ENTITY_ID)
|
|
await hass.services.async_call(DOMAIN, object_id)
|
|
await asyncio.wait_for(event_flag.wait(), 1)
|
|
|
|
assert script.is_on(hass, ENTITY_ID)
|
|
|
|
object_id = "test" if running == "same" else "test2"
|
|
with patch(
|
|
"homeassistant.config.load_yaml_config_file",
|
|
return_value={"script": {object_id: {"sequence": [{"delay": {"seconds": 5}}]}}},
|
|
):
|
|
await hass.services.async_call(DOMAIN, SERVICE_RELOAD, blocking=True)
|
|
await hass.async_block_till_done()
|
|
|
|
if running != "same":
|
|
assert hass.states.get(ENTITY_ID) is None
|
|
assert not hass.services.has_service(script.DOMAIN, "test")
|
|
|
|
assert hass.states.get("script.test2") is not None
|
|
assert hass.services.has_service(script.DOMAIN, "test2")
|
|
|
|
else:
|
|
assert hass.states.get(ENTITY_ID) is not None
|
|
assert hass.services.has_service(script.DOMAIN, "test")
|
|
|
|
|
|
async def test_service_descriptions(hass):
|
|
"""Test that service descriptions are loaded and reloaded correctly."""
|
|
# Test 1: has "description" but no "fields"
|
|
assert await async_setup_component(
|
|
hass,
|
|
"script",
|
|
{
|
|
"script": {
|
|
"test": {
|
|
"description": "test description",
|
|
"sequence": [{"delay": {"seconds": 5}}],
|
|
}
|
|
}
|
|
},
|
|
)
|
|
|
|
descriptions = await async_get_all_descriptions(hass)
|
|
|
|
assert descriptions[DOMAIN]["test"]["description"] == "test description"
|
|
assert not descriptions[DOMAIN]["test"]["fields"]
|
|
|
|
# Test 2: has "fields" but no "description"
|
|
with patch(
|
|
"homeassistant.config.load_yaml_config_file",
|
|
return_value={
|
|
"script": {
|
|
"test": {
|
|
"fields": {
|
|
"test_param": {
|
|
"description": "test_param description",
|
|
"example": "test_param example",
|
|
}
|
|
},
|
|
"sequence": [{"delay": {"seconds": 5}}],
|
|
}
|
|
}
|
|
},
|
|
):
|
|
await hass.services.async_call(DOMAIN, SERVICE_RELOAD, blocking=True)
|
|
|
|
descriptions = await async_get_all_descriptions(hass)
|
|
|
|
assert descriptions[script.DOMAIN]["test"]["description"] == ""
|
|
assert (
|
|
descriptions[script.DOMAIN]["test"]["fields"]["test_param"]["description"]
|
|
== "test_param description"
|
|
)
|
|
assert (
|
|
descriptions[script.DOMAIN]["test"]["fields"]["test_param"]["example"]
|
|
== "test_param example"
|
|
)
|
|
|
|
|
|
async def test_shared_context(hass):
|
|
"""Test that the shared context is passed down the chain."""
|
|
event = "test_event"
|
|
context = Context()
|
|
|
|
event_mock = Mock()
|
|
run_mock = Mock()
|
|
|
|
hass.bus.async_listen(event, event_mock)
|
|
hass.bus.async_listen(EVENT_SCRIPT_STARTED, run_mock)
|
|
|
|
assert await async_setup_component(
|
|
hass, "script", {"script": {"test": {"sequence": [{"event": event}]}}}
|
|
)
|
|
|
|
await hass.services.async_call(
|
|
DOMAIN, SERVICE_TURN_ON, {ATTR_ENTITY_ID: ENTITY_ID}, context=context
|
|
)
|
|
await hass.async_block_till_done()
|
|
|
|
assert event_mock.call_count == 1
|
|
assert run_mock.call_count == 1
|
|
|
|
args, kwargs = run_mock.call_args
|
|
assert args[0].context == context
|
|
# Ensure event data has all attributes set
|
|
assert args[0].data.get(ATTR_NAME) == "test"
|
|
assert args[0].data.get(ATTR_ENTITY_ID) == "script.test"
|
|
|
|
# Ensure context carries through the event
|
|
args, kwargs = event_mock.call_args
|
|
assert args[0].context == context
|
|
|
|
# Ensure the script state shares the same context
|
|
state = hass.states.get("script.test")
|
|
assert state is not None
|
|
assert state.context == context
|
|
|
|
|
|
async def test_logging_script_error(hass, caplog):
|
|
"""Test logging script error."""
|
|
assert await async_setup_component(
|
|
hass,
|
|
"script",
|
|
{"script": {"hello": {"sequence": [{"service": "non.existing"}]}}},
|
|
)
|
|
with pytest.raises(ServiceNotFound) as err:
|
|
await hass.services.async_call("script", "hello", blocking=True)
|
|
|
|
assert err.value.domain == "non"
|
|
assert err.value.service == "existing"
|
|
assert "Error executing script" in caplog.text
|
|
|
|
|
|
async def test_turning_no_scripts_off(hass):
|
|
"""Test it is possible to turn two scripts off."""
|
|
assert await async_setup_component(hass, "script", {})
|
|
|
|
# Testing it doesn't raise
|
|
await hass.services.async_call(
|
|
DOMAIN, SERVICE_TURN_OFF, {"entity_id": []}, blocking=True
|
|
)
|
|
|
|
|
|
async def test_async_get_descriptions_script(hass):
|
|
"""Test async_set_service_schema for the script integration."""
|
|
script_config = {
|
|
DOMAIN: {
|
|
"test1": {"sequence": [{"service": "homeassistant.restart"}]},
|
|
"test2": {
|
|
"description": "test2",
|
|
"fields": {
|
|
"param": {
|
|
"description": "param_description",
|
|
"example": "param_example",
|
|
}
|
|
},
|
|
"sequence": [{"service": "homeassistant.restart"}],
|
|
},
|
|
}
|
|
}
|
|
|
|
await async_setup_component(hass, DOMAIN, script_config)
|
|
descriptions = await hass.helpers.service.async_get_all_descriptions()
|
|
|
|
assert descriptions[DOMAIN]["test1"]["description"] == ""
|
|
assert not descriptions[DOMAIN]["test1"]["fields"]
|
|
|
|
assert descriptions[DOMAIN]["test2"]["description"] == "test2"
|
|
assert (
|
|
descriptions[DOMAIN]["test2"]["fields"]["param"]["description"]
|
|
== "param_description"
|
|
)
|
|
assert (
|
|
descriptions[DOMAIN]["test2"]["fields"]["param"]["example"] == "param_example"
|
|
)
|
|
|
|
|
|
async def test_extraction_functions(hass):
|
|
"""Test extraction functions."""
|
|
assert await async_setup_component(
|
|
hass,
|
|
DOMAIN,
|
|
{
|
|
DOMAIN: {
|
|
"test1": {
|
|
"sequence": [
|
|
{
|
|
"service": "test.script",
|
|
"data": {"entity_id": "light.in_both"},
|
|
},
|
|
{
|
|
"service": "test.script",
|
|
"data": {"entity_id": "light.in_first"},
|
|
},
|
|
{"domain": "light", "device_id": "device-in-both"},
|
|
]
|
|
},
|
|
"test2": {
|
|
"sequence": [
|
|
{
|
|
"service": "test.script",
|
|
"data": {"entity_id": "light.in_both"},
|
|
},
|
|
{
|
|
"condition": "state",
|
|
"entity_id": "sensor.condition",
|
|
"state": "100",
|
|
},
|
|
{"scene": "scene.hello"},
|
|
{"domain": "light", "device_id": "device-in-both"},
|
|
{"domain": "light", "device_id": "device-in-last"},
|
|
],
|
|
},
|
|
}
|
|
},
|
|
)
|
|
|
|
assert set(script.scripts_with_entity(hass, "light.in_both")) == {
|
|
"script.test1",
|
|
"script.test2",
|
|
}
|
|
assert set(script.entities_in_script(hass, "script.test1")) == {
|
|
"light.in_both",
|
|
"light.in_first",
|
|
}
|
|
assert set(script.scripts_with_device(hass, "device-in-both")) == {
|
|
"script.test1",
|
|
"script.test2",
|
|
}
|
|
assert set(script.devices_in_script(hass, "script.test2")) == {
|
|
"device-in-both",
|
|
"device-in-last",
|
|
}
|
|
|
|
|
|
async def test_config_basic(hass):
|
|
"""Test passing info in config."""
|
|
assert await async_setup_component(
|
|
hass,
|
|
"script",
|
|
{
|
|
"script": {
|
|
"test_script": {
|
|
"alias": "Script Name",
|
|
"icon": "mdi:party",
|
|
"sequence": [],
|
|
}
|
|
}
|
|
},
|
|
)
|
|
|
|
test_script = hass.states.get("script.test_script")
|
|
assert test_script.name == "Script Name"
|
|
assert test_script.attributes["icon"] == "mdi:party"
|
|
|
|
|
|
async def test_logbook_humanify_script_started_event(hass):
|
|
"""Test humanifying script started event."""
|
|
hass.config.components.add("recorder")
|
|
await async_setup_component(hass, DOMAIN, {})
|
|
await async_setup_component(hass, "logbook", {})
|
|
entity_attr_cache = logbook.EntityAttributeCache(hass)
|
|
|
|
event1, event2 = list(
|
|
logbook.humanify(
|
|
hass,
|
|
[
|
|
MockLazyEventPartialState(
|
|
EVENT_SCRIPT_STARTED,
|
|
{ATTR_ENTITY_ID: "script.hello", ATTR_NAME: "Hello Script"},
|
|
),
|
|
MockLazyEventPartialState(
|
|
EVENT_SCRIPT_STARTED,
|
|
{ATTR_ENTITY_ID: "script.bye", ATTR_NAME: "Bye Script"},
|
|
),
|
|
],
|
|
entity_attr_cache,
|
|
)
|
|
)
|
|
|
|
assert event1["name"] == "Hello Script"
|
|
assert event1["domain"] == "script"
|
|
assert event1["message"] == "started"
|
|
assert event1["entity_id"] == "script.hello"
|
|
|
|
assert event2["name"] == "Bye Script"
|
|
assert event2["domain"] == "script"
|
|
assert event2["message"] == "started"
|
|
assert event2["entity_id"] == "script.bye"
|
|
|
|
|
|
@pytest.mark.parametrize("concurrently", [False, True])
|
|
async def test_concurrent_script(hass, concurrently):
|
|
"""Test calling script concurrently or not."""
|
|
if concurrently:
|
|
call_script_2 = {
|
|
"service": "script.turn_on",
|
|
"data": {"entity_id": "script.script2"},
|
|
}
|
|
else:
|
|
call_script_2 = {"service": "script.script2"}
|
|
assert await async_setup_component(
|
|
hass,
|
|
"script",
|
|
{
|
|
"script": {
|
|
"script1": {
|
|
"mode": "parallel",
|
|
"sequence": [
|
|
call_script_2,
|
|
{
|
|
"wait_template": "{{ is_state('input_boolean.test1', 'on') }}"
|
|
},
|
|
{"service": "test.script", "data": {"value": "script1"}},
|
|
],
|
|
},
|
|
"script2": {
|
|
"mode": "parallel",
|
|
"sequence": [
|
|
{"service": "test.script", "data": {"value": "script2a"}},
|
|
{
|
|
"wait_template": "{{ is_state('input_boolean.test2', 'on') }}"
|
|
},
|
|
{"service": "test.script", "data": {"value": "script2b"}},
|
|
],
|
|
},
|
|
}
|
|
},
|
|
)
|
|
|
|
service_called = asyncio.Event()
|
|
service_values = []
|
|
|
|
async def async_service_handler(service):
|
|
nonlocal service_values
|
|
service_values.append(service.data.get("value"))
|
|
service_called.set()
|
|
|
|
hass.services.async_register("test", "script", async_service_handler)
|
|
hass.states.async_set("input_boolean.test1", "off")
|
|
hass.states.async_set("input_boolean.test2", "off")
|
|
|
|
await hass.services.async_call("script", "script1")
|
|
await asyncio.wait_for(service_called.wait(), 1)
|
|
service_called.clear()
|
|
|
|
assert "script2a" == service_values[-1]
|
|
assert script.is_on(hass, "script.script1")
|
|
assert script.is_on(hass, "script.script2")
|
|
|
|
if not concurrently:
|
|
hass.states.async_set("input_boolean.test2", "on")
|
|
await asyncio.wait_for(service_called.wait(), 1)
|
|
service_called.clear()
|
|
|
|
assert "script2b" == service_values[-1]
|
|
|
|
hass.states.async_set("input_boolean.test1", "on")
|
|
await asyncio.wait_for(service_called.wait(), 1)
|
|
service_called.clear()
|
|
|
|
assert "script1" == service_values[-1]
|
|
assert concurrently == script.is_on(hass, "script.script2")
|
|
|
|
if concurrently:
|
|
hass.states.async_set("input_boolean.test2", "on")
|
|
await asyncio.wait_for(service_called.wait(), 1)
|
|
service_called.clear()
|
|
|
|
assert "script2b" == service_values[-1]
|
|
|
|
await hass.async_block_till_done()
|
|
|
|
assert not script.is_on(hass, "script.script1")
|
|
assert not script.is_on(hass, "script.script2")
|