mirror of
https://github.com/Abdess/retroarch_system.git
synced 2026-10-18 09:23:26 -05:00
362 lines
15 KiB
Python
362 lines
15 KiB
Python
"""Regression tests for the public website data and citation contracts."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import hashlib
|
|
import json
|
|
import sqlite3
|
|
import sys
|
|
import tempfile
|
|
import unittest
|
|
from pathlib import Path
|
|
|
|
ROOT = Path(__file__).resolve().parent.parent
|
|
sys.path.insert(0, str(ROOT / "scripts"))
|
|
|
|
from generate_site import ( # noqa: E402
|
|
_admonition_body,
|
|
_browser_title,
|
|
_forge_sources,
|
|
_source_ref_markdown,
|
|
decorate_markdown_pages,
|
|
generate_data_exports,
|
|
)
|
|
|
|
|
|
class SiteReferenceContracts(unittest.TestCase):
|
|
def setUp(self) -> None:
|
|
scratch = ROOT / "tmp" / "tests"
|
|
scratch.mkdir(parents=True, exist_ok=True)
|
|
self.temp = tempfile.TemporaryDirectory(dir=scratch)
|
|
self.docs = Path(self.temp.name) / "docs"
|
|
self.docs.mkdir()
|
|
|
|
def tearDown(self) -> None:
|
|
self.temp.cleanup()
|
|
|
|
@staticmethod
|
|
def _fixtures() -> tuple[dict, dict, dict, dict]:
|
|
payload = b"firmware"
|
|
sha1 = hashlib.sha1(payload).hexdigest()
|
|
md5 = hashlib.md5(payload).hexdigest()
|
|
sha256 = hashlib.sha256(payload).hexdigest()
|
|
db = {
|
|
"schema_version": 1,
|
|
"generated_at": "2026-08-09T00:00:00Z",
|
|
"total_files": 1,
|
|
"total_size": len(payload),
|
|
"files": {
|
|
sha1: {
|
|
"path": "bios/Test/fw.bin",
|
|
"name": "fw.bin",
|
|
"size": len(payload),
|
|
"sha1": sha1,
|
|
"md5": md5,
|
|
"sha256": sha256,
|
|
"crc32": "0f00ba11",
|
|
"adler32": "0f00ba11",
|
|
}
|
|
},
|
|
"indexes": {
|
|
"by_md5": {md5: sha1},
|
|
"by_name": {"fw.bin": [sha1]},
|
|
"by_crc32": {"0f00ba11": sha1},
|
|
"by_sha256": {sha256: sha1},
|
|
"by_path_suffix": {"fw.bin": [sha1]},
|
|
},
|
|
}
|
|
coverages = {
|
|
"test": {
|
|
"platform": "Test Platform",
|
|
"config": {
|
|
"platform": "Test Platform",
|
|
"cores": ["testemu"],
|
|
"systems": {
|
|
"test-system": {
|
|
"files": [
|
|
{
|
|
"name": "fw.bin",
|
|
"destination": "fw.bin",
|
|
"required": True,
|
|
"sha1": sha1,
|
|
"md5": "C87A52C277F7952B41C639FC7BF0A43B,"
|
|
"d0ed892a5e8d47e0cb5f8aa5f4dd7c5a",
|
|
"crc32": "3F9F95A4",
|
|
"size": len(payload),
|
|
}
|
|
]
|
|
}
|
|
},
|
|
},
|
|
"total": 1,
|
|
"present": 1,
|
|
"verified": 1,
|
|
"untested": 0,
|
|
"missing": 0,
|
|
"core_present": 1,
|
|
"core_missing": 0,
|
|
"core_unsourceable": 0,
|
|
"details": [],
|
|
}
|
|
}
|
|
profiles = {
|
|
"testemu": {
|
|
"emulator": "Test Emulator",
|
|
"type": "libretro",
|
|
"source": "https://github.com/example/emulator",
|
|
"source_commit": "a" * 40,
|
|
"cores": ["testemu"],
|
|
"systems": ["test-system"],
|
|
"files": [
|
|
{
|
|
"name": "fw.bin",
|
|
"system": "test-system",
|
|
"required": True,
|
|
"md5": ["5c124e7948ada85da603a522782940d0",
|
|
"4921d5f2165dee6e2496f4388c4c81b2"],
|
|
"source_ref": "src/firmware.cpp:10-12",
|
|
}
|
|
],
|
|
}
|
|
}
|
|
stats = {
|
|
"schema_version": 1,
|
|
"generated_at": "2026-08-09T00:00:00Z",
|
|
"files": 1,
|
|
"size_bytes": len(payload),
|
|
"platforms": 1,
|
|
"emulators": 1,
|
|
"systems": 1,
|
|
"catalog_matched": 0,
|
|
"source": "https://github.com/Abdess/retrobios",
|
|
"downloads": "https://github.com/Abdess/retrobios/releases/tag/v2026.08.06",
|
|
"composition": {
|
|
"systems": {"files": 1, "size_bytes": len(payload)},
|
|
"arcade": {"files": 0, "size_bytes": 0},
|
|
"game_data": {"files": 0, "size_bytes": 0},
|
|
},
|
|
}
|
|
return db, coverages, profiles, stats
|
|
|
|
def test_source_references_are_revision_pinned_links(self):
|
|
_, _, profiles, _ = self._fixtures()
|
|
rendered = _source_ref_markdown(
|
|
profiles["testemu"], "src/firmware.cpp:10-12"
|
|
)
|
|
self.assertIn("/blob/" + "a" * 40 + "/src/firmware.cpp#L10-L12", rendered)
|
|
|
|
def test_ambiguous_two_repository_path_is_never_linked(self):
|
|
"""A path that could live in either declared repository stays plain.
|
|
|
|
The libretro port and the original emulator are two different trees.
|
|
Linking an unattributable path to whichever came first publishes a
|
|
citation that resolves to nothing.
|
|
"""
|
|
profile = {
|
|
"source": "https://github.com/libretro/example-libretro",
|
|
"source_commit": "a" * 40,
|
|
"upstream": "https://gitlab.com/vendor/example",
|
|
"upstream_commit": "b" * 40,
|
|
}
|
|
rendered = _source_ref_markdown(profile, "jg.c:213-214")
|
|
self.assertEqual(rendered, "`jg.c:213-214`")
|
|
self.assertNotIn("http", rendered)
|
|
|
|
# A repository-name prefix removes the ambiguity, so it links again.
|
|
prefixed = _source_ref_markdown(profile, "example/jg.c:213-214")
|
|
self.assertIn("gitlab.com/vendor/example/-/blob/" + "b" * 40 + "/jg.c", prefixed)
|
|
|
|
def test_preprocessor_tokens_cannot_become_page_headings(self):
|
|
rendered = _admonition_body("First paragraph.\n\n#if FEATURE\nEnabled")
|
|
self.assertIn("\\#if FEATURE", rendered)
|
|
self.assertNotIn("\n #if FEATURE", rendered)
|
|
|
|
def test_browser_titles_distinguish_emulators_from_system_pages(self):
|
|
self.assertEqual(
|
|
_browser_title(Path("emulators/qemu.md"), "QEMU"),
|
|
"QEMU emulator firmware",
|
|
)
|
|
self.assertEqual(
|
|
_browser_title(Path("systems/qemu.md"), "QEMU"),
|
|
"QEMU systems",
|
|
)
|
|
|
|
ACCEPTED = (
|
|
("md5", "c87a52c277f7952b41c639fc7bf0a43b"),
|
|
("md5", "d0ed892a5e8d47e0cb5f8aa5f4dd7c5a"),
|
|
("crc32", "3f9f95a4"),
|
|
("md5", "4921d5f2165dee6e2496f4388c4c81b2"),
|
|
)
|
|
|
|
def test_exports_have_catalog_hashes_and_queryable_sqlite(self):
|
|
db, coverages, profiles, stats = self._fixtures()
|
|
exports = generate_data_exports(
|
|
self.docs, db, coverages, profiles, stats
|
|
)
|
|
catalog = json.loads((self.docs / "api/v1/catalog.json").read_text())
|
|
self.assertEqual(catalog["count"], len(exports))
|
|
# Every reference resolves against the catalog's own URL, as an
|
|
# RFC 3986 client resolves it: the url was relative to the site root
|
|
# and the schema to api/v1/, so neither base resolved both.
|
|
import urllib.parse # noqa: PLC0415
|
|
|
|
site = "https://example.org/site/"
|
|
base = site + "api/v1/catalog.json"
|
|
for item in catalog["items"]:
|
|
for key in ("url", "schema"):
|
|
if key in item:
|
|
target = urllib.parse.urljoin(base, item[key]).removeprefix(site)
|
|
self.assertTrue((self.docs / target).is_file(), (key, item[key]))
|
|
path = self.docs / urllib.parse.urljoin(base, item["url"]).removeprefix(site)
|
|
self.assertEqual(hashlib.sha256(path.read_bytes()).hexdigest(), item["sha256"])
|
|
|
|
with sqlite3.connect(self.docs / "downloads/retrobios.sqlite") as connection:
|
|
# One lowercase row per accepted value: a comma-joined Recalbox
|
|
# md5, a JSON array of accepted revisions and an uppercase crc32
|
|
# each missed an exact lookup.
|
|
for algorithm, value in self.ACCEPTED:
|
|
with self.subTest(algorithm=algorithm, value=value):
|
|
self.assertTrue(connection.execute(
|
|
"SELECT count(*) FROM accepted_hashes WHERE algorithm = ? AND value = ?",
|
|
(algorithm, value)).fetchone()[0])
|
|
self.assertEqual(connection.execute("SELECT count(*) FROM files").fetchone()[0], 1)
|
|
self.assertEqual(connection.execute("SELECT count(*) FROM platforms").fetchone()[0], 1)
|
|
self.assertEqual(connection.execute("SELECT count(*) FROM emulators").fetchone()[0], 1)
|
|
|
|
def test_page_metadata_is_specific_and_idempotent(self):
|
|
page = self.docs / "gaps.md"
|
|
page.write_text("# Gap Analysis - RetroBIOS\n\nCurrent unresolved entries.\n")
|
|
decorate_markdown_pages(self.docs)
|
|
decorate_markdown_pages(self.docs)
|
|
content = page.read_text()
|
|
self.assertEqual(content.count('type="application/ld+json"'), 1)
|
|
self.assertIn("Current RetroBIOS verification gaps", content)
|
|
self.assertIn('"@type":"TechArticle"', content)
|
|
|
|
|
|
class PerModeSourcePins(unittest.TestCase):
|
|
"""A profile whose builds live in separate repositories.
|
|
|
|
`source`, `upstream` and `source_commit` may each be keyed by build mode.
|
|
Reading the URL from one mode and the revision from another produces a
|
|
permalink into a tree that never held that line, and binding the object
|
|
form straight into SQLite fails outright.
|
|
"""
|
|
|
|
PROFILE = {
|
|
"emulator": "twobuilds",
|
|
"source": {
|
|
"standalone": "https://github.com/vendor/emu",
|
|
"libretro": "https://github.com/porter/emu-libretro",
|
|
},
|
|
"upstream": "https://github.com/vendor/emu",
|
|
"source_commit": {"standalone": "a" * 40, "libretro": "b" * 40},
|
|
}
|
|
|
|
def test_each_repository_keeps_its_own_revision(self):
|
|
pairs = {
|
|
(repo.slug, pin) for repo, pin in _forge_sources(self.PROFILE)
|
|
}
|
|
self.assertIn(("vendor/emu", "a" * 40), pairs)
|
|
self.assertIn(("porter/emu-libretro", "b" * 40), pairs)
|
|
# The libretro fork must never be pinned to the standalone revision.
|
|
self.assertNotIn(("porter/emu-libretro", "a" * 40), pairs)
|
|
self.assertNotIn(("vendor/emu", "b" * 40), pairs)
|
|
|
|
def test_a_build_mode_label_is_resolved_first(self):
|
|
repo, pin = _forge_sources(self.PROFILE, "libretro")[0]
|
|
self.assertEqual((repo.slug, pin), ("porter/emu-libretro", "b" * 40))
|
|
|
|
def test_the_plain_string_form_is_unchanged(self):
|
|
profile = {
|
|
"source": "https://github.com/vendor/emu",
|
|
"source_commit": "c" * 40,
|
|
}
|
|
self.assertEqual(
|
|
[(repo.slug, pin) for repo, pin in _forge_sources(profile)],
|
|
[("vendor/emu", "c" * 40)],
|
|
)
|
|
|
|
def test_sqlite_export_accepts_a_per_mode_commit(self):
|
|
from generate_site import _json_text
|
|
|
|
self.assertEqual(
|
|
_json_text(self.PROFILE["source_commit"]),
|
|
'{"libretro": "' + "b" * 40 + '", "standalone": "' + "a" * 40 + '"}',
|
|
)
|
|
self.assertEqual(_json_text("c" * 40), "c" * 40)
|
|
|
|
|
|
|
|
class AnEmulatorPageNamesItsRevision(unittest.TestCase):
|
|
"""The page linked the repositories unpinned; the commit every citation
|
|
refers to sat in the YAML alone, for 178 profiles."""
|
|
|
|
def test_each_repository_links_its_pinned_commit(self):
|
|
import generate_site # noqa: PLC0415
|
|
|
|
profile = {
|
|
"emulator": "Caprice32", "type": "libretro",
|
|
"source": "https://github.com/libretro/libretro-cap32",
|
|
"upstream": "https://github.com/ColinPitrat/caprice32",
|
|
"source_commit": "c" * 40, "upstream_commit": "6" * 40,
|
|
"source_branch": "main", "systems": ["amstrad-cpc"], "files": [],
|
|
}
|
|
page = generate_site.generate_emulator_page("cap32", profile, {"files": {}})
|
|
self.assertIn(
|
|
"| Revision | [libretro/libretro-cap32@cccccccccccc]"
|
|
"(https://github.com/libretro/libretro-cap32/commit/" + "c" * 40 + "), "
|
|
"[ColinPitrat/caprice32@666666666666]"
|
|
"(https://github.com/ColinPitrat/caprice32/commit/" + "6" * 40 + "), "
|
|
"branch `main` |",
|
|
page,
|
|
)
|
|
|
|
|
|
class APlatformPageSaysWhereEachFileGoes(unittest.TestCase):
|
|
"""Three GameCube IPL.bin were listed by name alone: nothing told which
|
|
goes to GC/USA, GC/EUR or GC/JAP."""
|
|
|
|
def test_same_named_files_show_their_destinations(self):
|
|
import generate_site # noqa: PLC0415
|
|
|
|
regions = ("USA", "EUR", "JAP")
|
|
declared = [{"name": "IPL.bin", "destination": f"dolphin-emu/Sys/GC/{r}/IPL.bin",
|
|
"sha1": str(i) * 40} for i, r in enumerate(regions)]
|
|
files = [{"name": "IPL.bin", "status": "ok"} for _ in regions]
|
|
lines = generate_site._render_platform_systems(
|
|
{"nintendo-gamecube": files}, {("nintendo-gamecube", "IPL.bin"): declared}, {})
|
|
for region in regions:
|
|
self.assertIn(f"- `IPL.bin` at `dolphin-emu/Sys/GC/{region}/IPL.bin` - OK",
|
|
"\n".join(lines))
|
|
|
|
|
|
class AVariantShowsWhoPinsIt(unittest.TestCase):
|
|
"""A .variants/ file showed a name and a truncated MD5: the advision.zip
|
|
Batocera and RetroBat pin named no platform."""
|
|
|
|
def test_the_variant_card_names_its_readers(self):
|
|
import types # noqa: PLC0415
|
|
|
|
import generate_site # noqa: PLC0415
|
|
|
|
primary = {"name": "advision.zip", "path": "bios/Entex/Adventure Vision/advision.zip",
|
|
"sha1": "a" * 40, "md5": "b" * 32, "size": 3000}
|
|
variant = {"name": "advision.zip",
|
|
"path": "bios/Entex/Adventure Vision/.variants/advision.zip.1c086064",
|
|
"sha1": "c" * 40, "md5": "1c086064" + "0" * 24, "size": 3000,
|
|
"provenance": {"tosec": {"name": "x"}}}
|
|
consumers = types.SimpleNamespace(
|
|
platforms={"c" * 40: {"batocera", "retrobat"}}, emulators={"a" * 40: {"mame"}})
|
|
page = generate_site.generate_system_page(
|
|
"Entex", {"Adventure Vision": [primary, variant]}, consumers)
|
|
block = page[page.index('??? note "Variants (1)"'):]
|
|
self.assertIn(" - Collection path: `bios/Entex/Adventure Vision/.variants/advision.zip.1c086064`", block)
|
|
self.assertIn("[batocera](../platforms/batocera.md)", block)
|
|
self.assertIn("[retrobat](../platforms/retrobat.md)", block)
|
|
self.assertIn('`' + "c" * 40 + '`', block)
|
|
self.assertIn("Verified dump", block)
|
|
|
|
if __name__ == "__main__":
|
|
unittest.main()
|