test-protocol

Turn the raw results of a production or repair test into a printable test protocol for one device: serial number, measured values against their limits, a clear PASS/FAIL verdict with the failed checks on top, the input files with their SHA-256 for traceability, and signature boxes. Output is a single self-contained HTML file (A4 print layout), a PDF, or normalized JSON. Several result files of the same unit — the bench test, the interface test, the boot log comparison, a pytest run — are merged into one protocol.

$ test-protocol examples/EPC-24-00142/* --limits examples/limits.toml
EPC-24-00142: FAIL
PASS 43  FAIL 7
  FAIL  Storage / Reallocated sectors: 312 (≤ 10)
  FAIL  Storage / Pending sectors: 24 (≤ 0)
  FAIL  boot-log-diff.facts / dram: 2 GiB -> 1 GiB
  FAIL  boot-log-diff.facts / memory: 2097152K -> 1048576K
  FAIL  boot-log-diff.lines / log lines: 8 missing, 8 new
  FAIL  boot-log-diff.faults / mmc-timeout: eMMC/SD card does not respond (timeout)
  FAIL  boot-log-diff.faults / eth-phy: Ethernet PHY not found

$ test-protocol examples/EPC-24-00142/* --limits examples/limits.toml \
    --product "EPC-24 variant B" --operator "J. Doe" --meta order=PO-2026-118 \
    -o protocol.html --pdf protocol.pdf

Install

pip install test-protocol          # HTML and JSON, no dependencies
pip install "test-protocol[pdf]"   # adds WeasyPrint for PDF output

Python 3.10 or newer. For PDF output you need either WeasyPrint (the pdf extra; on Windows it needs the GTK/Pango libraries, see the WeasyPrint docs) or Chrome, Chromium or Edge, which the tool finds on its own.

Inputs

The format is detected from the file; --format forces it.

A measurement is PASS or FAIL against its limits; one without limits and without a result is shown as INFO and does not count. Inputs of one protocol must have the same serial number — if they differ, the tool stops (exit 2). A file without a serial number (JUnit, CSV) takes it from the other inputs or from --serial.

Limits file

Limits from a TOML file replace the limits in the raw data, and PASS/FAIL is evaluated again. The protocol marks such limits with the file name, and the file is listed with its SHA-256.

[[limit]]
step = "Supply rails"     # optional: only in this step
measurement = "5V0"       # matched without regard to case
low = 4.9
high = 5.1
unit = "V"

[[limit]]
measurement = "BIOS version"
expect = "5.27"           # text comparison

A limit that matches no measurement gives a warning. --require-limits fails every measurement that has no limit at all — for a strict end-of-line test.

Options

Exit status: 0 PASS, 1 FAIL, 2 bad input or configuration — so a test station script or a CI job can use the verdict directly.

The examples

examples/ has two units of a simulated embedded PC: one that passes and one with a failing SSD and a broken boot. See examples/README.md.

Licence

MIT