Python+Pytest+Allure+Yaml+Pymysql+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:公共方法包

--connect_db.py: SQL操作封装
--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/diannao/39285.shtml

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

相关文章

Python 类与对象：深入理解与应用

Python 类与对象：深入理解与应用

在 Python 中，类是一种抽象数据类型，用于描述具有相同属性和方法的对象集合。类通过属性（变量）和方法（函数）来定义对象的行为。对象是类的实例化结果，它可以具备类定义的所有特性。Python 中的类…
阅读更多...
ROS2 RQT

ROS2 RQT

1. RQT是什么 RQT是一个GUI框架，通过插件的方式实现了各种各样的界面工具。 强行解读下：RQT就像插座，任何电器只要符合插座的型号就可以插上去工作。 2.选择插件 这里我们可以选择现有的几个RQT插件来试一试，可以看到和话题、参…
阅读更多...
金蝶云星空字段之间连续触发值更新

金蝶云星空字段之间连续触发值更新

文章目录 金蝶云星空字段之间连续触发值更新场景说明具体需求：解决方案 金蝶云星空字段之间连续触发值更新 场景说明 字段A配置了字段B的计算公式，字段B配置了自动C的计算公式，修改A的时候，触发了B的重算，但是C触发不…
阅读更多...
【云原生】Kubernetes----ETCD数据的备份与恢复

【云原生】Kubernetes----ETCD数据的备份与恢复

目录 引言 一、ETCD数据备份 （一）确定备份策略 （二）使用etcdctl工具进行备份 1.安装etcdctl命令 2.设置ETCDCTL_API环境变量 （三）执行备份 二、数据还原 （一）创建新资源 &…
阅读更多...
XMind2TestCase：高效测试用例设计工具

XMind2TestCase：高效测试用例设计工具

XMind2TestCase：高效测试用例设计工具 引言传统测试用例设计的问题1. Excel表格的局限性2. 传统测试管理工具的不足3. 自研测试管理工具的挑战 思维导图在测试用例设计中的应用思维导图的优势思维导图的挑战 简介安装使用方式命令行调用使用Web界面 使用示例XMind文…
阅读更多...
广州自闭症机构哪家好

广州自闭症机构哪家好

在广州，众多的自闭症康复机构中，星贝育园自闭症儿童康复学校以其独特的优势脱颖而出。 一、专业的师资团队 我们拥有一支经验丰富、专业素养极高的师资队伍。每位老师都经过严格的专业培训，深入了解自闭症儿童的特点和需求。他们不仅…
阅读更多...
苍穹外卖项目 常用注解 + 动态sql

苍穹外卖项目 常用注解 + 动态sql

常用注解 常见的注解解析方法有两种： 编译期直接扫描：编译器在编译 Java 代码的时候扫描对应的注解并处理，比如某个方法使用Override 注解，编译器在编译的时候就会检测当前的方法是否重写了父类对应的方法。运行期通过反射处理&…
阅读更多...
SAP_ABAP相关日语单词

SAP_ABAP相关日语单词

