mirror of
https://github.com/Abdess/retroarch_system.git
synced 2026-10-13 23:13:23 -05:00
feat: make packs reproducible byte for byte
Two builds of the same pack from the same inputs produced different archives. Of 67 members, 65 were already identical: only README.txt and manifest.json differed, both stamped with the wall clock by writestr and the second carrying a generated timestamp. Generated members now use the epoch the archive rebuilder already applies, and the timestamp comes from the database snapshot the pack was built from, so the same data yields the same bytes. Install manifests skipped archived platforms, which is why RetroPie had none; archived means upstream is no longer scraped, not that the packs stopped shipping. A target-filtered manifest also had no record of its filter beyond the filename, so it carries one the way a region-filtered manifest already does.
This commit is contained in:
1 parent
dc14089932
commit
24e9b820ae
3 files changed
+370
-63
No files matched your search
@@ -2,7 +2,9 @@
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import hashlib
|
||||
import tempfile
|
||||
import time
|
||||
import unittest
|
||||
import zipfile
|
||||
from pathlib import Path
|
||||
@@ -152,5 +154,100 @@ class TestVerifyDeterminism(unittest.TestCase):
|
||||
self.assertEqual(original, rebuilt)
|
||||
|
||||
|
||||
class TestPackDeterminism(unittest.TestCase):
|
||||
"""A pack is a function of its inputs, not of the clock it was built on."""
|
||||
|
||||
def setUp(self):
|
||||
self._tmp = tempfile.TemporaryDirectory()
|
||||
self.tmp = Path(self._tmp.name)
|
||||
self.bios = self.tmp / "bios"
|
||||
self.platforms = self.tmp / "platforms"
|
||||
self.bios.mkdir()
|
||||
self.platforms.mkdir()
|
||||
|
||||
payload = b"DETERMINISM_PAYLOAD"
|
||||
(self.bios / "boot.rom").write_bytes(payload)
|
||||
sha1 = hashlib.sha1(payload).hexdigest()
|
||||
self.db = {
|
||||
"generated_at": "2026-01-02T03:04:05Z",
|
||||
"files": {
|
||||
sha1: {
|
||||
"path": str(self.bios / "boot.rom"),
|
||||
"name": "boot.rom",
|
||||
"size": len(payload),
|
||||
"sha1": sha1,
|
||||
"md5": hashlib.md5(payload).hexdigest(),
|
||||
},
|
||||
},
|
||||
"indexes": {
|
||||
"by_md5": {hashlib.md5(payload).hexdigest(): sha1},
|
||||
"by_name": {"boot.rom": [sha1]},
|
||||
"by_crc32": {},
|
||||
"by_sha256": {},
|
||||
"by_path_suffix": {},
|
||||
},
|
||||
}
|
||||
(self.platforms / "detplat.yml").write_text(
|
||||
"platform: DetPlat\n"
|
||||
"verification_mode: existence\n"
|
||||
"base_destination: system\n"
|
||||
"systems:\n"
|
||||
" test-sys:\n"
|
||||
" files:\n"
|
||||
" - name: boot.rom\n"
|
||||
" destination: boot.rom\n"
|
||||
" required: true\n"
|
||||
)
|
||||
|
||||
def tearDown(self):
|
||||
self._tmp.cleanup()
|
||||
|
||||
def _build(self, out_name: str) -> Path:
|
||||
from scripts.generate_pack import generate_pack
|
||||
|
||||
out = self.tmp / out_name
|
||||
out.mkdir()
|
||||
path = generate_pack(
|
||||
"detplat", str(self.platforms), self.db, str(self.bios), str(out),
|
||||
offline=True,
|
||||
)
|
||||
self.assertIsNotNone(path)
|
||||
return Path(path)
|
||||
|
||||
def test_two_builds_are_byte_identical(self):
|
||||
first = self._build("out1")
|
||||
time.sleep(2.1) # ZIP mtimes are 2s-granular: cross a whole tick
|
||||
second = self._build("out2")
|
||||
self.assertEqual(
|
||||
hashlib.sha256(first.read_bytes()).hexdigest(),
|
||||
hashlib.sha256(second.read_bytes()).hexdigest(),
|
||||
)
|
||||
|
||||
def test_generated_members_carry_the_fixed_epoch(self):
|
||||
pack = self._build("out1")
|
||||
with zipfile.ZipFile(pack) as zf:
|
||||
generated = [
|
||||
i for i in zf.infolist()
|
||||
if i.filename.rsplit("/", 1)[-1].startswith(
|
||||
("README.txt", "INSTRUCTIONS_", "RENAMED_")
|
||||
)
|
||||
]
|
||||
self.assertTrue(generated, "pack should carry a generated README")
|
||||
for info in generated:
|
||||
self.assertEqual(info.date_time, _FIXED_DATE_TIME)
|
||||
|
||||
def test_injected_manifest_is_pinned_to_the_database(self):
|
||||
from scripts.generate_pack import inject_manifest, verify_pack
|
||||
|
||||
pack = self._build("out1")
|
||||
ok, manifest = verify_pack(str(pack), self.db)
|
||||
self.assertTrue(ok, manifest.get("errors"))
|
||||
self.assertEqual(manifest["generated"], self.db["generated_at"])
|
||||
inject_manifest(str(pack), manifest)
|
||||
with zipfile.ZipFile(pack) as zf:
|
||||
info = zf.getinfo("manifest.json")
|
||||
self.assertEqual(info.date_time, _FIXED_DATE_TIME)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
Reference in new issue
Block a user