maint: Bump HACS to 2.0.0

This commit is contained in:
2024-09-02 08:36:59 -07:00
parent 1b64ea6cc9
commit 2665413b60
70 changed files with 1059 additions and 1110 deletions

View File

@@ -1,8 +1,12 @@
from __future__ import annotations
from ..repositories.base import HacsRepository
from typing import TYPE_CHECKING
from .base import ActionValidationBase, ValidationException
if TYPE_CHECKING:
from ..repositories.base import HacsRepository
async def async_setup_validator(repository: HacsRepository) -> Validator:
"""Set up this validator."""
@@ -15,7 +19,7 @@ class Validator(ActionValidationBase):
more_info = "https://hacs.xyz/docs/publish/include#check-archived"
allow_fork = False
async def async_validate(self):
async def async_validate(self) -> None:
"""Validate the repository."""
if self.repository.data.archived:
raise ValidationException("The repository is archived")

View File

@@ -1,12 +1,13 @@
"""Base class for validation."""
from __future__ import annotations
from typing import TYPE_CHECKING
from typing import TYPE_CHECKING, Any
from ..enums import HacsCategory
from ..exceptions import HacsException
if TYPE_CHECKING:
from ..enums import HacsCategory
from ..repositories.base import HacsRepository
@@ -17,7 +18,7 @@ class ValidationException(HacsException):
class ActionValidationBase:
"""Base class for action validation."""
categories: list[HacsCategory] = []
categories: tuple[HacsCategory, ...] = ()
allow_fork: bool = True
more_info: str = "https://hacs.xyz/docs/publish/action"
@@ -34,7 +35,7 @@ class ActionValidationBase:
async def async_validate(self) -> None:
"""Validate the repository."""
async def execute_validation(self, *_, **__) -> None:
async def execute_validation(self, *_: Any, **__: Any) -> None:
"""Execute the task defined in subclass."""
self.failed = False

View File

@@ -1,10 +1,14 @@
from __future__ import annotations
from typing import TYPE_CHECKING
from custom_components.hacs.enums import HacsCategory
from ..repositories.base import HacsRepository
from .base import ActionValidationBase, ValidationException
if TYPE_CHECKING:
from ..repositories.base import HacsRepository
URL = "https://brands.home-assistant.io/domains.json"
@@ -17,9 +21,9 @@ class Validator(ActionValidationBase):
"""Validate the repository."""
more_info = "https://hacs.xyz/docs/publish/include#check-brands"
categories = [HacsCategory.INTEGRATION]
categories = (HacsCategory.INTEGRATION,)
async def async_validate(self):
async def async_validate(self) -> None:
"""Validate the repository."""
response = await self.hacs.session.get(URL)

View File

@@ -1,8 +1,12 @@
from __future__ import annotations
from ..repositories.base import HacsRepository
from typing import TYPE_CHECKING
from .base import ActionValidationBase, ValidationException
if TYPE_CHECKING:
from ..repositories.base import HacsRepository
async def async_setup_validator(repository: HacsRepository) -> Validator:
"""Set up this validator."""
@@ -15,7 +19,7 @@ class Validator(ActionValidationBase):
more_info = "https://hacs.xyz/docs/publish/include#check-repository"
allow_fork = False
async def async_validate(self):
async def async_validate(self) -> None:
"""Validate the repository."""
if not self.repository.data.description:
raise ValidationException("The repository has no description")

View File

@@ -19,7 +19,7 @@ class Validator(ActionValidationBase):
more_info = "https://hacs.xyz/docs/publish/include#check-hacs-manifest"
async def async_validate(self):
async def async_validate(self) -> None:
"""Validate the repository."""
if RepositoryFile.HACS_JSON not in [x.filename for x in self.repository.tree]:
raise ValidationException(f"The repository has no '{RepositoryFile.HACS_JSON}' file")

View File

@@ -1,9 +1,13 @@
from __future__ import annotations
from typing import TYPE_CHECKING
from ..enums import HacsCategory
from ..repositories.base import HacsRepository
from .base import ActionValidationBase, ValidationException
if TYPE_CHECKING:
from ..repositories.base import HacsRepository
IGNORED = ["-shield", "img.shields.io", "buymeacoffee.com"]
@@ -15,12 +19,12 @@ async def async_setup_validator(repository: HacsRepository) -> Validator:
class Validator(ActionValidationBase):
"""Validate the repository."""
categories = [HacsCategory.PLUGIN, HacsCategory.THEME]
categories = (HacsCategory.PLUGIN, HacsCategory.THEME)
more_info = "https://hacs.xyz/docs/publish/include#check-images"
async def async_validate(self):
async def async_validate(self) -> None:
"""Validate the repository."""
info = await self.repository.async_get_info_file_contents()
info = await self.repository.async_get_info_file_contents(version=self.repository.ref)
for line in info.split("\n"):
if "<img" in line or "![" in line:
if [ignore for ignore in IGNORED if ignore in line]:

View File

@@ -1,8 +1,12 @@
from __future__ import annotations
from ..repositories.base import HacsRepository
from typing import TYPE_CHECKING
from .base import ActionValidationBase, ValidationException
if TYPE_CHECKING:
from ..repositories.base import HacsRepository
async def async_setup_validator(repository: HacsRepository) -> Validator:
"""Set up this validator."""
@@ -14,7 +18,7 @@ class Validator(ActionValidationBase):
more_info = "https://hacs.xyz/docs/publish/include#check-info"
async def async_validate(self):
async def async_validate(self) -> None:
"""Validate the repository."""
filenames = [x.filename.lower() for x in self.repository.tree]
if "readme" in filenames:

