mirror of
https://github.com/home-assistant/supervisor.git
synced 2025-12-11 12:45:48 -06:00
c277f3cad6
* Store and persist OS upgrade map to fix update path evaluation The existing logic calculated OS upgrade paths inline during fetch_data, which will not get reevaluted when the current OS is unsupported (JobCondition.OS_SUPPORTED). E.g. after updating from 11.4 to 11.5, the system wouldn't offer the next available update (15.2) because the upgrade path calculation relied on fresh data from the blocked fetch operation. Changes: - Add ATTR_HASSOS_UPGRADE constant and schema validation - Store hassos-upgrade map from version JSON in updater data - Refactor version_hassos property to use stored upgrade map instead of inline calculation during fetch_data - Maintain upgrade path logic: upgrade within major version first, then jump to next major version when at the latest in current major - Add type safety checks for version.major access This ensures upgrade paths work correctly even when update data refresh is blocked due to unsupported OS versions, fixing the scenario where HAOS 11.5 wouldn't show 15.2 as the next available update. * Update supervisor/updater.py Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Address mypy issue * Fix pytest --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
238 lines
7.3 KiB
Python
238 lines
7.3 KiB
Python
"""Validate functions."""
|
|
|
|
import ipaddress
|
|
import re
|
|
|
|
from awesomeversion import AwesomeVersion
|
|
import voluptuous as vol
|
|
|
|
from .const import (
|
|
ATTR_ADDONS_CUSTOM_LIST,
|
|
ATTR_AUDIO,
|
|
ATTR_AUTO_UPDATE,
|
|
ATTR_CHANNEL,
|
|
ATTR_CLI,
|
|
ATTR_CONTENT_TRUST,
|
|
ATTR_COUNTRY,
|
|
ATTR_DEBUG,
|
|
ATTR_DEBUG_BLOCK,
|
|
ATTR_DETECT_BLOCKING_IO,
|
|
ATTR_DIAGNOSTICS,
|
|
ATTR_DISPLAYNAME,
|
|
ATTR_DNS,
|
|
ATTR_ENABLE_IPV6,
|
|
ATTR_FORCE_SECURITY,
|
|
ATTR_HASSOS,
|
|
ATTR_HASSOS_UNRESTRICTED,
|
|
ATTR_HASSOS_UPGRADE,
|
|
ATTR_HOMEASSISTANT,
|
|
ATTR_ID,
|
|
ATTR_IMAGE,
|
|
ATTR_LAST_BOOT,
|
|
ATTR_LOGGING,
|
|
ATTR_MTU,
|
|
ATTR_MULTICAST,
|
|
ATTR_OBSERVER,
|
|
ATTR_OTA,
|
|
ATTR_PASSWORD,
|
|
ATTR_PORTS,
|
|
ATTR_PWNED,
|
|
ATTR_REGISTRIES,
|
|
ATTR_SESSION,
|
|
ATTR_SESSION_DATA,
|
|
ATTR_SESSION_DATA_USER,
|
|
ATTR_SUPERVISOR,
|
|
ATTR_TIMEZONE,
|
|
ATTR_USERNAME,
|
|
ATTR_VERSION,
|
|
ATTR_WAIT_BOOT,
|
|
SUPERVISOR_VERSION,
|
|
LogLevel,
|
|
UpdateChannel,
|
|
)
|
|
from .utils.validate import validate_timezone
|
|
|
|
# Move to store.validate when addons_repository config removed
|
|
RE_REPOSITORY = re.compile(r"^(?P<url>[^#]+)(?:#(?P<branch>[\w\-.]+))?$")
|
|
RE_REGISTRY = re.compile(r"^([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,}$")
|
|
|
|
# pylint: disable=no-value-for-parameter
|
|
# pylint: disable=invalid-name
|
|
network_port = vol.All(vol.Coerce(int), vol.Range(min=1, max=65535))
|
|
wait_boot = vol.All(vol.Coerce(int), vol.Range(min=1, max=60))
|
|
docker_image = vol.Match(
|
|
r"^([a-z0-9][a-z0-9.\-]*(:[0-9]+)?/)*?([a-z0-9{][a-z0-9.\-_{}]*/)*?([a-z0-9{][a-z0-9.\-_{}]*)$"
|
|
)
|
|
uuid_match = vol.Match(r"^[0-9a-f]{32}$")
|
|
sha256 = vol.Match(r"^[0-9a-f]{64}$")
|
|
token = vol.Match(r"^[0-9a-f]{32,256}$")
|
|
|
|
|
|
def version_tag(
|
|
value: str | None | int | float | AwesomeVersion,
|
|
) -> AwesomeVersion | None:
|
|
"""Validate main version handling."""
|
|
if value is None:
|
|
return None
|
|
if isinstance(value, AwesomeVersion):
|
|
return value
|
|
return AwesomeVersion(value)
|
|
|
|
|
|
def dns_url(url: str) -> str:
|
|
"""Take a DNS url (str) and validates that it matches the scheme dns://<ip address>."""
|
|
if not url.lower().startswith("dns://"):
|
|
raise vol.Invalid("Doesn't start with dns://") from None
|
|
address: str = url[6:] # strip the dns:// off
|
|
try:
|
|
ip = ipaddress.ip_address(address) # matches IPv4 or IPv6 addresses
|
|
except ValueError:
|
|
raise vol.Invalid(f"Invalid DNS URL: {url}") from None
|
|
|
|
# Currently only IPv4 work with docker network
|
|
if ip.version != 4:
|
|
raise vol.Invalid(f"Only IPv4 is working for DNS: {url}") from None
|
|
return url
|
|
|
|
|
|
dns_server_list = vol.All(vol.Length(max=8), [dns_url])
|
|
|
|
|
|
# Remove with addons_repositories config
|
|
def validate_repository(repository: str) -> str:
|
|
"""Validate a valid repository."""
|
|
data = RE_REPOSITORY.match(repository)
|
|
if not data:
|
|
raise vol.Invalid("No valid repository format!") from None
|
|
|
|
# Validate URL
|
|
# pylint: disable=no-value-for-parameter
|
|
vol.Url()(data.group("url"))
|
|
|
|
return repository
|
|
|
|
|
|
# pylint: disable=no-value-for-parameter
|
|
repositories = vol.All([validate_repository], vol.Unique())
|
|
|
|
docker_port = vol.All(str, vol.Match(r"^\d+(?:/tcp|/udp)?$"))
|
|
docker_ports = vol.Schema({docker_port: vol.Maybe(network_port)})
|
|
docker_ports_description = vol.Schema({docker_port: str})
|
|
|
|
|
|
# pylint: disable=no-value-for-parameter
|
|
SCHEMA_UPDATER_CONFIG = vol.Schema(
|
|
{
|
|
vol.Optional(ATTR_CHANNEL, default=UpdateChannel.STABLE): vol.Coerce(
|
|
UpdateChannel
|
|
),
|
|
vol.Optional(ATTR_HOMEASSISTANT): version_tag,
|
|
vol.Optional(ATTR_SUPERVISOR): version_tag,
|
|
vol.Optional(ATTR_HASSOS): version_tag,
|
|
vol.Optional(ATTR_HASSOS_UNRESTRICTED): version_tag,
|
|
vol.Optional(ATTR_HASSOS_UPGRADE): vol.Schema(
|
|
{vol.Extra: version_tag}, extra=vol.ALLOW_EXTRA
|
|
),
|
|
vol.Optional(ATTR_CLI): version_tag,
|
|
vol.Optional(ATTR_DNS): version_tag,
|
|
vol.Optional(ATTR_AUDIO): version_tag,
|
|
vol.Optional(ATTR_OBSERVER): version_tag,
|
|
vol.Optional(ATTR_MULTICAST): version_tag,
|
|
vol.Optional(ATTR_IMAGE, default=dict): vol.Schema(
|
|
{
|
|
vol.Optional(ATTR_HOMEASSISTANT): docker_image,
|
|
vol.Optional(ATTR_SUPERVISOR): docker_image,
|
|
vol.Optional(ATTR_CLI): docker_image,
|
|
vol.Optional(ATTR_DNS): docker_image,
|
|
vol.Optional(ATTR_AUDIO): docker_image,
|
|
vol.Optional(ATTR_OBSERVER): docker_image,
|
|
vol.Optional(ATTR_MULTICAST): docker_image,
|
|
},
|
|
extra=vol.REMOVE_EXTRA,
|
|
),
|
|
vol.Optional(ATTR_OTA): vol.Url(),
|
|
vol.Optional(ATTR_AUTO_UPDATE, default=True): bool,
|
|
},
|
|
extra=vol.REMOVE_EXTRA,
|
|
)
|
|
|
|
|
|
# pylint: disable=no-value-for-parameter
|
|
SCHEMA_SUPERVISOR_CONFIG = vol.Schema(
|
|
{
|
|
vol.Optional(ATTR_TIMEZONE): validate_timezone,
|
|
vol.Optional(ATTR_LAST_BOOT): str,
|
|
vol.Optional(
|
|
ATTR_VERSION, default=AwesomeVersion(SUPERVISOR_VERSION)
|
|
): version_tag,
|
|
vol.Optional(ATTR_IMAGE): docker_image,
|
|
vol.Optional(ATTR_ADDONS_CUSTOM_LIST, default=[]): repositories,
|
|
vol.Optional(ATTR_WAIT_BOOT, default=5): wait_boot,
|
|
vol.Optional(ATTR_LOGGING, default=LogLevel.INFO): vol.Coerce(LogLevel),
|
|
vol.Optional(ATTR_DEBUG, default=False): vol.Boolean(),
|
|
vol.Optional(ATTR_DEBUG_BLOCK, default=False): vol.Boolean(),
|
|
vol.Optional(ATTR_DIAGNOSTICS, default=None): vol.Maybe(vol.Boolean()),
|
|
vol.Optional(ATTR_DETECT_BLOCKING_IO, default=False): vol.Boolean(),
|
|
vol.Optional(ATTR_COUNTRY): str,
|
|
},
|
|
extra=vol.REMOVE_EXTRA,
|
|
)
|
|
|
|
|
|
SCHEMA_DOCKER_CONFIG = vol.Schema(
|
|
{
|
|
vol.Optional(ATTR_REGISTRIES, default=dict): vol.Schema(
|
|
{
|
|
vol.All(str, vol.Match(RE_REGISTRY)): {
|
|
vol.Required(ATTR_USERNAME): str,
|
|
vol.Required(ATTR_PASSWORD): str,
|
|
}
|
|
}
|
|
),
|
|
vol.Optional(ATTR_ENABLE_IPV6, default=None): vol.Maybe(vol.Boolean()),
|
|
vol.Optional(ATTR_MTU, default=None): vol.Maybe(
|
|
vol.All(int, vol.Range(min=68, max=65535))
|
|
),
|
|
}
|
|
)
|
|
|
|
|
|
SCHEMA_AUTH_CONFIG = vol.Schema({sha256: sha256})
|
|
|
|
SCHEMA_SESSION_DATA = vol.Schema(
|
|
{
|
|
token: vol.Schema(
|
|
{
|
|
vol.Required(ATTR_SESSION_DATA_USER): vol.Schema(
|
|
{
|
|
vol.Required(ATTR_ID): str,
|
|
vol.Required(ATTR_USERNAME, default=None): vol.Maybe(str),
|
|
vol.Required(ATTR_DISPLAYNAME, default=None): vol.Maybe(str),
|
|
}
|
|
)
|
|
}
|
|
)
|
|
}
|
|
)
|
|
|
|
SCHEMA_INGRESS_CONFIG = vol.Schema(
|
|
{
|
|
vol.Required(ATTR_SESSION, default=dict): vol.Schema(
|
|
{token: vol.Coerce(float)}
|
|
),
|
|
vol.Required(ATTR_SESSION_DATA, default=dict): SCHEMA_SESSION_DATA,
|
|
vol.Required(ATTR_PORTS, default=dict): vol.Schema({str: network_port}),
|
|
},
|
|
extra=vol.REMOVE_EXTRA,
|
|
)
|
|
|
|
# pylint: disable=no-value-for-parameter
|
|
SCHEMA_SECURITY_CONFIG = vol.Schema(
|
|
{
|
|
vol.Optional(ATTR_CONTENT_TRUST, default=True): vol.Boolean(),
|
|
vol.Optional(ATTR_PWNED, default=True): vol.Boolean(),
|
|
vol.Optional(ATTR_FORCE_SECURITY, default=False): vol.Boolean(),
|
|
},
|
|
extra=vol.REMOVE_EXTRA,
|
|
)
|