Files
STM32F4-Base/test
wandering1 e4981aa2f6 refactor(docs): point entry-file references at their new homes
AGENTS.md stopped being the store of record for build steps, Python env,
hardware pins, doc conventions, log cost and task ownership. Those facts
already live in docs, skills and role files; the entry file now only
points at them. This commit moves every reference that used to name the
entry file to the authoritative landing point, so a reader who follows a
link arrives at the fact instead of at a sentence that no longer exists.

What changed is links and prose, not behaviour. Code, scripts and tests
only have comment and docstring lines touched; the only non-comment edit
in the whole changeset is one note string inside the generated pin table
JSON, and its generator was changed in the same step so the two stay
byte-identical.

New landing points created before the references were retargeted:
- The console single-writer log design doc, section 7.1, is now the single
  authority for log cost: about 90 B flash and 216 B stack per DBG_ line,
  and the rule that deep call chains must predefine DBG_LINE_BUF_MAX.
  It also carries the full list of the twelve translation units that have
  tightened it, plus the grep command that decides the truth if the list
  and the code ever disagree.
- The document writing standard, section 2, now holds the BOM list.
- keil-build skill gains an exit code table: 0 success, 1 build failure,
  2 BuildEnvError, 3 usage, 4 build lock held. This corrects a belief
  that was never actually written down anywhere: exit 2 does not simply
  mean environment error, argparse also exits 2 and the wrapper script
  was remapped so the two no longer collide.

Regenerated and checked byte for byte:
- The end-to-end architecture SVG in docs/images from its generator.
- tools/netlist_semantics/pinout_kb.json from gen_kb.py.
Both are idempotent; running the generators again produces no diff.

Deliberately not touched, because machines read them:
- scripts/check_bom_drift.py joins every line containing BOM and asserts
  four paths are present, so the entry file BOM line must stay one line.
- scripts/gen_task_table.py reads the TASK_TABLE anchors directly.
- scripts/rename_maps and scripts/archive keep their historical wording;
  they describe what happened, not what is true now.

Verified: doc links report the same six pre-existing findings as the base
commit and no new ones, generated-fresh passes, bom drift is clean across
101 files, and AGENTS.md itself is unchanged in this commit.
2026-11-16 19:38:27 +08:00
..

test/ — 测试代码与主机端脚本

测试分两部分,物理隔离在两个子目录:

  • board/ —— 板端测试套件(.c/.h,编入固件由 testTask 执行)
  • host/ —— 主机端脚本(.py,PC 侧驱动板子并判读结果)

目录结构

目录 内容 README
board/ 板端测试套件(编入 Keil 工程,占 RAM) board/README.md
host/ PC 端测试/判读脚本(Python) host/README.md
run_all_suites.py 多套件回归编排(改宏 → 构建 → 烧录 → 采集,try/finally 保证还原开关);--check-build = 只编译不烧录(纯离机) 本文 §多套件回归

运行方式

# /serial-boot-test 一键闭环(推荐)
& '.venv\Scripts\python.exe' .dsh/skills/serial-boot-test/scripts/run_boot_test.py

# 单独校验日志
& '.venv\Scripts\python.exe' .dsh/skills/serial-boot-test/scripts/verify_log.py <日志文件>

# 多套件回归编排(需真机;自动改开关 + 构建 + 烧录 + 采集,结束后还原)
& '.venv\Scripts\python.exe' test/run_all_suites.py
& '.venv\Scripts\python.exe' test/run_all_suites.py --suites STORAGE,GD5F
& '.venv\Scripts\python.exe' test/run_all_suites.py --dry-run      # 只看计划

# 只编译不烧录(不需要 MCU / 串口 / ST-LINK,验证 4 套件可编译性)
& '.venv\Scripts\python.exe' test/run_all_suites.py --check-build

退出码约定:0=PASS / 1=FAIL / 2=采集或烧录错误 / 3=用法或预检错误。

多套件回归(run_all_suites.py)

套件互斥(编译期 #error)意味着跑 4 个套件要手工循环 4 轮。本脚本把它编排成一条 命令,并且无条件还原 test_config.h——跑完忘还原 = 测试固件进库,这是它存在的 核心理由(与提交期门禁 test-suite-switch 互为独立防线)。

⚠️ 每轮要真机烧录 + 采集,4 套件约数分钟起;破坏性套件还会改设备持久状态。 仅回归窗口用,绝不挂 pre-commit。

--check-build 则相反:只改宏 + /keil-build,不烧录不采集,无需任何硬件,用于防止 "测试套件长期编不过而无人知"(2026-08~09 CH395F 套件实例)。改动 test/board/ 下测试 代码后建议先跑它——实测 4 套件均 BUILD_OK: 0 errors, 0 warnings。

⚠️ 注意

  • 本目录被 pre-commit 门禁排除(测试代码不受 C 规范约束)
  • board/ 套件占用 RAM,启用前先核算预算(见 docs/内存管理/)
  • Keil 工程已同步:board/ 下 7 个 .c 编入 MDK-ARM/STM32F4-Demo.uvprojx, IncludePath 含 ../test/board;移动文件须同步改工程文件
  • 套件选择开关:board/test_config.h 的 TEST_SUITE_*(互斥,一次只启用一个)
  • 测试缓冲用分 Phase 复用静态缓冲(避免 L6406E 溢出)

相关文档

  • docs/测试说明/流程与规范/测试开发标准流程.md — 测试验证分层与门禁决策表
  • docs/测试说明/流程与规范/自动化测试流程.md — /serial-boot-test 细节与失败模式
  • 各模块测试指南:docs/测试说明/板级测试/*_Test_Guide.md
  • docs/测试说明/专项验证/链路延迟测试说明.md