52 lines
1.4 KiB
Python
52 lines
1.4 KiB
Python
"""Base class for validation."""
|
|
from __future__ import annotations
|
|
|
|
from time import monotonic
|
|
from typing import TYPE_CHECKING
|
|
|
|
from ..exceptions import HacsException
|
|
|
|
if TYPE_CHECKING:
|
|
from ..repositories.base import HacsRepository
|
|
|
|
|
|
class ValidationException(HacsException):
|
|
"""Raise when there is a validation issue."""
|
|
|
|
|
|
class ActionValidationBase:
|
|
"""Base class for action validation."""
|
|
|
|
category: str = "common"
|
|
|
|
def __init__(self, repository: HacsRepository) -> None:
|
|
self.hacs = repository.hacs
|
|
self.repository = repository
|
|
self.failed = False
|
|
|
|
@property
|
|
def slug(self) -> str:
|
|
"""Return the check slug."""
|
|
return self.__class__.__module__.rsplit(".", maxsplit=1)[-1]
|
|
|
|
async def async_validate(self) -> None:
|
|
"""Validate the repository."""
|
|
|
|
async def execute_validation(self, *_, **__) -> None:
|
|
"""Execute the task defined in subclass."""
|
|
self.hacs.log.info("<Validation %s> Starting validation", self.slug)
|
|
|
|
start_time = monotonic()
|
|
self.failed = False
|
|
|
|
try:
|
|
await self.async_validate()
|
|
except ValidationException as exception:
|
|
self.failed = True
|
|
self.hacs.log.error("<Validation %s> failed: %s", self.slug, exception)
|
|
|
|
else:
|
|
self.hacs.log.debug(
|
|
"<Validation %s> took %.3f seconds to complete", self.slug, monotonic() - start_time
|
|
)
|