Files
STM32F4-Base/scripts
wandering1 2055de0303 测试:落地测试架构改进 T-1~T-5(套件开关门禁/汇总行校验/通用 harness/公共断言宏/多套件编排)
背景:L0.5 主机侧单测落地后复审测试架构,给出 6 条改进意见(P0~P3),
登记进 docs/待处理内容.md「测试与验证基础设施」后逐条实施。

- T-1(P0) 测试套件开关门禁:新增 scripts/check_test_suite.py + pre-commit 钩子
  test-suite-switch,默认要求产品构建(全部 TEST_SUITE_* 注释),跑套件回归用
  --allow-test-build / ALLOW_TEST_BUILD=1 显式放行。顺带把 test_config.h 中长期
  开启的 TEST_SUITE_CH395F 改回注释(仓库此前躺着的是测试固件)。
- T-2(P1) verify_log.py 增加 --require-suite-summary:要求
  "=== <名称>: N/M PASSED (failed=0) ===" 且 N>0,堵住"套件没跑到汇总行/
  断言数为 0 仍判 PASS"的盲区;run_boot_test.py 同名参数透传。不传参向后兼容。
- T-3(P1) 抽取通用 harness test/host/common/unit_test_harness.py(工具链探测/
  INCLUDE-LIB 拼接/wd4819/GBK 解码/退出码契约);watchdog 运行器 170→55 行,只声明 TestBuild。
- T-4(P2) 新增 test/board/test_common.h 集中断言内核(TEST_CHECK_IMPL/TEST_REPORT_IMPL),
  4 套件各用一行宏绑定自身统计变量(保持 g_xxx_stats 独立、防跨套件串数)。
  刻意不 include dbg_log.h——否则冻结 DBG_TAG 默认值触发 #47-D 重定义警告。
- T-5(P2) 新增 test/run_all_suites.py 多套件回归编排,try/finally 无条件还原套件开关。

验证:@build 产品构建 0 错 0 警;4 套件逐一构建均 0/0;看门狗单测 39/39 PASS;
pre-commit 14 钩子全通过;编排脚本 dry-run/开关切换/异常还原均实测通过。
2026-10-01 07:28:57 +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)
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] 水位生成每任务最坏链报告

使用方式

# 全库跑门禁
& 'C:\ProgramData\anaconda3\python.exe' -m pre_commit run --all-files

# 单个脚本
& '.venv\Scripts\python.exe' scripts/check_doc_links.py --all
& '.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 tools\serial_tool\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/栈报告口径