pytest yaml接口自动化框架搭建

### 使用 Pytest 和 YAML 构建接口自动化测试框架 #### 创建项目结构 为了构建一个高效的接口自动化测试框架，合理的项目结构至关重要。通常情况下，在创建 Python 测试项目的初始阶段会定义一系列的包来组织不同的模块[^4]。 ```plaintext project_root/ ├── testcases/ # 存放具体的测试用例脚本(test_*.py) │ └── __init__.py # 初始化文件使该目录成为Python包 ├── data/ # 存储配置数据或外部输入的数据源 │ ├── environment.yaml # 不同环境下的API基础URL和其他全局变量设置 │ └── api_endpoints.yaml # API端点映射表 ├── reports/ # 自动生成报告存储位置(Allure或其他形式) └── requirements.txt # 记录项目所需的所有第三方库版本信息以便快速部署新环境 ``` #### 准备工作：安装依赖项 确保所有必要的工具都已就绪对于顺利开展后续开发非常重要。可以通过 `pip` 来批量安装所需的软件包，这一步骤简化了团队成员之间共享代码时的一致性问题[^5]。 ```bash $ pip3 install -r requirements.txt ``` #### 编写 Yaml 文件作为测试数据源 YAML 是一种易于阅读的人类友好型数据序列化标准，非常适合用来描述层次化的配置信息。在这里可以利用它来保存不同场景下的请求体以及预期响应等内容[^3]。 **data/api_requests.yaml** ```yaml login_request: url: "/api/v1/login" method: "POST" headers: Content-Type: application/json body: username: admin password: secret_password expected_response: status_code: 200 message: Login successful. ``` #### 实现 Test Runner 脚本 接下来就是编写实际执行这些 HTTP 请求并将结果反馈给用户的部分了。这里采用的是 PyTest 这一强大的单元测试框架来进行集成操作，并且能够很好地支持参数化测试案例的设计模式。 **tests/test_login.py** ```python import pytest from requests import post, get import yaml @pytest.mark.parametrize( "request_data", [ (item["body"], item.get("headers"), item.get("url")) for item in yaml.safe_load(open('data/api_requests.yaml'))['login_request'] ] ) def test_user_can_log_in(request_data): payload, header, endpoint = request_data response = post(endpoint, json=payload, headers=header) assert response.status_code == 200 assert "Login successful." in str(response.json()) ``` 上述代码片段展示了如何加载来自 YAML 的多个登录尝试组合，并针对每一个实例发起 POST 请求；最后验证服务器返回的状态码和消息是否符合预期内容。 #### 执行测试套件并生成报表 完成以上准备工作之后就可以运行整个测试集合了。PyTest 提供了一个简洁明了的方式来做这件事——只需简单调用命令行指令即可触发全部关联测试： ```bash $ pytest tests --html=./reports/report.html --self-contained-html ``` 此命令不仅启动了所有的测试函数而且还会自动生成一份 HTML 版式的总结文档放在指定路径下方便查看最终的结果详情。