阿里p10手敲python +pytest +yaml + Allure 实现接口自动化框架

以前弄过好多接口自动化框架的东西，比如httprunner2.0版本实现的接口自动化框架，还有httprunner3.X实现的接口自动化框架，这些都是开源的，实现起来比较简单。

以及使用python+unittest+ddt+yaml等工具实现的接口自动化框架等。

今天主要是使用python +pytest +yaml + Allure 实现接口自动化框架：环境使用python3+pytest等测试工具及yaml数据驱动，采用yaml管理测试用例等集成测试数据功能， 以及使用Allure来生成测试报告，最后通过yagmail发送测试结果邮件,可以根据需要集成到Jenkins；

项目地址：文章末尾免费领取

测试框架结构目录介绍：

目录结构介绍如下：

common/: 封装读取数据库配置，生成报告、发送邮件；
config/: 文件路径配置
data/: 每个接口的测试用例数据
logs/: 记录工具使用生成的日志
report/: 生成接口自动化测试报告
testcase/: 用于编写接口自动化测试用例
utils/: 程序核心模块。包含有yaml解析读写、发送邮箱、发送请求、生成最新测试报告文件
run.py: 执行所有接口测试用例的主程序

前言

框架主要使用 python 语言编写，结合 pytest 进行二次开发，用户仅需要在 yaml 文件中编写测试用例， 编写成功之后，会自动生成 pytest 的代码，零基础代码小白，也可以操作。

本框架支持多业务接口依赖，多进程执行，mysql 数据库断言和 接口响应断言，并且用例直接在yaml文件中维护，无需编写业务代码， 接口pytest框架生成allure报告，并且发送 企业微信通知/ 钉钉通知/ 邮箱通知/ 飞书通知，灵活配置。

实现功能

• 测试数据隔离, 实现数据驱动
• 支持多接口数据依赖: 如A接口需要同时依赖B、C接口的响应数据作为参数
• 数据库断言: 直接在测试用例中写入查询的sql即可断言，无需编写代码
• 动态多断言: 如接口需要同时校验响应数据和sql校验，支持多场景断言
• 自动生成用例代码: 测试人员在yaml文件中填写好测试用例, 程序可以直接生成用例代码，纯小白也能使用
• 代理录制: 支持代理录制，生成yaml格式的测试用例
• 统计接口的运行时长: 拓展功能，订制开关，可以决定是否需要使用
• 日志模块: 打印每个接口的日志信息，同样订制了开关，可以决定是否需要打印日志
• 钉钉、企业微信通知: 支持多种通知场景，执行成功之后，可选择发送钉钉、或者企业微信、邮箱通知
• 自定义拓展字段: 如用例中需要生成的随机数据，可直接调用
• 多线程执行

目录结构

├── Cache                          // 存放缓存文件
├── common                         // 配置
│   ├── conf.yaml                  // 公共配置
│   ├── setting.py                 // 环境路径存放区域
├── data                           // 测试用例数据
├── Enums                          // 枚举层，用于存放项目中所需的枚举
├── File                           // 上传文件接口所需的文件存放区域
├── log                            // 日志层
├── report                         // 测试报告层
├── test_case                      // 测试用例代码
├── utils                          // 工具类
│   └── assertUtils                // 断言
│       └── assertUtils.py        
│   └── cacheUtils                 // 缓存处理模块
│       └── cacheControl.py
│       └── redisControl.py  
│   └── logUtils                   // 日志处理模块
│       └── logControl.py
│       └── logDecoratrol.py       // 日志装饰器
│       └── runTimeDecoratrol.py   // 统计用例执行时长装饰器
│   └── mysqlUtils                 // 数据库模块
│       └── get_sql_data.py       
│       └── mysqlControl.py   
│   └── noticUtils                 // 通知模块
│       └── dingtalkControl.py     // 钉钉通知 
│       └── feishuControl.py       // 飞书通知
│       └── sendmailControl.py     // 邮箱通知
│       └── weChatSendControl.py   // 企业微信通知
│   └── otherUtils                 // 其他工具类
│       └── allureDate             // allure封装
│           └── allure_report_data.py // allure报告数据清洗
│           └── allure_tools.py   // allure 方法封装
│           └── error_case_excel.py   // 收集allure异常用例，生成excel测试报告
│       └── localIpControl.py      // 获取本地IP
│       └── threadControl.py       // 定时器类
│   └── readFilesUtils             // 文件操作
│       └── caseAutomaticControl.py // 自动生成测试代码 
│       └── clean_files.py          // 清理文件
│       └── excelControl.py         // 读写excel
│       └── get_all_files_path.py   // 获取所有文件路径
│       └── get_yaml_data_analysis.py // yaml用例数据清洗
│       └── regularControl.py        // 正则
│       └── yamlControl.py          // yaml文件读写
│   └── recordingUtils             // 代理录制
│       └── mitmproxyContorl.py
│   └── requestsUtils 
│       └── dependentCase.py        // 数据依赖处理
│       └── requestControl.py      // 请求封装
│   └── timeUtils
├── Readme.md                       // help
├── pytest.ini                  
├── run.py                           // 运行入口

