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, `<level> <YYYY-MM-DD> -- <what was seen>`. 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) <noreply@anthropic.com>

diff --git src/hg/utils/docent/tests/regress/rm37615.docent.yaml src/hg/utils/docent/tests/regress/rm37615.docent.yaml
index 3c4e1831a9c..e222724ac67 100644
--- src/hg/utils/docent/tests/regress/rm37615.docent.yaml
+++ src/hg/utils/docent/tests/regress/rm37615.docent.yaml
@@ -5,30 +5,33 @@
 # the position bar showed the lifted one. Two commits: 05c41aa8b79 first appended a note
 # saying the coordinates came from the source assembly, then 98572a57d65 replaced that with
 # the real fix -- overwrite those three fields with the lifted bed's target coordinates
 # before substituting, so the tooltip matches where the item is drawn.
 #
 # So the behavior to assert is the SECOND one. The plan for this suite still said to look
 # for the disclaimer note; that note is gone from the tree and a test for it would fail.
 #
 # The track is gnomAD v3.1.1, the same one rm37805 uses natively, because its mouseOver
 # pattern is exactly the coordinate substitution this bug was about:
 #
 #     <b>Position</b>: $chrom:${chromStart}-${chromEnd} ($ref/$alt)
 #
 # and the same window and variant are reachable, which makes the two scripts easy to read
 # together. gnomadVariants is a superTrack, so hideKids keeps its siblings off.
+proof:
+  - "assertion-only 2026-09-05 -- written from the ticket after the fix had shipped"
+
 target: genome-test
 db: hg38
 position: chr17:43091000-43092000
 reset: true
 fast: true
 steps:
   - go: chr17:43091000-43092000
   - hide: all
   - track: {gnomadVariants: hideKids, gnomadGenomesVariantsV3_1_1: pack}
   - expect: {rows: [gnomadGenomesVariantsV3_1_1], noText: "Warning/Error"}
 
   - convert: {to: hs1, quicklift: true}
   - open: lift
   - expect: {rows: [gnomadGenomesVariantsV3_1_1], noText: "Warning/Error"}