pytest接口自动化测试框架搭建的全过程

目录

一. 背景

二. 基础环境

三. 项目结构

四、框架解析

pytest是Python的一种单元测试框架,可用来组织用例执行,用例断言,下面这篇文章主要给大家介绍了关于pytest接口自动化测试框架搭建的相关资料,文中通过实例代码介绍的非常详细,需要的朋友可以参考下

一. 背景

Pytest目前已经成为Python系自动化测试必学必备的一个框架，网上也有很多的文章讲述相关的知识。最近自己也抽时间梳理了一份pytest接口自动化测试框架，因此准备写文章记录一下，做到尽量简单通俗易懂，当然前提是基本的python基础已经掌握了。如果能够对新学习这个框架的同学起到一些帮助，那就更好了~

二. 基础环境

语言：python 3.8

编译器：pycharm

基础：具备python编程基础

框架：pytest+requests+allure

三. 项目结构

项目结构图如下：


每一层具体的含义如下图：

 


测试报告如下图：

 

四、框架解析

4.1 接口数据文件处理


框架中使用草料二维码的get和post接口用于demo测试，比如：

get接口：https://cli.im/qrcode/getDefaultComponentMsg

返回值：{“code”:1,“msg”:"",“data”:{xxxxx}}

数据文件这里选择使用Json格式，文件内容格式如下，test_http_get_data.json：

{"dataItem": [{"id": "testget-1","name": "草料二维码get接口1","headers":{"Accept-Encoding":"gzip, deflate, br"},"url":"/qrcode/getDefaultComponentMsg","method":"get","expectdata": {"code": "1"}},{"id": "testget-2","name": "草料二维码get接口2","headers":{},"url":"/qrcode/getDefaultComponentMsg","method":"get","expectdata": {"code": "1"}}]
}

表示dataitem下有两条case，每条case里面声明了id, name, header, url, method, expectdata。如果是post请求的话，case中会多一个parameters表示入参，如下：

{"id":"testpost-1","name":"草料二维码post接口1","url":"/Apis/QrCode/saveStatic","headers":{"Content-Type":"application/x-www-form-urlencoded","Accept-Encoding":"gzip, deflate, br"},"parameters":{"info":11111,"content":11111,"level":"H","size":500,"fgcolor":"#000000","bggcolor":"#FFFFFF","transparent":"false","type":"text","codeimg":1},"expectdata":{"status":"1","qrtype":"static"}
}

为了方便一套脚本用于不同的环境运行，不用换了环境后挨个儿去改数据文件，比如

测试环境URL为：https://testcli.im/qrcode/getDefaultComponentMsg

生产环境URL为：https://cli.im/qrcode/getDefaultComponentMsg

因此数据文件中url只填写后半段，不填域名。然后config》global_config.py下设置全局变量来定义域名：

# 配置HTTP接口的域名，方便一套脚本用于多套环境运行时，只需要改这里的全局配置就OK
CAOLIAO_HTTP_POST_HOST = "https://cli.im"
CAOLIAO_HTTP_GET_HOST = "https://nc.cli.im"

utils文件夹下，创建工具类文件：read_jsonfile_utils.py， 用于读取json文件内容：

import json
import osclass ReadJsonFileUtils:def __init__(self, file_name):self.file_name = file_nameself.data = self.get_data()def get_data(self):fp = open(self.file_name,encoding='utf-8')data = json.load(fp)fp.close()return datadef get_value(self, id):return self.data[id]@staticmethoddef get_data_path(folder, fileName):BASE_PATH = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))data_file_path = os.path.join(BASE_PATH, folder, fileName)return data_file_pathif __name__ == '__main__':opers = ReadJsonFileUtils("..\\resources\\test_http_post_data.json")#读取文件中的dataItem,是一个list列表，list列表中包含多个字典dataitem=opers.get_value('dataItem')print(dataitem)

运行结果如下：

4.2 封装测试工具类

utils文件夹下，除了上面提到的读取Json文件工具类：read_jsonfile_utils.py，还有封装request 请求的工具类：http_utils.py

