自动化接口测试平台搭建之路,我是如何实现接口自动化测试平台

大雄 715 2022-08-27


下面是关于接口自动化测试平台

背景

工具选择

架构设计及技术实现

  参数设计

  断言

  持续集成

  测试集编写

总结

一、背景

1.目前公司发展比较迅速,还处于不停堆业务阶段,所以迭代比较频繁,导致人工回归的成本越来越大

2.在有限的测试资源情况下,开发自测的需求占比不低,后端频繁发布容易心里没底

3.该平台主要使用用户是测试同学,编写接口用例不能有太多的代码量

4.自动化是为了提高测试的效率,需要考虑投入产出比,维护成本要低

 

Ps:好的自动化项目,一定是需要关注ROI的,这也是贯穿我们整个设计的核心思想

 

二、工具选型

java和python对比:就接口自动化而言,两者从成熟度来说差不多;和公司语言保持一致,有利于后期的白盒测试;组内成员会java的更多

TestNg和Junit对比:TestNG包含了JUnit4的核心功能外,更加灵活、方便;

Jenkins:轻量级、成熟的持续集成工具,插件多,基本上要用到的功能都已能支持

 

所以我们最终确定的方案是通过Java+TestNg+jenkins去实现

 

三、架构设计及技术实现

3.1、参数设计

首先,接口参数非常多,有些是只要环境一样,值全部都是同一个;有些参数是有时效性或者执行一次后就不能再被执行的;而大部分是每个接口甚至同一个接口都是不同的值,所以为了接口的低维护成本和编写成本,我这里把所有的接口分成了三大类,全局参数(接口协议、域名、环境、请求头参数等)和非全局参数(接口路径、接口入参、请求方式等)、动态参数

3.1.1 全局参数

这类参数我们基本都是放在配置文件里,这样只要改一个地方就可以,而不需要每个地方去改下,重点说一下环境这个参数,因为我们整个是通过jenkins去集成的,所以在jenkins上会去传不同的环境入参,其他所有的全局参数基本都依赖这个值,以下是我的实现方式

首先在在testNg.xml文件中,接收jenkins中传过来的参数

然后在BeforeTest中先去获取这个参数,如下:

@Parameters({ "env" })

@BeforeTest

public void getEnv(String environment) {

...

...

}

3.1.2 非全局参数

为了接口参数更方便的管理、编写和维护,所以我们采用数据分离的方式;另外我们在我们的持续集成方案中,需要支持多个环境,所以我们在设计上需要区分环境;每个应用部署完后,我们只希望跑对应的接口用例,而不是全部都跑一遍,所以我们需要区分应用。

 

3.1.3 动态参数

为了我们接口用例的可维护性,所以我们需要尽可能缩短维护的时间,那很多接口的参数是有时效性的,比如token;也有些参数是用过后就不能再继续用的,比如库存,那有两个方案,一个是每次执行前都恢复下数据,但这样可能太重了,不仅要恢复数据库,可能缓存这些也要考虑;所以我们用了第二个方案,就是动态参数化,从而保证不用频繁的修改。

主要涉及两个方法,一是从上个接口的响应值中提取指定的参数;二是在后面的接口去用这个参数

 

3.2、断言

断言是自动化测试的重要组成部分,也就是实际值和预期值的比较,我这边也简单给它分成了二大类,静态断言、动态断言

动态断言:期望值从数据库/redis/es中,查出来后再去和实际值比较,适用范围(经常变的重要字段,如库存等)

静态断言:把期望值设为固定值,也是最常见的,适用范围(接口返回状态、接口的json格式等)

这里说下,我们这边实现静态断言的方式,静态断言也有好几种,一是直接通过响应值中是否包含你预期值中的字符串,这种优点就是编写比较快,但是会有偏差;所以我们用的是在响应值中,通过jsonpath,把值提取出来后再去比较,但是往往我们的一次断言中,需要断言的肯定不止一个字段,所以我们会把这些都塞到数组中,最后直接拿预期值数组和实际值数组去比较,以下是我们execl中的截图

 

Ps:因为我们需要考虑到维护成本,所以我们在断言选择上需要做一些取舍

 

3.3、持续集成

我们期望是在某个应用发布后,能自动触发执行我们对应模块的测试集,并且当有执行失败用例时能实现钉钉告警、卡点,并且发送报告,以下是我们的设计流程图

 

Ps:之所以用jenkins就是,jenkins已经集成了非常多的成熟插件,而且可以通过get/post接口,远程去通过参数化去执行jenkins中的任务,包括发送邮件及钉钉告警,这样在我们整个框架搭建上,就节省了很多编写代码的成本,而只需要去关注接口自动化本身的脚本编写上

 

