TheRock/rocm-systems/projects/hip-tests/catch/config/check_sources.py

# Copyright (c) Advanced Micro Devices, Inc., or its affiliates.
#
# SPDX-License-Identifier: MIT

import argparse
import os
import re
import sys

from common import NON_UNIT_GROUPS, iter_group_configs, ERROR, WARNING, RESET

CPP_EXTENSIONS = (".cc", ".cpp", ".cxx", ".c++", ".C", ".cp", ".CPP")

def find_source_test_cases(source_root, group, is_unit):
    if is_unit:
        source_dir = os.path.join(source_root, "unit", group)
    else:
        source_dir = os.path.join(source_root, group)

    if not os.path.isdir(source_dir):
        return set()

    test_names = set()
    # NOTE: This regex does not skip commented-out test cases (// or /* */).
    # A commented-out HIP_TEST_CASE will still be detected as a source test
    # and flagged as missing if it has no YAML entry.
    pattern = re.compile(
        r'\b(?:HIP_TEST_CASE|HIP_TEMPLATE_TEST_CASE|TEST_CASE|TEMPLATE_TEST_CASE)'
        r'\(\s*(?:"([^"]*)"|(\w+))\s*[,)]'
    )
    for root, _, files in os.walk(source_dir):
        for filename in files:
            if not filename.endswith(CPP_EXTENSIONS):
                continue
            filepath = os.path.join(root, filename)
            with open(filepath, errors="replace") as f:
                content = f.read()
            for match in pattern.finditer(content):
                test_names.add(match.group(1) or match.group(2))

    return test_names


def is_unit_group(group):
    return group not in NON_UNIT_GROUPS


def parse_args():
    parser = argparse.ArgumentParser(
        description="Check that every Catch2 test case found in the source "
        "tree has a corresponding entry in the YAML configs.",
    )
    parser.add_argument(
        "configs_path",
        help="Path to the directory containing YAML config files.",
    )
    parser.add_argument(
        "source_root",
        help="Root directory of the Catch2 test source files.",
    )
    return parser.parse_args()


def main():
    args = parse_args()

    configs_path = args.configs_path
    source_root = args.source_root

    missing = []

    for group, cases in iter_group_configs(configs_path):
        yaml_names = set(cases.keys())
        source_names = find_source_test_cases(
            source_root, group, is_unit=is_unit_group(group)
        )
        for name in sorted(source_names - yaml_names):
            missing.append(f"  {group}/{name}")

    if missing:
        strict = os.environ.get("THEROCK_REQUIRE_HIP_YAML_ENTRIES", "").strip().lower() in ("1", "true", "yes", "on")
        level = "ERROR" if strict else "WARNING"
        color = ERROR if strict else WARNING
        print(
            f"[check_sources] {color}{level}: The following Catch2 test cases have no entry in their YAML config:{RESET}",
            file=sys.stderr,
        )
        for entry in missing:
            print(f"[check_sources] {color}{entry}{RESET}", file=sys.stderr)
        if strict:
            sys.exit(1)


if __name__ == "__main__":
    main()