从Excel文件中读取数据的工具类：get_excel_data_utils.py(虽然本次框架中暂时未采用存放接口数据到Excel中，但也写了个工具类，需要的时候可以用)


http_utils.py内容：

import requests
import jsonclass HttpUtils:@staticmethoddef http_post(headers, url, parameters):print("接口请求url：" + url)print("接口请求headers：" + json.dumps(headers))print("接口请求parameters：" + json.dumps(parameters))res = requests.post(url, data=parameters, headers=headers)print("接口返回结果："+res.text)if res.status_code != 200:raise Exception(u"请求异常")result = json.loads(res.text)return result@staticmethoddef http_get(headers, url):req_headers = json.dumps(headers)print("接口请求url：" + url)print("接口请求headers：" + req_headers)res = requests.get(url, headers=headers)print("接口返回结果：" + res.text)if res.status_code != 200:raise Exception(u"请求异常")result = json.loads(res.text)return result

get_excel_data_utils.py内容：

import xlrd
from xlrd import xldate_as_tuple
import datetimeclass ExcelData(object):'''xlrd中单元格的数据类型数字一律按浮点型输出，日期输出成一串小数，布尔型输出0或1，所以我们必须在程序中做判断处理转换成我们想要的数据类型0 empty,1 string, 2 number, 3 date, 4 boolean, 5 error'''def __init__(self, data_path, sheetname="Sheet1"):#定义一个属性接收文件路径self.data_path = data_path# 定义一个属性接收工作表名称self.sheetname = sheetname# 使用xlrd模块打开excel表读取数据self.data = xlrd.open_workbook(self.data_path)# 根据工作表的名称获取工作表中的内容self.table = self.data.sheet_by_name(self.sheetname)# 根据工作表的索引获取工作表的内容# self.table = self.data.sheet_by_name(0)# 获取第一行所有内容,如果括号中1就是第二行，这点跟列表索引类似self.keys = self.table.row_values(0)# 获取工作表的有效行数self.rowNum = self.table.nrows# 获取工作表的有效列数self.colNum = self.table.ncols# 定义一个读取excel表的方法def readExcel(self):# 定义一个空列表datas = []for i in range(1, self.rowNum):# 定义一个空字典sheet_data = {}for j in range(self.colNum):# 获取单元格数据类型c_type = self.table.cell(i,j).ctype# 获取单元格数据c_cell = self.table.cell_value(i, j)if c_type == 2 and c_cell % 1 == 0:  # 如果是整形c_cell = int(c_cell)elif c_type == 3:# 转成datetime对象date = datetime.datetime(*xldate_as_tuple(c_cell, 0))c_cell = date.strftime('%Y/%d/%m %H:%M:%S')elif c_type == 4:c_cell = True if c_cell == 1 else Falsesheet_data[self.keys[j]] = c_cell# 循环每一个有效的单元格，将字段与值对应存储到字典中# 字典的key就是excel表中每列第一行的字段# sheet_data[self.keys[j]] = self.table.row_values(i)[j]# 再将字典追加到列表中datas.append(sheet_data)# 返回从excel中获取到的数据：以列表存字典的形式返回return datasif __name__ == "__main__":data_path = "..\\resources\\test_http_data.xls"sheetname = "Sheet1"get_data = ExcelData(data_path, sheetname)datas = get_data.readExcel()print(datas)

4.3 测试用例代码编写

testcases文件夹下编写测试用例：


test_caoliao_http_get_interface.py内容：

