搭建一个基于 Python 的接口自动化测试框架，集成 Pytest、Allure 和 Jenkins，并使用 Excel 管理测试用例，通常包括以下几个关键步骤： ### 1. 环境准备与依赖安装 首先确保系统中已安装 Python 和 pip，然后安装必要的测试框架和插件： ```bash pip install pytest allure-pytest allure pip install requests pip install openpyxl # 用于读取 Excel 文件 pip install pymysql # 如果需要操作数据库 ``` 此外，Jenkins 环境需要安装并配置好 Java 环境，并安装 Allure 插件以便生成和展示测试报告。 ### 2. 测试用例管理：使用 Excel 维护用例 将测试用例存储在 Excel 文件中，通常包括以下字段： - 用例编号 - 接口名称 - 请求方法（GET、POST 等） - 请求 URL - 请求头 - 请求参数 - 预期结果 - 数据依赖（如数据库查询） 使用 `openpyxl` 读取 Excel 文件并解析用例数据： ```python from openpyxl import load_workbook def read_excel_cases(file_path): wb = load_workbook(file_path) ws = wb.active cases = [] headers = [cell.value for cell in ws[1]] for row in ws.iter_rows(min_row=2): case = {headers[i]: cell.value for i, cell in enumerate(row)} cases.append(case) return cases ``` ### 3. 封装请求基类与配置管理 创建一个请求基类 `api_request.py`，封装通用的请求逻辑，并从配置文件中读取环境地址： ```python import requests import yaml with open('config/environment.yaml', 'r') as f: env_config = yaml.safe_load(f) def api_request(baseurl_key, endpoint, method='GET', params=None, headers=None): base_url = env_config[baseurl_key] url = f"{base_url}{endpoint}" response = requests.request(method, url, params=params, headers=headers) return response ``` 配置文件示例 `environment.yaml`： ```yaml prod: "https://api.prod.com" test: "https://api.test.com" ``` ### 4. 编写测试用例：使用 Pytest 和 Allure 注解 使用 Pytest 编写测试类，并通过 Allure 提供的装饰器丰富测试报告内容： ```python import pytest import allure from api_request import api_request from read_excel_cases import read_excel_cases test_cases = read_excel_cases('test_cases.xlsx') @allure.feature('接口测试模块') class TestAPI: @allure.title('测试标题：{case}') @pytest.mark.parametrize('case', test_cases) def test_api(self, case): with allure.step(f"执行测试用例：{case['用例编号']}"): response = api_request( baseurl_key=case['环境'], endpoint=case['请求URL'], method=case['请求方法'], params=case['请求参数'] ) assert response.status_code == 200 assert response.json()['code'] == case['预期结果'] ``` ### 5. 生成 Allure 报告 在命令行中运行测试，并生成 Allure 报告： ```bash pytest test_api.py --alluredir=./reports ``` 使用以下命令生成 HTML 报告： ```bash allure serve ./reports ``` ### 6. Jenkins 集成与持续集成 在 Jenkins 中配置自动化构建任务，执行以下步骤： 1. **源码管理**：连接 Git 仓库，获取测试代码。 2. **构建触发器**：设置定时任务或 Git Hook 触发构建。 3. **构建环境**：安装 Python、Allure CLI。 4. **构建步骤**： - 执行测试：`pytest test_api.py --alluredir=./reports` - 生成报告：`allure generate ./reports -o ./allure-report` 5. **发布 Allure 报告**：使用 Allure Jenkins 插件发布测试报告。 ### 7. 可选扩展功能 - **数据库验证**：在测试中加入数据库断言，使用 `pymysql` 或 `SQLAlchemy` 查询数据库验证接口返回数据。 - **契约测试**：引入 Pact 或类似工具，进行接口契约测试，确保服务提供方与消费方的兼容性。 - **日志与异常处理**：增强日志记录和异常捕获机制，便于调试和问题追踪。