4697bbddd881c72cccb85b9ff0aacd769396b9d0 braney Thu Sep 10 07:34:35 2026 -0700 docent: record what evidence each regression test has, and count it A regression test written after the fix asserts the right answer, but nobody has watched it fail for the reason it exists, and a loose assertion in that state is indistinguishable from no test at all. Four of the 37 scripts here have actually been watched to flip. That was recorded only as prose in each script's header, so answering "how many of these are real regression tests" meant a grep and a read, and the number could not be quoted. Every script now carries a top-level `proof:` key, one quoted line per piece of evidence, ` -- `. docent.js reads only the keys it names off the parsed document, so this costs a run nothing. tests/proof.js reads them and tallies, wired up as `make proof` in the shared docentTest.mk. It exits 1 on a malformed line, an unknown level, or a line left unquoted -- that last one because nearly every note names a ticket and a bare # in an unquoted YAML scalar silently truncates the sentence at the ticket number, which is how the first pass of this change lost half its text. The levels, weakest first: assertion-only, xfail, sandbox-ab, server-flip, caught-regression. Today that reads 31 / 2 / 0 / 3 / 1. nightly.sh now records the flips it finds. An xfail that PASSES is the best evidence this suite produces -- the same server, the same fixtures, the same script, one real build apart -- and until now it arrived as a red mail and was thrown away with the log 60 days later. It is appended to /hive/users/braney/docentNightly/flips.log, one line per script ever, outside the checkout because --update resets the tree. The mail says what to do with it. The three flips that already happened (rm38272 2026-09-06, rm36212 2026-09-09, rm38310 2026-09-10) were recovered from the old logs and seeded there by hand. Full suite run after the change: 37 scripts, all ok. refs #38252 Co-Authored-By: Claude Opus 5 (1M context) diff --git src/hg/utils/docent/tests/regress/rm38310.docent.yaml src/hg/utils/docent/tests/regress/rm38310.docent.yaml index 8fb328a6d6b..e430ce178e1 100644 --- src/hg/utils/docent/tests/regress/rm38310.docent.yaml +++ src/hg/utils/docent/tests/regress/rm38310.docent.yaml @@ -42,30 +42,34 @@ # that drew nothing. Do not put one in here. # # The fixture is ours, at ~/public_html/docentFixtures/bigBedFieldCount/. One bigBed with # four fields, eight tracks over it, one declared type each -- the whole point is that the # only thing that differs between the rows is the number on the type line. hubCheck # rejects five of the eight, correctly (hg/lib/trackHub.c hubCheckBigDataUrl refuses # numFields > bbi->fieldCount); it is the empty row that is the bug, not the hub. # # Track names carry the rm38310 prefix because a fixture must never name a track anything # the assembly might also call it -- see README.txt, and rm35920, which tested nothing for # its whole life over exactly that. # # The hub declares `visibility pack` itself, so there is no `track:` step and no # `hide: all`: a hub track's cart name carries a per-run hub__ prefix that `track:` # cannot write. +proof: + - "sandbox-ab 2026-09-09 -- the whole directory run twice against the #38310 sandbox on port 48099, patched CGIs and same-tree controls; 37 scripts, this one line differed" + - "server-flip 2026-09-10 -- 68f831e1209 reached genome-test and the nightly's xfail passed" + target: genome-test db: hg38 position: chr1:10537000-10538500 reset: true fast: true steps: - hub: {url: "https://hgwdev.gi.ucsc.edu/~braney/docentFixtures/bigBedFieldCount/hub.txt", db: hg38} - go: chr1:10537000-10538500 # The hub attached and all eight rows reached the page. This is setup, not the # assertion: the broken build draws all eight of these too. - expect: rows: [rm38310bb4, rm38310bb4plus, rm38310bb5, rm38310bb6, rm38310bb9, rm38310bb12, rm38310bb12plus, rm38310bbAuto]