import logging
import allureimport pytest
from utils.http_utils import HttpUtils
from utils.read_jsonfile_utils import ReadJsonFileUtils
from config.global_config import CAOLIAO_HTTP_GET_HOST@pytest.mark.httptest
@allure.feature("草料二维码get请求测试")
class TestHttpInterface:# 获取文件相对路径data_file_path = ReadJsonFileUtils.get_data_path("resources", "test_http_get_data.json")# 读取测试数据文件param_data = ReadJsonFileUtils(data_file_path)data_item = param_data.get_value('dataItem')  # 是一个list列表，list列表中包含多个字典"""@pytest.mark.parametrize是数据驱动;data_item列表中有几个字典，就运行几次caseids是用于自定义用例的名称"""@pytest.mark.parametrize("args", data_item, ids=['测试草料二维码get接口1', '测试草料二维码get接口2'])def test_caoliao_get_demo(self, args, login_test):# 打印用例ID和名称到报告中显示print("用例ID:{}".format(args['id']))print("用例名称:{}".format(args['name']))print("测试conftest传值：{}".format(login_test))logging.info("测试开始啦~~~~~~~")res = HttpUtils.http_get(args['headers'], CAOLIAO_HTTP_GET_HOST+args['url'])# assert断言，判断接口是否返回期望的结果数据assert str(res.get('code')) == str(args['expectdata']['code']), "接口返回status值不等于预期"

test_caoliao_http_post_interface.py内容：

import pytest
import logging
import allure
from utils.http_utils import HttpUtils
from utils.read_jsonfile_utils import ReadJsonFileUtils
from config.global_config import CAOLIAO_HTTP_POST_HOST# pytest.ini文件中要添加markers = httptest，不然会有warning，说这个Mark有问题
@pytest.mark.httptest
@allure.feature("草料二维码post请求测试")
class TestHttpInterface:# 获取文件相对路径data_file_path = ReadJsonFileUtils.get_data_path("resources", "test_http_post_data.json")# 读取测试数据文件param_data = ReadJsonFileUtils(data_file_path)data_item = param_data.get_value('dataItem') #是一个list列表，list列表中包含多个字典"""@pytest.mark.parametrize是数据驱动;data_item列表中有几个字典，就运行几次caseids是用于自定义用例的名称"""@pytest.mark.parametrize("args", data_item, ids=['测试草料二维码post接口1','测试草料二维码post接口2'])def test_caoliao_post_demo(self, args):# 打印用例ID和名称到报告中显示print("用例ID:{}".format(args['id']))print("用例名称:{}".format(args['name']))logging.info("测试开始啦~~~~~~~")res = HttpUtils.http_post(args['headers'], CAOLIAO_HTTP_POST_HOST+args['url'], args['parameters'])# assert断言，判断接口是否返回期望的结果数据assert str(res.get('status')) == str(args['expectdata']['status']), "接口返回status值不等于预期"assert str(res.get('data').get('qrtype')) == str(args['expectdata']['qrtype']), "接口返回qrtype值不等于预期"

企业中的系统接口，通常都有认证，需要先登录获取token，后续接口调用时都需要认证token。因此框架需要能处理在运行用例前置和后置做一些动作，所以这里用到了conftest.py文件，内容如下：

import logging
import tracebackimport pytest
import requests"""
如果用例执行前需要先登录获取token值，就要用到conftest.py文件了
作用：conftest.py 配置里可以实现数据共享，不需要import导入 conftest.py，pytest用例会自动查找
scope参数为session，那么所有的测试文件执行前执行一次
scope参数为module，那么每一个测试文件执行前都会执行一次conftest文件中的fixture
scope参数为class，那么每一个测试文件中的测试类执行前都会执行一次conftest文件中的fixture
scope参数为function，那么所有文件的测试用例执行前都会执行一次conftest文件中的fixture
"""# 获取到登录请求返回的ticket值，@pytest.fixture装饰后，testcase文件中直接使用函数名"login_ticket"即可得到ticket值
@pytest.fixture(scope="session")
def login_ticket():header = {'Content-Type': 'application/x-www-form-urlencoded; charset=UTF-8'}params = {"loginId": "username","pwd": "password",}url = 'http://testxxxxx.xx.com/doLogin'logging.info('开始调用登录接口:{}'.format(url))res = requests.post(url, data=params, headers=header, verify=False)  # verify：忽略https的认证try:ticket = res.headers['Set-Cookie']except Exception as ex:logging.error('登录失败！接口返回：{}'.format(res.text))traceback.print_tb(ex)logging.info('登录成功，ticket值为：{}'.format(ticket))return ticket#测试一下conftest.py文件和fixture的作用
@pytest.fixture(scope="session")
def login_test():print("运行用例前先登录！")# 使用yield关键字实现后置操作，如果上面的前置操作要返回值，在yield后面加上要返回的值# 也就是yield既可以实现后置，又可以起到return返回值的作用yield "runBeforeTestCase"print("运行用例后退出登录！")

