agentleFS
nieyuanqingnieyuanqing/software-engineering-skills/.claude/skills/new-test-case/SKILL.md

new-test-case

Skill4 starsChanged 26 days agoApache-2.0View on GitHub

在工程的 test/cases/ 目录下新增一个测试场景用例文件。一次执行只生成一个 CASE 文件,文件名固定格式 TEST-CASE-{4位递增数字编号}.md(自动扫描已有编号取最大值+1,从 0001 开始);内容按专业用例模板(元信息/前置条件/测试数据/步骤表/结果验证/清理)整理,步骤支持 API 调用、Playwright UI 操作、人工操作三种类型,可直接被 /do-test 执行;每次执行后同步更新 test/cases/case-summary.md 摘要索引(CASE 名称/关键执行流程/优先级,含历史 CASE)。当用户要求"新增测试用例"、"添加测试 case"、"写一个测试场景"时触发。支持 /new-test-case -h 查看帮助。

The file

Files
SKILL.md

new-test-case

在 test/cases/ 下新增一个测试场景用例文件。文件命名 TEST-CASE-{4位递增编号}.md,采用专业用例模板(支持 API、Playwright UI、结果验证),与 /do-test 的用例格式完全兼容,生成后可直接被 /do-test 执行。

触发条件:用户要求添加/新增测试用例、测试 case、测试场景。


零、参数处理

如果用户传入 -h 或 --help,不执行任何操作,直接把下面的帮助信息(核心是完整用例模板)原样输出在本次回复正文里后结束(斜杠命令把 SKILL.md 注入我的上下文不等于已展示给用户,正文里只回一句"已输出"就是没输出)。-h 与其它参数或说明文字同时出现时,一律只出帮助、忽略其余参数:本轮不猜附加要求,需要同时执行就把 -h 去掉分两次调用:


用法: /new-test-case [场景描述] [--update-summary] [-h]

一次执行生成一个用例文件:test/cases/TEST-CASE-{4位递增编号}.md
编号自动取现有 TEST-CASE-*.md 最大编号 + 1(无则从 0001 开始)。

选项
  --update-summary  仅根据 test/cases/ 内现有 CASE 文件更新或生成
                    case-summary.md 摘要索引,不生成新用例

──────────────────── 用例模板 ────────────────────

# TEST-CASE-{编号}:{场景名}

## 元信息

| 项 | 内容 |
|---|---|
| 用例编号 | TEST-CASE-{编号} |
| 测试类型 | API / UI (Playwright) / 混合 |
| 优先级 | P0 / P1 / P2 |
| 创建时间 | YYYY-MM-DD |

## 前置条件
- 执行前必须成立的状态(如:后端服务在线、测试账号可用)

## 测试数据
- 数据依赖及准备方式(如:商品 id=1 存在,不存在则先创建)

## 测试步骤

| # | 类型 | 操作 | 输入/参数 | 预期结果 |
|---|------|------|-----------|----------|
| 1 | API | GET /api/mall/products/1 | - | HTTP 200,且 price > 0 |
| 2 | UI | Playwright: goto /login → fill #username → click button[type=submit] | 测试账号 | 跳转至 /home |
| 3 | 人工 | 操作指引 + 判定标准 | - | - |

步骤类型:API=接口请求;UI=Playwright 页面操作;人工=需人工执行

## 结果验证
- 全部步骤完成后的整体断言(数据状态、跨步骤一致性)

## 善后清理
- 执行后的数据还原/清理操作(无则写 -)

──────────────────────────────────────────────────

工作流程
  1. 确定 test/cases/ 目录(不存在则创建)与下一个编号
  2. 收集场景信息(命令行已给描述则据此整理,缺项一次性交互补齐)
  3. 按模板写入 TEST-CASE-NNNN.md 并向用户展示内容摘要
  4. 更新 test/cases/case-summary.md:扫描目录下全部历史 CASE 文件,
     重建摘要索引(CASE 名称 / 关键执行流程 / 优先级)

示例
  /new-test-case 下单流程:登录后可用商品1创建订单并查询订单详情
  /new-test-case                 交互询问场景内容后生成
  /new-test-case --update-summary  仅重建 case-summary.md(扫描全部历史 CASE)
  /new-test-case -h              显示本帮助(出现即忽略其它参数,只出帮助)

一、确定编号

参数分支:传入 --update-summary 时跳过第一~三节,直接执行第四节(仅更新/生成 case-summary.md),完成后输出摘要变更说明即结束。

  1. test/cases/ 不存在则创建。
  2. 列出已有 TEST-CASE-*.md,提取 4 位数字编号取最大值;新编号 = 最大值 + 1,不足 4 位前补零(无文件则 0001)。
  3. 目标文件 test/cases/TEST-CASE-<编号>.md 已存在(异常情况)则顺延至下一个空编号。

二、收集场景信息

