Files
STM32F4-Base/docs/测试说明/看门狗单元测试说明.md
T
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

10 KiB
Raw Blame History

看门狗单元测试说明(主机侧)

模块:Task Watchdog(IWDG + 任务心跳位图,App/util/task_watchdog.c) 测试类型:主机侧纯逻辑单元测试(L0.5 层,见 §1.5)——在 PC 上离线验证 判定状态机,零硬件、零烧录、秒级、不占 MCU 的 RAM。 状态:✅ 已落地(39 用例,@build 0/0,已挂 pre-commit 钩子) 日期:2026-10-01 关联文档: ../子系统设计/看门狗设计说明.md(被测行为的设计依据)、 测试开发标准流程.md(测试分层与门禁总览)、 测试文档模板规范.md(本文命名规范)


1. 概述

1.1 为什么单独做主机侧单测

task_watchdog.c 分两半:

半边 内容 可测性
判定状态机(被测) 位图取走清零、必需掩码比较、miss_streak 累计(容忍 8 次)、100 ms 抽样节流、tick 回绕安全 纯逻辑,与硬件无关 → 可在 PC 上位穷举
硬件副作用 IWDG->KR 写(喂狗 / 启动)、HAL_GetTick() 需真机或桩

板端套件(test/board/)只能"在真机上完整跑一遍",无法穷举边界——例如:

  • 节流窗口边界 99 ms / 100 ms / 199 ms / 200 ms 的分野;
  • 连续缺席第 7 次 / 第 8 次 / 第 9 次的行为差异(停喂触发点);
  • HAL_GetTick() 跨越 2^32 回绕后是否仍正确节流。

这些用主机侧单测一次性钉死,且不占 MCU 的 RAM(本项目 RAM 已 95%,见 docs/内存管理/)。设计上参照项目既有的"共享核心 + 平台后端"做法 (App/cfg/cfg_file_store.h:MCU 端 cfg_file_store_mcu.c / 模拟器端 cfg_file_store_sim.c)。

1.2 被测对象与桩

被测源文件以 #include 原样纳入测试单元,保证测的是生产代码而非副本:

test/host/watchdog/watchdog_test.c
    ├── #include "main.h"    → stub/main.h     (HAL_GetTick 声明)
    ├── #include "iwdg.h"    → stub/iwdg.h     (IWDG_TypeDef + IWDG 外部声明)
    ├── #include "dbg_log.h" → stub/dbg_log.h  (DBG_* 映射 + 错误计数)
    └── #include "task_watchdog.c"  ← 生产源文件(App/util/),原样纳入

三个平台钩子(声明在 App/util/task_watchdog.h 末段"平台后端(内部)")在主机侧被替换为可观测桩:

钩子 MCU 默认实现(__weak) 主机侧桩
wd_platform_feed() IWDG->KR = 0x0000AAAAu 计数 s_feed_count++ + 写影子寄存器
wd_platform_start() IWDG->KR = 0x0000CCCCu 计数 s_start_count++ + 写影子寄存器
wd_platform_tick_ms() HAL_GetTick() 返回单测可控的 s_tick

生产端零增量:三个钩子在 MCU 构建下就是原来的寄存器写 / HAL 调用,行为逐字一致, 无额外分支、无额外符号(@build 0/0 已验)。平台默认实现由 #ifndef TASK_WATCHDOG_UNIT_TEST 守卫;测试专用复位 task_wd_test_reset() 仅在主机侧编译(MCU 构建零代码、零符号)。

1.3 测试环境

依赖 版本 / 说明
编译器 本机 MSVC(VS2019 BuildTools 14.29 / VS2022 任一),由 run_unit_test.py 自动探测
Python 仓库 .venv 或任意 python3(纯标准库)
硬件 无(不需要开发板 / 串口 / ST-LINK)

为何不调 vcvars64.bat:它内部调用 reg.exe 探测环境,本机安全策略禁止 reg.exe。运行器因此直接拼 INCLUDE/LIB 环境变量并用绝对 路径调 cl.exe(只需 MSVC 版本目录 + Windows SDK 的 include/lib),无副作用、可重复。

该工具链逻辑不在本模块目录内(2026-10-01 T-3 抽取):已沉淀为通用 harness ../../test/host/common/unit_test_harness.py, 本模块的 run_unit_test.py 只声明 TestBuild(源文件 / 桩目录 / 汇总行标记)。 新增 L0.5 单测时直接复用 harness,见 ../../test/host/common/README.md。

1.4 运行方式

# 仓库根目录(统一用 .venv)
& '.venv\Scripts\python.exe' test/host/watchdog/run_unit_test.py

退出码:0=PASS / 1=测试失败 / 2=环境错误(找不到编译器 / 编译失败 / 无汇总行)。

1.5 回归接入

