tooling/validation/engines/python_checks/__init__.py at b95c98521859097edee3ecc82bae9945dd3bcbbd · hdamker/tooling · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
# Python check registry.
# Each check is a CheckDescriptor with name, scope, and function.
# The CHECKS list defines execution order.

from __future__ import annotations

from ._types import CheckDescriptor, CheckScope

from .error_code_checks import check_conflict_deprecated, check_contextcode_format
from .filename_checks import check_filename_kebab_case, check_filename_matches_api_name
from .info_description_checks import check_info_description_templates
from .metadata_checks import check_commonalities_version
from .readme_checks import (
    check_api_readiness_checklist_removal,
    check_readme_placeholder_removal,
)
from .common_cache_checks import check_common_cache_sync
from .release_plan_checks import (
    check_declared_dependency_tags_exist,
    check_orphan_api_definitions,
    check_release_plan_active_release_state,
    check_release_plan_api_names_unique,
    check_release_plan_exclusivity,
    check_release_plan_semantics,
)
from .release_review_checks import check_release_review_file_restriction
from .subscription_checks import (
    check_cloudevent_via_ref,
    check_event_type_format,
    check_sinkcredential_not_in_response,
    check_subscription_filename,
)
from .test_checks import (
    check_test_directory_exists,
    check_test_file_version,
    check_test_files_exist,
)
from .version_checks import (
    check_feature_file_url_version,
    check_info_version_format,
    check_server_url_api_name,
    check_server_url_version,
)

# Ordered registry.  Execution order matches this list.
# Adding a new check: import the function and append a CheckDescriptor.
CHECKS: list[CheckDescriptor] = [
    # --- Per-API checks (run once per API in context.apis) ---
    CheckDescriptor("check-filename-kebab-case", CheckScope.API, check_filename_kebab_case),
    CheckDescriptor("check-filename-matches-api-name", CheckScope.API, check_filename_matches_api_name),
    CheckDescriptor("check-info-version-format", CheckScope.API, check_info_version_format),
    CheckDescriptor("check-server-url-version", CheckScope.API, check_server_url_version),
    CheckDescriptor("check-server-url-api-name", CheckScope.API, check_server_url_api_name),
    CheckDescriptor("check-test-files-exist", CheckScope.API, check_test_files_exist),
    CheckDescriptor("check-test-file-version", CheckScope.API, check_test_file_version),
    CheckDescriptor("check-feature-file-url-version", CheckScope.API, check_feature_file_url_version),
    CheckDescriptor("check-commonalities-version", CheckScope.API, check_commonalities_version),
    CheckDescriptor("check-subscription-filename", CheckScope.API, check_subscription_filename),
    CheckDescriptor("check-event-type-format", CheckScope.API, check_event_type_format),
    CheckDescriptor("check-sinkcredential-not-in-response", CheckScope.API, check_sinkcredential_not_in_response),
    CheckDescriptor("check-cloudevent-via-ref", CheckScope.API, check_cloudevent_via_ref),
    CheckDescriptor("check-conflict-deprecated", CheckScope.API, check_conflict_deprecated),
    CheckDescriptor("check-contextcode-format", CheckScope.API, check_contextcode_format),
    CheckDescriptor(
        "check-info-description-mandatory-missing",
        CheckScope.API,
        check_info_description_templates,
    ),
    # --- Repo-level checks (run once) ---
    CheckDescriptor("check-test-directory-exists", CheckScope.REPO, check_test_directory_exists),
    CheckDescriptor("check-release-plan-semantics", CheckScope.REPO, check_release_plan_semantics),
    CheckDescriptor("check-release-plan-api-names-unique", CheckScope.REPO, check_release_plan_api_names_unique),
    CheckDescriptor("check-readme-placeholder-removal", CheckScope.REPO, check_readme_placeholder_removal),
    CheckDescriptor("check-api-readiness-checklist-removal", CheckScope.REPO, check_api_readiness_checklist_removal),
    CheckDescriptor("check-release-review-file-restriction", CheckScope.REPO, check_release_review_file_restriction),
    CheckDescriptor("check-orphan-api-definitions", CheckScope.REPO, check_orphan_api_definitions),
    CheckDescriptor("check-common-cache-sync", CheckScope.REPO, check_common_cache_sync),
    CheckDescriptor("check-release-plan-exclusivity", CheckScope.REPO, check_release_plan_exclusivity),
    CheckDescriptor("check-release-plan-active-release-state", CheckScope.REPO, check_release_plan_active_release_state),
    CheckDescriptor("check-declared-dependency-tags-exist", CheckScope.REPO, check_declared_dependency_tags_exist),
]

__all__ = ["CHECKS", "CheckDescriptor", "CheckScope"]