|
|
||
|---|---|---|
| .. | ||
| cli | ||
| integration | ||
| templates | ||
| README.md | ||
| test_format_md_action.py | ||
| test_gitattributes_modes.py | ||
| test_plan_progress_cli.py | ||
| test_superpowers_list_sync.py | ||
| test_sync_templates_placeholders.py | ||
| test_toml_edge_cases.py | ||
README.md
🧪 Playbook 测试套件
本目录包含 Playbook 项目的测试,用于验证 CLI、模板与文档链接。
📋 目录结构
tests/
├── README.md # 本文件:测试文档
├── cli/ # Python CLI 测试(unittest)
│ └── test_playbook_cli.py # playbook.py 基础功能测试
├── test_format_md_action.py # format_md 动作测试
├── test_gitattributes_modes.py # gitattr_mode 行为测试
├── test_plan_progress_cli.py # plan_progress CLI 测试
├── test_superpowers_list_sync.py # superpowers 列表一致性测试
├── test_sync_templates_placeholders.py # 占位符替换测试
├── test_toml_edge_cases.py # TOML 解析边界测试
├── templates/ # 模板验证测试
│ ├── validate_python_templates.sh # Python 模板验证
│ ├── validate_cpp_templates.sh # C++ 模板验证
│ ├── validate_ci_templates.sh # CI 模板验证
│ └── validate_project_templates.sh # 项目模板验证
└── integration/ # 集成测试
└── check_doc_links.sh # 文档链接有效性检查
🚀 快速开始
# 进入 playbook 根目录
cd /path/to/playbook
# 1. 运行 Python CLI 测试
python -m unittest discover -s tests/cli -v
# 1.1 运行其他 Python 测试(tests/ 下的 test_*.py)
python -m unittest discover -s tests -p "test_*.py" -v
# 2. 运行模板验证测试
sh tests/templates/validate_python_templates.sh
sh tests/templates/validate_cpp_templates.sh
sh tests/templates/validate_ci_templates.sh
sh tests/templates/validate_project_templates.sh
# 3. 运行文档链接检查
sh tests/integration/check_doc_links.sh
🧭 CI 自动化测试
测试套件通过 Gitea Actions 自动运行(见 .gitea/workflows/test.yml):
- 触发时机:
- 推送到
main分支 - Pull Request 到
main分支 - 手动触发(workflow_dispatch)
- 推送到
- 运行平台:ubuntu-22.04
📚 测试详解
1. Python CLI 测试 (cli/)
使用 unittest 运行,覆盖 scripts/playbook.py 的核心行为:
- CLI 参数解析与帮助信息
- TOML 配置解析与动作顺序
- vendor/sync/install 等基础动作落地
2. 模板验证测试 (templates/)
通过脚本检查各类模板文件结构与关键字段(如占位符、关键配置项)。
3. 文档链接检查 (integration/)
扫描 docs/ 与模板文件中的本地链接,确保引用路径有效。