Python+Pytest+Allure+Yaml+Jenkins+GitLab接口自动化测试框架详解

Python+Pytest+Allure+Yaml接口自动化测试框架详解

编撰人：CesareCheung
更新时间：2024.06.20

一、技术栈

Python+Pytest+Allure+Yaml+Jenkins+GitLab
版本要求：Python3.7.0,Pytest7.4.4,Allure2.18.1,PyYaml6.0

二、环境配置

  1. 安装python3.7，并配置Pycharm运行环境为python3.7
  2. 安装allure并配置好环境变量
  3. 安装依赖包 pip install -r requirements.txt

三、自动化思路

通过请求方法封装及环境配置，用pytest框架运行读取testcase文件测试用例集，将参数传入对应test_*用例执行器汇总并执行输出allure测试报告
1）单个用例
2）多个用例
3）多用例上下游接口串联传参
4）用例执行（场景跑批）
5）测试报告
6）通知（邮件、企业微信）

四、项目结构：

在这里插入图片描述

框架目录详解

–common:公共方法包

--get_path.py:获取文件路径方法	
--logger_util.py:输出日志方法
--parameters_until.py：传参方式方法封装	
--requests_util.py：请求方式方法封装
--yaml_util.py：yaml文件读取写入方法

–config: 配置包

--config.yml：配置文件，主要为域名ip地址配置及日志输出级别--extract.yml：接口上下游串联时，用例文件做参数化截取返回值后自动输出保存到该文件

–data: 用于存放csv传参文件包（可用可不用，具体根据实际情况）

--get_token.csv：存放csv文件参数

–logs: 日志输出文件，会自动生成

–reports: 测试报告文件

–testcase: 测试用例文件集

	--fenmi：项目测试用例--login.yml：接口参数传参  # 如：-   name: 1、获取UUID#    base_url: https://XXXXX.combase_url: ${get_base_url(base_fenmi_url)}request:method: geturl: /fenmi/codeheaders:Authorization: '{{access_token}}'params:Accept: application/json, text/plain, */*Accept-Encoding: gzip, deflate, br, zstdAccept-Language: zh-CN,zh;q=0.9Connection: keep-aliveextract:uuid: '"uuid":"(.*?)"'validate:-   equals: {code: 200}-   equals: {msg: "操作成功"}                # 解释：name：为接口名称         base_url：读取config.yml文件的域名IP            request:请求参数           method：请求方式           url:接口地址          headers：请求头，比如token,'{{access_token}}'为取上游接口返回值做变量进行参数化，做参数化为固定写法'{{变量名}}'       params: 请求参数，具体需要看接口请求传参方式         extract：用于存在上下游接口关联时对返回值进行取值，固定写法，'"uuid":"(.*?)"'为正则表达式取值，也可用json提取，固定写法'"变量名"：正则表达式'          validate：断言           --test_fenmi.py: 单用例执行器，执行式传入对应yaml文件地址即可import allureimport pytestfrom common.requests_util import Requestutilfrom common.parameters_until import read_file@allure.epic('XX互联')@allure.feature('登录并查询服务收入细项列表数据')class Testrequests:# 获取access_token(get请求)@allure.story('获取uuid并登录获取token')@allure.severity("normal")@pytest.mark.parametrize("caseinfo",read_file('/testcases/fenmi/login.yml'))def test_get_token(self,caseinfo):allure.dynamic.title(caseinfo['name'])allure.dynamic.description(caseinfo['name'])Requestutil().analysis_yaml(caseinfo)

–all.py: 主运行程序

–conftest.py: 测试配置工具，clean_extract方法为重跑时清除原文件数据

–debugtalk.py:自定义函数，用于存放公共函数和变量的文件

–environment.properties:用于生成allure测试报告时，配置展示环境数据

–pytest.ini: pytest测试运行配置文件，用于配置pytest运行时指定一些参数

[pytest]
addopts = -vs --alluredir=reports/temp --clean-alluredir            运行时清除原先的测试报告及临时文件
; testpaths = testcases/fenmi                                       执行单个项目测试文件时可选一个testcase目录
testpaths = testcases/fenmi testcases/weixin testcases/Zgen         执行多个项目测试文件时可选多个testcase目录   
python_files = test_*.py                                            执行的文件，及测试用例
python_classes = Test*                                              执行对应测试用例目录所有Test开头的类
python_functions = test_*                                           执行对应类下所有的test开头的方法