由于用例中用到了@pytest.mark.httptest给用例打标，因此需要创建pytest.ini文件，并在里面添加markers = httptest，不然会有warning，说这个Mark有问题。并且用例中用到的日志打印logging模板也需要在pytest.ini文件中增加日志配置。pytest.ini文件内容如下：

 

[pytest]
markers =httptest: run http interface testdubbotest: run dubbo interface testlog_cli = true
log_cli_level = INFO
log_cli_format = %(asctime)s - %(pathname)s[line:%(lineno)d] - %(levelname)s: %(message)s
log_cli_date_format=%Y-%m-%d %H:%M:%S
log_format = %(asctime)s - %(pathname)s[line:%(lineno)d] - %(levelname)4s: %(message)s
log_date_format=%Y-%m-%d %H:%M:%S

4.4 测试用例运行生成报告

运行方式：
Terminal窗口，进入到testcases目录下，执行命令：运行某一条case：pytest test_caoliao_http_post_interface.py
运行所有case: pytest
运行指定标签的case：pytest -m httptest运行并打印过程中的详细信息：pytest -s test_caoliao_http_post_interface.py
运行并生成pytest-html报告：pytest test_caoliao_http_post_interface.py --html=../testoutput/report.html
运行并生成allure测试报告：
1. 先清除掉testoutput/result文件夹下的所有文件
2. 运行case，生成allure文件：pytest --alluredir ../testoutput/result
3. 根据文件生成allure报告：allure generate ../testoutput/result/ -o ../testoutput/report/ --clean
4. 如果不是在pycharm中打开，而是直接到report目录下打开index.html文件打开的报告无法展示数据，需要双击generateAllureReport.bat生成allure报告；

pytest-html报告：


generateAllureReport.bat文件位置：

 

文件内容：

allure open report/

Allure报告：


框架中用到的一些细节知识点和问题，如：

conftest.py和@pytest.fixture()结合使用
pytest中使用logging打印日志
python中获取文件相对路径的方式
python虚拟环境
pytest框架下Allure的使用

我会在后续写文章再介绍。另外框架同样适用于dubbo接口的自动化测试，只需要添加python调用dubbo的工具类即可，后续也会写文章专门介绍。

 以下是我收集到的比较好的学习教程资源，虽然不是什么很值钱的东西，如果你刚好需要，可以评论区，留言【777】直接拿走就好了

各位想获取资料的朋友请点赞 + 评论 + 收藏，三连！

三连之后我会在评论区挨个私信发给你们~

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

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

相关文章

【Java】常用Stream API

【Java】常用Stream API

常见 Stream 流表达式 总体结构图 一、两大类型 中间操作(Intermediate Operations) 中间操作是指在Stream上执行的操作, 它们返回一个新的Stream, 允许你链式地进行多个中间操作. 终端操作(Terminal Operations) 对Stream进行最终处理的操作, 当调用终端操作时, Stream会开始执…
阅读更多...
pycharm中配置conda

pycharm中配置conda

安装好pycharm和conda后，打开pycharm：
阅读更多...
湘大 XTU OJ 1308 比赛 题解：循环结束的临界点+朴素模拟

湘大 XTU OJ 1308 比赛 题解：循环结束的临界点+朴素模拟

一、链接 比赛 二、题目 题目描述 有n个人要进行比赛，比赛规则如下： 假设每轮比赛的人是m，取最大的k，k2^t且k≤m。这k个人每2人举行一场比赛，胜利者进入一下轮，失败者被淘汰。余下的m-k个人&#xff0…
阅读更多...
web-vue

