DeepDiff库一键搞定接口测试字段多，断言麻烦的问题，简直太好用

背景

想要做一个平台对比代码之间的区别，用python如何去实现?

接口的返回字段特别多，成千上万行，如何快速审核验证返回值全部字段？

那么今天就跟大家介绍一个库就可以很好实现以上两个需求。

01

deepdiff

其实满足上面需求的库有两个deepdiff和difflib，主要区别是deepdiff显示的对比效果比较简洁，但是可以设置忽略的字段，difflib显示的对比结果可以是html的，比较详细。但是由于篇幅有限，我们今天只讲deepdiff。

deepdiff模块常用来校验两个对象是否一致，并找出其中差异之处。其中提供了三个类，DeepDiff，DeepSearch和DeepHash，官网地址：https://deepdiff.readthedocs.io/en/latest/

• l DeepDiff：字典，可迭代项，字符串和其他对象的深层差异。它将递归地查找所有更改。
• l DeepSearch：在其他对象中搜索对象。
• l DeepHash：根据对象的内容对其进行哈希处理。

返回值的展示样式有两种，文本视图（原始）和树视图（新).

deepdiff是一个校验两个对象是否一致的库，并返回其中的差异之处 文档

在校验接口返回值与预期值的差异，可以直接用作接口测试中的assertion

Deepdiff 递归查找所有不同项，增加、减少、修改等

拿两个json进行比较

from deepdiff import DeepDiff
import pprint


a =  {"Object":{
        "code": "0",
        "message": "success"
    },
    "code": "0",
    "message": "success"
}

b =  {"Object":{
        "code": "0",
        "message": "failure"
    },
    "message": "success",
    "timestamp": "1614301293"
}

pprint.pprint(DeepDiff(a, b))

结果

{'dictionary_item_added': [root['timestamp']],
 'dictionary_item_removed': [root['code']],
 'values_changed': {"root['Object']['message']": {'new_value': 'failure',
                                                  'old_value': 'success'}}

指定key不去匹配

from deepdiff import DeepDiff
import pprint


a =  {"Object":{
        "code": "0",
        "message": "success"
    },
    "code": "0",
    "message": "success"
}

b =  {"Object":{
        "code": "0",
        "message": "failure"
    },
    "message": "success",
    "timestamp": "1614301293"
}

pprint.pprint(DeepDiff(a, b, exclude_paths={"root['timestamp']", "root['code']", "root['Object']['message']"}))

结果

{}

02

运行

对于测试人员用的比较多的就是DeepDiff，所以今天我们主要讲解这个类。

DeepDiff可以对字典，可迭代项，字符串和其他对象的深层差异。它将递归地查找所有更改。可以用来校验多种类型的文件内容，如txt、json、图片等......

下载

pip install deepdiff==4.3.2

案例1：校验json

demo1.json的文件内容如下:

demo2.json的文件内容如下:

示例代码如下：

运行代码的结果如下：

当两个对象中都存在，只是值不相同时，输出：

values_changed：{}

案例2：校验字典

运行效果如下：

默认是文本视图；使用树视图请添加view='tree'参数。demo1中有该字段，demo2中没有该字段就会出现dictionary_item_removed字段和详细信息;demo1中没有该字段，demo2中有该字段就会出现dictionary_item_added字段和详细信息。

案例3：可以设置参数，忽略一些字段，这个也是DeepDiff的亮点。

在实际工作断言的时候，我们不关系对象顺序或者重复项，可以在比较的时候加入 ignore_order

运行结果如下:

{}

备注:

1. 我们可以根据自己实际的项目去增加字段，比如report_repetition重复报告情况，significant_digits小数点后的显著位数，ignore_string_case是否区分大小写，字段这边就不一一列举介绍了，可以参考官网。
2. 如果实际请求结果和预期值的json数据都一致，那么会返回{}空字典，否则会返回对比结果，根据这个特点进行断言。

项目实战：

免费的查询手机号码信息的接口。

• Url地址：http://api.63code.com/tel/api.php
• 参数：tel = 电话号码
• 响应值：json数据

代码如下：

运行结果如下:

上述的第一个用例，由于实际的请求结果和预期值的json数据都一致，所以DeepDiff返回空字典，然后断言成功；而第二个用例我们修改预期值的tel字段值，所以，DeepDiff返回了对比后的结果，与预期值不符，断言失败。

03

总结

1. api 测试的时候，可以直接将全部的 json 比较，来确定是不是一样，可以少写很多代码

2. 数据库数据比较的时候也是一样可以，使用 sql 查处结果之后，直接变成 json 就可以和期望的 json 对比了

3. 还可以设置一些需要忽略的字段

end~