Smoke-Test-Recorder

本工具旨在为0自动化覆盖的团队快速创建一套基于API流量的冒烟测试用例。它通过启动一个本地代理，捕获您在浏览器中与被测系统交互时产生的fetch/XHR流量，并自动生成基于requests的pytest测试代码。

项目结构

auto-pytest-generator/
│
├── src/
│   └── auto_pytest_generator/
│       ├── __init__.py
│       ├── main.py             # CLI入口和mitmproxy启动逻辑
│       ├── dispatcher_addon.py # 网络流量分发器，过滤静态文件流量，分发流量对应的pytest_generator实例
|       ├── pytest_generator.py # 使用jinja2生成pytest用例的模板逻辑
|       ├── response_refresher.py # 用于更新已有用例的response断言部分
│       └── templates/
│           └── pytest_template.jinja2 # Jinja2模板文件
│
├── tests/
│   └── ...                     # 工具自身的单元测试
│
├── .gitignore
├── pyproject.toml              # 项目打包和依赖管理
└── README.md                   # 使用文档

特点

• 0配置启动：只需指定目标系统的URL前缀即可开始。
• 自动化生成：在浏览器中操作，用例自动生成。
• 基于真实数据断言：使用录制时的响应体做断言，无需依赖接口文档。
• 易于集成：生成的代码是标准的pytest格式，可直接运行。

安装

# 推荐使用uv或pipx进行安装，以避免污染全局环境
uv tool install auto-pytest-generator

# 或者使用pip
pip install auto-pytest-generator

使用

• 安装与更新

  • 安装：

    uv tool install auto-pytest-generator
    

  • 升级：

    uv tool upgrade auto-pytest-generator
    

• 录制（生成用例）

  • 启动代理并录制前端产生的 GET/XHR 流量：

    uv run apg recorder --url-prefix http://1.2.3.4:5678/
    

  • 录制完成后，生成的测试用例通常位于 ./generated_tests/（或根据配置输出到指定目录）。

  • 配置浏览器代理到 apg 代理服务，访问 http://mitm.it 检查代理是否生效。

• 更新 response 断言（refresh）

  • 使用已有用例回放并更新 response 断言：

    uv run apg response-refresh --origin-dir ./tests
    

  • 可选指定输出目录（默认会在项目下生成 refreshed_tests/）：

    uv run apg response-refresh --origin-dir ./tests --target-dir ./refreshed_tests/
    

  • 输出示例目录： ./refreshed_tests/unchanged/ ./refreshed_tests/data_changed/ ./refreshed_tests/error/

• 运行生成的用例

  • 将生成的 *.py 拷贝到测试运行环境（依赖 pytest, requests），使用 pytest 运行。

说明

• 录制阶段建议在稳定的 test 环境进行，尽量保证测试数据可重置以提升用例稳定性。
• refresh 阶段用于在新项目或后端变更时校验并自动更新断言，便于迁移验证。