Python-全字段断言-DeepDiff

deepdiff 模块常用来校验两个对象是否一致，包含三个常用类：DeepDiff、DeepSearch、DeepHash。DeepDiff最常用，可以对字典、可迭代对象、字符串等进行对比，使用递归查找所有差异，也可以用来校验文件内容的差异，如txt、json、图片等等。

官网地址：
https://zepworks.com/deepdiff/current/diff.html

DeepDiff库由以下功能模块组成：

1. DeepDiff: 该模块通过递归方式比较两个字典、可迭代对象、字符串和其他对象的深度差异。
2. DeepSearch：该模块支持在对象中搜索对象;
3. Extract：该模块可以根据值抽取其key的路径，反过来根据Key路径提取值；
4. 命令行：安装DeepDiff，可以在终端通过命令行对比本地的两个文件的不同，支持主流的文件格式：CSV、tsv、json、yaml等

1、deepdiff安装

pip3 install deepdiff

2、deepdiff常用操作
实际请求结果和预期值的json数据一致，则返回{}空字典，否则会返回对比差异的结果，接口测试中可以根据这个特点进行断言。如果对比的结果不同，将会给出如下的返回；

1. type_changes: 类型改变的key;
2. values_changed:值发生改变的key;
3. dictionary_item_added:字典key添加；
4. dictionary_item_removed：字段key删除；

案例一：txt文件对比
文件一dd_text01: “测试测试测试—测试测试”
文件二dd_text02:“测试测试测试–测试测试”

from deepdiff import DeepDiff

# case01：对比txt文件

f1, f2 = open('dd_text01.txt', 'r', encoding='utf-8').read(), open('dd_text02.txt', 'r', encoding='utf-8').read()
print(DeepDiff(f1, f2))

运行结果：

{'values_changed': {'root': {'new_value': '"测试测试测试--测试测试"', 'old_value': '"测试测试测试---测试测试"'}}}

案例二：JSON文件对比

json_01 ={
    "message": "",
    "code": "success",
    "data": {
        "username": "****",
        "isEnjoyMember": "true",
        "enjoyMemberExpireTime": 2354025599000,
        "memberType": 1,
        "enjoySurplusSeconds": 660667879,
        "clinicExpireTime": 1817913599000,
        "isClinicMember": "true",
        "clinicMemberType": 1,
        "clinicSurplusSeconds": 124555879,
        "isMember": "false",
        "expirationTime": None
    }
}
json_02={
    "message": "",
    "code": "success",
    "data": {
        "username": "**",
        "isEnjoyMember": "false",
        "enjoyMemberExpireTime": 2354025599000,
        "memberType": 1,
        "enjoySurplusSeconds": 660667879,
        "clinicExpireTime": 1817913599000,
        "isClinicMember": "true",
        "clinicMemberType": 1,
        "clinicSurplusSeconds": 124555879,
        "isMember": "false",
        "expirationTime": None
    }
}

print(DeepDiff(json_01,json_02))

运行结果：

{'values_changed': {"root['data']['username']": {'new_value': '**', 'old_value': '****'}, "root['data']['isEnjoyMember']": {'new_value': 'false', 'old_value': 'true'}}}

案例三：接口响应报文对比

test_data = {
        'slideshow':
            {
                'author': 'Yours Truly@@',
                'date': 'date of publication',
                'slides': [{
                    'title': 'Wake up to WonderWidgets!',
                    'type': 'all'
                },
                    {
                        'items':
                            ['Why <em>WonderWidgets</em> are great', 'Who <em>buys</em> WonderWidgets'],
                        'title': 'Overview', 'type': 'all'}],
                'title': 'Sample Slide Show'
            }
    }


res = requests.get('http://www.httpbin.org/json').json()
print(DeepDiff(res['slideshow']['author'],test_data))

执行结果：

{'type_changes': {'root': {'old_type': <class 'str'>, 'new_type': <class 'dict'>, 'old_value': 'Yours Truly', 'new_value': {'slideshow': {'author': 'Yours Truly@@', 'date': 'date of publication', 'slides': [{'title': 'Wake up to WonderWidgets!', 'type': 'all'}, {'items': ['Why <em>WonderWidgets</em> are great', 'Who <em>buys</em> WonderWidgets'], 'title': 'Overview', 'type': 'all'}], 'title': 'Sample Slide Show'}}}}}