Files
STM32F4-Base/scripts
wandering1 2bfa09ed15 feat(门禁): 主机单测覆盖率脚本与口径落地(销报告 §4.8 空白 ①)
落地物:
- scripts/check_test_coverage.py:发现规则与 L0.5 同一条(test/host/**/
  run_unit_test.py),直接 import 各运行器复用其 TestBuild 与
  unit_test_harness._BASE_FLAGS —— 配置零复制,不会漂出第二套口径;
  只算自研生产源码(App/**、Drivers/BSP/**)的行/函数、多套取并集、
  生成物(文件头写"自动生成/请勿手改")不进分母、分母一律来自插桩
  报告不猜行数;中间物全在 %TEMP%,不新增 .gitignore 规则。
- scripts/test_coverage_baseline.json:增量拦截台账(只拦回退不拦进步,
  与 layer-deps / bsp-err 同姿态);ci_local.py 加 opt-in --coverage。
- docs/测试说明/主机单测覆盖率口径.md:口径 + 工具链实测 + 九条盲区。
- 报告 §0.1 / §0.4 / §4.8 / §5.5 / §7 改写 + 变更记录 + 去处表。

工具链是实测出来的(换机必读):Windows 原生侧无任何 gcc/gcov(全盘扫
Program Files*、msys64、scoop、choco、.platformio、LocalAppData = 0 处);
MSVC 14.51 已砍 /coverage,且只报 D9002 后照常编译成功 = 静默假数据;
CodeCoverage.exe 17.0 三个子命令只打印用法。最终用 mscoverage 18.x
(Microsoft.CodeCoverage.Console.exe)collect -f cobertura 做加载期动态
插桩,并实测它透传子进程退出码 → "插桩运行下仍必须 PASS"可当硬条件。

首登数字:16/16 套插桩下全绿,并集 line=2552/2893(88.2%)、
func=193/207(93.2%)、19 个文件在测、**未触及 125 个生产源文件 /
约 11,839 行**——最后一栏才是这套口径真正照出来的东西。

门禁自证:人为抬高基线后 行/函数/总计 三条回退路径都报 REGRESS 且
退出码 1;--module 子集跑不再假报总计回退(首版会,已修:并集口径下
子集必然变小,全部回退判定只在全量跑时生效)。

GCC 追问的复测结论(口径文档 §2.1 决策记录):本机 WSL2 Ubuntu 确实有
gcc/gcov 15.2.0,16 套单测在 gcc 下全部编过、用例数与 MSVC 逐个一致,
gcov -b -c 也确实给出分支覆盖(nand_ftl.c 分支至少走过一次 41.40%);
但换编译器=换分母(sha256.c gcc 105 行 vs MSVC 114 行;adc_input.c 101
vs 120)。**用户裁定:本仓只留 MSVC 一条覆盖率通道**,不建第二条——
多一套工具链就多一套分母、多一本台账、多一个"这台机器到底有没有 WSL/
gcov"的未决项,换来的只有分支这一维。分支覆盖因此**记为已接受缺口**
(不是待办):绿灯只证明行与函数被测到,补偿判据 = TC 双向追溯 +
用例显式列边界值;§8 写明重开该裁定的前提是先答"两份分母怎么对齐"。

刻意未挂 pre-commit:16 个单测钩子已经跑过同一批测试;依赖 VS 可选
组件(缺组件时 skip 会静默失效、FAIL 会拦换机);待一个真实回退事件。
YAML 片段与理由写在口径文档 §8。

自查:pre-commit run --files(6 个改动文件)全 Passed;check_doc_links
--all 回到存量 35 处(本分支贡献 0);check_ids.py --strict PASS;
check_mojibake + BOM/CR/U+FFFD/行尾卫生逐项自查全净。本轮零 .c/.h 改动
(纯 .py/.json/.md),故未跑 @build、未占 build/bench 锁。
2026-10-23 23:44:45 +08:00
..

scripts/ — 开发脚本(提交门禁 + 报告生成)

本目录是 pre-commit 门禁脚本与报告生成脚本的存放处。 与 tools/(面向开发者的功能工具)区别:本目录服务于质量门禁与工程度量。

文件一览

提交门禁(接入 .pre-commit-config.yaml)

脚本 钩子名 作用
check_coding_standard.py C coding standard C 代码规范机械检查(命名前缀/常量右置/头文件保护宏等)
check_mojibake.py Forbid U+FFFD mojibake 扫描 U+FFFD 乱码(EF BF BD 字节)
check_doc_links.py doc-links 文档链接存在性 + 命名规范(D-3/D-7)+ §N.M 章节引用(口径见 docs/文档规范.md §3.5)。钩子已带 --sections-strict(自引用失效也拦);--section-todo 列出机器判不了目标的 §(带改写建议)。每次跑打印「可判定比例」行,防覆盖率回落
section_aliases.json (被 check_doc_links.py 读) 文档昵称别名表:「内存方案」→ docs/内存管理/RAM使用分析与优化方案.md。只登记无歧义昵称;登记一次即把该昵称的引用纳入硬门禁
check_ids.py id-check 编号门禁:docs/编号规范.md §8 的八项校验(未登记前缀 / 形态 / 悬空 / 重复定义 / 越游标 / 未紧邻文档名 / 孤儿 / 可判定比例)。已关闸为增量拦截:钩子带 --strict,只拦 scripts/id_known_backlog.json 台账之外的新错误级问题(存量按指纹豁免、台账只减不增);可判定比例跌破基线任何模式都失败。详表(含限制与盲区)→ docs/门禁说明/id-check.md
id_registry.json (被 check_ids.py 读) 前缀族注册表:属主登记处 / 形态正则 / 冻结 / 游标,逐项来自 docs/编号规范.md §4;decidable_ratio_baseline = 校验 8 的基线(只许涨)。与 section_aliases.json 同一套"别名表 + 可判定比例"范式
id_aliases.json (被 check_ids.py 读) 编号别名/作废表:旧字面量 → 现行字面量或 status: void(如 N-32 销项后仍被引用、T-4 随销项永久作废、模块码 PHY→NET)
check_test_traceability.py (被 id-check 顺带调用) TC 用例双向追溯:文档 ↔ 代码两侧的 TC 编号集合比对;2026-10-20 起范围扩到 test/host/ 与 7 篇「单元测试说明.md」(--board-only 回退旧板级口径)。此前该脚本未挂任何钩子
gen_task_table.py task-table FreeRTOS 任务表以 Src/freertos.c 为唯一事实源生成/校验(D-2/D-7)
check_mem_numbers.py mem-numbers 内存/Flash 数字以 .map 为唯一事实源校验(D-7 体积档)
check_test_suite.py test-suite-switch 测试套件开关=产品构建(防测试固件静默提交)

报告生成(非门禁)

脚本 作用
ram_report.py 从 .map 生成静态 RAM/Flash 占用报告(→ docs/内存管理/data/)
stack_report.py 从 Keil 静态调用图 + 串口 [STACK] 水位生成每任务最坏链报告

引用同步(改名 / 挪目录)

脚本 作用
rename_ids.py 编号(字面量)批量改名:映射表 JSON 驱动,files 显式 scope(同一裸形字面量可能属多族,实测 S3 三义 → 全局替换必造新撞号);默认干跑,--apply 落盘并自动写 id_aliases.json 的 scoped 旧号→新号条目;[示例]/[计划] 行与变更记录表不改写;按原字节读写(保 BOM 与行尾)。用法与批次记录 → docs/编号规范.md §8.3
rename_ref.py 改名/挪目录 + 全库引用自动改写:默认 dry-run 预览,--apply 才落盘(git mv → 改写引用 → 自动跑 check_doc_links --all 复核)。覆盖反引号引用、Markdown 链接、图片 ../ 层级换算、#include、uvprojx/CMakeLists.txt 源列表。固定动作与边界 → docs/文档规范.md §3.6

check_doc_links.py 除链接存在性外,还校验 §N.M 章节引用是否指向目标文档真实存在的编号标题(口径见 docs/文档规范.md §3.5)。

CI 与本地等价(2026-10-01 T-6)

脚本 / 文件 作用
ci_local.py 本地跑与 CI 等价的门禁(L0 pre-commit + L0b 提交信息 + L0.5 主机侧单测):自动选用装了 pre-commit 的解释器;无 .map 时自适应跳过 mem-numbers;退出码 0/1/2 与 CI 对齐。CI 定义见 ../.gitea/workflows/ci.yml,覆盖边界见 docs/测试说明/测试开发标准流程.md §9
ci_gitlint_range.ps1 CI 侧提交信息门禁:逐条校验本次 push/PR 引入的提交(--all-files 跑不到 commit-msg stage,故必须单独守)
ci_find_python.ps1 CI 侧 Python 探测(候选顺序须与 ci_local.py 同序同步,否则 CI 与本地判定会分叉)
ci_runner_bootstrap.ps1 本机 runner 运维脚本(体检 -Status / 干跑 -DryRun / 部署 -SetEnv -StartNow):装"等 Gitea 就绪 + 崩溃自拉起"的看门狗 + 开机计划任务 + 机器级 DTU_*

⚠️ 后三个脚本是本机 runner 专属运维(远程 CI 只跑在本机一台机器上),用法、原理与 踩坑全部集中在 docs/CI/README.md,本表只登记不展开。

使用方式

# 全库跑门禁(用仓库 .venv 的 python,其 pre-commit 随 requirements.txt 安装;
# 其他装有 pre-commit 的解释器可用 DTU_PRECOMMIT_PYTHON 指定)
& '.venv\Scripts\python.exe' -m pre_commit run --all-files

# 本地跑与 CI 等价的门禁(L0 + L0.5)
& '.venv\Scripts\python.exe' scripts/ci_local.py
& '.venv\Scripts\python.exe' scripts/ci_local.py --l0-only    # 只跑 L0
& '.venv\Scripts\python.exe' scripts/ci_local.py --l05-only   # 只跑 L0.5

# 单个脚本
& '.venv\Scripts\python.exe' scripts/check_doc_links.py --all
& '.venv\Scripts\python.exe' scripts/rename_ref.py docs/旧/名.md docs/新/名.md          # 预览
& '.venv\Scripts\python.exe' scripts/rename_ref.py docs/旧/名.md docs/新/名.md --apply  # 落盘
& '.venv\Scripts\python.exe' scripts/gen_task_table.py --check   # 或 --write / --diff
& '.venv\Scripts\python.exe' scripts/check_mem_numbers.py --check
& '.venv\Scripts\python.exe' scripts/check_test_suite.py               # 门禁判定
& '.venv\Scripts\python.exe' scripts/check_test_suite.py --allow-test-build  # 放行测试构建
& '.venv\Scripts\python.exe' scripts/ram_report.py
& '.venv\Scripts\python.exe' scripts/stack_report.py -s .dsh\skills\serial-assistant\scripts\state\serial.log

⚠️ 脚本编写约定

  • 保真回写:改文件前先探测原换行符(LF/CRLF)与 BOM,按原样回写(本仓库各文件换行混杂)
  • 受管区锚点:改文档中的数值/表格时用 <!-- XXX:BEGIN/END --> 锚点,只替换锚点内内容
  • 脚本输出文件绝不能落在自身扫描范围内(否则会"自我污染",见 docs-tree-reorg skill)
  • 生成器与校验器共用同一套正则/口径,避免两处数字打架

相关文档

  • docs/代码规范/pre-commit使用说明.md — 门禁完整说明与排除项
  • docs/代码规范/cppcheck使用说明.md
  • docs/文档规范.md — 文档门禁三档
  • docs/内存管理/RAM使用分析与优化方案.md — RAM/栈报告口径