usda-hass-config/custom_components/hacs/validate
root 873064d680 working 2.0 clone 2024-10-01 14:06:39 +00:00
..
README.md working 2.0 clone 2024-10-01 14:06:39 +00:00
__init__.py working 2.0 clone 2024-10-01 14:06:39 +00:00
archived.py working 2.0 clone 2024-10-01 14:06:39 +00:00
base.py working 2.0 clone 2024-10-01 14:06:39 +00:00
brands.py working 2.0 clone 2024-10-01 14:06:39 +00:00
description.py working 2.0 clone 2024-10-01 14:06:39 +00:00
hacsjson.py working 2.0 clone 2024-10-01 14:06:39 +00:00
images.py working 2.0 clone 2024-10-01 14:06:39 +00:00
information.py working 2.0 clone 2024-10-01 14:06:39 +00:00
integration_manifest.py working 2.0 clone 2024-10-01 14:06:39 +00:00
issues.py working 2.0 clone 2024-10-01 14:06:39 +00:00
manager.py working 2.0 clone 2024-10-01 14:06:39 +00:00
topics.py working 2.0 clone 2024-10-01 14:06:39 +00:00

README.md

Repository validation

This is where the validation rules that run against the various repository categories live.

Structure

  • There is one file pr. rule.
  • All rule needs tests to verify every possible outcome for the rule.
  • It's better with multiple files than a big rule.
  • All rules uses ActionValidationBase as the base class.
  • Only use validate or async_validate methods to define validation rules.
  • If a rule should fail, raise ValidationException with the failure message.

Example

from .base import (
    ActionValidationBase,
    ValidationBase,
    ValidationException,
)

class SuperAwesomeRepository(ActionValidationBase):
    category = "integration"

    async def async_validate(self):
        if self.repository != "super-awesome":
            raise ValidationException("The repository is not super-awesome")