测试开发 | REST Assured 实践：断言实现

桃扇骨 2023-09-24 16:33 52阅读 0赞

![9c4355b840f02639c644ba63c116321a.jpeg][]

`在上一篇文章中，我们初步探讨了，REST Assured 的应用实践，还有很`多丰富的用法需要慢慢探索研究。而 `REST Assured`提供的完整断言手段，是测试工程师最常用最重要的功能之一。断言该如何使用呢？

## ***1. Json 断言*** ##

1.1 环境准备

这里以 rest-assured 官方给的一个示例做演示学习

{
       "lotto":{
        "lottoId":5, "winning-numbers":[2,45,34,23,7,5,3], "winners":[{
          "winnerId":23,   "numbers":[2,45,34,23,3,5] },{
          "winnerId":54,   "numbers":[52,3,12,11,18,22] }]}}

在本地使用 `python -m CGIHTTPServer`临时搭建起一个服务：

![191689d9e0e947f52158b70b5d143327.png][]

1.2 JsonPath(Groovy's GPath)

> 在 Groovy 的官网，虽然并未提及它在 json 中的使用，但实际上只要是树形的层级关系，无论是 json、xml 或者其他格式，就可以使用这种简单的语法帮我们去找到其中的值，rest-assured 也已经帮我们实现支持了 GPath 的断言方式

根节点.子节点

1）我们可以使用根节点.(点)子节点的方式一层层的找下去，例如我们需要对`lottoId`等于 5 进行断言：

![08db0fff61fc438e0c8b8f62a18f4899.png][]

@Testvoid testGPath(){
            given().     when().             log().all().get("http://127.0.0.1:8000/restAssured.json").     then().             log().all().body("lotto.lottoId",equalTo(5)); }

2）如果我们想要断言`winners`数组下面的`winnerId`，检查23和54是否包含其中，可以如下`lotto.winners.winnerId`写法

![9be6422b7ec41b4b96fc21cf274b8c03.png][]

@Testvoid testGPath(){
           given().    when().            log().all().get("http://127.0.0.1:8000/restAssured.json").    then().            log().all()            .body("lotto.winners.winnerId",hasItems(54,23));}

**索引取值**

1）如果我们想要取某些相同字段中的某一个，可以使用类似索引的方式获取，例如想要断言 `winners`数组下面的 `winnerId`的第一个值是否为23，可以使用 `lotto.winners.winnerId[0]`，写法如下：

![85891b7dee032a174525d6850fbd291f.png][]

@Testvoid testGPath(){
           given().    when().            log().all().get("http://127.0.0.1:8000/restAssured.json").    then().            log().all()            .body("lotto.winners.winnerId[0]",equalTo(23));}

2）如果我们想要取某些相同字段中的最后一个，可以使用 `-1`作为索引，例如断言断言 `winners`数组下面的 `winnerId`的最后一个的值是否为 54

![3e241a967299b319383e70c15fbd6952.png][]

@Testvoid testGPath(){
           given().    when().            log().all().get("http://127.0.0.1:8000/restAssured.json").    then().            log().all()            .body("lotto.winners.winnerId[-1]",equalTo(54));}

**findAll**

有时候我们需要获取符合某些条件的结果来进行断言，这里 `findAll`可以帮助我们实现，我们可以在 `findAll`方法中写筛选条件，例如我们想取 `winnerId`的值在大于或等于 30 小于 60 之间的结果进行断言，具体写法如下：

@Testvoid testGPath(){
           given().    when().            log().all().get("http://127.0.0.1:8000/restAssured.json").    then().            log().all()            .body("lotto.winners.findAll{ winners -> winners.winnerId >= 30 && winners.winnerId < 60}.winnerId[0]",equalTo(54));}

**find**  
find 的用法与 findAll 基本一致，只是 find 默认取匹配到的第一个：

@Testvoid testGPath(){
           given().    when().            log().all().get("http://127.0.0.1:8000/restAssured.json").    then().            log().all()            .body("lotto.winners.find{ winners -> winners.winnerId >= 30 && winners.winnerId < 60}.winnerId",equalTo(54));    }

1.3 实操演示

将上述各个断言语法写在一起，实际运行校验结果：

![7103edfd0699392881aa456f9c721add.jpeg][]

***2. XML断言***

2.1 环境准备

上面介绍了，`GPath`也支持 `XML`格式的断言，这里再以 rest-assured 官方给的一个实例做演示

<shopping> <category type="groceries"> <item> <name>Chocolate</name> <price>10</price> </item> <item> <name>Coffee</name> <price>20</price> </item> </category> <category type="supplies"> <item> <name>Paper</name> <price>5</price> </item> <item quantity="4"> <name>Pens</name> <price>15</price> </item> </category> <category type="present"> <item when="Aug 10"> <name>Kathryn's Birthday</name> <price>200</price> </item> </category> </shopping>
    再次在本地搭起一个临时服务：

![f8fcb2ec4bbac13edc23bef98b6ed003.png][]

2.2 XmlPath断言语法

若我们要对第二个 name 的值 Coffee 进行断言，写法如下：

![4a5d806b3c2f30dd4dedbad4e24092b7.png][]

@Testvoid testXML(){
           when().            get("http://127.0.0.1:8000/restAssured.xml").    then().            log().all().            body("shopping.category[0].item[1].name",equalTo("Coffee"));}

**size()**  
可以利用 `size()`方法来获取对应节点的数量，例如这里要断言 `category`的数量：

@Testvoid testXML(){
           when().            get("http://127.0.0.1:8000/restAssured.xml").    then().            log().all()            .body("shopping.category.size()",equalTo(3));}

**it.@type、it.price**

在 xml中 断言中，可以利用 it. 属性或节点的值来作为筛选条件；  
例如这里要获取 `type`为 `supplies`的 `category`下的第一个 `item`的 `name，`以及获取 `price`为 10 的商品名 `name`。

![196193df0f3966e8901972fa2724d4a6.png][]

@Testvoid testXML(){
            when().             get("http://127.0.0.1:8000/restAssured.xml").     then().             log().all()             .body("shopping.category.findAll{ it.@type == 'supplies' }.item[0].name",equalTo("Paper"))             .body("shopping.category.item.findAll{ it.price == 10 }.name",equalTo("Chocolate")); }

**\*\*.findAll**  
对于xml中有一个特别的语法，`**.findAll`，可以直接忽略前面的节点，直接对筛选条件进行匹配，依然获取`price`为10的商品名`name`，写法如下：

@Testvoid testXML(){
           when().            get("http://127.0.0.1:8000/restAssured.xml").    then().            log().all()            .body("**.findAll{ it.price == 10 }.name",equalTo("Chocolate"));}

2.3 实操演示

将上述各个断言语法写在一起，实际运行校验结果：

![4c6ff9e5abb5ca81382fdae79d17e636.jpeg][]

## ***3. JsonSchema断言*** ##

3.1 需求背景

在实际工作中，对接口返回值进行断言校验，除了常用字段的断言检测以外，还要对其他字段的类型进行检测，原因在于：

*  返回字段较多，无法保证每个字段都写断言
 *  防止客户端未做 null 值的校验判断，如果因为版本变更或网络等原因造成某个不能接收 null 值的返回字段为 null，就很有可能造成软件的崩溃
 *  某些数值是不能为负的
 *  小数点保留位数，对于股票的交易、医疗数据的分析，小数点的精确度都是有其实际价值的

对返回的字段一个个写断言显然是非常耗时的，这个时候就需要一个模板，可以定义好数据类型和匹配条件，除了关键参数外，其余可直接通过此模板来断言，这个就要请出`JsonSchema`了

3.2 使用方法

先对上述的 json 例子做少许修改，增加一个 String 类型的 `winnername`字段，这里可以先你不用疑惑为什么加，后续自有其演示作用

![b8a9c776c66d8234c3f63d34803e39ab.png][]

**JsonSchema模板生成**

1）首先要借助于`Json schema tool`的网站https://www.jsonschema.net/，将返回json字符串复制到页面左边，然后点击`INFER SHCEMA`,就会自动转换为`schema json`文件类型,会将每个地段的返回值类型都设置一个默认类型; 在`pattern`中也可以写正则进行匹配

![7fce5675d019ad848be627d3790a12b9.jpeg][]

2）点击`“设置”`按钮会出现各个类型返回值更详细的断言设置，这个就是`schema`最常用也是最实用的功能，也可以对每种类型的字段最更细化的区间值校验或者断言，例如长度，取值范围等，具体感兴趣的话可以从官网学习深入学习；平常对重要字段的校验我通常会选用其他断言，比如`hamcrest`断言

![e4a702a8dcce2e7060068f4f4176bd46.png][]

3）选择复制功能，可以将生成的`schema`模板保存下来

![f6c7a7ebccb466c7270f56a4d725bcc8.png][]

**rest-assured结合使用**

4）添加maven依赖，在`rest-assured`完成支持

<dependency>    <groupId>io.rest-assured</groupId>    <artifactId>json-schema-validator</artifactId>    <version>4.0.0</version></dependency>

5）使用`matchesJsonSchemaInClasspath`方法对响应结果进行`schema`断言

@Testvoid jsonSchemaTest(){
           get("http://127.0.0.1:8000/restAssured.json").    then().log().all()            .body(matchesJsonSchemaInClasspath("jsonSchema.json"));}

运行结果：

![92e92cd726e654ca7739132087a0a9e3.png][]

**多类型校验-Combining schemas**

*  String类型的默认值为null，后端很有可能在某个字段无值时返回null，例如我们将之前添加的`winnername`字段返回`null`:

![2865f07a378a4d0d7376d47268f87d49.png][]

运行查看断言结果：

![3fe27790f99d5fe6373cce0c972ed482.png][]

很明显用例执行失败，当我们定义了`winnername`为`String`类型后，返回`null`就会断言失败，这显然不符合我们的需求，会造成用例执行结果的误判，这个时候我们需要使`winnername`即可以为`String`类型，又可以为`null`；

这就要用到`jsonSchema`提供的`Combining schemas`方法了 Combining schemas提供了如下几种方式：

*  allOf
 *  anyOf
 *  oneOf
 *  not

这里我们选取`anyOf`(任何一项满足即可)来完成上述的举例，将原来的`type`换成`String`和`null`任何一个都支持的类型：

![78d7db9a144d52080f7926828039b5a2.png][]

再次运行用例，查看断言结果：

![ef510102157ae304503d21347b90d305.png][]

用例完美通过，到此结束~

***4. 推荐阅读***

断言的语法不止上述列出的这些，但是日常工作中绝大部分需求都可以满足，如有需要可参考官方文档进去研究：  
  
**JsonPath:**  
https://www.javadoc.io/doc/io.rest-assured/json-path/latest/io/restassured/path/json/JsonPath.html  
**XmlPath:**  
https://www.javadoc.io/doc/io.rest-assured/xml-path/latest/io/restassured/path/xml/XmlPath.html  
**JsonSchema:**  
https://json-schema.org/understanding-json-schema/

另外，在我们实际工作中，很多时候并不是直接对响应结果直接断言，我们可能需要获取响应结果中的某些值，将这些值传递到下一个接口或者和其他接口的响应进行比较断言，这就涉及到了对响应 response 的获取与处理了，后续文章继续探讨。

最后：如果你平时有很多问题想要解决，你的测试职业规划也需要一点光亮，你也想跟着大家一起分享探讨，我给你
    推荐一个「软件测试学习交流群：746506216」 你缺的知识这里有，你少的技能这里有，你要的大牛也在这里……

--------------------

### 资源分享【[这份资料必须领取~][Link 1]】 ###

**下方这份完整的软件测试视频学习教程已经上传CSDN官方认证的二维码，朋友们如果需要可以自行免费领取 `【保证100%免费】`**

![在这里插入图片描述][4b0f9bb1a4dd4ab3a24710143c5cd349.png_pic_center]

![在这里插入图片描述][d96b58a511f84668b59f3f620964da07.png_pic_center]

[9c4355b840f02639c644ba63c116321a.jpeg]: https://img-blog.csdnimg.cn/img_convert/9c4355b840f02639c644ba63c116321a.jpeg
[191689d9e0e947f52158b70b5d143327.png]: https://img-blog.csdnimg.cn/img_convert/191689d9e0e947f52158b70b5d143327.png
[08db0fff61fc438e0c8b8f62a18f4899.png]: https://img-blog.csdnimg.cn/img_convert/08db0fff61fc438e0c8b8f62a18f4899.png
[9be6422b7ec41b4b96fc21cf274b8c03.png]: https://img-blog.csdnimg.cn/img_convert/9be6422b7ec41b4b96fc21cf274b8c03.png
[85891b7dee032a174525d6850fbd291f.png]: https://img-blog.csdnimg.cn/img_convert/85891b7dee032a174525d6850fbd291f.png
[3e241a967299b319383e70c15fbd6952.png]: https://img-blog.csdnimg.cn/img_convert/3e241a967299b319383e70c15fbd6952.png
[7103edfd0699392881aa456f9c721add.jpeg]: https://img-blog.csdnimg.cn/img_convert/7103edfd0699392881aa456f9c721add.jpeg
[f8fcb2ec4bbac13edc23bef98b6ed003.png]: https://img-blog.csdnimg.cn/img_convert/f8fcb2ec4bbac13edc23bef98b6ed003.png
[4a5d806b3c2f30dd4dedbad4e24092b7.png]: https://img-blog.csdnimg.cn/img_convert/4a5d806b3c2f30dd4dedbad4e24092b7.png
[196193df0f3966e8901972fa2724d4a6.png]: https://img-blog.csdnimg.cn/img_convert/196193df0f3966e8901972fa2724d4a6.png
[4c6ff9e5abb5ca81382fdae79d17e636.jpeg]: https://img-blog.csdnimg.cn/img_convert/4c6ff9e5abb5ca81382fdae79d17e636.jpeg
[b8a9c776c66d8234c3f63d34803e39ab.png]: https://img-blog.csdnimg.cn/img_convert/b8a9c776c66d8234c3f63d34803e39ab.png
[7fce5675d019ad848be627d3790a12b9.jpeg]: https://img-blog.csdnimg.cn/img_convert/7fce5675d019ad848be627d3790a12b9.jpeg
[e4a702a8dcce2e7060068f4f4176bd46.png]: https://img-blog.csdnimg.cn/img_convert/e4a702a8dcce2e7060068f4f4176bd46.png
[f6c7a7ebccb466c7270f56a4d725bcc8.png]: https://img-blog.csdnimg.cn/img_convert/f6c7a7ebccb466c7270f56a4d725bcc8.png
[92e92cd726e654ca7739132087a0a9e3.png]: https://img-blog.csdnimg.cn/img_convert/92e92cd726e654ca7739132087a0a9e3.png
[2865f07a378a4d0d7376d47268f87d49.png]: https://img-blog.csdnimg.cn/img_convert/2865f07a378a4d0d7376d47268f87d49.png
[3fe27790f99d5fe6373cce0c972ed482.png]: https://img-blog.csdnimg.cn/img_convert/3fe27790f99d5fe6373cce0c972ed482.png
[78d7db9a144d52080f7926828039b5a2.png]: https://img-blog.csdnimg.cn/img_convert/78d7db9a144d52080f7926828039b5a2.png
[ef510102157ae304503d21347b90d305.png]: https://img-blog.csdnimg.cn/img_convert/ef510102157ae304503d21347b90d305.png
[Link 1]: https://mp.weixin.qq.com/s/czHXAyc7CQ8wsv0R88UbWg
[4b0f9bb1a4dd4ab3a24710143c5cd349.png_pic_center]: https://img-blog.csdnimg.cn/4b0f9bb1a4dd4ab3a24710143c5cd349.png#pic_center
[d96b58a511f84668b59f3f620964da07.png_pic_center]: https://img-blog.csdnimg.cn/d96b58a511f84668b59f3f620964da07.png#pic_center