项 说明
触发范围 App/util/task_watchdog.c / task_watchdog.h,或 test/host/watchdog/**、test/host/common/unit_test_harness.py 变动
门禁层级 L0.5 层(介于 L0 静态门禁与 L1 板端套件之间):主机侧、秒级、纯逻辑,比板端套件便宜、比静态检查更强
pre-commit 钩子 watchdog-unit-test(本地钩子,.pre-commit-config.yaml §7)
汇总行 === Task Watchdog Tests: N/N PASSED (failed=0) ===
与板端测试的关系 互补:本单测保证判定逻辑正确;板端 @test 故障注入(docs/待处理内容.md N-03 V2/V4)保证真机复位链路正确

2. 测试用例

命名 TC-WD-NNN(WD = Watchdog)。全部在 watchdog_test.c 内,主机侧运行。

用例 断言 验证的设计点
TC-WD-001 未启动时 poll 不喂狗、is_armed()==0 启动前不判定(s_started 门卫)
TC-WD-016 未启动时即使全员置位也不喂、不更新 last_mask 同上(位图无关)
TC-WD-014 重复 task_wd_start() 只启动 IWDG 一次 启动幂等(IWDG 不可逆,重复启动无意义)
TC-WD-015 start 内部先喂一次(feed_count==1) 首个抽样窗口从启动时刻起算,避免启动即超时
TC-WD-002 50 ms 内 poll 不喂;累计 100 ms 喂 1 次 100 ms 抽样节流
TC-WD-003 全员置位 → 喂狗 1 次;last_mask==0x37 全员到位判定 + 掩码取值
TC-WD-004 不重新置位则第二轮不喂 取走清零语义(旧位不残留)
TC-WD-005 缺 UI(bit4)→ 不喂;last_mask 精确记录缺失位 必需掩码比较 + 缺失定位
TC-WD-006 连续 1..7 次缺席不报;第 8 次打 [WD] task stall;缺席期间不喂 WD_MISS_TOLERANCE=8(800 ms)停喂触发点
TC-WD-007 停喂后每 100 ms 复报一条 stall(现状行为) 见 §4 已知行为("最后遗言"持续到复位)
TC-WD-008 恢复全员到位 → 立即喂狗 + streak 归零 停顿可恢复(非锁死状态机)
TC-WD-009 99 ms 不判 / 100 ms 判 / 再 99 ms 不判 / 累计 100 ms 判 节流窗口边界(易错点)
TC-WD-010 tick 跨 2^32 回绕后 100 ms 仍正确判 无符号差比较(回绕安全)
TC-WD-011 is_armed/last_mask/miss_count 语义 观测接口正确性
TC-WD-013 非法任务 ID(>= TASK_WD_ID_MAX)被忽略,不污染位图 防位图越界(task_wd_beat 的守卫)

当前结果:39/39 PASSED(failed=0)。


3. 如何扩展用例

  1. 在 watchdog_test.c 加一个 static void tc_0NN_xxx(void);
  2. 用 fresh() 开头(复位模块静态态 + 清观测计数 + 时钟归零);
  3. 用 start_and_clear() 启动(并清掉 start 自身那一次喂狗);
  4. beat_all() / task_wd_beat(...) 置位,poll_advance(ms) 推进时间并抽样;
  5. CHECK(cond, "描述") 断言;
  6. 在 main() 里 fresh(); tc_0NN_xxx(); 注册。

⚠ 别忘 fresh():task_wd_poll 的节流基准 s_last_tick 与位图 / 计数都是模块 静态态,跨用例不隔离会导致假失败(本项目开发时即踩到,见 §4)。


4. 已知行为与可优化点

4.1 stall 日志在停喂后复报(TC-WD-007,现状)

实现(task_watchdog.c):

if (s_miss_streak < WD_MISS_TOLERANCE) { s_miss_streak++; }
if (s_miss_streak >= WD_MISS_TOLERANCE) { DBG_ERROR("[WD] task stall: ..."); }

streak 封顶 8 后,判定条件 streak >= 8 在后续每轮仍成立 → 每 100 ms 复报一条, 直到 IWDG 约 900 ms 后复位(约 9 条/停顿周期)。

评估:这是刻意的"最后遗言"——复位前日志窗口内信息不丢。代价是日志冗余。 若改为"每停顿周期仅报一次",需加一个 s_stall_reported 标志(在 streak 归零时清除)。 当前保留现状(单测按现状断言,行为变更须同步改 TC-WD-007 与本文)。

4.2 测试隔离依赖 task_wd_test_reset()

task_wd_poll 的节流基准 s_last_tick 曾是函数内 static,task_wd_test_reset() 够不到它 → 跨用例基线残留 → 假失败。已改为文件静态并纳入复位。 (这同时是更好的生产设计:模块状态应归于模块。)


5. 与板端验证的分工

层 覆盖 状态
本单测(L0.5) 判定状态机全部逻辑分支与边界 ✅ 已落地
板端故障注入(L1/L2) 真机:单任务卡死 → 停喂 → IWDG 真复位 → RCC_CSR 记 IWDGRSTF ⏳ 待台架(docs/待处理内容.md N-03 V2/V4)
长跑(L2) ≥30 min 无假复位(miss_count 稳定) ⏳ 待台架(N-03 V5)

本单测不能替代板端验证:IWDG 实际溢出时间、LSI 频率漂移、SHCSR/复位原因 寄存器的真机行为,仍需 @test 台架闭环确认。


变更记录

日期 变更
2026-10-01 §1.3/§1.4/§1.5 更新:工具链逻辑抽取到通用 harness test/host/common/unit_test_harness.py(T-3),本模块 run_unit_test.py 改为声明式 TestBuild(原 170 行 → 55 行);hooked 触发范围加 test/host/common/unit_test_harness.py。行为与退出码契约不变(39/39 PASSED)
2026-10-01 创建:看门狗判定状态机主机侧单元测试(39 用例)+ 平台层抽取(task_watchdog.h 末段三个 __weak 钩子)+ pre-commit 钩子 watchdog-unit-test;记录两处已知行为(stall 复报、测试隔离)