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/rm37805.docent.yaml src/hg/utils/docent/tests/regress/rm37805.docent.yaml
index d0e69020663..4a08f8069dd 100644
--- src/hg/utils/docent/tests/regress/rm37805.docent.yaml
+++ src/hg/utils/docent/tests/regress/rm37805.docent.yaml
@@ -15,28 +15,31 @@
 #   * this track has filterValuesDefault.annot pLoF,missense,synonymous, so at a position
 #     with only UTR and downstream variants it draws NOTHING and has no row at all. The
 #     first version of this test used chr17:43044295-43045295, where all 258 v3.1.1
 #     variants are annotated "other", and failed for that reason and not for the bug.
 #     chr17:43091000-43092000 is inside BRCA1 exon 11 and holds 80 missense, 13 pLoF and
 #     29 synonymous variants, so the row is drawn.
 #
 # The hover names an item by its TITLE, which for this track is the mouseOver text itself.
 # That pins one variant rather than whatever sits at the middle of a packed row, and it
 # makes docent wait for THAT item's tooltip instead of settling for a neighbour's.
 #
 # Both halves of the assertion are needed. tip: is what only holds when the pattern
 # rendered correctly -- the buggy build produced "43091450} (T/G)" and would fail it.
 # noText: catches a brace anywhere else the pattern might leak one; the window is narrow
 # and only this track is showing, so nothing else on the page produces one.
+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"}
 
   - mouseover: {track: gnomadGenomesVariantsV3_1_1, title: "rs80357218"}
   - expect: {tip: "chr17:43091449-43091450 (T/G)", noText: "}"}