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/rm37553.docent.yaml src/hg/utils/docent/tests/regress/rm37553.docent.yaml index 7a1f019eafb..4cf87b83475 100644 --- src/hg/utils/docent/tests/regress/rm37553.docent.yaml +++ src/hg/utils/docent/tests/regress/rm37553.docent.yaml @@ -17,30 +17,33 @@ # # Two wrong guesses about the label text, both fixed by reading the page rather than the # file. "GFF example" is not a label: the file says `track name=GFF example description=` # with the name unquoted, so hgCustom takes the name as "GFF" and drops "example". And the # DESCRIPTION is not on the page either -- hgTracks puts a track's longLabel in the # control's title attribute, which innerText does not see. What is visible is the # shortLabel, i.e. the name. # # Three names from three different loaders -- a hosted vcfTabix, an inline PSL, and a # remote bigChain -- so a partial load fails instead of passing on whichever one survived. # All three are several words long and belong to nothing native on hg19. The height floor # is the other half of it: these labels sit in the track controls under the image and # would be there even if nothing had drawn. Measured 2026-09-05: 46 rows, 6475px. The # floor is left low on purpose -- one of the remote bigDataUrls going away should not fail # this test, since the three label checks are what carries it. +proof: + - "assertion-only 2026-09-05 -- written from the ticket after the fix had shipped" + target: genome-test db: hg19 position: chr21:33031597-33041570 reset: true fast: true steps: - go: chr21:33031597-33041570 - hide: all - addCustomTrack: {url: "https://genecats.gi.ucsc.edu/qa/customTracks/testing/examples.WITHOUT.FTPS.txt"} - expect: text: "VCF Example One" noText: "Warning/Error" height: ">1000" - expect: {text: "Blat PSL"}