API接口自动化框架（Pytest+Request+Allure/Pytest-html+Loguru）

前言

公司突然要求你做自动化，但是没有代码基础不知道怎么做？或者有自动化基础，但是不知道如何系统性的做自动化， 放在yaml文件中维护，不知道如何处理多业务依赖的逻辑？

那么本自动化框架，将为你解决这些问题。

• 框架主要使用 python 语言编写，结合 pytest 进行二次开发，用户仅需要在 yaml 或者 excel 文件中编写测试用例， 编写成功之后，会自动生成测试用例代码，零基础代码小白，也可以操作。
• 如果是具备代码基础的，也可以直接通过 py 文件编写测试用例。
• 使用 Allure 生成报告，并针对测试报告样式进行了调整，使得报告更加美观；
• 测试完成后，支持发送 企业微信通知/ 钉钉通知/ 邮箱通知，灵活配置。

一、框架介绍

本框架主要是基于 Python + Pytest + Allure + Loguru + 邮件通知/企业微信通知/钉钉通知 实现的接口自动化框架。

二、实现功能

• 通过session会话方式，解决了登录之后cookie关联处理`
• 动态多断言: 如接口需要同时校验响应数据和sql校验，支持多场景断言
• 支持单独调试用例，支持用例的重复执行
• 框架天然支持接口动态传参、关联灵活处理
• 支持测试数据分析，测试数据不符合规范有预警机制
• 支持通过用例数据动态配置pytest.mark， 包括自定义标记，pytest.mark.skip以及pytest.mark.usefixtures
• 支持利用allure设置用例优先级，运行指定优先级的用例
• 执行环境一键切换，解决多环境相互影响问题
• 自动生成用例代码: 测试人员在yaml/excel文件中填写好测试用例, 程序可以直接生成用例代码，纯小白也能使用
• 支持参数多类型提取：支持通过jsonpath从response.json提取数据；支持通过正则表达式从response.text提取数据；支持直接提取response本身的数据，例如response.cookies
• 使用Allure生成测试报告，并对测试报告进行了定制化修改，使得测试报告更加美观
• 日志模块: 采用loguru管理日志，可以输出更为优雅，简洁的日志
• 钉钉、企业微信通知: 支持多种通知场景，执行成功之后，可选择发送钉钉、或者企业微信、邮箱通知
• 使用pipenv管理虚拟环境和依赖文件，提供了一系列命令和选项来帮助你实现各种依赖和环境管理相关的操作
• 支持将swagger.json接口文档转为YAML用例
• 支持接口相应后添加等待时间，方便接口调用后，进行一系列数据初始化操作，待操作成功后，执行后续接口

三、依赖库

allure_python_commons==2.9.45
click==8.1.7
Faker==21.0.0
jsonpath==0.82.2
loguru==0.7.2
openpyxl==3.1.2
pydantic==2.7.1
PyMySQL==1.1.0
pytest==8.2.0
PyYAML==6.0.1
PyYAML==6.0.1
Requests==2.31.0
requests_toolbelt==1.0.0
ruamel.base==1.0.0
sshtunnel==0.4.0
xpinyin==0.7.6
yagmail==0.15.293

四、安装教程

1. 通过Git工具clone代码到本地 或者 直接下载压缩包ZIP

https://gitlink.org.cn/floraachy/apiautotest.git

2. 本地电脑搭建好 python环境，我使用的python版本是3.9。包括allure测试报告所需的java环境（安装jdk）。

3. 安装依赖包
   方法一：使用pipenv管理依赖包

注意： 如果不熟悉pipenv， 可以跳过该步骤。

1. 安装pipenv

# 建议在项目根目录下执行命令安装
pip install pipenv

2. 使用pipenv管理安装环境依赖包：pipenv install （必须在项目根目录下执行）

   注意：使用pipenv install会自动安装Pipfile里面的依赖包，该依赖包仅安装在虚拟环境里，不安装在测试机。

方法二&