|
| 1 | +#!/usr/bin/env python3 |
| 2 | +"""Real-byte regression tests for the default-off build identity mask.""" |
| 3 | +from __future__ import annotations |
| 4 | + |
| 5 | +import base64 |
| 6 | +import hashlib |
| 7 | +import json |
| 8 | +from pathlib import Path |
| 9 | +import subprocess |
| 10 | +import tempfile |
| 11 | +import unittest |
| 12 | +from unittest import mock |
| 13 | + |
| 14 | +from check_replay_off_golden import mask_build_identity, measure |
| 15 | + |
| 16 | + |
| 17 | +def compact(value, *, canonical=False): |
| 18 | + # These fixtures use ASCII keys and integers, for which this is the |
| 19 | + # runner's canonical provenance encoding. |
| 20 | + return json.dumps(value, sort_keys=canonical, separators=(",", ":")).encode("utf-8") |
| 21 | + |
| 22 | + |
| 23 | +def report(version=(1, 7, 0), *, price=128, applied="fifo", provenance_input=None, |
| 24 | + missing=None, raw_edit=None, token_edit=None): |
| 25 | + engine = { |
| 26 | + "version_string": ".".join(map(str, version)), |
| 27 | + "major": version[0], "minor": version[1], "patch": version[2], |
| 28 | + "commit_sha": "0123456", |
| 29 | + } |
| 30 | + if missing is not None: |
| 31 | + del engine[missing] |
| 32 | + provenance = { |
| 33 | + "engine": engine, |
| 34 | + "applied": {"inputs": {"shape": applied if provenance_input is None else provenance_input}, |
| 35 | + "overrides": {}}, |
| 36 | + "runtime": {"major": 1, "minor": 7, "patch": 0}, |
| 37 | + } |
| 38 | + token_bytes = compact(provenance, canonical=True) |
| 39 | + if token_edit is not None: |
| 40 | + token_bytes = token_edit(token_bytes) |
| 41 | + document = { |
| 42 | + "trades": [{"entry_price": price, "major": 1, "minor": 7, "patch": 0}], |
| 43 | + "applied_inputs": {"shape": applied}, |
| 44 | + "fingerprint": { |
| 45 | + "token": base64.b64encode(token_bytes).decode("ascii"), |
| 46 | + "digest": "sha256:" + hashlib.sha256(token_bytes).hexdigest(), |
| 47 | + "provenance": provenance, |
| 48 | + }, |
| 49 | + } |
| 50 | + text = compact(document) + b"\n" |
| 51 | + if raw_edit is not None: |
| 52 | + text = raw_edit(text) |
| 53 | + return text, json.loads(text) |
| 54 | + |
| 55 | + |
| 56 | +def primary(version="1.7.0", *, price=128, run_id="replay-off-golden", edit=None): |
| 57 | + header = compact({ |
| 58 | + "schema": "pf-report-sink", "version": 1, "run_id": run_id, |
| 59 | + "engine": version, "records": [], |
| 60 | + }) |
| 61 | + if edit is not None: |
| 62 | + header = edit(header) |
| 63 | + # The identical version-looking body string must remain compared. |
| 64 | + return (header + b"\n" + compact(["T", price, "1.7.0"]) + b"\n" |
| 65 | + + compact({"trailer": "pf-report-sink", "version": 1, "counts": {"T": 1}}) |
| 66 | + + b"\n") |
| 67 | + |
| 68 | + |
| 69 | +class ReplayOffGoldenTests(unittest.TestCase): |
| 70 | + def masked_primary(self, data): |
| 71 | + # Only the external producer is substituted. measure(), the default |
| 72 | + # masker, and the sink masker all execute on the real fixture bytes. |
| 73 | + default_text, _ = report() |
| 74 | + with tempfile.TemporaryDirectory(prefix="replay-off-mask-test-") as scratch: |
| 75 | + directory = Path(scratch) |
| 76 | + |
| 77 | + def produce(command, **kwargs): |
| 78 | + if "--primary" in command: |
| 79 | + (directory / "primary.ndjson").write_bytes(data) |
| 80 | + return subprocess.CompletedProcess(command, 0, default_text, b"") |
| 81 | + |
| 82 | + with mock.patch("check_replay_off_golden.subprocess.run", side_effect=produce): |
| 83 | + return measure(Path("runner.py"), Path("strategy.so"), "fifo", |
| 84 | + directory)["primary_sink"] |
| 85 | + |
| 86 | + def test_default_versions_are_equal_and_non_identity_bytes_stay_visible(self): |
| 87 | + baseline = mask_build_identity(*report()) |
| 88 | + # Mutation control: reverting numeric masking leaves minor:7 versus |
| 89 | + # minor:8 in the raw report, decoded provenance and token spelling. |
| 90 | + for version in ((1, 8, 0), (2, 7, 0), (1, 7, 1), (12, 34, 56)): |
| 91 | + with self.subTest(version=version): |
| 92 | + self.assertEqual(baseline, mask_build_identity(*report(version))) |
| 93 | + for changes in ({"price": 129}, {"applied": "lifo"}, {"provenance_input": "lifo"}): |
| 94 | + with self.subTest(non_identity=changes): |
| 95 | + self.assertNotEqual(baseline, mask_build_identity(*report(**changes))) |
| 96 | + for before, after in ( |
| 97 | + (b'"entry_price":128,"major":1', b'"entry_price":128,"major":2'), |
| 98 | + (b'"runtime":{"major":1', b'"runtime":{"major":2')): |
| 99 | + with self.subTest(non_engine_numbers=before): |
| 100 | + edit = lambda data: data.replace(before, after) |
| 101 | + self.assertNotEqual(baseline, mask_build_identity(*report(raw_edit=edit))) |
| 102 | + input_edit = lambda data: data.replace(b'"shape":"fifo"', b'"shape":"lifo"') |
| 103 | + self.assertNotEqual(baseline, mask_build_identity(*report(token_edit=input_edit))) |
| 104 | + runtime_edit = lambda data: data.replace(b'"runtime":{"major":1', |
| 105 | + b'"runtime":{"major":2') |
| 106 | + self.assertNotEqual(baseline, mask_build_identity(*report(token_edit=runtime_edit))) |
| 107 | + # Token bytes are pinned even when their decoded value is unchanged. |
| 108 | + spaced = lambda data: data.replace(b'"applied":{', b'"applied": {') |
| 109 | + self.assertNotEqual(baseline, mask_build_identity(*report(token_edit=spaced))) |
| 110 | + |
| 111 | + def test_default_missing_or_duplicate_engine_numbers_are_refused(self): |
| 112 | + for key, value in (("major", 1), ("minor", 7), ("patch", 0)): |
| 113 | + member = f'"{key}":{value}'.encode("ascii") |
| 114 | + with self.subTest(key=key, location="decoded provenance", defect="missing"): |
| 115 | + with self.assertRaisesRegex(RuntimeError, "engine.*identity"): |
| 116 | + mask_build_identity(*report(missing=key)) |
| 117 | + for location in ("raw_edit", "token_edit"): |
| 118 | + for defect in ("missing", "duplicate same", "duplicate different", "duplicate spaced"): |
| 119 | + # Restrict the mutation to the engine object; the fixture |
| 120 | + # deliberately has identically named non-engine numbers. |
| 121 | + def edit(data, *, member=member, key=key, defect=defect): |
| 122 | + start = data.index(b'"engine":{') |
| 123 | + end = data.index(b"}", start) |
| 124 | + block = data[start:end] |
| 125 | + if defect == "missing": |
| 126 | + replacement = b"" |
| 127 | + elif defect == "duplicate same": |
| 128 | + replacement = member + b"," + member + b"," |
| 129 | + elif defect == "duplicate spaced": |
| 130 | + replacement = member + b"," + member.replace(b":", b" :") + b"," |
| 131 | + else: |
| 132 | + replacement = member + b',"' + key.encode("ascii") + b'":99,' |
| 133 | + block = block.replace(member + b",", replacement) |
| 134 | + return data[:start] + block + data[end:] |
| 135 | + |
| 136 | + with self.subTest(key=key, location=location, defect=defect): |
| 137 | + error = ("engine.*identity" if location == "token_edit" and defect == "missing" |
| 138 | + else f"engine {key}.*exactly once") |
| 139 | + with self.assertRaisesRegex(RuntimeError, error): |
| 140 | + mask_build_identity(*report(**{location: edit})) |
| 141 | + |
| 142 | + def test_sink_versions_are_equal_and_non_identity_bytes_stay_visible(self): |
| 143 | + original = primary() |
| 144 | + baseline = self.masked_primary(original) |
| 145 | + for version in ("1.8.0", "2.7.0", "1.7.1", "12.34.56"): |
| 146 | + with self.subTest(version=version): |
| 147 | + self.assertEqual(baseline, self.masked_primary(primary(version))) |
| 148 | + header, newline, body = original.partition(b"\n") |
| 149 | + self.assertEqual(baseline, header.replace(b'"engine":"1.7.0"', |
| 150 | + b'"engine":"<build-identity>"') + newline + body) |
| 151 | + for changes in ({"price": 129}, {"run_id": "different-run"}): |
| 152 | + with self.subTest(non_identity=changes): |
| 153 | + self.assertNotEqual(baseline, self.masked_primary(primary(**changes))) |
| 154 | + changed_body = original.replace(b'["T",128,"1.7.0"]', b'["T",128,"1.8.0"]') |
| 155 | + self.assertNotEqual(baseline, self.masked_primary(changed_body)) |
| 156 | + changed_schema = lambda data: data.replace(b'"version":1', b'"version":2') |
| 157 | + self.assertNotEqual(baseline, self.masked_primary(primary(edit=changed_schema))) |
| 158 | + |
| 159 | + def test_sink_missing_or_duplicate_header_engine_is_refused(self): |
| 160 | + for replacement in (b"", b'"engine":"1.7.0","engine":"1.8.0",', |
| 161 | + b'"engine":"1.7.0","engine" :"1.7.0",'): |
| 162 | + with self.subTest(replacement=replacement): |
| 163 | + edit = lambda data: data.replace(b'"engine":"1.7.0",', replacement) |
| 164 | + with self.assertRaisesRegex(RuntimeError, "sink header engine.*exactly once"): |
| 165 | + self.masked_primary(primary(edit=edit)) |
| 166 | + |
| 167 | + |
| 168 | +if __name__ == "__main__": |
| 169 | + unittest.main() |
0 commit comments