构建强大的接口自动化测试框架:Pytest实践指南!

一. 背景

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

二. 基础环境

语言:python 3.8
编译器:pycharm
基础:具备python编程基础
框架:pytest+requests+allure

三. 项目结构

项目结构图如下:


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


测试报告如下图:

现在我也找了很多测试的朋友,做了一个分享技术的交流群,共享了很多我们收集的技术文档和视频教程。
如果你不想再体验自学时找不到资源,没人解答问题,坚持几天便放弃的感受
可以加入我们一起交流。而且还有很多在自动化,性能,安全,测试开发等等方面有一定建树的技术大牛
分享他们的经验,还会分享很多直播讲座和技术沙龙
可以免费学习!划重点!开源的!!!
qq群号:110685036【暗号:csdn888】

四、框架解析

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的工具类即可,后续也会写文章专门介绍。

测试工程师工位上必备书籍之一,利用业余时间学习,挑战自动化测试高薪,从此告别点点点,欢迎加购:=========================================================
以上就是本篇文章的全部内容,如果对你有帮助,
 

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

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

相关文章

技巧-PyCharm中Debug和Run对训练的影响和实验测试

简介 在训练深度学习模型时,使用PyCharm的Debug模式和Run模式对训练模型的耗时会有一些区别。 Debug模式:Debug模式在训练模型时,会对每一行代码进行监视,这使得CPU的利用率相对较高。由于需要逐步执行、断点调试、查看变量值等操…

[C++][原创]VSCode C++怎么让运行的时候弹出cmd窗口,而不是在VSCode调试输出

VSCode C怎么让运行的时候弹出cmd窗口,而不是在VSCode控制台调试输出?其实在VSCode控制台调试输出是非常不错的,我很喜欢,但是偏偏有小白就喜欢每次运行弹个cmd窗口,这样的人也是少见。没办法,为了满足这样…

二分查找算法详解

🚀 作者主页: 有来技术 🔥 开源项目: youlai-mall 🍃 vue3-element-admin 🍃 youlai-boot 🌺 仓库主页: Gitee 💫 Github 💫 GitCode 💖 欢迎点赞…

华为ospf和isis双点双向路由重分布的次优路径和环路终极解决方案

r5上直接导入直连路由 r3和r2进行双点双向路由重分布 查看R3去往R5产生了次优路径: 因为是R2先互相引入的isis和ospf,所以R3会产生次优路径,如果是R3先相互引入ospf和isis,那就是R2去R5会产生次优路径,而R3本身不会。…

基于若依的ruoyi-nbcio流程管理系统增加流程节点配置(三)

更多ruoyi-nbcio功能请看演示系统 gitee源代码地址 前后端代码: https://gitee.com/nbacheng/ruoyi-nbcio 演示地址:RuoYi-Nbcio后台管理系统 这一节主要是对每个流程节点的字段规则设置与操作规则设置,目前也是只针对自定义业务表单。 1、…

元素在盒模型居中的情况

在CSS中,有多种方法可以使元素在盒模型中居中。下面列举了一些常见的情况和相应的解决方案: 水平居中:文本 text-align: center; 适用于:行内元素和文本。 水平居中:块级元素 margin-left: auto; margin-right: auto…

Day35| Leetcode 860. 柠檬水找零 Leetcode 406. 根据身高重建队列 Leetcode 452. 用最少数量的箭引爆气球

Leetcode 860. 柠檬水找零 题目链接 860 柠檬水找零 本题目比较简单,我一开始并没有看出有需要贪心的地方,看了一下解析: 局部最优:遇到账单20,优先消耗美元10,完成本次找零。全局最优:完成…

c语言编程题经典100例——(36~40例)

1&#xff0c;实现快速排序算法。 下面是用C语言实现快速排序算法的示例代码&#xff1a; #include <stdio.h> void swap(int* a, int* b) { int t *a; *a *b; *b t; } int partition(int arr[], int low, int high) { int pivot arr[high]; int i (low …

如何设置带有密码的excel只读模式?

Excel只读模式大家都不陌生&#xff0c;那大家知道带有密码的只读模式吗&#xff1f;今天给大家分享如何设置带有密码的只读模式。 打开excel文件&#xff0c;将文件进行【另存为】设置&#xff0c;然后停留在保存路径的界面中&#xff0c;我们点击下面的工具 – 常规选项 在常…

浅谈数据资产价值评估

