mirror of
https://github.com/mikecarper/MeshCore.git
synced 2026-10-20 22:01:58 +00:00
287 lines
19 KiB
Python
287 lines
19 KiB
Python
#!/usr/bin/env python3
|
|
import importlib.util
|
|
import json
|
|
from pathlib import Path
|
|
import tempfile
|
|
import unittest
|
|
import subprocess
|
|
import sys
|
|
import hashlib
|
|
from unittest.mock import patch
|
|
import zipfile
|
|
|
|
ROOT = Path(__file__).resolve().parents[1]
|
|
spec = importlib.util.spec_from_file_location("package_cascade_release", ROOT / "scripts/package_cascade_release.py")
|
|
package = importlib.util.module_from_spec(spec)
|
|
spec.loader.exec_module(package)
|
|
from motalib import FwIdent, Nrf52Layout, ensure_endf, ensure_nrf52_layout, target_id_for_env
|
|
|
|
|
|
class ReleaseQualificationTest(unittest.TestCase):
|
|
def test_portable_exclusions_require_a_complete_summary(self):
|
|
self.assertEqual(package.portable_profile_exclusions({}), [])
|
|
with tempfile.TemporaryDirectory() as temp:
|
|
log = Path(temp) / "matrix.log"
|
|
status = {"log": str(log)}
|
|
header = "2 standard ESP32 target(s) exceeded the portable OTA slot and were deferred to the expanded FULL pass:\n"
|
|
for body in ("DEFERRED: one (standard)\n", header + " one\n", header + " one\n one\n"):
|
|
log.write_text(body)
|
|
with self.assertRaisesRegex(ValueError, "exclusion summary"):
|
|
package.portable_profile_exclusions(status)
|
|
log.write_text(header + " one\n two\nLogging matrix completed successfully.\n")
|
|
self.assertEqual([r["target"] for r in package.portable_profile_exclusions(status)], ["one", "two"])
|
|
|
|
def test_partial_matrix_requires_completion_and_an_explicit_opt_in(self):
|
|
self.assertEqual(package.completed_matrix_failures({"state": "completed", "exit_code": "0"}), [])
|
|
for state, code in (("running", "0"), ("starting", "0"), ("failed", "143")):
|
|
with self.subTest(state=state, code=code), self.assertRaisesRegex(ValueError, "finished matrix"):
|
|
package.completed_matrix_failures({"state": state, "exit_code": code}, True)
|
|
with tempfile.TemporaryDirectory() as temp:
|
|
log = Path(temp) / "matrix.log"
|
|
status = {"state": "failed", "exit_code": "1", "log": str(log)}
|
|
with self.assertRaisesRegex(ValueError, "not completed successfully"):
|
|
package.completed_matrix_failures(status)
|
|
for body in ("", "Building a target\n", "Logging matrix completed with 2 failed build(s):\n one (standard) -> /tmp/one.log\n"):
|
|
log.write_text(body)
|
|
with self.assertRaisesRegex(ValueError, "summary"):
|
|
package.completed_matrix_failures(status, True)
|
|
log.write_text("Logging matrix completed with 2 failed build(s):\n"
|
|
" one (standard) -> /tmp/one.log\n"
|
|
" two (full-usb-wifi-ota) -> /tmp/two.log\n")
|
|
failures = package.completed_matrix_failures(status, True)
|
|
self.assertEqual([f["target"] for f in failures], ["one", "two"])
|
|
self.assertEqual(failures[1]["profile"], "full-usb-wifi-ota")
|
|
self.assertEqual(failures[1]["log_file"], "two.log")
|
|
|
|
def manifest(self, target="test_repeater", **changes):
|
|
return {"target": target, "platform": "ESP32_PLATFORM",
|
|
"schema_version": 2, "verified": True,
|
|
"ota_update_verified": True, "verification": [], **changes}
|
|
|
|
def test_source_capability_cannot_qualify_infrastructure(self):
|
|
with self.assertRaisesRegex(ValueError, "wireless updater"):
|
|
package.validate_manifest(self.manifest(ota_update_verified=False))
|
|
|
|
def test_usb_companion_is_accepted(self):
|
|
package.validate_manifest(self.manifest("test_companion_radio_usb", ota_update_verified=False))
|
|
|
|
def test_nrf52_sensor_profiles_require_actual_qualified_lora_receiver(self):
|
|
for role in ('repeater', 'room_server', 'sensor'):
|
|
for sensor in ('full', 'reduced'):
|
|
manifest = self.manifest('test_' + role, platform='NRF52_PLATFORM', build_profile='auto',
|
|
capabilities=['sensor.profile.' + sensor, 'ota.update.lora'], ota_update_methods=['lora'],
|
|
verification=[dict(capability='ota.update.lora', present=True, source='linked image')])
|
|
package.validate_manifest(manifest)
|
|
self.assertEqual(package.nrf52_sensor_profile(manifest), sensor)
|
|
self.assertIn('sensors + LoRa OTA', package.release_profile_label(manifest))
|
|
self.assertEqual(package.category({'manifest': manifest}), 'lora-ota')
|
|
for change in (dict(platform='ESP32_PLATFORM'), dict(target='test_companion_radio_full'),
|
|
dict(ota_update_methods=['bluetooth']), dict(verification=[]),
|
|
dict(verification=[dict(capability='ota.update.lora', present=True, source='filename')])):
|
|
with self.subTest(change=change), self.assertRaisesRegex(ValueError, 'qualified nRF52'):
|
|
package.validate_manifest({**manifest, **change})
|
|
with self.assertRaisesRegex(ValueError, 'ambiguous'):
|
|
package.validate_manifest({**manifest, 'capabilities': manifest['capabilities'] +
|
|
['sensor.profile.' + ('reduced' if sensor == 'full' else 'full')]})
|
|
|
|
def test_full_companion_requires_linked_source_implementation(self):
|
|
manifest = self.manifest("test_companion_radio_full", ota_update_verified=False)
|
|
with self.assertRaisesRegex(ValueError, "MOTA sending"):
|
|
package.validate_manifest(manifest)
|
|
manifest["verification"] = [{"capability": name, "present": True} for name in (
|
|
"companion.usb_mota_source", "companion.mota_sender", "companion.temp_radio",
|
|
"companion.ota_cli", "companion.wifi_ota_seeder")]
|
|
package.validate_manifest(manifest)
|
|
manifest["verification"][1]["present"] = False
|
|
with self.assertRaisesRegex(ValueError, "MOTA sending"):
|
|
package.validate_manifest(manifest)
|
|
|
|
def sensor_record(self, directory, sensor, *, target='test_repeater', target_id=None,
|
|
hw_id='TEST', app_base=0x26000, flags=0x10, fw_version=0x01110107):
|
|
stem = target + '-' + sensor + '-ota-v1.17.1.7-dev-deadbeef'
|
|
application, _ = ensure_endf(ensure_nrf52_layout(b'OTA: status\0invalid in-place patch geometry\0',
|
|
Nrf52Layout(app_base, 0xED000, 0xED000, flags)),
|
|
FwIdent(fw_version, target_id_for_env(target) if target_id is None else target_id, hw_id))
|
|
path = directory / (stem + '.zip')
|
|
with zipfile.ZipFile(path, 'w') as archive:
|
|
archive.writestr('application.bin', application)
|
|
archive.writestr('manifest.json', json.dumps({'manifest': {
|
|
'application': {'bin_file': 'application.bin', 'dat_file': 'application.dat'}}}))
|
|
archive.writestr('application.dat', b'fixture init')
|
|
manifest = self.manifest(target, artifact_target=target + '-' + sensor + '-ota',
|
|
platform='NRF52_PLATFORM', build_profile='auto', capabilities=['sensor.profile.' + sensor,
|
|
'ota.update.lora'], ota_update_methods=['lora'],
|
|
verification=[dict(capability='ota.update.lora', present=True, source='linked image')],
|
|
ota_update_requirements={'lora': {'storage': 'internal_flash_and_retained_ram'}})
|
|
return {'manifest': manifest, 'files': [path]}
|
|
|
|
def test_sensor_pair_requires_one_of_each_with_matching_packaged_identity_and_layout(self):
|
|
with tempfile.TemporaryDirectory() as temp:
|
|
directory = Path(temp)
|
|
full = self.sensor_record(directory, 'full')
|
|
reduced = self.sensor_record(directory, 'reduced')
|
|
package.validate_nrf52_sensor_pairs([full, reduced])
|
|
for records in ([full], [reduced], [full, reduced, reduced]):
|
|
with self.subTest(count=len(records)), self.assertRaisesRegex(ValueError, 'exactly one full'):
|
|
package.validate_nrf52_sensor_pairs(records)
|
|
for change in (dict(target='another_repeater'), dict(target_id=456), dict(hw_id='OTHER'),
|
|
dict(app_base=0x27000), dict(flags=0x20), dict(fw_version=0x01110108)):
|
|
with self.subTest(change=change), self.assertRaisesRegex(ValueError, 'sensor pair'):
|
|
package.validate_nrf52_sensor_pairs([full, self.sensor_record(directory, 'reduced', **change)])
|
|
reduced = self.sensor_record(directory, 'reduced')
|
|
reduced['manifest']['ota_update_requirements']['lora']['storage'] = 'external_qspi'
|
|
with self.assertRaisesRegex(ValueError, 'storage layout'):
|
|
package.validate_nrf52_sensor_pairs([full, reduced])
|
|
with self.assertRaisesRegex(ValueError, 'target ID disagrees with logical target'):
|
|
package.validate_nrf52_sensor_pairs([self.sensor_record(directory, 'full', target_id=456),
|
|
self.sensor_record(directory, 'reduced', target_id=456)])
|
|
|
|
def test_sensor_pair_filename_does_not_replace_metadata_or_packaged_layout(self):
|
|
with tempfile.TemporaryDirectory() as temp:
|
|
directory = Path(temp)
|
|
full = self.sensor_record(directory, 'full')
|
|
missing = {**full, 'manifest': {**full['manifest'], 'capabilities': ['ota.update.lora']}}
|
|
with self.assertRaisesRegex(ValueError, 'lacks qualified metadata'):
|
|
package.validate_nrf52_sensor_pairs([missing])
|
|
missing['manifest']['artifact_target'] = 'test_repeater'
|
|
with self.assertRaisesRegex(ValueError, 'lacks qualified metadata'):
|
|
package.validate_nrf52_sensor_pairs([missing])
|
|
full['manifest']['artifact_target'] = 'test_repeater-reduced-ota'
|
|
with self.assertRaisesRegex(ValueError, 'disagrees with metadata'):
|
|
package.validate_nrf52_sensor_pairs([full])
|
|
full['manifest']['artifact_target'] = 'different_repeater-full-ota'
|
|
with self.assertRaisesRegex(ValueError, 'filename disagrees'):
|
|
package.validate_nrf52_sensor_pairs([full])
|
|
full = self.sensor_record(directory, 'full')
|
|
with zipfile.ZipFile(full['files'][0], 'w') as archive:
|
|
archive.writestr('application.bin', b'no EndF identity or layout')
|
|
archive.writestr('manifest.json', json.dumps({'manifest': {
|
|
'application': {'bin_file': 'application.bin'}}}))
|
|
with self.assertRaisesRegex(ValueError, 'valid packaged EndF'):
|
|
package.validate_nrf52_sensor_pairs([full])
|
|
# The new policy is not retroactively applied to historical files.
|
|
package.validate_nrf52_sensor_pairs([{'manifest': self.manifest('legacy_repeater',
|
|
platform='NRF52_PLATFORM'), 'files': [directory / 'legacy_repeater-ota-v1.0.zip']}])
|
|
|
|
def test_collect_artifacts_always_enforces_sensor_pair_even_for_partial_staging(self):
|
|
with tempfile.TemporaryDirectory() as temp:
|
|
directory = Path(temp)
|
|
record = self.sensor_record(directory, 'full')
|
|
stem = record['files'][0].stem
|
|
(directory / (stem + '.uf2')).write_bytes(b'validated fixture UF2')
|
|
(directory / (stem + '.capabilities.json')).write_text(json.dumps(record['manifest']))
|
|
memory = dict(passed=True, available_internal_bytes=100000,
|
|
required_heap_bytes=10000, elf_sha256='a' * 64)
|
|
with patch.object(package, 'check_uf2'), patch.object(package, 'validate_package', return_value=memory), \
|
|
patch.object(package, 'validate_artifact_notice', return_value=None):
|
|
with self.assertRaisesRegex(ValueError, 'exactly one full'):
|
|
package.collect_artifacts(directory, 'v1.17.1.7-dev-deadbeef')
|
|
reduced = self.sensor_record(directory, 'reduced')
|
|
other = reduced['files'][0].stem
|
|
(directory / (other + '.uf2')).write_bytes(b'validated fixture UF2')
|
|
(directory / (other + '.capabilities.json')).write_text(json.dumps(reduced['manifest']))
|
|
self.assertEqual(len(package.collect_artifacts(directory, 'v1.17.1.7-dev-deadbeef')), 2)
|
|
def test_missing_qualification_and_mixed_versions_are_rejected(self):
|
|
with tempfile.TemporaryDirectory() as temp:
|
|
directory = Path(temp)
|
|
stem = "test_companion_radio_usb-v1.0-deadbeef"
|
|
(directory / (stem + ".bin")).write_bytes(b"firmware")
|
|
with self.assertRaisesRegex(ValueError, "without qualification"):
|
|
package.collect_artifacts(directory, "v1.0-deadbeef")
|
|
(directory / (stem + ".capabilities.json")).write_text(json.dumps(self.manifest("test_companion_radio_usb")))
|
|
with self.assertRaisesRegex(ValueError, "mixed-version"):
|
|
package.collect_artifacts(directory, "v2.0-deadbeef")
|
|
with self.assertRaisesRegex(ValueError, "pair incomplete"):
|
|
package.collect_artifacts(directory, "v1.0-deadbeef")
|
|
|
|
def test_stages_named_prerelease_and_checksums_only_after_completion(self):
|
|
with tempfile.TemporaryDirectory() as temp:
|
|
directory = Path(temp)
|
|
inputs = directory / "input"
|
|
inputs.mkdir()
|
|
commit = "deadbeef" + "0" * 32
|
|
label = "v1.17.1.5-halo-keymind-cascade-dev"
|
|
stem = "test_companion_radio_usb-" + label + "-deadbeef"
|
|
manifest = self.manifest("test_companion_radio_usb", ota_update_verified=False,
|
|
artifact_target="test_companion_radio_usb", build_profile="standard")
|
|
(inputs / (stem + ".capabilities.json")).write_text(json.dumps(manifest))
|
|
(inputs / (stem + ".bin")).write_bytes(b"test application")
|
|
(inputs / (stem + "-merged.bin")).write_bytes(b"test merged image")
|
|
proof = dict(schema_version=1, passed=True, available_internal_bytes=80000,
|
|
required_heap_bytes=50000, largest_internal_region_bytes=80000,
|
|
required_contiguous_bytes=5120, elf_sha256="a" * 64,
|
|
files={p.name: hashlib.sha256(p.read_bytes()).hexdigest() for p in inputs.iterdir()})
|
|
(inputs / (stem + ".memory.json")).write_text(json.dumps(proof))
|
|
status = directory / "status"
|
|
settings = (f"exit_code=0\nworking_directory={directory}\noutput_directory=input\n"
|
|
f"source_commit={commit}\nfirmware_version={label}\nfirmware_profile=cascade\n"
|
|
"radio_frequency=910.525\nradio_bandwidth=62.5\nradio_sf=7\nradio_cr=5\n")
|
|
status.write_text("state=running\n" + settings)
|
|
command = [sys.executable, str(ROOT / "scripts/package_cascade_release.py"),
|
|
"--input", str(inputs), "--output", str(directory / "stage"),
|
|
"--build-status", str(status), "--commit", commit]
|
|
result = subprocess.run(command, capture_output=True, text=True)
|
|
self.assertNotEqual(result.returncode, 0)
|
|
self.assertFalse((directory / "stage").exists())
|
|
status.write_text("state=completed\n" + settings)
|
|
result = subprocess.run(command, capture_output=True, text=True)
|
|
self.assertEqual(result.returncode, 0, result.stderr)
|
|
plan = json.loads((directory / "stage/release-plan.json").read_text())
|
|
self.assertEqual(plan["groups"][0]["tag"], label + "-deadbeef")
|
|
self.assertTrue(plan["groups"][0]["prerelease"])
|
|
assets = directory / "stage/companion"
|
|
picker = (directory / "stage/FIRMWARE-PICKER-1.17.1.5.html").read_text()
|
|
self.assertIn(f'companion/{stem}.bin', picker)
|
|
self.assertNotIn("/releases/download/", picker)
|
|
self.assertIn("companion/FULL-COMPANION-FEATURES.md", picker)
|
|
self.assertIn("/releases/download/", (assets / "FIRMWARE-PICKER-1.17.1.5.html").read_text())
|
|
self.assertIn(stem + ".bin", (assets / "TARGET-MANIFEST.tsv").read_text())
|
|
self.assertIn("910.525", (assets / "BUILD-NOTES.txt").read_text())
|
|
for line in (assets / "SHA256SUMS.txt").read_text().splitlines():
|
|
digest, name = line.split(" ", 1)
|
|
self.assertEqual(hashlib.sha256((assets / name).read_bytes()).hexdigest(), digest)
|
|
|
|
# A finished matrix can publish good files while explicitly
|
|
# retaining the failed attempts and the real nonzero exit code.
|
|
log = directory / "matrix.log"
|
|
log.write_text("1 standard ESP32 target(s) exceeded the portable OTA slot and were deferred to the expanded FULL pass:\n"
|
|
" large_repeater\n"
|
|
"Logging matrix completed with 1 failed build(s):\n"
|
|
" missing_repeater (standard) -> /tmp/missing.log\n")
|
|
status.write_text("state=failed\n" + settings.replace("exit_code=0", "exit_code=1")
|
|
+ f"log={log}\n")
|
|
partial_command = command.copy()
|
|
partial_command[partial_command.index("--output") + 1] = str(directory / "partial")
|
|
result = subprocess.run(partial_command, capture_output=True, text=True)
|
|
self.assertNotEqual(result.returncode, 0)
|
|
self.assertFalse((directory / "partial").exists())
|
|
result = subprocess.run(partial_command + ["--allow-partial"], capture_output=True, text=True)
|
|
self.assertEqual(result.returncode, 0, result.stderr)
|
|
plan = json.loads((directory / "partial/release-plan.json").read_text())
|
|
self.assertEqual(plan["matrix"]["exit_code"], 1)
|
|
self.assertEqual(plan["matrix"]["failures"][0]["target"], "missing_repeater")
|
|
assets = directory / "partial/companion"
|
|
self.assertIn("Partial matrix", (assets / "BUILD-NOTES.txt").read_text())
|
|
self.assertIn("missing_repeater", (assets / "BUILD-FAILURES.md").read_text())
|
|
self.assertEqual(plan["matrix"]["portable_profile_exclusions"][0]["target"], "large_repeater")
|
|
self.assertIn("large_repeater", (assets / "PORTABLE-PROFILE-EXCLUSIONS.md").read_text())
|
|
self.assertIn("Portable image limits", (assets / "BUILD-NOTES.txt").read_text())
|
|
self.assertEqual(len(list(assets.iterdir())), plan["groups"][0]["asset_count"])
|
|
checksums = (assets / "SHA256SUMS.txt").read_text()
|
|
self.assertIn("BUILD-FAILURES.json", checksums)
|
|
self.assertIn("PORTABLE-PROFILE-EXCLUSIONS.json", checksums)
|
|
for line in checksums.splitlines():
|
|
digest, name = line.split(" ", 1)
|
|
self.assertEqual(hashlib.sha256((assets / name).read_bytes()).hexdigest(), digest)
|
|
|
|
# Opting in to holes never authorizes publishing bad firmware.
|
|
(inputs / (stem + ".bin")).write_bytes(b"corrupted")
|
|
partial_command[partial_command.index("--output") + 1] = str(directory / "bad")
|
|
result = subprocess.run(partial_command + ["--allow-partial"], capture_output=True, text=True)
|
|
self.assertNotEqual(result.returncode, 0)
|
|
self.assertFalse((directory / "bad").exists())
|
|
|
|
|
|
if __name__ == "__main__":
|
|
unittest.main()
|