五、用例集

1）Yaml用例文件说明：

在这里插入图片描述

2）用例执行文件说明：

在这里插入图片描述

3）CSV文件用例读取：

data参数：

在这里插入图片描述

Yaml文件参数化：

在这里插入图片描述

4）testcase文件：为用例集可在用例集新增对应测试项目可按对应项目命名

5）yaml文件：为对应接口请求参数，可在yaml文件添加一条或者多条用例请求参数

6）test_*.py文件：通过pytest框架封装读取yaml文件参数并可运行的用例运行器

六、接口自动化框架规则

1.必须有的四个一级关键字：name，base_url，requests，validate
2.request关键字必须包含两个二级关键字：method，url
3.传参方式：在request一级关键字下，通过二级关键字参数传参。
如果是get请求，通过params传参。如：

  params:grant_type: client_credentialappid: XXXXXsecret: XXXX
如果是post请求：传json格式，通过json关键字传参。如：json: {"tag": {"id": 100, "name": "XXXaaa" }}传表单格式，通过data关键字传参。如：data:{"tag": {"id": 100, "name": "XXXCaaa" }}传文件格式，通过files关键字传参。如：files:media: "E:/Tanzl.jpg"

4.如果需要做接口关联，那么必须使用一级关键字：extract
提取：

如：json提取方式
extract:access_token: access_token
如：正则表达式提取方式
extract:access_token: '"access_token":"(.*?)"'取值：如：access_token={{access_token}}

5.热加载，当yaml文件需要使用动态参数时，那么可以在debugtalk.py中写方法调用。

  注意：传参时，需要什么类型的数据，需要做强转。int(mix),int(max)，如：# 获取随机数def get_random_number(self,mix,max):return random.randint(int(mix),int(max))热加载取值：${get_random_number(100000,999999)}

6.此框架支持两种断言方式：分别是equals和contains断言：
如：

validate:
-   equals: {status_code: 200}
-   equals: {expires_in: 7200}
-   contains: access_token

7.数据驱动使用csv和一级关键字parameters实现：如：

yaml写法：parameters:name-appid-secret-grant_type-assert_str: data/get_token.csv
csv写法：name,appid,secret,grant_type,assert_str获取access_token统一鉴权码,wx9b755d429f6fb216,b963db0b97c8487b0cb920a240bd78e3,client_credential,access_tokenappid必填项检查,"",b963db0b97c8487b0cb920a240bd78e3,client_credential,errcodesecret必填项检查,wx9b755d429f6fb216,"",client_credential,errcode

8.config.yml日志监控，异常处理，以及基础路径的设置。

七、测试报告

在这里插入图片描述

1）测试报告概述

  1. 可进行筛选成功或失败的用例
  2. 可查看该用例的详情
  3. 测试套可查看对应测试模块用例集合
  4. 功能模块可查看对应场景化用例集合
    在这里插入图片描述

在这里插入图片描述

2）测试报告详情

可查看具体用例请求参数及返回报文

在这里插入图片描述

八、Jenkins拉取GitLab集成及运行

1）GitLab仓库代码

在这里插入图片描述

2）框架主运行程序改动点（如果没有Jenkins没报Allure不是内部命令可不改）

在这里插入图片描述

3）配置Jenkins环境变量及对应执行脚本

在这里插入图片描述

4）配置Allure测试报告

在这里插入图片描述

5）Jenkins拉取GitLab仓库代码及对应工作空间

在这里插入图片描述

6）运行构建项目

在这里插入图片描述
在这里插入图片描述

7）集成推送企业微信信息

在这里插入图片描述

8）Jenkins集成Allure测试报告展示

在这里插入图片描述

9）生成Allure报告后报告显示字段内容及含义

在这里插入图片描述

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/news/863010.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

Python operator模块这么用，效率杠杠的！

Python operator模块这么用，效率杠杠的！

