Skip to main content

infrahub_sdk.ctl.check

Functions​

callback ​

callback() -> None

Execute user-defined checks.

run ​

run() -> None

Locate and execute all checks under the defined path.

run_check ​

run_check(check_module: CheckModule, client: InfrahubClient, format_json: bool, path: str, repository_config: InfrahubRepositoryConfig, branch: str | None = None, params: dict | None = None) -> bool

run_targeted_check ​

run_targeted_check(check_module: CheckModule, client: InfrahubClient, format_json: bool, path: str, repository_config: InfrahubRepositoryConfig, variables: dict[str, str], branch: str | None = None) -> bool

run_checks ​

run_checks(check_modules: list[CheckModule], format_json: bool, path: str, variables: dict[str, str], repository_config: InfrahubRepositoryConfig, branch: str | None = None) -> None

get_modules ​

get_modules(check_definitions: list[InfrahubCheckDefinitionConfig]) -> list[CheckModule]

list_checks ​

list_checks(repository_config: InfrahubRepositoryConfig) -> None

Classes​

CheckModule ​