如何基于YAML设计接口自动化测试框架？看完秒会！

港控/mmm° 2024-03-26 22:30 24阅读 0赞

在设计自动化测试框架的时候，我们会经常将测试数据保存在外部的文件（如Excel、YAML、CSV）或者数据库中，实现脚本与数据解耦，方便后期维护。目前非常多的自动化测试框架采用通过Excel或者YAML文件直接编写测试用例，通过脚本读取出来驱动自动化测试代码执行。

至于采用Excel还是YAML格式各位小伙伴都有不同见解，比如用Excel维护直观、修改数据方便，劣势是通过Git这样的版本控制工具不太好比较历史版本差异（因为是二进制格式）；YAML的优势是支持数据格式完备、版本控制管理方便（文本格式），劣势是没有Excel这么直观。Excel这种方式大家都比较熟悉了，本文带着大家来了解如何基于YAML设计自动化测试框架。

**YAML格式测试用例设计**

以接口自动化为例，用YAML编写测试用例要实现的基本功能需求：  
1.一个YAML文件能够支持多个用例存储需求，不然几千个用例对应几千个YAML文件管理起来也受不了  
2.用例中能够支持单接口测试用例也能支持业务场景用例（多个接口调用组合）  
3.用例中需要包含所属模块、用例名、请求信息、断言信息、提取响应（实现接口关联）等信息

基于上述需求我们来设计一版YAML格式用例：  
![在这里插入图片描述][4e2bcfaf775c42f0b35ae3988f76e799.png]

casename与module字段简单，我们来看下teststeps，为什么teststeps是数组类型？

因为用例中包含一个/多个接口请求步骤，也就是一个TestCase包含了多个teststep，每一个teststep就是一个接口请求。

request中指定接口请求信息，包括接口请求方法、请求地址、请求头、请求参数；其中不同的请求参数类型我们需要进行区别，上述的是json传参，如果是form表单、查询参数传参我们都可以约定为类似的key-value结构，只需要将json改为formparam、queryparam。

需要注意的是文件上传接口的参数会比较特殊，一般来说我们只需要设置要上传文件路径即可，所以我们可以这样设计：  
![在这里插入图片描述][b3b3f7d0207549e4ba9ac42d39fc7dce.png]

extract字段为要提取的响应数据字段，传递给后续的接口使用。一般我们要求能够支持JsonPath表达式或者正则表达式来提取，对应的key为要提取的字段名，对应的值为要提取的字段表达式。

validate字段是断言信息，也就是验证响应结果是否符合预期。这里我们需要支持常用的判断方法包括：等于、大于、小于、大于等于、小于等于，通过简写eq代替equals（等于）判断，其他的类似：大于等于（ge）、小于等于（le）、小于（lt）、大于（gt）。

上述的是单接口测试用例，我们看下多接口串联（业务场景）用例编写的样式：ModifyUserProfile.yaml  
![在这里插入图片描述][555cdc1b77a94c7290f1e4e561f0ee77.png]

在多接口测试中重要的是要能够支持参数传递，这里我们在前一个接口使用extract提取接口的响应字段，在后续要使用的接口中通过$\{token\}方式进行引用，熟悉Jmeter接口测试工具的同学应该非常熟悉这种格式。

**脚本读取YAML数据**

在读取YAML文件数据之前，我们首先需要了解两个概念：序列化与反序列化

把对象转换为字节序列的过程称为对象的序列化；

把字节序列恢复为对象的过程称为对象的反序列化。

而我们读取YAML的过程就可以称之为反序列化。

主流的编程语言都能实现对YAML的解析，接下来以Java语言为例讲解如何读取YAML文件的内容：

Java中能够实现YAML序列化和反序列化的库有很多，包括SnakeYaml、Jackson、jYaml等，使用起来大同小异。以使用Jackson为例：

步骤一：Maven POM文件中添加库的坐标  
![在这里插入图片描述][46d9f74531a347bc8af8a2217d92c1fc.png]