目录 1、基础操作符应用 🐍 1.1 加载operator模块 1.2 使用itemgetter进行排序 1.3 attrgetter与方法调用 2、高级功能探索 🔍 2.1 methodcaller的妙用 2.2 操作符重载与定制 3、结合lambda表达式 ✨ 3.1 lambda与operator模块协同工作 3.2 实战案例分析 4、结合…
阅读更多...
如何保护磁盘数据？电脑磁盘数据怎么保护？

如何保护磁盘数据？电脑磁盘数据怎么保护？

电脑磁盘是存储数据的基础，可以将各种重要数据保存在其中。为了避免数据泄露，我们需要保护磁盘数据。那么，电脑磁盘数据怎么保护呢？下面我们就一起来了解一下吧。 文件夹加密超级大师 文件夹加密超级大师是一款优秀的电脑数据加密…
阅读更多...
人工智能 (AI) 基本概念 入门篇【C#】版

人工智能 (AI) 基本概念 入门篇【C#】版

1. 什么是人工智能？ 人工智能（Artificial Intelligence, AI）是指计算机系统能够执行通常需要人类智能的任务，如视觉识别、语音识别、决策和语言翻译等。AI的核心是通过算法和数据进行学习和推理，以实现智能行为。 2.…
阅读更多...
说说MQ在你项目中的应用(二)商品支付

说说MQ在你项目中的应用(二)商品支付

看了不少关于MQ的文章，也对MQ的作用做了一些总结。通常来说MQ有三大功能：异步处理、系统解耦和流量削峰。但我觉得这些功能本质上都是围绕着异步这个核心来的，只是针对不同的业务场景做了些调整。 现在市面上常用的MQ中间件，如Ra…
阅读更多...
【期末速成】计算机操作系统 EP04 | 学习笔记

【期末速成】计算机操作系统 EP04 | 学习笔记

文章目录 一、前言🚀🚀🚀二、正文：☀️☀️☀️2.1 考点七：进程通信2.2 考点八：线程的概念2.3 考点九：处理机调度的概念及原则2.4 考点十：调度方式与调度算法 一、前言🚀…
阅读更多...
react+customize-cra使用less+less-loader时，可能遇到的问题及解决办法

react+customize-cra使用less+less-loader时，可能遇到的问题及解决办法

目录 1、先附上各依赖版本和config-overrides.js配置代码，按这个版本和配置就没问题 2、问题（注意：问题顺序没有先后之分哦） 2.1、TypeError: Cannot read property tap of undefined 2.2、No module factory available for d…
阅读更多...
阐述Python：except的用法和作用？

阐述Python：except的用法和作用？

💝💝💝欢迎莅临我的博客，很高兴能够在这里和您见面！希望您在这里可以感受到一份轻松愉快的氛围，不仅可以获得有趣的内容和知识，也可以畅所欲言、分享您的想法和见解。 推荐:「stormsha的主页」…
阅读更多...
网络配置(IP、NETMASK、GATEWAY、DNS、DHCP) ＜持续更新中＞

网络配置(IP、NETMASK、GATEWAY、DNS、DHCP) ＜持续更新中＞

参考： 初学Linux之网络配置(IP、NETMASK、GATEWAY、DNS、DHCP)-CSDN博客【学习笔记】网关 & 路由_网关和路由-CSDN博客【学习笔记】计算机网络 IP地址与MAC地址_根据mac分配ip-CSDN博客【学习笔记】TCP 和 UDP 协议_tcp 发送 syn 应答没有syn ack-CSDN博客 一…
阅读更多...
一次进程虚拟内存占用超过200G问题分析

一次进程虚拟内存占用超过200G问题分析

在对智驾软件系统资源进行分析时，发现一个进程虚存占用过高，超过200G top查看内存占用 有一个node应用占用了200G的虚拟内存 pmap查看该进程内存情况 pmap -x -p 8496结果显示有两个异常点，刚好和虚存使用总量吻合 一个50G和一个170G的堆…
阅读更多...
udp Socket组播 服务器

udp Socket组播 服务器

什么是组播 组播也可以称之为多播这也是 UDP 的特性之一。组播是主机间一对多的通讯模式，是一种允许一个或多个组播源发送同一报文到多个接收者的技术。组播源将一份报文发送到特定的组播地址，组播地址不同于单播地址，它并不属于特定某个主机…
阅读更多...
智慧校园-医务管理系统总体概述

智慧校园-医务管理系统总体概述

