Files
crawler-plugin/admin-frontend-vue/tests/source-pin-ratchet.test.ts
T
huangzd1997 f142744ed4 feat(护栏): 后管补挂载测试与 readSource 逐文件台账,另加一支 CI job(runner 现状见正文)
这面此前 0 个挂载测试(@vue/test-utils 不在 package.json、node_modules 是空目录),
.vite 页面全靠"读源码做正则断言"钉住,改法一旦不是那个字面写法就失明。
装上 @vue/test-utils + vitest + jsdom 后补了 2 文件 7 例挂载测试,靶子选两处只 console
不给用户提示的失败路径(公司目录没取到时原先只剩"tab 条没画出来")。

source-pin 台账用锚点分段口径:实测这棵树 1,704 个 test(/it( 全部行首出现、无循环生成,
而括号配对切块会被正则字面量里的 ) 提前收口、漏 48 处——分母悄悄变小对"只许减"是沉默的,
所以另加一条"与独立出现次数对平"的断言。基线落在每个文件上:只钉"总数+文件数"两个标量时,
A 加一条配 B 减一条就能双双不动地绕过去。

⚠ 这支 CI job 今天是纸面的:Gitea Actions 只列得出 3 次 run,末次停在 2026-08-11 且全是
failure,此后 origin/master 又推进 1,131 笔没有产生任何 run。同一个 workflow 里 backend 的
mvn test、frontend 的 npm test 也一并不会执行——"CI 强制"这一项要成立,得先恢复 runner。
2026-10-08 17:37:00 +08:00

227 lines
9.2 KiB
TypeScript
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
/**
* readSource 源码钉子占比的**逐文件台账**棘轮(只许减)。
*
* 为什么不是两个标量:只钉「总用例数 + 含钉子的文件数」时,A 文件加一条、B 文件减一条
* 就双双不动地绕过去了。基线必须落在每个文件上,且"台账外的新文件带钉子"同样算破口。
*
* 为什么切分器是锚点分段而不是括号配对:这棵树里 1,704 个 `test(`/`it(` 全部行首出现
* (缩进 ≤4、可带 await),没有一条由循环生成;而括号配对会被正则字面量里的 `)` 提前收口,
* 实测漏掉 48 处。"分母悄悄变小"对只许减的棘轮是沉默的,所以这里另用一把独立口径对账
* (countTestOccurrences),两者不等就红。
*
* 本机:`node --test tests/source-pin-ratchet.test.ts`(这面原先 0 个 node_modules,
* 纯 node 24 类型剥离就能跑,不依赖 vitest/vue-tsc)
* 重生成基线:`UPDATE_SOURCE_PIN_BASELINE=1 node --test tests/source-pin-ratchet.test.ts`
*/
import { test } from 'node:test'
import assert from 'node:assert/strict'
import { existsSync, mkdirSync, readdirSync, readFileSync, statSync, writeFileSync } from 'node:fs'
import { dirname, join } from 'node:path'
import { fileURLToPath } from 'node:url'
const HERE = dirname(fileURLToPath(import.meta.url))
const BASELINE_PATH = join(HERE, 'baselines', 'source-pin-ledger.json')
/** 这把尺子自己的源码里有 readSource/readFileSync 的字样,不能把自己算成钉子。 */
const SELF = 'source-pin-ratchet.test.ts'
export type FileLedger = { cases: number; pins: number }
export type Ledger = Record<string, FileLedger>
type Baseline = { note: string; totals: { files: number; cases: number; pins: number }; files: Ledger }
/** 剥掉块注释、行注释、单/双引号与模板字符串的内容,保留长度与换行以便回指行号。 */
export function stripNonCode(src: string): string {
const out: string[] = []
let i = 0
const n = src.length
while (i < n) {
const two = src.slice(i, i + 2)
if (two === '/*') {
const close = src.indexOf('*/', i + 2)
const end = close < 0 ? n : close + 2
for (let k = i; k < end; k++) out.push(src[k] === '\n' ? '\n' : ' ')
i = end; continue
}
if (two === '//') {
const nl = src.indexOf('\n', i + 2)
const end = nl < 0 ? n : nl
for (let k = i; k < end; k++) out.push(' ')
i = end; continue
}
const q = src[i]
if (q === '"' || q === "'" || q === '`') {
let k = i + 1
out.push(' ')
while (k < n) {
if (src[k] === '\\') { out.push(' ', src[k + 1] === '\n' ? '\n' : ' '); k += 2; continue }
if (src[k] === q) { out.push(' '); k++; break }
out.push(src[k] === '\n' ? '\n' : ' ')
k++
}
i = k; continue
}
out.push(src[i]); i++
}
return out.join('')
}
const ANCHOR = /^[ \t]{0,4}(?:await[ \t]+)?(?:test|it)[ \t]*\(/gm
const PIN = /readSource\s*\(|readFileSync\s*\(|globSync\s*\(/
/** 独立口径:出现次数(不做归属),用来给锚点分母对账。 */
export function countTestOccurrences(src: string): number {
return (stripNonCode(src).match(/(^|[^\w$.])(test|it)[ \t]*\(/g) || []).length
}
export function sliceCases(src: string): string[] {
const code = stripNonCode(src)
const starts: number[] = []
let m: RegExpExecArray | null
while ((m = ANCHOR.exec(code)) !== null) starts.push(m.index)
const regions: string[] = []
for (let i = 0; i < starts.length; i++) {
const to = i + 1 < starts.length ? starts[i + 1] : code.length
regions.push(code.slice(starts[i], to))
}
return regions
}
export function ledgerFor(src: string): FileLedger {
const cases = sliceCases(src)
return { cases: cases.length, pins: cases.filter((r) => PIN.test(r)).length }
}
export function collectSources(): Record<string, string> {
const out: Record<string, string> = {}
for (const name of readdirSync(HERE).sort()) {
if (name === SELF || !name.endsWith('.test.ts')) continue
const p = join(HERE, name)
if (!statSync(p).isFile()) continue
out[name] = readFileSync(p, 'utf8')
}
return out
}
export function buildLedger(sources: Record<string, string>): Ledger {
const led: Ledger = {}
for (const [name, src] of Object.entries(sources)) led[name] = ledgerFor(src)
return led
}
export type Breach = { file: string; got: FileLedger; cap: FileLedger }
export function diffAgainstBaseline(got: Ledger, baseline: Ledger): Breach[] {
const breaches: Breach[] = []
for (const [file, cap] of Object.entries(baseline)) {
const g = got[file] ?? { cases: 0, pins: 0 }
if (g.pins > cap.pins || g.cases > cap.cases) breaches.push({ file, got: g, cap })
}
for (const [file, g] of Object.entries(got)) {
if (!(file in baseline) && g.pins > 0) {
breaches.push({ file, got: g, cap: { cases: 0, pins: 0 } })
}
}
return breaches
}
function measure() {
const sources = collectSources()
return { sources, ledger: buildLedger(sources) }
}
function totals(ledger: Ledger) {
let files = 0, cases = 0, pins = 0
for (const v of Object.values(ledger)) { files++; cases += v.cases; pins += v.pins }
return { files, cases, pins }
}
function loadBaseline(): Baseline {
assert.ok(existsSync(BASELINE_PATH),
`基线台账不存在:${BASELINE_PATH}(用 UPDATE_SOURCE_PIN_BASELINE=1 跑一次生成)`)
return JSON.parse(readFileSync(BASELINE_PATH, 'utf8')) as Baseline
}
test('分母自证:切分器与独立出现次数口径逐文件对平', () => {
const { sources, ledger } = measure()
const bad: string[] = []
for (const [name, src] of Object.entries(sources)) {
const occ = countTestOccurrences(src)
if (ledger[name].cases !== occ) bad.push(`${name} 切分=${ledger[name].cases} 出现=${occ}`)
}
assert.deepEqual(bad, [], '切分器漏切用例 ⇒ 分母变小 ⇒ 棘轮变松:\n' + bad.join('\n'))
assert.ok(totals(ledger).cases > 1500, `分母只有 ${totals(ledger).cases},不像整棵 tests/ 树`)
})
test('基线自身不许是被清空的壳', () => {
const b = loadBaseline()
assert.ok(b.totals.cases > 1500, `基线 cases=${b.totals.cases} 小得可疑`)
assert.ok(Object.keys(b.files).length >= 100, `基线只覆盖 ${Object.keys(b.files).length} 个文件`)
})
test('逐文件台账只许减:钉子数与用例数都不得高于基线', () => {
const breaches = diffAgainstBaseline(measure().ledger, loadBaseline().files)
assert.deepEqual(breaches, [], JSON.stringify(breaches, null, 2))
})
test('钉子判定落在用例体内,不是文件里出现过 readSource', () => {
const two = `
import { readSource } from './helpers/x.ts'
test('钉源码', () => { assert.match(readSource('a.vue'), /company_id/) })
test('纯行为', () => { assert.equal(sum(1, 2), 3) })
`
const led = ledgerFor(two)
assert.equal(led.cases, 2)
assert.equal(led.pins, 1, '只有第一条是源码钉子')
const header = `
import { readFileSync } from 'node:fs'
const SRC = readFileSync('a.vue', 'utf8')
test('用夹具断行为', () => { assert.ok(SRC.length > 0) })
`
assert.equal(ledgerFor(header).pins, 0, '把文件头的夹具读取算成钉子会让占比虚高')
const commented = `
test('行为用例', () => {
// 这里提一句 readSource('x') 只是注释
assert.equal(1, 1)
})
`
assert.equal(ledgerFor(commented).pins, 0, '注释里的字样不该被算成钉子')
})
test('台账有牙:加钉子、搬进新文件都要红;减钉子不许红', () => {
const base = measure().ledger
const first = Object.keys(base)[0]
const bumped: Ledger = JSON.parse(JSON.stringify(base))
bumped[first] = { cases: bumped[first].cases, pins: bumped[first].pins + 1 }
assert.equal(diffAgainstBaseline(bumped, base).length, 1, '同文件加钉子没被抓到 ⇒ 棘轮是摆设')
const moved: Ledger = { ...base, 'brand-new-pin.test.ts': { cases: 3, pins: 3 } }
assert.ok(diffAgainstBaseline(moved, base).some((b) => b.file === 'brand-new-pin.test.ts'),
'新文件装钉子绕过台账 ⇒ "内部搬家"这条路必须堵住')
const improved: Ledger = JSON.parse(JSON.stringify(base))
improved[first] = { cases: improved[first].cases, pins: Math.max(0, improved[first].pins - 1) }
assert.deepEqual(diffAgainstBaseline(improved, base), [], '把改进报成破口等于拦住别人修好它')
})
test('占比读数当场打印,供四面评分尺子取数', () => {
const t = totals(measure().ledger)
const b = totals(loadBaseline().files)
const ratio = (100 * t.pins / t.cases).toFixed(2)
console.log(`[source-pin] 当前 文件=${t.files} 用例=${t.cases} 钉子=${t.pins} 占比=${ratio}% |基线 用例=${b.cases} 钉子=${b.pins}`)
assert.ok(Number(ratio) <= 30, `钉子占比 ${ratio}% 高得不合理`)
})
if (process.env.UPDATE_SOURCE_PIN_BASELINE === '1') {
const ledger = measure().ledger
const t = totals(ledger)
mkdirSync(dirname(BASELINE_PATH), { recursive: true })
writeFileSync(BASELINE_PATH, JSON.stringify({
note: 'readSource 钉子逐文件基线。只许减;台账外新文件带钉子同样算破口。由 tests/source-pin-ratchet.test.ts 生成。',
totals: { files: t.files, cases: t.cases, pins: t.pins },
files: ledger,
}, null, 1), 'utf8')
console.log('[source-pin] 基线已重写 -> ' + BASELINE_PATH)
}