这里用到了jackson-databind与jackson-dataformat-yaml，其中jackson-databind是Jackson的主库，jackson-dataformat-yaml是支持YAML数据格式的库，在这里同时引入了lombok，是为了后面编写实体类时简化一些代码的书写：

Lombok可以来帮助我们简化一些必须有但显得很臃肿（比如get/set方法）的Java代码的工具，通过使用对应的注解，可以在编译源码的时候自动生成对应的方法。

步骤二：编写YAML实体类  
对照YAML文件内容比如字段名（比如 “姓名”）和字段的数据类型（比如字符串），创建一个对应的类，用来在 Java 中表示YAML文件的信息。目的是为了能够将YAML文件保存到Java对象中（反序列化）。

TestCase实体类：  
![在这里插入图片描述][3c2b96e98b6443088b484c085fb01bbd.png]  
Teststep实体类：  
![在这里插入图片描述][079a29aaa931449085711aa26453ca3a.png]

Validate实体类：  
![在这里插入图片描述][78a97f4ccea14d12a585e07833b08512.png]

通过Jackson读取YAML文件内容并保存到TestCase实体类对象中  
![在这里插入图片描述][2895a83ac7a04c39a6c40af2cef11144.png]

其中new TypeReference<List>() \{\}是因为读取到的YAML文件中有多个TestCase用例，所以我们需要定义为List集合类型来接收。

来看看读取之后的效果：

![在这里插入图片描述][203eff602dd1418e8edcbf92b366d756.png]后续即可通过返回的testCase发起接口请求（比如通过REST-assured）、进行接口断言、提取响应字段等操作。

**最后感谢每一个认真阅读我文章的人，礼尚往来总是要有的，虽然不是什么很值钱的东西，如果你用得到的话可以直接拿走：**

#### ![在这里插入图片描述][492d7612ecf9402ca45f3dad0b4d69e3.png_pic_center] ####

**软件测试面试小程序**

被百万人刷爆的软件测试题库！！！谁用谁知道！！！全网最全面试刷题小程序，手机就可以刷题，地铁上公交上，卷起来！

**涵盖以下这些面试题板块：**

> 1、软件测试基础理论 ，2、web,app，接口功能测试 ，3、网络 ，4、数据库 ，5、linux
> 
> 6、web,app，接口自动化 ，7、性能测试 ，8、编程基础，9、hr面试题 ，10、开放性测试题，11、安全测试，12、计算机基础

![a04a286764814986a179a6ea4a30b0cb.png][]

这些资料，对于【软件测试】的朋友来说应该是最全面最完整的备战仓库，这个仓库也陪伴上万个测试工程师们走过最艰难的路程，希望也能帮助到你！

[4e2bcfaf775c42f0b35ae3988f76e799.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/63e467cd58394743b1aaee392adb91b6.png
[b3b3f7d0207549e4ba9ac42d39fc7dce.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/d56fd8dfa0a54207ad03a6645beb1987.png
[555cdc1b77a94c7290f1e4e561f0ee77.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/9c3dcfcdc1134f30a4a11c8b22e28965.png
[46d9f74531a347bc8af8a2217d92c1fc.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/2b2f727648604d7b9c007ed7d763a5c2.png
[3c2b96e98b6443088b484c085fb01bbd.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/fb5bf5dca29a46658c2231622b45b1f5.png
[079a29aaa931449085711aa26453ca3a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/d3d638e5411745349905049541662178.png
[78a97f4ccea14d12a585e07833b08512.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/ba22ac87585d4eed86bee0943ed34c82.png
[2895a83ac7a04c39a6c40af2cef11144.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/0a8528b6d4fd42d6a2729018e8415ba1.png
[203eff602dd1418e8edcbf92b366d756.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/871bbe0a2e0646c2af406a9e8aa26580.png
[492d7612ecf9402ca45f3dad0b4d69e3.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/e6ac35ffa4b24c8582cc4671720783e4.png
[a04a286764814986a179a6ea4a30b0cb.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/76a8373a382c4074adaa8cb0043770d2.png