智慧校园医务管理系统，作为校园健康管理体系的智能化升级，深度融合信息技术与医疗服务，为师生构筑起一道全方位的健康守护网。医务管理系统以提升校园医疗服务水平、优化健康管理流程为核心目标，通过一系列创新功能，确…
阅读更多...
MYSQL函数进阶详解：案例解析（第19天）

MYSQL函数进阶详解：案例解析（第19天）

系列文章目录 一、MySQL的函数（重点） 二、MySQL的窗口函数（重点） 三、MySQL的视图（熟悉） 四、MySQL的事务（熟悉） 文章目录 系列文章目录前言一、MySQL的函数1. 聚合函数2. group_c…
阅读更多...
从入口文件搭建php项目

从入口文件搭建php项目

入口文件index.php <?phprequire CallBack.php; // 处理回调请求逻辑 $bot new CallBack();// 请求方式 if (isset($_GET[method])) {$method $_GET[method];if (method_exists($bot, $method)) {return $bot->$method();} else {echo "没有该功能";die();…
阅读更多...
【单片机毕业设计选题24035】-基于STM8的便携式智能药盒控制系统

【单片机毕业设计选题24035】-基于STM8的便携式智能药盒控制系统

系统功能: 基于STM8的便携式智能药盒控制系统设计的总体方案设计&#xff0c;目前确定的模块主要有&#xff1a; STM8、蓝牙模块、时钟芯片、时钟和复位电路、压力传感器、声光报警电路、按键模块、系统电源模块构成。 STM8&#xff1a;核心控制器&#xff0c;完成各模块的控…
阅读更多...
“中国象棋第一人”王天一被查：到底是因作弊还是受贿？

“中国象棋第一人”王天一被查：到底是因作弊还是受贿？

“中国象棋第一人”王天一被查&#xff1a;到底是因作弊还是受贿&#xff1f; 近日&#xff0c;中国象棋界掀起了一场巨大的风波&#xff0c;被誉为“中国象棋第一人”的王天一被查的消息引起了广泛的关注与热议。据悉&#xff0c;王天一因涉嫌非国家工作人员受贿被有关部门依…
阅读更多...
npm常用命令详解与实践

npm常用命令详解与实践

npm&#xff08;Node Package Manager&#xff09;是一个JavaScript编程语言的包管理器&#xff0c;它是Node.js的默认包管理工具。npm用于管理项目中的依赖关系&#xff0c;安装、更新和发布包。 以下是一些常用的npm命令及其详解和实践示例&#xff1a; 1. npm init 初始化…
阅读更多...
pc端制作一个顶部固定的菜单栏

pc端制作一个顶部固定的菜单栏

效果 hsl颜色 hsl颜色在css中比较方便 https://www.w3school.com.cn/css/css_colors_hsl.asp 色相&#xff08;hue&#xff09;是色轮上从 0 到 360 的度数。0 是红色&#xff0c;120 是绿色&#xff0c;240 是蓝色。饱和度&#xff08;saturation&#xff09;是一个百分比值…
阅读更多...
i-Health

i-Health

技术栈&#xff1a;HTMLCSSJavascriptPHP
阅读更多...
将CSV、Excel、XML文件转换为MySQL数据库

将CSV、Excel、XML文件转换为MySQL数据库

在平时的工作中&#xff0c;经常会遇到需要将文件数据导入到数据库中的情况。有些客户之前可能只使用Excel表格作为记录工具&#xff0c;但当数据量达到一定程度或者需要将数据导入到其他系统中时&#xff0c;就会很emo,因为Excel表格虽然方便&#xff0c;但在数据处理和管理方…
阅读更多...
web安全渗透测试十大常规项（一）：web渗透测试之深入JAVA反序列化

web安全渗透测试十大常规项（一）：web渗透测试之深入JAVA反序列化

渗透测试之PHP反序列化 1. Java反序列化1.1 FastJson反序列化链知识点1.2 FastJson反序列化链分析1.3.1 FastJson 1.2.24 利用链分析1.3.2 FastJson 1.2.25-1.2.47 CC链分析1.3.2.1、开启autoTypeSupport：1.2.25-1.2.411. Java反序列化 1.1 FastJson反序列化链知识点 1、为什…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023