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/rm37491.docent.yaml src/hg/utils/docent/tests/regress/rm37491.docent.yaml
index aca50450f2e..6107cc3f175 100644
--- src/hg/utils/docent/tests/regress/rm37491.docent.yaml
+++ src/hg/utils/docent/tests/regress/rm37491.docent.yaml
@@ -17,30 +17,33 @@
 # does not express "the user deselected the other two". hideKids writes a `<track>=hide`
 # cart variable for each sibling, and isSubtrackVisible() (hg/lib/trackHub.c:1847) begins
 #
 #     boolean overrideComposite = (NULL != cartOptionalString(cart, tdb->track));
 #     ...
 #     if (overrideComposite) enabled = TRUE;
 #
 # so the mere presence of that variable makes the sibling count as visible and it lands in
 # the warning again -- a first version of this test failed on `noText: "NA12877"` and
 # looked exactly like the bug being back. What a deselected subtrack really looks like is
 # `<track>_sel=0` and NO visibility variable at all, which is what the checkbox on
 # hgTrackUi writes. There is no verb for that, so the state is set with the goto: escape
 # hatch.
 #
 # mane is turned on as well so the lift has something it CAN carry.
+proof:
+  - "assertion-only 2026-09-05 -- written from the ticket after the fix had shipped"
+
 target: genome-test
 db: hg38
 position: chr17:43044295-43125364
 reset: true
 fast: true
 steps:
   - go: chr17:43044295-43125364
   - hide: all
   - goto: "/cgi-bin/hgTracks?db=hg38&position=chr17:43044295-43125364&pix=1100&mane=pack&platinumGenomes=pack&platinumNA12878_sel=1&platinumNA12877_sel=0&platinumHybrid_sel=0"
 
   # One of the three drawn and the other two not. This is the state the warning is read
   # against, so it is asserted rather than assumed.
   - expect:
       rows: [mane, platinumNA12878]
       noRows: [platinumNA12877, platinumHybrid]