3.4、测试集编写

基于以上的背景,所以要求代码量要尽可能的少,这里主要用到TestNg中的@DataProvider和@test,通过@DataProvider从execl中读取对应的参数,然后通过@test去执行对应的测试集,以下是我们一个测试集所有的代码量

  

四、总结

好的自动化项目,一定是为了解放更多的人力,但如果投入和产出不成正比,那注定是没有意义的,整个项目也还有很多不足的地方或待优化的地方。目前正在组内推广中,期望在质量保障上能带来更多的收益

 

0、实现方式

  • 后端:java

  • 前端:vue+element-ui

  • mock:mock-server

  • 其它:redis

1、数据构建

我们在测试过程中发现测试数据的构建非常重要。如测试数据需要有真实性、唯一性、A 接口依赖 B 接口的返回值。目前通过提供环境变量、方法反射、接口依赖、SQL 依赖等方式提供数据,通过 ${}表达式引用。文章源自玩技e族-https://www.playezu.com/183387.html

1、环境变量

最简单的一种方式,key-value 方式文章源自玩技e族-https://www.playezu.com/183387.html


文章源自玩技e族-https://www.playezu.com/183387.html

2、预置方法

通过反射的方式,动态调用预置的数据构造方法文章源自玩技e族-https://www.playezu.com/183387.html


文章源自玩技e族-https://www.playezu.com/183387.html


文章源自玩技e族-https://www.playezu.com/183387.html

3、SQL 语句

为保证数据在不同环境的通用性,首先需实现数据源模块,这样可以保证在不同环境下执行用例连接到不同的数据库文章源自玩技e族-https://www.playezu.com/183387.html


文章源自玩技e族-https://www.playezu.com/183387.html


文章源自玩技e族-https://www.playezu.com/183387.html

4、接口依赖

选择已有的测试用例,提取响应头或者响应体数据文章源自玩技e族-https://www.playezu.com/183387.html


文章源自玩技e族-https://www.playezu.com/183387.html


文章源自玩技e族-https://www.playezu.com/183387.html

2、接口测试

2.1、测试用例

支持编写、导入(har、json、yaml 等)、复制、生成文章源自玩技e族-https://www.playezu.com/183387.html

2.2.1、编写

前置用例:支持在执行用例前执行其他测试用例文章源自玩技e族-https://www.playezu.com/183387.html

基本信息:主要是关联项目及模块文章源自玩技e族-https://www.playezu.com/183387.html

请求信息:配置请求方式、URL、headers、params、body文章源自玩技e族-https://www.playezu.com/183387.html

请求参数缓存:将请求参数中的 headers、params、form-data、json 对其进行暂存。可通过 #{}操作符调用文章源自玩技e族-https://www.playezu.com/183387.html

断言信息:支持多种断言方式及操作符文章源自玩技e族-https://www.playezu.com/183387.html

响应数据缓存:将响应内容的 headers、body 进行暂存。可通过 #{}操作符调用文章源自玩技e族-https://www.playezu.com/183387.html

可以看到可配置缓存请求参数以及响应数据,有何作用呢?举个简单栗子:如在测试用户详情接口,我们入参为 userId,断言需对响应体结果逐一校验,这就需要用到入参的 userId。文章源自玩技e族-https://www.playezu.com/183387.html

----------------------------------------------------------------------------------------------------文章源自玩技e族-https://www.playezu.com/183387.html

1.缓存 URL 参数 userId文章源自玩技e族-https://www.playezu.com/183387.html


文章源自玩技e族-https://www.playezu.com/183387.html

2.准备检查 SQL,依赖名称为 SelectUserInfoById文章源自玩技e族-https://www.playezu.com/183387.html


文章源自玩技e族-https://www.playezu.com/183387.html

3.断言检查接口返回值 username、realName 字段文章源自玩技e族-https://www.playezu.com/183387.html


文章源自玩技e族-https://www.playezu.com/183387.html

4.执行日志

文章源自玩技e族-https://www.playezu.com/183387.html

----------------------------------------------------------------------------------------------------文章源自玩技e族-https://www.playezu.com/183387.html









文章源自玩技e族-https://www.playezu.com/183387.html

2.2.2、生成

目前项目约束了一套规则配置,配置后,可根据等价类、边界值为每个属性生成约束,最终根据正交法或笛卡尔积生成完整的测试用例。同时为了保证数据的可重复性,数据类型支持动态数据,如用户注册时,可保证当前生成的 username 在数据库中不存在。文章源自玩技e族-https://www.playezu.com/183387.html


