check-endpoints.py

#!/usr/bin/env python3

from __future__ import annotations

import yaml
import re
import sys
import os


if len(sys.argv) != 2 or not os.path.isfile(sys.argv[1]):
    path = "../api/doc/specs/lichess-api.yaml"
    if not os.path.isfile(path):
        print(
            "Usage: check-endpoints.py <path to lichess-api.yaml from lichess-org/api repo>"
        )
        exit(1)
else:
    path = sys.argv[1]


with open(path) as f:
    spec = yaml.load(f, Loader=yaml.SafeLoader)

with open("berserk/clients.py", "r") as f:
    clients_content = f.read()


missing_endpoints: list[str] = []

for endpoint, data in spec["paths"].items():
    # Remove leading slash
    endpoint_without_slash = endpoint[1:]

    # Replace parameter placeholders with regular expression
    endpoint_regex = '"/' + re.sub(r"{[^/]+?}", r"[^/]+?", endpoint_without_slash) + '"'

    # Check if endpoint or a variation of it is present in file
    if not re.search(endpoint_regex, clients_content):
        if servers := data.get("servers"):
            if host := servers[0].get("url"):
                endpoint = host + endpoint
        missing_endpoints.append(endpoint)

if missing_endpoints:
    print("\nMissing endpoints:\n")
    for endp in sorted(missing_endpoints):
        print(endp)
else:
    print("No missing endpoints")