接口自动化框架详解(Pytest+request+Allure)

最新推荐文章于 2025-09-17 10:37:18 发布
原创 最新推荐文章于 2025-09-17 10:37:18 发布 · 1.6k 阅读 · 18 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#python #软件测试 #自动化测试 #功能测试 #测试用例 #pytest #测试工具

🍅 点击文末小卡片，免费获取软件测试全套资料，资料在手，涨薪更快

接口自动化是指模拟程序接口层面的自动化，由于接口不易变更，维护成本更小，所以深受各大公司的喜爱。

接口自动化包含2个部分，功能性的接口自动化测试和并发接口自动化测试。

本次文章着重介绍第一种，功能性的接口自动化框架。

一、简单介绍

环境：Mac、Python 3，Pytest，Allure，Request
流程：读取Yaml测试数据-生成测试用例-执行测试用例-生成Allure报告
模块类的设计说明:

Request.py 封装request方法，可以支持多协议扩展（get\post\put）
Config.py 读取配置文件，包括：不同环境的配置，email相关配置
Log.py 封装记录log方法，分为：debug、info、warning、error、critical
Email.py 封装smtplib方法，运行结果发送邮件通知
Assert.py 封装assert方法
run.py 核心代码。定义并执行用例集，生成报告

Yaml测试数据格式如下：

---

Basic:

dec: "基础设置"

parameters:

-

url: /settings/basic.json

data: slug=da1677475c27

header: {

"User-Agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_6) AppleWebKit/537.36 (KHTML, like Gecko)\

Chrome/67.0.3396.99 Safari/537.36",

"Content-Type": "keep-alive"

}

二、代码结构与框架流程

1、代码结构见下图：

2、框架流程见下图：

三、详细功能和使用说明

1、定义配置文件config.ini

该文件中区分测试环境[private_debug]和正式环境[online_release]分别定义相关配置项，[mail]部分为邮件相关配置项

# http接口测试框架配置信息


[private_debug]

# debug测试服务

tester = your name

environment = debug

versionCode = your version

host = www.jianshu.com

loginHost = /Login

loginInfo = email=wang@user.com&password=123456


[online_release]

# release正式服务

tester = your name

environment = release

versionCode = v1.0

host = www.jianshu.com

loginHost = /Login

loginInfo = email=wang@user.com&password=123456


[mail]

#发送邮件信息

smtpserver = smtp.163.com

sender = test1@163.com

receiver = wang@user.com

username = wang@user.com

password = 123456

2、读取yaml测试数据后封装

yaml测试数据例子见第一节，一条接口可定义多条case数据，get_parameter为已封装好的读取yaml数据方法，循环读取后将多条case数据存在list中。

class Basic:

params = get_parameter('Basic')

url = []

data = []

header = []

for i in range(0, len(params)):

url.append(params[i]['url'])

data.append(params[i]['data'])

header.append(params[i]['header'])

3、编写用例

class TestBasic:

@pytest.allure.feature('Home')

@allure.severity('blocker')

@allure.story('Basic')

def test_basic_01(self, action):

"""

用例描述：未登陆状态下查看基础设置

"""

conf = Config()

data = Basic()

test = Assert.Assertions()

request = Request.Request(action)


host = conf.host_debug

req_url = 'http://' + host

urls = data.url

params = data.data

headers = data.header


api_url = req_url + urls[0]

response = request.get_request(api_url, params[0], headers[0])


assert test.assert_code(response['code'], 401)

assert test.assert_body(response['body'], 'error', u'继续操作前请注册或者登录.')

assert test.assert_time(response['time_consuming'], 400)

Consts.RESULT_LIST.append('True')

4、运行整个框架run.py

if __name__ == '__main__':

# 定义测试集

allure_list = '--allure_features=Home,Personal'

args = ['-s', '-q', '--alluredir', xml_report_path, allure_list]

log.info('执行用例集为：%s' % allure_list)

self_args = sys.argv[1:]

pytest.main(args)

cmd = 'allure generate %s -o %s' % (xml_report_path, html_report_path)


try:

shell.invoke(cmd)

except:

log.error('执行用例失败，请检查环境配置')

raise


try:

mail = Email.SendMail()

mail.sendMail()

except:

log.error('发送邮件失败，请检查邮件配置')

raise

5、err.log实例

