Harden release packaging and recoverable installation after review

This commit is contained in:
bholman committed 2026-11-18 16:26:25 -07:00
1 parent cb40fed3b9
commit 8088c1fbf6
14 files changed
+933 -101

No files matched your search

+54 -7
View File
@@ -1,10 +1,20 @@
"""Check release integrity boundaries against a real completed local build."""
import json,sys,tempfile,unittest,zipfile
import hashlib,json,os,sys,tempfile,unittest,zipfile
from pathlib import Path
ROOT=Path(__file__).resolve().parents[1]
sys.path.insert(0,str(ROOT/'tools'))
from release import default_config,make_release,SSC
from release import (default_config,make_release,qualify_inputs,committed_tree,
committed_blob,source_member,SSC)
def selected_path(variable,default):
path=Path(os.environ.get(variable,str(default))).expanduser()
return (path if path.is_absolute() else ROOT/path).resolve()
BUILD=selected_path('COCO3PLUS_TEST_BUILD',ROOT/'build/fpga')
RELEASE=selected_path('COCO3PLUS_TEST_RELEASE',ROOT/'dist/coco3plus')
def digest(data):return hashlib.sha256(data).hexdigest()
class ReleaseGuards(unittest.TestCase):
def require_files(self,*paths):
missing=[str(p) for p in paths if not p.is_file()]
if missing:self.skipTest('Actual local dependency unavailable: '+', '.join(missing))
def test_fresh_profile_preserves_status_contract(self):
data=default_config(True);self.assertEqual(len(data),16)
value=int.from_bytes(data,'little')
@@ -13,6 +23,16 @@ class ReleaseGuards(unittest.TestCase):
self.assertEqual([(value>>(43+3*i))&7 for i in range(4)],[6,3,1,2])
self.assertEqual(value^int.from_bytes(default_config(False),'little'),1<<42)
def test_changed_ssc_fails_before_creating_output(self):
# A preserved historical fit is not automatically a release-qualified
# receipt. Do not modify it merely to reach a later ROM-input guard.
self.require_files(BUILD/'build.json',BUILD/'project/output_files/CoCo3.rbf')
record=json.loads((BUILD/'build.json').read_text())
if 'project_inventory_sha256' not in record:
with self.assertRaisesRegex(RuntimeError,'Legacy FPGA receipt lacks'):
qualify_inputs(record)
self.skipTest('SSC packaging test requires a new inventory-qualified fit; legacy evidence preserved')
self.require_files(*(ROOT/'roms/ssc'/name for name in SSC),
ROOT/'build/roms/boot0.rom',ROOT/'build/roms/boot1.rom')
with tempfile.TemporaryDirectory(dir=ROOT/'build') as folder:
base=Path(folder);roms=base/'roms';roms.mkdir()
for name in SSC:
@@ -21,13 +41,40 @@ class ReleaseGuards(unittest.TestCase):
chip=roms/'pic-7040-510.bin';data=bytearray(chip.read_bytes());data[-1]^=1;chip.write_bytes(data)
out=base/'release'
with self.assertRaisesRegex(RuntimeError,'incorrect input'):
make_release(out,ROOT/'build/fpga',ROOT/'build/roms',roms)
make_release(out,BUILD,ROOT/'build/roms',roms)
self.assertFalse(out.exists())
def test_corresponding_source_contains_no_local_roms(self):
release=ROOT/'dist/coco3plus'
with zipfile.ZipFile(release/'corresponding-source.zip') as archive:
names=archive.namelist();self.assertTrue(any(n.endswith('/rtl/coco3fpga.sv') for n in names))
self.assertFalse(any('/roms/ssc/' in n or '/.deps/' in n or '/build/' in n for n in names))
release=RELEASE
outer=release.with_name(release.name+'.zip')
self.require_files(release/'manifest.json',release/'corresponding-source.zip',outer)
record=json.loads((release/'manifest.json').read_text())
self.assertIn('source_files',record,'Select a newly qualified package; historical package predates source inventory')
tree=committed_tree(record['source_revision'])
expected=sorted(name for name in tree if source_member(name))
self.assertEqual(record['source_files'],expected)
self.assertEqual(record['corresponding_source_sha256'],digest((release/'corresponding-source.zip').read_bytes()))
greg='LICENSES/Greg-Miller-BSD-3-Clause.txt'
self.assertIn(greg,tree,'Selected release revision lacks the committed Greg Miller notice')
notice=committed_blob(tree[greg])
with zipfile.ZipFile(release/'corresponding-source.zip') as archive:
names=archive.namelist();self.assertEqual(set(names),{'coco3plus/'+n for n in expected})
self.assertTrue(any(n.endswith('/rtl/coco3fpga.sv') for n in names))
self.assertFalse(any('/roms/ssc/' in n or '/.deps/' in n or '/build/' in n for n in names))
self.assertFalse(any(n.endswith(('.rbf','.pdf','.docx','.xlsx','.bin','.rom')) for n in names))
self.assertEqual(archive.read('coco3plus/'+greg),notice)
notice_key='games/coco3plus/licenses/Greg-Miller-BSD-3-Clause.txt'
self.assertIn(notice_key,record['files'])
self.assertEqual((release/'fat'/notice_key).read_bytes(),notice)
with zipfile.ZipFile(outer) as archive:
self.assertEqual(set(archive.namelist()),
{p.relative_to(release).as_posix() for p in release.rglob('*') if p.is_file()})
self.assertEqual(archive.read('fat/'+notice_key),notice)
self.assertEqual(archive.read('corresponding-source.zip'),(release/'corresponding-source.zip').read_bytes())
self.assertIn('git checkout --detach '+record['source_revision'],archive.read('SOURCE-CHECKOUT.txt').decode())
self.assertEqual(json.loads(archive.read('manifest.json')),record)
for name,identity in record['files'].items():
data=archive.read('fat/'+name)
self.assertEqual(len(data),identity['bytes'],name)
self.assertEqual(digest(data),identity['sha256'],name)
self.assertEqual(record['files']['config/coco3plus_v51.CFG']['policy'],'create-if-missing')
if __name__=='__main__':unittest.main()