依赖库

allure-pytest==2.9.45
allure-python-commons==2.9.45
atomicwrites==1.4.0
attrs==21.2.0
certifi==2021.10.8
cffi==1.15.0
charset-normalizer==2.0.7
colorama==0.4.4
colorlog==6.6.0
cryptography==36.0.0
DingtalkChatbot==1.5.3
execnet==1.9.0
Faker==9.8.3
idna==3.3
iniconfig==1.1.1
jsonpath==0.82
packaging==21.3
pluggy==1.0.0
py==1.11.0
pycparser==2.21
PyMySQL==1.0.2
pyOpenSSL==21.0.0
pyparsing==3.0.6
pytest==6.2.5
pytest-forked==1.3.0
pytest-xdist==2.4.0
python-dateutil==2.8.2
PyYAML==6.0
requests==2.26.0
six==1.16.0
text-unidecode==1.3
toml==0.10.2
urllib3==1.26.7
xlrd==2.0.1
xlutils==2.0.0
xlwt==1.3.0

安装教程

首先，执行本框架之后，需要搭建好 python、jdk、 allure环境

搭建python教程

搭建jdk环境

安装allure：

如上环境如都搭建好，则安装本框架的所有第三方库依赖，执行如下命令

pip3 install -r requirements.txt

如果在安装过程中出现如下 Could not find a version 类似的异常， 不用担心，可能是因为你安装的python环境 版本和我不一致导致的，直接 pip install 库名称，不指定版本安装就可以了。

如上方截图说没有找到 asgiref==3.5.1,报错的意思是，没有找到3.5.1这个版本，那么直接控制台输入 pip3 install asgiref 进行安装即可

接口文档

这里非常感谢一位安卓的朋友，给我推荐了开源的接口文件，框架中会针对开源接口中的登录、个人信息、收藏（新增、查看、修改、删除）等功能，编写结果自动化案例 下方是接口文档地址，大家可以自行查看（因为开源的接口，里面有些逻辑性的功能，如修改被删除的网址接口并没有过多的做判断， 因此用例中只写了一些基础的场景，仅供大家参考。） 

如何创建用例

创建用例步骤

1、在data文件夹下方创建相关的yaml用例

2、写完之后，需要执行 utils\readFilesUtils\caseAutomaticControl.py 这个文件，生成自动化代码

3、执行caseAutomaticControl.py文件之后，会发现，在test_case层新增该条用例的对应代码，可直接执行该用例调试

4、当所有接口都编写好之后，可以直接运行run.py主程序，执行所有自动化接口

下面我们来看一下，如何创建用例

用例中相关字段的介绍

上方截图，就是一个用例中需要维护的相关字段，下面我会对每个字段的作用，做出解释。

Python + Pytest + Yaml + Allure 接口自动化测试框架是一种快速搭建接口自动化测试的方式，该方案具备灵活可扩展、代码简洁、配置文件清晰、测试报告美观等优势。通过 Yaml 格式来描述测试用例和相关数据，使得测试用例更加清晰、易于维护；同时，Pytest 提供了丰富的插件机制，可以方便地扩展和定制自己的测试框架，使得测试脚本编写变得更加轻松和高效；最后，Allure 报告通过图表、图形化界面等方式直观展示测试结果，方便测试人员进行问题定位和分析。

在实际的项目中，采用 Python + Pytest + Yaml + Allure 进行接口自动化测试，不仅能够提高测试效率、减少人力成本、降低测试风险，而且可以让测试人员更加专注于测试的核心任务，如验证接口的正确性、稳定性和安全性等，从而为产品质量保证提供坚实的基础。

下面分享我整理的这份2023年可能是最全的自动化测试工程师发展方向知识架构体系图。

码尚教育软件测试全职业生涯进阶从零到测试开发VIP课程| ProcessOn免费在线作图,在线流程图,在线思维导图

如果对你有帮助的话，点个赞收个藏，给作者一个鼓励，也方便你下次能够快速查找，感谢。

如果你想获取该文章配套的视频视频教程以及练手的接口。请狠狠点击文章末尾推广小卡片

并把所需的资料的文章链接发给我即可领取

如果你想获取简历模板+面试技术宝典+求职视频+上千份测试真题，

请狠狠点击文章末尾推广小卡片

并把所需的资料的文章链接发给我即可领取