需要六项内容:场景名、测试类型与优先级、前置条件、测试数据、测试步骤、结果验证。

  1. 命令行带了场景描述 → 据描述整理;可结合工程代码(后端 Controller、页面调用、test/api/url-list.md 若存在)推断具体 API 路径、页面路由与元素入口,使步骤可执行。
  2. 描述缺失或不足以成文 → 一次性向用户询问缺项。
  3. 步骤编写要求:
    • API 步骤:写明方法 + 完整路径 + 关键参数(path/query/body)。
    • UI 步骤:按 Playwright 语义描述——goto <页面路径>、fill <选择器> "<值>"、click <选择器或文本>、断言写明期望出现的元素/文本/跳转;选择器优先用稳定标识(data-testid、id、可访问角色+名称),避免脆弱的层级选择器。
    • 人工步骤:写明操作指引与判定标准(如验证码、第三方系统操作)。
    • 每步的"预期结果"必须可判定(状态码、字段取值、元素可见性、URL 变化等)。
  4. 结果验证:补充跨步骤的整体断言(如"下单后库存 -1"、"列表页出现新订单"),与单步预期不重复。

三、写入用例文件

按以下固定模板写入(占位符替换为实际内容;无内容的可选项写 -):

# TEST-CASE-<编号>:<场景名>

## 元信息

| 项 | 内容 |
|---|---|
| 用例编号 | TEST-CASE-<编号> |
| 测试类型 | API / UI (Playwright) / 混合 |
| 优先级 | P0 / P1 / P2 |
| 创建时间 | <YYYY-MM-DD> |

## 前置条件
- <条件 1,如:后端服务在线且健康检查通过>
- <条件 2,如:测试账号可用>

## 测试数据
- <数据依赖及准备方式,如:商品 id=1 存在(不存在则先调 POST /api/mall/products 创建)>

## 测试步骤

| # | 类型 | 操作 | 输入/参数 | 预期结果 |
|---|------|------|-----------|----------|
| 1 | API | `GET /api/mall/products/1` | - | HTTP 200,且 price > 0 |
| 2 | UI | Playwright: goto `/login` → fill `#username`/`#password` → click `button[type=submit]` | 测试账号 | 跳转至 `/home`,页面出现欢迎信息 |
| 3 | API | `POST /api/mall/orders` | body: {"productId":1,"quantity":1} | HTTP 200,响应含 orderId |

类型说明:API=接口请求;UI=Playwright 页面操作;人工=需人工执行(给出操作指引)。

## 结果验证
- <整体断言 1,如:GET /api/mall/orders/{orderId} 状态为待支付,金额与步骤 1 的 price 一致>
- <整体断言 2,如:商品 id=1 库存较执行前 -1>

## 善后清理
- <执行后还原操作,如:DELETE /api/mall/orders/{orderId};无则写 ->

写入后向用户输出:文件路径、场景名、测试类型、步骤数(API/UI/人工 分列),并提示可用 /do-test --case=<场景名> 立即执行该用例。


四、更新 case-summary.md(必做)

每次生成新 CASE 后,或传入 --update-summary 时,重建 test/cases/case-summary.md(覆盖式更新,非追加):

  1. 扫描 test/cases/ 下全部用例文件(TEST-CASE-*.md 及其他兼容格式用例;排除 case-summary.md 自身)。
  2. 从每个用例中提取:
    • CASE 名称:标题中的场景名(旧格式用例取 # 场景: 后文本);若元信息含 生成来源:AICASE SKILL,名称后追加后缀 (AICASE);
    • 关键执行流程:将"测试步骤"表压缩为一行流程(各步骤"操作"用 → 串联,超长截断至约 60 字);
    • 优先级:元信息中的优先级;缺失时按测试类型默认(API=P1,UI/混合=P2),并在摘要中标注 (默认)。
  3. 按编号升序写入:
# CASE 摘要

更新时间:<YYYY-MM-DD>
用例总数:N(P0: a / P1: b / P2: c)

| 用例编号 | CASE 名称 | 关键执行流程 | 优先级 |
|----------|-----------|--------------|--------|
| TEST-CASE-0001 | 下单流程 | 查询商品 → 登录 → 创建订单 → 校验订单详情 | P0 |
| TEST-CASE-0002 | 退款流程 | 创建订单 → 申请退款 → 校验退款状态 | P1 (默认) |
  1. 无法解析的文件在表格末尾单列"待整理"一节提醒用户。

五、注意事项

  • 一次执行只生成一个 CASE 文件;用户需要多个用例时逐个执行。
  • 不修改已有用例文件;需要改旧用例时直接编辑对应文件,不经本 skill。
  • case-summary.md 由本 skill 自动重建,不要手工维护(手工修改会在下次生成时被覆盖)。
  • 用例中不得写入真实账号密码等敏感信息,用"测试账号"等占位描述。
  • UI 步骤无法确定选择器时,结合前端代码(src/web)查询真实选择器;确实无法确定的标注 待确认选择器 并提醒用户。
  • 不执行 git commit,由用户决定是否提交。

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.