web-vue

<html><head><title>永远朋友</title><script src"../js/vue.js"></script></head><body><div id "app"><input type"text" v-model"message">{{ message }}</div&g…
阅读更多...
mysql延时问题排查

mysql延时问题排查

背景介绍 最近遇到一个奇怪的问题&#xff0c;有个业务&#xff0c;每天早上七点半产生主从延时&#xff0c;延时时间12.6K&#xff1b; 期间没有抽数/备份等任务&#xff1b;查看慢日志发现&#xff0c;期间有一个delete任务&#xff0c;在主库执行了161s delete from xxxx_…
阅读更多...
SD-MTSP：光谱优化算法LSO求解单仓库多旅行商问题MATLAB（可更改数据集，旅行商的数量和起点）

SD-MTSP：光谱优化算法LSO求解单仓库多旅行商问题MATLAB（可更改数据集，旅行商的数量和起点）

一、光谱优化算法LSO 光谱优化算法&#xff08;Light Spectrum Optimizer&#xff0c;LSO&#xff09;由Mohamed Abdel-Basset等人于2022年提出。 参考文献&#xff1a; [1]Abdel-Basset M, Mohamed R, Sallam KM, Chakrabortty RK. Light Spectrum Optimizer: A Novel Physi…
阅读更多...
深眸科技｜发现AI+3D视觉的价值，技术升级加速视觉应用产品国产替代

深眸科技｜发现AI+3D视觉的价值，技术升级加速视觉应用产品国产替代

随着中国工业化进程的不断深入和智能制造浪潮的影响&#xff0c;工业生产对于机器视觉技术的需求不断攀升&#xff0c;其应用范围覆盖了工业领域的众多行业&#xff0c;包括3C电子、汽车、半导体、新能源、物流等。 据GGII发布的最新数据显示&#xff0c;近年来我国机器视觉市…
阅读更多...
通达OA SQL注入漏洞【CVE-2023-4165】

通达OA SQL注入漏洞【CVE-2023-4165】

通达OA SQL注入漏洞【CVE-2023-4165】 一、产品简介二、漏洞概述三、影响范围四、复现环境POC小龙POC检测工具: 五、修复建议 免责声明&#xff1a;请勿利用文章内的相关技术从事非法测试&#xff0c;由于传播、利用此文所提供的信息或者工具而造成的任何直接或者间接的后果及损…
阅读更多...
029 - integer types 整数类型

029 - integer types 整数类型

MySQL支持SQL标准整数类型 INTEGER&#xff08;或INT&#xff09;和 SMALLINT。作为一个可扩展标准&#xff0c;MySQL也支持整数类型 TINYINT&#xff0c;MEDIUMINT和 BIGINT。下表显示了每种整数类型所需的存储空间和范围。 表11.1 MySQL支持的整数类型的必需存储和范围 类型…
阅读更多...
电脑麦克风没声音？

电脑麦克风没声音？

这3招就可以解决&#xff01; 在我们使用电脑录制视频时&#xff0c;有时会遇到一个令人头疼的问题&#xff1a;麦克风没有声音。那么&#xff0c;为什么会出现这种情况呢&#xff1f;更重要的是&#xff0c;我们应该如何解决这个问题呢&#xff1f;本文将介绍3种方法&#xf…
阅读更多...
内生性的蒙特卡罗模拟

内生性的蒙特卡罗模拟

这是一个很好的例子,通过蒙特卡洛模拟展示了忽略相关变量时,回归系数估计的偏差。 %% 蒙特卡洛模拟&#xff1a;内生性会造成回归系数的巨大误差 times 300; % 蒙特卡洛的次数 R zeros(times,1); % 用来储存扰动项u和x1的相关系数 K zeros(times,1); % 用来储存遗漏了x2…
阅读更多...
数据结构和算法三（排序）

数据结构和算法三（排序）