基本概念 1. プログラミング言語 (プログラミングげんご, Puroguramingu gengo) - 编程语言 2. 開発 (かいはつ, Kaihatsu) - 开发 3. システム (システム, Shisutemu) - 系统 4. モジュール (モジュール, Mojūru) - 模块 5. トランザクションコード (トランザクションコード,…
阅读更多...
探索旅游卡项目的八大黄金赛道，你离月入十几万仅一步之遥！

探索旅游卡项目的八大黄金赛道，你离月入十几万仅一步之遥！

作为旅游卡项目的推广精英，我深知在这个充满机遇与挑战的时代，选择正确的赛道至关重要。今天，我将从定位、内容、产品、流量、变现这五个核心维度出发，为你揭秘旅游卡项目的八大热门方向。如果你正对旅游充满热情，或拥…
阅读更多...
【基于R语言群体遗传学】-3-计算等位基因频率

【基于R语言群体遗传学】-3-计算等位基因频率

书接上文，我们讲完了哈代温伯格基因型频率，也使用数据进行了拟合，那么接下来就是考虑一些计算的问题： 【基于R语言群体遗传学】-1-哈代温伯格基因型比例-CSDN博客 【基于R语言群体遗传学】-2-模拟基因型（simulating …
阅读更多...
【leetcode--最小栈】

【leetcode--最小栈】

设计一个支持 push ，pop ，top 操作，并能在常数时间内检索到最小元素的栈。 实现 MinStack 类: MinStack() 初始化堆栈对象。void push(int val) 将元素val推入堆栈。void pop() 删除堆栈顶部的元素。int top() 获取堆栈顶部的元素。int get…
阅读更多...
TextInput是用于在用户界面中输入文本的控件，通常应用于表单、搜索框等需要用户输入文字的场景

TextInput是用于在用户界面中输入文本的控件，通常应用于表单、搜索框等需要用户输入文字的场景

TextInput是用于在用户界面中输入文本的控件，通常应用于表单、搜索框等需要用户输入文字的场景。以下是对TextInput的详细解释，涵盖其各个方面的功能和属性。 基本属性 text 描述：TextInput中当前显示的文本。用法：text: "示…
阅读更多...
WebKey备受瞩目的Web3.0新叙事，硬件与加密生态完美融合特性成为数字世界的新入口

WebKey备受瞩目的Web3.0新叙事，硬件与加密生态完美融合特性成为数字世界的新入口

在当今迅速发展的科技领域，Web3.0正在引领一场颠覆性的变革。而作为这一变革的先锋，WebKey无疑是备受瞩目的创新项目。它不仅代表了一种全新的技术趋势，更是数字世界中硬件与加密生态完美融合的典范。 硬件与加密生态的完美融合 WebKey的核心…
阅读更多...
Java基础面试题（简单版）：

Java基础面试题（简单版）：

1.java的8个基本数据类型? 整型: byte(占用1个字节) short(占用2个字节) int(占用4个字节) long(占用8个字节) 浮点型: float(占用4个字节)、double(占用8个字节) 字符型: char 布尔型: boolean 2.ArrayList和LinkedList的区别? 可以说ArrayList和LinkedList除了是同属于集合…
阅读更多...
【QT】输入类控件

【QT】输入类控件

目录 Line Edit 核心属性 核心信号 正则表达式 示例：使用正则表达式验证输入框内容 示例：切换输入框密码模式下的显示状态 Text Edit 核心属性 核心信号 示例：获取多行输入框的内容同步显示到label 示例：获取文本的选…
阅读更多...
三生随记——眉笔诡事

三生随记——眉笔诡事

在一个被遗忘的古镇上，流传着一个关于眉笔的诡异传说。这个古镇坐落在群山的环抱中，鲜少有人知晓它的存在。而在这片土地上，却有着一件被视为诅咒之源的眉笔。 眉笔的来历无人知晓，只知它在一夜之间出现在镇上的古董店中。那支眉笔…
阅读更多...
一文讲懂npm link

一文讲懂npm link

前言 在本地开发npm模块的时候，我们可以使用npm link命令，将npm 模块链接到对应的运行项目中去，方便地对模块进行调试和测试 用法 包链接是一个两步过程： 1.为依赖项创建全局软链npm link。一个符号链接，简称软链&a…
阅读更多...
0702_ARM5

0702_ARM5

练习：使用usart4 main.c #include "uart4.h"int main() {// 初始化 UART4hal_uart4_init();while (1) {// 发送一个字符串//hal_put_char( hal_get_char());hal_put_string(hal_get_string());}return 0; } usart4.c #include "uart4.h"//**…
阅读更多...
c# 操作mysql的帮助类

c# 操作mysql的帮助类

MySqlHelper 的静态类，其中包含了一些用于执行 MySQL 数据库操作的方法。这些方法包括执行存储过程、插入、更新、删除操作以及执行数据库事务查询操作等。 该类中的方法主要有： ExecuteNonQuery 方法：用于执行存储过程、插入、更新、删除操…
阅读更多...
如何降低布隆过滤器的误判率

如何降低布隆过滤器的误判率

降低布隆过滤器的误判率（也称为假阳性率）是布隆过滤器应用中一个关键的问题。误判率主要来源于哈希碰撞，即不同的元素可能被哈希到相同的位置。为了降低误判率，可以从以下几个方面进行优化： 1. 增加哈希函数的个数 原…
阅读更多...
最新文章

Copyright @ 2022~2023