validate-schema.py

"""
A simple script to validate all series YAMLs.

This does not enforce `format` as this is auto-off in JSON Schema's spec.

Note that this does some monkey-patching to dodge around features of PyYAML.
"""
import logging
from pathlib import Path
import re
from jsonschema import FormatChecker
from jsonschema.validators import extend, validate, Draft202012Validator
import yaml, json

# Bodge to ignore dates and just use as-is.
# This makes this script unsafe to import!
yaml.SafeLoader.yaml_implicit_resolvers = {
    k: [r for r in v if r[0] != 'tag:yaml.org,2002:timestamp'] for
    k, v in yaml.SafeLoader.yaml_implicit_resolvers.items()
}

Validator = extend(Draft202012Validator, format_checker=FormatChecker())


def checkFile(schema, filename: Path):
    if filename.suffix!='.yml' or re.search(r'[^a-zA-Z0-9_\-\.\(\)]', filename.stem):
        raise ValueError("bad filename " + filename.name)
    with open(filename, encoding="utf-8") as f:
        series = yaml.safe_load(f)
    validate(series, schema, cls=Validator)

    # now check lists of games
    series_games = set(series['games'])
    found_games = set()
    for rando in series['randomizers']:
        rando_games = set(rando['games'])
        found_games.update(rando_games)
        undefined_games = rando_games.difference(series_games)
        if undefined_games:
            raise ValueError("undefined games in " + rando['identifier'] + " : " + ', '.join(undefined_games))
    
    unused_games = series_games.difference(found_games)
    if unused_games:
        raise ValueError("unused games: " + ', '.join(unused_games))



if __name__ == "__main__":
    errored = False
    with open("src/schemata/series.schema.json") as f:
        schema = json.load(f)
    
    for filename in Path("src/series/").glob("*"):
        try:
            checkFile(schema, filename)
        except Exception as e:
            logging.basicConfig(format=filename.name + ": %(message)s")
            logging.error(e)
            errored = True
    
    if errored:
        exit(-1)  # Error code to cause gh actions failure