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 模板)
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,直接内联):
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 §4.2):
MSVC cl.exe(装了 VS 即有)+ Windows SDK + 纯标准库 Python;不调 vcvars64.bat
(内部 reg.exe 受限),直接拼环境变量调 cl.exe。
⚠️ 注意
- 本目录在 pre-commit 的 cppcheck / 代码规范排除范围(
test/豁免) - 改动本 harness 会触发
watchdog-unit-test钩子(files正则已含本文件)