列表排序 排序类型&#xff1a; 一、冒泡排序&#xff1a; 屏幕录制2023-07-25 13.05.12 def bubble_sort(li):exchangeFalseif len(li)<1:return lifor i in range(len(li)-1):for j in range(len(li)-i-1):if li[j]>li[j1]:li[j],li[j1]li[j1],li[j]print(li)exchangeT…
阅读更多...
【C语言学习】函数原型

【C语言学习】函数原型

函数原型 代码一 #include<stdio.h> void sum(int begin, int end) {int i;int sum 0;for(ibegin; i<end; i){sum sum i;}printf("%d到%d的和是%d\n", begin, end, sum); }int main() {sum(1,10);sum(20,30);sum(40,50);return 0; }代码二&#xff08;函…
阅读更多...
【黑马头条之xxl-Job分布式任务调度】

【黑马头条之xxl-Job分布式任务调度】

本笔记内容为黑马头条项目的分布式任务调度热点文章部分 目录 一、今日内容 1、需求分析 2、实现思路 3、定时计算 4、定时任务框架-xxljob 二、分布式任务调度 1、什么是分布式任务调度 2、xxl-Job简介 3、XXL-Job-环境搭建 4、配置部署调度中心-docker安装 5、xx…
阅读更多...
C#实现邮箱验证码

C#实现邮箱验证码

开发环境&#xff1a;C#&#xff0c;VS2019&#xff0c;.NET Core 3.1&#xff0c;ASP.NET Core Web API&#xff0c;163邮箱 1、在163邮箱的设置中开通IMAP/SMTP的服务&#xff0c;授权成功后会弹出一个窗体&#xff08;如下图所示&#xff09;&#xff0c;上面显示了授权密码…
阅读更多...
JavaScript、TypeScript、ES5、ES6之间的联系和区别

JavaScript、TypeScript、ES5、ES6之间的联系和区别

ECMAScript&#xff1a; 一个由 ECMA International 进行标准化&#xff0c;TC39 委员会进行监督的语言。通常用于指代标准本身。JavaScript&#xff1a; ECMAScript 标准的各种实现的最常用称呼。这个术语并不局限于某个特定版本的 ECMAScript 规范&#xff0c;并且可能被用于…
阅读更多...
126、高频Redis面试题:如何保证Redis和数据库数据一致性

126、高频Redis面试题:如何保证Redis和数据库数据一致性

高频Redis面试题:如何保证Redis和数据库数据一致性 缓存用法如何更新缓存先更新缓存&#xff0c;再更新数据库先更新数据库&#xff0c;再更新缓存先删除缓存&#xff0c;再更新数据库延时双删&#xff08;删除缓存&#xff0c;更新数据库&#xff0c;再延时删除缓存&#xff0…
阅读更多...
flask-----初始项目架构

flask-----初始项目架构

1.初始的项目目录 -apps 包 ------存放app -user文件夹 -------就是一个app -models.py --------存放表模型 -views.py -------存放主代码 -ext包 -init.py -------实例化db对象 -manage.py -----运行项目的入口 -setting.py -----配置文件 2.各文件内容 manage…
阅读更多...
【JavaSE】数组的定义与使用

【JavaSE】数组的定义与使用

详解数组 数组的基本概念什么是数组数组的创建及初始化数组的使用 数组是引用类型基本类型变量与引用类型变量的区别引用变量认识 null 数组的应用场景数组练习二维数组 数组的基本概念 什么是数组 数组可以看成是相同类型元素的一个集合。在内存中是一段连续的空间。比如现实…
阅读更多...
深入解析搜好货API：开启智能化电商解决方案

深入解析搜好货API：开启智能化电商解决方案

随着电商行业的快速发展&#xff0c;人们对于个性化、智能化的购物体验的追求也越来越高。为了满足消费者的需求&#xff0c;搜好货API应运而生。 一、搜好货API的基本原理 搜好货API基于先进的数据挖掘和机器学习算法&#xff0c;通过收集和分析大量的商品信息和用户行为数据…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023