jeans/core
jeans/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-07-23 21:27:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

Validate in split_entity_id (#66835)

Browse Source
This commit is contained in:
Paulus Schoutsen 2022-02-18 16:11:17 -08:00 committed by GitHub
parent 3bf2be1765
commit 1bbc1f5f55
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 27 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
homeassistant/components/logbook/__init__.py
View File

@ -71,7 +71,7 @@ GROUP_BY_MINUTES = 15
EMPTY_JSON_OBJECT = "{}" EMPTY_JSON_OBJECT = "{}"
UNIT_OF_MEASUREMENT_JSON = '"unit_of_measurement":' UNIT_OF_MEASUREMENT_JSON = '"unit_of_measurement":'
HA_DOMAIN_ENTITY_ID = f"{HA_DOMAIN}." HA_DOMAIN_ENTITY_ID = f"{HA_DOMAIN}._"
CONFIG_SCHEMA = vol.Schema( CONFIG_SCHEMA = vol.Schema(
{DOMAIN: INCLUDE_EXCLUDE_BASE_FILTER_SCHEMA}, extra=vol.ALLOW_EXTRA {DOMAIN: INCLUDE_EXCLUDE_BASE_FILTER_SCHEMA}, extra=vol.ALLOW_EXTRA
@ -598,7 +598,7 @@ def _keep_event(hass, event, entities_filter):
if domain is None: if domain is None:
return False return False
return entities_filter is None or entities_filter(f"{domain}.") return entities_filter is None or entities_filter(f"{domain}._")
def _augment_data_with_context( def _augment_data_with_context(

7
homeassistant/core.py
View File

@ -141,9 +141,12 @@ TIMEOUT_EVENT_START = 15
_LOGGER = logging.getLogger(__name__) _LOGGER = logging.getLogger(__name__)
def split_entity_id(entity_id: str) -> list[str]: def split_entity_id(entity_id: str) -> tuple[str, str]:
"""Split a state entity ID into domain and object ID.""" """Split a state entity ID into domain and object ID."""
return entity_id.split(".", 1) domain, _, object_id = entity_id.partition(".")
if not domain or not object_id:
raise ValueError(f"Invalid entity ID {entity_id}")
return domain, object_id
VALID_ENTITY_ID = re.compile(r"^(?!.+__)(?!_)[\da-z_]+(?<!_)\.(?!_)[\da-z_]+(?<!_)$") VALID_ENTITY_ID = re.compile(r"^(?!.+__)(?!_)[\da-z_]+(?<!_)\.(?!_)[\da-z_]+(?<!_)$")

18
tests/helpers/test_entity_registry.py
View File

@ -1220,9 +1220,9 @@ def test_entity_registry_items():
async def test_deprecated_disabled_by_str(hass, registry, caplog): async def test_deprecated_disabled_by_str(hass, registry, caplog):
"""Test deprecated str use of disabled_by converts to enum and logs a warning.""" """Test deprecated str use of disabled_by converts to enum and logs a warning."""
entry = registry.async_get_or_create( entry = registry.async_get_or_create(
"light", domain="light.kitchen",
"hue", platform="hue",
"5678", unique_id="5678",
disabled_by=er.RegistryEntryDisabler.USER.value, disabled_by=er.RegistryEntryDisabler.USER.value,
) )
@ -1233,9 +1233,9 @@ async def test_deprecated_disabled_by_str(hass, registry, caplog):
async def test_deprecated_entity_category_str(hass, registry, caplog): async def test_deprecated_entity_category_str(hass, registry, caplog):
"""Test deprecated str use of entity_category converts to enum and logs a warning.""" """Test deprecated str use of entity_category converts to enum and logs a warning."""
entry = er.RegistryEntry( entry = er.RegistryEntry(
"light", entity_id="light.kitchen",
"hue", unique_id="5678",
"5678", platform="hue",
entity_category="diagnostic", entity_category="diagnostic",
) )
@ -1246,9 +1246,9 @@ async def test_deprecated_entity_category_str(hass, registry, caplog):
async def test_invalid_entity_category_str(hass, registry, caplog): async def test_invalid_entity_category_str(hass, registry, caplog):
"""Test use of invalid entity category.""" """Test use of invalid entity category."""
entry = er.RegistryEntry( entry = er.RegistryEntry(
"light", entity_id="light.kitchen",
"hue", unique_id="5678",
"5678", platform="hue",
entity_category="invalid", entity_category="invalid",
) )

12
tests/test_core.py
View File

@ -49,7 +49,17 @@ PST = dt_util.get_time_zone("America/Los_Angeles")
def test_split_entity_id(): def test_split_entity_id():
"""Test split_entity_id.""" """Test split_entity_id."""
assert ha.split_entity_id("domain.object_id") == ["domain", "object_id"] assert ha.split_entity_id("domain.object_id") == ("domain", "object_id")
with pytest.raises(ValueError):
ha.split_entity_id("")
with pytest.raises(ValueError):
ha.split_entity_id(".")
with pytest.raises(ValueError):
ha.split_entity_id("just_domain")
with pytest.raises(ValueError):
ha.split_entity_id("empty_object_id.")
with pytest.raises(ValueError):
ha.split_entity_id(".empty_domain")
def test_async_add_hass_job_schedule_callback(): def test_async_add_hass_job_schedule_callback():