mirror of
https://github.com/home-assistant/supervisor.git
synced 2025-04-19 10:47:15 +00:00
9650fd2ba1
* Extend container image name validator
The current validator allows certain invalid names (e.g. upper
case), but disallows valid cases (such as ttl.sh/myimage).
Improve the container image validator to support more valid
options and at the same time disallow some of the invalid
options.
Note that this is not a complete/perfect validation still. A much
much more sophisticated regex would be necessary to be 100% accurate.
Also we format the string and replace {machine}/{arch} using Python
format strings. In that regard the image format in Supervisor deviates
from the Docker/OCI container image name format.
* Use an actual invalid image name in config validation
125 lines
3.5 KiB
Python
125 lines
3.5 KiB
Python
"""Test validators."""
|
|
|
|
import pytest
|
|
import voluptuous as vol
|
|
|
|
from supervisor import validate
|
|
|
|
DNS_GOOD_V4 = [
|
|
"dns://10.0.0.1", # random local
|
|
"dns://254.254.254.254", # random high numbers
|
|
"DNS://1.1.1.1", # cloudflare
|
|
"dns://9.9.9.9", # quad-9
|
|
]
|
|
DNS_GOOD_V6 = [
|
|
"dns://2606:4700:4700::1111", # cloudflare
|
|
"DNS://2606:4700:4700::1001", # cloudflare
|
|
]
|
|
DNS_BAD = ["hello world", "https://foo.bar", "", "dns://example.com"]
|
|
IMAGE_NAME_GOOD = [
|
|
"ghcr.io/home-assistant/{machine}-homeassistant",
|
|
"ghcr.io/home-assistant/{arch}-homeassistant",
|
|
"homeassistant/{arch}-homeassistant",
|
|
"doocker.io/homeassistant/{arch}-homeassistant",
|
|
"ghcr.io/home-assistant/amd64-homeassistant",
|
|
"homeassistant/amd64-homeassistant",
|
|
"ttl.sh/homeassistant",
|
|
"myreg.local:8080/homeassistant",
|
|
]
|
|
IMAGE_NAME_BAD = [
|
|
"ghcr.io/home-assistant/homeassistant:123",
|
|
".ghcr.io/home-assistant/homeassistant",
|
|
"HOMEASSISTANT/homeassistant",
|
|
"homeassistant/HOMEASSISTANT",
|
|
"homeassistant/_homeassistant",
|
|
"homeassistant/-homeassistant",
|
|
]
|
|
|
|
|
|
async def test_dns_url_v4_good():
|
|
"""Test the DNS validator with known-good ipv6 DNS URLs."""
|
|
for url in DNS_GOOD_V4:
|
|
assert validate.dns_url(url)
|
|
|
|
|
|
def test_dns_url_v6_good():
|
|
"""Test the DNS validator with known-good ipv6 DNS URLs."""
|
|
with pytest.raises(vol.error.Invalid):
|
|
for url in DNS_GOOD_V6:
|
|
assert validate.dns_url(url)
|
|
|
|
|
|
def test_dns_server_list_v4():
|
|
"""Test a list with v4 addresses."""
|
|
assert validate.dns_server_list(DNS_GOOD_V4)
|
|
|
|
|
|
def test_dns_server_list_v6():
|
|
"""Test a list with v6 addresses."""
|
|
with pytest.raises(vol.error.Invalid):
|
|
assert validate.dns_server_list(DNS_GOOD_V6)
|
|
|
|
|
|
def test_dns_server_list_combined():
|
|
"""Test a list with both v4 and v6 addresses."""
|
|
combined = DNS_GOOD_V4 + DNS_GOOD_V6
|
|
# test the matches
|
|
with pytest.raises(vol.error.Invalid):
|
|
validate.dns_server_list(combined)
|
|
# test max_length is OK still
|
|
with pytest.raises(vol.error.Invalid):
|
|
validate.dns_server_list(combined)
|
|
# test that it fails when the list is too long
|
|
with pytest.raises(vol.error.Invalid):
|
|
validate.dns_server_list(combined + combined + combined + combined)
|
|
|
|
|
|
def test_dns_server_list_bad():
|
|
"""Test the bad list."""
|
|
# test the matches
|
|
with pytest.raises(vol.error.Invalid):
|
|
assert validate.dns_server_list(DNS_BAD)
|
|
|
|
|
|
def test_dns_server_list_bad_combined():
|
|
"""Test the bad list, combined with the good."""
|
|
combined = DNS_GOOD_V4 + DNS_GOOD_V6 + DNS_BAD
|
|
|
|
with pytest.raises(vol.error.Invalid):
|
|
# bad list
|
|
assert validate.dns_server_list(combined)
|
|
|
|
|
|
def test_image_name_good():
|
|
"""Test container image names validator with known-good image names."""
|
|
for image_name in IMAGE_NAME_GOOD:
|
|
assert validate.docker_image(image_name)
|
|
|
|
|
|
def test_image_name_bad():
|
|
"""Test container image names validator with known-bad image names."""
|
|
for image_name in IMAGE_NAME_BAD:
|
|
with pytest.raises(vol.error.Invalid):
|
|
assert validate.docker_image(image_name)
|
|
|
|
|
|
def test_version_complex():
|
|
"""Test version simple with good version."""
|
|
for version in (
|
|
"landingpage",
|
|
"dev",
|
|
"1c002dd",
|
|
"1.1.1",
|
|
"1.0",
|
|
"0.150.1",
|
|
"0.150.1b1",
|
|
"0.150.1.dev20200715",
|
|
"1",
|
|
"alpine-5.4",
|
|
1,
|
|
1.1,
|
|
):
|
|
assert validate.version_tag(version) == str(version)
|
|
|
|
assert validate.version_tag(None) is None
|