# Nexus-Testing

**Repository Path**: YunAbove/Nexus-Testing

## Basic Information

- **Project Name**: Nexus-Testing
- **Description**: 基于Python和pytest的广告账户API自动化测试框架，采用数据驱动设计，集成数据库操作、日志记录及Allure报告，支持参数化测试与CI/CD无缝集成，助力高效接口测试与质量保障。
- **Primary Language**: Unknown
- **License**: AGPL-3.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-08-29
- **Last Updated**: 2026-10-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Nexus-Testing

[English](README.md) | 中文

**Nexus 测试平台的接口自动化与场景执行引擎。**

## 项目定位

Nexus-Testing 从 api_test 演进而来，使用 pytest、场景 YAML、数据工厂、接口客户端和断言组件，把业务测试内容与通用框架能力分开。

框架负责“如何执行”，场景和测试用例负责“验证什么”，业务数据由测试数据层和运行时工厂管理。

## 仓库地址

- GitHub：https://github.com/Abovetheclouds306/Nexus-Testing
- Gitee：https://gitee.com/YunAbove/Nexus-Testing

两个远端保持同一份代码，主分支为 main。

## V1.0 与 V2.0

V1.0 框架基线已经阶段性完结：

- 场景协议、加载器、组装器和注册表结构已建立。
- 请求、鉴权、数据、清理、证据和报告能力已归入通用框架层。
- 业务测试、场景 YAML 和业务数据继续保留在业务层。
- API framework profile 已完成离线回归。
- 关键接口链路已完成验证。

V2.0 继续处理真实环境验收、发布后回归、外部回调依赖、失败证据和更深层的重复执行能力。

## 核心能力

- 场景协议 v0.1：用 YAML 描述 flow、fixtures、actions 和 assertions。
- 数据驱动执行：测试数据和业务状态可以在运行时创建。
- 可插拔注册表：Flow、Fixture、Action、Assertion 可以独立扩展。
- API 执行链：上传、请求、响应断言和业务状态断言。
- 兼容旧入口：旧业务测试和旧 YAML 仍可继续使用。

## 快速开始

    # 创建环境并安装依赖
    python -m venv .venv
    # Windows: .venv\Scripts\activate
    pip install -r requirements.txt

    # 根据模板初始化本地配置
    python init.py

    # 编辑 .env，填写测试环境地址和凭据
    # .env.example 提供变量示例

    # 先运行不依赖外部环境的框架检查
    python -m pytest -c framework-tests.ini

    # 运行单个场景，需要可访问测试环境
    python -m scenario.runner media_review_success

    # 运行业务冒烟，需要测试环境和凭据
    python -m pytest -m smoke -v

框架检查适合在修改公共能力后优先执行。业务用例可能写入测试环境，运行前请确认用例的数据准备和清理策略。

仓库内 `config/users.yaml` 只保留合成角色。真实角色映射请放在被忽略的
`config/users.local.yaml`，或通过 `NEXUS_USERS_FILE` 显式指定；用户名使用
`<ROLE>_USERNAME`，密码使用 `<ROLE>_PASSWORD`，缺少角色专用密码会明确标记为 `BLOCKED`。
真实业务样本可放在被忽略的 `test_data/private/<同名文件>.yaml`，本地数据管理器会优先加载该覆盖文件。

## 目录说明

    Nexus-Testing/
    ├── scenario/                 # 场景协议、加载、组装和运行入口
    ├── scenarios/                # 场景 YAML
    ├── framework/                # 通用客户端、适配器、错误和插件
    ├── utils/                    # 请求、数据库、数据工厂和断言工具
    ├── tests/                    # 框架测试和业务测试
    ├── config/                   # 接口地址和环境配置
    ├── test_data/                # 业务测试数据
    ├── scripts/                  # 受维护的数据、初始化和报告脚本
    └── init.py                   # 本地初始化入口

## 文档与安全

- [仓库协作规则](AGENTS.md)
- [文档与数据策略](DOCS_POLICY.md)
- 业务文档和生成报告保留在本地 docs/，不提交到公开仓库。
- .env、数据库密码、Token 和运行报告禁止提交。
- test_data/ 是业务测试输入，日常清理不得删除或重置。
- 临时脚本、日志、缓存和报告会被 .gitignore 忽略。

## 许可证

AGPL-3.0