加gzh"大数据食铁兽“&#xff0c;了解更多大数据信息 数据是资产&#xff0c;是当前时代大背景下毋庸置疑的。随着科技的发展&#xff0c;数据的重要性越来越受到人们的关注。对于企业来说&#xff0c;数据是非常重要的资产&#xff0c;它可以为企业提供决策依据、增加市…

20天GMV超过百万美金!桌下迷你跑步机在TikTok Shop美国站热销

上周总GMV达到1.59亿美元&#xff0c;达到历史新高&#xff0c;是美国站自开通以来首次单周出单达到亿级&#xff1b;日均出单1660万美元&#xff0c;单日出单最高达2820万美元&#xff1b; 截至11月19日&#xff0c;GMV Top 5 的商品分类排名依次为&#xff1a;美妆个护、女士…

【论文复现】RoSteALS: Robust Steganography using Autoencoder Latent Space-2023-CVPR

代码链接&#xff1a;https://github.com/TuBui/RoSteALS 一定要按照dockerfile&#xff0c;requirements.txt和requirements2.txt配置环境 需要补充的库&#xff1a; pip安装&#xff1a;omegaconf slack slackclient bchlib (0.14.0版本) einops imagenet-c conda安装&…

4、stable diffusion

github 安装anaconda环境 conda env create -f environment.yaml conda activate ldm安装依赖 conda install pytorch1.12.1 torchvision0.13.1 torchaudio0.12.1 cudatoolkit11.3 -c pytorch pip install transformers4.19.2 diffusers invisible-watermark pip install -e…

C++学习之路(十一)C++ 用Qt5实现一个工具箱(增加一个进制转换器功能)- 示例代码拆分讲解

上篇文章&#xff0c;我们用 Qt5 实现了在小工具箱中添加了《时间戳转换功能》功能。为了继续丰富我们的工具箱&#xff0c;今天我们就再增加一个平时经常用到的功能吧&#xff0c;就是「 进制转换 」功能。下面我们就来看看如何来规划开发一个这样的小功能并且添加到我们的工具…

抖音本地生活服务商申请要多久审核通过?

近年来&#xff0c;随着互联网的普及和社交媒体的兴起&#xff0c;本地生活服务行业也迎来了巨大的发展机遇。作为最受欢迎的短视频平台之一&#xff0c;抖音也不例外。抖音本地生活服务商申请要多久审核通过&#xff1f;这是许多想要加入抖音本地服务行业的人们最关心的问题之…

Docker—共享应用程序

现在您已经构建了一个映像&#xff0c;可以共享它。要共享Docker映像&#xff0c;您必须使用Docker注册表。默认注册表是Docker Hub&#xff0c;是您使用的所有图像的来源。 Docker ID&#xff08;Docker标识&#xff09; Docker ID允许您访问Docker Hub&#xff0c;这是世界上…

绩效考核的基础及基本内容

人力资源是企业的第一资源&#xff0c;员工绩效水平决定着人力资源价值的实现程度&#xff0c;绩效是企业永远的重点&#xff0c;没有绩效&#xff0c;一切无从谈起。很多企业在实施考核时扩大了绩效考核的积极作用&#xff0c;并没有考虑企业对绩效考核负面效应的承载能力&…

深入了解Java8新特性-日期时间API:OffsetDateTime类

阅读建议 嗨&#xff0c;伙计&#xff01;刷到这篇文章咱们就是有缘人&#xff0c;在阅读这篇文章前我有一些建议&#xff1a; 本篇文章大概24000多字&#xff0c;预计阅读时间长需要20分钟。本篇文章的实战性、理论性较强&#xff0c;是一篇质量分数较高的技术干货文章&…

easyExcel自定义导出,指定列,设置请求头背景色,加入合计行,设置合计行字体,背景色等等

效果图 1.引入easyExcel pom <dependency><groupId>com.alibaba</groupId><artifactId>easyexcel</artifactId><version>3.3.1</version></dependency> 2.工具类-自定义样式handler-CustomCellWriteHandler import java.util…

信号分析仪-4024CA频谱分析仪 频率范围9kHz~9GHz

01 4024CA频谱分析仪 产品综述&#xff1a; 4024CA频谱分析仪是一款专为外场测试而设计的大宽带手持式实时频谱分析仪&#xff0c;最大实时分析带宽达到120MHz&#xff0c;具有实时频谱分析、5G NR解调分析、LTE FDD/TDD解调分析、GSM/EDGE解调分析、定向分析等多种测量功能…