Glean testing coverage

android-components.csv

fenix.csv

test_coverage_detector.py

# Find metrics that never use the Glean testing API

import argparse
from pathlib import Path
import sys

from glean_parser import parser, util


def find_testing_apis(
    metric_names,
    testing_apis=["testGetValue", "testHasValue", "testGetNumRecordedErrors"],
):
    results = {x: False for x in metric_names}

    for filename in root_dir.glob("**/*.kt"):
        with open(filename, "r", encoding="utf8") as fd:
            content = fd.read()

        for category, name in metric_names:
            kotlin_id = f"{util.Camelize(category)}.{util.camelize(name)}"
            for api in testing_apis:
                testing_id = f"{kotlin_id}.{api}"
                if testing_id in content:
                    results[(category, name)] = True

    return results


argparser = argparse.ArgumentParser(
    "Determine the Glean metric testing coverage for an Android project"
)
argparser.add_argument(
    "root_dir", type=str, nargs=1, help="Root directory of the project to analyse"
)
args = argparser.parse_args()
root_dir = Path(args.root_dir[0]).resolve()

metrics_files = list(
    x for x in root_dir.glob("**/metrics.yaml") if "gecko" not in str(x)
)
metrics = parser.parse_objects(metrics_files)
if util.report_validation_errors(metrics):
    sys.exit(1)

metric_names = set()
for category_name, category in metrics.value.items():
    for metric_name, metric in category.items():
        metric_names.add((category_name, metric_name))

results = find_testing_apis(metric_names)

print("category,name,tested")
for (category, name), tested in sorted(list(results.items())):
    print(f"{category},{name},{tested}")