[ERROR 2018-08-24 09:55:37]Response body != expected_msg, expected_msg is {"error":"继续操作前请注册或者登录9."}, body is {"error":"继续操作前请注册或者登录."}

[ERROR 2018-08-24 10:00:11]Response time > expected_time, expected_time is 400, time is 482.745

[ERROR 2018-08-25 21:49:41]statusCode error, expected_code is 208, statusCode is 200

6、Assert部分代码

def assert_body(self, body, body_msg, expected_msg):

"""

验证response body中任意属性的值

:param body:

:param body_msg:

:param expected_msg:

:return:

"""

try:

msg = body[body_msg]

assert msg == expected_msg

return True


except:

self.log.error("Response body msg != expected_msg, expected_msg is %s, body_msg is %s" % (expected_msg, body_msg))

Consts.RESULT_LIST.append('fail')


raise


def assert_in_text(self, body, expected_msg):

"""

验证response body中是否包含预期字符串

:param body:

:param expected_msg:

:return:

"""

try:

text = json.dumps(body, ensure_ascii=False)

# print(text)

assert expected_msg in text

return True


except:

self.log.error("Response body Does not contain expected_msg, expected_msg is %s" % expected_msg)

Consts.RESULT_LIST.append('fail')


raise

7、Request部分代码

def post_request(self, url, data, header):

"""

Post请求

:param url:

:param data:

:param header:

:return:


"""

if not url.startswith('http://'):

url = '%s%s' % ('http://', url)

print(url)

try:

if data is None:

response = self.get_session.post(url=url, headers=header)

else:

response = self.get_session.post(url=url, params=data, headers=header)


except requests.RequestException as e:

print('%s%s' % ('RequestException url: ', url))

print(e)

return ()


except Exception as e:

print('%s%s' % ('Exception url: ', url))

print(e)

return ()


# time_consuming为响应时间，单位为毫秒

time_consuming = response.elapsed.microseconds/1000

# time_total为响应时间，单位为秒

time_total = response.elapsed.total_seconds()


Common.Consts.STRESS_LIST.append(time_consuming)


response_dicts = dict()

response_dicts['code'] = response.status_code

try:

response_dicts['body'] = response.json()

except Exception as e:

print(e)

response_dicts['body'] = ''


response_dicts['text'] = response.text

response_dicts['time_consuming'] = time_consuming

response_dicts['time_total'] = time_total


return response_dicts

四、Allure报告及Email

1、Allure报告总览，见下图：

2、Email见下图：

五、后续优化

1、集成Jenkins，使用Jenkins插件生成Allure报告
2、多线程并发接口自动化测试
3、接口加密，参数加密

最后感谢每一个认真阅读我文章的人，礼尚往来总是要有的，虽然不是什么很值钱的东西，如果你用得到的话可以直接拿走：

这些资料，对于做【软件测试】的朋友来说应该是最全面最完整的备战仓库，这个仓库也陪伴我走过了最艰难的路程，希望也能帮助到你！凡事要趁早，特别是技术行业，一定要提升技术功底。