View File

@@ -1,13 +1,17 @@
from __future__ import annotations
from typing import TYPE_CHECKING
from voluptuous.error import Invalid
from ..enums import HacsCategory, RepositoryFile
from ..repositories.base import HacsRepository
from ..repositories.integration import HacsIntegrationRepository
from ..utils.validate import INTEGRATION_MANIFEST_JSON_SCHEMA
from .base import ActionValidationBase, ValidationException
if TYPE_CHECKING:
from ..repositories.base import HacsRepository
from ..repositories.integration import HacsIntegrationRepository
async def async_setup_validator(repository: HacsRepository) -> Validator:
"""Set up this validator."""
@@ -19,16 +23,16 @@ class Validator(ActionValidationBase):
repository: HacsIntegrationRepository
more_info = "https://hacs.xyz/docs/publish/include#check-manifest"
categories = [HacsCategory.INTEGRATION]
categories = (HacsCategory.INTEGRATION,)
async def async_validate(self):
async def async_validate(self) -> None:
"""Validate the repository."""
if RepositoryFile.MAINIFEST_JSON not in [x.filename for x in self.repository.tree]:
raise ValidationException(
f"The repository has no '{RepositoryFile.MAINIFEST_JSON}' file"
)
content = await self.repository.async_get_integration_manifest(self.repository.ref)
content = await self.repository.get_integration_manifest(version=self.repository.ref)
try:
INTEGRATION_MANIFEST_JSON_SCHEMA(content)
except Invalid as exception:

View File

@@ -1,8 +1,12 @@
from __future__ import annotations
from ..repositories.base import HacsRepository
from typing import TYPE_CHECKING
from .base import ActionValidationBase, ValidationException
if TYPE_CHECKING:
from ..repositories.base import HacsRepository
async def async_setup_validator(repository: HacsRepository) -> Validator:
"""Set up this validator."""
@@ -15,7 +19,7 @@ class Validator(ActionValidationBase):
more_info = "https://hacs.xyz/docs/publish/include#check-repository"
allow_fork = False
async def async_validate(self):
async def async_validate(self) -> None:
"""Validate the repository."""
if not self.repository.data.has_issues:
raise ValidationException("The repository does not have issues enabled")

View File

@@ -1,4 +1,5 @@
"""Hacs validation manager."""
from __future__ import annotations
import asyncio
@@ -7,13 +8,12 @@ import os
from pathlib import Path
from typing import TYPE_CHECKING
from homeassistant.core import HomeAssistant
from ..repositories.base import HacsRepository
from .base import ActionValidationBase
if TYPE_CHECKING:
from homeassistant.core import HomeAssistant
from ..base import HacsBase
from ..repositories.base import HacsRepository
from .base import ActionValidationBase
class ValidationManager:
@@ -23,16 +23,16 @@ class ValidationManager:
"""Initialize the setup manager class."""
self.hacs = hacs
self.hass = hass
self._validatiors: dict[str, ActionValidationBase] = {}
self._validators: dict[str, ActionValidationBase] = {}
@property
def validatiors(self) -> list[ActionValidationBase]:
def validators(self) -> list[ActionValidationBase]:
"""Return all list of all tasks."""
return list(self._validatiors.values())
return list(self._validators.values())
async def async_load(self, repository: HacsRepository) -> None:
"""Load all tasks."""
self._validatiors = {}
self._validators = {}
validator_files = Path(__file__).parent
validator_modules = (
module.stem
@@ -40,10 +40,10 @@ class ValidationManager:
if module.name not in ("base.py", "__init__.py", "manager.py")
)
async def _load_module(module: str):
async def _load_module(module: str) -> None:
task_module = import_module(f"{__package__}.{module}")
if task := await task_module.async_setup_validator(repository=repository):
self._validatiors[task.slug] = task
self._validators[task.slug] = task
await asyncio.gather(*[_load_module(task) for task in validator_modules])
@@ -59,9 +59,9 @@ class ValidationManager:
and os.getenv("GITHUB_REPOSITORY") != repository.data.full_name
)
validatiors = [
validators = [
validator
for validator in self.validatiors or []
for validator in self.validators or []
if (
(not validator.categories or repository.data.category in validator.categories)
and validator.slug not in os.getenv("INPUT_IGNORE", "").split(" ")
@@ -69,10 +69,10 @@ class ValidationManager:
)
]
await asyncio.gather(*[validator.execute_validation() for validator in validatiors])
await asyncio.gather(*[validator.execute_validation() for validator in validators])
total = len(validatiors)
failed = len([x for x in validatiors if x.failed])
total = len(validators)
failed = len([x for x in validators if x.failed])
if failed != 0:
repository.logger.error("%s %s/%s checks failed", repository.string, failed, total)

View File

@@ -1,8 +1,12 @@
from __future__ import annotations
from ..repositories.base import HacsRepository
from typing import TYPE_CHECKING
from .base import ActionValidationBase, ValidationException
if TYPE_CHECKING:
from ..repositories.base import HacsRepository
async def async_setup_validator(repository: HacsRepository) -> Validator:
"""Set up this validator."""
@@ -15,7 +19,7 @@ class Validator(ActionValidationBase):
more_info = "https://hacs.xyz/docs/publish/include#check-repository"
allow_fork = False
async def async_validate(self):
async def async_validate(self) -> None:
"""Validate the repository."""
if not self.repository.data.topics:
raise ValidationException("The repository has no valid topics")