Files
STM32F4-Base/test/board/test_common.h
T
wandering1 f754d59218 docs(测试说明): 按用途分六个子目录并同步全库引用
分层:流程与规范/ 单元测试/ 板级测试/ 专项验证/ 测试工具/ 测试数据/,
顶层只留新增的目录导航 README.md(归层判据 + 硬约束 + 本次处置记录)。

- 搬迁 28 个路径:测试数据三个目录 58 个文件为纯改名(R100,内容逐字节不变)
- 全库引用同步 124 个文件:AGENTS / docs 索引 / skills / 门禁注释 / scripts
- 门禁面:scripts/check_test_traceability.py 的 glob 改 rglob
  (分层后不递归扫描=追溯门禁直接瞎掉)
- scripts/rename_ref.py:收尾的 ℹ 提示在 GBK 代码页抛 UnicodeEncodeError,
  让进程以退出码 1 收场而改写其实已落盘(RC 与真实结果相反);改为把
  stdout/stderr reconfigure 成 UTF-8,与 check_doc_links.py 等同法
- docs/文档规范.md §1.1 补「子目录文件过多时再分一层」;§3.6 补 rename_ref
  搬整目录的两个实测坑:① 会改写目录内部文件的内容 ② 内部文件的 ../ 出链
  不补层级(本次 23 个被误改的证据文件已按 HEAD 原始字节逐字节还原)
- docs/README.md §6 改为与六个子目录一一对应,并补登原先漏登记的
  「启动日志原子性复验流程」一行
- .cubemx_survival_baseline.json:App/util/task_watchdog.c 的注释路径也随分层更新,
  该文件是存活审计的 watchdog-module 漂移锚点,按脚本自己的提示跑 --write 重建基线
  (实测重建后仅 watchdog-module 一条哈希变化)
- 铁律 4 例外(本次在任务树里改了单写者文件):AGENTS.md 与
  .pre-commit-config.yaml 只被 rename_ref 改写路径字面量(后者全在注释行),
  任务表块与钩子声明一字未动

验证:check_doc_links.py --sections-strict 覆盖全部 88 个改动 .md 全绿;
check_test_traceability.py 输出与主树逐行一致;196 个文本文件无 BOM、无新增
CR、无 U+FFFD、无行尾空白;陈旧引用面由主树 25 处降到 6 处(无新增断链)。
2026-10-30 07:16:07 +08:00

83 lines
3.2 KiB
C
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
/*
* 模块名称:板端测试套件公共断言宏
* 模块功能:为 test/board/ 下的各测试套件提供**语义统一**的统计结构体与断言/
* 报告宏内核,消除 4 套件(CH395F / STORAGE / GD5F / RTC)之间逐字重复的
* 宏定义(2026-10-01 测试架构评审)。
*
* 设计取舍:**统计变量仍按套件独立**(各套件持有自己的 `g_xxx_stats`),
* 公共宏只提供"内核",由各套件用一行宏把它绑定到自己的统计变量。
* 理由见 docs/测试说明/流程与规范/测试开发标准流程.md §3.2:
* - 统计变量独立 = 防跨套件串数(历史约定,不能破);
* - 内核共用 = 报告行格式/字段一处维护,改一次即全生效。
*
* 适用平台:STM32F4 系列
* 作者:王建锋
* 创建日期:2026-10-01
*
* ⚠️ 本头文件**刻意不 include `dbg_log.h`**:
* `dbg_log.h` 在未定义 `DBG_TAG` 时会给出默认值 `""`(`#ifndef DBG_TAG`),
* 而本文件被各套件头在**很靠前**的位置包含——若在此处拉入 `dbg_log.h`,
* 会把空 `DBG_TAG` 冻结,导致各 `.c` 文件随后 `#define DBG_TAG "[TEST_TASK]"`
* 触发 ARMCC `#47-D: incompatible redefinition of macro "DBG_TAG"`(实测 8 条警告)。
* 这里的宏只在**使用点**展开(使用点在 `.c` 中,且那些 `.c` 已按约定先
* `#define DBG_TAG` 再 include `dbg_log.h`),故无需在此引入。
*
* 用法(套件头文件内):
* #include "test_common.h"
* typedef test_stats_t gd5f_stats_t; // 或直接用 test_stats_t
* extern gd5f_stats_t g_gd5f_test_stats;
* #define GD5F_TEST_CHECK(cond, fmt, ...) \
* TEST_CHECK_IMPL(g_gd5f_test_stats, cond, fmt, ##__VA_ARGS__)
* #define GD5F_TEST_REPORT(name) TEST_REPORT_IMPL(g_gd5f_test_stats, name)
*/
#ifndef TEST_COMMON_H
#define TEST_COMMON_H
#ifdef __cplusplus
extern "C" {
#endif
#include <stdint.h>
/* 测试统计(各套件**各自**定义一个此类型的外部变量,防跨套件串数) */
typedef struct {
uint16_t total;
uint16_t passed;
uint16_t failed;
} test_stats_t;
/*
* 断言内核:统计自增 + [PASS]/[FAIL] 打印。
* 套件侧不应直接调用本宏(每次都要写统计变量名),而应用它派生出
* 自己的 `XXX_TEST_CHECK(cond, fmt, ...)`(见文件头用法)。
*/
#define TEST_CHECK_IMPL(stats, cond, fmt, ...) do { \
(stats).total++; \
if (cond) { \
(stats).passed++; \
DBG_INFO("[PASS] " fmt, ##__VA_ARGS__); \
} else { \
(stats).failed++; \
DBG_ERROR("[FAIL] " fmt, ##__VA_ARGS__); \
} \
} while (0)
/*
* 报告内核:套件运行结束时打印汇总行
* `=== <name>: N/M PASSED (failed=0) ===`
* 该汇总行是 `@test` 回归的默认判定标记(见 测试开发标准流程.md §3.2/§6.2.1)。
*/
#define TEST_REPORT_IMPL(stats, name) do { \
DBG_INFO("=== %s: %u/%u PASSED (failed=%u) ===", \
name, \
(unsigned)(stats).passed, (unsigned)(stats).total, \
(unsigned)(stats).failed); \
} while (0)
#ifdef __cplusplus
}
#endif
#endif /* TEST_COMMON_H */