文章源自玩技e族-https://www.playezu.com/183387.html

为有效等价类用例和无效等价类用例,单独配置通用断言文章源自玩技e族-https://www.playezu.com/183387.html



文章源自玩技e族-https://www.playezu.com/183387.html

动态生成结果(用例可复用)文章源自玩技e族-https://www.playezu.com/183387.html


文章源自玩技e族-https://www.playezu.com/183387.html

静态生成结果文章源自玩技e族-https://www.playezu.com/183387.html


文章源自玩技e族-https://www.playezu.com/183387.html

2.2.3、导入

目前支持了 har、json、yaml、csv、excel 方式导入。另外,可在导入时将用例加入测试套件文章源自玩技e族-https://www.playezu.com/183387.html


文章源自玩技e族-https://www.playezu.com/183387.html

2.2、用例执行日志

用例执行日志将记录用例的执行情况,断言信息,方便排错。同时,加入执行链路跟踪,使用例整体运行情况更加清晰。文章源自玩技e族-https://www.playezu.com/183387.html


文章源自玩技e族-https://www.playezu.com/183387.html

可以通过点击查看未解析依赖值之前的原始语法文章源自玩技e族-https://www.playezu.com/183387.html


文章源自玩技e族-https://www.playezu.com/183387.html

一次 “获取用户详情” 用例完整的链路跟踪


文章源自玩技e族-https://www.playezu.com/183387.html

2.3、测试套件

测试套件与测试用例之见为 N 对 N 关系。你可以文章源自玩技e族-https://www.playezu.com/183387.html

在测试套件执行之前:为套件执行依赖、添加通用 headers、params、form-data文章源自玩技e族-https://www.playezu.com/183387.html

在测试套件执行之后:为套件执行依赖文章源自玩技e族-https://www.playezu.com/183387.html

测试套件通过并行的方式大幅提升测试效率。当然测试套件中用例同样提供执行先后顺序的设定文章源自玩技e族-https://www.playezu.com/183387.html


文章源自玩技e族-https://www.playezu.com/183387.html

可以方便快捷的维护套件内的用例文章源自玩技e族-https://www.playezu.com/183387.html


文章源自玩技e族-https://www.playezu.com/183387.html

通过并行的方式,在 1s 不到的时间内执行了 24 条测试用例文章源自玩技e族-https://www.playezu.com/183387.html


文章源自玩技e族-https://www.playezu.com/183387.html

2.4、测试报告

在测试套件执行后,将生成测试报告。统计基本运行情况及详细的请求信息文章源自玩技e族-https://www.playezu.com/183387.html



文章源自玩技e族-https://www.playezu.com/183387.html

2.5、其他设置

1.定时任务:可为测试套件制定定时任务文章源自玩技e族-https://www.playezu.com/183387.html

2.设置代理:便于调试及监控文章源自玩技e族-https://www.playezu.com/183387.html

3.超时配置:防止超时阻塞文章源自玩技e族-https://www.playezu.com/183387.html

3、稳定性测试

平时可能会对一些接口进行稳定性测试,因此特意支持按执行时长和执行次数两种调度方式。同时将保留执行日志文章源自玩技e族-https://www.playezu.com/183387.html


文章源自玩技e族-https://www.playezu.com/183387.html

4、mock

mock 基于开源 mock 框架 mock-server。关于这一块,在我之前的帖子可以看到,在此不再赘述,目前主要实现的功能点有:文章源自玩技e族-https://www.playezu.com/183387.html

  • 多节点:可满足不同人员对于相同接口的配置

  • 动态注入:运行时注入/启停 mock-server、mock-api,无需启停服务

  • 可视化报告:由 mock-server-ui 提供

  • 丰富的命中策略:支持 header、body、queryparams、pathparams

  • 支持自动转发:在未命中 mock-api 时支持自动转发真实服务

  • 支持响应延时配置

以上就是小编为大家整理的接口自动化测试平台


版权声明:本文内容由网络用户投稿,版权归原作者所有,本站不拥有其著作权,亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容,请联系我们jiasou666@gmail.com 处理,核实后本网站将在24小时内删除侵权内容。

上一篇:springboot打包实现项目JAR包和依赖JAR包分离
下一篇:Opencv与python实现多目标跟踪 (一) - PaddleDetection目标检测(opencv 多目标跟踪)
相关文章

 发表评论

评论列表