Skip to content

Tankerkoenig UUIDs are not UUIDv4 #33121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
guillempages wants to merge 1 commit into from
Closed

Tankerkoenig UUIDs are not UUIDv4 #33121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions homeassistant/components/tankerkoenig/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,16 +27,16 @@
DEFAULT_SCAN_INTERVAL = timedelta(minutes=30)


def uuid4_string(value):
"""Validate a v4 UUID in string format."""
def uuid_string(value):
Copy link
Copy Markdown
Member

@balloob balloob Mar 21, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why even validate it as uuid at all ?

"""Validate a UUID in string format."""
try:
result = UUID(value, version=4)
result = UUID(value)
except (ValueError, AttributeError, TypeError) as error:
raise vol.Invalid("Invalid Version4 UUID", error_message=str(error))
raise vol.Invalid("Invalid UUID", error_message=str(error))

if str(result) != value.lower():
# UUID() will create a uuid4 if input is invalid
raise vol.Invalid("Invalid Version4 UUID")
raise vol.Invalid("Invalid UUID")

return str(result)

Expand All @@ -45,7 +45,7 @@ def uuid4_string(value):
{
DOMAIN: vol.Schema(
{
vol.Required(CONF_API_KEY): uuid4_string,
vol.Required(CONF_API_KEY): uuid_string,
vol.Optional(
CONF_SCAN_INTERVAL, default=DEFAULT_SCAN_INTERVAL
): cv.time_period,
Expand All @@ -66,7 +66,7 @@ def uuid4_string(value):
cv.positive_int, vol.Range(min=1)
),
vol.Optional(CONF_STATIONS, default=[]): vol.All(
cv.ensure_list, [uuid4_string]
cv.ensure_list, [uuid_string]
),
}
)
Expand Down
20 changes: 6 additions & 14 deletions tests/components/tankerkoenig/test_tankerkoenig_validators.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,28 +5,20 @@
import pytest
import voluptuous as vol

from homeassistant.components.tankerkoenig import uuid4_string
from homeassistant.components.tankerkoenig import uuid_string


class TestUUID4StringValidator(unittest.TestCase):
"""Test the UUID4 string custom validator."""
class TestUUIDStringValidator(unittest.TestCase):
"""Test the UUID string custom validator."""

def test_uuid4_string(caplog):
def test_uuid_string(caplog):
"""Test string uuid validation."""
schema = vol.Schema(uuid4_string)
schema = vol.Schema(uuid_string)

for value in ["Not a hex string", "0", 0]:
with pytest.raises(vol.Invalid):
schema(value)

with pytest.raises(vol.Invalid):
# the third block should start with 4
schema("a03d31b2-2eee-2acc-bb90-eec40be6ed23")

with pytest.raises(vol.Invalid):
# the fourth block should start with 8-a
schema("a03d31b2-2eee-4acc-1b90-eec40be6ed23")

_str = str(uuid.uuid4())
_str = str(uuid.uuid())
assert schema(_str) == _str
assert schema(_str.upper()) == _str