SKILL.md
WHartTest 测试管理平台
快速开始
# 设置环境变量
export WHARTTEST_BACKEND_URL="http://your-backend:8000"
export WHARTTEST_API_KEY="your-api-key"
# 执行操作
python whart_tools.py --action <action_name> [--参数名 参数值]
可用操作
项目管理
| Action | 描述 | 参数 |
|---|---|---|
get_projects |
获取所有项目列表 | 无 |
get_modules |
获取项目下的模块列表 | --project_id |
add_module |
新增用例模块 | --projectid, --name, --parentid (可选) |
用例管理
| Action | 描述 | 参数 |
|---|---|---|
get_levels |
获取用例等级列表 | 无 |
get_testcases |
获取模块下的用例列表 | --projectid, --moduleid |
gettestcasedetail |
获取用例详情 | --projectid, --caseid |
add_testcase |
新增测试用例 | --projectid, --moduleid, --name, --level, --precondition, --steps, --notes, --reviewstatus, --testtype |
edit_testcase |
编辑测试用例 | --projectid, --caseid, --name, --level, --moduleid, --precondition, --steps, --notes, --reviewstatus, --testtype, --isoptimization |
截图管理
| Action | 描述 | 参数 |
|---|---|---|
upload_screenshot |
上传单张截图 | --projectid, --caseid, --filepath, --title, --description, --stepnumber, --page_url |
upload_screenshots |
批量上传截图 | --projectid, --caseid, --filepaths(逗号分隔), --title, --description, --stepnumber, --page_url |
截图路径约定:自动化技能(如 playwright-skill、browser-use)生成的截图应优先保存到 SCREENSHOTDIR 环境变量指定的目录。上传时只需传入文件名(无需路径),系统会优先从 SCREENSHOTDIR 查找;若未命中,会再回退到常见临时截图目录做兼容搜索。
单张上传:--filepath "case11step1.png" 批量上传:--filepaths "step1.png,step2.png,step3.png"(最多10张,逗号分隔)
文件管理
| Action | 描述 | 参数 |
|---|---|---|
list_files |
获取项目文件列表 | --projectid, --page, --pagesize, --search, --status, --extension, --mime_type, --ordering |
getfiledetail |
获取文件详情 | --projectid, --fileid |
upload_file |
上传单个项目文件 | --projectid, --filepath |
upload_files |
批量上传项目文件 | --projectid, --filepaths(逗号分隔) |
validate_files |
校验 file_ids 是否存在、属于项目且状态可用 | --projectid, --fileids(JSON数组或逗号分隔) |
getfilereferences |
获取文件引用详情 | --projectid, --fileid |
delete_file |
删除项目文件;被引用文件由后端软删除 | --projectid, --fileid |
getfilesettings |
获取项目文件管理设置 | --project_id |
updatefilesettings |
更新自动清理设置 | --projectid, --autodeleteonunbind, --autodeletezero_refs |
cleanupunreferencedfiles |
立即清理无引用项目文件 | --project_id |
download_file |
下载文件到本地 | --projectid, --fileid, --outputpath 或 --outputdir |
preview_file |
预览文件;文本直接返回,二进制可保存 | --projectid, --fileid, --output_path(可选) |
文件 ID 约定:上传文件后返回的 id / fileid 可传给接口自动化、UI 自动化或智能体对话中的 fileids 字段。使用前可通过 validate_files 校验。
设置布尔值:--autodeleteonunbind 与 --autodeletezerorefs 使用 true / false。
审核状态
--review_status 可选值:
pending_review- 待审核(默认)approved- 通过needs_optimization- 优化optimizationpendingreview- 优化待审核unavailable- 不可用
测试类型
--test_type 可选值:
smoke- 冒烟测试functional- 功能测试(默认)boundary- 边界测试exception- 异常测试permission- 权限测试security- 安全测试compatibility- 兼容性测试
--isoptimization 标志(布尔型,无需传值):在 edittestcase 时带上此标志,会自动将状态设为 optimizationpendingreview(优化待审核),用于AI优化后的用例提交。一次调用即可完成编辑+状态更新。
- ✅ 正确用法:
python wharttools.py --action edittestcase --projectid 1 --caseid 51 ... --is_optimization - ❌ 错误用法:
--is_optimization true(不要传值)
使用示例
# 获取项目列表
python whart_tools.py --action get_projects
# 获取项目1的模块
python whart_tools.py --action get_modules --project_id 1
# 新增用例模块
python whart_tools.py --action add_module --project_id 1 --name "新功能模块"
# 新增子用例模块
python whart_tools.py --action add_module --project_id 1 --name "子功能模块" --parent_id 10
# 获取用例列表
python whart_tools.py --action get_testcases --project_id 1 --module_id 5
# 新增用例
python whart_tools.py --action add_testcase \
--project_id 1 \
--module_id 5 \
--name "登录功能测试" \
--level P0 \
--precondition "用户已注册" \
--steps '[{"step_number":1,"description":"输入用户名","expected_result":"用户名显示"}]' \
--notes "冒烟测试"
# 上传单张截图
python whart_tools.py --action upload_screenshot \
--project_id 1 \
--case_id 10 \
--file_path "step1.png" \
--title "登录页面截图" \
--step_number 1
# 批量上传截图
python whart_tools.py --action upload_screenshots \
--project_id 1 \
--case_id 10 \
--file_paths "step1.png,step2.png,step3.png" \
--title "登录测试截图"
# 上传项目文件
python whart_tools.py --action upload_file \
--project_id 1 \
--file_path "./需求说明.docx"
# 查询项目文件
python whart_tools.py --action list_files \
--project_id 1 \
--search "需求" \
--page_size 20
# 校验附件 file_ids
python whart_tools.py --action validate_files \
--project_id 1 \
--file_ids "12,13"
# 下载项目文件
python whart_tools.py --action download_file \
--project_id 1 \
--file_id 12 \
--output_dir "./downloads"
# 更新文件清理设置
python whart_tools.py --action update_file_settings \
--project_id 1 \
--auto_delete_on_unbind true \
--auto_delete_zero_refs false
输出格式
所有操作返回 JSON 格式结果,便于解析处理。