wandering1
2055de0303
背景：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/开关切换/异常还原均实测通过。
83 lines
3.6 KiB
Markdown
83 lines
3.6 KiB
Markdown
# test/host/common/ — 主机侧测试公共库
|
||
|
||
> L0.5 主机侧单元测试的**通用 harness**：被各模块的单测运行器共享，
|
||
> 集中承载工具链探测与编译/运行/判定的公共细节。
|
||
|
||
## 文件一览
|
||
|
||
| 文件 | 作用 |
|
||
|---|---|
|
||
| `unit_test_harness.py` | **通用单测 harness**（纯标准库）：探测本机 MSVC → 拼 `INCLUDE`/`LIB` → 编译测试单元 → 运行 → 判定退出码 |
|
||
|
||
## 为什么要有这层（2026-10-01 抽取，T-3）
|
||
|
||
看门狗单测最早的运行器（`test/host/watchdog/run_unit_test.py`）把工具链探测、
|
||
`INCLUDE`/`LIB` 拼接、GBK 解码、`/wd4819` 抑制、退出码契约**全写死在模块目录内**。
|
||
第二个 L0.5 单测出现时须整段复制——工具链细节一旦修正（新增 VS 版本、SDK 布局
|
||
变化、编码处理调整）就会发散。抽取后各模块运行器只剩"声明式"配置。
|
||
|
||
> **边界**：harness **不认识任何模块**——源码路径、桩目录、额外 include、断言
|
||
> 汇总行特征全部由调用方传入。新单测只写一个 `TestBuild(...)` + 一行 `sys.exit(...)`。
|
||
|
||
## 用法（模块侧 `run_unit_test.py` 模板）
|
||
|
||
```python
|
||
import os, sys
|
||
HERE = os.path.dirname(os.path.abspath(__file__))
|
||
ROOT = os.path.dirname(os.path.dirname(os.path.dirname(HERE)))
|
||
sys.path.insert(0, os.path.join(ROOT, "test", "host", "common"))
|
||
|
||
from unit_test_harness import TestBuild, run_host_unit_test
|
||
|
||
BUILD = TestBuild(
|
||
name="<模块名> Tests", # 人类可读名（打印用）
|
||
src=os.path.join(HERE, "<模块>_test.c"), # 测试单元（内部 #include 生产源）
|
||
include_dirs=[ # 顺序敏感：桩目录必须在生产目录之前
|
||
os.path.join(HERE, "stub"),
|
||
os.path.join(ROOT, "App", "util"),
|
||
HERE,
|
||
],
|
||
summary_marker="=== <模块名> Tests:", # 运行输出中必须出现的汇总行前缀
|
||
)
|
||
|
||
if __name__ == "__main__":
|
||
sys.exit(run_host_unit_test(BUILD))
|
||
```
|
||
|
||
另一写法（不落 `run_unit_test.py`，直接内联）：
|
||
|
||
```python
|
||
from unit_test_harness import TestBuild, run_host_unit_test
|
||
raise SystemExit(run_host_unit_test(TestBuild(name="...", src="...", ...)))
|
||
```
|
||
|
||
## 退出码契约（各模块运行器统一遵循）
|
||
|
||
| 码 | 含义 |
|
||
|---|---|
|
||
| `0` | PASS——编译 + 运行成功，且日志含 `summary_marker` |
|
||
| `1` | FAIL——有测试用例未通过 |
|
||
| `2` | 环境错误——找不到编译器 / 编译失败 / 未产生汇总行 |
|
||
|
||
## `TestBuild` 字段
|
||
|
||
| 字段 | 必填 | 说明 |
|
||
|---|---|---|
|
||
| `name` | ✓ | 打印用名称；同时用于派生 exe 名与 obj 目录名 |
|
||
| `src` | ✓ | 测试单元 `.c` 的绝对路径（内部 `#include` 生产源，保证测的是真代码） |
|
||
| `include_dirs` | | `/I` 目录列表；**桩目录需排在前面**才能覆盖真实头 |
|
||
| `summary_marker` | | 运行输出中必须出现的汇总行前缀；空 = 不校验 |
|
||
| `extra_flags` | | 追加的 `cl.exe` 开关 |
|
||
| `exe_name` / `obj_tag` | | 覆盖派生的产物名 / 中间目录名（默认由 `name` 派生，落在系统 temp） |
|
||
|
||
## 环境要求
|
||
|
||
同 L0.5 通用要求（见 [`../../../docs/测试说明/测试开发标准流程.md`](../../../docs/测试说明/测试开发标准流程.md) §4.2）：
|
||
MSVC `cl.exe`（装了 VS 即有）+ Windows SDK + 纯标准库 Python；**不调 `vcvars64.bat`**
|
||
（内部 `reg.exe` 受限），直接拼环境变量调 `cl.exe`。
|
||
|
||
## ⚠️ 注意
|
||
|
||
- 本目录在 pre-commit 的 cppcheck / 代码规范**排除范围**（`test/` 豁免）
|
||
- 改动本 harness 会触发 `watchdog-unit-test` 钩子（`files` 正则已含本文件）
|