RFC: Deprecate auto target all for services and introduce entity_id: * (#19006)
* Deprecate auto target all * Match on word 'all'
This commit is contained in:
1 parent
56c7e78cf2
commit
8ea0a8d40b
24 files changed
+143
-41
No files matched your search
@@ -584,3 +584,16 @@ def test_is_regex():
|
||||
|
||||
valid_re = ".*"
|
||||
schema(valid_re)
|
||||
|
||||
|
||||
def test_comp_entity_ids():
|
||||
"""Test config validation for component entity IDs."""
|
||||
schema = vol.Schema(cv.comp_entity_ids)
|
||||
|
||||
for valid in ('ALL', 'all', 'AlL', 'light.kitchen', ['light.kitchen'],
|
||||
['light.kitchen', 'light.ceiling'], []):
|
||||
schema(valid)
|
||||
|
||||
for invalid in (['light.kitchen', 'not-entity-id'], '*', ''):
|
||||
with pytest.raises(vol.Invalid):
|
||||
schema(invalid)
|
||||
@@ -452,3 +452,37 @@ async def test_set_service_race(hass):
|
||||
|
||||
await hass.async_block_till_done()
|
||||
assert not exception
|
||||
|
||||
|
||||
async def test_extract_all_omit_entity_id(hass, caplog):
|
||||
"""Test extract all with None and *."""
|
||||
component = EntityComponent(_LOGGER, DOMAIN, hass)
|
||||
await component.async_add_entities([
|
||||
MockEntity(name='test_1'),
|
||||
MockEntity(name='test_2'),
|
||||
])
|
||||
|
||||
call = ha.ServiceCall('test', 'service')
|
||||
|
||||
assert ['test_domain.test_1', 'test_domain.test_2'] == \
|
||||
sorted(ent.entity_id for ent in
|
||||
component.async_extract_from_service(call))
|
||||
assert ('Not passing an entity ID to a service to target all entities is '
|
||||
'deprecated') in caplog.text
|
||||
|
||||
|
||||
async def test_extract_all_use_match_all(hass, caplog):
|
||||
"""Test extract all with None and *."""
|
||||
component = EntityComponent(_LOGGER, DOMAIN, hass)
|
||||
await component.async_add_entities([
|
||||
MockEntity(name='test_1'),
|
||||
MockEntity(name='test_2'),
|
||||
])
|
||||
|
||||
call = ha.ServiceCall('test', 'service', {'entity_id': '*'})
|
||||
|
||||
assert ['test_domain.test_1', 'test_domain.test_2'] == \
|
||||
sorted(ent.entity_id for ent in
|
||||
component.async_extract_from_service(call))
|
||||
assert ('Not passing an entity ID to a service to target all entities is '
|
||||
'deprecated') not in caplog.text
|
||||
@@ -306,3 +306,35 @@ async def test_call_no_context_target_specific(
|
||||
assert len(mock_service_platform_call.mock_calls) == 1
|
||||
entities = mock_service_platform_call.mock_calls[0][1][2]
|
||||
assert entities == [mock_entities['light.kitchen']]
|
||||
|
||||
|
||||
async def test_call_with_match_all(hass, mock_service_platform_call,
|
||||
mock_entities, caplog):
|
||||
"""Check we only target allowed entities if targetting all."""
|
||||
await service.entity_service_call(hass, [
|
||||
Mock(entities=mock_entities)
|
||||
], Mock(), ha.ServiceCall('test_domain', 'test_service', {
|
||||
'entity_id': 'all'
|
||||
}))
|
||||
|
||||
assert len(mock_service_platform_call.mock_calls) == 1
|
||||
entities = mock_service_platform_call.mock_calls[0][1][2]
|
||||
assert entities == [
|
||||
mock_entities['light.kitchen'], mock_entities['light.living_room']]
|
||||
assert ('Not passing an entity ID to a service to target '
|
||||
'all entities is deprecated') not in caplog.text
|
||||
|
||||
|
||||
async def test_call_with_omit_entity_id(hass, mock_service_platform_call,
|
||||
mock_entities, caplog):
|
||||
"""Check we only target allowed entities if targetting all."""
|
||||
await service.entity_service_call(hass, [
|
||||
Mock(entities=mock_entities)
|
||||
], Mock(), ha.ServiceCall('test_domain', 'test_service'))
|
||||
|
||||
assert len(mock_service_platform_call.mock_calls) == 1
|
||||
entities = mock_service_platform_call.mock_calls[0][1][2]
|
||||
assert entities == [
|
||||
mock_entities['light.kitchen'], mock_entities['light.living_room']]
|
||||
assert ('Not passing an entity ID to a service to target '
|
||||
'all entities is deprecated') in caplog.text
|
||||
Reference in new issue
Block a user