mirror of
https://github.com/Gathin23/cleanyourtv.git
synced 2026-11-05 21:06:40 +00:00
Gathin23
2ee1d306d9
After a list merges, main's tables and counts lag until they are regenerated. As a failing unit test that turned "Lists, tools and docs" red, which is also the signal the merge bot waits on between merges, so a wave would stop at its first list. The check now runs as its own job, which the bot can leave out while its counts step regenerates the tables after the wave. The strict unit tests that compared the committed tables and the alt-text count with the folders go: the job's gen_tables.py --check covers both.
83 lines
3.3 KiB
Python
83 lines
3.3 KiB
Python
"""Checks every TV list in examples/ and the two tables that index them.
|
|
|
|
The tables are generated from each folder's tv.json by tools/gen_tables.py. Here only the tv.json files
|
|
are checked; that the committed tables and counts are what the script writes is CI's "README tables" job,
|
|
on main only, kept apart so a list merge waiting for its regenerated tables doesn't turn these tests red.
|
|
|
|
Run from the repository root: python3 -m unittest discover -s tests -v
|
|
"""
|
|
import re
|
|
import sys
|
|
from pathlib import Path
|
|
import unittest
|
|
|
|
|
|
ROOT = Path(__file__).resolve().parents[1]
|
|
sys.path.insert(0, str(ROOT / "tools"))
|
|
import gen_tables # noqa: E402 (needs tools/ on the path first)
|
|
|
|
EXAMPLES = ROOT / "examples"
|
|
PACKAGE = re.compile(r"^[A-Za-z_][A-Za-z0-9_]*(\.[A-Za-z0-9_]+)+$")
|
|
|
|
|
|
def folders():
|
|
return sorted(p for p in EXAMPLES.iterdir() if p.is_dir())
|
|
|
|
|
|
def table_rows(path, header_prefix):
|
|
"""Rows of the first markdown table whose header starts with header_prefix."""
|
|
lines = path.read_text(encoding="utf-8").split("\n")
|
|
start = next(i for i, l in enumerate(lines) if l.startswith(header_prefix))
|
|
rows = []
|
|
for line in lines[start + 2:]:
|
|
if not line.startswith("|"):
|
|
break
|
|
rows.append(line)
|
|
return rows
|
|
|
|
|
|
class ExampleListsTest(unittest.TestCase):
|
|
def test_every_folder_has_a_list(self):
|
|
for folder in folders():
|
|
with self.subTest(folder=folder.name):
|
|
self.assertTrue((folder / "debloat.txt").is_file(), "no debloat.txt")
|
|
|
|
def test_list_format(self):
|
|
for folder in folders():
|
|
path = folder / "debloat.txt"
|
|
if not path.is_file():
|
|
continue
|
|
with self.subTest(folder=folder.name):
|
|
lines = path.read_text(encoding="utf-8").split("\n")
|
|
self.assertTrue(lines and lines[0].startswith("#"),
|
|
"first line should be a comment naming the TV, Android version and build")
|
|
packages = []
|
|
for n, line in enumerate(lines, 1):
|
|
body = line.split("#", 1)[0].strip()
|
|
if not body:
|
|
continue
|
|
self.assertRegex(body, PACKAGE, f"line {n}: not a package name: {line!r}")
|
|
packages.append(body)
|
|
self.assertTrue(packages, "no packages: notes without a list belong in docs/devices/")
|
|
dupes = sorted({p for p in packages if packages.count(p) > 1})
|
|
self.assertFalse(dupes, f"listed twice: {dupes}")
|
|
|
|
def test_every_folder_has_a_valid_tv_json(self):
|
|
try:
|
|
gen_tables.load(ROOT)
|
|
except gen_tables.Problem as e:
|
|
self.fail(str(e))
|
|
|
|
def test_readme_table_has_one_row_per_list(self):
|
|
readme_rows = table_rows(ROOT / "README.md", "| TV | OS |")
|
|
example_rows = table_rows(EXAMPLES / "README.md", "| Folder |")
|
|
self.assertEqual(len(readme_rows), len(example_rows),
|
|
"README.md TV table and examples/README.md have a different number of rows")
|
|
readme_tvs = sorted(r.split("|")[1].strip() for r in readme_rows)
|
|
example_tvs = sorted(r.split("|")[2].strip() for r in example_rows)
|
|
self.assertEqual(readme_tvs, example_tvs, "the TV column differs between the two tables")
|
|
|
|
|
|
if __name__ == "__main__":
|
|
unittest.main()
|