Python3+pytest+allure接口自动化测试框架搭建
myzbx 2025-03-20 16:59 59 浏览
项目结构
安装依赖
pip install pytest requests pytest-html pytest-xdist jsonpath
核心代码实现
配置文件 (config/config.py)
class Config:
# 环境配置
BASE_URL = "https://api.example.com"
TIMEOUT = 10
# 测试账号
USERNAME = "test_user"
PASSWORD = "test_password"
# 日志配置
LOG_LEVEL = "INFO"
API客户端 (api/client.py)
import requests
import json
import logging
from config.config import Config
class APIClient:
def __init__(self):
self.base_url = Config.BASE_URL
self.session = requests.Session()
self.timeout = Config.TIMEOUT
def get(self, url, params=None, headers=None):
return self._request("GET", url, params=params, headers=headers)
def post(self, url, data=None, json=None, headers=None):
return self._request("POST", url, data=data, json=json, headers=headers)
def put(self, url, data=None, json=None, headers=None):
return self._request("PUT", url, data=data, json=json, headers=headers)
def delete(self, url, headers=None):
return self._request("DELETE", url, headers=headers)
def _request(self, method, url, **kwargs):
full_url = self.base_url + url
logging.info(f"Request: {method} {full_url}")
if "headers" not in kwargs or kwargs["headers"] is None:
kwargs["headers"] = {"Content-Type": "application/json"}
if "timeout" not in kwargs:
kwargs["timeout"] = self.timeout
try:
response = self.session.request(method, full_url, **kwargs)
logging.info(f"Response status: {response.status_code}")
return response
except Exception as e:
logging.error(f"Request error: {e}")
raise
测试用例 (tests/test_api.py)
import pytest
import json
from api.client import APIClient
class TestAPI:
@pytest.fixture(scope="class")
def api_client(self):
return APIClient()
def test_get_users(self, api_client):
"""测试获取用户列表接口"""
response = api_client.get("/users")
assert response.status_code == 200
data = response.json()
assert "data" in data
assert isinstance(data["data"], list)
def test_create_user(self, api_client):
"""测试创建用户接口"""
user_data = {
"name": "测试用户",
"email": "test@example.com",
"password": "password123"
}
response = api_client.post("/users", json=user_data)
assert response.status_code == 201
data = response.json()
assert data["name"] == user_data["name"]
assert data["email"] == user_data["email"]
def test_update_user(self, api_client):
"""测试更新用户接口"""
# 假设我们已经知道用户ID为1
user_id = 1
update_data = {"name": "更新名称"}
response = api_client.put(f"/users/{user_id}", json=update_data)
assert response.status_code == 200
data = response.json()
assert data["name"] == update_data["name"]
pytest配置 (conftest.py)
import pytest
import logging
import os
from datetime import datetime
# 设置日志
def setup_logging():
log_dir = "logs"
if not os.path.exists(log_dir):
os.makedirs(log_dir)
log_file = f"{log_dir}/test_{datetime.now().strftime('%Y%m%d_%H%M%S')}.log"
logging.basicConfig(
level=logging.INFO,
format="%(asctime)s - %(levelname)s - %(message)s",
handlers=[
logging.FileHandler(log_file),
logging.StreamHandler()
]
)
def pytest_configure(config):
setup_logging()
@pytest.fixture(scope="session", autouse=True)
def setup_teardown():
# 测试前置操作
logging.info("测试开始")
yield
# 测试后置操作
logging.info("测试结束")
测试运行脚本 (run.py)
import pytest
import argparse
import os
from datetime import datetime
def run_tests():
parser = argparse.ArgumentParser(description="运行API自动化测试")
parser.add_argument("--html", action="store_true", help="生成HTML报告")
parser.add_argument("--parallel", action="store_true", help="并行运行测试")
args = parser.parse_args()
# 创建报告目录
report_dir = "reports"
if not os.path.exists(report_dir):
os.makedirs(report_dir)
# 构建pytest参数
pytest_args = ["-v", "tests/"]
if args.html:
report_file = f"{report_dir}/report_{datetime.now().strftime('%Y%m%d_%H%M%S')}.html"
pytest_args.extend(["--html", report_file, "--self-contained-html"])
if args.parallel:
pytest_args.extend(["-n", "auto"])
# 运行测试
pytest.main(pytest_args)
if __name__ == "__main__":
run_tests()
执行测试
# 普通执行
python run.py
# 生成HTML报告
python run.py --html
# 并行执行测试
python run.py --parallel
# 同时生成报告和并行执行
python run.py --html --parallel
添加Allure报告
更新依赖
pip install pytest requests pytest-html pytest-xdist jsonpath allure-pytest
安装Allure命令行工具Windows
scoop install allure
更新测试用例 (tests/test_api.py)
import pytest
import json
import allure
from api.client import APIClient
@allure.epic("API测试")
@allure.feature("用户管理接口")
class TestAPI:
@pytest.fixture(scope="class")
def api_client(self):
return APIClient()
@allure.story("获取用户列表")
@allure.title("测试获取所有用户")
@allure.severity(allure.severity_level.NORMAL)
def test_get_users(self, api_client):
"""测试获取用户列表接口"""
with allure.step("发送GET请求到/users"):
response = api_client.get("/users")
with allure.step("验证响应状态码"):
assert response.status_code == 200
with allure.step("验证响应数据结构"):
data = response.json()
assert "data" in data
assert isinstance(data["data"], list)
allure.attach(json.dumps(data, indent=2),
"响应数据",
allure.attachment_type.JSON)
@allure.story("创建新用户")
@allure.title("测试创建用户功能")
@allure.severity(allure.severity_level.CRITICAL)
def test_create_user(self, api_client):
"""测试创建用户接口"""
user_data = {
"name": "测试用户",
"email": "test@example.com",
"password": "password123"
}
allure.attach(json.dumps(user_data, indent=2),
"请求数据",
allure.attachment_type.JSON)
with allure.step("发送POST请求到/users"):
response = api_client.post("/users", json=user_data)
with allure.step("验证响应状态码"):
assert response.status_code == 201
with allure.step("验证创建的用户数据"):
data = response.json()
assert data["name"] == user_data["name"]
assert data["email"] == user_data["email"]
allure.attach(json.dumps(data, indent=2),
"响应数据",
allure.attachment_type.JSON)
@allure.story("更新用户")
@allure.title("测试更新用户信息")
@allure.severity(allure.severity_level.HIGH)
def test_update_user(self, api_client):
"""测试更新用户接口"""
# 假设我们已经知道用户ID为1
user_id = 1
update_data = {"name": "更新名称"}
allure.attach(json.dumps(update_data, indent=2),
"请求数据",
allure.attachment_type.JSON)
with allure.step(f"发送PUT请求到/users/{user_id}"):
response = api_client.put(f"/users/{user_id}", json=update_data)
with allure.step("验证响应状态码"):
assert response.status_code == 200
with allure.step("验证更新后的用户数据"):
data = response.json()
assert data["name"] == update_data["name"]
allure.attach(json.dumps(data, indent=2),
"响应数据",
allure.attachment_type.JSON)
更新API客户端 (api/client.py)
import requests
import json
import logging
import allure
from config.config import Config
class APIClient:
def __init__(self):
self.base_url = Config.BASE_URL
self.session = requests.Session()
self.timeout = Config.TIMEOUT
def get(self, url, params=None, headers=None):
return self._request("GET", url, params=params, headers=headers)
def post(self, url, data=None, json=None, headers=None):
return self._request("POST", url, data=data, json=json, headers=headers)
def put(self, url, data=None, json=None, headers=None):
return self._request("PUT", url, data=data, json=json, headers=headers)
def delete(self, url, headers=None):
return self._request("DELETE", url, headers=headers)
def _request(self, method, url, **kwargs):
full_url = self.base_url + url
logging.info(f"Request: {method} {full_url}")
# 记录请求信息到Allure
if "json" in kwargs and kwargs["json"] is not None:
allure.attach(json.dumps(kwargs["json"], indent=2, ensure_ascii=False),
f"{method} {url} - Request Body",
allure.attachment_type.JSON)
elif "data" in kwargs and kwargs["data"] is not None:
allure.attach(str(kwargs["data"]),
f"{method} {url} - Request Body",
allure.attachment_type.TEXT)
if "headers" not in kwargs or kwargs["headers"] is None:
kwargs["headers"] = {"Content-Type": "application/json"}
if "timeout" not in kwargs:
kwargs["timeout"] = self.timeout
try:
response = self.session.request(method, full_url, **kwargs)
logging.info(f"Response status: {response.status_code}")
# 记录响应信息到Allure
try:
response_body = response.json()
allure.attach(json.dumps(response_body, indent=2, ensure_ascii=False),
f"{method} {url} - Response Body",
allure.attachment_type.JSON)
except:
allure.attach(response.text,
f"{method} {url} - Response Body",
allure.attachment_type.TEXT)
return response
except Exception as e:
logging.error(f"Request error: {e}")
allure.attach(str(e),
f"{method} {url} - Exception",
allure.attachment_type.TEXT)
raise
更新conftest.py
import pytest
import logging
import os
import allure
from datetime import datetime
# 设置日志
def setup_logging():
log_dir = "logs"
if not os.path.exists(log_dir):
os.makedirs(log_dir)
log_file = f"{log_dir}/test_{datetime.now().strftime('%Y%m%d_%H%M%S')}.log"
logging.basicConfig(
level=logging.INFO,
format="%(asctime)s - %(levelname)s - %(message)s",
handlers=[
logging.FileHandler(log_file),
logging.StreamHandler()
]
)
return log_file
def pytest_configure(config):
log_file = setup_logging()
# 添加环境信息到Allure报告
allure.environment(
python_version=platform.python_version(),
pytest_version=pytest.__version__,
platform=platform.system(),
host=Config.BASE_URL
)
@pytest.fixture(scope="session", autouse=True)
def setup_teardown():
# 测试前置操作
logging.info("测试开始")
yield
# 测试后置操作
logging.info("测试结束")
# 添加钩子函数记录测试结果
@pytest.hookimpl(tryfirst=True, hookwrapper=True)
def pytest_runtest_makereport(item, call):
outcome = yield
report = outcome.get_result()
if report.when == "call":
if report.failed:
# 失败时捕获页面截图或其他信息
allure.attach(
f"测试用例: {item.function.__name__} 失败",
"失败信息",
allure.attachment_type.TEXT
)
更新运行脚本 (run.py)
import pytest
import argparse
import os
import shutil
import subprocess
from datetime import datetime
def run_tests():
parser = argparse.ArgumentParser(description="运行API自动化测试")
parser.add_argument("--html", action="store_true", help="生成HTML报告")
parser.add_argument("--allure", action="store_true", help="生成Allure报告")
parser.add_argument("--parallel", action="store_true", help="并行运行测试")
parser.add_argument("--clean", action="store_true", help="清理报告目录")
args = parser.parse_args()
# 创建报告目录
report_dir = "reports"
allure_result_dir = "allure-results"
allure_report_dir = f"{report_dir}/allure-report"
if args.clean:
if os.path.exists(report_dir):
shutil.rmtree(report_dir)
if os.path.exists(allure_result_dir):
shutil.rmtree(allure_result_dir)
if not os.path.exists(report_dir):
os.makedirs(report_dir)
# 构建pytest参数
pytest_args = ["-v", "tests/"]
if args.html:
report_file = f"{report_dir}/report_{datetime.now().strftime('%Y%m%d_%H%M%S')}.html"
pytest_args.extend(["--html", report_file, "--self-contained-html"])
if args.allure:
pytest_args.extend(["--alluredir", allure_result_dir])
if args.parallel:
pytest_args.extend(["-n", "auto"])
# 运行测试
pytest.main(pytest_args)
# 生成Allure报告
if args.allure:
# 创建Allure报告目录
if not os.path.exists(allure_report_dir):
os.makedirs(allure_report_dir)
print("正在生成Allure报告...")
try:
subprocess.run(["allure", "generate", allure_result_dir, "-o", allure_report_dir, "--clean"], check=True)
print(f"Allure报告已生成: {os.path.abspath(allure_report_dir)}")
# 打开Allure报告
print("正在打开Allure报告...")
subprocess.run(["allure", "open", allure_report_dir], check=True)
except subprocess.CalledProcessError as e:
print(f"生成Allure报告失败: {e}")
except FileNotFoundError:
print("未找到allure命令,请确保Allure已正确安装")
if __name__ == "__main__":
run_tests()
添加缺少的导入到conftest.py中
import platform
from config.config import Config
执行测试并生成Allure报告
# 清理历史报告并生成Allure报告
python run.py --allure --clean
# 同时生成HTML和Allure报告
python run.py --html --allure
# 并行执行测试并生成Allure报告
python run.py --allure --parallel
相关推荐
- 资深架构师亲授,从堆栈到GC,一篇文章打通任督二脉!
-
“又双叒OOM了?”“服务半夜崩了,日志全是`java.lang.OutOfMemoryError`...”“GC停顿太长,用户投诉卡顿!”如果你也常被这些问题折磨,根本症结往往在于:你对Java...
- Java JAR 启动内存参数配置指南:从基础设置到性能优化
-
在启动Java可执行JAR文件时,合理配置JVM内存参数是保障应用稳定性和性能的关键。本文将系统讲解如何通过命令行参数、环境变量等方式指定内存配置,并结合实际场景提供优化建议。一、核心内存...
- 浏览器存储"四大家族":谁才是你的数据管家?
-
当你关闭浏览器再重新打开,登录状态为何还在?购物车商品为何不会消失?这些"记忆"背后,藏着浏览器存储的"四大家族"——Cookie、localStorage、sessi...
- SOP与SIP深度解析(sop与soic)
-
SOP(标准作业程序)与SIP(标准检验程序)是确保产品质量和生产效率的两大支柱,分别聚焦于生产执行和质量验证。一、核心区别:目标与作用域维度SOP(标准作业程序)SIP(标准检验程序)定位指导“如何...
- Java 技术岗面试全景备战!从基础到架构的系统性通关攻略分享
-
Java技术岗的面试往往是一项多维度的能力检验。本文将会从核心知识点、项目经验到面试策略,为你梳理一份系统性的备战攻略!需要的同学可以私信小编【学习】一、技术基础:面试的“硬性指标”1.最重要的还是...
- C++11 新特性(c++11新特性 pdf)
-
一、核心语言革新移动语义与右值引用通过&&标识临时对象(右值),实现资源转移而非复制。例如移动构造函数将原对象资源指针转移后置空,避免深拷贝,极大优化容器操作性能。12类型推导auto:自动推导变量类...
- 2026年前每个开发者都应该学习的技能
-
优秀开发者和伟大开发者之间的差距正在快速扩大。随着AI工具的爆炸式增长、自动化工作流程和日益复杂的技术栈,开发者不能再仅仅"知道如何编码"了。在2026年及以后,您的优势不仅仅是编写代...
- 看一看,Python这四种作用域你都知道吗?
-
点赞、收藏、加关注,下次找我不迷路一、啥是作用域?先打个比方比如说,你在自己的卧室(相当于一个小空间)里放了一本书,这本书在卧室里随便你怎么看,这就是这本书在卧室这个"作用域"内...
- 抛弃立即执行函数 (IIFE),拥抱现代 JavaScript 块级作用域
-
IIFE(ImmediatelyInvokedFunctionExpression)曾是JavaScript开发中的重要工具,但随着ES6+的块级作用域特性,我们现在有了更优雅的替代...
- 2025 年是时候重新认识 Symbol 的八大特性了?
-
大家好,很高兴又见面了,我是"高级前端进阶",由我带着大家一起关注前端前沿、深入前端底层技术,大家一起进步,也欢迎大家关注、点赞、收藏、转发!1.什么是Symbol原始类型在J...
- 函数、表达式与控制流:Rust 的核心语法构建块
-
在上一篇中我们了解了变量与类型,本篇将深入函数、表达式与控制流的使用,让你的代码更具逻辑性。一、函数定义与调用函数是组织和复用代码的基本单元。在Rust中,使用fn关键字定义函数:///计算...
- 所有权、借用与生命周期:理解 Rust 的核心机制
-
上一篇我们学习了函数、表达式和控制流,这一篇将正式进入Rust最核心、最独特的语言机制:所有权系统。一、为什么需要所有权机制?在C/C++中,内存管理依赖开发者手动操作,容易出现野指针、重复...
- Rust 语言的借用规则:构筑安全内存管理体系的核心保障机制
-
前言在系统级编程范畴内,内存安全始终是一项极具挑战性的关键议题。Rust语言凭借其独树一帜的「借用规则」(BorrowingRules),于编译阶段便有效规避了诸如空指针、野指针以及数据竞争等一系...
- 函数编写指南:参数、返回值与作用域实战详解
-
你是否在编写函数时遇到过参数传递混乱、返回值逻辑不清晰,或者变量作用域导致的奇怪bug?别担心,这篇文章将用最通俗的语言和实战案例,带你彻底搞懂函数的核心三要素:参数、返回值与作用域。一、参数:灵活...
- 服务器频繁报错?5 步教你快速排查修复!运维必看!
-
服务器突然报错、网站打不开、数据库连不上……这些问题是不是让你头大?别慌!今天教你一套「望闻问切」的排查法,90%的服务器故障都能轻松解决!一、定位错误类型:先看日志再动手1.日志是关键系统日志...
- 一周热门
- 最近发表
- 标签列表
-
- HTML 简介 (30)
- HTML 响应式设计 (31)
- HTML URL 编码 (32)
- HTML Web 服务器 (31)
- HTML 表单属性 (32)
- HTML 音频 (31)
- HTML5 支持 (33)
- HTML API (36)
- HTML 总结 (32)
- HTML 全局属性 (32)
- HTML 事件 (31)
- HTML 画布 (32)
- HTTP 方法 (30)
- 键盘快捷键 (30)
- CSS 语法 (35)
- CSS 轮廓宽度 (31)
- CSS 谷歌字体 (33)
- CSS 链接 (31)
- CSS 定位 (31)
- CSS 图片库 (32)
- CSS 图像精灵 (31)
- SVG 文本 (32)
- 时钟启动 (33)
- HTML 游戏 (34)
- JS Loop For (32)