接口自动化框架(Pytest+request+Allure)介绍和使用
DeathAlthas的博客
09-20 1440
接口自动化是指模拟程序接口层面的自动化，由于接口不易变更，维护成本更小，所以深受各大公司的喜爱。 接口自动化包含2个部分，功能性的接口自动化测试和并发接口自动化测试。 一、简单介绍 环境：Python 3，Pytest，Allure，Request pytest==3.6.0 pytest-allure-adaptor==1.7.10(弃用) pytest-rerunfailures==5.0 configparser==3.5.0 PyYAML==3.12 requests==2.18.4 simplej
接口自动化框架，参数化处理，db数据承载形式实现参数化
weixin_50851485的博客
10-12 744
1，接口自动化框架 1.1框架结构 接口测试框架的结构如下图所示： 接口测试框架的结构说明: - API 用来封装被测系统的接口 - TestCase 将一个或者多个接口封装成测试用例，并使用UnitTest管理测试用例TestCase 可以调用数据库进行数据校验 - 为了方便维护测试数据，可以把测试脚本和测试数据分离开 - 通过UnitTest断言接口返回的数据，并生成测试报告 1.2 框架目录...
一套接口自动化框架
07-19
一套接口自动化框架，框架搭建：unittest+python+ffmepg，实现功能report+html双报告输出、脚本case，模版case双编写、自定义失败重试，跳过等分级分层定制运行
接口自动化框架设计
weixin_65784341的博客
05-16 1282
帮助你快速设计一个接口自动化框架
Pytest+requests进行接口自动化测试4.0（Pytest框架前后置处理+参数化+Allure+log日志的实现）
最新发布
know__ledge的博客
09-17 813
Pytest框架前后置处理+参数化+Allure+log日志的实现
接口自动化框架(Pytest+request+Allure)
热门推荐
测试官
07-14 1万+
前言： 接口自动化是指模拟程序接口层面的自动化，由于接口不易变更，维护成本更小，所以深受各大公司的喜爱。 接口自动化包含2个部分，功能性的接口自动化测试和并发接口自动化测试。 本次文章着重介绍第一种，功能性的接口自动化框架。 一、简单介绍 环境：Mac、Python 3，Pytest，Allure，Request pytest==3.6.0 pytest-allure-adaptor==1.7.10(弃用) pytest-rerunfailures==5.0 configparser==3.5
Python+pytest+request+allure+yaml接口自动化
weixin_45041600的博客
09-03 3309
项目场景：Python+allure+jenkins，报告无法生成 报错提示：allure-results does not exist 问题： 解决： Path和Report path 路径写错了，然后打开报告一直没有数据
python+requests+pytest+allure+yaml+DDT+logs 接口自动化框架终极版
06-07
框架代码已封装 小白 3行代码即可实现接口自动化 使用教程：https://blog.csdn.net/weixin_41121249/article/details/125162171?spm=1001.2014.3001.5502 框架搭建历程如下 1pytest插件，运行规则以及参数，pytest....
码尚 python+requests+pytest+allure+yaml+DDT+logs 接口自动化框-各分支源码总汇
06-07
接口自动化框架（1-4）（5）（6）（7）（8）（终极版）共6个分支 1pytest插件，运行规则以及参数，pytest.ini配置文 件，跳过用例，用例执行顺序，夹具等 2Fixture固件，contest.py，断言以及Allure报告生成！ 3...
接口自动化框架
03-23
接口自动化源码
api_auto_test:Pytest+Request+Allure+Jenkins 接口自动化测试Demo
05-11
api_auto_test 概要：对postman的一个接口做了接口自动化测试，使用Pytest+Request+Allure+Jenkins 框架 技术栈： python3 、pytest、Requests Allure Jenkins 测试接口介绍 本例使用Postman自带的一个接口来做测试，url如下： https://postman-echo.com/time/before?timestamp=2016-10-10&target=2018-12-13 根据接口的请求参数timestamp、target和返回内容，大概设计了如下测试数据： 项目介绍 1、本项目用Pycharm开发，新建一个项目后，还要添加如下依赖包： PyYAML allure-pytest requests selenium xlrd 2、 项目目录如下图： 3、config 这个包下放的配置文件，如环境、url
python+requests+pytest 接口自动化框架(1-4)
06-02
python+requests+pytest 接口自动化框架 1 pytest插件，运行规则以及参数，pytest.ini配置文 件，跳过用例，用例执行顺序，夹具等 2 Fixture固件，contest.py，断言以及Allure报告生成 3 Pytest测试框架之Allure报告...
Python+Pytest+Allure+Yaml+Pymysql+Jenkins+GitLab接口自动化测试框架详解
Cesare的博客
06-25 2607
Python+Pytest+Allure+Yaml接口自动化测试框架详解
API接口自动化框架（Pytest+Request+Allure/Pytest-html+Loguru）
Flora's Zone
02-09 2471
框架主要使用 python 语言编写，结合 pytest 进行二次开发，用户仅需要在 yaml 或者 excel 文件中编写测试用例， 编写成功之后，会自动生成测试用例代码，零基础代码小白，也可以操作。
pytest+request接口自动化项目详解
06-20
<think>我们正在构建一个使用pytest和requests的接口自动化测试项目。根据用户的问题，我们需要详细解释如何实现这样的项目。参考引用内容，我们可以总结出以下几个关键点：1.使用requests库发送HTTP请求。2.使用pytest作为测试框架来管理测试用例。3.可能使用YAML文件进行数据驱动（引用[3]）。4.使用Allure生成测试报告（引用[2],[3]）。5.测试用例的组织和标记（引用[1]）。因此，我们将按照以下结构进行详解：一、项目结构二、环境准备三、请求的封装四、测试用例编写（使用pytest）五、数据驱动（结合YAML）六、测试报告（Allure）七、运行测试注意：引用内容中有些代码片段，我们可以参考并适当调整。开始详细说明：</think>### 使用 Pytest + Requests 构建接口自动化测试项目详解 #### 一、项目结构设计 ```bash project/ ├── conftest.py # pytest全局配置 ├── requirements.txt # 依赖库 ├── testcases/ # 测试用例目录 │ ├── __init__.py │ ├── test_login.py # 示例测试模块 │ └── test_user.py ├── utils/ # 工具类 │ ├── __init__.py │ ├── request_util.py # 请求封装 │ └── assert_util.py # 断言封装 └── data/ # 测试数据 ├── login_data.yaml └── user_data.yaml ``` #### 二、核心组件实现 1. **请求封装 (`utils/request_util.py`)** ```python import requests class RequestUtil: def __init__(self): self.session = requests.Session() def send_request(self, method, url, **kwargs): method = method.upper() try: response = self.session.request(method, url, **kwargs) response.raise_for_status() # 自动抛出HTTP错误 return response except requests.exceptions.RequestException as e: raise AssertionError(f"请求失败: {str(e)}") ``` 2. **断言工具 (`utils/assert_util.py`)** ```python def assert_response(response, expected_status=200, expected_data=None): # 状态码断言 assert response.status_code == expected_status, \ f"状态码错误: 期望{expected_status}, 实际{response.status_code}" # 响应体断言 if expected_data: actual_data = response.json() for key, value in expected_data.items(): assert key in actual_data, f"缺失字段: {key}" assert actual_data[key] == value, \ f"字段值不匹配: {key} 期望={value}, 实际={actual_data[key]}" ``` #### 三、测试用例编写 (`testcases/test_login.py`) ```python import pytest from utils.request_util import RequestUtil from utils.assert_util import assert_response @pytest.mark.login class TestLogin: @pytest.fixture(scope="class") def req(self): return RequestUtil() @pytest.mark.parametrize("case", [ {"username": "admin", "password": "123456", "expected": 200}, {"username": "invalid", "password": "xxx", "expected": 401} ]) def test_login(self, req, case): """登录接口测试""" url = "https://api.example.com/login" payload = { "username": case["username"], "password": case["password"] } response = req.send_request("POST", url, json=payload) assert_response(response, expected_status=case["expected"]) ``` #### 四、Pytest 配置 (`conftest.py`) ```python import pytest # 全局前置处理 @pytest.fixture(scope="session", autouse=True) def setup_session(): print("\n=== 测试开始 ===") yield print("\n=== 测试结束 ===") # 失败重试机制 def pytest_addoption(parser): parser.addoption("--reruns", action="store", default=1, help="失败重试次数") @pytest.hookimpl(tryfirst=True) def pytest_configure(config): config.addinivalue_line("markers", "login: 登录模块测试") ``` #### 五、运行与报告生成 1. **安装依赖 (`requirements.txt`)** ``` pytest==7.4.0 requests==2.31.0 pytest-rerunfailures==12.0 allure-pytest==2.13.2 ``` 2. **执行测试** ```bash # 运行全部测试 pytest -v # 运行标记为login的测试 pytest -m login # 失败重试3次 pytest --reruns 3 -v ``` 3. **生成Allure报告** ```bash pytest --alluredir=./report/allure_results allure serve ./report/allure_results # 本地查看报告 ``` #### 六、最佳实践 1. **数据驱动** ```python # 从YAML加载测试数据 import yaml @pytest.mark.parametrize("case", yaml.safe_load(open("data/login_data.yaml"))) def test_login_data_driven(req, case): ... ``` 2. **关联参数处理** ```python # 在conftest.py中存储全局token @pytest.fixture def auth_token(req): response = req.send_request("POST", login_url, json=credentials) return response.json()["token"] # 测试用例使用token def test_user_info(req, auth_token): headers = {"Authorization": f"Bearer {auth_token}"} ... ``` 3. **异步请求支持** ```python # 在request_util.py中添加 import aiohttp async def async_request(self, method, url, **kwargs): async with aiohttp.ClientSession() as session: async with session.request(method, url, **kwargs) as response: ... ```
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值