src/test-protection.ts

Functions

Imports

It imports src/github/pr-files.ts. Imported by src/complete-ci.ts.

Source

1import { inTestDir, type PrFileRow } from "./github/pr-files";
2
3// Narrow test protection on complete (docs/work-queue.md, "CI on complete"; Grok design
4// review 2026-10-23, build step 5). Green CI shows nothing when the change took away the
5// test that would have failed, so complete is refused when a pull request removes a test
6// file, removes or renames a test, or adds a skip, unless the job's body names that file
7// or test. Only these three: editing a test's body is ordinary work, and is left to the
8// reviewer and to auto-merge, which never merges an existing test edit unattended.
9
10// Test files in any of the repos: capsid's directories and merge-class's names, plus
11// Python's and Go's own naming.
12const isTestFile = (path: string | undefined) => inTestDir(path) || (path !== undefined && /(^|\/)test_[^/]*\.py$|_test\.(py|go)$/.test(path));
13
14// A test's declaration on one diff line: its name, or null.
15const DECLARATIONS = [
16  /\b(?:it|test|describe)(?:\.only|\.skip|\.todo|\.each\s*\([^)]*\))?\s*\(\s*(['"`])(.+?)\1/,
17  /^\s*(?:async\s+)?def\s+(test\w*)\s*\(/,
18  /^\s*class\s+(Test\w*)\b/,
19  /^\s*func\s+(Test\w*)\s*\(/,
20];
21function testName(line: string): string | null {
22  for (const re of DECLARATIONS) {
23    const m = re.exec(line);
24    if (m) return m[m.length - 1];
25  }
26  return null;
27}
28
29const SKIP = /\b(?:it|test|describe)\.(?:skip|todo)\b|\b(?:xit|xtest|xdescribe)\s*\(|@pytest\.mark\.(?:skip|skipif|xfail)\b|\bpytest\.skip\(|@unittest\.skip|\bself\.skipTest\(|\bt\.Skip(?:Now|f)?\(|#\[ignore\]|@Disabled\b/;
30
31/** What a pull request's files take away from its tests, each unless the job body names it. Pure. */
32export function weakenedTests(rows: readonly PrFileRow[], jobBody: string): string[] {
33  const named = (s: string) => jobBody.includes(s);
34  const found: string[] = [];
35  for (const f of rows) {
36    const old = f.previous_filename ?? f.filename;
37    if (isTestFile(old) && (f.status === "removed" || (f.previous_filename && !isTestFile(f.filename)))) {
38      if (!named(old)) found.push(`removes the test file ${old}`);
39      continue;
40    }
41    if (!isTestFile(f.filename) || f.status === "added") continue;
42    if (f.patch === undefined) {
43      if ((f.deletions ?? 1) > 0 && !named(f.filename)) found.push(`changes ${f.filename}, and GitHub gave no diff of it to read`);
44      continue;
45    }
46    const lines = f.patch.split("\n").filter((l) => !l.startsWith("---") && !l.startsWith("+++"));
47    const removed = new Set<string>();
48    const added = new Set<string>();
49    for (const line of lines) {
50      const name = testName(line.slice(1));
51      if (name && line.startsWith("-")) removed.add(name);
52      if (name && line.startsWith("+")) added.add(name);
53    }
54    lines.forEach((line, i) => {
55      const text = line.slice(1);
56      if (!line.startsWith("+") || !SKIP.test(text)) return;
57      // The test the skip is on: its own line, or the declaration a decorator sits above.
58      // A skip on a test this pull request adds is not one taken away; one whose test
59      // cannot be found is counted, since it cannot be shown new.
60      const own = testName(text);
61      const below = own ? null : lines.slice(i + 1, i + 4).find((l) => !l.startsWith("-") && testName(l.slice(1)));
62      const name = own ?? (below ? testName(below.slice(1)) : null);
63      const isNew = name !== null && (own ? true : below!.startsWith("+")) && added.has(name) && !removed.has(name);
64      if (!isNew && !named(name ?? f.filename)) found.push(`adds a skip in ${f.filename}: ${text.trim().slice(0, 80)}`);
65    });
66    for (const name of removed) {
67      if (!added.has(name) && !named(name)) found.push(`removes or renames the test "${name}" in ${f.filename}`);
68    }
69  }
70  return found;
71}